Linkable glossary

[davedelong]

Feature Name

Glossary

Description

I would like DocC to aggregate - term Word: Definition… listings into a glossary, and then support linking to individual terms in that glossary using <term:Word>.

Motivation

It's pretty typical for packages to have custom terms or terms of art they use to express concepts, and aggregating that information into a glossary is useful for newcomers to become familiar with core concepts of the package. Having a consistent way to display that information would make building rich documentation simpler.

Importance

No response

Alternatives Considered

Currently I'm manually building my own glossary, but the generated HTML does not include id="..." values on the individual terms, so I cannot link to a specific term. The best I can do is [the term](<doc:Glossary>), which only takes users to the page itself.