|
| 1 | +# Glossary style |
| 2 | + |
| 3 | +A supplement to the [Canonical Documentation Style Guide](https://docs.ubuntu.com/styleguide/en/) |
| 4 | + |
| 5 | +## Glossary entry |
| 6 | +A glossary entry explains what is meant by a term. |
| 7 | + |
| 8 | +**product** <br /> |
| 9 | +A unit of software or hardware that is offered to a market to meet a need. |
| 10 | + |
| 11 | +### A use of a term |
| 12 | + |
| 13 | +A use of a term such as [product](https://www.example.com) is presented as a link to the entry for that term in a glossary. |
| 14 | + |
| 15 | +### Good definitions |
| 16 | + |
| 17 | +A *gloss* (the defining text) typically starts with an approachable, targeted description that is designed to help the reader understand a *sense* (a meaning) of a term. |
| 18 | + |
| 19 | +Each gloss should be clear about what the sense includes and what it excludes. This can be done by specifying the *context* (the conditions in which the term would have that sense) and the *application* (which items are included in the sense). |
| 20 | + |
| 21 | +### Inline definitions |
| 22 | + |
| 23 | +The guidelines under *Good definitions* demonstrate that a term can be defined in line by presenting the term in italics and providing a brief definition in parentheses. This is useful for terms that are only used in one or a few topics. If a term is widely used, the glossary is the best place to define it. |
| 24 | + |
| 25 | +### Ambiguity |
| 26 | + |
| 27 | +To reduce the number of ambiguous terms, try to use appropriately-specific terms. |
| 28 | + |
| 29 | +**core** <br /> |
| 30 | +The working memory of a computer. |
| 31 | + |
| 32 | +**core file** <br /> |
| 33 | +A file created when an application crashes. The file reflects the state of the application at the time of the crash, including the values in working memory ([core](https://www.example.com)). |
| 34 | + |
| 35 | +**Ubuntu Core** <br /> |
| 36 | +A minimal version of the Linux operating system designed to be embedded in devices that have stringent resource or performance constraints, such as [IoT](https://www.example.com) devices. |
| 37 | + |
| 38 | +It is rare that a technical term has multiple senses, so the following example is artificial. |
| 39 | + |
| 40 | +**cloud** <br /> |
| 41 | +1. A resource shared among customers and accessed via networking that contains, for example, storage and computing capacity. <br /> |
| 42 | +2. A mass of material suspended in a gas or liquid that scatters light. |
| 43 | + |
| 44 | +### Structure of more-complex definitions |
| 45 | + |
| 46 | +Although simplicity is a virtue in definitions, it helps to know how a more extensive definition can be structured. |
| 47 | + |
| 48 | +An optional informal description may be followed by a more-formal definition and sometimes a brief explanation. |
| 49 | +* A formal definition identifies the context and provides criteria for what is meant by the sense. |
| 50 | +* An explanation describes one or more of: what the thing being defined is useful for, how it is structured, how it works, and the effect of using it. |
| 51 | + |
| 52 | +### Abbreviations |
| 53 | + |
| 54 | +An abbreviation can be expanded at the beginning of the gloss. |
| 55 | + |
| 56 | +**DNS** <br /> |
| 57 | +**Domain Name System**. A system that translates human-readable domain names (canonical.com) to their IP addresses (185.125.190.20). |
| 58 | + |
| 59 | +### References to other terms |
| 60 | + |
| 61 | +A glossary entry or a gloss may |
| 62 | +* refer to detailed background (using "See"), |
| 63 | +* suggest alternative terms (using "Alternatives:"), and |
| 64 | +* suggest related topics, including related terms (using "Related topic:" or "Related topics:" followed by a comma-delimited list of topics and terms). |
| 65 | + |
| 66 | +Terms that are preferred in place of the current term may be presented as a link to the preferred term. |
| 67 | + |
| 68 | +A gloss may offer advice about when to select the term (using "Compare", "Synonyms:", and "Antonyms:") or how to use the term in context (using "Usage:"). |
| 69 | + |
| 70 | +*Examples to be provided.* |
| 71 | + |
| 72 | +### Supplementary information |
| 73 | + |
| 74 | +Conventional language and font treatments are used to flag special properties of the gloss or of the glossary term. |
| 75 | +* If a gloss is under construction, it may start with *Work in progress*. |
| 76 | +* The gloss content may start with information about status of the sense, such as *Deprecated*. |
| 77 | + |
| 78 | +Examples may be presented inline within parentheses or after the description, definition, and explanation (using "For example, "). |
| 79 | + |
| 80 | +A citation may be presented at the end of a gloss. |
| 81 | + |
| 82 | +*Examples to be provided.* |
0 commit comments