idnits 2.17.1 draft-hoffman-rfcexamples-02.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- == The page length should not exceed 58 lines per page, but there was 2 longer pages, the longest (page 14) being 61 lines Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- ** There is 1 instance of too long lines in the document, the longest one being 1 character in excess of 72. ** The abstract seems to contain references ([1]), which it shouldn't. Please replace those with straight textual mentions of the documents in question. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the IETF Trust and authors Copyright Line does not match the current year -- The document date (February 25, 2015) is 3348 days in the past. Is this intentional? Checking references for intended status: Informational ---------------------------------------------------------------------------- -- Looks like a reference, but probably isn't: '1' on line 22 Summary: 2 errors (**), 0 flaws (~~), 2 warnings (==), 2 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 Network Working Group P. Hoffman 3 Internet-Draft VPN Consortium 4 Intended status: Informational T. Hansen 5 Expires: August 29, 2015 AT&T Laboratories 6 February 25, 2015 8 Examples of the 'XML2RFC' Version 2 and 3 Vocabularies 9 draft-hoffman-rfcexamples-02 11 Abstract 13 This document gives examples of use of the "XML2RFC" vocabulary. The 14 examples cover both version 2 and version 3. The purposes of this 15 draft it to give authors of Internet Drafts examples of how to use 16 the XML vocabularies, and to show how use of the version 2 vocabulary 17 will change with version 3. 19 Editorial Note (To be removed by RFC Editor) 21 Discussion of this draft takes place on the rfc-interest mailing list 22 (rfc-interest@rfc-editor.org), which has its home page at [1]. 24 Status of This Memo 26 This Internet-Draft is submitted in full conformance with the 27 provisions of BCP 78 and BCP 79. 29 Internet-Drafts are working documents of the Internet Engineering 30 Task Force (IETF). Note that other groups may also distribute 31 working documents as Internet-Drafts. The list of current Internet- 32 Drafts is at http://datatracker.ietf.org/drafts/current/. 34 Internet-Drafts are draft documents valid for a maximum of six months 35 and may be updated, replaced, or obsoleted by other documents at any 36 time. It is inappropriate to use Internet-Drafts as reference 37 material or to cite them other than as "work in progress." 39 This Internet-Draft will expire on August 29, 2015. 41 Copyright Notice 43 Copyright (c) 2015 IETF Trust and the persons identified as the 44 document authors. All rights reserved. 46 This document is subject to BCP 78 and the IETF Trust's Legal 47 Provisions Relating to IETF Documents 48 (http://trustee.ietf.org/license-info) in effect on the date of 49 publication of this document. Please review these documents 50 carefully, as they describe your rights and restrictions with respect 51 to this document. Code Components extracted from this document must 52 include Simplified BSD License text as described in Section 4.e of 53 the Trust Legal Provisions and are provided without warranty as 54 described in the Simplified BSD License. 56 Table of Contents 58 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 59 2. Example of a v2 Document . . . . . . . . . . . . . . . . . . 2 60 3. Example of a v3 Document . . . . . . . . . . . . . . . . . . 9 61 4. Security Considerations . . . . . . . . . . . . . . . . . . . 16 62 5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 16 63 6. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 17 64 7. Normative References . . . . . . . . . . . . . . . . . . . . 17 66 1. Introduction 68 This document gives examples of use of the "XML2RFC" vocabulary. The 69 examples cover both version 2 [XML2RFCv2] and version 3 [XML2RFCv3]. 70 Some of the examples are given to help authors use parts of the 71 vocabulary common to both versions (called "v2" and "v3" in this 72 document), while others appear in order to help authors transitioning 73 from version 2 to version 3 to see how features from the earlier 74 version relate to features in the later version. 76 This document currently only has one main example, which shows the 77 commonly-used XML elements. A future version of the document may 78 have a more complete example, and will very likely have topic- 79 specific examples (such as lists, tables, and so on). 81 2. Example of a v2 Document 83 The following is a v2 document that has all the elements that are 84 needed for typical Internet Drafts. 86 87 90 ]> 92 93 95 105 106 107 An Example of Using XML for an Internet Draft 108 110 111 ExampleCorp 112
113 114 123 Exemplar Way 115 Anytown 116 California 117 95060 118 US 119 120 +1 123-456-7890 121 +1 123-456-7890 122 chrissmith@example.com 123 http://www.example.com/corporate/ 124
125 127 129 130 131
132 jk@lmn.op 133
134 136 138 General 139 Imaginary WG 140 XML 141 Imagination 143 144 This is an example of an abstract. It is a short paragraph that 145 gives an overview of the document in order to help the 146 reader determine whether or not they are interested in reading 147 further. 148 150 151 This isn't a real RFC, just an example. 152 154 156 158
160 This is the first paragraph of the introduction to this 161 document. This introduction is probably much shorter than it would 162 be for a real Internet Draft. 164 Something to note about this paragraph is that it has a 165 pointer to , and one to 166 , both of which appear later in the 167 document. 169 171 174
176 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL 177 NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" 178 in this document are to be interpreted as described in 179 . 181
183
185
187 This is a reference to . 188 Actually, the reference itself is not all that interesting, but the 189 way that the reference is incorporated is. Note that the inclusion 190 of RFC 2119 was done at the top of the XML, while the information 191 for RFC 6949 is done directly in the references section. 192 The IETF web site is 193 quite 194 nice, 195 isn't it? 196 Unlike other web sites, it doesn't use 197 gratuitous vertical space. 199
201
203 Bulleted lists are good for items that 204 are not ordered: 206 208 This is the first item. 210 This is the second item. Here comes a sub-list: 212 214 This is the first sub-item. 216 This is the second sub-item 217 and some more detail on the second sub-item. 219 221 This is the item after the sub-list. 223 225 Numbered lists are good for items that are ordered: 227 229 This is the first item. 231 This is the second item. Here comes a sub-list, but 232 with letters: 234 236 This is the first sub-item. 238 This is the second sub-item 239 241 This is the item after the sub-list. 243 245 And an example of hanging indent. 247 249 These are bigger plants 251 These are smaller plants 253 255 And the always-interesting "format" for lists. 257 259 An element that gets a funny bullet. 261 263
265
267 The following is a figure with a caption. 268 Also, it uses the ampersand (&) and less than 269 (<) characters in the example text. 271
272 273 The ampersand (&) and 274 less than (<) are two characters 275 that need escaping. 276 277
279 Here are two short figures with no titles and with 280 odd alignment. 282
283 This might appear in the center. 284
286
287 This might appear right-aligned. 288
290 Here is a figure that is actually pulled from somewhere else. 291 292 Remember to check whether that file still exists. 294
296
298
300
302 The following is a table example. 304 305 These are sometimes called "inert" gasses. 306 Name 307 Symbol 308 Atomic Number 310 Helium 311 He 312 2 314 Neon 315 Ne 316 10 318 Argon 319 Ar 320 18 322 Krypton 323 Kr 324 36 326 Xenon 327 Xe 328 54 330 Radon 331 Rn 332 86 334 Source: Chemistry 101 336 338 The following is a right-aligned table with "full" (but not "all") 339 lines between cells. 341 342 Time 343 Mood 345 Morning 346 Happy! 348 Afternoon 349 Happy! 351 Evening 352 Somber 354 356
358
360 None. 362
364
366 There are no security considerations for an imaginary 367 Internet Draft. 369
371
373 Some of the things included in this draft came from 374 Elwyn Davies' templates. 376
378 380 382 383 &RFC2119; 385 387 389 390 391 RFC Series Format Requirements and Future Development 392 393 394 395 396 397 398 399 This is a primary reference work. 400 402 404 405 Random Early Detection (RED) gateways for Congestion 406 Avoidance 407 408 LBL 409 410 411 LBL 412 413 414 415 417 419 421 423 424 426 3. Example of a v3 Document 428 The following is a v3 document that has all the elements that are 429 needed for typical Internet Drafts. It was converted from the 430 example in Section 2. 432 433 435 439 440 441 442 443 An Example of Using XML for an Internet Draft 444 446 447 ExampleCorp 448
449 450 123 Exemplar Way 451 Anytown 452 California 453 95060 454 US 455 456 +1 123-456-7890 457 +1 123-456-7890 458 chrissmith@example.com 459 http://www.example.com/corporate/ 460
461 463 465 466 467
468 jk@lmn.op 469
470 472 474 General 475 Imaginary WG 476 XML 477 Imagination 479 480 This is an example of an abstract. It is a short paragraph that 481 gives an overview of the document in order to help the 482 reader determine whether or not they are interested in reading 483 further. 484 486 487 This isn't a real RFC, just an example. 488 490 492 494
Introduction 496 This is the first paragraph of the introduction to this 497 document. This introduction is probably much shorter than it would 498 be for a real Internet Draft. 500 Something to note about this paragraph is that it has a 501 pointer to , and one to 502 , both of which appear later in the 503 document. 505 507 510
Terminology 512 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL 513 NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" 514 in this document are to be interpreted as described in 515 . 517
519
521
The Protocol Being Described 523 This is a reference to . 524 Actually, the reference itself is not all that interesting, but the 525 way that the reference is incorporated is. Note that the inclusion 526 of RFC 2119 was done at the top of the XML, while the information 527 for RFC 6949 is done directly in the references section. 528 The IETF web site is 529 quite 530 nice, 531 isn't it? 532 Unlike other web sites, it doesn't use 533 gratuitous vertical space. 535
537
Basic Lists 539 Bulleted lists are good for items that 540 are not ordered: 542
    544
  • This is the first item.
    • 546
  • This is the second item. Here comes a sub-list: 548
      550
    • This is the first sub-item.
      • 552
    • This is the second sub-item 553 and some more detail on the second sub-item.
      • 555
    • 557
  • This is the item after the sub-list.
    • 559
