Expose TOC placeholder in XML output #625
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Until now the brief description of pages was prepended to the <detaileddescription> element and the <briefdescription> element was not present at all, which meant there was no easy way to extract the brief description for purposes of creating a page index, for example. With this patch, the brief description is included in both <briefdescription> and <detaileddescription>, thus duplicated, to avoid backwards compatibility issues.
Currently the XML output for a page was generated the same independently of whether the \tableofcontents command was present in the page source or not. Because of that, the users of the XML output had no chance of knowing whether given page should have a TOC or not. There's now a new <tableofcontents> element that gets added in case the TOC was requested. As it is trivial to populate the TOC on user side by simply enumerating the <sectN> elements, the element is empty and acts just as a boolean.
mosra
force-pushed
the
xml-tableofcontents
branch
from
7ae0aed
to
fe76097
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
(Depends on changes in #624, even though the two features are independent, the changes are in very close areas -- I didn't want to open two PRs where one would conflict with the other and make you headaches with merging. Hope that's okay.)
Currently the XML output for a page was generated the same independently of whether the
\tableofcontentscommand was present in the page source or not. Because of that, the users of the XML output had no chance of knowing whether given page should have a TOC or not.There's now a new
<tableofcontents>element that gets added in case the TOC was requested. As it is trivial to populate the TOC on user side by simply enumerating the<sectN>elements, the element is empty and acts just as a boolean.Thanks again for looking into this :)