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
64 stars 38 forks source link

ToC in PDF output does not have subordinate appendix subsections #576

Closed ietf-svn-bot closed 3 years ago

ietf-svn-bot commented 3 years ago

resolution_wontfix type_defect | by mahoney@nostrum.com

In the table of contents of the PDF output, the subsections for appendices are listed at the same level as the main sections. For example:

Appendix A. Stuff
A.1  Foo
A.2  Bar

Instead of the following, where the "V" indicates an expandable/collapsable ToC entry with subsections: 

V  Appendix A. Stuff
     A.1  Foo
     A.2  Bar

For an example, please see https://www.rfc-editor.org/v3test/rfc8949.pdf

Issue migrated from trac:576 at 2022-02-08 07:11:29 +0000

ietf-svn-bot commented 3 years ago

@henrik@levkowetz.com uploaded file Screenshot 2020-12-02 at 17.10.32.png (15.9 KiB)

Screenshot Appendix E. ++ from pre-release RFC 8049, from Preview app Screenshot 2020-12-02 at 17.10.32.png

ietf-svn-bot commented 3 years ago

@henrik@levkowetz.com commented

This doesn't seem to match what I see using Safari 14.0.1 or Preview 11.0 on a Mac. See attached screenshot of the start of the Appendix G. ToC from the link above. Am I misunderstanding something?

ietf-svn-bot commented 3 years ago

@mahoney@nostrum.com uploaded file rfc8949-ToC-screenshot.png (185.2 KiB)

rfc8949-ToC-screenshot.png

ietf-svn-bot commented 3 years ago

@mahoney@nostrum.com commented

I've added a screenshot from RFC 8949 that shows the issue (taken from Preview 10.1 on Mac OS Mojave).

ietf-svn-bot commented 3 years ago

@henrik@levkowetz.com commented

Oh, I see. This isn't in the rendered PDF document, it's in the ToC that Preview generates based on information extracted from the PDF.

I'll see if I can understand how the difference between regular sub-sections and appendix sub-sections comes about (but depending on the code built into Preview to create this ToC this may not be something we can fix).

ietf-svn-bot commented 3 years ago

@henrik@levkowetz.com changed status from new to waiting

ietf-svn-bot commented 3 years ago

@henrik@levkowetz.com commented

I've investigated, and found that in the sidebar ToC generated by Preview, this issue occurs if the subsections of 'Appendix A' are named 'A.1', 'A.2' etc.; but it does not occur if the subsections are named 'Appendix A.1', 'Appendix A.2', etc.

So the current appendix subsection naming does not interact well with Preview's ToC extraction. Does the RPC want to change the appendix subsection naming style to be 'Appendix A.1' etc. rather than the current 'A.1', etc.?

ietf-svn-bot commented 3 years ago

@stpeter@mozilla.com commented

Per discussion in the XML change management team (see https://codimd.ietf.org/cmt-20210419 for notes) we suggest marking this as WONTFIX.

ietf-svn-bot commented 3 years ago

@stpeter@mozilla.com changed status from waiting to closed

ietf-svn-bot commented 3 years ago

@stpeter@mozilla.com changed resolution from ` towontfix`

ietf-svn-bot commented 3 years ago

@julian.reschke@gmx.de commented

FWIW, when using XSL:FO to generate PDF, "bookmarks" can be used to generate that view explicitly (at least Acrobat Reader uses that). I imagine other ways to generate PDF should have the same feature.

See https://www.w3.org/TR/xsl11/#d0e14206.

ietf-svn-bot commented 3 years ago

@julian.reschke@gmx.de commented

I've investigated, and found that in the sidebar ToC generated by Preview, this issue occurs if the subsections of 'Appendix A' are named 'A.1', 'A.2' etc.; but it does not occur if the subsections are named 'Appendix A.1', 'Appendix A.2', etc.

That is misleading. The core issue is that the sub-appendices incorrectly use

.

Please re-open; this is a bug.

ietf-svn-bot commented 3 years ago

@jennifer@painless-security.com commented

FYI, the patch for #581 will change the sub-appendices to <h3> to match other section headings.