DOC: Appendices bookmarks not being generated#227
DOC: Appendices bookmarks not being generated#227thewtex merged 1 commit intoInsightSoftwareConsortium:mainfrom
Conversation
|
Now I see #128. But I still see bookmarks (I think that's what the content in the left panel is): |
|
I don't see the double appendices / Appendix in the propose patch anymore (see results in the GHA aritfacts: https://github.com/InsightSoftwareConsortium/ITKSoftwareGuide/actions/runs/14055782571) With the 5.4.2 version I see: Note especially the place of the word appendices and the extra whilst in version 5.24.2 we see: |
dzenanz
left a comment
There was a problem hiding this comment.
Thank you for the effort on addressing all these issues Albert!
There was a problem hiding this comment.
Thanks for doing this @albert-github.
I would please ask you to stick to the ITK commit message guidelines:
https://docs.itk.org/en/stable/contributing/#commit-messages
Please, read the section and do read Chris Beam's post.
Having clear, self-contained messages helps reviewing, and, especially, navigating history.
So
$ git commit --amend
|
Jon, could you please amend the commit with the message you would like to see? That could serve as another example for Albert to learn our preferred norms. |
Generate bookmarks for Appendices:
- Transition to a new part using `\part{Appendices}`.
- Transition to the A, B, C numbering using `\appendix`.
- Redefine the `\part` and `\partname` commands to an empty string so
that the "Part" and part number (name) values are not displayed.
| \renewcommand{\thepart}{} | ||
| \renewcommand{\partname}{} | ||
| \part{Appendices} | ||
| \appendix |
There was a problem hiding this comment.
What happens if \begin{appendices} and \end{appendices} are kept? I've read that they are better for long documents vs. using \appendix.
9c661e4 to
a8dc6f7
Compare
@dzenanz I've done this, but as I've not investigated the fix or possibilities, thoroughly, it is just guesswork or a mere description, so @albert-github I'd be grateful if you could amend the commit message. Also, as it detaches from the commit message that I put, there is not a single command there that says explicitly which ones makes the bookmarks to be displayed, which should be the whole point of the fix. |
thewtex
left a comment
There was a problem hiding this comment.
@albert-github @dzenanz @jhlegarreta thank you 🙏






Adding appendices properly to bookmarks. Closes #128.