Tech-invite   World Map
3GPPspecs     Glossaries     T+       IETF     RFCs     Groups     SIP     ABNFs

RFC 7991

 
 
 

The "xml2rfc" Version 3 Vocabulary

Part 3 of 5, p. 44 to 77
Prev Section       Next Section

 


prevText      Top      ToC       Page 44 
2.38.  <postalLine>

   Represents one line of a postal address.  When more than one
   <postalLine> is given, the prep tool emits them in the order given.

   This element appears as a child element of <postal> (Section 2.37).

   Content model: only text content.

2.38.1.  "ascii" Attribute

   The ASCII equivalent of the text in the address line.

2.39.  <refcontent>

   Text that should appear between the title and the date of a
   reference.  The purpose of this element is to prevent the need to
   abuse <seriesInfo> to get such text in a reference.

   For example:

   <reference anchor="April1">
     <front>
       <title>On Being A Fool</title>
       <author initials="K." surname="Phunny" fullname="Knot Phunny"/>
       <date year="2000" month="April"/>
     </front>
     <refcontent>Self-published pamphlet</refcontent>
   </reference>

   would render as:

      [April1]     Phunny, K., "On Being A Fool", Self-published
                   pamphlet, April 2000.

   This element appears as a child element of <reference>
   (Section 2.40).

   Content model:

   In any order:

   o  Text

   o  <bcp14> elements (Section 2.9)

   o  <em> elements (Section 2.22)

Top      Up      ToC       Page 45 
   o  <strong> elements (Section 2.50)

   o  <sub> elements (Section 2.51)

   o  <sup> elements (Section 2.52)

   o  <tt> elements (Section 2.62)

2.40.  <reference>

   Represents a bibliographic reference.

   This element appears as a child element of <referencegroup>
   (Section 2.41) and <references> (Section 2.42).

   Content model:

   In this order:

   1.  One <front> element (Section 2.26)

   2.  In any order:

       *  <annotation> elements (Section 2.3)

       *  <format> elements (Section 3.3)

       *  <refcontent> elements (Section 2.39)

       *  <seriesInfo> elements (Section 2.47; deprecated in this
          context)

2.40.1.  "anchor" Attribute (Mandatory)

   Document-wide unique identifier for this reference.  Usually, this
   will be used both to "label" the reference in the "References"
   section and as an identifier in links to this reference entry.

2.40.2.  "quoteTitle" Attribute

   Specifies whether or not the title in the reference should be quoted.
   This can be used to prevent quoting, such as on errata.

   Allowed values:

   o  "true" (default)

   o  "false"

Top      Up      ToC       Page 46 
2.40.3.  "target" Attribute

   Holds the URI for the reference.

2.41.  <referencegroup>

   Represents a list of bibliographic references that will be
   represented as a single reference.  This is most often used to
   reference STDs and BCPs, where a single reference (such as "BCP 9")
   may encompass more than one RFC.

   This element appears as a child element of <references>
   (Section 2.42).

   Content model:

   One or more <reference> elements (Section 2.40)

2.41.1.  "anchor" Attribute (Mandatory)

   Document-wide unique identifier for this reference group.  Usually,
   this will be used both to "label" the reference group in the
   "References" section and as an identifier in links to this reference
   entry.

2.42.  <references>

   Contains a set of bibliographic references.

   In the early days of the RFC Series, there was only one "References"
   section per RFC.  This convention was later changed to group
   references into two sets, "Normative" and "Informative", as described
   in [RFC7322].  This vocabulary supports the split with the <name>
   child element.  In general, the title should be either "Normative
   References" or "Informative References".

   This element appears as a child element of <back> (Section 2.8).

Top      Up      ToC       Page 47 
   Content model:

   In this order:

   1.  One optional <name> element (Section 2.32)

   2.  In any order:

       *  <reference> elements (Section 2.40)

       *  <referencegroup> elements (Section 2.41)

2.42.1.  "anchor" Attribute

   An optional user-supplied identifier for this set of references.

2.42.2.  "title" Attribute

   Deprecated.  Use <name> instead.

2.43.  <region>

   Provides the region name in a postal address.

   This element appears as a child element of <postal> (Section 2.37).

   Content model: only text content.

2.43.1.  "ascii" Attribute

   The ASCII equivalent of the region name.

2.44.  <relref>

   Represents a link to a specific part of a document that appears in a
   <reference> element.  Formatters that have links (such as HTML and
   PDF) render <relref> elements as external hyperlinks to the specified
   part of the reference, creating the link target by combining the base
   URI from the <reference> element with the "relative" attribute from
   this element.  The "target" attribute is required, and it must be the
   anchor of a <reference> element.

   The "section" attribute is required, and the "relative" attribute is
   optional.  If the reference is not an RFC or Internet-Draft that is
   in the v3 format, the element needs to have a "relative" attribute;
   in this case, the value of the "section" attribute is ignored.

Top      Up      ToC       Page 48 
   An example of the <relref> element with text content might be:

         See
         <relref section="2.3" target="RFC9999" displayFormat="bare">
         the protocol overview</relref>
         for more information.

   An HTML formatter might generate:

         See
         <a href="http://www.rfc-editor.org/rfc/rfc9999.html#s-2.3">
         the protocol overview</a>
         for more information.

   Note that the URL in the above example might be different when the
   RFC Editor deploys the v3 format.

   This element appears as a child element of <annotation>
   (Section 2.3), <blockquote> (Section 2.10), <cref> (Section 2.16),
   <dd> (Section 2.18), <dt> (Section 2.21), <em> (Section 2.22), <li>
   (Section 2.29), <name> (Section 2.32), <preamble> (Section 3.6),
   <strong> (Section 2.50), <sub> (Section 2.51), <sup> (Section 2.52),
   <t> (Section 2.53), <td> (Section 2.56), <th> (Section 2.58), and
   <tt> (Section 2.62).

   Content model: only text content.

2.44.1.  "displayFormat" Attribute

   This attribute is used to signal formatters what the desired format
   of the relative reference should be.  Formatters for document types
   that have linking capability should wrap each part of the displayed
   text in hyperlinks.  If there is content in the <relref> element,
   formatters will ignore the value of this attribute.

   "of"

      A formatter should display the relative reference as the word
      "Section" followed by a space, the contents of the "section"
      attribute followed by a space, the word "of", another space, and
      the value from the "target" attribute enclosed in square brackets.

      For example, with an input of:

         See
         <relref section="2.3" target="RFC9999" displayFormat="of"/>
         for an overview.

Top      Up      ToC       Page 49 
      An HTML formatter might generate:

         See
         <a href="http://www.rfc-editor.org/info/rfc9999#s-2.3">
         Section 2.3</a> of
         [<a href="#RFC9999">RFC9999</a>]
         for an overview.

      Note that "displayFormat='of'" is the default for <relref>, so it
      does not need to be given in a <relref> element if that format is
      desired.

   "comma"

      A formatter should display the relative reference as the value
      from the "target" attribute enclosed in square brackets, a comma,
      a space, the word "Section" followed by a space, and the "section"
      attribute.

      For example, with an input of:

         See
         <relref section="2.3" target="RFC9999" displayFormat="comma"/>,
         for an overview.

      An HTML formatter might generate:

         See
         [<a href="#RFC9999">RFC9999</a>],
         <a href="http://www.rfc-editor.org/info/rfc9999#s-2.3">
         Section 2.3</a>, for an overview.

   "parens"

      A formatter should display the relative reference as the value
      from the "target" attribute enclosed in square brackets, a space,
      a left parenthesis, the word "Section" followed by a space, the
      "section" attribute, and a right parenthesis.

      For example, with an input of:

         See
         <relref section="2.3" target="RFC9999" displayFormat="parens"/>
         for an overview.

Top      Up      ToC       Page 50 
      An HTML formatter might generate:

         See
         [<a href="#RFC9999">RFC9999</a>]
         (<a href="http://www.rfc-editor.org/info/rfc9999#s-2.3">
         Section 2.3</a>)
         for an overview.

   "bare"

      A formatter should display the relative reference as the contents
      of the "section" attribute and nothing else.  This is useful when
      there are multiple relative references to a single base reference.

      For example:

         See Sections
         <relref section="2.3" target="RFC9999" displayFormat="bare"/>
         and
         <relref section="2.4" target="RFC9999" displayFormat="of"/>
         for an overview.

      An HTML formatter might generate:

         See Sections
         <a href="http://www.rfc-editor.org/info/rfc9999#s-2.3">
         2.3</a>
         and
         <a href="http://www.rfc-editor.org/info/rfc9999#s-2.4">
         Section 2.4</a> of
         [<a href="#RFC9999">RFC9999</a>]
         for an overview.

   Allowed values:

   o  "of" (default)

   o  "comma"

   o  "parens"

   o  "bare"

Top      Up      ToC       Page 51 
2.44.2.  "relative" Attribute

   Specifies a relative reference from the URI in the target reference.
   This value must include whatever leading character is needed to
   create the relative reference; typically, this is "#" for HTML
   documents.

2.44.3.  "section" Attribute (Mandatory)

   Specifies a section of the target reference.  If the reference is not
   an RFC or Internet-Draft in the v3 format, it is an error.

2.44.4.  "target" Attribute (Mandatory)

   The anchor of the reference for this element.  If this value is not
   an anchor to a <reference> or <referencegroup> element, it is an
   error.  If the reference at the target has no URI, it is an error.

2.45.  <rfc>

   This is the root element of the xml2rfc vocabulary.

   Content model:

   In this order:

   1.  Optional <link> elements (Section 2.30)

   2.  One <front> element (Section 2.26)

   3.  One <middle> element (Section 2.31)

   4.  One optional <back> element (Section 2.8)

2.45.1.  "category" Attribute

   Deprecated; instead, use the "name" attribute in <seriesInfo>.

Top      Up      ToC       Page 52 
2.45.2.  "consensus" Attribute

   Affects the generated boilerplate.  Note that the values of "no" and
   "yes" are deprecated and are replaced by "false" (the default) and
   "true".

   See [RFC7841] for more information.

   Allowed values:

   o  "no"

   o  "yes"

   o  "false" (default)

   o  "true"

2.45.3.  "docName" Attribute

   Deprecated; instead, use the "value" attribute in <seriesInfo>.

