OASIS Darwin Information Typing Architecture (DITA) TC

 View Only
  • 1.  proposed packaging and doctype shells for DITA 1.2

    Posted 08-15-2008 15:53

    Assumptions:
    - need to keep the legacy shells from 1.1 to avoid breaking existing users
    - beyond legacy shells, adding only the bare minimum to exercise each new domain and structural type
    - users will go to the web tool for most combinations (such as tech content with learning objectives, or tech content without the sw domain)

    Base (2 shells):
            topic and map plus utility domains
    Tech content (11 shells):
            topic, concept, task, general task, task with requirements domain, reference, glossary, ditabase (all incorp. hazard, utility, sw, pr, ui domains);
            bookmap, 2 classification maps
    Learning and training (7 shells):

            5 l&t topic types, topic with l&t domain, map with l&t domain


    Michael Priestley
    Lead IBM DITA Architect
    mpriestl@ca.ibm.com
    http://dita.xml.org/blog/25


  • 2.  RE: [dita] proposed packaging and doctype shells for DITA 1.2

    Posted 08-15-2008 19:29
    
    
    
    
    
    
    
    
    
    
    

    All of the map doctype shells include the map-group domain, right?

     

    Just checking: There are no doctype shells specific to the Machine Industry, Software and Programming, or Classification, Controlled Values, and Taxonomies work or to the extent that there are they are included in the Technical Content collection, right?

     

    Just checking: Grouping the doctype shells into three collections (base, tech content, learning and training) doesn’t imply any changes to the organization of the DITA 1.2 specification documents or does it?

     

    The current organization of the DITA 1.2 specification documents is:

     

    • DITA 1.2 Specification Overview
    • DITA 1.2 Base Architectural Specification
    • DITA 1.2 Base Language Reference
    • DITA 1.2 Utility Domain Specializations Architecture and Language Reference
    • DITA 1.2 Technical Content Architecture and Language Reference
    • DITA 1.2 Software and Programming Content Architecture and Language Reference
    • DITA 1.2 Learning and Training Content Architecture and Language Reference
    • DITA 1.2 Machine Industry Content Architecture and Language Reference
    • DITA 1.2 Classification, Controlled Values, and Taxonomies Architecture and Language Reference

     


    From: Michael Priestley [mailto:mpriestl@ca.ibm.com]
    Sent: Friday, August 15, 2008 11:53 AM
    To: dita@lists.oasis-open.org
    Subject: [dita] proposed packaging and doctype shells for DITA 1.2

     


    Assumptions:
    - need to keep the legacy shells from 1.1 to avoid breaking existing users
    - beyond legacy shells, adding only the bare minimum to exercise each new domain and structural type
    - users will go to the web tool for most combinations (such as tech content with learning objectives, or tech content without the sw domain)

    Base (2 shells):
            topic and map plus utility domains
    Tech content (11 shells):
            topic, concept, task, general task, task with requirements domain, reference, glossary, ditabase (all incorp. hazard, utility, sw, pr, ui domains);
            bookmap, 2 classification maps
    Learning and training (7 shells):

            5 l&t topic types, topic with l&t domain, map with l&t domain


    Michael Priestley
    Lead IBM DITA Architect
    mpriestl@ca.ibm.com
    http://dita.xml.org/blog/25



  • 3.  RE: [dita] proposed packaging and doctype shells for DITA 1.2

    Posted 08-19-2008 16:02
    
    
    
    
    
    
    
    
    
    
    

    Here is an update to Michael’s proposal with clarifications from today’s TC call:

     

    Base Collection:

    • Base Topic
    • Base Map (map plus Utilities and Map Group domains)

     

    Technical Content Collection (all topics include hazard, utility, sw, pr, and ui domains):

    • Topic
    • Concept
    • Task
    • General Task
    • Task with requirements domain
    • Reference
    • Glossary
    • Ditabase
    • Map
    • Bookmap
    • Classification map #1
    • Classification map #2

     

    Learning and Training Content Collection:

    • Learning Assessment
    • Learning Content
    • Learning Overview
    • Learning Plan
    • Learning Summary
    • Learning Topic (Topic plus the Learning and Training domains added)
    • Learning Map (Base Map plus the Learning and Training domains added)
    • Learning Bookmap (Bookmap with the Learning and Training domains added)

     


    From: Michael Priestley [mailto:mpriestl@ca.ibm.com]
    Sent: Friday, August 15, 2008 11:53 AM
    To: dita@lists.oasis-open.org
    Subject: [dita] proposed packaging and doctype shells for DITA 1.2

     


    Assumptions:
    - need to keep the legacy shells from 1.1 to avoid breaking existing users
    - beyond legacy shells, adding only the bare minimum to exercise each new domain and structural type
    - users will go to the web tool for most combinations (such as tech content with learning objectives, or tech content without the sw domain)

    Base (2 shells):
            topic and map plus utility domains
    Tech content (11 shells):
            topic, concept, task, general task, task with requirements domain, reference, glossary, ditabase (all incorp. hazard, utility, sw, pr, ui domains);
            bookmap, 2 classification maps
    Learning and training (7 shells):

            5 l&t topic types, topic with l&t domain, map with l&t domain


    Michael Priestley
    Lead IBM DITA Architect
    mpriestl@ca.ibm.com
    http://dita.xml.org/blog/25



  • 4.  AW: [dita] proposed packaging and doctype shells for DITA 1.2

    Posted 08-19-2008 17:35
    
    
    
    
    
    
    
    Jeff
     
    we had a pretty long discussion in the machine industry subcommittee regarding this packaging issue. Unfortuneatly, all packaging ideas we looked at ideal would break the backward compatibility. So an optimal solution for that issue - from the machine industry point of view - will not be possible in DITA 1.x.
     
    Finally we decided to support your proposal.
     
    We also discussed the issue needing a separate machine industry package or not. Finally we decided that it is not yet required. But for dita 1.3 or dita 2.0 we will bring up a lot of new parts which will maybe make it necessery to discuss the machine industry package issue again for dita 1.3 or 2.0.
     
    Finally we decided not to have a separate machine industry package in DITA 1.2.
     
     
     
     
     
     
     
     


    Von: Ogden, Jeff [mailto:jogden@ptc.com]
    Gesendet: Dienstag, 19. August 2008 18:02
    An: dita@lists.oasis-open.org
    Betreff: RE: [dita] proposed packaging and doctype shells for DITA 1.2

    Here is an update to Michael’s proposal with clarifications from today’s TC call:

     

    Base Collection:

    • Base Topic
    • Base Map (map plus Utilities and Map Group domains)

     

    Technical Content Collection (all topics include hazard, utility, sw, pr, and ui domains):

    • Topic
    • Concept
    • Task
    • General Task
    • Task with requirements domain
    • Reference
    • Glossary
    • Ditabase
    • Map
    • Bookmap
    • Classification map #1
    • Classification map #2

     

    Learning and Training Content Collection:

    • Learning Assessment
    • Learning Content
    • Learning Overview
    • Learning Plan
    • Learning Summary
    • Learning Topic (Topic plus the Learning and Training domains added)
    • Learning Map (Base Map plus the Learning and Training domains added)
    • Learning Bookmap (Bookmap with the Learning and Training domains added)

     


    From: Michael Priestley [mailto:mpriestl@ca.ibm.com]
    Sent: Friday, August 15, 2008 11:53 AM
    To: dita@lists.oasis-open.org
    Subject: [dita] proposed packaging and doctype shells for DITA 1.2

     


    Assumptions:
    - need to keep the legacy shells from 1.1 to avoid breaking existing users
    - beyond legacy shells, adding only the bare minimum to exercise each new domain and structural type
    - users will go to the web tool for most combinations (such as tech content with learning objectives, or tech content without the sw domain)

    Base (2 shells):
            topic and map plus utility domains
    Tech content (11 shells):
            topic, concept, task, general task, task with requirements domain, reference, glossary, ditabase (all incorp. hazard, utility, sw, pr, ui domains);
            bookmap, 2 classification maps
    Learning and training (7 shells):

            5 l&t topic types, topic with l&t domain, map with l&t domain


    Michael Priestley
    Lead IBM DITA Architect
    mpriestl@ca.ibm.com
    http://dita.xml.org/blog/25



  • 5.  RE: [dita] proposed packaging and doctype shells for DITA 1.2

    Posted 08-19-2008 18:28
    
    
    
    
    
    
    
    
    
    
    

    This seems good to me.  We’ll see what others think.

     

    An updated summary of the doctype shells we expect to include as part of DITA 1.2 is included below.

     

    There is also a new Wiki page that lists the proposed DITA 1.2 doctype shells. See: http://wiki.oasis-open.org/dita/Draft_list_of_doctype_shells_to_be_included_in_DITA_1.2  

     

    Thanks for the quick turn around on this issue.

     

        -Jeff

     

     

    Base Collection:

    • Base Topic
    • Base Map (map plus Utilities and Map Group domains)

     

    Technical Content Collection (all topics include hazard, utility, sw, pr, and ui domains):

    • Topic
    • Concept
    • Task
    • General Task
    • Machine Industry Task (the domains from General Task plus the Requirements Domain and without the sw and pr domains)
    • Reference
    • Glossary
    • Ditabase
    • Map
    • Bookmap
    • Classification map #1
    • Classification map #2

     

    Learning and Training Content Collection:

    • Learning Assessment
    • Learning Content
    • Learning Overview
    • Learning Plan
    • Learning Summary
    • Learning Topic (Topic plus the Learning and Training domains added)
    • Learning Map (Base Map plus the Learning and Training domains added)
    • Learning Bookmap (Bookmap with the Learning and Training domains added)

     

     


    From: SeicoDyne DITA [mailto:dita@seicodyne.ch]
    Sent: Tuesday, August 19, 2008 1:35 PM
    To: Ogden, Jeff; dita@lists.oasis-open.org
    Subject: AW: [dita] proposed packaging and doctype shells for DITA 1.2

     

    Jeff

     

    we had a pretty long discussion in the machine industry subcommittee regarding this packaging issue. Unfortuneatly, all packaging ideas we looked at ideal would break the backward compatibility. So an optimal solution for that issue - from the machine industry point of view - will not be possible in DITA 1.x.

     

    Finally we decided to support your proposal.

     

    We also discussed the issue needing a separate machine industry package or not. Finally we decided that it is not yet required. But for dita 1.3 or dita 2.0 we will bring up a lot of new parts which will maybe make it necessery to discuss the machine industry package issue again for dita 1.3 or 2.0.

     

    Finally we decided not to have a separate machine industry package in DITA 1.2.

     

    Naming of the task type:

    "Task with requirements domain" is not realy a cool name, and as it is a description only, I guess it was ment to be renamed.

    As we already have given the "task requirements domain" a general name indicating that it can be used in other industries, we finally came to the conclusion that the most appropriate name for this "General Task with requirements domain" (as it is build on "General Task"), would be to keep the name for this task shell as machineryTask.

     

    So finally we decided to propose as name for this topic shell:

    machineryTask, containing all domains from "generalTask" including "task requirements domain" but excluding "sw- and pr-domain"

     

    Hope that is OK.

     

    Best regards

     

     

    Chris

     

     

     

    SeicoDyne GmbH

    Eichenstrasse 16

    CH-6015 Reussbühl

    Switzerland

    Tel: +41 41 534 66 97

    Mob: +41 78 790 66 97

    Skype: seicodyne

     

     

     

     

     

     

    Member of the DITA Technical Committee

    Chairman of the DITA Machine Industry Subcommittee

     

     


    Von: Ogden, Jeff [mailto:jogden@ptc.com]
    Gesendet: Dienstag, 19. August 2008 18:02
    An: dita@lists.oasis-open.org
    Betreff: RE: [dita] proposed packaging and doctype shells for DITA 1.2

    Here is an update to Michael’s proposal with clarifications from today’s TC call:

     

    Base Collection:

    • Base Topic
    • Base Map (map plus Utilities and Map Group domains)

     

    Technical Content Collection (all topics include hazard, utility, sw, pr, and ui domains):

    • Topic
    • Concept
    • Task
    • General Task
    • Task with requirements domain
    • Reference
    • Glossary
    • Ditabase
    • Map
    • Bookmap
    • Classification map #1
    • Classification map #2

     

    Learning and Training Content Collection:

    • Learning Assessment
    • Learning Content
    • Learning Overview
    • Learning Plan
    • Learning Summary
    • Learning Topic (Topic plus the Learning and Training domains added)
    • Learning Map (Base Map plus the Learning and Training domains added)
    • Learning Bookmap (Bookmap with the Learning and Training domains added)

     


    From: Michael Priestley [mailto:mpriestl@ca.ibm.com]
    Sent: Friday, August 15, 2008 11:53 AM
    To: dita@lists.oasis-open.org
    Subject: [dita] proposed packaging and doctype shells for DITA 1.2

     


    Assumptions:
    - need to keep the legacy shells from 1.1 to avoid breaking existing users
    - beyond legacy shells, adding only the bare minimum to exercise each new domain and structural type
    - users will go to the web tool for most combinations (such as tech content with learning objectives, or tech content without the sw domain)

    Base (2 shells):
            topic and map plus utility domains
    Tech content (11 shells):
            topic, concept, task, general task, task with requirements domain, reference, glossary, ditabase (all incorp. hazard, utility, sw, pr, ui domains);
            bookmap, 2 classification maps
    Learning and training (7 shells):

            5 l&t topic types, topic with l&t domain, map with l&t domain


    Michael Priestley
    Lead IBM DITA Architect
    mpriestl@ca.ibm.com
    http://dita.xml.org/blog/25