idnits 2.17.1 draft-hoffman-rfcexamples-03.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 : ---------------------------------------------------------------------------- ** 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 (May 6, 2015) is 3271 days in the past. Is this intentional? Checking references for intended status: Informational ---------------------------------------------------------------------------- -- Looks like a reference, but probably isn't: '1' on line 21 Summary: 2 errors (**), 0 flaws (~~), 1 warning (==), 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: November 7, 2015 AT&T Laboratories 6 May 6, 2015 8 Examples of the 'XML2RFC' Version 2 and 3 Vocabularies 9 draft-hoffman-rfcexamples-03 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 [1]. 23 Status of This Memo 25 This Internet-Draft is submitted in full conformance with the 26 provisions of BCP 78 and BCP 79. 28 Internet-Drafts are working documents of the Internet Engineering 29 Task Force (IETF). Note that other groups may also distribute 30 working documents as Internet-Drafts. The list of current Internet- 31 Drafts is at http://datatracker.ietf.org/drafts/current/. 33 Internet-Drafts are draft documents valid for a maximum of six months 34 and may be updated, replaced, or obsoleted by other documents at any 35 time. It is inappropriate to use Internet-Drafts as reference 36 material or to cite them other than as "work in progress." 38 This Internet-Draft will expire on November 7, 2015. 40 Copyright Notice 42 Copyright (c) 2015 IETF Trust and the persons identified as the 43 document authors. All rights reserved. 45 This document is subject to BCP 78 and the IETF Trust's Legal 46 Provisions Relating to IETF Documents 47 (http://trustee.ietf.org/license-info) in effect on the date of 48 publication of this document. Please review these documents 49 carefully, as they describe your rights and restrictions with respect 50 to this document. Code Components extracted from this document must 51 include Simplified BSD License text as described in Section 4.e of 52 the Trust Legal Provisions and are provided without warranty as 53 described in the Simplified BSD License. 55 Table of Contents 57 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 58 2. Example of a v2 Document . . . . . . . . . . . . . . . . . . 2 59 3. Example of a v3 Document . . . . . . . . . . . . . . . . . . 9 60 4. Security Considerations . . . . . . . . . . . . . . . . . . . 16 61 5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 17 62 6. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 17 63 7. Normative References . . . . . . . . . . . . . . . . . . . . 17 64 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 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 The purpose of this document is to help developers of tools that 71 process v2 and/or v3 documents to see examples of the documents. 73 Earlier versions of this document said that it was to help people 74 with v2 documents transition to v3. The authors have backed off from 75 that goal. Instead, we point out that the changes from v2 to v3 are 76 listed in detail in Section 1.2 of [XML2RFCv3]. Also, we expect that 77 there will be additional documents created later describing the 78 v2-to-v3 conversion, as well as tools that will do as much of the 79 conversion as possible. 81 This is meant to be a short-lived document. It is not expected that 82 this document will be published as an RFC. 84 2. Example of a v2 Document 86 The following is a v2 document that has all the elements that are 87 needed for typical Internet-Drafts. 89 90 93 ]> 95 96 97 107 108 109 An Example of Using XML for an Internet Draft 110 112 113 ExampleCorp 114
115 116 123 Exemplar Way 117 Anytown 118 California 119 95060 120 US 121 122 +1 123-456-7890 123 +1 123-456-7890 124 chrissmith@example.com 125 http://www.example.com/corporate/ 126
127 129 131 132 133
134 jk@lmn.op 135
136 138 140 General 141 Imaginary WG 142 XML 143 Imagination 144 145 This is an example of an abstract. It is a short paragraph that 146 gives an overview of the document in order to help the 147 reader determine whether or not they are interested in reading 148 further. 149 151 152 This isn't a real RFC, just an example. 153 155 157 159
161 This is the first paragraph of the introduction to this 162 document. This introduction is probably much shorter than it would 163 be for a real Internet Draft. 165 Something to note about this paragraph is that it has a 166 pointer to , and one to 167 , both of which appear later in the 168 document. 170 172 175
177 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL 178 NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" 179 in this document are to be interpreted as described in 180 . 182
184
186
188 This is a reference to . 189 Actually, the reference itself is not all that interesting, but the 190 way that the reference is incorporated is. Note that the inclusion 191 of RFC 2119 was done at the top of the XML, while the information 192 for RFC 6949 is done directly in the references section. 194 The IETF web site is 195 quite 196 nice, 197 isn't it? 198 Unlike other web sites, it doesn't use 199 gratuitous vertical space. 201
203
205 Bulleted lists are good for items that 206 are not ordered: 208 210 This is the first item. 212 This is the second item. Here comes a sub-list: 214 216 This is the first sub-item. 218 This is the second sub-item 219 and some more detail on the second sub-item. 221 223 This is the item after the sub-list. 225 227 Numbered lists are good for items that are ordered: 229 231 This is the first item. 233 This is the second item. Here comes a sub-list, but 234 with letters: 236 238 This is the first sub-item. 239 This is the second sub-item 241 243 This is the item after the sub-list. 245 247 And an example of hanging indent. 249 251 These are bigger plants 253 These are smaller plants 255 257 And the always-interesting "format" for lists. 259 261 An element that gets a funny bullet. 263 265
267
269 The following is a figure with a caption. 270 Also, it uses the ampersand (&) and less than 271 (<) characters in the example text. 273
274 275 The ampersand (&) and 276 less than (<) are two characters 277 that need escaping. 278 279
281 Here are two short figures with no titles and with 282 odd alignment. 284
285 This might appear in the center. 286
287
288 This might appear right-aligned. 289
291 Here is a figure that is actually pulled from somewhere else. 292 293 Remember to check whether that file still exists. 295
297
299
301
303 The following is a table example. 305 306 These are sometimes called "inert" gasses. 307 Name 308 Symbol 309 Atomic Number 311 Helium 312 He 313 2 315 Neon 316 Ne 317 10 319 Argon 320 Ar 321 18 323 Krypton 324 Kr 325 36 327 Xenon 328 Xe 329 54 331 Radon 332 Rn 333 86 334 Source: Chemistry 101 335 337 The following is a right-aligned table with "full" (but not "all") 338 lines between cells. 340 341 Time 342 Mood 344 Morning 345 Happy! 347 Afternoon 348 Happy! 350 Evening 351 Somber 353 355
357
359 None. 361
363
365 There are no security considerations for an imaginary 366 Internet Draft. 368
370
372 Some of the things included in this draft came from 373 Elwyn Davies' templates. 375
377 379 381 382 &RFC2119; 384 386 388 389 390 RFC Series Format Requirements and Future Development 391 392 393 394 395 396 397 398 This is a primary reference work. 399 401 403 404 Random Early Detection (RED) gateways for Congestion 405 Avoidance 406 407 LBL 408 409 410 LBL 411 412 413 414 416 418 420 422 423 425 3. Example of a v3 Document 427 The following is a v3 document that has all the elements that are 428 needed for typical Internet-Drafts. It was converted from the 429 example in Section 2. 431 432 434 438 441 442 An Example of Using XML for an Internet Draft 443 445 446 ExampleCorp 447
448 449 123 Exemplar Way 450 Anytown 451 California 452 95060 453 US 454 455 +1 123-456-7890 456 +1 123-456-7890 457 chrissmith@example.com 458 http://www.example.com/corporate/ 459
460 462 464 465 466
467 jk@lmn.op 468
469 471 473 General 474 Imaginary WG 475 XML 476 Imagination 478 479 This is an example of an abstract. It is a short paragraph that 480 gives an overview of the document in order to help the 481 reader determine whether or not they are interested in reading 482 further. 483 485 486 This isn't a real RFC, just an example. 487 489 491 493
Introduction 495 This is the first paragraph of the introduction to this 496 document. This introduction is probably much shorter than it would 497 be for a real Internet Draft. 499 Something to note about this paragraph is that it has a 500 pointer to , and one to 501 , both of which appear later in the 502 document. 504 506 509
Terminology 511 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL 512 NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" 513 in this document are to be interpreted as described in 514 . 516
518
520
The Protocol Being Described 522 This is a reference to . 523 Actually, the reference itself is not all that interesting, but the 524 way that the reference is incorporated is. Note that the inclusion 525 of RFC 2119 was done at the top of the XML, while the information 526 for RFC 6949 is done directly in the references section. 527 The IETF web site is 528 quite 529 nice, 530 isn't it? 531 Unlike other web sites, it doesn't use 532 gratuitous vertical space. 534
536
Basic Lists 538 Bulleted lists are good for items that 539 are not ordered: 541
    543
  • This is the first item.
    • 545
  • This is the second item. Here comes a sub-list: 547
      549
    • This is the first sub-item.
      • 551
    • This is the second sub-item 552 and some more detail on the second sub-item.
      • 554
    • 556
  • This is the item after the sub-list.
    • 558
560 Numbered lists are good for items that are ordered: 562
    564
  1. This is the first item.
    2. 566
  2. This is the second item. Here comes a sub-list, but 567 with letters: 569
      571
    1. This is the first sub-item.
      2. 573
    2. This is the second sub-item
      3. 574
    3. 576
  3. This is the item after the sub-list.
    4. 578
580 And an example of hanging indent. 582
584
Trees
These are bigger plants
586
Lichen
These are smaller plants
588
590 And the always-interesting "format" for lists. 592
    594
  1. An element that gets a funny bullet.
    2. 596
598
600
Figures 602 The following is a figure with a caption. 603 Also, it uses the ampersand (&) and less than 604 (<) characters in the example text. 606
This could be haiku 607 608 The ampersand (&) and 609 less than (<) are two characters 610 that need escaping. 611 612
614 Here are two short figures with no titles and with 615 odd alignment. 617
618 This might appear in the center. 619
621
622 This might appear right-aligned. 623
625 Here is a figure that is actually pulled from somewhere else. 626 627 Remember to check whether that file still exists. 629
631
633
635
Tables 637 The following is a table example. 639 These are sometimes called "inert" gasses. 640 642 643 644 646 647 648 650 651 652 654 655 656 658 659 660 662 663 664 666 667 668 669
NameSymbolAtomic Number
HeliumHe2
NeonNe10
ArgonAr18
KryptonKr36
XenonXe54
RadonRn86
Source: Chemistry 101 671 The following is a right-aligned table with "full" 672 (but not "all") lines between cells. 674 675 676 678 679 681 682 684 685 687
TimeMood
MorningHappy!
AfternoonHappy!
EveningSomber
689
691
IANA Considerations 693 None. 695
697
Security Considerations 699 There are no security considerations for an imaginary 700 Internet Draft. 702
704
Acknowledgements 706 Some of the things included in this draft came from 707 Elwyn Davies' templates. 709
711 713 715 Normative References 716 719 721 Informative References 723 724 725 RFC Series Format Requirements and Future Development 726 727 728 729 730 731 732 733 This is a primary reference work. 734 736 738 739 Random Early Detection (RED) gateways for Congestion 740 Avoidance 741 742 LBL 743 744 745 LBL 746 747 748 749 752 754 756 757 759 4. Security Considerations 761 The examples in this document do not introduce any new security 762 considerations. 764 5. IANA Considerations 766 There are no IANA considerations for this document. 768 6. Acknowledgments 770 The ideas for the examples in this document come from many people 771 over a long period of time. Special thanks go to the Alice Russo and 772 other members of the RFC Design Team for suggestions and debugging 773 help. 775 7. Normative References 777 [XML2RFCv2] 778 Reschke, J., "The 'XML2RFC' version 2 Vocabulary", draft- 779 reschke-xml2rfc (work in progress), 2014. 781 [XML2RFCv3] 782 Hoffman, P., "The 'XML2RFC' version 3 Vocabulary", draft- 783 hoffman-xml2rfc (work in progress), 2014. 785 Authors' Addresses 787 Paul Hoffman 788 VPN Consortium 790 EMail: paul.hoffman@vpnc.org 792 Tony Hansen 793 AT&T Laboratories 794 200 Laurel Ave. South 795 Middletown, NJ 07748 796 USA 798 EMail: tony+rfcv3@maillennium.att.com