OASIS Darwin Information Typing Architecture (DITA) TC

RE: [dita] naming convention last call?

  • 1.  RE: [dita] naming convention last call?

    Posted 09-12-2005 14:24
     MHonArc v2.5.0b2 -->
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    

    dita message

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


    Subject: RE: [dita] naming convention last call?


    Do we (the DITA TC) plan to provide conversion
    tools to convert DITA 1.x content into DITA 2.x
    content?
     
    Even if we do, that still leaves a lot of user
    created stylesheets and programming that will
    need to be converted, so we need to consider
    very carefully what changing our names between
    1.x and 2.x will mean in terms of DITA 2.x adoption.
     
    paul


    From: Erik Hennum [mailto:ehennum@us.ibm.com]
    Sent: Saturday, 2005 September 10 9:55
    To: dita@lists.oasis-open.org
    Subject: [dita] naming convention last call?

    Esteemed DITA TC:

    We need to close on the naming issue and move on.

    I'd propose:

    • In the DITA 1.1 timeframe, because DITA 1.0 has no mixed case names, the naming convention for new names is to separate the words of a compound with a hyphen (as with "related-links"). Thus, the <data> element will have an "about-type" attribute. This convention is not applied to existing DITA 1.0 names.
    • In the DITA 2.0 timeframe, the expected naming convention for compounds is to follow TEI and use camelCase (lower case initial). (Upper case initial seems more suited to data formats because the markup isn't part of a discourse flow but rather a structure delimiter.) This convention is applied to both existing and future compound names (including "choiceTable" and "relatedLinks").

    Creators of new specializations modules may want to adopt the camelCase naming convention now so as to have consistency with the expected long-term DITA naming convention.


    Does that work?


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