561 Numbered lists are good for items that are ordered: 563
    565
  1. This is the first item.
    2. 567
  2. This is the second item. Here comes a sub-list, but 568 with letters: 570
      572
    1. This is the first sub-item.
      2. 574
    2. This is the second sub-item
      3. 575
    3. 577
  3. This is the item after the sub-list.
    4. 579
581 And an example of hanging indent. 583
585
Trees
These are bigger plants
587
Lichen
These are smaller plants
589
591 And the always-interesting "format" for lists. 593
    595
  1. An element that gets a funny bullet.
    2. 597
599
601
Figures 603 The following is a figure with a caption. 604 Also, it uses the ampersand (&) and less than 605 (<) characters in the example text. 607
This could be haiku 608 609 The ampersand (&) and 610 less than (<) are two characters 611 that need escaping. 612 613
615 Here are two short figures with no titles and with 616 odd alignment. 618
619 This might appear in the center. 620
622
623 This might appear right-aligned. 624
626 Here is a figure that is actually pulled from somewhere else. 627 628 Remember to check whether that file still exists. 630
631 632 633
635
637
Tables 639 The following is a table example. 641 These are sometimes called "inert" gasses. 643 645 646 647 649 650 651 653 654 655 657 658 659 661 662 663 665 666 667 669 670 671 673
NameSymbolAtomic Number
HeliumHe2
NeonNe10
ArgonAr18
KryptonKr36
XenonXe54
RadonRn86
675 Source: Chemistry 101 676 The following is a right-aligned table with "full" (but not "all") 677 lines between cells. 679 680 681 683 684 686 687 689 690 692
TimeMood
MorningHappy!
AfternoonHappy!
EveningSomber
694
696
IANA Considerations 698 None. 700
702
Security Considerations 704 There are no security considerations for an imaginary 705 Internet Draft. 707
709
Acknowledgements 711 Some of the things included in this draft came from 712 Elwyn Davies' templates. 714
716 718 720 722 724 726 728 729 730 RFC Series Format Requirements and Future Development 731 732 733 734 735 736 737 738 This is a primary reference work. 739 741 743 744 Random Early Detection (RED) gateways for Congestion 745 Avoidance 746 747 LBL 748 749 750 LBL 751 752 753 754 757 759 761 762 764 4. Security Considerations 766 The examples in this document do not introduce any new security 767 considerations. 769 5. IANA Considerations 771 There are no IANA considerations for this document. 773 6. Acknowledgments 775 The ideas for the examples in this document come from many people 776 over a long period of time. 778 7. Normative References 780 [XML2RFCv2] 781 Reschke, J., "The 'XML2RFC' version 2 Vocabulary", draft- 782 reschke-xml2rfc (work in progress), 2014. 784 [XML2RFCv3] 785 Hoffman, P., "The 'XML2RFC' version 3 Vocabulary", draft- 786 hoffman-xml2rfc (work in progress), 2014. 788 Authors' Addresses 790 Paul Hoffman 791 VPN Consortium 793 EMail: paul.hoffman@vpnc.org 795 Tony Hansen 796 AT&T Laboratories 797 200 Laurel Ave. South 798 Middletown, NJ 07748 799 USA 801 EMail: tony+rfcv3@maillennium.att.com