Merge pull request #620 from keberlein/chunking-indexing

Edits based on 04 Feb 2022 call with R Anderson

specification/archSpec/base/chunk-attribute-combine.dita

@@ -5,7 +5,7 @@
     <shortdesc><ph rev="review-h">The presence of </ph>
     <codeph>chunk="combine"</codeph> instructs a processor to combine the
       <ph rev="review-h">referenced</ph> source documents for rendering
-    purposes. A single result document is generated.</shortdesc>
+    purposes.<!-- A single result document is generated.--></shortdesc>
   <prolog>
     <metadata>
       <keywords>
@@ -32,10 +32,7 @@
           specifies <codeph>chunk="combine"</codeph>, the equivalent DITA
           document would be a single DITA document with a root element <ph
             rev="review-h">that groups</ph> peer topics.</note></li>
-            <li>When <ph rev="review-h"><codeph>chunk="combine"</codeph> is
-          specified</ph> on a reference to a map, all source DITA documents
-          <ph rev="review-h">that are</ph> within the scope of the
-        referenced map are treated as one DITA document.</li>
+      <!--<li>When <ph rev="review-h"><codeph>chunk="combine"</codeph> is specified</ph> on a reference to a map, all source DITA documents <ph rev="review-h">that are</ph> within the scope of the referenced map are treated as one DITA document.</li>-->
             <li><ph rev="review-h">When</ph>
         <codeph>chunk="combine"</codeph> is specified on a map, <ph
           rev="review-h">map</ph> branch, or map reference, all source DITA

specification/archSpec/base/chunk-attribute-split.dita

@@ -5,8 +5,8 @@
     <shortdesc><ph rev="review-h">The presence of </ph>
     <codeph>chunk="split"</codeph> instructs a processor to split each
     topic from the referenced source document into its own document for
-    rendering purposes. Multiple result documents are
-    generated.</shortdesc>
+    rendering
+    purposes.<!-- Multiple result documents are generated.--></shortdesc>
   <prolog>
     <metadata>
       <keywords>
@@ -19,6 +19,13 @@
 <conbody>
         <p>The following rules apply:</p>
         <ul>
+      <li>When <ph rev="review-h"><codeph>chunk="split"</codeph> is</ph>
+        specified on the root element of a map, it sets a default operation
+        for all source DITA documents <ph rev="review-h">in the navigation
+          structure of the map.</ph> The default <codeph>split</codeph>
+        value is used except where a <codeph>combine</codeph> value is
+        encountered, in which case <codeph>combine</codeph> takes over for
+        that entire branch. </li>
             <li>When <ph rev="review-h"><codeph>chunk="split"</codeph>
           is</ph> specified on a <xmlelement>topicref</xmlelement> element
         that <ph rev="review-h">references</ph> a source DITA document, it
@@ -29,19 +36,6 @@
           <xmlelement>topicgroup</xmlelement> that does not <ph
           rev="review-h">reference a source DITA document or result in
           published output</ph>, the attribute has no meaning.</li>
-            <li>When <ph rev="review-h"><codeph>chunk="split"</codeph>
-          is</ph> specified on the root element of a map, it sets a default
-        operation for all source DITA documents <ph rev="review-h">in the
-          navigation structure of the map.</ph> The default
-          <codeph>split</codeph> value is used except where a
-          <codeph>combine</codeph> value is encountered, in which case
-          <codeph>combine</codeph> takes over for that entire branch. </li>
         </ul>
-    <draft-comment author="Kristen J Eberlein" time="04 February 2022">
-      <p>What about <codeph>chunk="split" specified on a map reference or
-          map branch?</codeph></p>
-      <p>If possible, I'd like us to make this list and the one in the
-        previous topic parallel ...</p>
-    </draft-comment>
 </conbody>
 </concept>

specification/archSpec/base/example-chunk-combine-all.dita

@@ -4,15 +4,8 @@
 <title>Example: Using <xmlatt>chunk</xmlatt> to combine all documents into one</title>
 <shortdesc>When a processor would typically render each topic document as
     an independent result document, the <xmlatt>chunk</xmlatt> attribute
-    can be used to render all content as a single document.<draft-comment
-      author="Kristen J Eberlein" time="04 February 2022">
-      <p>Here's an alternate short description for us to consider: <q>When
-          a processor would typically render each topic document as an
-          independent result document, specifying
-            <codeph>chunk="combine</codeph> on the root map element
-          instructs the processor to render all content as a single
-          document.</q></p>
-    </draft-comment></shortdesc>
+    can be used to render all content as a single
+    document.<!--<draft-comment author="Kristen J Eberlein" time="04 February 2022"><p>Here's an alternate short description for us to consider: <q>When a processor would typically render each topic document as an independent result document, specifying <codeph>chunk="combine</codeph> on the root map element instructs the processor to render all content as a single document.</q></p></draft-comment>--></shortdesc>
   <prolog>
     <metadata>
       <keywords>

specification/archSpec/base/example-chunk-combine-branch.dita

@@ -6,15 +6,7 @@
 <shortdesc>When a publishing system typically would render each topic
     document as an independent result document, the <xmlatt>chunk</xmlatt>
     attribute can be used to render individual branches of a map as single