2.45.4.  "indexInclude" Attribute

   Specifies whether or not a formatter is requested to include an index
   in generated files.  If the source file has no <iref> elements, an
   index is never generated.  This option is useful for generating
   documents where the source document has <iref> elements but the
   author no longer wants an index.

   Allowed values:

   o  "true" (default)

   o  "false"

2.45.5.  "ipr" Attribute

   Represents the Intellectual Property status of the document.  See
   Appendix A.1 for details.

2.45.6.  "iprExtract" Attribute

   Identifies a single section within the document for which extraction
   "as is" is explicitly allowed (only relevant for historic values of
   the "ipr" attribute).

Top      Up      ToC       Page 53 
2.45.7.  "number" Attribute

   Deprecated; instead, use the "value" attribute in <seriesInfo>.

2.45.8.  "obsoletes" Attribute

   A comma-separated list of RFC numbers or Internet-Draft names.

   The prep tool will parse the attribute value so that incorrect
   references can be detected.

2.45.9.  "prepTime" Attribute

   The date that the XML was processed by a prep tool.  This is included
   in the XML file just before it is saved to disk.  The value is
   formatted using the "date-time" format defined in Section 5.6 of
   [RFC3339].  The "time-offset" should be "Z".

2.45.10.  "seriesNo" Attribute

   Deprecated; instead, use the "value" attribute in <seriesInfo>.

2.45.11.  "sortRefs" Attribute

   Specifies whether or not the prep tool will sort the references in
   each reference section.

   Allowed values:

   o  "true"

   o  "false" (default)

2.45.12.  "submissionType" Attribute

   The document stream, as described in [RFC7841].  (The RFC Series
   Editor may change the list of allowed values in the future.)

   Allowed values:

   o  "IETF" (default)

   o  "IAB"

   o  "IRTF"

   o  "independent"

Top      Up      ToC       Page 54 
2.45.13.  "symRefs" Attribute

   Specifies whether or not a formatter is requested to use symbolic
   references (such as "[RFC2119]").  If the value for this is "false",
   the references come out as numbers (such as "[3]").

   Allowed values:

   o  "true" (default)

   o  "false"

2.45.14.  "tocDepth" Attribute

   Specifies the number of levels of headings that a formatter is
   requested to include in the table of contents; the default is "3".

2.45.15.  "tocInclude" Attribute

   Specifies whether or not a formatter is requested to include a table
   of contents in generated files.

   Allowed values:

   o  "true" (default)

   o  "false"

2.45.16.  "updates" Attribute

   A comma-separated list of RFC numbers or Internet-Draft names.

   The prep tool will parse the attribute value so that incorrect
   references can be detected.

2.45.17.  "version" Attribute

   Specifies the version of xml2rfc syntax used in this document.  The
   only expected value (for now) is "3".

2.46.  <section>

   Represents a section (when inside a <middle> element) or an appendix
   (when inside a <back> element).

   Subsections are created by nesting <section> elements inside
   <section> elements.  Sections are allowed to be empty.

Top      Up      ToC       Page 55 
   This element appears as a child element of <back> (Section 2.8),
   <boilerplate> (Section 2.11), <middle> (Section 2.31), and <section>
   (Section 2.46).

   Content model:

   In this order:

   1.  One optional <name> element (Section 2.32)

   2.  In any order:

       *  <artwork> elements (Section 2.5)

       *  <aside> elements (Section 2.6)

       *  <blockquote> elements (Section 2.10)

       *  <dl> elements (Section 2.20)

       *  <figure> elements (Section 2.25)

       *  <iref> elements (Section 2.27)

       *  <ol> elements (Section 2.34)

       *  <sourcecode> elements (Section 2.48)

       *  <t> elements (Section 2.53)

       *  <table> elements (Section 2.54)

       *  <texttable> elements (Section 3.8)

       *  <ul> elements (Section 2.63)

   3.  Optional <section> elements (Section 2.46)

2.46.1.  "anchor" Attribute

   Document-wide unique identifier for this section.

2.46.2.  "numbered" Attribute

   If set to "false", the formatter is requested to not display a
   section number.  The prep tool will verify that such a section is not
   followed by a numbered section in this part of the document and will
   verify that the section is a top-level section.

Top      Up      ToC       Page 56 
   Allowed values:

   o  "true" (default)

   o  "false"

2.46.3.  "removeInRFC" Attribute

   If set to "true", this note is marked in the prep tool with text
   indicating that it should be removed before the document is published
   as an RFC.  That text will be "This note is to be removed before
   publishing as an RFC."

   Allowed values:

   o  "true"

   o  "false" (default)

2.46.4.  "title" Attribute

   Deprecated.  Use <name> instead.

2.46.5.  "toc" Attribute

   Indicates to a formatter whether or not the section is to be included
   in a table of contents, if such a table of contents is produced.
   This only takes effect if the level of the section would have
   appeared in the table of contents based on the "tocDepth" attribute
   of the <rfc> element, and of course only if the table of contents is
   being created based on the "tocInclude" attribute of the <rfc>
   element.  If this is set to "exclude", any section below this one
   will be excluded as well.  The "default" value indicates inclusion of
   the section if it would be included by the tocDepth attribute of the
   <rfc> element.

   Allowed values:

   o  "include"

   o  "exclude"

   o  "default" (default)

