idnits 2.17.1 draft-touch-msword-template-v2.0-07.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- ** It looks like you're using RFC 3978 boilerplate. You should update this to the boilerplate described in the IETF Trust License Policy document (see https://trustee.ietf.org/license-info), which is required now. -- Found old boilerplate from RFC 3978, Section 5.1 on line 16. -- Found old boilerplate from RFC 3978, Section 5.5, updated by RFC 4748 on line 925. -- Found old boilerplate from RFC 3979, Section 5, paragraph 1 on line 936. -- Found old boilerplate from RFC 3979, Section 5, paragraph 2 on line 943. -- Found old boilerplate from RFC 3979, Section 5, paragraph 3 on line 949. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- ** Bad filename characters: the document name given in the document, 'draft-touch-msword-template-v2.0-07', contains other characters than digits, lowercase letters and dash. Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- No issues found here. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the IETF Trust Copyright Line does not match the current year == Couldn't figure out when the document was first submitted -- there may comments or warnings related to the use of a disclaimer for pre-RFC5378 work that could not be issued because of this. Please check the Legal Provisions document at https://trustee.ietf.org/license-info to determine if you need the pre-RFC5378 disclaimer. -- The document date (July 8, 2008) is 5769 days in the past. Is this intentional? -- Found something which looks like a code comment -- if you have code sections in the document, please surround them with '' and '' lines. Checking references for intended status: Informational ---------------------------------------------------------------------------- -- Looks like a reference, but probably isn't: 'Tou2005' on line 332 -- Looks like a reference, but probably isn't: 'Bra2004' on line 368 -- Looks like a reference, but probably isn't: 'Bra2004a' on line 373 -- Looks like a reference, but probably isn't: 'Bra2004b' on line 373 -- Obsolete informational reference (is this intentional?): RFC 3978 (ref. '2') (Obsoleted by RFC 5378) -- Obsolete informational reference (is this intentional?): RFC 3979 (ref. '3') (Obsoleted by RFC 8179) -- Obsolete informational reference (is this intentional?): RFC 3285 (ref. '6') (Obsoleted by RFC 5385) -- Obsolete informational reference (is this intentional?): RFC 2629 (ref. '7') (Obsoleted by RFC 7749) Summary: 2 errors (**), 0 flaws (~~), 2 warnings (==), 15 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 1 Network Working Group J. Touch 2 Internet Draft USC/ISI 3 Intended status: Informational July 8, 2008 4 Expires: January 2009 6 Version 2.0 Microsoft Word Template 7 for Creating Internet Drafts and RFCs 8 draft-touch-msword-template-v2.0-07.txt 10 Status of this Memo 12 By submitting this Internet-Draft, each author represents that 13 any applicable patent or other IPR claims of which he or she is 14 aware have been or will be disclosed, and any of which he or she 15 becomes aware will be disclosed, in accordance with Section 6 of 16 BCP 79. 18 Internet-Drafts are working documents of the Internet Engineering 19 Task Force (IETF), its areas, and its working groups. Note that 20 other groups may also distribute working documents as Internet- 21 Drafts. 23 Internet-Drafts are draft documents valid for a maximum of six months 24 and may be updated, replaced, or obsoleted by other documents at any 25 time. It is inappropriate to use Internet-Drafts as reference 26 material or to cite them other than as "work in progress." 28 The list of current Internet-Drafts can be accessed at 29 http://www.ietf.org/ietf/1id-abstracts.txt 31 The list of Internet-Draft Shadow Directories can be accessed at 32 http://www.ietf.org/shadow.html 34 This Internet-Draft will expire on January 8, 2009. 36 Abstract 38 This document describes the properties and use of a revised Microsoft 39 Word template (.dot) for writing Internet Drafts and RFCs. It updates 40 the initial template described in RFC 3285 to more fully support 41 Word's outline modes and to be easier to use. This template can be 42 direct-printed and direct-viewed, where either is line-for-line 43 identical with RFC Editor-compliant ASCII output. This version is 44 intended as an update to RFC3285. 46 The most recent version of this template and post-processing scripts 47 are available at http://www.isi.edu/touch/tools 49 Table of Contents 51 1. Introduction...................................................2 52 2. Use............................................................3 53 2.1. Setting up your version of Word to edit RFCs..............4 54 2.2. Editing...................................................4 55 2.3. Saving the File...........................................6 56 2.4. Generating Output.........................................6 57 2.4.1. Printing Direct to a Printer.........................6 58 2.4.2. Printing the Text File...............................7 59 2.4.3. XML Support..........................................7 60 3. Changes from RFC 3285..........................................7 61 3.1. Heading Styles............................................8 62 3.2. References Style..........................................8 63 3.3. Boilerplate...............................................9 64 3.4. Simplification............................................9 65 3.5. Ability to direct print and direct view...................9 66 4. Compatibility Issues..........................................10 67 5. Security Considerations.......................................10 68 6. IANA Considerations...........................................10 69 7. Acknowledgments...............................................10 70 APPENDIX A: Template configuration details.......................11 71 A.1. Configure................................................11 72 A.2. Configure styles.........................................11 73 A.2.1. Redefine existing styles............................11 74 A.2.2. Add new styles......................................12 75 A.2.3. Hidden styles:......................................13 76 A.3. Define page layout.......................................13 77 A.4. Insert boilerplate.......................................14 78 A.5. Automatic fields.........................................15 79 APPENDIX B: Post-processor script (perl).........................17 80 8. References....................................................21 81 8.1. Normative References.....................................21 82 8.2. Informative References...................................21 83 Author's Addresses...............................................21 84 Intellectual Property Statement..................................22 86 1. Introduction 88 Internet Drafts and RFCs are predominantly written in embedded-text 89 compile-based formatting systems [1][4][5]. The primary and first 90 such system is NROFF, a text formatting utility based on manual entry 91 of embedded configuration commands, such as ".p" for new paragraphs. 93 XML is a more recent alternative that uses structure tags instead of 94 explicit formatting commands to allow a single file (.xml) to be 95 'compiled' into ASCII output, HTML, or a variety of other formats as 96 desired [7]. 98 Although XML adds more modern semantic information to the structure 99 tags, neither system supports modern WYSIWYG (what you see is what 100 you get) editing. Editors such as Microsoft Word and Corel 101 WordPerfect, provide not only WYSIWYG editing, but also semantic tags 102 as well as outline-mode capabilities. To that end, a Word template 103 called 2-Word.template.rtf was created that supports authoring RFCs, 104 as described in RFC-3285 [6]. That version succeeded in enabling 105 Word-based RFC editing, but did not support Word's outline mode 106 renumbering capabilities. 108 This document describes the properties and use of a revised Microsoft 109 Word template (.dot) file that supports Internet Draft and RFC 110 formatting, intended as an update to that of RFC-3285. This version, 111 called 2-Word-v2.0.template.dot, addresses a number of issues with 112 the preliminary version: 114 o redefines basic styles (Normal, Heading1, etc.) rather than 115 creating new styles 117 o updates boilerplate according to BCP 78 119 o uses more conventional methods for autonumbered references and 120 figures, including support for name-based references (e.g., 121 "[Tou2005]") 123 o supports direct output to a printer from the .doc source, as well 124 as RFC-3285-style 'print to text' with post-processing on Windows- 125 based PCs 127 This document assumes familiarity with Microsoft Windows operating 128 systems and the Word application. 130 2. Use 132 To use this template, double-click on it in Windows (it may work in 133 MacOS and/or OpenOffice, but this has not been confirmed). The result 134 should be a 'new' document. Do NOT open this document from within 135 Word, e.g., via the File->Open menu; this will edit the template, 136 rather than using the template to create a new template-based 137 document. 139 2.1. Setting up your version of Word to edit RFCs 141 Unfortunately, Word does not have a way to save some useful settings 142 in a template. It may be useful to configure autoformatting to avoid 143 using smart quotes or hyphens. This template is compatible with these 144 features, however, as its post-processor script translates these non- 145 standard character codes to their RFC-compatible ASCII equivalents. 147 2.2. Editing 149 The template provides a number of styles for use (for details, see 150 APPENDIX A: ). Some are redefined internal styles, and some are new, 151 as follow. Throughout the document, avoid the use of bold, italics, 152 or any other character formatting, as well as any graphics, or 153 paragraph or table borders. Smart hyphens and quotes need not be 154 avoided, and will be translated during post-processing. 156 The current styles allow existing hyphens to break (wrap) across 157 lines, but do not add hyphenation. To insert a non-breaking hyphen, 158 type (control-underscore); this is particularly useful in 159 URLs, which are more readable if not line-wrapped. 161 Note that it is critical NOT to use any styles other than those 162 provided by this template. 164 o Redefined internal styles for general use: 166 Normal, Heading1-9, Caption, Header, Footer: 168 Use in the normal fashion. Tabs can be used as desired. 170 o New styles: 172 RFC Title: 174 For the document title only 176 RFC Figure: 178 For ASCII-art figures. single spaced, kept-together 180 RFC List Bullet: 182 For bulleted-lists 184 RFC List Numbered: 186 For numbered-lists. use 'restart numbering' as desired for new 187 list sequences 189 RFC References: 191 For normative and informative references. Do not restart 192 numbering for informative references. 194 NOTE: references can use an alternate unnumbered style which 195 relies on use of Word's bookmark feature to set cross-reference 196 tags. 198 RFC App: 200 For appendix titles, using "APPENDIX A: " format. Starts at the 201 top of a new page. If appendices are used, start the references 202 (after appendices) at the top of a new page (insert 'page 203 break') 205 RFC App H1-5: 207 For appendix headings ("A.1. " format). NOTE: these headings 208 will NOT auto-renumber when promoted/demoted in outline mode. 210 o Redefined styles used internal to the doc, but not generally 211 accessed by users: 213 TOC1-9: 215 For table of contents entries. 217 RFC Instructions: 219 For instructions to authors. These notes must be deleted. 221 RFC H1 - no num: 223 For unnumbered headings in end boilerplate text. 225 RFC H1 - no TOC no num: 227 For unnumbered, unlisted (in TOC) headings in front boilerplate 228 text. 230 2.3. Saving the File 232 The template is provided as a Word 97-2003 ".dot" template; Word 2007 233 uses an XML-based variant called ".dotx". Word 2007 can use ".dot" 234 templates in "Compatibility Mode". If the file is saved in that mode, 235 it has a ".doc" suffix; if saved in native Word 2007 mode, it has a 236 ".docx" format. It does not matter which saved file format is used. 238 2.4. Generating Output 240 This template supports printing similar output to both regular 241 printers (8.5x11" paper) and as Internet-Draft/RFC compatible text 242 files. Printing to a printer is designed for Windows XP and Vista and 243 may work with earlier versions of Windows; it has not been tested 244 with other OS's. The template is currently in a Word 97-2003 format 245 (.dot); this can be used in "Compatibility Mode" in Word 2007. 247 Printing to text is supported only for Windows at this time. There is 248 no current support for XML. Details are provided as follows. 250 2.4.1. Printing Direct to a Printer 252 The template produces output direct to a printer that is line-for- 253 line, page-for-page identical with the text-only version, with a few 254 minor exceptions: 256 o Single and double quotes may be angled (left quote, right quote), 257 rather than straight, depending on whether 'smart quotes' are 258 enabled in Tools->Autocorrect options. 260 o Hyphens may print as an EM-dash or EN-dash, depending on whether 261 'smart hyphens' are enabled in Tools->Autocorrect options. 263 2.4.2. Printing the Text File 265 Printing to an ASCII text file is currently known to work only on 266 Windows-XP and Windows-Vista PCs; appropriate ASCII-output drivers 267 for MacOS or Unix boxes running OpenOffice are not currently known. 269 To generate .txt output on a Windows-XP or Windows Vista PC, use a 270 two-step process. First, generate a .prn file by printing the 271 document to text-only printer. Second, apply post-processing to clean 272 up the text and apply 'new page' characters. 274 Install the "Generic/Text Only" printer, as found in under "Generic" 275 in the available print drivers list. Configure the printer to save to 276 a file, or click 'save to file' when printing. A printed file will 277 have a .prn file suffix. 279 The printed output needs to be run through a post-processor to 280 generate valid Internet-Draft or RFC formatted text. Run the .prn 281 file through the post-processing as described in APPENDIX B: . This 282 includes: 284 o Omit s (converts to as well as omitting bare 285 s) 287 o Convert smart quotes and hyphens to their ASCII counterparts 289 o Omits blank lines between the footer of one page and the header of 290 the next, and inserts a (form-feed) between the two. 292 o Checks for remaining illegal characters (not printable ASCII, CR, 293 LF), as required 295 2.4.3. XML Support 297 There is no current support for XML in this template. Although Word 298 2003 provides XML support, its use is counterintuitive to most Word 299 users. XML fields are edited using a separate database editor, rather 300 than in the native Word input screen. Future support for XML is being 301 considered for a future revision of this template. 303 3. Changes from RFC 3285 305 This document and the ".dot" template borrow heavily from RFC 3285 306 [6]. Notably, all specifics of point sizes, tab locations, and the 307 automatic date fields are directly from that template. This document 308 builds on that information as follows. 310 3.1. Heading Styles 312 This document redefines Normal, Heading1-9, Header, Footer, and 313 Caption, rather than defining new RFC-named styles as in RFC 3285. 314 The use of internal style names is required for proper operation of 315 outline mode, notably when promoting/demoting sections of text with 316 subsequent renumbering of headings therein. 318 Note that this use of redefined standard styles is the common 319 practice, both in Microsoft-supplied templates as well as templates 320 from the IEEE and ACM, among others. 322 Additional heading styles RFC App and RFC App H1-9 were added to 323 support alternate numbering used in appendices, although these styles 324 exhibit the previous deficiency of custom styles in outline mode 325 (will not auto-renumber on promote/demote). 327 3.2. References Style 329 There are two different reference styles - RFC References, and RFC 330 References Bookmark. The former cross-references using numbers (e.g., 331 [1]), the latter is uses Word's bookmarking cross-reference features 332 to support name/year cross-references (e.g., [Tou2005]). The latter 333 is expected to be the preferred format for future IDs and RFCs. 335 RFC References is a body text paragraph style that autonumbers based 336 on the "[1]" format. Again, it is common practice, both among 337 Microsoft-supplied templates as well as templates from the IEEE and 338 ACM, to use autonumbered paragraphs in the body text for references. 339 This differs from RFC 3285, in which references were inserted as 340 endnotes, rather than as main body text. 342 Putting references in endnotes has unexpected behavior. In 343 particular, the reference is defined by its first use as a citation, 344 and cross-referenced by subsequence citations. Removing the first 345 citation removes the reference entirely, despite other cross- 346 references. This is not the case with body text autonumbered 347 paragraphs, which persist regardless of which cross-references are 348 deleted. 350 Note that Word does not provide a way to ensure that all RFC 351 Reference paragraphs are cross-referenced, i.e., users can insert 352 references which are not cited. This can be desired, however, e.g., 353 for bibliographies of supplemental material. 355 RFC References Bookmark is a body text paragraph style that does not 356 use autonumbering. Currently, authors are expected to manually format 357 their references using name-based tags between square brackets 358 ("[]"). There is no required format, but a suggested format would use 359 the first three letters of the first author, together with the four 360 numbers of the document year, e.g., for this document's reference 361 "[2]", the reference would now appear as: 363 [Bra2004] Bradner, S., "IETF Rights... 365 The author is expected to select the text of the reference 366 "[Bra2004]" and Insert a Bookmark at that point with whatever name is 367 convenient for the author. It can then be cited as usual as a cross- 368 reference to the bookmark: [Bra2004] Note that Word bookmark names 369 must start with a letter, and may include numbers but not spaces. 371 When two references collide, e.g., for two papers written by Bradner 372 in 2004, a trailing lowercase letter should be used to distinguish 373 them, e.g., [Bra2004a] and [Bra2004b]. 375 3.3. Boilerplate 377 The boilerplate in this template was updated to conform with current 378 RFC Editor requirements, notably BCP 78 rights statements, as well as 379 pending guidelines for Internet Draft and RFC authors [2][3][5]. 381 The boilerplate is written in regular text, and can be easily edited 382 by authors to keep the template up-to-date as BCP 78 is revised. 384 3.4. Simplification 386 Headers and footers use more conventional tabbing to control 387 formatting, rather than tables. 389 Users no longer need to avoid the use of smart quotes or hyphens; 390 these are automatically translated to RFC-compliant ASCII characters 391 during post-processing. 393 A number of styles include grouping configuration, designed to 394 provide more readable output. In particular, all headings are "keep 395 with next" to avoid widowed heading lines, and all list items, 396 references, and figure lines are "keep together", to avoid in 397 advertent splitting across page boundaries. 399 3.5. Ability to direct print and direct view 401 This template can print directly to a printer, generating output 402 which is line-for-line, page-for-page identical with the compliant 403 ASCII text output, excepting minor formatting of hyphens and quotes. 405 Further, this template can be previewed in File->Print Preview or 406 View->Print Layout, again generating screen images which are line- 407 for-line, page-for-page identical with the compliant ASCII text 408 output. This allows true "WYSIWYG" (what-you-see-is-what-you-get) 409 editing and printing. 411 4. Compatibility Issues 413 There are no known compatibility issues at this time. This version of 414 the template was designed under Windows XP and Word 2002, and has 415 also been tested under Windows Vista and Word 2007. It is not yet 416 known whether previous versions of Windows/Word are supported using 417 this template. 419 As noted in Sec. 3.1, this template redefines predefined styles, 420 which is common practice. 422 5. Security Considerations 424 There are many security issues in the general use of Microsoft 425 operating systems and applications. This template is not known to 426 expose any new security issues; it contains no macros as developed 427 and deployed. The author considered including the MD5 signatures of 428 the current versions of the .dot template and .pl post-processor 429 files. The current processor .pl file is included in this document as 430 an appendix. The .dot file is updated to track the current 431 requirements of the IETF boilerplate, so its MD5 signature cannot be 432 included here, but is posted on our website for verification. 434 6. IANA Considerations 436 There are no IANA issues in this document. 438 The RFC Editor may remove this section prior to publication. 440 7. Acknowledgments 442 The author acknowledges the substantial efforts of the previous 443 version of the Word template, Mike Gahrns and Tony Hain [6]. This 444 document is intended to build upon their work. Thanks also to Lars- 445 Erik Jonsson for feedback on this template and post-processor script, 446 as well as suggestions on making it more generic to support earlier 447 versions of Windows, and Jixiong Dong for finding an obscure bug in 448 the formatting. 450 This document was prepared using 2-Word-v2.0.template.dot. 452 APPENDIX A: Template configuration details 454 The Word 97-2003 ".dot" template, compatible with Word 2007, consists 455 of a set of default configuration settings, a set of modified and 456 newly-defined styles, and an initial template of text. This section 457 in particular assumes familiarity with Microsoft Word configuration 458 and modification of styles. Note that use of the template does not 459 require understanding this section; this merely documents the 460 settings already in the ".dot" file. 462 A.1. Configure 464 A.2. Configure styles 466 Modify paragraph styles as indicated. In general use, only the 467 redefined existing styles Normal, Heading1-9, Header, Footer, and 468 Caption, and new styles RFC Figure, RFC References, RFC List Bullet, 469 RFC List Numbered, RFC App, and RFC App H1-5 need be used by authors. 471 Other styles, such as redefined TOC1-9, RFC Hidden, RFC H1 - no num, 472 and RFC H1 - no TOC no num are used by the template, but are 473 typically hidden in the styles list, and need not be explicitly 474 applied by authors. 476 All measurement units below are in points. Change measurement units 477 to points to set. 479 A.2.1. Redefine existing styles 481 Redefine the Normal style first; all others are based on Normal 482 except as noted. 484 1. Normal: font Courier New, font size 12 point, next style Normal, 485 line spacing EXACTLY 12 point, spacing before 0 pt, spacing after 486 12 pt, indent left 21.6 pts, widow/orphan control, left tabs at 487 every 3 spaces (1 space = 7.2 points, given 72 points/inch and 10 488 characters/inch): 21.6, 43.2, 64.8, 86.4, 108, 129.6, 151.2,172.8, 489 194.4, 216, 237.6, 259.2, 280.8, 302.4, 324, 345.6,367.2, 388.8, 490 410.4, 432, 453.6, 475.2, 496.8 492 (Note: 12 point fonts are 12 points tall, i.e., 6 lines/inch 493 vertically; 12-point Courier is 10 characters/inch horizontally) 495 2. Heading 1-9: Normal + indent left 0 pt, hanging 21.6 pts, keep 496 with next, set autonumbering as "1. ", "1.1. ", "1.1.1. ", etc. 497 Note the space after the right-most period; type this in the 498 number format field, and leave the "follow number with" field as 499 'nothing' (click on the 'more' button to see this field if it is 500 not already visible). 502 NOTES: change the autonumbering ONCE, in ONE format, and in that 503 format change all subsequent levels. 505 3. TOC 1-9: Normal + paragraph flush, clear tabs, add new Right tab 506 at 504 pts that includes a "..." leader. Add indent left as 507 follows: TOC 1: 21.6, TOC 2: 43.2, TOC 3: 64.8, TOC 4: 86.4, TOC 508 5: 108, TOC 6: 129.6, TOC 7: 151.2, TOC 8: 172.8, TOC 9: 194.4 510 4. Header: Normal + space after 0 pts, next style Header, clear tabs, 511 and add centered tab at 252 pts, tab right at 504 pts 513 5. Footer: Header + next style Footer 515 6. Caption: Normal + centered, autonumbered "Figure #" 517 A.2.2. Add new styles 519 Note: "keep lines together" is optional for lists and references; it 520 helps avoid breaking individual items across pages. 522 1. RFC Figure: Normal + space after 0 pts, keep with next, keep lines 523 together, next style RFC figure (also used for authors' addresses) 525 2. RFC List Bullet - Normal + custom bulleted, "o" bullet style, 526 aligned at 21.6 pts, bullet tab after 43.2 pts, bullet indent at 527 43.2 pts, next style RFC List Bullet, keep lines together 529 3. RFC List Numbered - Normal + custom numbered, "1. " number format, 530 aligned at 21.6 pts, bullet tab after 43.2 pts, bullet indent at 531 43.2 pts, next style RFC List Numbered, keep lines together 533 4. RFC References: Normal + hanging 43.2 pts, outline level body 534 text, remove tabs at 21.6 and 43.2 pts, custom numbering with 535 format "[1]", numbering left aligned 21.6 pts, number tab space 536 after at 64.8 pts, number text indent at 64.8 pts, next style RFC 537 References, keep lines together (used for both normative and 538 informational references) 540 5. RFC References Bookmark: Normal + hanging 72 pts, no num, remove 541 tabs less than 72 pts, keep lines together (used for both 542 normative and informational references) 544 6. RFC Title: Normal + space after 24 pts, centered (used for 545 document title) 547 7. RFC App: RFC H1 - no num + page break before, custom outline 548 numbered, outline number style "APPENDIX A: ", outline level 1, 549 follow number with nothing, outline number at 0 pts, outline 550 indent text at 0 pts, (used for Appendix titles) 552 8. RFC App H1-5: RFC H1 - no num + paragraph level 2-6, custom 553 outline numbered, outline number style "A.1. " - "A.1.1.1.1.1. ", 554 follow number with nothing, outline number at 0 pts, outline 555 indent text at 0 pts, (link with RFC App at level 2-6), (used for 556 Appendix heading levels) 558 A.2.3. Hidden styles: 560 These are used for pre-formatted components or instructions, and are 561 configured to be hidden from the list of available styles. 563 1. RFC H1 - no num: Normal + indent left 0 pts, outline Level 1, keep 564 with next (used for base template trailer headers - Copyright, 565 Acknowledgement, etc.) 567 2. RFC H1 - no TOC nonum: Normal + indent left 0 pts, (outline level 568 body text, as with Normal), keep with next (used for base template 569 front matter headers - Abstract, Status, TOC header, etc.) 571 3. RFC Instructions: Normal, character bold. This style is not 572 normally shown, and is used for instructions which should be 573 removed before publication. 575 A.3. Define page layout 577 Configure Page Setup as follows: 579 4. Margins: 581 Portrait orientation. 583 Top: 72 pts 584 Bottom: 60 pts (72 + 60 +_660 [55 lines] = 792 [11 in]) 585 Left: 36 pts (5 characters at 7.2 pts/char) 586 Right: 57.6 pts (8.5"-7.2" = 1.3in = 93.6 pts - 36 for left) 587 Gutter: 0 pts 588 Header: 0 pts 589 Footer: 0 pts 591 If the error "One or more margins are outside the printable 592 area" message, select Ignore. This may depend on the printer 593 currently selected. 595 5. Paper size: 597 Paper size "letter" 599 Width: 612 pts 600 Height: 792 pts (55 lines/page + 132 for top & bott margins) 602 6. Layout: 604 Different headers and footers on the first page 606 Header: 72 pts from edge 607 Footer: 60 pts from edge 609 A.4. Insert boilerplate 611 See below for definitions of {ACDt}, {ACDy}, {AEM}, {AEY}, {AP} 613 First page header: 615 {blank line} 616 {blank line} 617 {tab} 618 Internet Draft{tab} 619 Intended status: {tab}{ACDy} 620 Expires: {AEM}{AEY} 621 {blank line} 622 {blank line} 624 Footer (same on first and subsequent pages): 626 {blank line} 627 {blank line} 628 {blank line} 629 {tab}Expires: {AEM} {ACDy}, {AEY}{tab}[Page {AP}] 630 {blank line} 632 The front text and end text are as specified in BCP 78 [2]. For 633 Internet Drafts, the sentence declaring the expiration dates uses 634 automatic fields as needed, as with the headers and footers. Note 635 that some of these fields will not be updated properly until the 636 document has been saved and/or printed. 638 Basic document outline with examples are provided to demonstrate 639 their use, including a table of contents. 641 A.5. Automatic fields 643 Most of these are self-explanatory; the expiry month is set 6 months 644 in advance. The expiry year rolls-over (+1) if needed. The expiry day 645 is a copy of the current date. 647 NOTE: expiry date can generate invalid dates, e.g., April 31, 648 Februrary 30, etc. 650 o {AEM} means auto expiry month, and is a field code = 652 { IF { SAVEDATE \@ "M" \* MERGEFORMAT } = 1 653 July 654 { IF { SAVEDATE \@ "M" \* MERGEFORMAT } = 2 655 August 656 { IF { SAVEDATE \@ "M" \* MERGEFORMAT } = 3 657 September 658 { IF { SAVEDATE \@ "M" \* MERGEFORMAT } = 4 659 October 660 { IF { SAVEDATE \@ "M" \* MERGEFORMAT } = 5 661 November 662 { IF { SAVEDATE \@ "M" \* MERGEFORMAT } = 6 663 December 664 { IF { SAVEDATE \@ "M" \* MERGEFORMAT } = 7 665 January 666 { IF { SAVEDATE \@ "M" \* MERGEFORMAT } = 8 667 February 668 { IF { SAVEDATE \@ "M" \* MERGEFORMAT } = 9 669 March 670 { IF { SAVEDATE \@ "M" \* MERGEFORMAT } = 10 671 April 672 { IF { SAVEDATE \@ "M" \* MERGEFORMAT } = 11 673 May 674 { IF { SAVEDATE \@ "M" \* MERGEFORMAT } = 12 675 June 676 "Fail" *\ MERGEFORMAT 677 } *\ MERGEFORMAT } *\ MERGEFORMAT } *\ MERGEFORMAT } *\ MERGEFORMAT } 678 *\ MERGEFORMAT } *\ MERGEFORMAT } *\ MERGEFORMAT } *\ MERGEFORMAT 679 } *\ MERGEFORMAT } *\ MERGEFORMAT } *\ MERGEFORMAT } 680 o {ACDt} means auto current date, and is a field code = 682 { SAVEDATE \@ "MMMM d, yyyy" } 684 o {ACDy} means auto current day, and is a field code = 686 { SAVEDATE \@ "d " } 688 o {AEY} means auto expiry year, and is a field code = 690 { IF { SAVEDATE \@ "M" \* MERGEFORMAT } < 7 691 { SAVEDATE \@ "YYYY" \* MERGEFORMAT } 692 { IF { SAVEDATE \@ "M" \* MERGEFORMAT } > 6 693 { = { SAVEDATE \@ "YYYY" \* MERGEFORMAT } + 1 694 \* MERGEFORMAT } 695 "FAIL" \* MERGEFORMAT \* MERGEFORMAT 696 } \* MERGEFORMAT 697 } 699 o {AP} means auto page, and is a field code = 701 { Page } 703 APPENDIX B: Post-processor script (perl) 705 #!/local/bin/perl 706 # ------------------------------------------------------------------ 707 # 2-Word-post-v2.0 708 # Perl post-processor for MS Word RFC/Internet-draft template output 709 # 710 # J. Touch 711 # touch@isi.edu 712 # http://www.isi.edu/touch 713 # 714 # USC Information Sciences Institute (USC/ISI) 715 # Marina del Rey, California 90292, USA 716 # Copyright (c) 2004-2005 717 # 718 # Revision date: July 1, 2005 719 # ------------------------------------------------------------------ 720 # 721 # Copyright (c) 2004-2005 by the University of Southern California. 722 # All rights reserved. 723 # 724 # Permission to use, copy, modify, and distribute this software and 725 # its documentation in source and binary forms for non-commercial 726 # purposes and without fee is hereby granted, provided that the 727 # above copyright notice appear in all copies and that both the 728 # copyright notice and this permission notice appear in supporting 729 # documentation, and that any documentation, advertising materials, 730 # and other materials related to such distribution and use 731 # acknowledge that the software was developed by the University of 732 # Southern California, Information Sciences Institute. The name of 733 # the University may not be used to endorse or promote products 734 # derived from this software without specific prior written 735 # permission. 736 # 737 # THE UNIVERSITY OF SOUTHERN CALIFORNIA MAKES NO REPRESENTATIONS 738 # ABOUT THE SUITABILITY OF THIS SOFTWARE FOR ANY PURPOSE. THIS 739 # SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED 740 # WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES 741 # OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. 742 # ------------------------------------------------------------------ 743 # 744 # usage: 745 # 2-Word-post-v2.0.pl [inputfile.txt] > [outputfile.txt] 746 # 747 # function: 748 # removes indent on each line (blank print margin, typ. 5 chars) 749 # converts cr/lf to cr 750 # converts 'smart quotes' to regular quotes (single and double) 751 # converts 'smart hyphens' (EM-dash, EN-dash) to regular hyphen 752 # omits blank lines between footer and next-page header 753 # inserts formfeed (ff) between footer and next-page header 754 # checks for illegal chars (not printable ASCII, cr, lf, ff) 755 # checks for page lengths exceeded 756 # checks for line lengths exceeded 757 # prints errors indicating page and line on that page 758 # 759 # illegal character errors are posted to STDERR 760 # 761 # returns the logical OR of codes indicating errors found: 762 # 0x00 no error 763 # 0x01 if any illegal characters found 764 # 0x02 if any page length exceeds $maxpagelen 765 # 0x04 if any line length exceeds $maxlinelen 766 # 767 # ------------------------------------------------------------------ 769 # ------------------------------------------------------------------ 770 # VARIABLES 771 # ------------------------------------------------------------------ 773 $pagenum = 1; # start on page 1, not 0 775 $maxpagelen = 66; # max lines per page 777 $maxlinelen = 72; # max chars per line 779 # specific error codes 780 %codes = ( 781 'none' => 0x00, 782 'char' => 0x01, 783 'page' => 0x02, 784 'line' => 0x04, 785 ); 787 %codestrings = ( 788 'none' => '(no error)', 789 'char' => 'invalid character code', 790 'line' => 'exceeded $maxpagelen lines per page', 791 'page' => 'exceeded $maxlinelen chars per line', 792 ); 794 $errorcode = $codes{'none'}; 796 $indentlen = -1; # how many spaces to eat from the beginning 797 # of each line; ought to be 5. negative flag 798 # means it is not yet initialized 800 $indentstr = " "; # until known otherwise, assume 5 spaces 802 $killwhite = 1; # flag kills space between footer, header 803 # start in 'between footer and header' mode, 804 # so eats all whitespace before the first line 806 # ------------------------------------------------------------------ 807 # ERROR SUBROUTINE 808 # ------------------------------------------------------------------ 809 sub printerr ($) { 810 my ($errstring) = shift; 812 print STDERR "ERROR: $codestrings{$errstring} ", 813 "on line $linenum on page $pagenum of text input file\n"; 814 $errorcode |= $codes{$errstring}; 815 return; 816 } 818 # ------------------------------------------------------------------ 819 # MAIN 820 # ------------------------------------------------------------------ 822 while ($line = <>) { 823 $line =~ s/\r//g; # remove Unix-style end-of-line 824 # if this line is NOT empty, start printing again (see below) 825 if ($line !~ /^\s*$/) { 826 $killwhite = 0; 827 if ($indentlen < 0) { 828 # discover margin indent 829 $line =~ /^((\s)*)/; 830 $indentstr = $1; 831 $indentlen = length($indentstr); 832 } 833 } 834 # remove the margin indent 835 $line =~ s/^($indentstr)//; 836 # change special hyphens, quotes to regular ones 837 $line =~ tr/\221\222\223\224\226\227/\'\'\"\"\-\-/; 838 # print unless we're between the end of one page 839 # and the beginning of the next 840 if ($killwhite != 1) { 841 # check to see if we have any invalid characters left 842 # 012 = new line, 014 = form feed, 015 = carriage return 843 # 040-176 = printable ASCIIs 844 if ($line !~ /^([\012\014\015\040-\176])*$/) { 845 printerr('char'); 846 # note - we don't stop here, so we can find all the 847 # unprintable characters in one pass 848 } 849 $linenum++; 850 if ($linenum > $maxpagelen) { 851 printerr('page'); 852 } 853 if ($#line > $maxlinelen) { 854 printerr('line'); 855 } 856 print $line; 857 } 858 # check to see if this is the end of a page; 859 # if so, then print a form feed (ctl-L), and 860 # kill the printing of subsequent empty lines 861 if ($line =~ /\[Page \d+\]\s+$/) { 862 print "\f\n"; 863 $killwhite = 1; 864 $linenum = 0; 865 $pagenum++; 866 } 867 } 868 exit($errorcode); 870 8. References 872 8.1. Normative References 874 (None). 876 8.2. Informative References 878 [1] Reynolds, J., Braden, R., (eds.), "Instructions to Request for 879 Comments (RFC) Authors," (work in progress), August 2004. 881 [2] Bradner, S., (ed.) "IETF Rights in Contributions", BCP 78, RFC 882 3978, March 2005. 884 [3] Bradner, S., (ed.) "Intellectual Property Rights in IETF 885 Technology", BCP 79, RFC 3979, March 2005. 887 [4] RFC Editor formatting tools web page, "http://www.rfc 888 editor.org/formatting.html". 890 [5] IETF, "Guidelines to Authors of Internet Drafts". Available as 891 1id-guidelines.txt at http://www.ietf.org 893 [6] Gahrns, M. and T. Hain, "Using Microsoft Word to create 894 Internet Drafts and RFCs," RFC 3285, May 2002. 896 [7] Rose, M., "Writing I-Ds and RFCs using XML," RFC 2629, June 897 1999. 899 Author's Addresses 901 Joe Touch 902 USC/ISI 903 4676 Admiralty Way 904 Marina del Rey, CA 90292-6695 905 U.S.A. 907 Phone: +1 (310) 448-9151 908 Fax: +1 (310) 448-9300 909 Email: touch@isi.edu 911 Full Copyright Statement 913 Copyright (C) The IETF Trust (2008). 915 This document is subject to the rights, licenses and restrictions 916 contained in BCP 78, and except as set forth therein, the authors 917 retain all their rights. 919 This document and the information contained herein are provided on an 920 "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS 921 OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY, THE IETF TRUST AND 922 THE INTERNET ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS 923 OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF 924 THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED 925 WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. 927 Intellectual Property Statement 929 The IETF takes no position regarding the validity or scope of any 930 Intellectual Property Rights or other rights that might be claimed to 931 pertain to the implementation or use of the technology described in 932 this document or the extent to which any license under such rights 933 might or might not be available; nor does it represent that it has 934 made any independent effort to identify any such rights. Information 935 on the procedures with respect to rights in RFC documents can be 936 found in BCP 78 and BCP 79. 938 Copies of IPR disclosures made to the IETF Secretariat and any 939 assurances of licenses to be made available, or the result of an 940 attempt made to obtain a general license or permission for the use of 941 such proprietary rights by implementers or users of this 942 specification can be obtained from the IETF on-line IPR repository at 943 http://www.ietf.org/ipr. 945 The IETF invites any interested party to bring to its attention any 946 copyrights, patents or patent applications, or other proprietary 947 rights that may cover technology that may be required to implement 948 this standard. Please address the information to the IETF at 949 ietf-ipr@ietf.org.