Re: [dita] Phase 1 proposal: expand howtoavoid

From
Kristen James Eberlein <>
Date
2018-05-16T15:12:13+00:00
ID
Thread
Re: [dita] Phase 1 proposal: expand howtoavoid
Jang, we discussed the hazardstatement domain at yesterday's TC
      meeting. No one present had experienced any difficulties with the
      domain; everyone thinks it is adequate as-is.

    
We did agree that expanding the content model for
      <howtoavoid> would be appropriate.

    
Best,

      Kris

      

      Kristen James Eberlein

      Chair, OASIS DITA Technical Committee

      Principal consultant, Eberlein Consulting

      www.eberleinconsulting.com

      +1 919 622-1501; kriseberlein (skype)

      

    

    
On 5/15/2018 6:19 PM, Jang wrote:

    

    
      
      Hi Dawn,
      

      

      
This should of course be combined with my proposal
        to revise the hazardstatement domain. I can see no real
        objections to adding a <p>, <ol>, <ul>. I
        would like to do a little more research among users of
        hazardstatement to find out which elements are actually being
        used and which are missing.

      

      

      
Also, I would not add a <div> or a <dl>.
        I would rather remove <simpletable>. The
        <howtoavoid> should really be a very short statement of
        avoiding an identified danger. When <simpletable> or
        <dl> is required, there is something seriously wrong with
        the content that the author is trying to cram into a
        <hazardstatement>.

      

      

      
Kind regards from Shanghai

      

      

      
Jang

      

        

          
Jang F.M. Graat
            Smart Information Design
            Amsterdam, Netherlands
            Cell: +31 646 854 996
            
          

        

        

          
            
On 15 May 2018, at 23:58, Eliot Kimber <>
              wrote:

            
            

              

                
If you’re
                  going to add p you might as well add div too. I could
                  also see an argument for dl as an alternative to
                  simpletable.

                
 

                
Cheers,

                
 

                
E.

                
 

                

                  

                    

                      
--

                    

                    

                      
Eliot Kimber

                    

                    

                      
http://contrext.com

                    

                    

                      
 

                    

                  

                

                
 

                
 

                

                  
From: <>
                      on behalf of Dawn Stevens <>
                      Date: Tuesday,
                      May 15, 2018 at 10:47 AM
                      To: ""
                      <>
                      Subject: [dita]
                      Phase 1 proposal: expand howtoavoid

                

                

                  
 

                

                
From our
                  discussion today, I’ve put together a Phase 1 proposal
                  for expanding the content model within
                  <howtoavoid>.

                
I’ve never
                  written a Phase 1 proposal.  Hopefully I have put what
                  is needed in it, but if I need more, please advise.

                
 

                
Thanks,

                
Dawn

                
 

                
 

                
Phase
                      1 proposal: Add elements to <howtoavoid>

                
 

                
Requirement:

                
An important requirement when
                    writing hazard statements that conform to ISO and
                    ANSI requirements is providing information on how to
                    avoid the potential hazard. Often there are multiple
                    ways to avoid the problem; however, there are
                    currently limited elements available to itemize
                    these ways. Users are forced to use <sl> to
                    provide multiple lines of content and adjust their
                    stylesheets to add bullets or other distinguishing
                    formatting. 

                
We need to provide additional
                    block elements in the model to make it easier to
                    include multiple ways to avoid.

                
Proposal:

                
The current model for
                    <howtoavoid> content is:

                
<!ENTITY % hazard.cnt 
                    "#PCDATA
                    | 
                     %basic.ph; | 
                     %sl; | 
                     %simpletable;"
                  >

                
I propose adding p, ol, and ul at
                    a minimum to this model.

                
<!ENTITY % hazard.cnt 
                    "#PCDATA
                    | 
                     %basic.ph; | 
                     %p; |

                
   %sl; | 

                
   %ul; |
                     %ol; |
                     %simpletable;"
                  >