xml2rfc_examples
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
xml2rfc_examples [2020/10/27 16:37] arusso |
xml2rfc_examples [2020/10/28 15:14] (current) arusso |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ===== xml2rfc examples ===== | ===== xml2rfc examples ===== | ||
| + | |||
| + | When considering "Is there a better way to do this?" | ||
| ==== Summary ==== | ==== Summary ==== | ||
| - xref to a section in another RFC and the authors want to include the section title | - xref to a section in another RFC and the authors want to include the section title | ||
| - | - xref to a section in another RFC when it's not desired to have the RFC number immediately afterwards. | ||
| - xref with format=" | - xref with format=" | ||
| - < | - < | ||
| Line 10: | Line 11: | ||
| ==== Details ==== | ==== Details ==== | ||
| - | === 1) xref to a section in another RFC and the authors want to include the section title === | + | ==== 1) xref to a section in another RFC and the authors want to include the section title ==== |
| It requires 2 xrefs to get the desired output (using sectionFormat=" | It requires 2 xrefs to get the desired output (using sectionFormat=" | ||
| - | See two examples at end of page. | + | Note: As discussed with Henrik Nov. 2019. |
| - | === 2) xref to a section in another RFC when it's not desired to have the RFC number immediately afterwards. === | + | Example A (from rfc8658.notprepped.xml) |
| - | workaround: rephrase to avoid using sectionFormat=" | + | XML: |
| + | < | ||
| + | described in Section <xref target=" | ||
| + | sectionFormat=" | ||
| + | </ | ||
| + | TEXT output: | ||
| + | < | ||
| + | described in Section 2 (IANA Considerations) of [RFC3575] | ||
| + | </ | ||
| + | HTML output: | ||
| + | < | ||
| + | < | ||
| + | </ | ||
| - | === 3) xref with format=" | + | -------------- |
| + | Example B (from rfc8731.notprepped.xml) | ||
| + | |||
| + | XML: | ||
| + | < | ||
| + | defined in Section <xref target=" | ||
| + | sectionFormat=" | ||
| + | </ | ||
| + | |||
| + | TEXT output: | ||
| + | < | ||
| + | defined in Section 7.1 (ECDH Message Numbers) of [RFC5656] | ||
| + | </ | ||
| + | |||
| + | HTML output: | ||
| + | < | ||
| + | < | ||
| + | </ | ||
| + | |||
| + | |||
| + | ==== 2) xref with format=" | ||
| bc it includes square brackets around the title in the text file | bc it includes square brackets around the title in the text file | ||
| Line 38: | Line 71: | ||
| < | < | ||
| This document obsoletes " | This document obsoletes " | ||
| - | | + | |
| </ | </ | ||
| Line 46: | Line 79: | ||
| < | < | ||
| This document obsoletes [" | This document obsoletes [" | ||
| - | | + | |
| </ | </ | ||
| - | === 4) use < | + | ==== 3) use < |
| - | The functionality exists | + | It's possible to include more info when < |
| a) name + org\\ | a) name + org\\ | ||
| - | ''< | + | XML: ''< |
| - | (file: draft-ietf-lisp-gpe-19.xml - in the queue) | + | (file: draft-ietf-lisp-gpe-19.xml - in the queue)\\ |
| + | Original (in a list): '' | ||
| b) name + email\\ | b) name + email\\ | ||
| - | ''< | + | XML: ''< |
| - | (file: rfc8790.notprepped.xml) | + | (file: rfc8790.notprepped.xml)\\ |
| + | Original (in a registration template): '' | ||
| c) name + email + org\\ | c) name + email + org\\ | ||
| - | ''< | + | XML: ''< |
| - | (file: rfc8698.notprepped.xml) | + | (file: rfc8698.notprepped.xml)\\ |
| + | Original (in a paragraph in " | ||
| + | Thinking aloud: ability to put the data in the contact element and have a decent rendering when in < | ||
| - | === 5) get a <dl> with a blank line between <dt> and <dd> === | + | ==== 4) get a <dl> with a blank line between <dt> and < |
| Mail sent 2020-10-15 with details. | Mail sent 2020-10-15 with details. | ||
| Line 75: | Line 112: | ||
| suggestion from Jean for dl's newline attribute: newline=" | suggestion from Jean for dl's newline attribute: newline=" | ||
| - | file: rfc8940.xml (draft-ietf-emu-eap-session-id-07) | + | file: published as rfc8940.xml (draft-ietf-emu-eap-session-id-07) |
| - | === More on #1 === | ||
| - | === xref to published RFC with section number and section title === | ||
| - | Note: As discussed with Henrik Nov. 2019. | ||
| - | |||
| - | Example 1 (from rfc8658.notprepped.xml) | ||
| - | |||
| - | XML: | ||
| - | < | ||
| - | described in Section <xref target=" | ||
| - | sectionFormat=" | ||
| - | </ | ||
| - | |||
| - | TEXT output: | ||
| - | < | ||
| - | described in Section 2 (IANA Considerations) of [RFC3575] | ||
| - | </ | ||
| - | |||
| - | HTML output: | ||
| - | < | ||
| - | < | ||
| - | </ | ||
| - | |||
| - | Example 2 (from rfc8731.notprepped.xml) | ||
| - | |||
| - | XML: | ||
| - | < | ||
| - | defined in Section <xref target=" | ||
| - | sectionFormat=" | ||
| - | </ | ||
| - | |||
| - | TEXT output: | ||
| - | < | ||
| - | defined in Section 7.1 (ECDH Message Numbers) of [RFC5656] | ||
| - | </ | ||
| - | |||
| - | HTML output: | ||
| - | < | ||
| - | < | ||
| - | </ | ||
xml2rfc_examples.1603841876.txt.gz · Last modified: 2020/10/27 16:37 by arusso
Page Tools