Top      Up      ToC       Page 57 
2.47.  <seriesInfo>

   Specifies the document series in which this document appears, and
   also specifies an identifier within that series.

   A processing tool determines whether it is working on an RFC or an
   Internet-Draft by inspecting the "name" attribute of a <seriesInfo>
   element inside the <front> element inside the <rfc> element, looking
   for "RFC" or "Internet-Draft".  (Specifying neither value in any of
   the <seriesInfo> elements can be useful for producing other types of
   documents but is out of scope for this specification.)

   It is invalid to have multiple <seriesInfo> elements inside the same
   <front> element containing the same "name" value.  Some combinations
   of <seriesInfo> "name" attribute values make no sense, such as having
   both <seriesInfo name="rfc"/> and <seriesInfo name="Internet-Draft"/>
   in the same <front> element.

   This element appears as a child element of <front> (Section 2.26) and
   <reference> (Section 2.40; deprecated in this context).

   Content model: this element does not have any contents.

2.47.1.  "asciiName" Attribute

   The ASCII equivalent of the name field.

2.47.2.  "asciiValue" Attribute

   The ASCII equivalent of the value field.

2.47.3.  "name" Attribute (Mandatory)

   The name of the series.  The currently known values are "RFC",
   "Internet-Draft", and "DOI".  The RFC Series Editor may change this
   list in the future.

   Some of the values for "name" interact as follows:

   o  If a <front> element contains a <seriesInfo> element with a name
      of "Internet-Draft", it can also have at most one additional
      <seriesInfo> element with a "status" attribute whose value is of
      "standard", "full-standard", "bcp", "fyi", "informational",
      "experimental", or "historic" to indicate the intended status of
      this Internet-Draft, if it were to be later published as an RFC.
      If such an additional <seriesInfo> element has one of those
      statuses, the name needs to be "".

Top      Up      ToC       Page 58 
   o  If a <front> element contains a <seriesInfo> element with a name
      of "RFC", it can also have at most one additional <seriesInfo>
      element with a "status" attribute whose value is of
      "full-standard", "bcp", or "fyi" to indicate the current status of
      this RFC.  If such an additional <seriesInfo> element has one of
      those statuses, the "value" attribute for that name needs to be
      the number within that series.  That <front> element might also
      contain an additional <seriesInfo> element with the status of
      "info", "exp", or "historic" and a name of "" to indicate the
      status of the RFC.

   o  A <front> element that has a <seriesInfo> element that has the
      name "Internet-Draft" cannot also have a <seriesInfo> element that
      has the name "RFC".

   o  The <seriesInfo> element can contain the DOI for the referenced
      document.  This cannot be used when the <seriesInfo> element is an
      eventual child element of an <rfc> element -- only as an eventual
      child of a <reference> element.  The "value" attribute should use
      the form specified in [RFC7669].

2.47.4.  "status" Attribute

   The status of this document.  The currently known values are
   "standard", "informational", "experimental", "bcp", "fyi", and
   "full-standard".  The RFC Series Editor may change this list in the
   future.

2.47.5.  "stream" Attribute

   The stream (as described in [RFC7841]) that originated the document.
   (The RFC Series Editor may change this list in the future.)

   Allowed values:

   o  "IETF" (default)

   o  "IAB"

   o  "IRTF"

   o  "independent"

Top      Up      ToC       Page 59 
2.47.6.  "value" Attribute (Mandatory)

   The identifier within the series specified by the "name" attribute.

   For BCPs, FYIs, RFCs, and STDs, this is the number within the series.
   For Internet-Drafts, it is the full draft name (ending with the
   two-digit version number).  For DOIs, the value is given, such as
   "10.17487/rfc1149", as described in [RFC7669].

   The name in the value should be the document name without any file
   extension.  For Internet-Drafts, the value for this attribute should
   be "draft-ietf-somewg-someprotocol-07", not
   "draft-ietf-somewg-someprotocol-07.txt".

2.48.  <sourcecode>

   This element allows the inclusion of source code into the document.

   When rendered, source code is always shown in a monospace font.  When
   <sourcecode> is a child of <figure> or <section>, it provides full
   control of horizontal whitespace and line breaks.  When formatted, it
   is indented relative to the left margin of the enclosing element.  It
   is thus useful for source code and formal languages (such as ABNF
   [RFC5234] or the RNC notation used in this document).  (When
   <sourcecode> is a child of other elements, it flows with the text
   that surrounds it.)  Tab characters (U+0009) inside of this element
   are prohibited.

   For artwork such as character-based art, diagrams of message layouts,
   and so on, use the <artwork> element instead.

   Output formatters that do pagination should attempt to keep source
   code on a single page.  This is to prevent source code that is split
   across pages from looking like two separate pieces of code.

   See Section 5 for a description of how to deal with issues of using
   "&" and "<" characters in source code.

   This element appears as a child element of <blockquote>
   (Section 2.10), <dd> (Section 2.18), <figure> (Section 2.25), <li>
   (Section 2.29), <section> (Section 2.46), <td> (Section 2.56), and
   <th> (Section 2.58).

   Content model: only text content.

