Index: Allow to configure heading depth for less cluttered index file #63
Labels
enhancement
New feature or request
Comments
about-code
added a commit
that referenced
this issue
Jan 26, 2020
) You can now use option `indexing.groupByHeadingDepth` to adjust the granularity of section links in an index file. So for example for `groupByHeadingDepth: 1` the term index will only print the chapters of occurrence. Sections of occurrence are listed in numbered subscript links. (`generateFiles.indexFile` or `generateFiles.listOfFigures`).
about-code
added a commit
that referenced
this issue
Feb 9, 2020
feat: Allow configuring heading depth for less cluttered index file (#63) You can now use option `indexing.groupByHeadingDepth` to adjust the granularity of section links in an index file. So for example for `groupByHeadingDepth: 1` the term index will only print the chapters of occurrence. Sections of occurrence are listed in numbered subscript links. docs: API doc test: New baseline.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
User Story
Today when generating an index file for glossary terms, the generated file will list terms and for each term all the headings directly preceding the paragraph of occurrence. While this allows to jump precisely to the location where a term was used, it clutters the index with seemingly unrelated headings.
As a writer I would like to be able to declare that the index should only link to headings of a particular depth, e.g. document titles (headings of depth 1) and want the system to generate superscript links to the sections of occurrence (depth > 1).
Example 1:
depth: 1generates links to document titles and links to deeper document sections as superscript linksExample 2:
depth: 2generates links to headings at depth 2 and superscript links to headings of depth > 2The text was updated successfully, but these errors were encountered: