<?xml version="1.0" encoding="UTF-8"?>
  <?xml-stylesheet type="text/xsl" href="rfc2629.xslt" ?>
  <?rfc toc="yes"?>
<?rfc symrefs="yes"?>
<?rfc sortrefs="yes"?>
<?rfc compact="yes"?>
<?rfc comments="yes"?>
<?rfc inline="yes"?>
<?rfc linkmailto="no" ?>
<?rfc rfcedstyle="yes"?>

  <!DOCTYPE rfc SYSTEM "rfc2629.dtd" [
  <!ENTITY RFC1311 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.1311.xml">
  <!ENTITY RFC1818 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.1818.xml">
  <!ENTITY RFC4844 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.4844.xml">
  <!ENTITY RFC5741 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.5741.xml">
  <!ENTITY RFC6635 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.6635.xml">
  <!ENTITY RFC6949 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.6949.xml">
  <!ENTITY RFC7990 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.7990.xml">
  <!ENTITY RFC7996 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.7996.xml">
  ]>

<rfc ipr="trust200902" docName="draft-flanagan-7322bis-00" category="info">


  <front>
    <title abbrev="7322-bis">RFC Style Guide</title>

    <author initials="H." surname="Flanagan" fullname="Heather Flanagan">
      <organization>RFC Editor</organization>
      <address>
        <email>rse@rfc-editor.org</email>
        <uri>https://orcid.org/0000-0002-2647-2220</uri>
      </address>
    </author>


    <author initials="S." surname="Ginoza" fullname="Sandy Ginoza">
      <organization>RFC Editor</organization>
      <address>
        <email>rfc-editor@rfc-editor.org</email>
        <uri>https://www.rfc-editor.org</uri>
      </address>
    </author>

    <date year="2017" month="March" day="10"/>





    <abstract>

<t>This document describes the fundamental and unique style conventions
and editorial policies currently in use for the RFC Series.  It
captures the RFC Editor's basic requirements and offers guidance
regarding the style and structure of an RFC.  Additional guidance is
captured on a website that reflects the experimental nature of that
guidance and prepares it for future inclusion in the RFC Style Guide.
This document obsoletes RFC 7322, "RFC Style Guide".</t>

    </abstract>

  </front>

  <middle>


<section anchor="introduction" title="Introduction">

<t>The ultimate goal of the RFC publication process is to produce
documents that are readable, clear, consistent, and reasonably
uniform.  The basic formatting conventions for RFCs were established
in the 1970s by the original RFC Editor, Jon Postel.  This document
describes the fundamental and unique style conventions and editorial
policies currently in use for the RFC Series <xref target="RFC4844"/>.  It is
intended as a stable, infrequently updated reference for authors,
editors, and reviewers.</t>

<t>The RFC Editor also maintains a web portion of the Style Guide (see
Appendix A.3) that describes issues as they are raised and indicates
how the RFC Editor intends to address them.  As new style issues
arise, the RFC Editor will first address them on the web portion of
the Style Guide <xref target="STYLE-WEB"/>.  These topics may become part of the RFC
Style Guide when it is revised.</t>

<t>The world of technical publishing has generally accepted rules for
grammar, punctuation, capitalization, sentence length and complexity,
parallelism, etc.  The RFC Editor generally follows these accepted
rules as defined by the Chicago Manual of Style (CMOS) <xref target="CMOS"/>, with a
few important exceptions to avoid ambiguity in complex technical
prose and to handle mixtures of text and computer languages, or to
preserve historical formatting rules.  This document presents these
exceptions as applied or recommended by the RFC Editor.</t>

<t>All RFCs begin as Internet-Drafts (also referred to as I-Ds), and a
well-written and properly constructed Internet-Draft <xref target="ID-GUIDE"/>
provides a strong basis for a good RFC.  The RFC Editor accepts
Internet-Drafts from specified streams for publication [RFC4844] and
applies the rules and guidelines for the RFC Series during the
editorial process.</t>

</section>

<section anchor="rfc-editors-philosophy" title="RFC Editor's Philosophy">

<t>Authors may find it helpful to understand the RFC Editor's goals
during the publication process, namely to:</t>

<t><list style='symbols'>
  <t>Prepare the document according to RFC style and format.</t>
  <t>Make the document as clear, consistent, and readable as possible.</t>
  <t>Correct larger content/clarity issues; flag any unclear passages
for author review.</t>
  <t>Fix inconsistencies (e.g., terms that appear in various forms,
text that appears multiple times, or inconsistent
capitalization).</t>
</list></t>

<t>We strive for consistency within:</t>

<t>a. the document,</t>

<t>b. a cluster of documents <xref target="CLUSTER"/>, and</t>

<t>c. the series of RFCs on the subject matter.</t>

<t>The editorial process of the RFC Editor is not an additional
technical review of the document.  Where the RFC Editor may suggest
changes in wording for clarity and readability, it is up to the
author, working group, or stream-approving body to determine whether
the changes have an impact on the technical meaning of the document
[RFC4844].  If the original wording is a more accurate representation
of the technical content being described in the document, it takes
precedence over editorial conventions.</t>

<t>The activity of editing sometimes creates a tension between author
and editor.  The RFC Editor attempts to minimize this conflict for
RFC publication while continually striving to produce a uniformly
excellent document series.  The RFC Editor refers to this fundamental
tension as "editorial balance,"" and maintaining this balance is a
continuing concern for the RFC Editor.  There is a prime directive
that must rule over grammatical conventions: do not change the
intended meaning of the text.</t>

<t>If the RFC Editor cannot edit a document without serious risk of
altering the meaning, it may be returned to the stream-approving body
for review.  See Appendix A.2 for more information.</t>

</section>

<section anchor="rfc-style-conventions" title="RFC Style Conventions">

<t>This Style Guide does not use terminology as defined in RFC 2119
<xref target="BCP14"/>.  In this document, lowercase use of "must" and "should"
indicates changes the RFC Editor will make automatically to conform
with this Style Guide versus those that may be questioned if not
applied.  The lowercase "must" indicates those changes that will be
applied automatically and are not at the discretion of the authors.
The lowercase "should" indicates the RFC Editor's recommended use,
but conformance with the recommendations is not required; the RFC
Editor may question whether the guidance may be applied.</t>

<section anchor="language" title="Language">

<t>The RFC publication language is English.  Spelling may be either
American or British, as long as an individual document is internally
consistent.  Where both American and British English spelling are
used within a document or cluster of documents, the text will be
modified to be consistent with American English spelling.</t>

</section>

<section anchor="punctuation" title="Punctuation">

<t><list style='symbols'>
  <t>A comma is used before the last item of a series, e.g.,  <vspace blankLines='1'/>
"TCP service is reliable, ordered, and full duplex"</t>
  <t>When quoting literal text, punctuation is placed outside quotation
marks, e.g.,  <vspace blankLines='1'/>
Search for the string "Error Found".  <vspace blankLines='1'/>
When quoting general text, such as general text from another RFC,
punctuation may be included within the quotation marks, e.g.,  <vspace blankLines='1'/>
RFC 4844 indicates that "RFCs are available free of charge to
   anyone via the Internet. " <vspace blankLines='1'/>
Quotation marks are not necessary when text is formatted as a
block quotation.</t>
</list></t>

</section>

<section anchor="dns-names-and-uris" title="DNS Names and URIs">

<t>DNS names, whether or not in URIs, that are used as generic examples
in RFCs should use the particular examples defined in "Reserved Top
Level DNS Names" <xref target="BCP32"/>, to avoid accidental conflicts.</t>

<t>Angle brackets are strongly recommended around URIs <xref target="STD66"/>, e.g.,</t>

<t>&lt;http://example.com/ &gt;</t>

<t>The use of HTTPS rather than HTTP is strongly encouraged.</t>

</section>

<section anchor="capitalization" title="Capitalization">

<t><list style='symbols'>
  <t>Capitalization must be consistent within the document and ideally
should be consistent with related RFCs.  Refer to the online table
of decisions on consistent usage of terms in RFCs <xref target="TERMS"/>.</t>
  <t>Per CMOS guidelines, the major words in RFC titles and section
titles should be capitalized (this is sometimes called "title
case").  Typically, all words in a title will be capitalized,
except for internal articles, prepositions, and conjunctions.</t>
  <t>Section titles that are in sentence form will follow typical
sentence capitalization.</t>
  <t>Titles of figures may be in sentence form or use title case.</t>
</list></t>

</section>

<section anchor="citations" title="Citations">

<t><list style='symbols'>
  <t>References and citations must match.  That is, there must be a
reference for each citation used, and vice versa.</t>
  <t>Citations must be enclosed in square brackets (e.g., "[CITE1]").</t>
  <t>A citation/reference tag must not contain spaces.
    <list>
    <t>Example: "[RFC2119]" rather than "[RFC 2119]"</t>
    </list></t>
   <t>However, the proper textual naming of an RFC contains a space.
     <list>
     <t>Example: "See RFC 2119 <xref target="BCP14"/> for more information."</t>
   </list></t>
  <t>Cross-references within the body of the memo and to other RFCs
must use section numbers rather than page numbers, as pagination
may change per format and device.</t>
  <t>An in-text citation may a) follow the subject for which it is being cited
    or b) be read as part of the text. For example:
    <list>
    <t>a) As part of the transition to IPv6, NAT64 [RFC6146] and DNS64
     [RFC6147] technologies will be utilized by some access networks to
     provide IPv4 connectivity for IPv6-only nodes [RFC6144].</t>
   </list></t>
 </list></t>

    <t>or
      <list>

      <t>b) Note that SAVI raises a number of important privacy considerations
       that are discussed more fully in [RFC6959].</t>
     </list></t>

<t>We recommend using a) and strongly recommend consistent use of one style throughout.</t>

</section>

<section anchor="abbreviation-rules" title="Abbreviation Rules">

<t>Abbreviations should be expanded in document titles and upon first
use in the document.  The full expansion of the text should be
followed by the abbreviation itself in parentheses.  The exception is
an abbreviation that is so common that the readership of RFCs can be
expected to recognize it immediately; examples include (but are not
limited to) TCP, IP, SNMP, and HTTP.  The online list of
abbreviations <xref target="ABBR"/> provides guidance.  Some cases are marginal, and
the RFC Editor will make the final judgment, weighing obscurity
against complexity.</t>

<t>Note: The online list of abbreviations is not exhaustive or
   definitive.  It is a list of abbreviations appearing in RFCs and
   sometimes reflects discussions with authors, Working Group Chairs,
   and/or Area Directors (ADs).  Note that some abbreviations have
   multiple expansions.  Additionally, this list includes some terms
   that look like abbreviations but that are actually fixed names for
   things and hence cannot and should not be expanded.  These are
   noted as "No Expansion".</t>

</section>

<section anchor="compounds" title="RFCs as Compounds">
  <t>Whenever possible:
  <list style='symbols'>
    <t>Hyphenated compounds formed with RFC numbers should be avoided;
      this can be accomplished by: rewording the sentence (e.g., [RFC5011]-style
      rollover –> rollover as described in RFC 5011). </t>
    <t>adding a note in either the Terminology or Conventions section mentioning
      the RFC so that other occurrences throughout the text will be understood by
      the reader to be in the style of said RFC (e.g., This document uses the term
      “rollover” as defined in RFC 5011.).</t>
    </list></t>
    <t>If use of an RFC number in attributive position is unavoidable, the
      preferred form should appear as in the example “RFC 5011-style rollover”.
      That is:
      <list style='symbols'>
        <t>no hyphen between “RFC” and the number (don’t use RFC-5011-style rollover)</t>
        <t>avoid hyphenating citations with text (don’t use [RFC5011]-style rollover)</t>
      </list>
    </t>
  </section>

  <section anchor="images" title="Images and Figures">
  <t>The goal of having images within an RFC is to convey information. A good
    diagram or image expresses information quickly, clearly, and with low chance
    of misunderstanding. Technically correct but confusing images get in the
    way of understanding and implementation.</t>
    <t><list style='symbols'>
      <t>Images should be legible when displayed on a standard screen (1920x1080)
        and printed on either A4 or US Letter paper. Any text within the diagram
        should be readable at that resolution. </t>
      <t>Authors should use black on white, not white on black. No color or
        greyscale <xref target="RFC7990"/><xref target="RFC7996"/></t>
      <t>Keep your diagrams as simple as possible. If an object in the diagram
        is not immediately relevant, leave it out. If you have several ideas you
        want to convey, consider using more than one diagram.</t>
      <t>San-serif fonts are generally considered more readable for digital
        material. [citation needed]</t>
      <t>The style of diagrams within an RFC should be consistent (fonts, shapes,
        lines). For example, if you you use a dashed line to indicate a certain
        type of packet flow, then continue to use that style of line consistently.
        This is encouraged within a single RFC and also within a cluster of RFCs.</t>
      <t>Line styles, including thickness, color, and arrow types, are easy
        methods to convey a particular meaning to the reader. Consistently use
        the same line styles to convey a particular meaning throughout all
        diagrams within an RFC in order to avoid confusing the reader.</t>
      <t>Flowcharts: avoid crossing the lines if possible.</t>
    </list></t>
  </section>


</section>

<section anchor="structure-of-an-rfc" title="Structure of an RFC">

<t>A published RFC will largely contain the elements in the following
list.  Some of these sections are required, as noted.  Those sections
marked with "*" will be supplied by the RFC Editor during the
editorial process when necessary.  Sections are allowed to contain
nothing but subsections.  The rules for each of these elements are
described in more detail below.
<list>

<t>First-page header                      * [Required]</t>
<t>Title                                    [Required]</t>
<t>Abstract                                 [Required]</t>
<t>RFC Editor or Stream Note              * [Upon request]</t>
<t>Status of This Memo                    * [Required]</t>
<t>Copyright Notice                       * [Required]</t>
<t>Table of Contents                      * [Required]</t>
<t>Body of the Memo                         [Required]</t>
   <t><list>
  <t>1.  Introduction                       [Required]</t>
  <t>2.  Requirements Language (RFC 2119)</t>
  <t>3.  ...</t>
  <t>     MAIN BODY OF THE TEXT</t>
  <t>6.  ...</t>
  <t>7.  IANA Considerations                [Required]</t>
  <t>8.  Internationalization Considerations</t>
  <t>9.  Security Considerations            [Required]</t>
  <t>10.  References</t>
  <t>10.1.  Normative References</t>
  <t>10.2.  Informative References</t>
  <t>Appendix A.</t>
  <t>Appendix B.</t>
</list></t>
<t>Index</t>
<t>Acknowledgements</t>
<t>Contributors</t>
<t>Author's Address                         [Required]</t>
 </list></t>

<t>Within the body of the memo, the order shown above is strongly
recommended.  Exceptions may be questioned.  Outside the body of the
memo, the order above is required.  The section numbers above are for
illustrative purposes; they are not intended to correspond to
required numbering in an RFC.</t>

<t>The elements preceding the body of the memo should not be numbered.
Typically, the body of the memo will have numbered sections and the
appendices will be labeled with letters.  Any sections that appear
after the appendices should not be numbered or labeled (e.g., see
"Contributors" above).</t>

<section anchor="first-page-header" title="First-Page Header">

<t>Headers will follow the format described in "RFC Streams, Headers,
and Boilerplates" <xref target="RFC5741"/> and its successors.  In addition, the
following conventions will apply.</t>

<section anchor="authoreditor" title="Author/Editor">

<t>The determination of who should be listed as an author or editor on
an RFC is made by the stream.</t>

<t>The author's name (initial followed by family name) appears on the
first line of the heading.  Some variation, such as additional
initials or capitalization of family name, is acceptable.  Once the
author has selected how their name should appear, they should use
that display consistently in all of their documents.</t>

<t>The total number of authors or editors on the first page is generally
limited to five individuals and their affiliations.  If there is a
request for more than five authors, the stream-approving body needs
to consider if one or two editors should have primary responsibility
for this document, with the other individuals listed in the
Contributors or Acknowledgements section.  There must be a direct
correlation of authors and editors in the document header and the
Authors' Addresses section.  These are the individuals that must sign
off on the document during the AUTH48 process and respond to
inquiries, such as errata.</t>

</section>
<section anchor="organization" title="Organization">

<t>The author's organization is indicated on the line following the
author's name.</t>

<t>For multiple authors, each author name appears on its own line,
followed by that author's organization.  When more than one author is
affiliated with the same organization, the organization can be
"factored out," appearing only once following the corresponding
Author lines.  However, such factoring is inappropriate when it would
force an unacceptable reordering of author names.</t>

<t>If an author cannot or will not provide an affiliation for any
reason, "Independent", "Individual Contributor", "Retired", or some
other term that appropriately describes the author's affiliation may
be used.  Alternatively, a blank line may be included in the document
header when no affiliation is provided.</t>

</section>
<section anchor="issn-2070-1721" title="ISSN: 2070-1721">

<t>The RFC Series has been assigned an International Standard Serial
Number of 2070-1721 <xref target="ISO3297"/>.  It will be included by the
RFC Editor.</t>

</section>
<section anchor="updates-and-obsoletes" title="Updates and Obsoletes">

<t>When an RFC obsoletes or updates a previously published RFC or RFCs,
this information is included in the document header.  For example:</t>

<t>"Updates: nnnn" or "Updates: nnnn, ..., nnnn"</t>

<t>"Obsoletes: nnnn" or "Obsoletes: nnnn, ..., nnnn"</t>

<t>If the document updates or obsoletes more than one document, numbers
will be listed in ascending order.</t>

</section>
</section>
<section anchor="full-title" title="Full Title">

<t>The title must be centered below the rest of the heading, preceded by
two blank lines and followed by one blank line.</t>

<t>Choosing a good title for an RFC can be a challenge.  A good title
should fairly represent the scope and purpose of the document without
being either too general or too specific and lengthy.</t>

<t>Abbreviations in a title must generally be expanded when first
encountered (see Section 3.6 for additional guidance on
abbreviations).</t>

<t>It is often helpful to follow the expansion with the parenthesized
abbreviation, as in the following example:</t>

<figure><artwork><![CDATA[
                  Encoding Rules for the
  Common Routing Encapsulation Extension Protocol (CREEP)
]]></artwork></figure>

<t>The RFC Editor recommends that documents describing a particular
company's private protocol should bear a title of the form "Foo's ...
Protocol" (where Foo is a company name), to clearly differentiate it
from a protocol of more general applicability.</t>

</section>
<section anchor="abstract-section" title="Abstract Section">

<t>Every RFC must have an Abstract that provides a concise and
comprehensive overview of the purpose and contents of the entire
document, to give a technically knowledgeable reader a general
overview of the function of the document.</t>

<t>Composing a useful Abstract generally requires thought and care.
Usually, an Abstract should begin with a phrase like "This memo ..."
or "This document ..."  A satisfactory Abstract can often be
constructed in part from material within the Introduction section,
but an effective Abstract may be shorter, less detailed, and perhaps
broader in scope than the Introduction.  Simply copying and pasting
the first few paragraphs of the Introduction is allowed, but it may
result in an Abstract that is both incomplete and redundant.  Note
also that an Abstract is not a substitute for an Introduction; the
RFC should be self-contained as if there were no Abstract.</t>

<t>Similarly, the Abstract should be complete in itself.  It will appear
in isolation in publication announcements and in the online index of
RFCs.  Therefore, the Abstract must not contain citations.</t>

</section>
<section anchor="rfc-editor-or-stream-notes-section" title="RFC Editor or Stream Notes Section">

<t>A stream-approving body may approve the inclusion of an editorial
note to explain anything unusual about the process that led to the
document's publication or to note a correction.  In this case, a
stream note section will contain such a note.</t>

<t>Additionally, an RFC Editor Note section may contain a note inserted
by the RFC Editor to highlight special circumstances surrounding
an RFC.</t>

</section>
<section anchor="status-of-this-memo-section" title="Status of This Memo Section">

<t>The RFC Editor will supply an appropriate "Status of This Memo" as
defined in RFC 5741 [RFC5741] and "Format for RFCs in the IAB Stream"
<xref target="IAB-FORM"/>.</t>

</section>
<section anchor="copyright-licenses-and-ipr-boilerplate-section" title="Copyright, Licenses, and IPR Boilerplate Section">

<t>The full copyright and license notices are available on the IETF
Trust Legal Provisions documents website <xref target="IETF-TRUST"/>.</t>

</section>
<section anchor="table-of-contents-section" title="Table of Contents Section">

<t>A Table of Contents (TOC) is required in all RFCs.  It must be
positioned after the Copyright Notice and before the Introduction.</t>

</section>
<section anchor="body-of-the-memo" title="Body of the Memo">

<t>Following the TOC is the body of the memo.</t>

<t>Each RFC must include an Introduction section that (among other
things) explains the motivation for the RFC and (if appropriate)
describes the applicability of the document, e.g., whether it
specifies a protocol, provides a discussion of some problem, is
simply of interest to the Internet community, or provides a status
report on some activity.  The body of the memo and the Abstract must
be self-contained and separable.  This may result in some duplication
of text between the Abstract and the Introduction; this is
acceptable.</t>

<section anchor="introduction-section" title="Introduction Section">

<t>The Introduction section should always be the first section following
the TOC (except in the case of MIB module documents).  While
"Introduction" is recommended, authors may choose alternate titles
such as "Overview" or "Background".  These alternates are acceptable.</t>

<t>For MIB module documents, common practice has been for "The
Internet-Standard Management Framework" <xref target="MIB-BOILER"/> text to appear
as Section 1.</t>

</section>
<section anchor="requirements-language-section" title="Requirements Language Section">

<t>Some documents use certain capitalized words ("MUST", "SHOULD", etc.)
to specify precise requirement levels for technical features.
RFC 2119 <xref target="BCP14"/> defines a default interpretation of these
capitalized words in IETF documents.  If this interpretation is used,
RFC 2119 must be cited (as specified in RFC 2119) and included as a
normative reference.  Otherwise, the correct interpretation must be
specified in the document.</t>

<t>This section must appear as part of the body of the memo (as defined
by this document).  It must appear as part of, or subsequent to, the
Introduction section.</t>

<t>These words are considered part of the technical content of the
document and are intended to provide guidance to implementers about
specific technical features, generally governed by considerations of
interoperability.  RFC 2119 says:</t>

<t>Imperatives of the type defined in this memo must be used with
   care and sparingly.  In particular, they MUST only be used where
   it is actually required for interoperation or to limit behavior
   which has potential for causing harm (e.g., limiting
   retransmisssions)  For example, they must not be used to try to
   impose a particular method on implementers where the method is not
   required for interoperability.</t>

</section>
<section anchor="iana-considerations-section" title="IANA Considerations Section">

<t>For guidance on how to register IANA-related values or create new
registries to be managed by IANA, see "Guidelines for Writing an IANA
Considerations Section in RFCs" <xref target="BCP26"/>.</t>

<t>The RFC Editor will update text accordingly after the IANA
assignments have been made.  It is helpful for authors to clearly
identify where text should be updated to reflect the newly assigned
values.  For example, the use of "TBD1", "TBD2", etc., is recommended
in the IANA Considerations section and in the body of the memo.</t>

<t>If the authors have provided values to be assigned by IANA, the
RFC Editor will verify that the values inserted by the authors match
those that have actually been registered on the IANA site.  When
writing a given value, consistent use of decimal or hexadecimal is
recommended.</t>

<t>If any of the IANA-related information is not clear, the RFC Editor
will work with IANA to send queries to the authors to ensure that
assignments and values are properly inserted.</t>


</section>
<section anchor="internationalization-considerations-section" title="Internationalization Considerations Section">

<t>All RFCs that deal with internationalization issues should have a
section describing those issues; see "IETF Policy on Character Sets
and Languages" <xref target="BCP18"/>, Section 6, for more information.</t>

</section>
<section anchor="security-considerations-section" title="Security Considerations Section">

