Skip to content
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

Limiting the number of glossary links #117

Closed
1 of 4 tasks
about-code opened this issue Dec 5, 2020 · 1 comment
Closed
1 of 4 tasks

Limiting the number of glossary links #117

about-code opened this issue Dec 5, 2020 · 1 comment
Labels
enhancement New feature or request

Comments

@about-code
Copy link
Owner

about-code commented Dec 5, 2020

User Story

With a large body of terms being used to describe a domain the frequency of using terms from the body of terms increases with the level of details of the domain being described. So chapters describing very specific details of a domain tend to have paragraphs with many term occurrences. As a writer I would like to be able to limit the number of glossary links being created for better readability and less distraction.

As a writer I would like to be able to limit the number of links to only the first occurrence

  • within a paragraph (paragraph is meant to be understood by the definition of the markdown syntax element paragraph)
  • within a section (section is meant to be understood as the area between two headings (corresponding to the markdown syntax element heading)
  • within a chapter (chapter is meant to be understood as the area between two headings (corresponding to the markdown syntax element heading with attribute depth 1)
  • within a document (a markdown file)
@about-code about-code added the enhancement New feature or request label Dec 5, 2020
@about-code about-code added wontfix This will not be worked on and removed wontfix This will not be worked on labels Dec 6, 2020
about-code added a commit that referenced this issue Dec 6, 2020
* feat: Limiting the number of glossary links to first in paragraph (#117, #118, #127)
* test: New baseline.
@about-code
Copy link
Owner Author

A few ideas have been dropped for the moment due to implementation cost. We might reconsider them upon request gut are closing this for now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant