OASIS Darwin Information Typing Architecture (DITA) TC

RE: [dita] related-links content model

  • 1.  RE: [dita] related-links content model

    Posted 09-29-2005 20:48
     MHonArc v2.5.0b2 -->
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    

    dita message

    [Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]


    Subject: RE: [dita] related-links content model


    Hi,
    
    This has become a problem for a couple of groups working on different
    specializations. One user needs the following links:
    * one optional link to setup information for the topic
    * one optional link to a zip that contains materials related to the topic
    * one optional link to in-depth information about this topic
    * one optional link to a PDF version of the topic
    * any number of links to bio topics about the authors
    * any number of generic links
    
    Ideally, the content model would look something like this:
    (setupLink?, downloadMaterials?, inDepthInfo?, pdfVersion?, authorInfo*,
    link*)
    
    As explained previously, this is not allowed, because nothing is required.
    The only way to get around this without making one required is to
    specialize a linkpool, and make that required - something like this:
    <newLinks><newLinkPool> ...optional links, in order...
    </newLinkPool></newLinks>
    
    Instead of having the overhead of 2 link groups, this user chose not to
    enforce an order, and allow any number of links:
    (setupLink | downloadMaterials | inDepthInfo | pdfVersion | authorInfo |
    link)+
    
    This does not really meet her needs, because most of the links should be
    limited to one instance.
    
    The other user wants to have a related links element to include
    contact/support information. He set up the model like this:
    (email*, emailcc*, url*)
    
    This one is easier to fix, just by removing the order requirement, but it
    does mean the user does not get exactly what he wants.
    
    Aside from the actual use cases - I can vouch for the fact that it is
    difficult to explain to users why their new templates must have either one
    required link, or a seemingly useless element...
    
    Thanks,
    
    Robert D Anderson
    IBM Authoring Tools Development
    Chief Architect, DITA Open Toolkit
    
    
                                                                               
                 "JoAnn Hackos"                                                
                 <joann.hackos@com                                             
                 tech-serv.com>                                             To 
                                           Robert D                            
                 09/29/2005 02:32          Anderson/Rochester/IBM@IBMUS,       
                 PM                        <dita@lists.oasis-open.org>         
                                                                            cc 
                                                                               
                                                                       Subject 
                                           RE: [dita] related-links content    
                                           model                               
                                                                               
                                                                               
                                                                               
                                                                               
                                                                               
                                                                               
    
    
    
    
    Hi,
    Can you provide a use case of the related link problem? Why would I be
    using a set of links like this? What is a description of a practical
    situation?
    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