<t>All RFCs must contain a section that discusses the security
considerations relevant to the specification; see "Guidelines for
Writing RFC Text on Security Considerations" <xref target="BCP72"/> for more
information.</t>

<t>Note that additional boilerplate material for RFCs containing MIB and
YANG modules also exists.  See "Security Guidelines for IETF MIB
Modules" <xref target="MIB-SEC"/> and "yang module security considerations"
<xref target="YANG-SEC"/> for details.</t>

</section>
<section anchor="references-section" title="References Section">

<t>The reference list is solely for recording reference entries.
Introductory text is not allowed.</t>

<t>The RFC style allows the use of any of a variety of reference styles,
as long as they are used consistently within a document.  However,
where necessary, some reference styles have been described for use
within the Series.  See the examples in this document.</t>

<t>The RFC Editor ensures that references to other RFCs refer to the
most current RFC available on that topic (unless provided with a
reason not to do so).  When referring to an obsoleted document, it is
common practice to also refer to the most recent version.</t>

<t>A reference to an RFC that has been assigned an STD <xref target="RFC1311"/>, BCP
<xref target="RFC1818"/>, or FYI <xref target="FYI90"/> sub-series number must include the
sub-series number of the document.  Note that the FYI series was
ended by RFC 6360.  RFCs that were published with an FYI sub-series
number and still maintain the FYI number must include the sub-series
number in the reference.</t>

<t>Reference lists must indicate whether each reference is normative or
informative, where normative references are essential to implementing
or understanding the content of the RFC and informative references
provide additional information.  More information about normative and
informative references may be found in the IESG's statement
"Normative and Informative References" <xref target="REFS"/>.  When both normative
and informative references exist, the references section should be
split into two subsections:</t>

<t>Templates are available on the RFC Editor website for the XML format of
  certain references <xref target="REFEXAMPLE"/>.</t>

<t>s.  References</t>

<t>s.1.  Normative References</t>

<figure><artwork><![CDATA[
        xxx
        ...
        xxx
]]></artwork></figure>

<t>s.2.  Informative References</t>

<figure><artwork><![CDATA[
        xxx
        ...
        xxx
]]></artwork></figure>

<t>References will generally appear in alphanumeric order by citation
tag.  Where there are only normative or informative references, no
subsection is required; the top-level section should say "Normative
References" or "Informative References".</t>

<t>Normative references to Internet-Drafts will cause publication of the
RFC to be suspended until the referenced draft is also ready for
publication; the RFC Editor will then update the entry to refer to
the RFC and publish both documents simultaneously.</t>

<section anchor="uris-in-rfcs" title="URIs in RFCs">

<t>The use of URIs in references is acceptable, as long as the URI is
the most stable (i.e., unlikely to change and expected to be
continuously available) and direct reference possible.  The URI will
be verified as valid during the RFC editorial process.</t>

<t>If a dated URI (one that includes a timestamp for the page) is
available for a referenced web page, its use is required.</t>

<t>Note that URIs may not be the sole information provided for a
reference entry.</t>

<t>The use of HTTPS rather than HTTP is strongly encouraged.</t>


</section>
<section anchor="referencing-rfcs" title="Referencing RFCs">

<t>The following format is required for referencing RFCs. The Stream
  abbreviation should be used; when no stream is available, as with legacy RFCs,
  this may be left blank. </t>
<t>Note the ordering for multiple authors: the format of
  the name of the last author listed is different than that of all previous
  authors in the list.</t>

<t>For one author or editor:</t>

<t>[RFCXXXX] Last name, First initial., Ed. (if applicable),
             "RFC Title", Stream, Sub-series number (if applicable),
             RFC number, DOI, Date of publication,
             <eref target="http://www.rfc-editor.org/info/rfc#">http://www.rfc-editor.org/info/rfc#</eref>.</t>

<t>Example:</t>

<t>[RFC3080] Rose, M., "The Blocks Extensible Exchange
             Protocol Core," IETF, RFC 3080, DOI 10.17487/RFC3080, March 2001,
             <eref target="http://www.rfc-editor.org/info/rfc3080">http://www.rfc-editor.org/info/rfc3080</eref>.</t>

<t>For two authors or editors:</t>

<t>[RFCXXXX] Last name, First initial., Ed. (if applicable)
             and First initial. Last name, Ed. (if applicable),
             "RFC Title", Stream, Sub-series number (if applicable),
             RFC number, DOI, Date of publication,
             <eref target="http://www.rfc-editor.org/info/rfc#">http://www.rfc-editor.org/info/rfc#</eref>.</t>

<t>Example:</t>

<t>[RFC6323] Renker, G. and G. Fairhurst, "Sender RTT
             Estimate Option for the Datagram Congestion
             Control Protocol (DCCP)", IETF, RFC 6323, DOI 10.17487/RFC6323, July 2011,
             <eref target="http://www.rfc-editor.org/info/rfc6323">http://www.rfc-editor.org/info/rfc6323</eref>.</t>

<t>For three or more authors or editors:</t>

<t>[RFCXXXX] Last name, First initial., Ed. (if applicable),
             Last name, First initial., Ed. (if applicable),
             and First initial. Last name, Ed. (if applicable),
             "RFC Title", Stream, Sub-series number (if applicable),
             RFC number, DOI, Date of publication,
             <eref target="http://www.rfc-editor.org/info/rfc#">http://www.rfc-editor.org/info/rfc#</eref>.</t>

<t>Example:</t>

<t>[RFC6429] Bashyam, M., Jethanandani, M., and A. Ramaiah,
             "TCP Sender Clarification for Persist
             Condition", IETF, RFC 6429, DOI 10.17487/RFC6429, December 2011,
             <eref target="http://www.rfc-editor.org/info/rfc6429">http://www.rfc-editor.org/info/rfc6429</eref>.</t>

</section>
<section anchor="referencing-stds-and-bcps" title="Referencing STDs and BCPs">

<t>Internet Standards (STDs) and Best Current Practices (BCPs) may
consist of a single RFC or multiple RFCs.  When an STD or BCP that
contains multiple RFCs is referenced, the reference entry should
include ALL of the RFCs comprising that sub-series.  The authors
should refer to specific RFC numbers as part of the text (not as
citations) and cite the sub-series number.  Inclusion of the URI to
the STD or BCP info page (see Section 3.2.3 of <xref target="RFC5741"/>) is
recommended.  The text should appear as follows:</t>

