From e3f0b2e8f8aea3a4708a88e8f8631b02d64d76c9 Mon Sep 17 00:00:00 2001 From: Kristen James Eberlein Date: Tue, 17 Sep 2024 09:44:10 -0400 Subject: [PATCH] updates from indexing review Dave Alvin --- specification/archSpec/base/index-elements.dita | 17 +++++++++-------- .../archSpec/base/index-page-references.dita | 11 +++++++---- specification/archSpec/base/index-ranges.dita | 10 +++++++--- ...dita-2.0-key-definitions-cover-pages.ditamap | 4 ++-- .../non-normative/revision-history.dita | 14 ++++++++++++++ 5 files changed, 39 insertions(+), 17 deletions(-) diff --git a/specification/archSpec/base/index-elements.dita b/specification/archSpec/base/index-elements.dita index df811300..76443edf 100644 --- a/specification/archSpec/base/index-elements.dita +++ b/specification/archSpec/base/index-elements.dita @@ -29,8 +29,8 @@
indexterm
-
Defines a term or subject that - can contribute to an index. +
Defines a term that can + contribute to an index. Matching values of start and end attributes on indexterm elements can specify an @@ -38,15 +38,16 @@
index-see
-
Defines a term or subject to use as a - see reference. See references direct a reader to the - preferred term.
+
Defines a term + to use as a see reference. See references + direct a reader to the preferred term.
index-see-also
-
Defines a term or subject to use as a - see also reference. See also references direct a - reader to an alternate index entry for additional information.
+
Defines a term + to use as a see also reference. See also + references direct a reader to an alternate index entry for + additional information.

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 index 0d828741..e995d667 100644 --- a/specification/archSpec/base/index-page-references.dita +++ b/specification/archSpec/base/index-page-references.dita @@ -4,8 +4,7 @@ Index locators An indexterm element binds the content of the element, typically a - term or subject, to a specific location in a - document. + term, to a specific location in a document. @@ -26,9 +25,13 @@

  • An indexterm element that contains child indexterm elements contributes to the hierarchy of the multilevel index entry that is generated. Only - a leaf + a leaf indexterm element contributes a locator to - the generated index entry.
    • + the generated index entry. A leaf + indexterm element is an + indexterm element that does not + contain any other indexterm elements. +
  • If an indexterm element also contains one or more index-see elements, no locator is included in the generated index entry.
    • diff --git a/specification/archSpec/base/index-ranges.dita b/specification/archSpec/base/index-ranges.dita index 03089176..9762f589 100644 --- a/specification/archSpec/base/index-ranges.dita +++ b/specification/archSpec/base/index-ranges.dita @@ -8,7 +8,7 @@ indexterm elements to index an extended discussion. The generated index entry reflects the span - between the two indexterm elements . + between the two indexterm elements. @@ -32,9 +32,13 @@ End-of-range element should contain no content or nested elements.

    +

    The start-of-range and end-of-range elements + must be leaf indexterm 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.

    The location of the - indexterm elements determines how the span - is defined:

    + indexterm elements determines how the range is defined:

    Topic body
    diff --git a/specification/dita-2.0-key-definitions-cover-pages.ditamap b/specification/dita-2.0-key-definitions-cover-pages.ditamap index 88145bb7..9b8a3450 100644 --- a/specification/dita-2.0-key-definitions-cover-pages.ditamap +++ b/specification/dita-2.0-key-definitions-cover-pages.ditamap @@ -13,14 +13,14 @@ - Working Draft 37 + Working Draft 39 - 14 May 2024 + 29 August 2024 diff --git a/specification/non-normative/revision-history.dita b/specification/non-normative/revision-history.dita index bb84967e..2c00a92f 100644 --- a/specification/non-normative/revision-history.dita +++ b/specification/non-normative/revision-history.dita @@ -175,6 +175,20 @@ Kristen James Eberlein Generated working draft #37. Included updated content for "Specialization elements". + + + 17 + 26 August 2024 + Kristen James Eberlein + Generated working draft #38. Included draft of updated + indexing content. + + + 18 + 29 August 2024 + Kristen James Eberlein + Working draft #39. Includes completed indexing + content.