2.48.1.  "anchor" Attribute

   Document-wide unique identifier for this source code.

Top      Up      ToC       Page 60 
2.48.2.  "name" Attribute

   A filename suitable for the contents (such as for extraction to a
   local file).  This attribute can be helpful for other kinds of tools
   (such as automated syntax checkers, which work by extracting the
   source code).  Note that the "name" attribute does not need to be
   unique for <artwork> elements in a document.  If multiple
   <sourcecode> elements have the same "name" attribute, a formatter
   might assume that the elements are all fragments of a single file,
   and such a formatter can collect those fragments for later
   processing.

2.48.3.  "src" Attribute

   The URI reference of a source file [RFC3986].

   It is an error to have both a "src" attribute and content in the
   <sourcecode> element.

2.48.4.  "type" Attribute

   Specifies the type of the source code.  The value of this attribute
   is free text with certain values designated as preferred.

   The preferred values for <sourcecode> types are:

   o  abnf

   o  asn.1

   o  bash

   o  c++

   o  c

   o  cbor

   o  dtd

   o  java

   o  javascript

   o  json

   o  mib

Top      Up      ToC       Page 61 
   o  perl

   o  pseudocode

   o  python

   o  rnc

   o  xml

   o  yang

   The RFC Series Editor will maintain a complete list of the preferred
   values on the RFC Editor web site, and that list is expected to be
   updated over time.  Thus, a consumer of v3 XML should not cause a
   failure when it encounters an unexpected type or no type is
   specified.

2.49.  <street>

   Provides a street address.

   This element appears as a child element of <postal> (Section 2.37).

   Content model: only text content.

2.49.1.  "ascii" Attribute

   The ASCII equivalent of the street address.

2.50.  <strong>

   Indicates text that is semantically strong.  Text enclosed within
   this element will be displayed as bold after processing.  This
   element can be combined with other character formatting elements, and
   the formatting will be additive.

   This element appears as a child element of <annotation>
   (Section 2.3), <blockquote> (Section 2.10), <cref> (Section 2.16),
   <dd> (Section 2.18), <dt> (Section 2.21), <em> (Section 2.22), <li>
   (Section 2.29), <preamble> (Section 3.6), <refcontent>
   (Section 2.39), <sub> (Section 2.51), <sup> (Section 2.52), <t>
   (Section 2.53), <td> (Section 2.56), <th> (Section 2.58), and <tt>
   (Section 2.62).

Top      Up      ToC       Page 62 
   Content model:

   In any order:

   o  Text

   o  <bcp14> elements (Section 2.9)

   o  <cref> elements (Section 2.16)

   o  <em> elements (Section 2.22)

   o  <eref> elements (Section 2.24)

   o  <iref> elements (Section 2.27)

   o  <relref> elements (Section 2.44)

   o  <sub> elements (Section 2.51)

   o  <sup> elements (Section 2.52)

   o  <tt> elements (Section 2.62)

   o  <xref> elements (Section 2.66)

2.51.  <sub>

   Causes the text to be displayed as subscript, approximately half a
   letter-height lower than normal text.  This element can be combined
   with other character formatting elements, and the formatting will be
   additive.

   This element appears as a child element of <annotation>
   (Section 2.3), <blockquote> (Section 2.10), <cref> (Section 2.16),
   <dd> (Section 2.18), <dt> (Section 2.21), <em> (Section 2.22), <li>
   (Section 2.29), <preamble> (Section 3.6), <refcontent>
   (Section 2.39), <strong> (Section 2.50), <t> (Section 2.53), <td>
   (Section 2.56), <th> (Section 2.58), and <tt> (Section 2.62).

Top      Up      ToC       Page 63 
   Content model:

   In any order:

   o  Text

   o  <bcp14> elements (Section 2.9)

   o  <cref> elements (Section 2.16)

   o  <em> elements (Section 2.22)

   o  <eref> elements (Section 2.24)

   o  <iref> elements (Section 2.27)

   o  <relref> elements (Section 2.44)

   o  <strong> elements (Section 2.50)

   o  <tt> elements (Section 2.62)

   o  <xref> elements (Section 2.66)

2.52.  <sup>

   Causes the text to be displayed as superscript, approximately half a
   letter-height higher than normal text.  This element can be combined
   with other character formatting elements, and the formatting will be
   additive.

   This element appears as a child element of <annotation>
   (Section 2.3), <blockquote> (Section 2.10), <cref> (Section 2.16),
   <dd> (Section 2.18), <dt> (Section 2.21), <em> (Section 2.22), <li>
   (Section 2.29), <preamble> (Section 3.6), <refcontent>
   (Section 2.39), <strong> (Section 2.50), <t> (Section 2.53), <td>
   (Section 2.56), <th> (Section 2.58), and <tt> (Section 2.62).

   Content model:

   In any order:

   o  Text

   o  <bcp14> elements (Section 2.9)

   o  <cref> elements (Section 2.16)