-      documents.<draft-comment author="Kristen J Eberlein"
-      time="04 February 2022">
-      <p>Here's an alternate short description for us to consider: <q>When
-          a processor would typically render each topic document as an
-          independent result document, specifying
-            <codeph>chunk="combine</codeph> on a map branch instructs the
-          processor to render the content of the map branch as a single
-          document.</q></p>
-    </draft-comment></shortdesc>
+    documents.<!--<draft-comment author="Kristen J Eberlein" time="04 February 2022"><p>Here's an alternate short description for us to consider: <q>When a processor would typically render each topic document as an independent result document, specifying <codeph>chunk="combine</codeph> on a map branch instructs the processor to render the content of the map branch as a single document.</q></p></draft-comment>--></shortdesc>
   <prolog>
     <metadata>
       <keywords>
@@ -85,7 +77,7 @@
         with <filepath>goals.dita</filepath> will not be affected.</p>
       <codeblock>&lt;map>
   &lt;title>Lesson plan&lt;/title>
-  &lt;topicref href="goals.dita" <b>chunk="combine"</b>>
+  &lt;topicref href="goals.dita">
     <ph rev="review-h">&lt;!-- More topic references to goal topics --></ph>
   &lt;/topicref>
   &lt;topicref href="firstLesson.dita" <b>chunk="combine"</b>>

specification/archSpec/base/example-chunk-combine-group.dita

@@ -5,13 +5,7 @@
       >groups</ph> of topics</title>
 <shortdesc>The <xmlatt>chunk</xmlatt> attribute can be used on grouping
     elements to combine multiple source documents into one result
-      document.<draft-comment author="Kristen J Eberlein"
-      time="04 February 2022">
-      <p>Here's an alternate short description for us to consider:
-          <q>Xpecifying <codeph>chunk="combine</codeph> on a  grouping
-          element instructs the processor to combine multiple source
-          documents into a single result document.</q></p>
-    </draft-comment></shortdesc>
+    document.<!--<draft-comment author="Kristen J Eberlein" time="04 February 2022"><p>Here's an alternate short description for us to consider: <q>Xpecifying <codeph>chunk="combine</codeph> on a grouping element instructs the processor to combine multiple source documents into a single result document.</q></p></draft-comment>--></shortdesc>
   <prolog>
     <metadata>
       <keywords>
@@ -52,7 +46,7 @@
         <filepath>ingroup2.dita</filepath>.</p>
     <p><ph rev="review-h">The result of evaluating the</ph>
       <xmlatt>chunk</xmlatt> attribute on
-        <xmlelement>topichead</xmlelement> also results in a single <ph
+        <xmlelement>topichead</xmlelement> is also a single <ph
         rev="review-h">result</ph> document. In many applications, a
         <xmlelement>topichead</xmlelement> is equivalent to a single
       title-only topic<ph rev="review-h">. In</ph> that case, the chunked

specification/archSpec/base/example-chunk-combine-nested-topics.dita

@@ -78,16 +78,19 @@ documents with their own nested topics.</shortdesc>
         middle documents have child topics that need to be taken into
         account:</p>
       <ul id="ul_l3y_wng_thb">
+        <!--<li><filepath>ancestor.dita</filepath> has a root <xmlelement>dita</xmlelement> element, so content from <ph rev="review-h">each topic that is referenced in the map</ph> is located after any nested topics within the final child of the <xmlelement>dita</xmlelement> element.</li>-->
+        <!--<li>ancestor.dita has a root &lt;dita> element, with several root-level topics. After evaluating the chunk attribute, content from middle.dita is placed after the the topic with id="ancestor-last-child" in ancestor.dita</li>-->
         <li><filepath>ancestor.dita</filepath> has a root
-            <xmlelement>dita</xmlelement> element, so content from <ph
-            rev="review-h">each topic that is referenced in the map</ph> is
-          located after any nested topics within the final child of the
-            <xmlelement>dita</xmlelement> element.</li>
+            <xmlelement>dita</xmlelement> element, with several root-level
+          topics. After evaluating the <xmlatt>chunk</xmlatt> attribute,
+          content from <filepath>middle.dita</filepath> is placed after the
+          topic with <codeph>id="ancestor-last-child"</codeph>in
+            <filepath>ancestor.dita</filepath>.</li>
+        <!--<li>middle.dita does not have a &lt;dita> element, but it does have a nested topic, so content from child.dita is located after that nested topic.</li>-->
         <li><filepath>middle.dita</filepath> does not have a
             <xmlelement>dita</xmlelement> element, but it does have a
-          nested topic, so content from <ph rev="review-h">any topic that
-            is referenced in the map</ph> is located after that nested
-          topic.</li>
+          nested topic, so content from <filepath>child.dita</filepath> is
+          located after that nested topic.</li>
       </ul>
       <p rev="review-h">In each case, the original map hierarchy is
         preserved.</p>

specification/archSpec/base/example-chunk-split.dita

@@ -24,7 +24,7 @@
       <title>Splitting a single <ph rev="review-h">topic</ph>
         document</title>
       <p rev="review-h">This example covers the scenario of splitting a
-        single topic referenced in a DITA map.</p>
+        single topic document that is referenced in a DITA map.</p>
       <fig id="fig_gqp_nqd_1gb">
         <title rev="review-h">Root map and the topic documents that it
           references</title>
@@ -136,7 +136,7 @@
 <example>
 <title>Splitting all topic documents in a map</title>
       <p rev="review-h">This example covers the scenario of splitting all
-        the topics that are referenced in a DITA map.</p>
+        the topic documents that are referenced in a DITA map.</p>
 <fig id="fig_qns_tsd_1gb">
 <title rev="review-h">Root map with chunking specified</title>
         <p><ph rev="review-h">Specifying</ph>