<t>See RFC 1034 [STD13].</t>

<t>For an STD or BCP that contains one RFC:</t>

<t>[STDXXX]  Last name, First initial., Ed. (if applicable),
             "RFC Title", Stream, Sub-series number, RFC number, DOI, Date of
             publication, <eref target="http://www.rfc-editor.org/info/std#">http://www.rfc-editor.org/info/std#</eref>.</t>

<t>Example:</t>

<t>[STD72]   Gellens, R. and J. Klensin, "Message Submission
             for Mail", IETF, STD 72, RFC 6409, DOI 10.17487/RFC6409, November 2011,
             <eref target="http://www.rfc-editor.org/info/std72">http://www.rfc-editor.org/info/std72</eref>.</t>

<t>For an STD or BCP that contains two or more RFCs:</t>

<t>[STDXXX]  Last name, First initial., Ed. (if applicable),
             "RFC Title", Stream, Sub-series number, RFC number, DOI, Date of
             publication.</t>

<figure><artwork><![CDATA[
         Last name, First initial., Ed. (if applicable)
         and First initial. Last name, Ed. (if applicable),
         "RFC Title", Stream, Sub-series number, RFC number, DOI,
         Date of publication.

         <http://www.rfc-editor.org/info/std#>
]]></artwork></figure>

<t>Example:</t>

<t>[STD13]   Mockapetris, P., "Domain names - concepts and
             facilities", STD 13, RFC 1034, DOI 10.17487/RFC1034, November 1987.</t>

<figure><artwork><![CDATA[
  Mockapetris, P., "Domain names - implementation and
  specification", STD 13, RFC 1035, DOI 10.17487/RFC1035,
  November 1987.

         <http://www.rfc-editor.org/info/std13>
]]></artwork></figure>

</section>
<section anchor="referencing-internet-drafts" title="Referencing Internet-Drafts">

<t>References to Internet-Drafts may only appear as informative
references.  Given that several revisions of an I-D may be produced
in a short time frame, references must include the posting date
(month and year), the full Internet-Draft file name (including the
version number), and the phrase "Work in Progress".  Authors may
reference multiple versions of an I-D.  If the referenced I-D was
also later published as an RFC, then that RFC must also be listed.</t>

<t>[SYMBOLIC-TAG]  Last name, First initial., Ed. (if applicable)
                   and First initial. Last name, Ed. (if
                   applicable), "I-D Title", Work in Progress,
                   draft-string-NN, Month Year.
</t>

<t>Example:</t>

<t>[RFC-STYLE] Flanagan, H. and S. Ginoza, "RFC Style Guide",
               Work in Progress, draft-flanagan-style-01,
               June 2013.
</t>

</section>
<section anchor="referencing-errata" title="Referencing Errata">

<t>The following format is required when a reference to an erratum
report is necessary:</t>

<t>[ErrNumber]  RFC Errata, Erratum ID number, RFC number, &lt;URI&gt;.</t>

<t>[Err1912]  RFC Errata, Erratum ID 1912, RFC 2978, xxx.</t>

</section>
<section anchor="referencing-other-standards-development-organizations-sdos" title="Referencing Other Standards Development Organizations (SDOs)">

<t>The following format is suggested when referencing a document or
standard from another SDO in which authors are listed:</t>

<t>[SYMBOLIC-TAG]
  <list>
          <t> Last name, First initial. and First initial. Last name,</t>
          <t> "Document Title", Document reference number, Date of </t>
          <t> publication, &lt;URI if available &gt;.</t>
   </list></t>

<t>[W3C.REC-xml11]
  <list>
          <t> Bray, T., Paoli, J., Sperberg-McQueen, C., Maler, E.,</t>
          <t> Yergeau, F., and J.  Cowan, "Extensible Markup Language</t>
          <t> (XML) 1.1 (Second Edition)", W3C Recommendation</t>
          <t> REC-xml11-20060816, August 2006, </t>
          <t> &lt;http://www.w3.org/TR/2006/REC-xml11-20060816 &gt;.</t>
  </list></t>



<t>The order of authors in the list is the same as the order
shown on the actual document and that the common, abbreviated form of
the SDO is used.</t>

<t>Alternatively, when no list of authors is available, the following
format is recommended:</t>

<figure><artwork><![CDATA[[SYMBOLIC-TAG]  Organization, "Document Title", Document
                   reference number, Date of publication,
                   <URI if available>.
]]></artwork></figure>

<t>Example:</t>

<figure><artwork><![CDATA[[IEEE802.1Q]  IEEE, "Local and Metropolitan Area
                 Networks -- Media Access Control (MAC)
                 Bridges and Virtual Bridged Local Area
                 Networks", IEEE Std 802.1Q-2011, August 2011,
                 <http://standards.ieee.org/findstds/standard/
                 802.1Q-2011.html>
]]></artwork></figure>

<t>Per the IEEE coordination team, listing dates for IEEE standards is not
recommended unless there is a need to cite a particular section, in which case
the dated reference is appropriate. An RFC with a dated IEEE reference suggests
that the RFC only applies to that specific IEEE specification.</t>

</section>

<section anchor="emailref" title="Referencing Email on Mailing Lists">
<t>When referencing emails to mailing lists, the template provided here should be used:
  <list>
    <t>[reftag] Sender, A., "Subject: Subject line", message to the </t>
    <t>listname mailing list, DD Month YYYY, &lt;URL &gt;.</t>
  </list></t>
</section>

</section>
</section>
<section anchor="appendices-section" title="Appendices Section">

<t>The RFC Editor recommends placing references before the Appendices.
Appendices should be labeled as "Appendix A.  Title", "A.1.  Title",
"Appendix B.  Title", etc.</t>

</section>

<section anchor="index" title="Index">
  <t>If included, an index appears directly after any appendices and before the
    Acknowledgements (if any). Where applicable, it appears before the “IAB
    Members at the Time of Approval” section.</t>
