Edit highlighting domain topics

oasis-tcs · Nov 3, 2021 · 364acf4 · 364acf4
1 parent f246d25
commit 364acf4
Show file tree

Hide file tree

Showing 8 changed files with 37 additions and 37 deletions.
diff --git a/specification/common/reuse-w-lwdita/reuse-b.dita b/specification/common/reuse-w-lwdita/reuse-b.dita
@@ -2,8 +2,9 @@
 <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
 <reference id="b" xml:lang="en-us">
 <title><xmlelement>b</xmlelement></title>
-  <shortdesc id="shortdesc">Bold text is used to draw a reader's attention to a phrase without
-    otherwise adding meaning to the content.</shortdesc>
+  <shortdesc id="shortdesc">Bold text is text that is used to draw a
+    reader's attention to a phrase without otherwise adding meaning to the
+    content.</shortdesc>
 <refbody>
   <section id="specialization-hierarchy">
    <title>Specialization hierarchy</title>

diff --git a/specification/common/reuse-w-lwdita/reuse-i.dita b/specification/common/reuse-w-lwdita/reuse-i.dita
@@ -2,8 +2,9 @@
 <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
 <reference id="i" xml:lang="en-us">
 <title><xmlelement>i</xmlelement></title>
-    <shortdesc id="shortdesc">Italic text is used to emphasize the key points in printed text, or
-        when quoting a speaker, to show which words the speaker stressed.</shortdesc>
+    <shortdesc id="shortdesc">Italic text is text that is used to emphasize
+    the key points in printed text, or when quoting a speaker, to show
+    which words the speaker stressed.</shortdesc>
 <refbody>
         <section id="specialization-hierarchy">
             <title>Specialization hierarchy</title>

diff --git a/specification/langRef/base/b.dita b/specification/langRef/base/b.dita
@@ -9,14 +9,15 @@
 </keywords>
 </metadata></prolog>
 <refbody>
-    <section conkeyref="reuse-b/specialization-hierarchy" id="specialization-hierarchy"/>
+    <section conkeyref="reuse-b/specialization-hierarchy"
+      id="specialization-hierarchy"/>
   <section conkeyref="reuse-b/attributes" id="attributes"/>
 <example id="example" otherprops="examples">
 <title>Example</title>
 
-      <p>The following code sample shows bold highlighting used to draw a reader's attention to a
-        phrase:</p>
-<codeblock>&lt;p&gt;Use the bold tag <b>&lt;b&gt;for visual emphasis only&lt;/b&gt;</b>; do not use it if another phrase-level 
+      <p>The following code sample shows a <xmlelement>b</xmlelement>
+        element used to draw a reader's attention to a phrase:</p>
+<codeblock>&lt;p&gt;Use the bold tag &lt;b&gt;for visual emphasis only&lt;/b&gt;; do not use it if another phrase-level 
 element better signifies the reason for the emphasis.&lt;/p&gt;</codeblock>
 
 </example>

diff --git a/specification/langRef/base/i.dita b/specification/langRef/base/i.dita
@@ -9,11 +9,13 @@
 </keywords>
 </metadata></prolog>
 <refbody>
-        <section conkeyref="reuse-i/specialization-hierarchy" id="specialization-hierarchy"/>
+        <section conkeyref="reuse-i/specialization-hierarchy"
+      id="specialization-hierarchy"/>
         <section conkeyref="reuse-i/attributes" id="attributes"/>
 <example id="example" otherprops="examples"><title>Example</title>
-            <p>The following code sample shows italic highlighting used to indicate a different
-                voice, such as the use of a foreign word:</p>
+            <p>The following code sample shows an
+          <xmlelement>i</xmlelement>element used to indicate the use of a
+        foreign word:</p>
             <codeblock>&lt;note type="tip">Take care to measure the right amount when mixing ingredients.
 A <b>&lt;i>laissez-faire&lt;/i></b> attitude to baking is a recipe for disaster.&lt;/note></codeblock></example>
 </refbody>

diff --git a/specification/langRef/base/line-through.dita b/specification/langRef/base/line-through.dita
@@ -2,8 +2,10 @@
 <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
 <reference xml:lang="en-us" id="line-through" >
   <title><xmlelement>line-through</xmlelement></title>
-  <shortdesc>The <xmlelement>line-through</xmlelement> element indicates text that is rendered with
-    a line struck through the content.</shortdesc>
+  <shortdesc>A strikethrough is a typographical presentation of words with
+    a horizontal line through their center. It can indicate that words are
+    a mistake and not intended for inclusion, or it can be used
+    deliberately to imply a change of thought.</shortdesc>
   <prolog>
     <metadata>
       <keywords>
@@ -30,8 +32,9 @@
     </section>
     <example id="example" otherprops="examples">
       <title>Example</title>
-      <p>The following code sample shows line-through highlighting used to indicate a rhetorical
-        revision:</p>
+      <p>The following code sample shows a
+          <xmlelement>line-through</xmlelement> element used to indicate a
+        rhetorical revision:</p>
       <codeblock xml:space="preserve">&lt;p>Line-through: DITA technology can be
       &lt;line-through>maddening&lt;/line-through>a challenge to implement.&lt;/p></codeblock>
     </example>

diff --git a/specification/langRef/base/overline.dita b/specification/langRef/base/overline.dita
@@ -2,8 +2,9 @@
 <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
 <reference xml:lang="en-us" id="overline">
   <title><xmlelement>overline</xmlelement></title>
-  <shortdesc>The <xmlelement>overline</xmlelement> element indicates content that is rendered with a
-    line above it. </shortdesc>
+  <shortdesc>An overline is a horizontal line that is printed above a line
+    of text, a mathematical symbol, or an illustration in a newspaper or
+    journal.</shortdesc>
   <prolog>
     <metadata>
       <keywords>
@@ -24,8 +25,10 @@
     </section>
     <example id="example" otherprops="examples">
       <title>Example</title>
-      <p>The following code sample shows overline highlighting used for mathematical notation:</p>
-      <codeblock xml:space="preserve">&lt;p>Overline: &lt;overline>&lt;i>x&lt;/i>&lt;/overline> is the 
+      <p>The following code sample shows an <xmlelement>overline
+        </xmlelement> element used to provide the highlighting used for
+        mathematical notation:</p>
+      <codeblock>&lt;p>Overline: &lt;overline>&lt;i>x&lt;/i>&lt;/overline> is the 
 average value of&lt;i>x&lt;sub>i&lt;/sub>&lt;/i>&lt;/p></codeblock>
     </example>
   </refbody>

diff --git a/specification/langRef/base/tt.dita b/specification/langRef/base/tt.dita
@@ -3,8 +3,9 @@
  "reference.dtd">
 <reference id="tt" xml:lang="en-us">
 <title><xmlelement>tt</xmlelement></title>
-<shortdesc>The <xmlelement>tt</xmlelement> (teletype) indicates text that typically is rendered in
-      monospaced highlighting. </shortdesc>
+  <shortdesc>Teletype text is text that is displayed on a fixed-width
+    display such as a teletype, text-only screen, or line
+    printer.</shortdesc>
 <prolog><metadata>
 <keywords><indexterm>highlighting domain<indexterm><xmlelement>tt</xmlelement></indexterm></indexterm>
 </keywords>

diff --git a/specification/langRef/containers/hi-d.dita b/specification/langRef/containers/hi-d.dita
@@ -2,22 +2,10 @@
 <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
 <reference id="highld" xml:lang="en-us">
 <title>Highlighting domain elements</title>
-<shortdesc>The highlighting elements are used to highlight text with styles such as bold, italic,
-        and monospaced. These elements are intended solely for use by authors when no semantically
-        appropriate element is available and a formatting effect is required.<draft-comment
-            author="robander">Need to decide on a consistent style for short descriptions for these.
-            Currently have:<ul id="ul_ppg_nc2_ppb">
-                <li>Bold text is used...</li>
-                <li>Italic text is used...</li>
-                <li>The <xmlelement>line-through</xmlelement> element indicates text that is
-                    ...</li>
-                <li>The <xmlelement>overline</xmlelement> element indicates content that is ...</li>
-                <li>A subscript is text that is ...</li>
-                <li>A superscript is text that is ...</li>
-                <li>The <xmlelement>tt</xmlelement> (teletype) indicates text that typically is
-                    ...</li>
-                <li>An underline, also called an underscore, is a ...</li>
-            </ul></draft-comment></shortdesc>
+<shortdesc>The highlighting elements are used to highlight text with styles
+    such as bold, italic, and monospaced. These elements are intended
+    solely for use by authors when no semantically appropriate element is
+    available and a formatting effect is required.</shortdesc>
 <prolog><metadata>
 <keywords><indexterm>domains<indexterm>highlighting</indexterm></indexterm></keywords>
 </metadata></prolog>