Merge pull request #482 from robander/rngdoccleanup

Remove obsolete doc from RNG until review completes
oasis-tcs · Oct 4, 2021 · e782456 · e782456
2 parents dd3c9a1 + 4e28275
commit e782456
Show file tree

Hide file tree

Showing 13 changed files with 170 additions and 369 deletions.
diff --git a/doctypes/rng/base/alternativeTitlesDomain.rng b/doctypes/rng/base/alternativeTitlesDomain.rng
@@ -104,8 +104,7 @@
             </define>
             <define name="navtitle.element"> 
                 <element name="navtitle" dita:longName="Navigation Title">
-                    <a:documentation>Specifies the title to use when displaying the resource in the context of a
-                        navigational aid, such as a table of contents. Category: Topic elements</a:documentation>
+                    <a:documentation></a:documentation>
                     <ref name="navtitle.attlist"/>
                     <ref name="navtitle.content"/>
                 </element>
@@ -135,8 +134,7 @@
             </define>
             <define name="searchtitle.element">
                 <element name="searchtitle" dita:longName="Search Title">
-                    <a:documentation>Specifies the title to display for this resource in search results for output
-                        systems that support topic-based searching. Category: Topic elements</a:documentation>
+                    <a:documentation></a:documentation>
                     <ref name="searchtitle.attlist"/>
                     <ref name="searchtitle.content"/>
                 </element>
@@ -167,9 +165,7 @@
             </define>
             <define name="linktitle.element">
                 <element name="linktitle" dita:longName="Link Title">
-                    <a:documentation>Specifies the title to use when populating empty links or
-                        cross-references to this topic. May also be used as a fallback for certain
-                        other alternative titles. Category: Topic elements</a:documentation>
+                    <a:documentation></a:documentation>
                     <ref name="linktitle.attlist"/>
                     <ref name="linktitle.content"/>
                 </element>
@@ -200,7 +196,7 @@
             </define>
             <define name="subtitle.element">
                 <element name="subtitle" dita:longName="Subtitle">
-                    <a:documentation>Specifies a secondary or subordinate title. Category: Topic elements</a:documentation>
+                    <a:documentation></a:documentation>
                     <ref name="subtitle.attlist"/>
                     <ref name="subtitle.content"/>
                 </element>
@@ -231,9 +227,7 @@
             </define>
             <define name="titlehint.element">
                 <element name="titlehint" dita:longName="titlehint">
-                    <a:documentation>For use in DITA maps to indicate the title of the referenced
-                        resource for the convenience of map authors; not used in output.
-                        Category: Topic elements</a:documentation>
+                    <a:documentation></a:documentation>
                     <ref name="titlehint.attlist"/>
                     <ref name="titlehint.content"/>
                 </element>

diff --git a/doctypes/rng/base/commonElementsMod.rng b/doctypes/rng/base/commonElementsMod.rng
diff --git a/doctypes/rng/base/ditavalrefDomain.rng b/doctypes/rng/base/ditavalrefDomain.rng
@@ -100,18 +100,12 @@ PUBLIC "-//OASIS//ELEMENTS DITA 2.0 DITAVAL Ref Domain//EN"
       </optional>
       <optional>
         <attribute name="conaction">
-          <a:documentation>This attribute enables users to push content into a new location.</a:documentation>
           <choice>
             <value>mark</value>
-            <a:documentation>Marks the reference position.</a:documentation>
             <value>pushafter</value>
-            <a:documentation>Push after the marked position.</a:documentation>
             <value>pushbefore</value>
-            <a:documentation>Push before the marked position.</a:documentation>
             <value>pushreplace</value>
-            <a:documentation>Push and replace content.</a:documentation>
             <value>-dita-use-conref-target</value>
-            <a:documentation>Use the value from the conref target.</a:documentation>
           </choice>
         </attribute>
       </optional>
@@ -192,7 +186,7 @@ PUBLIC "-//OASIS//ELEMENTS DITA 2.0 DITAVAL Ref Domain//EN"
       <ref name="ditavalref-univ-atts"/>
     </define>
     <define name="ditavalmeta.element">
-      <a:documentation>The &lt;ditavalmeta> element ...</a:documentation>
+      <a:documentation></a:documentation>
       <element name="ditavalmeta" a:longName="DITAVAL Ref Metadata">
         <ref name="ditavalmeta.attlist"/>
         <ref name="ditavalmeta.content"/>
@@ -223,7 +217,7 @@ PUBLIC "-//OASIS//ELEMENTS DITA 2.0 DITAVAL Ref Domain//EN"
       <ref name="ditavalref-univ-atts"/>
     </define>
     <define name="dvrResourcePrefix.element">
-      <a:documentation>The &lt;dvrResourcePrefix> element ...</a:documentation>
+      <a:documentation></a:documentation>
       <element name="dvrResourcePrefix" a:longName="DITVAL Ref Resource Prefix">
         <ref name="dvrResourcePrefix.attlist"/>
         <ref name="dvrResourcePrefix.content"/>
@@ -254,7 +248,7 @@ PUBLIC "-//OASIS//ELEMENTS DITA 2.0 DITAVAL Ref Domain//EN"
       <ref name="ditavalref-univ-atts"/>
     </define>
     <define name="dvrResourceSuffix.element">
-      <a:documentation>The &lt;dvrResourceSuffix> element ...</a:documentation>
+      <a:documentation></a:documentation>
       <element name="dvrResourceSuffix" a:longName="DITVAL Ref Resource Suffix">
         <ref name="dvrResourceSuffix.attlist"/>
         <ref name="dvrResourceSuffix.content"/>
@@ -285,7 +279,7 @@ PUBLIC "-//OASIS//ELEMENTS DITA 2.0 DITAVAL Ref Domain//EN"
       <ref name="ditavalref-univ-atts"/>
     </define>
     <define name="dvrKeyscopePrefix.element">
-      <a:documentation>The &lt;dvrKeyscopePrefix> element ...</a:documentation>
+      <a:documentation></a:documentation>
       <element name="dvrKeyscopePrefix" a:longName="DITVAL Ref Key Scope Prefix">
         <ref name="dvrKeyscopePrefix.attlist"/>
         <ref name="dvrKeyscopePrefix.content"/>
@@ -316,7 +310,7 @@ PUBLIC "-//OASIS//ELEMENTS DITA 2.0 DITAVAL Ref Domain//EN"
       <ref name="ditavalref-univ-atts"/>
     </define>
     <define name="dvrKeyscopeSuffix.element">
-      <a:documentation>The &lt;dvrKeyscopeSuffix> element ...</a:documentation>
+      <a:documentation></a:documentation>
       <element name="dvrKeyscopeSuffix" a:longName="DITVAL Ref Resource Suffix">
         <ref name="dvrKeyscopeSuffix.attlist"/>
         <ref name="dvrKeyscopeSuffix.content"/>

diff --git a/doctypes/rng/base/emphasisDomain.rng b/doctypes/rng/base/emphasisDomain.rng
@@ -94,9 +94,7 @@
       </define>
       <define name="strong.element"> 
         <element name="strong" dita:longName="Strong">
-          <a:documentation>Strong text can be used to indicate content that is considered to be important 
-            or serious, or that has some form of urgency. Category: Emphasis elements
-          </a:documentation>
+          <a:documentation></a:documentation>
           <ref name="strong.attlist"/>
           <ref name="strong.content"/>
         </element>
@@ -127,9 +125,7 @@
       </define>
       <define name="em.element">
         <element name="em" dita:longName="Emphasis">
-          <a:documentation>Emphasized text is used to indicate stress or to otherwise 
-            highlight content. Category: Emphasis elements
-          </a:documentation>
+          <a:documentation></a:documentation>
           <ref name="em.attlist"/>
           <ref name="em.content"/>
         </element>

diff --git a/doctypes/rng/base/hazardstatementDomain.rng b/doctypes/rng/base/hazardstatementDomain.rng
@@ -107,10 +107,7 @@ PUBLIC "-//OASIS//ELEMENTS DITA 2.0 Hazard Statement Domain//EN"
       </define>
       <define name="hazardstatement.element">
         <element name="hazardstatement" dita:longName="Hazard Statement">
-          <a:documentation>The &lt;hazardstatement> element contains hazard warning information. It
-            is based on the regulations of the ANSI Z535 and the ISO 3864 standards. It gives the
-            author the opportunity to select the hazard statement, to add one or more safety signs
-            and to add the required phrases.</a:documentation>
+          <a:documentation></a:documentation>
           <ref name="hazardstatement.attlist"/>
           <ref name="hazardstatement.content"/>
         </element>
@@ -190,10 +187,7 @@ PUBLIC "-//OASIS//ELEMENTS DITA 2.0 Hazard Statement Domain//EN"
       </define>
       <define name="hazardsymbol.element">
         <element name="hazardsymbol" dita:longName="Hazard Symbol">
-          <a:documentation>A graphic representation intended to convey a message without the use of
-            words. It may represent a hazard, a hazardous situation, a precaution to avoid a hazard,
-            a result of not avoiding a hazard, or any combination of these
-            messages.</a:documentation>
+          <a:documentation></a:documentation>
           <ref name="hazardsymbol.attlist"/>
           <ref name="hazardsymbol.content"/>
         </element>
@@ -242,10 +236,7 @@ PUBLIC "-//OASIS//ELEMENTS DITA 2.0 Hazard Statement Domain//EN"
       </define>
       <define name="messagepanel.element">
         <element name="messagepanel" dita:longName="Hazard Message panel">
-          <a:documentation>The &lt;messagepanel> element describes the area of a safety sign or
-            label that contains the word message which identifies a hazard, indicates how to avoid
-            the hazard, and advises of the probable consequences of not avoiding the
-            hazard.</a:documentation>
+          <a:documentation></a:documentation>
           <ref name="messagepanel.attlist"/>
           <ref name="messagepanel.content"/>
         </element>
@@ -272,9 +263,7 @@ PUBLIC "-//OASIS//ELEMENTS DITA 2.0 Hazard Statement Domain//EN"
       </define>
       <define name="typeofhazard.element">
         <element name="typeofhazard" dita:longName="The Type of Hazard">
-          <a:documentation>&lt;typeofhazard> element is the container for the first text entry of a
-            safety label. It contains the description of the type of hazard, such as &#34;Moving
-            parts can crush and cut&#34;.</a:documentation>
+          <a:documentation></a:documentation>
           <ref name="typeofhazard.attlist"/>
           <ref name="typeofhazard.content"/>
         </element>
@@ -301,9 +290,7 @@ PUBLIC "-//OASIS//ELEMENTS DITA 2.0 Hazard Statement Domain//EN"
       </define>
       <define name="consequence.element">
         <element name="consequence" dita:longName="Consequences of not Avoiding the Hazard">
-          <a:documentation>The &lt;consequence> element is the container for the second text entry
-            of a safety label. It contains the description of the consequences of not avoiding the
-            hazard, such as &#34;Keep guard in place&#34;.</a:documentation>
+          <a:documentation></a:documentation>
           <ref name="consequence.attlist"/>
           <ref name="consequence.content"/>
         </element>
@@ -333,9 +320,7 @@ PUBLIC "-//OASIS//ELEMENTS DITA 2.0 Hazard Statement Domain//EN"
       </define>
       <define name="howtoavoid.element">
         <element name="howtoavoid" dita:longName="How to Avoid the Hazard">
-          <a:documentation>The &lt;howtoavoid> element is the container for the third text entry of
-            a safety label. It contains the description of how to avoid the hazard, such as
-            &#34;Lock out power before servicing&#34;.</a:documentation>
+          <a:documentation></a:documentation>
           <ref name="howtoavoid.attlist"/>
           <ref name="howtoavoid.content"/>
         </element>