</section>

<section anchor="acknowledgements-section" title="Acknowledgements Section">

<t>This optional section may be used instead of, or in addition to, a
Contributors section.  It is often used by authors to publicly thank
those who have provided feedback regarding a document and to note any
documents from which text was borrowed.</t>

</section>
<section anchor="contributors-section" title="Contributors Section">

<t>This optional section acknowledges those who have made significant
contributions to the document.</t>

<t>In a similar fashion to the Author�s Address section, the RFC Editor
does not make the determination as to who should be listed as a
contributor to an RFC.  The determination of who should be listed as
a contributor is made by the stream.</t>

<t>The Contributors section may include brief statements about the
nature of particular contributions (e.g., "Sam contributed Section 3"), and
it may also include affiliations of listed contributors.  At the
discretion of the author(s), contact addresses may also be included
in the Contributors section, for those contributors whose knowledge
makes them useful future contacts for information about the RFC.  The
format of any contact information should be similar to the format of
information in the Author�s Address section.</t>

</section>
<section anchor="authors-address-or-authors-addresses-section" title="Author's Address or Authors' Addresses Section">

<t>This required section gives contact information for the author(s)
   listed in the first-page header.</t>

<t>Contact information must include a long-lived email address and
   optionally may include a postal address and/or telephone number.  If
   the postal address is included, it should include the country name,
   using the English short name listed by the ISO 3166 Maintenance
   Agency <xref target="ISO_OBP"/>.  The purpose of this section is to
   (1) unambiguously define author identity (e.g., the John Smith who
   works for FooBar Systems) and (2) provide contact information for
   future readers who have questions or comments.</t>

<t>The practice of munged email addresses (i.e., altering an email
   address to make it less readable to bots and web crawlers to avoid
   spam) is not appropriate in an archival document series.  Author
   contact information is provided so that readers can easily contact
   the author with questions and/or comments.  Address munging is not
   allowed in RFCs.</t>

</section>
</section>

<section anchor="security-considerations" title="Security Considerations">

<t>This document has no security considerations.</t>

</section>

<section anchor="iana-considerations" title="IANA Considerations">

<t>This document has no IANA considerations.</t>

</section>

</middle>


<back>

<references title="Normative References">

<reference anchor="STYLE-WEB" target="http://www.rfc-editor.org/rfc-style-guide/part2.html">
  <front>
    <title>Web Portion of the Style Guide</title>
    <author>
      <organization>RFC Editor</organization>
    </author>
    <date/>
  </front>
</reference>

</references>

<references title="Informative References">

<reference anchor="ABBR" target="https://www.rfc-editor.org/rfc-style-guide/abbrev.expansion.txt">
  <front>
    <title>RFC Editor Abbreviations List</title>
    <author>
      <organization>RFC Editor</organization>
    </author>
    <date/>
  </front>
</reference>

<reference anchor="BCP14" target="https://www.rfc-editor.org/info/bcp14">
  <front>
    <title>Key words for use in RFCs to Indicate Requirement Levels</title>
    <author initials="S." surname="Bradner" fullname="Scott Bradner"/>
    <date year="1997" month="March"/>
  </front>
  <seriesInfo name="BCP" value="14"/>
  <seriesInfo name="RFC" value="2119"/>
</reference>

<reference anchor="BCP18" target="https://www.rfc-editor.org/info/bcp18">
  <front>
    <title>IETF Policy on Character Sets and Languages</title>
    <author initials="H." surname="Alvestrand" fullname="Harald Alvestrand"/>
    <date year="1998" month="January"/>
  </front>
  <seriesInfo name="BCP" value="18"/>
  <seriesInfo name="RFC" value="2277"/>
</reference>

<reference anchor="BCP26" target="https://www.rfc-editor.org/info/bcp26">
  <front>
    <title>Guidelines for Writing an ANA Considerations Section in RFCs</title>
    <author initials="H." surname="Alvestrand" fullname="Harald Alvestrand"/>
    <author initials="T." surname="Narten"/>
    <date year="2008" month="May"/>
  </front>
  <seriesInfo name="BCP" value="26"/>
  <seriesInfo name="RFC" value="5226"/>
</reference>

<reference anchor="BCP32" target="https://www.rfc-editor.org/info/bcp32">
  <front>
    <title>Reserved Top Level DNS Names</title>
    <author initials="D." surname="Eastlake 3rd"/>
    <author initials="A." surname="Panitz"/>
    <date year="1999" month="June"/>
  </front>
  <seriesInfo name="BCP" value="32"/>
  <seriesInfo name="RFC" value="2606"/>
</reference>

<reference anchor="BCP72" target="https://www.rfc-editor.org/info/bcp72">
  <front>
    <title>Guidelines for Writing RFC Text on Security Considerations</title>
    <author initials="E." surname="Rescorla"/>
    <author initials="B." surname="Korver"/>
    <date year="2003" month="July"/>
  </front>
  <seriesInfo name="BCP" value="72"/>
  <seriesInfo name="RFC" value="3552"/>
</reference>

<reference anchor="CLUSTER" target="https://www.rfc-editor.org/cluster_def.html">
  <front>
    <title>Clusters in the RFC Editor Queue</title>
    <author>
      <organization>RFC Editor</organization>
    </author>
    <date/>
  </front>
</reference>

<reference anchor="CMOS">
  <front>
    <title>Chicago Manual of Style, 16th ed.</title>
    <author>
      <organization>University of Chicago Press, 2010</organization>
    </author>
    <date year="2010"/>
  </front>
</reference>

<reference anchor="FYI90" target="https://www.rfc-editor.org/info/fyi90">
  <front>
    <title>FYI on FYI: Introduction to the FYI Notes</title>
    <author initials="G." surname="Malkin"/>
    <author initials="J." surname="Reynolds"/>
    <date year="1990" month="March"/>
  </front>
  <seriesInfo name="FYI" value="90"/>
  <seriesInfo name="RFC" value="1150"/>

  <annotation>
          Housley, R., "Conclusion of FYI RFC Sub-Series", RFC 6360,
          August 2011.
  </annotation>

</reference>


