search

ietf-tools / xml2rfc

Generate RFCs and IETF drafts from document source in XML according to the IETF xml2rfc v2 and v3 vocabularies
https://ietf-tools.github.io/xml2rfc/
BSD 3-Clause "New" or "Revised" License
63 stars 35 forks source link

feat: Update subseries presentation #1102

Closed kesara closed 4 months ago

kesara commented 4 months ago

Fixes #1100

With https://github.com/ietf-tools/xml2rfc/pull/1102/commits/205c09c84fb4f204d727ae64c56dab70d61fe768, xml2rfc tries to add the correct target for subseries when referencegroup's target attribute is missing.

Updated examples: Format Example
XML draft-foobar-00.xml
Text draft-foobar-00.txt
HTML draft-foobar-00.html
PDF draft-foobar-00.pdf
ajeanmahoney commented 4 months ago

This fix's HTML output matches the current HTML output. However, the text output has line breaks in the URLs, whereas the current layout for text output starts the URL on a new line to prevent some of these breaks.

cabo commented 4 months ago

(off-topic comment: This appears to be one more case where <nobr functionality would help, this time in the bowels of xml2rfc.)

kesara commented 4 months ago

This fix's HTML output matches the current HTML output. However, the text output has line breaks in the URLs, whereas the current layout for text output starts the URL on a new line to prevent some of these breaks.

@ajeanmahoney, I've made appropriate changes. Can you recheck the example outputs? Thanks.

rjsparks commented 4 months ago

I've approved, but wait for @ajeanmahoney review as well.

kesara commented 4 months ago

The text output is missing a period between the URL and the "At the time of writing" sentence (the period is there in the HTML and PDF outputs).

I've fixed this.

The extrapolated URL (when the target is not given) for a STD, BCP, or FYI should be of the form <https://www.rfc-editor.org/info/...>. Currently it shows, for example, <https://www.rfc-editor.org/std/std1>

I've fixed this too.

For the non-subseries referencegroup output, I'd like to see one that contains multiple references, both with and without a target, thanks!

See updated files: Format Example
XML draft-foobar-00.xml
Text draft-foobar-00.txt
HTML draft-foobar-00.html
PDF draft-foobar-00.pdf
cabo commented 4 months ago

Can you do an example that has a referencegroup mixed from references to different subseries?

kesara commented 4 months ago

Can you do an example that has a referencegroup mixed from references to different subseries?

@cabo, RPC confirmed that RFCs are not shared between different subseries. But this is an issue if this happens in the future because the xml2rfc logic looks at the first reference within referencegroup to identify the subseries. This is because referencegroup element doesn't carry information about the subseries.

cabo commented 4 months ago

I'm fine with this behavior (first reference determines processing) -- I just wanted to make sure that we have considered this (non-)use case.

kesara commented 4 months ago

@ajeanmahoney Any issues with the output changes in https://github.com/ietf-tools/xml2rfc/pull/1102#issuecomment-1951542113?