Top      Up      ToC       Page 64 
   o  <em> elements (Section 2.22)

   o  <eref> elements (Section 2.24)

   o  <iref> elements (Section 2.27)

   o  <relref> elements (Section 2.44)

   o  <strong> elements (Section 2.50)

   o  <tt> elements (Section 2.62)

   o  <xref> elements (Section 2.66)

2.53.  <t>

   Contains a paragraph of text.

   This element appears as a child element of <abstract> (Section 2.1),
   <aside> (Section 2.6), <blockquote> (Section 2.10), <dd>
   (Section 2.18), <li> (Section 2.29), <list> (Section 3.4), <note>
   (Section 2.33), <section> (Section 2.46), <td> (Section 2.56), and
   <th> (Section 2.58).

   Content model:

   In any order:

   o  Text

   o  <bcp14> elements (Section 2.9)

   o  <cref> elements (Section 2.16)

   o  <em> elements (Section 2.22)

   o  <eref> elements (Section 2.24)

   o  <iref> elements (Section 2.27)

   o  <list> elements (Section 3.4)

   o  <relref> elements (Section 2.44)

   o  <spanx> elements (Section 3.7)

   o  <strong> elements (Section 2.50)

Top      Up      ToC       Page 65 
   o  <sub> elements (Section 2.51)

   o  <sup> elements (Section 2.52)

   o  <tt> elements (Section 2.62)

   o  <vspace> elements (Section 3.10)

   o  <xref> elements (Section 2.66)

2.53.1.  "anchor" Attribute

   Document-wide unique identifier for this paragraph.

2.53.2.  "hangText" Attribute

   Deprecated.  Instead, use <dd> inside of a definition list (<dl>).

2.53.3.  "keepWithNext" Attribute

   Acts as a hint to the output formatters that do pagination to do a
   best-effort attempt to keep the paragraph with the next element,
   whatever that happens to be.  For example, the HTML output @media
   print CSS ("CSS" refers to Cascading Style Sheets) might translate
   this to page-break-after: avoid.  For PDF, the paginator could
   attempt to keep the paragraph with the next element.  Note: this
   attribute is strictly a hint and not always actionable.

   Allowed values:

   o  "false" (default)

   o  "true"

2.53.4.  "keepWithPrevious" Attribute

   Acts as a hint to the output formatters that do pagination to do a
   best-effort attempt to keep the paragraph with the previous element,
   whatever that happens to be.  For example, the HTML output @media
   print CSS might translate this to page-break-before: avoid.  For PDF,
   the paginator could attempt to keep the paragraph with the previous
   element.  Note: this attribute is strictly a hint and not always
   actionable.

Top      Up      ToC       Page 66 
   Allowed values:

   o  "false" (default)

   o  "true"

2.54.  <table>

   Contains a table with a caption with the table number.  If the
   element contains a <name> element, the caption will also show that
   name.

   Inside the <table> element is, optionally, a <thead> element to
   contain the rows that will be the table's heading and, optionally, a
   <tfoot> element to contain the rows of the table's footer.  If the
   XML is converted to a representation that has page breaks (such as
   PDFs or printed HTML), the header and footer are meant to appear on
   each page.

   This element appears as a child element of <aside> (Section 2.6) and
   <section> (Section 2.46).

   Content model:

   In this order:

   1.  One optional <name> element (Section 2.32)

   2.  Optional <iref> elements (Section 2.27)

   3.  One optional <thead> element (Section 2.59)

   4.  One or more <tbody> elements (Section 2.55)

   5.  One optional <tfoot> element (Section 2.57)

2.54.1.  "anchor" Attribute

   Document-wide unique identifier for this table.

Top      Up      ToC       Page 67 
2.55.  <tbody>

   A container for a set of body rows for a table.

   This element appears as a child element of <table> (Section 2.54).

   Content model:

   One or more <tr> elements (Section 2.61)

2.55.1.  "anchor" Attribute

   Document-wide unique identifier for the tbody.

2.56.  <td>

   A cell in a table row.

   This element appears as a child element of <tr> (Section 2.61).

   Content model:

   Either:

      In any order, but at least one of:

      *  <artwork> elements (Section 2.5)

      *  <dl> elements (Section 2.20)

      *  <figure> elements (Section 2.25)

      *  <ol> elements (Section 2.34)

      *  <sourcecode> elements (Section 2.48)

      *  <t> elements (Section 2.53)

      *  <ul> elements (Section 2.63)

Top      Up      ToC       Page 68 
   Or:

      In any order:

      *  Text

      *  <bcp14> elements (Section 2.9)

      *  <br> elements (Section 2.12)

      *  <cref> elements (Section 2.16)

      *  <em> elements (Section 2.22)

      *  <eref> elements (Section 2.24)

      *  <iref> elements (Section 2.27)

      *  <relref> elements (Section 2.44)

      *  <strong> elements (Section 2.50)

      *  <sub> elements (Section 2.51)

      *  <sup> elements (Section 2.52)

      *  <tt> elements (Section 2.62)

      *  <xref> elements (Section 2.66)

2.56.1.  "align" Attribute

   Controls whether the content of the cell appears left justified
   (default), centered, or right justified.  Note that "center" or
   "right" will probably only work well in cells with plain text; any
   other elements might make the contents render badly.

   Allowed values:

   o  "left" (default)

   o  "center"

   o  "right"

2.56.2.  "anchor" Attribute

   Document-wide unique identifier for the cell.

Top      Up      ToC       Page 69 
2.56.3.  "colspan" Attribute

   The number of columns that the cell is to span.  For example, setting
   "colspan='3'" indicates that the cell occupies the same horizontal
   space as three cells of a row without any "colspan" attributes.

2.56.4.  "rowspan" Attribute

   The number of rows that the cell is to span.  For example, setting
   "rowspan='3'" indicates that the cell occupies the same vertical
   space as three rows.

2.57.  <tfoot>

   A container for a set of footer rows for a table.

   This element appears as a child element of <table> (Section 2.54).

   Content model:

   One or more <tr> elements (Section 2.61)

2.57.1.  "anchor" Attribute

   Document-wide unique identifier for the tfoot.

2.58.  <th>

   A cell in a table row.  When rendered, this will normally come out in
   boldface; other than that, there is no difference between this and
   the <td> element.

   This element appears as a child element of <tr> (Section 2.61).

   Content model:

   Either:

      In any order, but at least one of:

      *  <artwork> elements (Section 2.5)

      *  <dl> elements (Section 2.20)

      *  <figure> elements (Section 2.25)

      *  <ol> elements (Section 2.34)

Top      Up      ToC       Page 70 
      *  <sourcecode> elements (Section 2.48)

      *  <t> elements (Section 2.53)

      *  <ul> elements (Section 2.63)

   Or:

      In any order:

      *  Text

      *  <bcp14> elements (Section 2.9)

      *  <br> elements (Section 2.12)

      *  <cref> elements (Section 2.16)

      *  <em> elements (Section 2.22)

      *  <eref> elements (Section 2.24)

      *  <iref> elements (Section 2.27)

      *  <relref> elements (Section 2.44)

      *  <strong> elements (Section 2.50)

      *  <sub> elements (Section 2.51)

      *  <sup> elements (Section 2.52)

      *  <tt> elements (Section 2.62)

      *  <xref> elements (Section 2.66)

2.58.1.  "align" Attribute

   Controls whether the content of the cell appears left justified
   (default), centered, or right justified.  Note that "center" or
   "right" will probably only work well in cells with plain text; any
   other elements might make the contents render badly.

Top      Up      ToC       Page 71 
   Allowed values:

   o  "left" (default)

   o  "center"

   o  "right"

2.58.2.  "anchor" Attribute

   Document-wide unique identifier for the row.

2.58.3.  "colspan" Attribute

   The number of columns that the cell is to span.  For example, setting
   "colspan='3'" indicates that the cell occupies the same horizontal
   space as three cells of a row without any "colspan" attributes.

2.58.4.  "rowspan" Attribute

   The number of rows that the cell is to span.  For example, setting
   "rowspan='3'" indicates that the cell occupies the same vertical
   space as three rows.

2.59.  <thead>

   A container for a set of header rows for a table.

   This element appears as a child element of <table> (Section 2.54).

   Content model:

   One or more <tr> elements (Section 2.61)

2.59.1.  "anchor" Attribute

   Document-wide unique identifier for the thead.

Top      Up      ToC       Page 72 
2.60.  <title>

   Represents the document title.

   When this element appears in the <front> element of the current
   document, the title might also appear in page headers or footers.  If
   it is long (~40 characters), the "abbrev" attribute can be used to
   specify an abbreviated variant.

   This element appears as a child element of <front> (Section 2.26).

   Content model: only text content.

2.60.1.  "abbrev" Attribute

   Specifies an abbreviated variant of the document title.

2.60.2.  "ascii" Attribute

   The ASCII equivalent of the title.

2.61.  <tr>

   A row of a table.

   This element appears as a child element of <tbody> (Section 2.55),
   <tfoot> (Section 2.57), and <thead> (Section 2.59).

   Content model:

   In any order, but at least one of:

   o  <td> elements (Section 2.56)

   o  <th> elements (Section 2.58)

2.61.1.  "anchor" Attribute

   Document-wide unique identifier for the row.

Top      Up      ToC       Page 73 
2.62.  <tt>

   Causes the text to be displayed in a constant-width font.  This
   element can be combined with other character formatting elements, and
   the formatting will be additive.

   This element appears as a child element of <annotation>
   (Section 2.3), <blockquote> (Section 2.10), <cref> (Section 2.16),
   <dd> (Section 2.18), <dt> (Section 2.21), <em> (Section 2.22), <li>
   (Section 2.29), <name> (Section 2.32), <preamble> (Section 3.6),
   <refcontent> (Section 2.39), <strong> (Section 2.50), <sub>
   (Section 2.51), <sup> (Section 2.52), <t> (Section 2.53), <td>
   (Section 2.56), and <th> (Section 2.58).

   Content model:

   In any order:

   o  Text

   o  <bcp14> elements (Section 2.9)

   o  <cref> elements (Section 2.16)

   o  <em> elements (Section 2.22)

   o  <eref> elements (Section 2.24)

   o  <iref> elements (Section 2.27)

   o  <relref> elements (Section 2.44)

   o  <strong> elements (Section 2.50)

   o  <sub> elements (Section 2.51)

   o  <sup> elements (Section 2.52)

   o  <xref> elements (Section 2.66)

