idnits 2.17.1 draft-hoffman-rfcexamples-04.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: ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- No issues found here. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the IETF Trust and authors Copyright Line does not match the current year -- The document date (November 4, 2015) is 3089 days in the past. Is this intentional? Checking references for intended status: Informational ---------------------------------------------------------------------------- No issues found here. Summary: 0 errors (**), 0 flaws (~~), 1 warning (==), 1 comment (--). 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: May 7, 2016 AT&T Laboratories 6 November 4, 2015 8 Examples of the 'XML2RFC' Version 2 and 3 Vocabularies 9 draft-hoffman-rfcexamples-04 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 is to give developers of tools that process v2 and/or v3 16 documents a corpus to test against. 18 Editorial Note (To be removed by RFC Editor) 20 Discussion of this draft takes place on the rfc-interest mailing list 21 (rfc-interest@rfc-editor.org), which has its home page at 22 . 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 May 7, 2016. 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 . . . . . . . . . . . . . . . . . . 10 61 4. Security Considerations . . . . . . . . . . . . . . . . . . . 17 62 5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 17 63 6. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 17 64 7. Normative References . . . . . . . . . . . . . . . . . . . . 17 65 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 17 67 1. Introduction 69 This document gives examples of use of the "XML2RFC" vocabulary. The 70 examples cover both version 2 [XML2RFCv2] and version 3 [XML2RFCv3]. 71 The purpose of this document is to help developers of tools that 72 process v2 and/or v3 documents to see examples of the documents. 74 Earlier versions of this document said that it was to help people 75 with v2 documents transition to v3. The authors have backed off from 76 that goal. Instead, we point out that the changes from v2 to v3 are 77 listed in detail in Section 1.2 of [XML2RFCv3]. Also, we expect that 78 there will be additional documents created later describing the 79 v2-to-v3 conversion, as well as tools that will do as much of the 80 conversion as possible. 82 This is meant to be a short-lived document. It is not expected that 83 this document will be published as an RFC. 85 2. Example of a v2 Document 87 The following is a v2 document that has all the elements that are 88 needed for typical Internet-Drafts. 90 91 94 ]> 96 97 99 109 110 111 An Example of Using XML for an Internet Draft 112 114 115 ExampleCorp 116
117 118 123 Exemplar Way 119 Anytown 120 California 121 95060 122 US 123 124 +1 123-456-7890 125 +1 123-456-7890 126 chrissmith@example.com 127 http://www.example.com/corporate/ 128
129 131 133 134 135
136 jk@lmn.op 137
138 140 142 General 143 Imaginary WG 144 XML 145 Imagination 147 148 This is an example of an abstract. It is a short paragraph that 149 gives an overview of the document in order to help the 150 reader determine whether or not they are interested in reading 151 further. 152 154 155 This isn't a real RFC, just an example. 156 158 160 162
164 This is the first paragraph of the introduction to this 165 document. This introduction is probably much shorter than it would 166 be for a real Internet Draft. 168 Something to note about this paragraph is that it has a 169 pointer to , and one to 170 , both of which appear later in the 171 document. 173 175 178
180 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL 181 NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" 182 in this document are to be interpreted as described in 183 . 185
187
189
191 This is a reference to . 192 Actually, the reference itself is not all that interesting, but the 193 way that the reference is incorporated is. Note that the inclusion 194 of RFC 2119 was done at the top of the XML, while the information 195 for RFC 6949 is done directly in the references section. 197 The IETF web site is 198 quite 199 nice, 200 isn't it? 201 Unlike other web sites, it doesn't use 202 gratuitous vertical space. 204
206
208 Bulleted lists are good for items that 209 are not ordered: 211 213 This is the first item. 215 This is the second item. Here comes a sub-list: 217 219 This is the first sub-item. 221 This is the second sub-item 222 and some more detail on the second sub-item. 224 226 This is the item after the sub-list. 228 230 Numbered lists are good for items that are ordered: 232 234 This is the first item. 236 This is the second item. Here comes a sub-list, but 237 with letters: 239 240 This is the first sub-item. 242 This is the second sub-item 244 246 This is the item after the sub-list. 248 250 And an example of hanging indent. 252 254 These are bigger plants 256 These are smaller plants 258 260 And the always-interesting "format" for lists. 262 264 An element that gets a funny bullet. 266 268
270
272 The following is a figure with a caption. 273 Also, it uses the ampersand (&) and less than 274 (<) characters in the example text. 276
277 278 The ampersand (&) and 279 less than (<) are two characters 280 that need escaping. 281 282
284 Here are two short figures with no titles and with 285 odd alignment. 287
288 This might appear in the center. 289
291
292 This might appear right-aligned. 293
295 Here is a figure that is actually pulled from somewhere else. 296 297 Remember to check whether that file still exists. 299
301
303
305
307 The following is a table example. 309 310 These are sometimes called "inert" gasses. 311 Name 312 Symbol 313 Atomic Number 315 Helium 316 He 317 2 319 Neon 320 Ne 321 10 323 Argon 324 Ar 325 18 327 Krypton 328 Kr 329 36 331 Xenon 332 Xe 333 54 335 Radon 336 Rn 337 86 339 Source: Chemistry 101 340 342 The following is a right-aligned table with "full" (but not "all") 343 lines between cells. 345 346 Time 347 Mood 349 Morning 350 Happy! 352 Afternoon 353 Happy! 355 Evening 356 Somber 358 360
362
364 None. 366
368
370 There are no security considerations for an imaginary 371 Internet Draft. 373
375
377 Some of the things included in this draft came from 378 Elwyn Davies' templates. 380
382 383 385 387 &RFC2119; 389 391 393 394 395 RFC Series Format Requirements and Future Development 396 397 398 399 400 401 402 403 This is a primary reference work. 404 406 408 409 Random Early Detection (RED) gateways for Congestion 410 Avoidance 411 412 LBL 413 414 415 LBL 416 417 418 419 421 423 425 427 428 430 3. Example of a v3 Document 432 The following is a v3 document that has all the elements that are 433 needed for typical Internet-Drafts. It was converted from the 434 example in Section 2. 436 437 439 443 445 446 447 An Example of Using XML for an Internet Draft 448 450 451 ExampleCorp 452
453 454 123 Exemplar Way 455 Anytown 456 California 457 95060 458 US 459 460 +1 123-456-7890 461 +1 123-456-7890 462 chrissmith@example.com 463 http://www.example.com/corporate/ 464
465 467 469 470 471
472 jk@lmn.op 473
474 475 477 General 478 Imaginary WG 479 XML 480 Imagination 482 483 This is an example of an abstract. It is a short paragraph that 484 gives an overview of the document in order to help the 485 reader determine whether or not they are interested in reading 486 further. 487 489 490 This isn't a real RFC, just an example. 491 493 495 497
Introduction 499 This is the first paragraph of the introduction to this 500 document. This introduction is probably much shorter than it would 501 be for a real Internet Draft. 503 Something to note about this paragraph is that it has a 504 pointer to , and one to 505 , both of which appear later in the 506 document. 508 510 513
Terminology 515 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL 516 NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" 517 in this document are to be interpreted as described in 518 . 520
522
523
The Protocol Being Described 525 This is a reference to . 526 Actually, the reference itself is not all that interesting, but the 527 way that the reference is incorporated is. Note that the inclusion 528 of RFC 2119 was done at the top of the XML, while the information 529 for RFC 6949 is done directly in the references section. 531 The IETF web site is 532 quite 533 nice, 534 isn't it? 535 Unlike other web sites, it doesn't use 536 gratuitous vertical space. 538
540
Basic Lists 542 Bulleted lists are good for items that 543 are not ordered: 545
    547
  • This is the first item.
    • 549
  • This is the second item. Here comes a sub-list: 551
      553
    • This is the first sub-item.
      • 555
    • This is the second sub-item 556 and some more detail on the second sub-item.
      • 558
    • 560
  • This is the item after the sub-list.
    • 562
564 Numbered lists are good for items that are ordered: 566
    568
  1. This is the first item.
    2. 570
  2. This is the second item. Here comes a sub-list, but 571 with letters: 573
      575
    1. This is the first sub-item.
      2. 577
    2. This is the second sub-item
      3. 579
    3. 581
  3. This is the item after the sub-list.
    4. 583
585 And an example of hanging indent. 587
589
Trees
These are bigger plants
591
Lichen
These are smaller plants
593
595 And the always-interesting "format" for lists. 597
    599
  1. An element that gets a funny bullet.
    2. 601
603
605
Figures 607 The following is a figure with a caption. 608 Also, it uses the ampersand (&) and less than 609 (<) characters in the example text. 611
This could be haiku 612 613 The ampersand (&) and 614 less than (<) are two characters 615 that need escaping. 616 617
618 Here are two short figures with no titles and with 619 odd alignment. 621
622 This might appear in the center. 623
625
626 This might appear right-aligned. 627
629 Here is a figure that is actually pulled from somewhere else. 630 631 Remember to check whether that file still exists. 633
635 636
638
640
Tables 642 The following is a table example. 644 These are sometimes called "inert" 645 gasses. 647 648 649 651 652 653 655 656 657 659 660 661 663 664 665 666 667 668 670 671 672 674
NameSymbolAtomic Number
HeliumHe2
NeonNe10
ArgonAr18
KryptonKr36
XenonXe54
RadonRn86
Source: Chemistry 101 676 The following is a right-aligned table with "full" 677 (but not "all") 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. 713
715 717 719 Normative References 721 724 726 Informative References 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 760 761 763 4. Security Considerations 765 The examples in this document do not introduce any new security 766 considerations. 768 5. IANA Considerations 770 There are no IANA considerations for this document. 772 6. Acknowledgments 774 The ideas for the examples in this document come from many people 775 over a long period of time. Special thanks go to the Alice Russo and 776 other members of the RFC Design Team for suggestions and debugging 777 help. 779 7. Normative References 781 [XML2RFCv2] 782 Reschke, J., "The 'XML2RFC' version 2 Vocabulary", draft- 783 reschke-xml2rfc (work in progress), 2014. 785 [XML2RFCv3] 786 Hoffman, P., "The 'XML2RFC' version 3 Vocabulary", draft- 787 hoffman-xml2rfc (work in progress), 2014. 789 Authors' Addresses 791 Paul Hoffman 792 VPN Consortium 794 EMail: paul.hoffman@vpnc.org 796 Tony Hansen 797 AT&T Laboratories 798 200 Laurel Ave. South 799 Middletown, NJ 07748 800 USA 802 EMail: tony+rfcv3@maillennium.att.com