-
Notifications
You must be signed in to change notification settings - Fork 17
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
DOC: Appendices bookmarks not being generated #227
base: main
Are you sure you want to change the base?
DOC: Appendices bookmarks not being generated #227
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: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for the effort on addressing all these issues Albert!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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. |
Adding appendices properly to bookmarks. Closes #128.