Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

updates from indexing review Dave Alvin #940

Merged
merged 1 commit into from
Sep 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 9 additions & 8 deletions specification/archSpec/base/index-elements.dita
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
11 changes: 7 additions & 4 deletions specification/archSpec/base/index-page-references.dita
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand All @@ -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>
Expand Down
10 changes: 7 additions & 3 deletions specification/archSpec/base/index-ranges.dita
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand All @@ -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>
Expand Down
4 changes: 2 additions & 2 deletions specification/dita-2.0-key-definitions-cover-pages.ditamap
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
14 changes: 14 additions & 0 deletions specification/non-normative/revision-history.dita
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
Loading