This is the mail archive of the docbook@lists.oasis-open.org mailing list for the DocBook project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

RE: reasoning behind index terms


This, to me, seems akin to the decision-point that folks need to make w/rt the recursive sectioning schema and the enumerated one in docbook. I am a proponent of the former. The TOC structure is similar; however, there does not seem to be a recursive alternative there. In my project, we use something very similar to the docbook TOC, except that we've adopted our own custom recursive element called 'level' and have not implemented the enumerated scheme.

In the case of indexes, it seems to me that a more formal structure, such as the one that is currently implemented in docbook, is attractive. I know that the indexers here would certainly agree with that. Do you really want to go eight levels deep in an index? In addition, the use of unique elements allows for different content models, which might be needed given that indexers seem to think about each level somewhat differently. In short, I think that your co-workers are wrong. In the case of TOC and sections, recursive structures are the better way to go, IMHO.

The XSLT doesn't have to be any longer. Your template can match multiple elements, then calculate the level, or use a choose ...

Thanks,

Rich

-----Original Message-----
From: Matthew L. Avizinis [mailto:mla@gleim.com] 
Sent: Monday, August 05, 2002 7:37 AM
To: docbook@lists.oasis-open.org
Subject: DOCBOOK: reasoning behind index terms


Hello,
  What is the reasoning behind using all the index, indexdiv, primary, secondary, indexentry, etc. terms? (Is there a link to a webpage that already addresses this issue perhaps?)  A debate at my office has one side supporting the docbook terminology and the other stating that <index>
  <item>
     <item>
        <item>
           etc.
        </item>
     </item>
  </item>
</index>

would be simpler to use with XSLT, i.e. any code would be shorter and less repetitive.  I, for one, am in favor of the more descriptive approach used by docbook.  However, perhaps I do not able to state my reasons eloquently enough to convince them that it has more advantages than the above method. So, could someone describe a few reasons why DOCBOOK uses the terms it does for indexing and perhaps show some of the disadvantages of the above scheme. thanks for all help,
   Matthew L. Avizinis <mailto:mla@gleim.com>
Gleim Publications, Inc.
   4201 NW 95th Blvd.
 Gainesville, FL 32606
(352)-375-0772
      www.gleim.com <http://www.gleim.com>


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]