Re: [dita] Preferred Index Terms

[Kristen James Eberlein <kris@eberleinconsulting.com>]

I think the "preferred entry" concept works for DocBook, but not DITA.

We need to always take reuse in different deliverables and team 
authoring into consideration.

Best,
Kris

Kristen James Eberlein
Chair, OASIS DITA Technical Committee
Principal consultant, Eberlein Consulting
www.eberleinconsulting.com
+1 919 622-1501; kriseberlein (skype)

On 8/13/2019 1:11 PM, Eliot Kimber wrote:
> That's a good question--either all the preferred entries would be highlighted or the system would issue some kind of warning.
>
> That might be why this was not considered for the original indexing design.
>
> Cheers,
>
> E.
>
> --
> Eliot Kimber
> http://contrext.com
>   
>
> ïOn 8/13/19, 11:25 AM, "Kristen James Eberlein" <dita@lists.oasis-open.org on behalf of kris@eberleinconsulting.com> wrote:
>
>      
>        
>          
>        
>        
>          How would you expect a processor to handle multiple instances of
>            "preferred" indexterm elements?
>          
>          Given reuse and team authoring, I'd think this scenario would be
>            inevitable.
>          
>          Best,
>            Kris
>            
>            Kristen James Eberlein
>            Chair, OASIS DITA Technical Committee
>            Principal consultant, Eberlein Consulting
>            www.eberleinconsulting.com <http://www.eberleinconsulting.com>
>            +1 919 622-1501; kriseberlein (skype)
>            
>          
>          On 8/13/2019 12:12 PM, Scott Hudson
>            wrote:
>          
>          
>            Option 2 could be a tall order for some companies. I think Option 1 has a lower barrier to entry.
>      
>      Thanks,
>      
>      --Scott
>      
>      ïOn 8/13/19, 10:10 AM, "dita@lists.oasis-open.org on behalf of Eliot Kimber" <mailto:dita@lists.oasis-open.orgonbehalfofEliotKimber> <dita@lists.oasis-open.org on behalf of ekimber@contrext.com> <mailto:dita@lists.oasis-open.orgonbehalfofekimber@contrext.com> wrote:
>      
>          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://urldefense.proofpoint.com/v2/url?u=https-3A__tdg.docbook.org_tdg_5.2_indexterm.singular.html&d=DwICaQ&c=P3aKjizb3qsxp0SERaL2sw&r=YQWdLfM9mekBOdoMmoBdn9RgyqIHrveGolBbb4_uGWQ&m=funuX7JZzWPj0ZrlF6lD84qqUTut2bhaS9OPCKwaLA4&s=MMy33hmVxReB9hxZj451pAEh4ufIv-FgbWTTOmq_DQE&e=
>          
>          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
>          https://urldefense.proofpoint.com/v2/url?u=http-3A__contrext.com&d=DwICaQ&c=P3aKjizb3qsxp0SERaL2sw&r=YQWdLfM9mekBOdoMmoBdn9RgyqIHrveGolBbb4_uGWQ&m=funuX7JZzWPj0ZrlF6lD84qqUTut2bhaS9OPCKwaLA4&s=UNU71uffVV18F8FqFuGN7P0zak83tZQUei3LZlBQV9w&e=
>           
>          
>          
>          
>          ---------------------------------------------------------------------
>          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://urldefense.proofpoint.com/v2/url?u=https-3A__www.oasis-2Dopen.org_apps_org_workgroup_portal_my-5Fworkgroups.php&d=DwICaQ&c=P3aKjizb3qsxp0SERaL2sw&r=YQWdLfM9mekBOdoMmoBdn9RgyqIHrveGolBbb4_uGWQ&m=funuX7JZzWPj0ZrlF6lD84qqUTut2bhaS9OPCKwaLA4&s=hhtmP7wyTw2zABE0UCKFAKqqMk-rJDHiiyUn2ORjwMs&e=
>          
>          
>      
>      
>          
>      
>        
>      
>      
>      ---------------------------------------------------------------------
>      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