[std] Improve index by adding cross-references to defined terms
Nobody has claimed this yet.
- Dominant language
- TeX
- Stars
- 221
- Forks
- 813
- Avg merge
- 16h 4m
- Merged PRs (30d)
- 36
Description
Consider "odr-use": We're pretty good at sticking a cross-reference to [basic.def.odr] after each mention of the term, but the index still only lists page 27, where the term is defined.
Suggestion:
- Introduce new macros
\usedefn{term}{xref}and\usedefnx{term}{index-term}{xref}. They would render asterm\iref{xref}and also put add an index entry fortermorindex-term, respectively. - We could make the index entry bold for the location where we define a term.
- Replace all appearances of
odr-use\iref{basic.def.odr}with\usedefn{odr-use}{basic.def.odr}etc.
Opinions?
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the existing \iref references for defined terms, especially odr-use and [basic.def.odr]. Review how index entries and cross-references are currently generated, then assess the proposed \usedefn and \usedefnx macros and replace the identified appearances if the approach is accepted; done means the references render correctly and index entries are added as specified.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- tex
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100