diff --git a/doctypes/rng/base/highlightDomain.rng b/doctypes/rng/base/highlightDomain.rng
@@ -118,9 +118,7 @@
       </define>
       <define name="b.element">
         <element name="b" dita:longName="Bold">
-          <a:documentation>Bold text is used to draw attention to a word or 
-            phrase for utilitarian purposes without implying that there is any 
-            extra importance. Category: Typographic elements</a:documentation>
+          <a:documentation></a:documentation>
           <ref name="b.attlist"/>
           <ref name="b.content"/>
         </element>
@@ -151,7 +149,7 @@
       </define>
       <define name="u.element">
         <element name="u" dita:longName="Underlined">
-          <a:documentation>The underline (&lt;u>) element is used to apply underline highlighting to the content of the element. Category: Typographic elements</a:documentation>
+          <a:documentation></a:documentation>
           <ref name="u.attlist"/>
           <ref name="u.content"/>
         </element>
@@ -182,9 +180,7 @@
       </define>
       <define name="i.element">
         <element name="i" dita:longName="Italic">
-          <a:documentation>Italic text is used to indicate either an alternate voice 
-            or mood, or to otherwise offset it from the content around it to indicate 
-            a different quality of text. Category: Typographic elements</a:documentation>
+          <a:documentation></a:documentation>
           <ref name="i.attlist"/>
           <ref name="i.content"/>
         </element>
@@ -214,7 +210,7 @@
       </define>
       <define name="line-through.element">
         <element name="line-through" dita:longName="Line through">
-          <a:documentation>Category: Typographic elements </a:documentation>
+          <a:documentation></a:documentation>
           <ref name="line-through.attlist"/>
           <ref name="line-through.content"/>
         </element>
@@ -245,7 +241,7 @@
       </define>
       <define name="overline.element">
         <element name="overline" dita:longName="Overline">
-          <a:documentation>Category: Typographic elements </a:documentation>
+          <a:documentation></a:documentation>
           <ref name="overline.attlist"/>
           <ref name="overline.content"/>
         </element>
@@ -255,7 +251,7 @@
       </define>
     </div>
     <div>
-      <a:documentation>LONG NAME: Typewriter</a:documentation>
+      <a:documentation>LONG NAME: Teletype</a:documentation>
       <define name="tt.content">
         <zeroOrMore>
           <choice>
@@ -276,7 +272,7 @@
       </define>
       <define name="tt.element">
         <element name="tt" dita:longName="Teletype (monospaced)">
-          <a:documentation> The teletype (&lt;tt>) element is used to apply monospaced highlighting to the content of the element. Category: Typographic elements </a:documentation>
+          <a:documentation></a:documentation>
           <ref name="tt.attlist"/>
           <ref name="tt.content"/>
         </element>
@@ -307,9 +303,7 @@
       </define>
       <define name="sup.element">
         <element name="sup" dita:longName="Superscript">
-          <a:documentation>The superscript (&lt;sup>) element indicates that text should be superscripted, or vertically raised in relationship to the surrounding text. Superscripts are usually a
-            smaller font than the surrounding text. Use this element only when there is not some other more proper tag. This element is part of the DITA highlighting domain. Category: Typographic
-            elements</a:documentation>
+          <a:documentation></a:documentation>
           <ref name="sup.attlist"/>
           <ref name="sup.content"/>
         </element>
@@ -340,8 +334,7 @@
       </define>
       <define name="sub.element">
         <element name="sub" dita:longName="Subscript">
-          <a:documentation>A subscript (&lt;sub>) indicates that text should be subscripted, or placed lower in relationship to the surrounding text. Subscripted text is often a smaller font than the
-            surrounding text. Formatting may vary depending on your output process. This element is part of the DITA highlighting domain. Category: Typographic elements</a:documentation>
+          <a:documentation></a:documentation>
           <ref name="sub.attlist"/>
           <ref name="sub.content"/>
         </element>