Top      Up      ToC       Page 74 
2.63.  <ul>

   An unordered list.  The labels on the items will be symbols picked by
   the formatter.

   This element appears as a child element of <abstract> (Section 2.1),
   <aside> (Section 2.6), <blockquote> (Section 2.10), <dd>
   (Section 2.18), <li> (Section 2.29), <note> (Section 2.33), <section>
   (Section 2.46), <td> (Section 2.56), and <th> (Section 2.58).

   Content model:

   One or more <li> elements (Section 2.29)

2.63.1.  "anchor" Attribute

   Document-wide unique identifier for the list.

2.63.2.  "empty" Attribute

   Defines whether or not the label is empty.  empty="true" indicates
   that no label will be shown.

   Allowed values:

   o  "false" (default)

   o  "true"

2.63.3.  "spacing" Attribute

   Defines whether or not there is a blank line between entries.
   spacing="normal" indicates a single blank line, while
   spacing="compact" indicates no space between.

   Allowed values:

   o  "normal" (default)

   o  "compact"

Top      Up      ToC       Page 75 
2.64.  <uri>

   Contains a web address associated with the author.

   The contents should be a valid URI; this most likely will be an
   "http:" or "https:" URI.

   This element appears as a child element of <address> (Section 2.2).

   Content model: only text content.

2.65.  <workgroup>

   This element is used to specify the Working Group (IETF) or Research
   Group (IRTF) from which the document originates, if any.  The
   recommended format is the official name of the Working Group (with
   some capitalization).

   In Internet-Drafts, this is used in the upper left corner of the
   boilerplate, replacing the "Network Working Group" string.
   Formatting software can append the words "Working Group" or "Research
   Group", depending on the "submissionType" property of the <rfc>
   element (Section 2.45.12).

   This element appears as a child element of <front> (Section 2.26).

   Content model: only text content.

2.66.  <xref>

   A reference to an anchor in this document.  Formatters that have
   links (such as HTML and PDF) are likely to render <xref> elements as
   internal hyperlinks.  This element is useful for referring to
   references in the "References" section, to specific sections of this
   document, to specific figures, and so on.  The "target" attribute is
   required.

   This element appears as a child element of <annotation>
   (Section 2.3), <blockquote> (Section 2.10), <c> (Section 3.1), <cref>
   (Section 2.16), <dd> (Section 2.18), <dt> (Section 2.21), <em>
   (Section 2.22), <li> (Section 2.29), <name> (Section 2.32),
   <postamble> (Section 3.5), <preamble> (Section 3.6), <strong>
   (Section 2.50), <sub> (Section 2.51), <sup> (Section 2.52), <t>
   (Section 2.53), <td> (Section 2.56), <th> (Section 2.58), <tt>
   (Section 2.62), and <ttcol> (Section 3.9).

   Content model: only text content.

Top      Up      ToC       Page 76 
2.66.1.  "format" Attribute

   This attribute signals to formatters what the desired format of the
   reference should be.  Formatters for document types that have linking
   capability should wrap the displayed text in hyperlinks.

   "counter"

      The "derivedContent" attribute will contain just a counter.  This
      is used for targets that are <section>, <figure>, <table>, or
      items in an ordered list.  Using "format='counter'" where the
      target is any other type of element is an error.

      For example, with an input of:

         <section anchor="overview">Protocol Overview</section>
         . . .
         See Section <xref target="overview" format="counter"/>
         for an overview.

      An HTML formatter might generate:

         See Section <a href="#overview">1.7</a> for an overview.

   "default"

      If the element has no content, the "derivedContent" attribute will
      contain a text fragment that describes the referenced part
      completely, such as "XML" for a target that is a <reference>, or
      "Section 2" or "Table 4" for a target to a non-reference.  (If the
      element has content, the "derivedContent" attribute is filled with
      the content.)

      For example, with an input of:

         <section anchor="overview">Protocol Overview</section>
         . . .
         See <xref target="overview"/> for an overview.

      An HTML formatter might generate:

         See <a href="#overview">Section 1.7</a> for an overview.

   "none"

      Deprecated.

Top      Up      ToC       Page 77 
   "title"

      If the target is a <reference> element, the "derivedContent"
      attribute will contain the name of the reference, extracted from
      the <title> child of the <front> child of the reference.  Or, if
      the target element has a <name> child element, the
      "derivedContent" attribute will contain the text content of that
      <name> element concatenated with the text content of each
      descendant node of <name> (that is, stripping out all of the XML
      markup, leaving only the text).  Or, if the target element does
      not contain a <name> child element, the "derivedContent" attribute
      will contain the name of the "anchor" attribute of that element
      with no other adornment.

   Allowed values:

   o  "default" (default)

   o  "title"

   o  "counter"

   o  "none"

2.66.2.  "pageno" Attribute

   Deprecated.

   Allowed values:

   o  "true"

   o  "false" (default)

2.66.3.  "target" Attribute (Mandatory)

   Identifies the document component being referenced.  The value needs
   to match the value of the "anchor" attribute of an element in the
   document; otherwise, it is an error.


Next Section