Next in thread → Next in month →

Re: [dita-lightweight-dita] Outline (rough, very) of LwDITA spec

From
Kristen James Eberlein <>
Date
2016-09-18T20:05:33+00:00
ID
Thread
Re: [dita-lightweight-dita] Outline (rough, very) of LwDITA spec
Hi, Carlos.

    
Belated response, but ...

    
I'd start by separating the element topics and the
      rationale/tutorial/architectural overview topics. Not because I
      think that is how the final spec should be authored, but because:

    
      
We have existing element reference topics in the full spec,
        and we need to align full spec and LWDITA spec. The elements
        must have the same semantic meaning, whether they are used in
        full DITA or LWDITA.

      
The proposed elements for LWDITA that do not exist in
        full DITA should be proposed for DITA 2.0.

      
Thinking how to best group the elements proposed for LWDITA
        might help the DITA TC consider how to reformulate the full spec
        for DITA 2.0.

    
    
Separating the content leaves us with the following:

    
Rationale/tutorial/architectural overview topics

    
## LwDITA intro

      ## Rationale

      ## Attributes/capabilities

      

      ## Three models for content creation

      ### XDITA intro

      ### HDITA intro

      ### MDITA intro

    
## Minimal specialization model

      - Template based specialization

      - Structural specialization annotations

      - Attribute and domain specialization annotations

    
Elements

    
Grouping the elements is always difficult. We struggled with this
      for DITA 1.2. Some groupings are obvious, but others are not. I
      built a spreadsheet (attached) and listed the grouping from your
      list, the DITA 1.3 spec, and my own (not-so-great) attempt at
      grouping:

    
      
Audio and video elements

      
Basic content elements  (p, ph, pre, xref)

      

      
Definition list elements

      
Image elements (alt, fig, image)

      
Metadata elements (data and prolog)

      

      
Ordered and unordered lists

      
Structural elements (map, section, shortdesc, title, topic)

      

      
Table elements

    
    The basic principle is that an element can only appear in one place.
    I'd like to see the same short descriptions for full and LWDITA,
    also examples if possible.

    

    I've uploaded CHM and PDF made from existing (full DITA) language
    ref topics to Kavi:
https://www.oasis-open.org/committees/document.php?document_id=58913&wg_abbrev=dita-lightweight-dita

    

    
Best,

    

    

      Kris

      .

      Kristen James Eberlein

      Chair, OASIS DITA Technical Committee

      Principal consultant, Eberlein Consulting

      www.eberleinconsulting.com

      +1 919 682-2290; kriseberlein (skype)

      

    

    
On 7/25/2016 3:07 PM, Carlos Evia
      wrote:

    

    
      
      Dear all,
      

      

      
Attached is the very rough outline of the DITA spec
        in Markdown format. Michael gave me some feedback and I added
        sections based on that and his pre/overview presentation.

      
Please send comments and throw tomatoes as needed.

      

      

      
Thanks a lot,

      

      

      
Carlos

      

        

          

            

              

                  

                      

                          

                              

                                  
--- 

                                
                                

                                  
Carlos Evia,
                                    Ph.D.

                                  
Director of
                                    Professional and Technical Writing

                                  
Associate
                                    Professor of Technical Communication

                                  
Department
                                    of English

                                  
Center for
                                    Human-Computer Interaction

                                  
Virginia
                                    Tech

                                  
Blacksburg,
                                    VA 24061-0112

                                  
(540)200-8201

                                

                              

                            

                        

                    

                

            

          

        

      

      

      
      

      
      

        

          

            

              

                  

                      

                          

                              

                                

                                

                              

                            

                        

                    

                

              
            

            
          

          
          
        

        
      

    
    

  

Attachment:
LWDITA-elements.xlsx

Description: Binary data
Next in thread → Next in month →