Re: [dita] Errata 02 item: Grammar glitch in <required-cleanup>

From
Kristen James Eberlein <>
Date
2017-08-31T21:00:25+00:00
ID
Thread
Re: [dita] Errata 02 item: Grammar glitch in <required-cleanup>
Eliot, I think you need to cram a few more instances of the word
      element into the sentence -- Not. 

    

    
How about "Provides information about the origins of the content
      of the <required-cleanup> element. This provides authors
      context for determining how the migrated content should be
      tagged."

    
After all, the content did not necessary come from XML or SGML or
      HTML.

    
I doubt that anyone uses this attribute; maybe it should be a
      candidate for removal.

    

    
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/31/2017 4:32 PM, Eliot Kimber
      wrote:

    

    
      
      
      
      
      
      

        
I think a
            better phrasing would be:

        
 

        
Specifies the
            element type name of the element the
            <required-cleanup> element replaced (and whose content
            the <required-cleanup> now contains, if any).

        
 

        
“Indicates”
            vague in this context—it doesn’t specify the form of the
            indication. Better to be explicit and precise.

        
 

        
But I think the
            original is grammatically correct as written.

        
 

        
Cheers,

        
 

        
E.

        
 

        

          

            

              
--

            

            

              
Eliot
                  Kimber

            

            

              
http://contrext.com

            

            

              
 

            

          

        

        
 

        
 

        

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

              Date: Thursday, August 31, 2017 at 3:12 PM

              To: <>

              Subject: Re: [dita] Errata 02 item: Grammar glitch
              in <required-cleanup>

        

        

          
 

        

        
The original needs to be rewritten. Technically, one needs to
          read it as "The element ... was ..."

        
How about "Indicates the element from which the content of
          the <required-cleanup> element was migrated. This
          provides authors context for determining how the migrated
          content should be tagged."

        

          
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/31/2017 3:33 PM, Eliot Kimber wrote:

        

        
          
If you
              rephrase it as “Indicates the element from which the
              contents of the <required-cleanup> element were
              mapped” then I think it becomes clearer that “contents
              were mapped” is the correct construction.

          
 

          
Unless I’m
              completely misreading the original, in which case its
              needs to be rewritten so that it can’t be misread.

          
 

          
Cheers,

          
 

          
E.

          
 

          
 

          

            

              

                
--

              

              

                
Eliot
                    Kimber

              

              

                
http://contrext.com

              

              

                
 

              

            

          

          
 

          
 

          

            
From: <>
                on behalf of Eliot Kimber <>

                Date: Thursday, August 31, 2017 at 9:17 AM

                To: DITA TC <>

                Subject: Re: [dita] Errata 02 item: Grammar
                glitch in <required-cleanup>

          

          

            
 

          

          
I don’t agree
              with this change: contents … were is correct in my
              opinion.

          
 

          
Cheers,

          
 

          
E.

          
 

          

            

              

                
--

              

              

                
Eliot
                    Kimber

              

              

                
http://contrext.com

              

              

                
 

              

            

          

          
 

          
 

          

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

                Date: Wednesday, August 30, 2017 at 10:00 PM

                To: DITA TC <>

                Subject: [dita] Errata 02 item: Grammar glitch
                in <required-cleanup>

          

          

            
 

          

          
http://docs.oasis-open.org/dita/dita/v1.3/errata01/os/complete/part3-all-inclusive/langRef/base/required-cleanup.html#required-cleanup

          
Currently:

            @remap

            Indicates the element that the contents of the
            <required-cleanup> element were mapped from
            (provides an idea about what the new intent should be).

          
Should be (at a minimum):

            @remap

            Indicates the element that the contents of the
            <required-cleanup> element was mapped from
            (provides an idea about what the new intent should be).

          
A more exhaustive rewrite probably is in order.

          

            
-- 

              Best,

              Kris

              

              Kristen James Eberlein

              Chair, OASIS DITA Technical Committee

              Principal consultant, Eberlein Consulting

              www.eberleinconsulting.com

              +1 919 682-2290; kriseberlein (skype)

          

          
---------------------------------------------------------------------
            To unsubscribe from this mail list, you must leave the OASIS
            TC that generates this mail. Follow this link to all your
            TCs in OASIS at: https://www.oasis-open.org/apps/org/workgroup/portal/my_workgroups.php
            

        
        

--------------------------------------------------------------------- To
          unsubscribe from this mail list, you must leave the OASIS TC
          that generates this mail. Follow this link to all your TCs in
          OASIS at:
          https://www.oasis-open.org/apps/org/workgroup/portal/my_workgroups.php