Merge pull request #940 from keberlein/close-dave-alvin

updates from indexing review Dave Alvin
oasis-tcs · Sep 17, 2024 · 7e95e2e · 7e95e2e
2 parents 57ca226 + e3f0b2e
commit 7e95e2e
Show file tree

Hide file tree

Showing 5 changed files with 39 additions and 17 deletions.
diff --git a/specification/archSpec/base/index-elements.dita b/specification/archSpec/base/index-elements.dita
@@ -29,24 +29,25 @@
         <dl>
             <dlentry>
                 <dt><xmlelement>indexterm</xmlelement></dt>
-                <dd><ph rev="review-chenier">Defines a term or subject that
-            can contribute to an index.</ph>
+                <dd><ph rev="review-chenier">Defines a term that can
+            contribute to an index.</ph>
           <ph rev="review-dave-alvin">Matching values of
               <xmlatt>start</xmlatt> and <xmlatt>end</xmlatt> attributes on
               <xmlelement>indexterm</xmlelement> elements can specify an
             index range.</ph></dd>
             </dlentry>
             <dlentry>
                 <dt><xmlelement>index-see</xmlelement></dt>
-                <dd rev="review-1"><ph rev="review-chenier">Defines a term or subject to use as a
-                            <term>see reference</term>.</ph> See references direct a reader to the
-                    preferred term.</dd>
+                <dd rev="review-1"><ph rev="review-chenier">Defines a term
+            to use as a <term>see reference</term>.</ph> See references
+          direct a reader to the preferred term.</dd>
             </dlentry>
             <dlentry>
                 <dt><xmlelement>index-see-also</xmlelement></dt>
-                <dd rev="review-1"><ph rev="review-chenier">Defines a term or subject to use as a
-                            <term>see also reference</term>.</ph> See also references direct a
-                    reader to an alternate index entry for additional information.</dd>
+                <dd rev="review-1"><ph rev="review-chenier">Defines a term
+            to use as a <term>see also reference</term>.</ph> See also
+          references direct a reader to an alternate index entry for
+          additional information.</dd>
             </dlentry>
         </dl>
         <p>How the index elements are combined, the location of

diff --git a/specification/archSpec/base/index-page-references.dita b/specification/archSpec/base/index-page-references.dita
@@ -4,8 +4,7 @@
     <title>Index locators</title>
     <shortdesc>An <xmlelement>indexterm</xmlelement> element <ph
       rev="review-chenier">binds the content of the element, typically a
-      term or subject, to a specific location in a
-    document.</ph></shortdesc>
+      term, to a specific location in a document.</ph></shortdesc>
     <prolog>
         <metadata>
             <keywords>
@@ -26,9 +25,13 @@
             <li>An <xmlelement>indexterm</xmlelement> element that contains
         child <xmlelement>indexterm</xmlelement> elements contributes to
         the hierarchy of the multilevel index entry that is generated. Only
-        a <ph rev="review-chenier">leaf</ph>
+        a <term rev="review-chenier">leaf</term>
         <xmlelement>indexterm</xmlelement> element contributes a locator to
-        the generated index entry.</li>
+        the generated index entry. <ph rev="review-dave-alvin">A leaf
+            <xmlelement>indexterm</xmlelement> element is an
+            <xmlelement>indexterm</xmlelement> element that does not
+          contain any other <xmlelement>indexterm</xmlelement> elements.
+        </ph></li>
             <li>If an <xmlelement>indexterm</xmlelement> element also contains one or more
                     <xmlelement>index-see</xmlelement> elements, <ph rev="review-1">no locator is
                     included in the generated index entry.</ph></li>

diff --git a/specification/archSpec/base/index-ranges.dita b/specification/archSpec/base/index-ranges.dita
@@ -8,7 +8,7 @@
     <xmlelement>indexterm</xmlelement> elements to index <ph
       rev="review-chenier">an extended discussion</ph>. <ph
       rev="review-chenier">The generated index entry reflects the span
-      between the two <xmlelement>indexterm</xmlelement> elements </ph>. </shortdesc>
+      between the two <xmlelement>indexterm</xmlelement> elements</ph>. </shortdesc>
     <prolog>
         <metadata>
             <keywords>
@@ -32,9 +32,13 @@
       <ph rev="review-dave-alvin">End-of-range element should contain no
         content or nested elements.</ph>
     </p>
+    <p rev="review-dave-alvin">The start-of-range and end-of-range elements
+      must be leaf <xmlelement>indexterm</xmlelement> elements. If part of
+      a multilevel index entry, the start-of-range and end-of-range
+      elements must be at the same level of the hierarchy.</p>
         <p rev="review-chenier">The location of the
-        <xmlelement>indexterm</xmlelement> elements determines how the span
-      is defined:</p>
+        <xmlelement>indexterm</xmlelement> elements determines how the <ph
+        rev="review-dave-alvin">range</ph> is defined:</p>
         <dl>
             <dlentry>
                 <dt>Topic body</dt>

diff --git a/specification/dita-2.0-key-definitions-cover-pages.ditamap b/specification/dita-2.0-key-definitions-cover-pages.ditamap
@@ -13,14 +13,14 @@
       <!-- Also used in the "Citation format" section.-->
       <topicmeta>
         <keywords>
-          <keyword>Working Draft 37</keyword>
+          <keyword>Working Draft 39</keyword>
         </keywords>
       </topicmeta>
     </keydef>
     <keydef keys="stage-date">
       <topicmeta>
         <keywords>
-          <keyword>14 May 2024</keyword>
+          <keyword>29 August 2024</keyword>
         </keywords>
       </topicmeta>
     </keydef>

diff --git a/specification/non-normative/revision-history.dita b/specification/non-normative/revision-history.dita
@@ -175,6 +175,20 @@
         <stentry>Kristen James Eberlein</stentry>
         <stentry>Generated working draft #37. Included updated content for
           "Specialization elements".</stentry>
+      </strow>
+      <strow>
+        <stentry>17</stentry>
+        <stentry>26 August 2024</stentry>
+        <stentry>Kristen James Eberlein</stentry>
+        <stentry>Generated working draft #38. Included draft of updated
+          indexing content.</stentry>
+      </strow>
+      <strow>
+        <stentry>18</stentry>
+        <stentry>29 August 2024</stentry>
+        <stentry>Kristen James Eberlein</stentry>
+        <stentry>Working draft #39. Includes completed indexing
+          content.</stentry>
       </strow>
         </simpletable>
     </refbody>