Skip to content

Commit

Permalink
Editorial fixes wrt x:include (rfc-format#18)
Browse files Browse the repository at this point in the history
  • Loading branch information
reschke committed Apr 19, 2020
1 parent 5118a13 commit 27db8f1
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions draft-iab-rfc7991bis.xml
Expand Up @@ -6537,9 +6537,9 @@ that is either on the Internet or local to the user's computer.</t>
In the v3 syntax, XInclude is expressed as the &lt;xi:include&gt; element. To use this
element, you need to include the "xi" namespace in the &lt;<x:ref>rfc</x:ref>&gt; element; that is, you need to specify
</t>
<figure><artwork>
<artwork type="example">
xmlns:xi="http://www.w3.org/2001/XInclude"
</artwork></figure>
</artwork>
<t>
as one of the attributes in the &lt;<x:ref>rfc</x:ref>&gt; element.</t>

Expand All @@ -6548,7 +6548,7 @@ that are already formed as XML. Currently, this can be done from xml2rfc.tools.i
expected to be from the RFC Editor. For example, if a document has three normative
references, all RFCs, the document might contain:
</t>
<figure><artwork>
<artwork type="example">
&lt;references&gt;
&lt;xi:include href="http://xml2rfc.tools.ietf.org/public/rfc/
bibxml/reference.RFC.2119.xml"/&gt;
Expand All @@ -6557,17 +6557,17 @@ references, all RFCs, the document might contain:
&lt;xi:include href="http://xml2rfc.tools.ietf.org/public/rfc/
bibxml/reference.RFC.7169.xml"/&gt;
&lt;/references&gt;
</artwork></figure>

</artwork>
<t>(the line breaks in the example above have been added for readability and need to be removed in practice)</t>
<t>&lt;xi:include&gt; can be used anywhere an XML element could be used (but not where
free text is used). For example, if three Internet-Drafts are all including a particular paragraph
or section verbatim, that text can be kept either in a file or somewhere on the web and can be
included with &lt;xi:include&gt;. An example of pulling something from the local disk would
be:
</t>
<figure><artwork>
&lt;x:include href="file://home/chris/ietf/drafts/commontext.xml"/&gt;
</artwork></figure>
<artwork type="example">
&lt;xi:include href="file://home/chris/ietf/drafts/commontext.xml"/&gt;
</artwork>
<t>
In general, XInclude should be used instead of ENTITY references and XML Processing Instructions (PIs)
that allow external inclusions.
Expand Down Expand Up @@ -8816,6 +8816,7 @@ to the v3 schema.</t>

<section title="Since draft-iab-rfc7991bis-03" anchor="changes.since.03">
<ul x:when-empty="None yet.">
<li>Editorial fixes in <xref target="includingexternal"/> (<eref target="https://github.com/rfc-format/draft-iab-xml2rfc-v3-bis/issues/18"/>)</li>
<li>Fix prose and default value for &lt;<x:ref>dl</x:ref>&gt; element's "newline" attribute (<eref target="https://github.com/rfc-format/draft-iab-xml2rfc-v3-bis/issues/77"/>)</li>
<li>Undeprecated metadata attributes on &lt;<x:ref>rfc</x:ref>&gt; (<eref target="https://github.com/rfc-format/draft-iab-xml2rfc-v3-bis/issues/122"/>)</li>
</ul>
Expand Down

0 comments on commit 27db8f1

Please sign in to comment.