1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117
|
<pre>Independent Submission J. Touch
Request for Comments: 5385 USC/ISI
Obsoletes: <a href="./rfc3285">3285</a> February 2010
Category: Informational
ISSN: 2070-1721
<span class="h1">Version 2.0 Microsoft Word Template</span>
<span class="h1">for Creating Internet Drafts and RFCs</span>
Abstract
This document describes the properties and use of a revised Microsoft
Word template (.dot) for writing Internet Drafts and RFCs. It
replaces the initial template described in <a href="./rfc3285">RFC 3285</a> to more fully
support Word's outline modes and to be easier to use. This template
can be direct-printed and direct-viewed, where either is line-for-
line identical with RFC Editor-compliant ASCII output. This version
obsoletes <a href="./rfc3285">RFC 3285</a>.
The most recent version of this template and post-processing scripts
are available at <a href="http://www.isi.edu/touch/tools">http://www.isi.edu/touch/tools</a>.
Status of This Memo
This document is not an Internet Standards Track specification; it is
published for informational purposes.
This is a contribution to the RFC Series, independently of any other
RFC stream. The RFC Editor has chosen to publish this document at
its discretion and makes no statement about its value for
implementation or deployment. Documents approved for publication by
the RFC Editor are not a candidate for any level of Internet
Standard; see <a href="./rfc5741#section-2">Section 2 of RFC 5741</a>.
Information about the current status of this document, any errata,
and how to provide feedback on it may be obtained at
<a href="http://www.rfc-editor.org/info/rfc5385">http://www.rfc-editor.org/info/rfc5385</a>.
<span class="grey">Touch Informational [Page 1]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-2" ></span>
<span class="grey"><a href="./rfc5385">RFC 5385</a> Version 2.0 Microsoft Word Template February 2010</span>
Copyright Notice
Copyright (c) 2010 IETF Trust and the persons identified as the
document authors. All rights reserved.
This document is subject to <a href="https://www.rfc-editor.org/bcp/bcp78">BCP 78</a> and the IETF Trust's Legal
Provisions Relating to IETF Documents
(<a href="http://trustee.ietf.org/license-info">http://trustee.ietf.org/license-info</a>) in effect on the date of
publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect
to this document.
Table of Contents
<a href="#section-1">1</a>. Introduction ....................................................<a href="#page-3">3</a>
<a href="#section-2">2</a>. Use .............................................................<a href="#page-3">3</a>
<a href="#section-2.1">2.1</a>. Setting up Your Version of Word to Edit RFCs ...............<a href="#page-4">4</a>
<a href="#section-2.2">2.2</a>. Editing ....................................................<a href="#page-4">4</a>
<a href="#section-2.3">2.3</a>. Saving the File ............................................<a href="#page-6">6</a>
<a href="#section-2.4">2.4</a>. Generating Output ..........................................<a href="#page-6">6</a>
<a href="#section-2.4.1">2.4.1</a>. Printing Direct to a Printer ........................<a href="#page-6">6</a>
<a href="#section-2.4.2">2.4.2</a>. Printing the Text File ..............................<a href="#page-6">6</a>
<a href="#section-2.4.3">2.4.3</a>. XML Support .........................................<a href="#page-7">7</a>
<a href="#section-3">3</a>. Changes from <a href="./rfc3285">RFC 3285</a> ...........................................<a href="#page-7">7</a>
<a href="#section-3.1">3.1</a>. Heading Styles .............................................<a href="#page-7">7</a>
<a href="#section-3.2">3.2</a>. References Style ...........................................<a href="#page-8">8</a>
<a href="#section-3.3">3.3</a>. Boilerplate ................................................<a href="#page-9">9</a>
<a href="#section-3.4">3.4</a>. Simplification .............................................<a href="#page-9">9</a>
<a href="#section-3.5">3.5</a>. Ability to Direct Print and Direct View ....................<a href="#page-9">9</a>
<a href="#section-4">4</a>. Compatibility Issues ...........................................<a href="#page-10">10</a>
<a href="#section-5">5</a>. Security Considerations ........................................<a href="#page-10">10</a>
<a href="#section-6">6</a>. Acknowledgments ................................................<a href="#page-10">10</a>
<a href="#appendix-A">Appendix A</a>. Template Configuration Details ........................<a href="#page-11">11</a>
<a href="#appendix-A.1">A.1</a>. Configure Styles ..........................................<a href="#page-11">11</a>
<a href="#appendix-A.1.1">A.1.1</a>. Redefine Existing Styles ...........................<a href="#page-11">11</a>
<a href="#appendix-A.1.2">A.1.2</a>. Add New Styles .....................................<a href="#page-12">12</a>
<a href="#appendix-A.1.3">A.1.3</a>. Hidden Styles ......................................<a href="#page-13">13</a>
<a href="#appendix-A.2">A.2</a>. Define Page Layout ........................................<a href="#page-13">13</a>
<a href="#appendix-A.3">A.3</a>. Insert Boilerplate ........................................<a href="#page-14">14</a>
<a href="#appendix-A.4">A.4</a>. Automatic Fields ..........................................<a href="#page-15">15</a>
<a href="#appendix-B">Appendix B</a>. Post-Processor Script (Perl) ..........................<a href="#page-17">17</a>
Informative References ............................................<a href="#page-20">20</a>
<span class="grey">Touch Informational [Page 2]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-3" ></span>
<span class="grey"><a href="./rfc5385">RFC 5385</a> Version 2.0 Microsoft Word Template February 2010</span>
<span class="h2"><a class="selflink" id="section-1" href="#section-1">1</a>. Introduction</span>
Internet Drafts and RFCs are predominantly written in embedded-text,
compile-based formatting systems [<a href="#ref-1" title=""Instructions to Request for Comments (RFC) Authors"">1</a>][4][<a href="#ref-5" title=""Guidelines to Authors of Internet Drafts"">5</a>]. The primary and first
such system is NROFF, a text-formatting utility based on manual entry
of embedded configuration commands, such as ".p" for new paragraphs.
XML is a more recent alternative that uses structure tags instead of
explicit formatting commands to allow a single file (.xml) to be
'compiled' into ASCII output, HTML, or a variety of other formats as
desired [<a href="#ref-7" title=""Writing I-Ds and RFCs using XML"">7</a>].
Although XML adds more modern semantic information to the structure
tags, neither system supports modern WYSIWYG (what-you-see-is-what-
you-get) editing. Editors such as Microsoft Word and Corel
WordPerfect provide not only WYSIWYG editing, but also semantic tags
as well as outline-mode capabilities. To that end, a Word template
called 2-Word.template.rtf was created that supports authoring RFCs,
as described in <a href="./rfc3285">RFC 3285</a> [<a href="#ref-6" title=""Using Microsoft Word to create Internet Drafts and RFCs"">6</a>]. That version succeeded in enabling
Word-based RFC editing, but did not support Word's outline mode
renumbering capabilities.
This document describes the properties and use of a revised Microsoft
Word template (.dot) file that supports Internet Draft and RFC
formatting, intended as an update to that of <a href="./rfc3285">RFC 3285</a>. This version,
called 2-Word-v2.0.template.dot, addresses a number of issues with
the preliminary version:
o redefines basic styles (Normal, Heading1, etc.) rather than
creating new styles,
o updates the boilerplate according to <a href="https://www.rfc-editor.org/bcp/bcp78">BCP 78</a>,
o uses more conventional methods for autonumbered references and
figures, including support for name-based references (e.g.,
"[Tou2005]"), and
o supports direct output to a printer from the .doc source, as well
as <a href="./rfc3285">RFC-3285</a>-style 'print to text' with post-processing on Windows-
based PCs.
This document assumes familiarity with Microsoft Windows operating
systems and the Word application.
<span class="h2"><a class="selflink" id="section-2" href="#section-2">2</a>. Use</span>
To use this template, double-click on it in Windows (it may work in
MacOS and/or OpenOffice, but this has not been confirmed). The
result should be a 'new' document. Do NOT open this document from
<span class="grey">Touch Informational [Page 3]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-4" ></span>
<span class="grey"><a href="./rfc5385">RFC 5385</a> Version 2.0 Microsoft Word Template February 2010</span>
within Word, e.g., via the File->Open menu; this will edit the
template, rather than using the template to create a new template-
based document.
<span class="h3"><a class="selflink" id="section-2.1" href="#section-2.1">2.1</a>. Setting up Your Version of Word to Edit RFCs</span>
Unfortunately, Word does not have a way to save some useful settings
in a template. It may be useful to configure autoformatting to avoid
using smart quotes or hyphens. However, this template is compatible
with these features as its post-processor script translates such non-
standard character codes into their RFC-compatible ASCII equivalents.
<span class="h3"><a class="selflink" id="section-2.2" href="#section-2.2">2.2</a>. Editing</span>
The template provides a number of styles for use (for details, see
<a href="#appendix-A">Appendix A</a>). Some are redefined internal styles and some are new, as
follows. Throughout the document, avoid the use of bold, italics, or
any other character formatting, as well as any graphics or paragraph
or table borders. Smart hyphens and quotes need not be avoided and
will be translated during post-processing.
The current styles allow existing hyphens to break (wrap) across
lines, but do not add hyphenation. To insert a non-breaking hyphen,
type <CTL-_> (control-underscore); this is particularly useful in
URLs, which are more readable if not line-wrapped.
Note that it is critical NOT to use any styles other than those
provided by this template.
o Redefined internal styles for general use:
Normal, Heading1-9, Caption, Header, Footer:
Use in the normal fashion. Tabs can be used as desired.
o New styles:
RFC Title:
For the document title only.
RFC Figure:
For ASCII-art figures. Single spaced, kept together.
RFC List Bullet:
For bulleted lists.
<span class="grey">Touch Informational [Page 4]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-5" ></span>
<span class="grey"><a href="./rfc5385">RFC 5385</a> Version 2.0 Microsoft Word Template February 2010</span>
RFC List Numbered:
For numbered lists. Use 'restart numbering' as desired for new
list sequences.
RFC References:
For normative and informative references. Do not restart
numbering for informative references.
NOTE: references can use an alternate unnumbered style that
relies on use of Word's bookmark feature to set cross-reference
tags.
RFC App:
For appendix titles, using "Appendix A." format. Starts at the
top of a new page. If appendices are used, start the
references (after appendices) at the top of a new page (insert
'page break').
RFC App H1-5:
For appendix headings ("A.1." format).
NOTE: these headings will NOT auto-renumber when
promoted/demoted in outline mode.
o Redefined internal styles not generally accessed by users:
TOC1-9:
For table of contents entries.
RFC Instructions:
For instructions to authors. These notes must be deleted.
RFC H1 - no num:
For unnumbered headings in end boilerplate text.
RFC H1 - no TOC no num:
For unnumbered, unlisted (in TOC) headings in front boilerplate
text.
<span class="grey">Touch Informational [Page 5]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-6" ></span>
<span class="grey"><a href="./rfc5385">RFC 5385</a> Version 2.0 Microsoft Word Template February 2010</span>
<span class="h3"><a class="selflink" id="section-2.3" href="#section-2.3">2.3</a>. Saving the File</span>
The template is provided as a Word 97-2003 ".dot" template; Word 2007
uses an XML-based variant called ".dotx". Word 2007 can use ".dot"
templates in "Compatibility Mode". If the file is saved in that
mode, it has a ".doc" suffix; if saved in native Word 2007 mode, it
has a ".docx" format. It does not matter which saved file format is
used.
<span class="h3"><a class="selflink" id="section-2.4" href="#section-2.4">2.4</a>. Generating Output</span>
This template supports printing similar output both to regular
printers (8.5 x 11 inch paper) and as Internet-Draft/RFC-compatible
text files. Printing to a printer is designed for Windows XP and
Vista and may work with earlier versions of Windows; it has not been
tested with other OS's. The template is currently in a Word 97-2003
format (.dot); this can be used in "Compatibility Mode" in Word 2007.
Printing to text is supported only for Windows at this time. There
is no current support for XML. Details are provided as follows.
<span class="h4"><a class="selflink" id="section-2.4.1" href="#section-2.4.1">2.4.1</a>. Printing Direct to a Printer</span>
The template produces output direct to a printer that is line-for-
line, page-for-page identical with the text-only version, with a few
minor exceptions:
o Single and double quotes may be angled (left quote, right quote),
rather than straight, depending on whether 'smart quotes' are
enabled in Tools->Autocorrect options.
o Hyphens may print as an em dash or en dash, depending on whether
'smart hyphens' are enabled in Tools->Autocorrect options.
<span class="h4"><a class="selflink" id="section-2.4.2" href="#section-2.4.2">2.4.2</a>. Printing the Text File</span>
Printing to an ASCII text file is currently known to work only on
Windows-XP and Windows-Vista PCs; appropriate ASCII-output drivers
for MacOS or Unix boxes running OpenOffice are not currently known.
To generate .txt output on a Windows-XP or Windows Vista PC, use a
two-step process. First, generate a .prn file by printing the
document to a text-only printer. Second, apply post-processing to
clean up the text and apply 'new page' characters.
<span class="grey">Touch Informational [Page 6]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-7" ></span>
<span class="grey"><a href="./rfc5385">RFC 5385</a> Version 2.0 Microsoft Word Template February 2010</span>
Install the "Generic/Text Only" printer, as found under "Generic" in
the available print drivers list. Configure the printer to save to a
file or click 'save to file' when printing. A printed file will have
a .prn file suffix.
The printed output needs to be run through a post-processor to
generate valid Internet-Draft or RFC formatted text. Run the .prn
file through the post-processing as described in <a href="#appendix-B">Appendix B</a>. This
performs the following operations:
o Omits <CR>s (converts <CR><LF> to <LF> and omits bare <CR>s).
o Converts smart quotes and hyphens to their ASCII counterparts.
o Omits blank lines between the footer of one page and the header of
the next, and inserts a <CTL-L> (form-feed) between the two.
o Checks for remaining illegal characters (not printable ASCII, CR,
LF), as required.
<span class="h4"><a class="selflink" id="section-2.4.3" href="#section-2.4.3">2.4.3</a>. XML Support</span>
There is no current support for XML in this template. Although Word
2003 provides XML support, its use is counterintuitive to most Word
users. XML fields are edited using a separate database editor,
rather than in the native Word input screen. Future support for XML
is being considered for a future revision of this template.
<span class="h2"><a class="selflink" id="section-3" href="#section-3">3</a>. Changes from <a href="./rfc3285">RFC 3285</a></span>
This document and the ".dot" template borrow heavily from <a href="./rfc3285">RFC 3285</a>
[<a href="#ref-6" title=""Using Microsoft Word to create Internet Drafts and RFCs"">6</a>]. Notably, all specifics of point sizes, tab locations, and the
automatic date fields are directly from that template. This document
builds on that information as follows.
<span class="h3"><a class="selflink" id="section-3.1" href="#section-3.1">3.1</a>. Heading Styles</span>
This document redefines Normal, Heading1-9, Header, Footer, and
Caption, rather than defining new RFC-named styles as in <a href="./rfc3285">RFC 3285</a>.
The use of internal style names is required for proper operation of
outline mode, notably when promoting/demoting sections of text with
subsequent renumbering of headings therein.
Note that this use of redefined standard styles is the common
practice, both in Microsoft-supplied templates as well as templates
from the IEEE and ACM, among others.
<span class="grey">Touch Informational [Page 7]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-8" ></span>
<span class="grey"><a href="./rfc5385">RFC 5385</a> Version 2.0 Microsoft Word Template February 2010</span>
Additional heading styles RFC App and RFC App H1-9 were added to
support alternate numbering used in appendices, although these styles
exhibit the previous deficiency of custom styles in outline mode
(will not auto-renumber on promote/demote).
<span class="h3"><a class="selflink" id="section-3.2" href="#section-3.2">3.2</a>. References Style</span>
There are two different reference styles -- RFC References, and RFC
References Bookmark. The former cross-references using numbers
(e.g., [<a href="#ref-1" title=""Instructions to Request for Comments (RFC) Authors"">1</a>]); the latter uses Word's bookmarking cross-reference
features to support name/year cross-references (e.g., [Tou2005]).
The latter is expected to be the preferred format for future I-Ds and
RFCs.
RFC References is a body text paragraph style that autonumbers based
on the "[<a href="#ref-1" title=""Instructions to Request for Comments (RFC) Authors"">1</a>]" format. Again, it is common practice, both among
Microsoft-supplied templates as well as templates from the IEEE and
ACM, to use autonumbered paragraphs in the body text for references.
This differs from <a href="./rfc3285">RFC 3285</a>, in which references were inserted as
endnotes, rather than as main body text.
Putting references in endnotes has unexpected behavior. In
particular, the reference is defined by its first use as a citation
and is cross-referenced by subsequent citations. Removing the first
citation removes the reference entirely, despite other cross-
references. This is not the case with body text autonumbered
paragraphs, which persist regardless of which cross-references are
deleted.
Note that Word does not provide a way to ensure that all RFC
Reference paragraphs are cross-referenced, i.e., users can insert
references that are not cited. This can be desired, however, e.g.,
for bibliographies of supplemental material.
RFC References Bookmark is a body text paragraph style that does not
use autonumbering. Currently, authors are expected to manually
format their references using name-based tags between square brackets
("[]"). There is no required format, but a suggested format would
use the first three letters of the first author, together with the
four numbers of the document year, e.g., for this document's
reference "[<a href="#ref-2" title=""Rights Contributors Provide to the IETF Trust"">2</a>]", the reference would now appear as:
[<a id="ref-Bra2004">Bra2004</a>] Bradner, S., "IETF Rights..."
<span class="grey">Touch Informational [Page 8]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-9" ></span>
<span class="grey"><a href="./rfc5385">RFC 5385</a> Version 2.0 Microsoft Word Template February 2010</span>
The author is expected to select the text of the reference
"[<a href="#ref-Bra2004" title="S.">Bra2004</a>]" and insert a bookmark at that point with whatever name is
convenient for the author. It can then be cited as usual as a cross-
reference to the bookmark: [<a href="#ref-Bra2004" title="S.">Bra2004</a>]. Note that Word bookmark names
must start with a letter, and may include numbers but not spaces.
When two references collide, e.g., for two papers written by Bradner
in 2004, a trailing lowercase letter should be used to distinguish
them, e.g., [Bra2004a] and [Bra2004b].
<span class="h3"><a class="selflink" id="section-3.3" href="#section-3.3">3.3</a>. Boilerplate</span>
The boilerplate in this template was updated to conform with current
RFC Editor requirements, notably <a href="https://www.rfc-editor.org/bcp/bcp78">BCP 78</a> rights statements, as well as
pending guidelines for Internet Draft and RFC authors [<a href="#ref-2" title=""Rights Contributors Provide to the IETF Trust"">2</a>][3][<a href="#ref-5" title=""Guidelines to Authors of Internet Drafts"">5</a>].
The boilerplate is written in regular text, and can be easily edited
by authors to keep the template up-to-date as <a href="https://www.rfc-editor.org/bcp/bcp78">BCP 78</a> is revised.
<span class="h3"><a class="selflink" id="section-3.4" href="#section-3.4">3.4</a>. Simplification</span>
Headers and footers use more conventional tabbing to control
formatting, rather than tables.
Users no longer need to avoid the use of smart quotes or hyphens;
these are automatically translated to RFC-compliant ASCII characters
during post-processing.
A number of styles include grouping configuration, designed to
provide more readable output. In particular, all headings are "keep
with next" to avoid widowed heading lines, and all list items,
references, and figure lines are "keep together" to avoid inadvertent
splitting across page boundaries.
<span class="h3"><a class="selflink" id="section-3.5" href="#section-3.5">3.5</a>. Ability to Direct Print and Direct View</span>
This template can print directly to a printer, generating output that
is line-for-line, page-for-page identical with the compliant ASCII
text output, excepting minor formatting of hyphens and quotes.
Further, this template can be previewed in File->Print Preview or
View->Print Layout, again generating screen images that are line-
for-line, page-for-page identical with the compliant ASCII text
output. This allows true WYSIWYG (what-you-see-is-what-you-get)
editing and printing.
<span class="grey">Touch Informational [Page 9]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-10" ></span>
<span class="grey"><a href="./rfc5385">RFC 5385</a> Version 2.0 Microsoft Word Template February 2010</span>
<span class="h2"><a class="selflink" id="section-4" href="#section-4">4</a>. Compatibility Issues</span>
There are no known compatibility issues at this time. This version
of the template was designed under Windows XP and Word 2002, and has
also been tested under Windows Vista and Word 2007. It is not yet
known whether previous versions of Windows/Word are supported using
this template.
As noted in Sec. 3.1, this template redefines predefined styles,
which is common practice.
<span class="h2"><a class="selflink" id="section-5" href="#section-5">5</a>. Security Considerations</span>
There are many security issues in the general use of Microsoft
operating systems and applications. This template is not known to
expose any new security issues; it contains no macros as developed
and deployed. The author considered including the MD5 signatures of
the current versions of the .dot template and .pl post-processor
files. The current processor .pl file is included in this document
as an appendix. The .dot file is updated to track the current
requirements of the IETF boilerplate, so its MD5 signature cannot be
included here, but is posted on our website for verification.
<span class="h2"><a class="selflink" id="section-6" href="#section-6">6</a>. Acknowledgments</span>
The author acknowledges the substantial efforts of the authors of the
previous version of the Word template, Mike Gahrns and Tony Hain [<a href="#ref-6" title=""Using Microsoft Word to create Internet Drafts and RFCs"">6</a>].
This document is intended to build upon their work. Thanks also to
Lars-Erik Jonsson for feedback on this template and post-processor
script, as well as suggestions on making it more generic to support
earlier versions of Windows, and to Jixiong Dong for finding an
obscure bug in the formatting.
This document was prepared using 2-Word-v2.0.template.dot.
<span class="grey">Touch Informational [Page 10]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-11" ></span>
<span class="grey"><a href="./rfc5385">RFC 5385</a> Version 2.0 Microsoft Word Template February 2010</span>
<span class="h2"><a class="selflink" id="appendix-A" href="#appendix-A">Appendix A</a>. Template Configuration Details</span>
The Word 97-2003 ".dot" template, compatible with Word 2007, consists
of a set of default configuration settings, a set of modified and
newly-defined styles, and an initial template of text. This section
in particular assumes familiarity with Microsoft Word configuration
and modification of styles. Note that use of the template does not
require understanding this section; this merely documents the
settings already in the ".dot" file.
<span class="h3"><a class="selflink" id="appendix-A.1" href="#appendix-A.1">A.1</a>. Configure Styles</span>
Modify paragraph styles as indicated. In general use, only the
redefined existing styles Normal, Heading1-9, Header, Footer, and
Caption, and new styles RFC Figure, RFC References, RFC List Bullet,
RFC List Numbered, RFC App, and RFC App H1-5 need be used by authors.
Other styles, such as redefined TOC1-9, RFC Hidden, RFC H1 - no num,
and RFC H1 - no TOC no num are used by the template, but are
typically hidden in the styles list, and need not be explicitly
applied by authors.
All measurement units below are in points. Change measurement units
to points to set.
<span class="h4"><a class="selflink" id="appendix-A.1.1" href="#appendix-A.1.1">A.1.1</a>. Redefine Existing Styles</span>
Redefine the Normal style first; all others are based on Normal,
except as noted.
1. Normal: font Courier New, font size 12 point, next style Normal,
line spacing EXACTLY 12 point, spacing before 0 pt, spacing after
12 pt, indent left 21.6 pts, widow/orphan control, left tabs at
every 3 spaces (1 space = 7.2 points, given 72 points/inch and 10
characters/inch): 21.6, 43.2, 64.8, 86.4, 108, 129.6, 151.2,172.8,
194.4, 216, 237.6, 259.2, 280.8, 302.4, 324, 345.6,367.2, 388.8,
410.4, 432, 453.6, 475.2, 496.8.
NOTE: 12 point fonts are 12 points tall, i.e., 6 lines/inch
vertically; 12-point Courier is 10 characters/inch horizontally.
2. Heading 1-9: Normal + indent left 0 pt, hanging 21.6 pts, keep
with next, set autonumbering as "1. ", "1.1. ", "1.1.1. ", etc.
Note the space after the right-most period; type this in the
"number format" field, and leave the "follow number with" field as
'nothing' (click on the 'more' button to see this field if it is
not already visible).
<span class="grey">Touch Informational [Page 11]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-12" ></span>
<span class="grey"><a href="./rfc5385">RFC 5385</a> Version 2.0 Microsoft Word Template February 2010</span>
NOTE: change the autonumbering ONCE and in ONE format; in that
format, change all subsequent levels.
3. TOC 1-9: Normal + paragraph flush, clear tabs, add new Right tab
at 504 pts that includes a "..." leader. Add indent left as
follows: TOC 1: 21.6, TOC 2: 43.2, TOC 3: 64.8, TOC 4: 86.4, TOC
5: 108, TOC 6: 129.6, TOC 7: 151.2, TOC 8: 172.8, TOC 9: 194.4.
4. Header: Normal + space after 0 pts, next style Header, clear tabs,
and add centered tab at 252 pts, tab right at 504 pts.
5. Footer: Header + next style Footer.
6. Caption: Normal + centered, autonumbered "Figure #".
<span class="h4"><a class="selflink" id="appendix-A.1.2" href="#appendix-A.1.2">A.1.2</a>. Add New Styles</span>
NOTE: "keep lines together" is optional for lists and references; it
helps avoid breaking individual items across pages.
1. RFC Figure: Normal + space after 0 pts, keep with next, keep lines
together, next style RFC figure (also used for authors'
addresses).
2. RFC List Bullet: Normal + custom bulleted, "o" bullet style,
aligned at 21.6 pts, bullet tab after 43.2 pts, bullet indent at
43.2 pts, next style RFC List Bullet, keep lines together.
3. RFC List Numbered: Normal + custom numbered, "1. " number format,
aligned at 21.6 pts, bullet tab after 43.2 pts, bullet indent at
43.2 pts, next style RFC List Numbered, keep lines together.
4. RFC References: Normal + hanging 43.2 pts, outline level body
text, remove tabs at 21.6 and 43.2 pts, custom numbering with
format "[<a href="#ref-1" title=""Instructions to Request for Comments (RFC) Authors"">1</a>]", numbering left aligned 21.6 pts, number tab space
after at 64.8 pts, number text indent at 64.8 pts, next style RFC
References, keep lines together (used for both normative and
informative references).
5. RFC References Bookmark: Normal + hanging 72 pts, no num, remove
tabs less than 72 pts, keep lines together (used for both
normative and informative references).
6. RFC Title: Normal + space after 24 pts, centered (used for
document title).
<span class="grey">Touch Informational [Page 12]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-13" ></span>
<span class="grey"><a href="./rfc5385">RFC 5385</a> Version 2.0 Microsoft Word Template February 2010</span>
7. RFC App: RFC H1 - no num + page break before, custom outline
numbered, outline number style "Appendix A.", outline level 1,
follow number with nothing, outline number at 0 pts, outline
indent text at 0 pts, (used for Appendix titles).
8. RFC App H1-5: RFC H1 - no num + paragraph level 2-6, custom
outline numbered, outline number style "A.1." - "A.1.1.1.1.1.",
follow number with nothing, outline number at 0 pts, outline
indent text at 0 pts, (link with RFC App at level 2-6), (used for
Appendix heading levels).
<span class="h4"><a class="selflink" id="appendix-A.1.3" href="#appendix-A.1.3">A.1.3</a>. Hidden Styles</span>
These are used for pre-formatted components or instructions and are
configured to be hidden from the list of available styles.
1. RFC H1 - no num: Normal + indent left 0 pts, outline Level 1, keep
with next (used for base template trailer headers -- Copyright,
etc.).
2. RFC H1 - no TOC nonum: Normal + indent left 0 pts, (outline level
body text, as with Normal), keep with next (used for base template
front matter headers -- Abstract, Status, TOC header, etc.).
3. RFC Instructions: Normal, character bold. This style is not
normally shown and is used for instructions that should be removed
before publication.
<span class="h3"><a class="selflink" id="appendix-A.2" href="#appendix-A.2">A.2</a>. Define Page Layout</span>
Configure Page Setup as follows:
1. Margins:
Portrait orientation.
Top: 72 pts
Bottom: 60 pts (72 + 60 +_660 [55 lines] = 792 [11 in])
Left: 36 pts (5 characters at 7.2 pts/char)
Right: 57.6 pts (8.5"-7.2" = 1.3in = 93.6 pts - 36 for left)
Gutter: 0 pts
Header: 0 pts
Footer: 0 pts
If the error message "One or more margins are outside the
printable area" appears, select Ignore. This may depend on the
printer currently selected.
<span class="grey">Touch Informational [Page 13]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-14" ></span>
<span class="grey"><a href="./rfc5385">RFC 5385</a> Version 2.0 Microsoft Word Template February 2010</span>
2. Paper size:
Paper size "letter".
Width: 612 pts
Height: 792 pts (55 lines/page + 132 for top and bottom margins)
3. Layout:
Different headers and footers on the first page.
Header: 72 pts from edge
Footer: 60 pts from edge
<span class="h3"><a class="selflink" id="appendix-A.3" href="#appendix-A.3">A.3</a>. Insert Boilerplate</span>
See below for definitions of {ACDt}, {ACDy}, {AEM}, {AEY}, {AP}.
First page header:
{blank line}
{blank line}
<Working Group Name>{tab}<Initial. Lastname>
Internet Draft{tab}<Affiliation>
Intended status: <e.g., Informational>{tab}{ACDy}
Expires: {AEM}{AEY}
{blank line}
{blank line}
Footer (same on first and subsequent pages):
{blank line}
{blank line}
{blank line}
<Lastname>{tab}Expires: {AEM} {ACDy}, {AEY}{tab}[Page {AP}]
{blank line}
The front text and end text are as specified in <a href="https://www.rfc-editor.org/bcp/bcp78">BCP 78</a> [<a href="#ref-2" title=""Rights Contributors Provide to the IETF Trust"">2</a>]. For
Internet Drafts, the sentence declaring the expiration dates uses
automatic fields as needed, as with the headers and footers. Note
that some of these fields will not be updated properly until the
document has been saved and/or printed.
A basic document outline with examples is provided in the Word
template to demonstrate the use of automatic fields, including a
table of contents.
<span class="grey">Touch Informational [Page 14]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-15" ></span>
<span class="grey"><a href="./rfc5385">RFC 5385</a> Version 2.0 Microsoft Word Template February 2010</span>
<span class="h3"><a class="selflink" id="appendix-A.4" href="#appendix-A.4">A.4</a>. Automatic Fields</span>
Most of these are self-explanatory; the expiry month is set 6 months
in advance. The expiry year rolls-over (+1), if needed. The expiry
day is a copy of the current date.
NOTE: expiry date can generate invalid dates, e.g., April 31,
February 30, etc.
o {AEM} means auto expiry month, and is a field code =
{ IF { SAVEDATE \@ "M" \* MERGEFORMAT } = 1
July
{ IF { SAVEDATE \@ "M" \* MERGEFORMAT } = 2
August
{ IF { SAVEDATE \@ "M" \* MERGEFORMAT } = 3
September
{ IF { SAVEDATE \@ "M" \* MERGEFORMAT } = 4
October
{ IF { SAVEDATE \@ "M" \* MERGEFORMAT } = 5
November
{ IF { SAVEDATE \@ "M" \* MERGEFORMAT } = 6
December
{ IF { SAVEDATE \@ "M" \* MERGEFORMAT } = 7
January
{ IF { SAVEDATE \@ "M" \* MERGEFORMAT } = 8
February
{ IF { SAVEDATE \@ "M" \* MERGEFORMAT } = 9
March
{ IF { SAVEDATE \@ "M" \* MERGEFORMAT } = 10
April
{ IF { SAVEDATE \@ "M" \* MERGEFORMAT } = 11
May
{ IF { SAVEDATE \@ "M" \* MERGEFORMAT } = 12
June
"Fail" *\ MERGEFORMAT
} *\ MERGEFORMAT } *\ MERGEFORMAT } *\ MERGEFORMAT } *\ MERGEFORMAT }
*\ MERGEFORMAT } *\ MERGEFORMAT } *\ MERGEFORMAT } *\ MERGEFORMAT
} *\ MERGEFORMAT } *\ MERGEFORMAT } *\ MERGEFORMAT }
o {ACDt} means auto current date, and is a field code =
{ SAVEDATE \@ "MMMM d, yyyy" }
o {ACDy} means auto current day, and is a field code =
{ SAVEDATE \@ "d " }
<span class="grey">Touch Informational [Page 15]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-16" ></span>
<span class="grey"><a href="./rfc5385">RFC 5385</a> Version 2.0 Microsoft Word Template February 2010</span>
o {AEY} means auto expiry year, and is a field code =
{ IF { SAVEDATE \@ "M" \* MERGEFORMAT } < 7
{ SAVEDATE \@ "YYYY" \* MERGEFORMAT }
{ IF { SAVEDATE \@ "M" \* MERGEFORMAT } > 6
{ = { SAVEDATE \@ "YYYY" \* MERGEFORMAT } + 1
\* MERGEFORMAT }
"FAIL" \* MERGEFORMAT \* MERGEFORMAT
} \* MERGEFORMAT
}
o {AP} means auto page, and is a field code =
{ Page }
<span class="grey">Touch Informational [Page 16]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-17" ></span>
<span class="grey"><a href="./rfc5385">RFC 5385</a> Version 2.0 Microsoft Word Template February 2010</span>
<span class="h2"><a class="selflink" id="appendix-B" href="#appendix-B">Appendix B</a>. Post-Processor Script (Perl)</span>
#!/local/bin/perl
# ------------------------------------------------------------------
# 2-Word-post-v2.0
# Perl post-processor for MS Word RFC/Internet-draft template output
#
# J. Touch
# touch@isi.edu
# <a href="http://www.isi.edu/touch">http://www.isi.edu/touch</a>
#
# USC Information Sciences Institute (USC/ISI)
# Marina del Rey, California 90292, USA
# Copyright (c) 2004-2009
#
# Revision date: May 5, 2009
# ------------------------------------------------------------------
#
# usage:
# 2-Word-post-v2.0.pl [inputfile.txt] > [outputfile.txt]
#
# function:
# removes indent on each line (blank print margin, typ. 5 chars)
# converts cr/lf to cr
# converts 'smart quotes' to regular quotes (single and double)
# converts 'smart hyphens' (em dash, en dash) to regular hyphen
# omits blank lines between footer and next-page header
# inserts formfeed (ff) between footer and next-page header
# removes end-of-line whitespace
# checks for illegal chars (not printable ASCII, cr, lf, ff)
# checks for page lengths exceeded
# checks for line lengths exceeded
# prints errors indicating page and line on that page
#
# illegal character errors are posted to STDERR
#
# returns the logical OR of codes indicating errors found:
# 0x00 no error
# 0x01 if any illegal characters found
# 0x02 if any page length exceeds $maxpagelen
# 0x04 if any line length exceeds $maxlinelen
#
# ------------------------------------------------------------------
<span class="grey">Touch Informational [Page 17]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-18" ></span>
<span class="grey"><a href="./rfc5385">RFC 5385</a> Version 2.0 Microsoft Word Template February 2010</span>
# ------------------------------------------------------------------
# VARIABLES
# ------------------------------------------------------------------
$pagenum = 1; # start on page 1, not 0
$maxpagelen = 66; # max lines per page
$maxlinelen = 72; # max chars per line
# specific error codes
%codes = (
'none' => 0x00,
'char' => 0x01,
'page' => 0x02,
'line' => 0x04,
);
%codestrings = (
'none' => '(no error)',
'char' => 'invalid character code',
'line' => 'exceeded $maxpagelen lines per page',
'page' => 'exceeded $maxlinelen chars per line',
);
$errorcode = $codes{'none'};
$indentlen = -1; # how many spaces to eat from the beginning
# of each line; ought to be 5. negative flag
# means it is not yet initialized
$indentstr = " "; # until known otherwise, assume 5 spaces
$killwhite = 1; # flag kills space between footer, header
# start in 'between footer and header' mode,
# so eats all whitespace before the first line
# ------------------------------------------------------------------
# ERROR SUBROUTINE
# ------------------------------------------------------------------
sub printerr ($) {
my ($errstring) = shift;
print STDERR "ERROR: $codestrings{$errstring} ",
"on line $linenum on page $pagenum of text input file\n";
$errorcode |= $codes{$errstring};
return;
}
<span class="grey">Touch Informational [Page 18]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-19" ></span>
<span class="grey"><a href="./rfc5385">RFC 5385</a> Version 2.0 Microsoft Word Template February 2010</span>
# ------------------------------------------------------------------
# MAIN
# ------------------------------------------------------------------
while ($line = <>) {
$line =~ s/\r//g; # remove Unix-style end-of-line
# if this line is NOT empty, start printing again (see below)
if ($line !~ /^\s*$/) {
$killwhite = 0;
if ($indentlen < 0) {
# discover margin indent
$line =~ /^((\s)*)/;
$indentstr = $1;
$indentlen = length($indentstr);
}
}
# remove the margin indent
$line =~ s/^($indentstr)//;
# change special hyphens, quotes to regular ones
$line =~ tr/\221\222\223\224\226\227/\'\'\"\"\-\-/;
# omit end-of-line whitespace
$line =~ s/\s+\n/\n/g;
# print unless we're between the end of one page
# and the beginning of the next
if ($killwhite != 1) {
# check to see if we have any invalid characters left
# 012 = new line, 014 = form feed, 015 = carriage return
# 040-176 = printable ASCIIs
if ($line !~ /^([\012\014\015\040-\176])*$/) {
printerr('char');
# note -- we don't stop here, so we can find all the
# unprintable characters in one pass
}
$linenum++;
if ($linenum > $maxpagelen) {
printerr('page');
}
if ($#line > $maxlinelen) {
printerr('line');
}
print $line;
}
# check to see if this is the end of a page;
# if so, then print a form feed (ctl-L), and
# kill the printing of subsequent empty lines
if ($line =~ /\[Page \d+\]\s+$/) {
print "\f\n";
$killwhite = 1;
<span class="grey">Touch Informational [Page 19]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-20" ></span>
<span class="grey"><a href="./rfc5385">RFC 5385</a> Version 2.0 Microsoft Word Template February 2010</span>
$linenum = 0;
$pagenum++;
}
}
exit($errorcode);
Informative References
[<a id="ref-1">1</a>] Reynolds, J., Ed., and R. Braden, Ed., "Instructions to Request
for Comments (RFC) Authors", Work in Progress, August 2004.
[<a id="ref-2">2</a>] Bradner, S., Ed., and J. Contreras, Ed., "Rights Contributors
Provide to the IETF Trust", <a href="https://www.rfc-editor.org/bcp/bcp78">BCP 78</a>, <a href="./rfc5378">RFC 5378</a>, November 2008.
[<a id="ref-3">3</a>] Bradner, S., Ed., "Intellectual Property Rights in IETF
Technology", <a href="https://www.rfc-editor.org/bcp/bcp79">BCP 79</a>, <a href="./rfc3979">RFC 3979</a>, March 2005.
[<a id="ref-4">4</a>] RFC Editor, "Formatting RFCS",
<a href="http://www.rfc-editor.org/formatting.html">http://www.rfc-editor.org/formatting.html</a>.
[<a id="ref-5">5</a>] IETF, "Guidelines to Authors of Internet Drafts". Available as
1id-guidelines.txt at <a href="http://www.ietf.org">http://www.ietf.org</a>.
[<a id="ref-6">6</a>] Gahrns, M. and T. Hain, "Using Microsoft Word to create
Internet Drafts and RFCs", <a href="./rfc3285">RFC 3285</a>, May 2002.
[<a id="ref-7">7</a>] Rose, M., "Writing I-Ds and RFCs using XML", <a href="./rfc2629">RFC 2629</a>, June
1999.
Author's Address
Joe Touch
USC/ISI
4676 Admiralty Way
Marina del Rey, CA 90292-6695
U.S.A.
Phone: +1 (310) 448-9151
Fax: +1 (310) 448-9300
EMail: touch@isi.edu
Touch Informational [Page 20]
</pre>
|