OASIS Darwin Information Typing Architecture (DITA) TC

 View Only

RE: [dita] some index-range-* issues

  • 1.  RE: [dita] some index-range-* issues

    Posted 08-09-2006 01:26
    We can avoid cross-topic ranges by having some guidelines that users
    shouldn't be creating orphaned range tags into their topics. Paul G's
    
    new markup proposal will create XML with enough information that
    implementors could warn users when they've got orphaned tags. Even
    though the DTD can't prevent the orphaned tags, XML editors could
    theoretically warn users about that scenario.
    
    
    In terms of what we want to support, it doesn't make much sense to
    modify DITA to accommodate a 'poor indexing practice' if the best
    practice is to simply show the start page. In terms of technology, it
    wouldn't be difficult to add some type of "range" attribute on an
    indexterm within topicmeta to indicate to some output process to include
    both the start/end pages but the real question is "should we"? JoAnn
    seems to be suggesting that we should try to encode best practices
    within our data model as opposed to being overly accommodating.
    
    - Yas Etessam
    
    
    ________________________________
    
    From: JoAnn Hackos [mailto:joann.hackos@comtech-serv.com] 
    Sent: Tuesday, August 08, 2006 2:47 PM
    To: Dana Spradley; Grosso, Paul
    Cc: dita@lists.oasis-open.org
    Subject: RE: [dita] some index-range-* issues
    
    
    
    Dana,
    
    You're echoing my thoughts, reflected in this earlier memo.
    
     
    
    Perhaps the additional confusion here is moving across topics. It would
    seem better to avoid cross-topic indexing ranges completely. Would that
    still be an option? 
    
     
    
    I think the current state of the proposals in both cases tries  to
    accommodate poor indexing practices that ignore the usability of an
    index for actual readers. The simplest method is to give the page number
    only for the first page of a longer item, letting the reader decide when
    he has had enough. Some indexers use ff (folios or numbers of pages)to
    indicate a longer discussion, beginning on a page, such as 356ff with
    the ff in italic. There is something problematic, it seems, to have page
    ranges that span topics, given our case for the standalone nature of a
    topic. 
    
     
    
    Anyway -- just a few thoughts on the philosophy behind the technical
    debate.
    
    JoAnn
    
     
    
     
    
    JoAnn T. Hackos, PhD
    President
    Comtech Services, Inc.
    710 Kipling Street, Suite 400
    Denver, CO 80215
    303-232-7586
    joann.hackos@comtech-serv.com