OASIS Darwin Information Typing Architecture (DITA) TC

View Only

Back to discussions

Expand all | Collapse all

Re: [dita] Navtitle and locktitle

1. Re: [dita] Navtitle and locktitle

Recommend

Robert Anderson

Posted 02-23-2006 20:08

MHonArc v2.5.0b2 -->

dita message

Subject: Re: [dita] Navtitle and locktitle

From: Robert D Anderson <robander@us.ibm.com>
To: "Paul Prescod" <paul.prescod@blastradius.com>
Date: Thu, 23 Feb 2006 14:09:22 -0600

Hi Paul -- yes, that has also been my understanding. For our users in IBM,
we've created an editor macro that goes through to refresh all of the
navtitles in a map, though we do not do it automatically. As with your
description, the macro does not update navtitles for anything that sets or
inherits locktitle="yes".

Robert D Anderson
IBM Authoring Tools Development
Chief Architect, DITA Open Toolkit


                                                                           
             Erik                                                          
             Hennum/Oakland/IB                                             
             M@IBMUS                                                    To 
                                       "Paul Prescod"                      
             02/23/2006 01:53          <paul.prescod@blastradius.com>      
             PM                                                         cc 
                                       dita@lists.oasis-open.org           
                                                                   Subject 
                                       Re: [dita] Navtitle and locktitle   
                                                                           
                                                                           
                                                                           
                                                                           
                                                                           
                                                                           




Hi, Paul:

Yes, that's my understanding of the dual role of navtitle - to cache the
topic title inline so the map provides an intelligible outline and (as an
extra option) permit overriding the topic title to provide a contextual
title in a navigation.


Erik Hennum
ehennum@us.ibm.com


(Embedded image moved to file: pic28884.gif)Inactive hide details for "Paul
Prescod" <paul.prescod@blastradius.com>"Paul Prescod"
<paul.prescod@blastradius.com>

                                                                           
                         "Paul Prescod"                                    
                         <paul.prescod@b                                   
                         lastradius.com>                                   
                                         (Embedded image moved to file:    
                                         pic08693.gif)                     
                         02/23/2006                                     To 
                         11:38 AM                       (Embedded image    
                                                        moved to file:     
                                                        pic13428.gif)      
                                                        <dita@lists.oasis- 
                                                        open.org>          
                                         (Embedded image moved to file:    
                                         pic29848.gif)                     
                                                                        cc 
                                                        (Embedded image    
                                                        moved to file:     
                                                        pic15881.gif)      
                                         (Embedded image moved to file:    
                                         pic23255.gif)                     
                                                                   Subject 
                                                        (Embedded image    
                                                        moved to file:     
                                                        pic28605.gif)      
                                                        [dita] Navtitle    
                                                        and locktitle      
                                                                           
                                                                           
                                         (Embedded image moved to file:    
                                         pic04458.gif)                     
                                                (Embedded image moved to   
                                                file: pic32148.gif)        
                                                                           
                                                                           



It's a bit subtle, but I read the DITA spec as saying that the navtitle
attribute is totally meaningless (ignored) from a publishing point of
view unless the locktitle attribute is set. As a performance
enhancement, I would like XMetaL DITA Edition to "cache" the navtitle
from titles in documents similar to the way it caches the content of
conrefed content. This allows us to load a document without downloading
every referenced document from the CMS to look at its title.

This means that if we load a document with "navtitle='foo'" and
"locktitle='no'" then we will feel free to overwrite the navtitle based
on the content of the referenced document. Alternately, if the locktitle
= 'yes' then we will presume that the navtitle is real and important and
therefore leave it alone.

Does this seem correct to DITA's designers? The alternative is to cache
the title in a processing instruction which will just introduce extra
junk into the DITA document.

Paul Prescod