OASIS Mailing List ArchivesView the OASIS mailing list archive below
or browse/search using MarkMail.


Help: OASIS Mailing Lists Help | MarkMail Help

dita message

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]

Subject: Re: Preferred Index Terms

 can see two ways it could be done:

1. Add an attribute like @significance to <indexterm>, basically exactly what DocBook does.
2. Specialize <indexterm> to <indexterm-preferred>.

Perhaps 3. create a list of preferred terms to be referenced during processing.

Especially once translated versions come into this, maintaining a "preferred" markup in the content gets fussy and awkward. External lists -- these are the English prefered terms, these are the Simplified Chinese, Traditional Chinese, Finnish, etc. -- give a single thing that can be maintained in one place by the language-knowledgeable and the processing can use that during index creation to know which locator gets special rendering.

Graydon Saunders | Publishing Solutions Developer | Precision Content 
Direct: +1
 (647)265-8500 x106Email: graydon@precisioncontent.com | www.precisioncontent.com



Unlock the Knowledge in Your Enterprise™

This email and any files transmitted with it are confidential and intended solely for the use of the individual or entity to whom they are addressed. If you are not the intended recipient you are notified that disclosing, copying, distributing or taking any action in reliance on the contents of this information is strictly prohibited. Please notify us by return email if you have received this email in error. ©2019, Precision Content Authoring Solutions Inc, Mississauga, Ontario, Canada

From: dita@lists.oasis-open.org <dita@lists.oasis-open.org> on behalf of Eliot Kimber <ekimber@contrext.com>
Sent: 13 August 2019 12:09
To: ligh >> dita-lightweight-dita@lists.oasis-open.org <dita@lists.oasis-open.org>
Subject: [dita] Preferred Index Terms
An indexing requirement that DITA does not currently satisfy out of the box is identify an instance of an index term as being the "preferred" instance. Preferred instances are usually rendered by highlighting the page number (or other locator) for that entry.

DocBook provides for this with the @significance attribute of the <indexterm> element:


Where the @significance attribute has the value "normal" or "preferred":

<indexterm significance="preferred"><primary>apple</primary></indexterm>

It seems reasonable to add this mechanism to DITA.

I can see two ways it could be done:

1. Add an attribute like @significance to <indexterm>, basically exactly what DocBook does.
2. Specialize <indexterm> to <indexterm-preferred>.

Option 2 could of course be done by anyone who wants to define the specialization, and maybe that's the answer: if you have this requirement, implement the specialization and the processing for it.

But I wanted to at least record the requirement for discussion.


Eliot Kimber

To unsubscribe from this mail list, you must leave the OASIS TC that
generates this mail.  Follow this link to all your TCs in OASIS at:

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]