Skip to content

Commit d7ecba1

Browse files
committed
Use 4-space indentation for quoted markup. Explain glossary entry < dict entry.
1 parent 9af28da commit d7ecba1

File tree

1 file changed

+20
-18
lines changed

1 file changed

+20
-18
lines changed

website/docs/explanation/glossary_what.md

Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -68,40 +68,42 @@ A collection of related topics can be provided at the end of the gloss. These co
6868
```{glossary}
6969
GnuTLS
7070
**GNU’s Not Unix Transport Layer Security**.
71-
A GNU software package that secures data in transit by implementing the {term}`SSL`, {term}`TLS`, and {term}`DTLS` protocols.
71+
A GNU software package that secures data in transit by implementing the
72+
{term}`SSL`, {term}`TLS`, and {term}`DTLS` protocols.
7273
73-
Related topic(s): [GnuTLS (Ubuntu Server documentation)](https://documentation.ubuntu.com/server/explanation/crypto/gnutls/#), [GnuTLS (official site)](https://www.gnutls.org/), Cryptography, Web services, OpenLDAP.
74+
Related topic(s): [GnuTLS (Ubuntu Server documentation)](https://documentation.ubuntu.com/server/explanation/crypto/gnutls/#),
75+
[GnuTLS (official site)](https://www.gnutls.org/),
76+
Cryptography, Web services, OpenLDAP.
7477
7578
```
7679

77-
## Advanced features
80+
## Dictionary features
7881

79-
In this treatment, the features considered basic are those focused on meaning.
80-
81-
There is a further realm of more specialized glossary features. Sometimes the origin of a term, or the pronunciation, or an alternate form, or some other aspect of the term is of great interest.
82-
83-
Advanced features can be introduced in glossaries by imitating the features of entries in authoritative dictionaries.
82+
Glossary entries tend to be simpler than full dictionary entries. Some glossary entries, however, may include dictionary features such as the origin of a term, or the pronunciation, or an alternate form, or some other specialized aspect of the term that is of great interest.
8483

8584
## Appendix 1: Mechanics
8685

87-
This document is written in Markedly Structured Text ([MyST](https://myst-parser.readthedocs.io/en/latest/syntax/typography.html#syntax-glossaries)).
86+
This document is written in Markedly Structured Text
87+
([MyST](https://myst-parser.readthedocs.io/en/latest/syntax/typography.html#syntax-glossaries)).
8888

8989
Glossaries can also be produced using [reStructured Text (rST)](https://sublime-and-sphinx-guide.readthedocs.io/en/latest/glossary.html).
9090

9191
A reference to a term is coded as follows:
9292

93-
`{term}`referenced_term``
94-
95-
A complex glossary entry is coded as follows:
93+
`{term}`referenced_term
9694

97-
```{glossary}
98-
GnuTLS_example
99-
**GNU’s Not Unix Transport Layer Security**.
100-
A GNU software package that secures data in transit by implementing the {term}`SSL`, {term}`TLS`, and {term}`DTLS` protocols.
95+
A complex glossary entry is coded as follows ("..." indicates omitted characters):
10196

102-
Related topic(s): [GnuTLS (Ubuntu Server documentation)](https://documentation.ubuntu.com/server/explanation/crypto/gnutls/#), [GnuTLS (official site)](https://www.gnutls.org/), Cryptography, Web services, OpenLDAP.
97+
```{glossary}
98+
GnuTLS_example
99+
**GNU’s Not Unix Transport Layer Security**.
100+
A GNU software package that secures data in transit by implementing the
101+
{term}`SSL`, {term}`TLS`, and {term}`DTLS` protocols.
103102

104-
```
103+
Related topic(s): [GnuTLS (Ubuntu Server doc...)](https://doc.../gnutls/#),
104+
[GnuTLS (official site)](https://www.gnutls.org/),
105+
Cryptography, Web services, OpenLDAP.
106+
```
105107

106108
## Appendix 2: Locally-defined terms
107109

0 commit comments

Comments
 (0)