01/12/10 12:07:53 (10 years ago)

bump up document dates, update to latest version of rfc2629.xslt

1 edited


  • rfc2629xslt/rfc2629xslt.xml

    r1019 r1095  
    3030        </author>
    32     <date month="September" year="2010"/>
     32    <date month="November" year="2010"/>
    3434    <keyword>RFC2629</keyword>
    3939    <keyword>PDF</keyword>
    4040    <keyword>GRDDL</keyword>
     41    <keyword>epub</keyword>
    4142    <keyword>Dublin Core</keyword>
    4243        </front>
     698<section title="Transforming to ePub" anchor="output.epub">
     700  Experimental transformation to ePub format is available through a set
     701  of stylesheets, and the Unix Shell script
     702  <spanx style="verb">mkepub.sh</spanx> (which requires that "zip" and either
     703  "saxon" or "xsltproc" are installed).
     706  <preamble>
     707    For instance, an epub version of rfc2616.xml can be generated like this:
     708  </preamble>
     709  <artwork type="example">
     710mkepub.sh rfc2616.xml
     1663<reference anchor='RFC5741'>
     1664  <front>
     1665    <title>RFC Streams, Headers, and Boilerplates</title>
     1666    <author initials='L.' surname='Daigle' fullname='Leslie Daigle'/>
     1667    <author initials='O.' surname='Kolkman' fullname='Olaf Kolkman'/>
     1668    <date month='December' year='2009' />
     1669  </front>
     1670  <seriesInfo name='RFC' value='5741' />
    16451674<reference anchor="HTML" target="http://www.w3.org/TR/html401/">
    16461675  <front>
     2412<section title="Producing the IETF 'Boilerplate'" anchor="boilerplate">
     2414  Various attributes of the <spanx style="verb">&lt;rfc&gt;</spanx>
     2415  element plus some child elements of <spanx style="verb">&lt;front&gt;</spanx>
     2416  affect the automatically generated parts of the front page, such as the
     2417  tabular information at the beginning, the "Status Of This Memo", and the
     2418  "Copyright Notice".
     2421  When submitting an Internet Draft, this "boilerplate" is checked
     2422  by "Idnits" (<eref target="http://tools.ietf.org/tools/idnits/"/>) for
     2423  compliance with the current Intellectual Property rules, and thus
     2424  it is important to set the correct values.
     2427  Furthermore, the RFC Production Center uses RFC2629-based tools to
     2428  generate the final RFC text, so the more accurate the supplied information
     2429  is, the less additional work is left, and the risk for errors in producing
     2430  the final (and immutable!) document is reduced.
     2433  <t>
     2434    <x:h>Note:</x:h> this only applies to the case when IETF documents are
     2435    produced. The "private" processing instruction <iref item="private PI pseudo-attribute"/><iref item="Processing Instruction pseudo attributes" subitem="private"/>
     2436    allows to switch off most of the autogeneration logic.
     2437  </t>
    23832440<section title="The /rfc/@ipr Attribute" anchor="attribute-ipr">
    2385   The <spanx style="verb">ipr</spanx> specifies what kind of text is generated
    2386   for the "Status Of This Memo" and "Copyright Notice" sections on the front
    2387   page. When submitting an Internet Draft, the "boilerplate" is checked
    2388   by "Idnits" (<eref target="http://tools.ietf.org/tools/idnits/"/>) for compliance with the current Intellectual Property rules, and thus
    2389   it's important to set the correct value.
    2390 </t>
    2391 <t>
    2392   As of the time of this writing, the attribute value can take a long list of values. As
     2442  As of the time of this writing, this attribute value can take a long list of values. As
    23932443  frequently, this is not the result of a grand plan, but simply for historic
    23942444  reasons. Of these values, only a few are currently in use; all others are
    24002450    <x:h>Note:</x:h> some variations of the boilerplate are selected based
    24012451    on the document's date; therefore it is important to specify the "year",
    2402     "month" and "date" attributes when archiving the XML source of an Internet
    2403     Draft on the day of submission.
     2452    "month" and "day" attributes of the <spanx style="verb">&lt;date&gt;</spanx> element
     2453    when archiving the XML source of an Internet Draft on the day of submission.
    24042454  </t>
    24092459  For further information, refer to <eref target="http://trustee.ietf.org/docs/IETF-Copyright-FAQ.pdf"/>.
     2462  Finally, for the current "Status Of This Memo" text, the <spanx style="verb">submissionType</spanx> attribute
     2463  determines whether a statement about "Code Components" is inserted (this is the
     2464  case for the value "IETF", which also happens to be the default). Other values,
     2465  such as "independent", suppress this part of the text.
     2610<section title="The /rfc/@category Attribute" anchor="attribute-category">
     2612  For RFCs, the <spanx style="verb">category</spanx> determines the "maturity level"
     2613  (see <xref target="RFC2026" x:fmt="of" x:sec="4"/>). The allowed values
     2614  are "std" for "Standards Track", "bcp" for "BCP", "info" for "Informational",
     2615  "exp" for "Experimental", and "historic" for - surprise - "Historic".
     2618  For Internet Drafts, the category attribute is not needed, but <spanx>will</spanx>
     2619  appear on the front page ("Intended Status"). Supplying this information can
     2620  be useful, because reviewers may want to know.
     2623  <t>
     2624    <x:h>Note:</x:h> the Standards Track consists of "Proposed Standard",
     2625    "Draft Standards", and "Internet Standard". These do not appear in the
     2626    boilerplate, thus the category attribute doesn't handle them.
     2627    However, this information can be useful for validity checkers, and thus
     2628    <spanx style="verb">rfc2629.xslt</spanx> supports an extension attribute
     2629    for that purpose (see <xref target="ext-rfc2629.rfc"/> for details).
     2630  </t>
     2634<section title="The /rfc/@submissionType Attribute" anchor="attribute-submissiontype">
     2636  The RFC Editor publishes documents from different "document streams", of which
     2637  the "IETF stream" of course is the most prominent one. Other streams are the "independent stream"
     2638  (used for things like administrative information or April 1st RFCs),
     2639  the "IAB stream" (Internet Architecture Board) and the "IRTF stream" (Internet Research Task Force).
     2642  Not surprisingly, the values for the attribute are "IETF" (the default value),
     2643  "independent", "IAB", and "IRTF".
     2646  <spanx>The values "IAB" and "IRTF" are supported by rfc2629.xslt, but not
     2647  yet allowed by the DTD (waiting for release 1.36 of xml2rfc).</spanx>
     2650  Historically, this did not affect the final appearance of RFCs, except for
     2651  subtle differences in Copyright notices.
     2652  Nowadays (as of <xref target="RFC5741"/>), the stream name appears in the first
     2653  line of the front page, and it also affects the text in the "Status Of This Memo"
     2654  section.
     2657  For current documents, setting <spanx style="verb">submissionType</spanx> attribute will
     2658  have the following effect:
     2659  <list style="symbols">
     2660    <t>
     2661      For RFCs, the stream name appears in the upper left corner of the
     2662      first page (in Internet Drafts, this is either "Network Working Group",
     2663      or the value of the <spanx style="verb">&lt;workgroup&gt;</spanx> element).
     2664    </t>
     2665    <t>
     2666      For RFCs, if affects the whole "Status Of This Memo" section (see
     2667      <xref x:sec="3.2.2" x:fmt="of" target="RFC5741"/>).
     2668    </t>
     2669    <t>
     2670      For all RFCs and Internet Drafts, it determines whether the "Copyright
     2671      Notice" mentions the Copyright on Code Components (see TLP, Section "Text To Be Included in IETF Documents").
     2672    </t>
     2673  </list>
     2676  <t>
     2677    <x:h>Note:</x:h> as of Version 1.35, <spanx style="verb">xml2rfc</spanx>
     2678    (as opposed to <spanx style="verb">rfc2629.xslt</spanx>)
     2679    does <spanx>not</spanx> implement support values other than "IETF" or
     2680    "independent".
     2681  </t>
     2685<section title="The /rfc/@consensus Attribute" anchor="attribute-consensus">
     2687  <spanx>Supported by rfc2629.xslt, but not
     2688  yet allowed by the DTD (waiting for release 1.36 of xml2rfc).</spanx>
     2691  For some of the publication streams (see <xref target="attribute-submissiontype"/>),
     2692  the "Status Of This Memo" section depends on whether there was a consensus
     2693  to publish (again, see <xref x:sec="3.2.2" x:fmt="of" target="RFC5741"/>).
     2696  The <spanx style="verb">consensus</spanx> attribute ("yes"/"no", defaulting to "yes")
     2697  can be used to supply this information. The effect for the various streams is:
     2698  <list style="symbols">
     2699    <t>"independent" and "IAB": none.</t>
     2700    <t>"IETF": mention that there was an IETF consensus.</t>
     2701    <t>"IRTF": mention that there was a research group consensus (where the name of the research
     2702    group is extracted from the <spanx style="verb">&lt;workgroup&gt;</spanx> element).</t>
     2703  </list>
     2707<section title="The /rfc/@number Attribute" anchor="attribute-number">
     2709  For RFCs, this attribute supplies the RFC number.
     2713<section title="The /rfc/@docName Attribute" anchor="attribute-docname">
     2715  For Internet Drafts, this specifies the draft name (which appears
     2716  below the title). The file extension is <spanx>not</spanx> part
     2717  of the draft, so in general it should end with the current draft number
     2718  ("-", plus two digits).
     2721  <t>
     2722  <x:h>Note:</x:h> "Idnits" (<eref target="http://tools.ietf.org/tools/idnits/"/>)
     2723  checks the in-document draft name for consistency with the filename of
     2724  the submitted document.
     2725  </t>
     2729<section title="The /rfc/@obsoletes Attribute" anchor="attribute-obsoletes">
     2731  The RFC Editor maintains a database (<eref target="http://www.rfc-editor.org/rfc.html"/>)
     2732  of all RFCs, including information about which one obsoletes which. Upon publication of an RFC, this
     2733  database is updated from the data on the front page.
     2736  This attribute takes a list of comma-separated RFC <spanx>numbers</spanx>.
     2737  Do <spanx>not</spanx> put the string "RFC" here.
     2741<section title="The /rfc/@updates Attribute" anchor="attribute-updates">
     2743  This is like <spanx style="verb">obsoletes</spanx>, but for the "updates"
     2744  relation.
    25542748  <section title="License" anchor="license">
    25552749  <t>
Note: See TracChangeset for help on using the changeset viewer.