diff --git a/doctypes/rng/base/mapGroupDomain.rng b/doctypes/rng/base/mapGroupDomain.rng
@@ -119,8 +119,7 @@ PUBLIC "-//OASIS//ELEMENTS DITA 2.0 Map Group Domain//EN"
       </define>
       <define name="topichead.element">
         <element name="topichead">
-          <a:documentation>The &lt;topichead> element provides a title-only entry in a navigation map, as an alternative to the fully-linked title provided by the &lt;topicref> element. Category:
-            Mapgroup elements</a:documentation>
+          <a:documentation></a:documentation>
           <ref name="topichead.attlist"/>
           <ref name="topichead.content"/>
         </element>
@@ -151,9 +150,7 @@ PUBLIC "-//OASIS//ELEMENTS DITA 2.0 Map Group Domain//EN"
       </define>
       <define name="topicgroup.element">
         <element name="topicgroup">
-          <a:documentation>The &lt;topicgroup> element is for creating groups of &lt;topicref> elements without affecting the hierarchy, as opposed to nested &lt; topicref> elements within a
-            &lt;topicref>, which does imply a structural hierarchy. It is typically used outside a hierarchy to identify groups for linking without affecting the resulting toc/navigation output.
-            Category: Mapgroup elements</a:documentation>
+          <a:documentation></a:documentation>
           <ref name="topicgroup.attlist"/>
           <ref name="topicgroup.content"/>
         </element>
@@ -263,8 +260,7 @@ PUBLIC "-//OASIS//ELEMENTS DITA 2.0 Map Group Domain//EN"
       </define>
       <define name="anchorref.element">
         <element name="anchorref">
-          <a:documentation>The contents of an &lt;anchorref> element are rendered both in the original authored location and at the location of the referenced &lt;anchor> element. The referenced
-            &lt;anchor> element can be defined in the current map or another map.</a:documentation>
+          <a:documentation></a:documentation>
           <ref name="anchorref.attlist"/>
           <ref name="anchorref.content"/>
         </element>
@@ -302,9 +298,7 @@ PUBLIC "-//OASIS//ELEMENTS DITA 2.0 Map Group Domain//EN"
       </define>
       <define name="mapref.element">
         <element name="mapref" dita:longName="Map reference">
-          <a:documentation>The &lt;mapref> element is a convenience element that has the same meaning as a &lt;topicref> element that explicitly sets the format attribute to &#34;ditamap&#34;. The
-            hierarchy of the referenced map is merged into the container map at the position of the reference, and the relationship tables of the child map are added to the parent
-            map.</a:documentation>
+          <a:documentation></a:documentation>
           <ref name="mapref.attlist"/>
           <ref name="mapref.content"/>
         </element>
@@ -415,9 +409,7 @@ PUBLIC "-//OASIS//ELEMENTS DITA 2.0 Map Group Domain//EN"
       </define>
       <define name="keydef.element">
         <element name="keydef">
-          <a:documentation>The &lt;keydef> element is a convenience element that is used to define keys without any of the other effects that occur when using a &lt;topicref> element: no content is
-            included in output, no title is included in the table of contents, and no linking or other relationships are defined. The &lt;keydef> element is not the only way to define keys; its
-            purpose is to simplify the process by defaulting several attributes to achieve the described behaviors.</a:documentation>
+          <a:documentation></a:documentation>
           <ref name="keydef.attlist"/>
           <ref name="keydef.content"/>
         </element>
@@ -513,7 +505,7 @@ PUBLIC "-//OASIS//ELEMENTS DITA 2.0 Map Group Domain//EN"
       </define>
       <define name="mapresources.element">
         <element name="mapresources">
-          <a:documentation/>
+          <a:documentation></a:documentation>
           <ref name="mapresources.attlist"/>
           <ref name="mapresources.content"/>
         </element>