Re: [dita] A richer indexterm

[Christopher Wong <cwong@idiominc.com>]

Thanks, Indi. I just noticed that this is issue #45 on the DITA 1.1 requirements list, so we should certainly consider Nokia's implementation for 1.1.

Chris

indi.liepa@nokia.com wrote:

Hi, 
 
I agree with this request.
 
In Nokia we have specialised <indexterm> to support primary, secondary
and tertiary index term levels and see and see also entries.
 
<index_entry>
  <primary></primary><secondary></secondary><tertiary></tertiary>
 
<see><primary></primary><secondary></secondary><tertiary></tertiary></see>
 
<see_also><primary></primary><secondary></secondary><tertiary></tertiary></see_also>
  

</index_entry>
 
Attached is content model specification we have implemented. It would be
great to have this sort of support in OASIS DITA.
 
Regards
 
Indi
 
Indi Liepa 
Senior Information Architect 
Content Solutions 
Nokia/TP 
Southwood UK 
Tel mobile: +447795114893 
Tel office: +441252866256 


 
-----Original Message-----
From: ext JoAnn Hackos [mailto:joann.hackos@comtech-serv.com]
Sent: Monday, May 16, 2005 11:54 PM
To: Christopher Wong; dita@lists.oasis-open.org
Subject: RE: [dita] A richer indexterm


I definitely would like a richer accommodation for index terms. We use
"see" and "see also" items and often use three levels of index terms.
IBM used to have a very fine internal document on indexing which DITA
ought to support. 
 
JoAnn

  _____  

From: Christopher Wong [mailto:cwong@idiominc.com] 
Sent: Monday, May 16, 2005 4:28 PM
To: dita@lists.oasis-open.org
Subject: [dita] A richer indexterm


Do DITA adopters see a need for richer indexterm content? It only allows
plain text at the moment. But typical book indexes are littered with
"see XXX" and "see also XYZ" entries that should be treated specially. I
pulled up an IBM manual online ("IBM WebSphere V4.0 Advanced Edition
Handbook", by IBM, March 13, 2002) on Safari, and its index page has
plenty of HTML-ized index entries, such as:



Packaging [See Application packaging]
Password encoding 2nd
Performance 2nd [See also Workload management]
PKI [See Public-key infrastructure]
Plug-in [See Web server plug-in]
plugin-cfg.xml 2nd
     Default location
POP3 [See Post Office Protocol]
Post Office Protocol
Problem determination [See Troubleshooting]
Public-key infrastructure
PVCS


How do real-world adopters do this? Thanks.

Chris





  

<?xml version="1.0" encoding="utf-8"?>
<!--ArborText, Inc., 1988-2002, v.4002-->
<!DOCTYPE reference PUBLIC "-//IBM//DTD DITA Reference//EN"
 "reference.dtd">
<?Pub Inc?>
<reference id="GUIDD4C2B811DB3511D88910000BDB6BA40A">
<title>index_entry</title>
<refbody>
<section><title>Purpose</title><p>Defines a single entry in an index.</p></section>
<section><title>Justification</title><p>Nokia requires support for <q>See</q> and <q>See
also</q> structures.<?Pub Caret?></p><p>It must also be possible to define
primary, secondary and tertiary level index entries.</p></section>
<section><title>Contains</title><ul>
<li><p><keyword>primary</keyword>(optional, one only) then</p></li>
<li><p><keyword>secondary</keyword>(optional, one only) then</p></li>
<li><p><keyword>tertiary</keyword>(optional, one only) followed by</p></li>
<li><p><keyword>see</keyword>(optional, one or more) then</p></li>
<li><p><keyword>see also</keyword>(optional, one or more)</p></li>
</ul></section>
<section><title>Specialisation</title><p>Specialised from DITA <keyword>indexterm</keyword>.</p></section>
</refbody>
</reference>
<?Pub *0000001129?>