Skip to content

Commit

Permalink
Final edits from review Chenier
Browse files Browse the repository at this point in the history
  • Loading branch information
robander committed Aug 13, 2024
1 parent b6d013c commit 3566816
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 21 deletions.
3 changes: 1 addition & 2 deletions specification/archSpec/base/index-overview.dita
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,7 @@
<li>An <term>index</term> is a mapping from
<xmlelement>indexterm</xmlelement> elements to locations in the
DITA content.</li>
<li>a <term>generated index</term> is a human-readable mapping of
index terms to rendered locations.</li>
<li>A <term>generated index</term> is a mapping of index terms to rendered locations.</li>
</ul>
<p>While DITA provides several elements that support indexing, how those elements are used
will vary by implementation.</p>
Expand Down
26 changes: 14 additions & 12 deletions specification/archSpec/base/index-ranges.dita
Original file line number Diff line number Diff line change
Expand Up @@ -33,24 +33,26 @@
<dl>
<dlentry>
<dt>Topic body</dt>
<dd rev="review-chenier">The start-of-range and
end-of-range elements are in the body of the same DITA topic. The
range is defined as between two point references in the DITA
topic</dd>
<dd rev="review-chenier">The start-of-range and end-of-range elements are in the
body of the same DITA topic. The range is defined as between two point references in the
DITA topic. If an end-of-range element does not exist within the same topic body, the
start-of-range element is treated as a point reference rather than as the start of a
range.</dd>
</dlentry>
<dlentry>
<dt>Topic prolog</dt>
<dd rev="review-chenier">The start-of-range and
end-of-range elements are in the prolog of the same DITA topic.
The range is defined as being between the title of the DITA topic
and the end of the last nested topic. </dd>
<dd rev="review-chenier">The start-of-range and end-of-range elements are in the
prolog of the same DITA topic. The range is defined as being between the title of the DITA
topic and the end of the last nested topic. If an end-of-range element does not exist
within the topic prolog, the start-of-range element is treated as a point reference rather
than as the start of a range.</dd>
</dlentry>
<dlentry>
<dt>DITA map</dt>
<dd rev="review-chenier">The start-of-range and
end-of-range elements are contained within topic references in
the same DITA map. If an end-of-range element does not exist
within the same map, the start-of-range element is ignored.</dd>
<dd rev="review-chenier">The start-of-range and end-of-range elements are contained
within topic references in the same DITA map. If an end-of-range element does not exist
within the same map, the start-of-range element is treated as a point reference rather
than as the start of a range.</dd>
</dlentry>
</dl>
<p>Processors that support index ranges <term outputclass="RFC-2119">SHOULD</term> do the following:<ul>
Expand Down
12 changes: 5 additions & 7 deletions specification/archSpec/base/location-of-indexterm-elements.dita
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,11 @@
<dl>
<dlentry>
<dt>Topic prologs</dt>
<dd>An <xmlelement>indexterm</xmlelement> element that is
located in a topic prolog is a point reference to the title of
the topic. <ph rev="review-1">If an
<xmlelement>indexterm</xmlelement> element has an
<xmlatt>end</xmlatt> attribute, it is a point reference to
the <ph rev="review-chenier">end of the branch that is
specified by the topic reference</ph>.</ph></dd>
<dd>An <xmlelement>indexterm</xmlelement> element that is located in a topic prolog
is a point reference to the title of the topic. <ph rev="review-1">If an
<xmlelement>indexterm</xmlelement> element has an <xmlatt>end</xmlatt>
attribute, it is a point reference to the <ph rev="review-chenier">end of
the topic, including any sub-topics</ph>.</ph></dd>
</dlentry>
<dlentry rev="review-1">
<dt>Anywhere else in a DITA topic</dt>
Expand Down

0 comments on commit 3566816

Please sign in to comment.