From 605f754b2e8e9f16f53f2607c1c0c2e8926ad499 Mon Sep 17 00:00:00 2001 From: Jake Cahill <45230295+JakeSCahill@users.noreply.github.com> Date: Thu, 26 Sep 2024 22:14:28 +0100 Subject: [PATCH] Update STYLE-GUIDE.adoc --- meta-docs/STYLE-GUIDE.adoc | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/meta-docs/STYLE-GUIDE.adoc b/meta-docs/STYLE-GUIDE.adoc index cb79414..6845b44 100644 --- a/meta-docs/STYLE-GUIDE.adoc +++ b/meta-docs/STYLE-GUIDE.adoc @@ -670,6 +670,17 @@ This is an important glossterm::[] 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:[,] +---- + +Here, replace `` 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: