Re: [dita] Revised element reference topics -- Please take a look

From
Kristen James Eberlein <>
Date
2017-08-10T13:18:45+00:00
ID
Thread
Re: [dita] Revised element reference topics -- Please take a look
Sorry, Scott -- I realize that I left Specialization hierarchy
      out of the list. Look at the topic for <b>.

      

      It should have read:

    

    
      

        Title

      
Short description (uses natural language)

      
Usage
        information

      
Formatting
        expectations

      
Processing
        expectations

      
Specialization hierarchy

      

      
Attributes

      
Example 

        

      

    
    
The plan is to move the content model
      topics out of the spec and into an ancillary document. We do not
      have a way to accurately generate the content models.

      

      Best,

      Kris

      

      Kristen James Eberlein

      Chair, OASIS DITA Technical Committee

      Principal consultant, Eberlein Consulting

      www.eberleinconsulting.com

      +1 919 682-2290; kriseberlein (skype)

      

    

    
On 8/10/2017 8:52 AM, Scott Hudson
      wrote:

    

    
      
      
      
      
      
      
      

        
Thanks, Kris.
            

        
 

        
I would like to
            keep the Inheritance section that is in the current
            reference topics. It is very helpful for implementers and
            those creating specializations.

        
 

        
Perhaps we
            could use the following structure:

        

          1.      
              Title
            

        

          2.      
              Short
            description (uses natural language)
            

        

          3.      
              Usage
            information
            

        

          4.      
              Formatting
            expectations
            

        

          5.      
              Processing
            expectations
            

        

          6.      
              Specialization
            information

        
          
            
Domain

            
Inheritance

          
        
        

          7.      
              Attributes
            

        

          8.      
              Example

        
 

        
Another option
            is to move the Specialization information (Inheritance)
            section to the content model appendix. I'm not sure how easy
            this would be to maintain or generate?

        
 

        
Also, for
            authors, I think it is still important to know what child
            elements a particular element can contain, and where the
            element is allowed (parents). The current method points to
            the content model appendix. I assume this will also remain?

        
 

        
One other
            comment: in the Index, there are several entries that are
            likely to span many pages and be quite repetitive with other
            entries. I'd recommend against using the following index
            entries:

        
·        
              elements

        

          o   
              body

        
·        
              formatting
            expectations

        
·        
              processing
            expectations

        
 

        
Thanks
            and best regards,

        
 

        
--Scott

        
 

        
Voting
            member:

        
Boeing
            Data Standards Technical Advisory Board

        
OASIS
            DocBook TC, Publishers SC (Chair)

        
OASIS
            DITA TC, Tech Comm SC, LW DITA SC, Learning Content SC
            (Secretary)

        
OASIS
            DITA Adoption TC

        
OASIS
            Augmented Reality in Information Products (ARIP) TC

        
 

        
Scott
              Hudson

            Content Strategist, Digital Aviation Learning and
            Development

        
Jeppesen,
            A Boeing Company

        
55
            Inverness Drive East

        
Englewood,
            CO  80112

        
303-328-6228
            | Cell: 303-350-7934

        
 

        

        
 

        
This
            document contains only administrative, uncontrolled data
            under U.S. International Traffic in Arms Regulations.

        
 

        
 

        

          
From:
              <>
              on behalf of Kristen James Eberlein
              <>

              Date: Thursday, August 10, 2017 at 5:56 AM

              To: DITA TC <>

              Subject: [dita] Revised element reference topics
              -- Please take a look

        

        

          
 

        

        
If you were at the TC meeting on 18
          July, you heard Robert report about the items regarding the
          DITA 2.0 spec that a small group discussed and the
          recommendations that they came up with.

        
I attach a PDF that includes some
          element reference topics that have been reworked to match the
          new format, which includes the following sections:

        

        
        
Do note that these rejigged topics do
            not necessarily contain appropriate content for DITA
          2.0, but that existing content has been moved into the
          relevant section, for example, "Formatting expectations". We
          all thought that moving content into the relevant sections
          would make it much easier to see what content is appropriate,
          what is unneeded, and where we have content that should be
          augmented.

        
The attribute sections are
          untouched. Normative statements have been reworked so that
          they are complete content that could be reused in another
          document or appendix.

        

          
--
            

            Best,

            Kris

            

            Kristen James Eberlein

            Chair, OASIS DITA Technical Committee

            Principal consultant, Eberlein Consulting

            www.eberleinconsulting.com

            +1 919 682-2290; kriseberlein (skype)