@@ -33,17 +23,28 @@
The glossSurfaceForm element is most often used for terms that
also specify the glossAcronym element. In that context, the
glossSurfaceForm element contains the term in a manner that
- introduces both the term and the acronym, so that later references to the term can be
- replaced with the acronym alone. In some languages, the surface
- form that expands the acronym in its first use handles the formatting differently than in
- English. For example, in Polish, the acronym precedes the expansion. In addition, some
- languages may not have a corresponding acronym for a term, so the
- glossSurfaceForm and glossAcronym
- would be left blank in translated content.
- See the abbreviated-form element for a
- full description of how the surface form is used together with
- acronyms.
+ introduces both the term and
+ its
+ shortened form, so that later references to the term can be replaced with
+ the
+ shortened
+ form alone. In some languages, the surface
+ form that expands the
+ shortened
+ form in its first use handles the formatting differently than in
+ English. For example, in Polish,
+ an
+ acronym precedes
+ its
+ expansion. In addition, some languages may not have a corresponding
+ short
+ form for a term, so the glossSurfaceForm and
+ glossAcronym would be left blank in translated
+ content.
+ See the abbreviated-form
+ element for a full description of how the surface form is used together with
+ short
+ forms, such as acronyms.
Specialization hierarchy
@@ -63,7 +64,9 @@
the glossary entry topic is referenced from an abbreviated-form
element.
<glossentry id="abs">
- <glossterm>Anti-lock Braking System</glossterm>
+ <glossterm>Anti-lock Braking System</glossterm>
+ <glossdef>A safety feature on vehicles used to prevent a wheel lock up and
+ to help operators maintain control of the vehicle.</glossdef>
<glossBody>
<glossSurfaceForm>Anti-lock Braking System (ABS)</glossSurfaceForm>
<glossAlt>
@@ -74,3 +77,4 @@
+
\ No newline at end of file
diff --git a/specification/langRef/technicalContent/glossUsage.dita b/specification/langRef/technicalContent/glossUsage.dita
index 6bfa5391..5c561b54 100644
--- a/specification/langRef/technicalContent/glossUsage.dita
+++ b/specification/langRef/technicalContent/glossUsage.dita
@@ -21,10 +21,7 @@
Specialization hierarchy
The glossUsage element is specialized from
note. It is defined in the glossary entry module.
- Although I realize the element is specialized from Note, I
- question the need to point out the type and othertype attributes; they don't seem to me to
- have any meaning in the content of a usage note. A usage note is type usage note, in my
- mind. Why would anyone specify any type or othertype?
+
@@ -53,3 +50,4 @@
+
\ No newline at end of file
diff --git a/specification/langRef/technicalContent/glossentry.dita b/specification/langRef/technicalContent/glossentry.dita
index 62ff513d..f194b511 100644
--- a/specification/langRef/technicalContent/glossentry.dita
+++ b/specification/langRef/technicalContent/glossentry.dita
@@ -39,10 +39,16 @@
One possible implementation of a glossary in online processing is to associate a hotspot
for mentions of terms in term elements and display the definition
on hover or click. A possible implementation in PDF processing is to define a first-use
- occurrence form of the term with its acronym and use it in conjunction with
- abbreviated-form to render a spell-out version of the term with
- its acronym on first use within an output, while rendering the acronym in all subsequent
- locations.
+ occurrence form of the term with its
+ shortened
+ form and use it in conjunction with
+ abbreviated-form to render a
+ spelled-out
+ version of the term with its
+ short
+ form on first use within an output, while rendering the
+ short
+ form in all subsequent locations.
Specialization hierarchy
@@ -61,27 +67,28 @@
<glossterm>USB flash drive</glossterm>
<glossdef>A small portable drive.</glossdef>
<glossBody>
- <glossPartOfSpeech value="noun"/>
+
<glossUsage>Do not use this term in upper case (for example, in "USB Flash Drive")
because that suggests a trademark.</glossUsage>
<glossAlt>
<glossAcronym>UFD</glossAcronym>
- <glossStatus value="prohibited"/>
+ <glossUsage>Do not use. This acronym is commonly used
+ to stand for "unique factorization domain."</glossStatus>
</glossAlt>
<glossAlt id="memoryStick">
<glossSynonym>memory stick</glossSynonym>
- <glossUsage>This is a colloquial term.</glossUsage>
+ <glossUsage>Do not use. This synonym is a colloquial term.</glossUsage>
</glossAlt>
<glossAlt>
- <glossAbbreviation>stick</glossAbbreviation>
- <glossStatus value="prohibited"/>
- <glossUsage>This is too colloquial.</glossUsage>
- <glossAlternateFor href="#usbfd/memoryStick"/>
+ <glossAcronymn>stick</glossAcronym>
+ <glossUsage>Do not use. This short form is too vague.</glossUsage>
+
</glossAlt>
<glossAlt>
- <glossAbbreviation>flash</glossAbbreviation>
- <glossStatus value="prohibited"/>
- <glossUsage>This short form is ambiguous.</glossUsage>
+ <glossAcronym>flash</glossAcronym>
+
+ <glossUsage>Do not use. This short form is ambiguous.</glossUsage>
</glossAlt>
</glossBody>
</glossentry>
@@ -89,3 +96,4 @@
+
\ No newline at end of file