<reference anchor="IAB-FORM" target="https://www.rfc-editor.org/rfc-style-guide/iab-format.txt">
  <front>
    <title>Format for RFCs in the IAB Stream</title>
    <author>
      <organization>IAB</organization>
    </author>
    <date/>
  </front>
</reference>

<reference anchor="ID-GUIDE" target="http://www.ietf.org/ietf-ftp/1id-guidelines.txt">
  <front>
    <title>Guidelines to Authors of Internet Drafts</title>
    <author>
      <organization>IETF</organization>
    </author>
    <date/>
  </front>
</reference>

<reference anchor="IETF-TRUST" target="https://trustee.ietf.org/license-info/">
  <front>
    <title>Trust Legal Provisions (TLP)</title>
    <author>
      <organization>IETF Trust</organization>
    </author>
    <date/>
  </front>
</reference>

<reference anchor="ISO_OBP" target="https://www.iso.org/obp/ui/">
  <front>
    <title>Online Browsing Platform (OBP)</title>
    <author>
      <organization>ISO</organization>
    </author>
    <date/>
  </front>
</reference>

<reference anchor="ISO3297">
  <front>
    <title>Identification and description, Information and documentation - International standard serial number (ISSN)</title>
    <author>
      <organization>Technical Committee ISO/TC 46, Information and documentation, Subcommittee SC 9
      </organization>
    </author>
    <date year="2007" month="September"/>
  </front>
</reference>

<reference anchor="MIB-BOILER" target="https://www.ops.ietf.org/mib-boilerplate.html">
  <front>
    <title>Boilerplate for IETF MIB Documents</title>
    <author>
      <organization>IETF OPS Area</organization>
    </author>
    <date/>
  </front>
</reference>

<reference anchor="MIB-SEC" target="https://trac.tools.ietf.org/area/ops/trac/wiki/mib-security">
  <front>
    <title>Security Guidelines for IETF MIB Modules</title>
    <author>
      <organization>IETF OPS Area</organization>
    </author>
    <date/>
  </front>
</reference>

<reference anchor="REFEXAMPLE" target="https://www.rfc-editor.org/ref-example/">
  <front>
    <title>Reference Examples</title>
    <author>
      <organization>RFC Editor</organization>
    </author>
    <date/>
  </front>
</reference>

<reference anchor="REFS" target="http://www.ietf.org/iesg/statement/normative-informative.html">
  <front>
    <title>IESG Statement: Normative and Informative</title>
    <author>
      <organization>IESG</organization>
    </author>
    <date/>
  </front>
</reference>

&RFC1311;
&RFC1818;
&RFC4844;
&RFC5741;
&RFC6635;
&RFC7990;
&RFC7996;

<reference anchor="STD66" target="https://www.rfc-editor.org/info/std66">
  <front>
    <title>Uniform Resource Identifier (URI): Generic Synta</title>
    <author initials="T." surname="Berners-Lee"/>
    <author initials="R." surname="Fielding"/>
    <author initials="L." surname="Masinter"/>
    <date year="2005" month="January"/>
  </front>
  <seriesInfo name="STD" value="66"/>
  <seriesInfo name="RFC" value="3986"/>
</reference>


<reference anchor="TERMS" target="https://www.rfc-editor.org/styleguide.html">
  <front>
    <title>Terms List</title>
    <author>
      <organization>RFC Editor</organization>
    </author>
    <date/>
  </front>
</reference>

<reference anchor="YANG-SEC" target="https://trac.tools.ietf.org/area/ops/trac/wiki/yang-security-guidelines">
  <front>
    <title>yang module security considerations</title>
    <author>
      <organization>IETF Ops Area</organization>
    </author>
    <date/>
  </front>
</reference>

</references>

<section anchor="app-A" title="Related Procedures">

<t>The following procedures are related to the application and updating
   of the RFC Style Guide.</t>

<section anchor="app-a1" title="Dispute Resolution">

<t>There are competing rationales for some of the rules described in
   this Guide, and the RFC Editor has selected the ones that work best
   for the Series.  However, at times, an author may have a disagreement
   with the RFC Production Center (RPC) over the application of Style
   Guide conventions.  In such cases, the authors should discuss their
   concerns with the RPC.  If no agreement can be reached between the
   RPC and the authors, the RFC Series Editor will, with input from the
   appropriate stream-approving body, make a final determination.  If
   further resolution is required, the dispute resolution process as
   described in the RFC Editor Model <xref target ="RFC6635"/> will be followed.</t>

</section>

<section anchor="app-a2"  title="Returning an I-D to the Document Stream">

<t>For a given document, if the RFC Editor determines that it cannot be
   edited without serious risk of altering the meaning of the technical
   content or if the RFC Editor does not have the resources to provide
   the level of editing it needs, it may be sent back to the stream-
   approving body with a request to improve the clarity, consistency,
   and/or readability of the document.  This is not to be considered a
   dispute with the author.</t>

</section>

<section anchor="app-a3"  title="Revising This Document and Associated Web Pages">

<t>The RFC Series is continually evolving as a document series.  This
   document focuses on the fundamental and stable requirements that must
   be met by an RFC.  From time to time, the RFC Editor may offer less
   formal recommendations that authors may apply at their discretion;
   these recommendations may be found on the RFC Editor website
   "Guidelines for RFC Style" <xref target="STYLE-WEB"/>.</t>

<t>When a new recommendation is made regarding the overall structure and
   formatting of RFCs, it will be published on that page and accepted
   for a period of time before the RFC Editor determines whether it
   should become part of the fundamental requirements in the RFC Style
   Guide or remain as a less formal recommendation.  That period of time
   will vary, in part depending on the frequency with which authors
   encounter and apply the guidance.</t>

</section>

</section>

<section anchor="contributors" title="Contributors">

<t>Alice Russo
   RFC Production Center</t>

<t>Authors' Addresses</t>

<t>Heather Flanagan
   RFC Series Editor</t>

<t>EMail: rse@rfc-editor.org</t>

<t>Sandy Ginoza
   RFC Production Center</t>

<t>EMail: rfc-editor@rfc-editor.org</t>

</section>


</back>
</rfc>
