You're correct, I did misunderstand the intent.
If we mean "read this index entry first, out of the numerous references available" that would seem to be more naturally <indexterm-preferred> than an attribute.
It does raise various "can we have more than one for a single base text?" and "what happens if the preferred term moves during translation?" questions.
Graydon Saunders | Publishing Solutions Developer | Precision
Content
Direct: +1 (647)265-8500
x106| Email: 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: 14 August 2019 11:01
To: ligh >> dita-lightweight-dita@lists.oasis-open.org <dita@lists.oasis-open.org>
Subject: [dita] Re: Preferred Index Terms
Sent: 14 August 2019 11:01
To: ligh >> dita-lightweight-dita@lists.oasis-open.org <dita@lists.oasis-open.org>
Subject: [dita] Re: Preferred Index Terms
I think you've misunderstood the meaning of "preferred" in this context--it refers to the particular *instance* of the term as indexed relative to other places the term is indexed, as opposed to the notion of a "preferred term" relative
to other terms with similar meanings.
Cheers,
E.
--
Eliot Kimber
http://contrext.com
ïOn 8/14/19, 8:47 AM, "Graydon Saunders" <graydon@precisioncontent.com> wrote:
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
x106| Email: graydon@precisioncontent.com | www.precisioncontent.com <https://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:
https://tdg.docbook.org/tdg/5.2/indexterm.singular.html
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.
Cheers,
E.
--
Eliot Kimber
http://contrext.com
---------------------------------------------------------------------
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:
https://www.oasis-open.org/apps/org/workgroup/portal/my_workgroups.php
---------------------------------------------------------------------
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:
https://www.oasis-open.org/apps/org/workgroup/portal/my_workgroups.php
Cheers,
E.
--
Eliot Kimber
http://contrext.com
ïOn 8/14/19, 8:47 AM, "Graydon Saunders" <graydon@precisioncontent.com> wrote:
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
x106| Email: graydon@precisioncontent.com | www.precisioncontent.com <https://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:
https://tdg.docbook.org/tdg/5.2/indexterm.singular.html
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.
Cheers,
E.
--
Eliot Kimber
http://contrext.com
---------------------------------------------------------------------
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:
https://www.oasis-open.org/apps/org/workgroup/portal/my_workgroups.php
---------------------------------------------------------------------
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:
https://www.oasis-open.org/apps/org/workgroup/portal/my_workgroups.php