You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
As a user I want to have a link from the definition of a term to its occurrences in text.
Alternatively the software may offer an option to generate an index document which lists all glossary terms (without their detailed definition). Every term links to the term's glossary definition as well as to the parent section of the paragraph where it was found in text. The link to its definition may always be the first one. Multiple occurrences in the same section of a document only generate one section link in the index.
This could require a breaking change since the section headings of non-glossary documents must be made navigable. To be navigable they must be wrapped into links as we do for glossary headings already, e.g. with remark-autolink-headings. However, this could potentially alter manually created, navigable headings and their URL fragments. Changing the fragment could result in broken cross-links or bookmarks (they'll still find the page but make the HTML viewer no longer scroll to the correct position).
feat: Generate an index from glossary terms and links to sections where they are being mentioned. Enable with new config option 'generateFiles.indexFile'. Details see README.md (#3)
BREAKING CHANGE:
With this change section headings will be automatically linkified. URL fragments of section headings may change thus affecting inter-document cross-links or bookmarks of already published documentation. Note: links and bookmarks will continue to point the same *page* yet not the correct section on that page. Prior section headings which have manually been wrapped into markdown link brackets may get wrapped twice. Review any output prior to publishing it.
User Story
As a user I want to have a link from the definition of a term to its occurrences in text.
Alternatively the software may offer an option to generate an index document which lists all glossary terms (without their detailed definition). Every term links to the term's glossary definition as well as to the parent section of the paragraph where it was found in text. The link to its definition may always be the first one. Multiple occurrences in the same section of a document only generate one section link in the index.
For example an index could look like
Index
The text was updated successfully, but these errors were encountered: