Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Update subseries presentation #1102

Merged
merged 4 commits into from
Feb 21, 2024

Conversation

kesara
Copy link
Member

@kesara kesara commented Feb 14, 2024

Fixes #1100

With 205c09c, 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
Copy link
Collaborator

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
Copy link
Contributor

cabo commented Feb 14, 2024

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

@kesara kesara force-pushed the feat/subseries-references branch from 728f880 to 73c7b80 Compare February 14, 2024 23:13
@kesara
Copy link
Member Author

kesara commented Feb 14, 2024

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.

@kesara kesara force-pushed the feat/subseries-references branch from 7549f1d to 8fe62fb Compare February 15, 2024 02:57
@kesara kesara requested a review from rjsparks February 15, 2024 18:35
@rjsparks
Copy link
Member

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

Copy link
Collaborator

@ajeanmahoney ajeanmahoney left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).

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>

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

@kesara kesara force-pushed the feat/subseries-references branch from 8fe62fb to 8685b57 Compare February 19, 2024 01:19
@kesara kesara force-pushed the feat/subseries-references branch from 8685b57 to 43a33a8 Compare February 19, 2024 01:20
@kesara
Copy link
Member Author

kesara commented Feb 19, 2024

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
Copy link
Contributor

cabo commented Feb 19, 2024

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

@kesara
Copy link
Member Author

kesara commented Feb 19, 2024

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
Copy link
Contributor

cabo commented Feb 19, 2024

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
Copy link
Member Author

kesara commented Feb 20, 2024

@ajeanmahoney Any issues with the output changes in #1102 (comment)?

@ajeanmahoney ajeanmahoney self-requested a review February 21, 2024 21:11
Copy link
Collaborator

@ajeanmahoney ajeanmahoney left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've reviewed the test outputs, and it looks good.

@kesara kesara merged commit e4542c2 into ietf-tools:main Feb 21, 2024
13 checks passed
@kesara kesara deleted the feat/subseries-references branch February 21, 2024 21:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Updated format for subseries references
4 participants