Skip to content

Commit

Permalink
Update STYLE-GUIDE.adoc
Browse files Browse the repository at this point in the history
  • Loading branch information
JakeSCahill authored Sep 26, 2024
1 parent c3c87b5 commit 605f754
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions meta-docs/STYLE-GUIDE.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -670,6 +670,17 @@ This is an important glossterm:<term-name>:[<definition>]

IMPORTANT: Links to the glossary page are provided only when terms are defined in the {url-docs}/tree/shared/modules/terms[`terms` module] of the `shared` branch.

To add custom link text for a term, which can be useful for displaying plurals or context-specific variations of the term without changing the term reference, use this syntax:

[,asciidoc]
----
glossterm:<term-name>[,<custom-link-text>]
----

Here, replace `<custom-link-text>` with text that will appear as the link. For example:

glossterm:test term[,This link text is custom.]

=== Glossary pages

To produce a glossary page with all terms that have been defined in the `shared` component, create an empty page called `glossary.adoc` in the `reference` module and include a title:
Expand Down

0 comments on commit 605f754

Please sign in to comment.