Glossary-table
Preview#
| Abbreviation | The broad category for any shortened form of a word or phrase. It can be a clipped word, such as Dr. for doctor, or a set of initials. Acronyms and initialisms are both abbreviations, but not all abbreviations are acronyms. | Abbreviation | Writing |
| Acronym | A new pronounceable word made from the first letters of a long name or phrase, such as laser instead of Light Amplification by Stimulated Emission of Radiation. It is a subtype of abbreviation. | Abbreviation | Writing |
| Alias | An alternate label, spelling, acronym, or old URL that points back to a canonical term or page. | Term | Content |
| Archetype | A reusable starter file for a known content shape, used to create pages with consistent front matter and structure. | Term | Hugo |
| Architecture Decision Record (ADR) | A short decision note that records context, decision, consequences, and status. | Term | Governance |
| Brand system | The reusable identity, content, design, and implementation decisions that make the brand recognizable across surfaces. | Term | Identity |
| Component | A reusable interface pattern with a defined purpose, behavior, source, and accessibility expectation. | Term | Interface |
| Content adapter | A Hugo mechanism that turns structured data records into normal pages during the build. | Term | Hugo |
| Data-driven page aka generated table | A page whose visible content is rendered from structured data rather than maintained as manual Markdown rows. | Term | Architecture |
| Design system | The shared foundations, components, content patterns, and implementation rules used to build coherent interfaces. | Term | Foundations |
| Design token aka token | A named design decision that stores a reusable visual value such as colour, type, spacing, or layout. | Term | Foundations |
| Glossary | A curated reference of preferred terms, definitions, aliases, and bilingual equivalents. | Term | Governance |
| Hugo | The static site generator used to turn Markdown, data files, templates, and assets into the published sites. | Term | Hugo |
| Initialism | An abbreviation made from the first letters of a phrase, pronounced one letter at a time, such as ATM instead of automated teller machine. | Abbreviation | Writing |
| Internationalization (i18n) | Internationalization. The language-aware template and content mechanics that support English and French pages. | Abbreviation | Hugo |
| Markdown | A lightweight plain-text format for writing structured content that Hugo can render as HTML. | Term | Content |
| Partial layout | A reusable Hugo template fragment stored under layouts/partials/. | Term | Hugo |
| Shortcode | A Hugo helper called from Markdown to render reusable behavior or structured markup. | Term | Hugo |
| Style Dictionary | The token build tool that transforms source token data into generated CSS and documentation data. | Term | Tooling |
Example
{{< glossary-table >}}When to use
A sortable glossary table rendered from `data/brand/glossary.yml` by default.
Implementation
layouts/shortcodes/glossary-table.htmlOptions
| Option | Read by the shortcode template |
|---|---|
source | Read by the shortcode template |
Interface manifest
- Kind
- Shortcode
- Category
- Data
- Status
- Implemented
- Implementation
- Shortcode:
layouts/shortcodes/glossary-table.html