OASIS Darwin Information Typing Architecture (DITA) TC

 View Only
Expand all | Collapse all

DITA 1.2 Review Comment: Thoughts on topicgroup, navtitle, and locktitle

Eliot Kimber

Eliot Kimber08-24-2010 17:37

Christopher Nitchie

Christopher Nitchie08-24-2010 19:06

Christopher Nitchie

Christopher Nitchie08-24-2010 20:11

Eliot Kimber

Eliot Kimber08-24-2010 20:51

Eliot Kimber

Eliot Kimber08-25-2010 13:07

  • 1.  DITA 1.2 Review Comment: Thoughts on topicgroup, navtitle, and locktitle

    Posted 08-12-2010 21:04
      In '3.1.2.2.4 topicgroup', a paragraph states that "Beginning with 
    DITA 1.2, you are able to specify a 


  • 2.  RE: [dita] DITA 1.2 Review Comment: Thoughts on topicgroup, navtitle, and locktitle

    Posted 08-24-2010 15:44
    For the confusion, here's a proposed clarification:
    
    In DITA 1.2, the 


  • 3.  Re: [dita] DITA 1.2 Review Comment: Thoughts on topicgroup,navtitle, and locktitle

    Posted 08-24-2010 17:13
    On 8/24/10 10:43 AM, "Bruce Nevin (bnevin)" 


  • 4.  Re: [dita] DITA 1.2 Review Comment: Thoughts on topicgroup,navtitle, and locktitle

    Posted 08-24-2010 17:37
    The real answer would be to specialize 


  • 5.  Re: [dita] DITA 1.2 Review Comment: Thoughts on topicgroup, navtitle, andlocktitle

    Posted 08-24-2010 18:04
    First - you're certainly right that this is "unavoidable" rather than
    "unintended". The issue was known when we added 


  • 6.  RE: [dita] DITA 1.2 Review Comment: Thoughts on topicgroup, navtitle, and locktitle

    Posted 08-24-2010 19:06
    Normally I'd agree that if 


  • 7.  Re: [dita] DITA 1.2 Review Comment: Thoughts on topicgroup,navtitle, and locktitle

    Posted 08-24-2010 19:59
    It is not true that its semantic of not contributing to navigation is
    inherent in its type.
    
    It's inherent in having neither a navigation title nor an associated
    resource.
    
    That is, a 


  • 8.  RE: [dita] DITA 1.2 Review Comment: Thoughts on topicgroup, navtitle, and locktitle

    Posted 08-24-2010 20:11
    > That is, a 


  • 9.  Re: [dita] DITA 1.2 Review Comment: Thoughts on topicgroup, navtitle, andlocktitle

    Posted 08-24-2010 20:16
    > That is, I cannot unilaterally specialize from map/topicref and declare,
    in
    > my vocabulary documentation, that any navtitle for my specialization be
    > ignored.
    
    Why not? You should be perfectly within your rights to have your own
    vocabulary, with your own documentation, where your own documentation
    states something like "In this specialization of X, I'll process
    differently than my ancestor in this specific way." Any processor claiming
    support specifically for your vocabulary specialization must follow that
    rule; any other conforming DITA processor will (must) use the default
    fallback behavior.
    
    > All general-purpose DITA processors will be well within their
    > rights to treat an instance of my specialization that happens to have a
    > 


  • 10.  Re: [dita] DITA 1.2 Review Comment: Thoughts on topicgroup,navtitle, and locktitle

    Posted 08-24-2010 20:51
    On 8/24/10 3:15 PM, "Robert D Anderson" 


  • 11.  Re: [dita] DITA 1.2 Review Comment: Thoughts on topicgroup, navtitle,and locktitle

    Posted 08-25-2010 12:03
    
      
        
      
      
        Thanks for this detailed discussion.

    Let's avoid unnecessary complications. The topicgroup element is there to provide a way of grouping topicrefs without causing changes to navigation, or output of titles or anything else.

    I think a topicgroup gets its semantic of groupness from:

    1. its name
    2. its intent
    3. the syntax of being parent to a group of child elements.

    A topicref that contains other elements also has the semantic of groupness. The distinguishing feature of topicgroup is not that it has the semantic of groupness, but that the only semantic it has is groupness.

    To give a topicgroup a navtitle is to contradict its reason for existence. That is why it has no navtitle attribute.

    So, to keep things simple, for ordinary mortals, I propose:

    1. The topicgroup element should not be given a navtitle grandchild, even though permitted by the DTD. If you want to have a navtitle grandchild then you should use a topicref element (or a specialisation of topicref, or some other specialization).

    2. There is no obligation for a processor to process a navtitle grandchild of a topicgroup element in any particular way. It might be preferable to not output anything so that the user might investigate the absence of expected output and then refer to the documentation and thence correct the error of their ways. However, for reasons of speed or simplicity or any other reason, the processor has no obligation to suppress the output.

    There is nothing in the design of a car that prevents me from signalling right but driving straight on, even though it could have fatal consequences. We cannot prevent coders from producing self-contradictory code and don't have an obligation to resolve all ambiguities.

    Regards,
    
    Doug Morrison
    Information Architect
    http://dita4all.com
    

    On 24/08/2010 21:50, Eliot Kimber wrote:
    25ekimber@reallysi.com" type="cite">
    On 8/24/10 3:15 PM, "Robert D Anderson" <robander@us.ibm.com> wrote:
    
    
    That is, I cannot unilaterally specialize from map/topicref and declare,
    
    in
    
    my vocabulary documentation, that any navtitle for my specialization be
    ignored.
    
    Why not? You should be perfectly within your rights to have your own
    vocabulary, with your own documentation, where your own documentation
    states something like "In this specialization of X, I'll process
    differently than my ancestor in this specific way." Any processor claiming
    support specifically for your vocabulary specialization must follow that
    rule; any other conforming DITA processor will (must) use the default
    fallback behavior.
    
    The difference is that if the DITA spec says it it's a normative requirement
    of all conforming processors that support the mapgroup domain to treat
    topicgroup specially, so they have to do it.
    
    Putting anything in my personal vocabulary that overrides the default
    behavior required by the DITA spec is going to go nowhere and I would never
    depend on it because it would be negating the very value of specialization,
    namely stuff happens automatically because of the built-in defaults.
    
    It's one thing to define *additional* semantics for specializations--that's
    expected. It's quite another to define *variant* semantics for
    specializations--that seems both wrong and ill advised.
    
    So again I say, if groupness is something a topicref either does or doesn't
    have, we need a way to say that independently.
    
    I can certainly see that being able to have titled groups would be
    handy--that's pretty typical of how I do markup design, so I think it would
    be useful to be able to have groups with titles that still do not contribute
    to navigation and do not impose their non-navigation behavior onto their
    descendants.
    
    On the other hand, I don't think it would be the end of the world to have to
    specialize from mapgroup just to get groupness if we did decide to make
    topicgroup a special case, so I won't go to the mat if everyone else thinks
    that's ok. It just bothers me to have a special case like this.
    
    That is, if I want to design specialized topicrefs that act as groups and
    that may also have titles, having to specialize from mapgroup would be OK
    since it doesn't impose any inappropriate constraints, even though it would
    otherwise be unnecessary.
    
    Cheers,
    
    Eliot
    
    


  • 12.  Re: [dita] DITA 1.2 Review Comment: Thoughts on topicgroup,navtitle, and locktitle

    Posted 08-25-2010 13:07
    On 8/25/10 7:02 AM, "Doug Morrison" 


  • 13.  RE: [dita] DITA 1.2 Review Comment: Thoughts on topicgroup, navtitle, and locktitle

    Posted 08-25-2010 14:15
    None of us likes being backed into an icky corner of inconsistency;
    abstracting that layer of complaint about the 'unavoidable consequences'
    of adding 


  • 14.  Re: [dita] DITA 1.2 Review Comment: Thoughts on topicgroup,navtitle, and locktitle

    Posted 08-25-2010 15:22
    I'm saying that in DITA 1.1 topicgroup gets its groupness from having
    neither a navtitle nor a bound resource. Because in DITA 1.1 the
    mapgroup-d/topicgroup element could never have either @navtitle or @href, it
    was impossible for it to have a navigation title. This meant that there was
    no need for topicgroup to be processed specially since *simply be dint of
    having no title and no bound resource* it *could not* contribute to
    navigation (there is nothing to navigate to).
    
    Thus in DITA 1.1 the "groupness" of topicgroup is inherent its allowed
    syntactic construction.
    
    In DITA 1.2, because we introduced 


  • 15.  Re: [dita] DITA 1.2 Review Comment: Thoughts on topicgroup, navtitle,and locktitle

    Posted 08-25-2010 16:20
      My thinking was "a topicgroup needs a navtitle just like a fish needs 
    a bicycle" so let's not force processors to do any unnecessary 
    processing - just do what is easiest. However, there are strong 
    arguments for consistency (as exemplified by the "Copy Exact" strategy 
    of Intel).
    
    I also thought that Eliot's view of the origin of 'groupness', however 
    technically correct, was inconsistent with what common mortals like 
    myself think. However, this really doesn't matter, as users should not 
    not provide a navtitle as a grandchild of topicgroup in the first place.
    
    So, my revised view is:
    
    1. The topicgroup element should not be given a navtitle grandchild, 
    even though permitted by the DTD. If you want to have a navtitle 
    grandchild then you should use a topichead or topicref element (or 
    specialisations thereof).
    2. If, in spite of the advice to the contrary, a topicgroup element has 
    a navtitle grandchild, it must be processed as though it were a topichead.
    
    The behaviour may strike some as odd, but there is sound logic behind it 
    (as given by Eliot). Moreover, I don't see that anyone has any good 
    grounds for complaint: if you want a navtitle to be used for navigation, 
    use topichead or topicref (or specializations thereof), if you don't 
    want a navtitle to be used for navigation don't provide one (or don't 
    set locktitle="yes"). If you design processors then it should work as 
    defined above without creating any special privileged case for 
    topicgroup. Everyone happy?
    
    Regards,
    
    Doug Morrison
    Information Architect
    http://dita4all.com
    
    
    On 25/08/2010 16:20, Eliot Kimber wrote:
    > I'm saying that in DITA 1.1 topicgroup gets its groupness from having
    > neither a navtitle nor a bound resource. Because in DITA 1.1 the
    > mapgroup-d/topicgroup element could never have either @navtitle or @href, it
    > was impossible for it to have a navigation title. This meant that there was
    > no need for topicgroup to be processed specially since *simply be dint of
    > having no title and no bound resource* it *could not* contribute to
    > navigation (there is nothing to navigate to).
    >
    > Thus in DITA 1.1 the "groupness" of topicgroup is inherent its allowed
    > syntactic construction.
    >
    > In DITA 1.2, because we introduced


  • 16.  RE: [dita] DITA 1.2 Review Comment: Thoughts on topicgroup, navtitle, and locktitle

    Posted 08-25-2010 17:28
    >  Everyone happy?
    
    Everyone except the implementors that are just about at code
    freeze for the current release and won't have time to change
    their implementations for another 12 months--and all their
    users and anyone their users interchange DITA with for the
    next couple years.
    
    paul
    
    > 


  • 17.  Re: [dita] DITA 1.2 Review Comment: Thoughts on topicgroup,navtitle, and locktitle

    Posted 08-25-2010 17:30
    On 8/25/10 12:27 PM, "Grosso, Paul" 


  • 18.  RE: [dita] DITA 1.2 Review Comment: Thoughts on topicgroup, navtitle, and locktitle

    Posted 08-25-2010 17:35
    We treat topicgroup as a special case which never contributes to the
    hierarchy, regardless of the presence of 


  • 19.  Re: [dita] DITA 1.2 Review Comment: Thoughts on topicgroup,navtitle, and locktitle

    Posted 08-25-2010 17:40
    On 8/25/10 12:34 PM, "Nitchie, Chris" 


  • 20.  Re: [dita] DITA 1.2 Review Comment: Thoughts on topicgroup,navtitle, and locktitle

    Posted 08-25-2010 17:38
    Here is a simple test map:
    
    
      
    
    
    In OxygenXML 11.2, it's map manager does not show the navigation title of
    the topicgroup.
    
    The Open Toolkit's HTML generation does show the navigation title (treats it
    as a topichead).
    
    I know any code I've written would treat it as a topic head.
    
    Cheers,
    
    E.
    
    On 8/25/10 12:29 PM, "Eliot Kimber" 


  • 21.  RE: [dita] DITA 1.2 Review Comment: Thoughts on topicgroup, navtitle, and locktitle

    Posted 08-25-2010 17:34
     
    
    > 


  • 22.  RE: [dita] DITA 1.2 Review Comment: Thoughts on topicgroup, navtitle, and locktitle

    Posted 08-26-2010 22:44
    FWIW Doug's last post makes sense to me. If a writer does put a
    


  • 23.  RE: [dita] DITA 1.2 Review Comment: Thoughts on topicgroup, navtitle, and locktitle

    Posted 08-27-2010 15:10
    In 3.1.1.1.5 Navtitle, we say:
    
    "Because the navtitle element is available within topicmeta, and
    topicmeta is used in many different contexts, it is possible that
    navtitle can be specified in contexts where a navigation title does not
    make sense (for example, on the topicgroup element). In those
    situations, the navtitle element has no defined purpose."
    
    I suppose we could say something like:
    
    "... Although the navtitle element has no defined purpose in those
    situations, processors may nonetheless display a title."
    
    	/B
    
    
    > 


  • 24.  Re: [dita] DITA 1.2 Review Comment: Thoughts on topicgroup,navtitle, and locktitle

    Posted 08-27-2010 15:20
    The question is not whether or not the title can be "displayed" but whether
    or not the topicref contributes to navigation when it has a title.
    
    "display" is way too inspecific--what context? A map viewer in an editor?
    Rendered output? A report of all the topicrefs in a map?
    
    By focusing on navigation/not navigation we avoid any need to discuss the
    rendition implications.
    
    For example, in a map viewer I might choose to display a topicgroup's
    navigation title even though it doesn't contribute to navigation simply
    because, since the author put it there, they presumably want to see it.
    
    Cheers,
    
    E.
    
    On 8/27/10 10:09 AM, "Bruce Nevin (bnevin)" 


  • 25.  RE: [dita] DITA 1.2 Review Comment: Thoughts on topicgroup, navtitle, and locktitle

    Posted 08-27-2010 23:12
    I understand the term "display" but I don't understand the term
    "contributes to navigation." Could someone explain the latter concept
    some other way please?
    
    I also don't understand the term "groupness." 
    
    In any case (this might have been said amongst the things that I don't
    understand), there are at least five possible ways to process the
    following markup:
    
    


  • 26.  Re: [dita] DITA 1.2 Review Comment: Thoughts on topicgroup, navtitle,and locktitle

    Posted 08-27-2010 23:32

    On 8/27/2010 6:07 PM, Su-Laine Yeo wrote:
    BECDDDED92C3B949A38F5BC4BF56D21F03EFDA80@van-mail.jena.local" type="cite">
    In any case (this might have been said amongst the things that I don't
    understand), there are at least five possible ways to process the
    following markup:
    
    <topicref href="Topic_A.xml">
    <topicgroup><topicmeta><navtitle>Group B</navtitle></topicmeta>
    	<topicref href="Topic_B1.xml"/>
    	<topicref href="Topic_B2.xml"/>
    	<topicref href="Topic_B3.xml"/>
    </topicgroup>
    

    To this example, I would add a classic possible specialization, which for me puts some context on what the base behavior should be:

    <preface href="Topic_A.xml">
    <body><topicmeta><navtitle>Group B</navtitle></topicmeta>
    	<chapter href="Topic_B1.xml"/>
    	<chapter href="Topic_B2.xml"/>
    	<chapter href="Topic_B3.xml"/>
    </body>
    
    Here, I expect that the topicmeta/navtitle (however it got there) is meaningless in terms of the application, that groupness gave my processor a handle for logical processing of prefixes and page numbers for topics in its context, and that my results (in a ToC view) would be:

    Preface ... page iv
    Chapter 1. asdf ... page 1
    Chapter 2. asdf ... page 7
    Chapter 3. asdf ... page 13

    Looks like case 2 to me. So in terms of application instances, when would case 1 or the others ever make sense?
    --
    "Where is the wisdom we have lost in knowledge?
    Where is the knowledge we have lost in information?"
    --T.S. Eliot