Re: [dita] DITA errata template: Redlining issue

From
Kristen James Eberlein <>
Date
2016-06-22T18:53:44+00:00
ID
Thread
Re: [dita] DITA errata template: Redlining issue
Hi, Chet.

    
Our e-mails crossed. Let's set up a time to talk. Please e-mail
      me off-list with your availability for tomorrow and Friday;
      thanks!

    

    
Best,

      Kris

      

      Kristen James Eberlein

      Chair, OASIS DITA Technical Committee

      Principal consultant, Eberlein Consulting

      www.eberleinconsulting.com

      +1 919 682-2290; kriseberlein (skype)

      

    

    
On 6/22/2016 10:56 AM, Chet Ensign
      wrote:

    

    
      
Here is a suggestion - it is what we have done for
        OData. There it added to the work load for us in that case. 
        

        

        
As always, the keys are what your community of users need
          and what the OASIS rules require. In this situation, the rules
          are pretty simple. See https://www.oasis-open.org/policies-guidelines/tc-process#errata 

        

        

        
You need to provide the errata document itself which is
          essentially a list of changes ("... set of proposed
          corrections...") and optionally (but I think vitally
          important) an updated copy of the standard with the changes
          applied. 

        

        

        
In the case of OData, the main copy of the standard was
          clean for readability. The redlined version we produced is
          also there but in a separate folder. 

        

        

        
I would be fine with the errata, the OS with the errata
          applied, and a version generated that displays changes in
          whatever way is convenient - change bars, color changes. DITA
          is complex enough as it is. 

        

        

        
We will need to work out the directory structure and file
          names and such. I hate errata because they lay another level
          of complexity on it but we've worked out the best solution we
          can. 

        

        

        
It might be worth a call to go over all the options and
          find the best way to make this as easy on you as we can. 

        

        

        
Best, 

        

        

        
/chet

        

        

        

        

      

      

        
On Tue, Jun 21, 2016 at 10:51 AM, Bob
          Thomas <>
          wrote:

          
            
Flagging with red for new text should
              suffice, especially since the HTML version is the
              authoritative one.

            

              

                

                  
On Tue, Jun 21, 2016 at 8:50
                    AM, Tom Magliery <>
                    wrote:

                    
                      

                        
Perhaps you could
                            counter-propose change bars.

                            

                            mag

                              

                              

                              

                              -----Original Message-----

                              From: Kristen James Eberlein [mailto:]

                              Sent: Tue 6/21/2016 7:43 AM

                              To: Tom Magliery; Scott Hudson; DITA TC

                              Subject: Re: [dita] DITA errata template:
                              Redlining issue

                              

                              Guys, we will be replacing all of the
                              content models in the appendix. Do we want
                              to double the size of the errata?

                              

                              

                              Best,

                              

                              

                              Kris

                              

                              Kristen James Eberlein

                              Chair, OASIS DITA Technical Committee

                              Principal consultant, Eberlein Consulting

                              www.eberleinconsulting.com

                              +1
                                919 682-2290; kriseberlein (skype)

                              

                              

                              On 6/21/2016 10:36 AM, Tom Magliery wrote:

                              

                              

                                      The XML editor that all of you
                              use, and the one that I use, retain (most)
                              deleted material in PIs if you turn on
                              change tracking. Attribute changes are
                              problematic.

                                     

                                      I think there was a time about a
                              skillion years ago that we did some DITA
                              OT customization for a customer who wanted
                              to see something like this. Or that might
                              have been just for change bars in the
                              margins.

                                     

                                      mag

                                     

                                     

                                     

                                      -----Original Message-----

                                      From: 
                              on behalf of Scott Hudson

                                      Sent: Tue 6/21/2016 7:31 AM

                                      To: Kristen James Eberlein; DITA
                              TC

                                      Subject: RE: [dita] DITA errata
                              template: Redlining issue

                                     

                            
                                    Don't we have a line-through
                            element? <http://docs.oasis-open.org/dita/dita/v1.3/os/part3-all-inclusive/langRef/base/line-through.html#line-through>
                            http://docs.oasis-open.org/dita/dita/v1.3/os/part3-all-inclusive/langRef/base/line-through.html#line-through

                                     

                                      Just sayin'

                                     

                                      --Scott

                                     

                                      -----Original Message-----

                                      From: 
                              [mailto:]
                              On Behalf Of Kristen James Eberlein

                                      Sent: Tuesday, June 21, 2016 8:25
                              AM

                                      To: DITA TC

                                      Subject: [dita] DITA errata
                              template: Redlining issue

                                     

                                      Folks, the template that we
                              received from Paul Knight includes
                              instructions to indicate any deleted text
                              with strike through. (Thanks to Bob Thomas
                              for carefully looking at the template and
                              bringing this to my attention.)

                                     

                                      I've sent e-mail to Paul Knight
                              and Chet Ensign basically saying "Hey, we
                              can't do this; this is a Microsoft Word
                              convention. We CAN provide a clear list of
                              changes ...", but I have not yet heard
                              back.

                                     

                                      Thoughts from TC members?

                                     

                                      --

                                      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://urldefense.proofpoint.com/v2/url?u=https-3A__www.oasis-2Dopen.org_apps_org_workgroup_portal_my-5Fworkgroups.php&d=CwICaQ&c=P3aKjizb3qsxp0SERaL2sw&r=YQWdLfM9mekBOdoMmoBdn9RgyqIHrveGolBbb4_uGWQ&m=VwKfONQA1Ua63_Zvhoaf-TxobsibVpCKIbG-hmvDgW0&s=ryXNFj5ondk_cg9WNYySe1Nut3039guzQEMqc3LzfN8&e=

                                     

                                     

                                     

                              

                              

                              

                            
                        

                      

                    
                  

                  

                  
                  

                  

                

              

              -- 

                
Bob Thomas
                  
+1 720 201
                      8260

                  
Skype: bob.thomas.colorado

                  
Instant messaging: Gmail chat () or
                    Skype

                  
Time zone: Mountain (GMT-7)

                  

                    

                    

                  

                

              

          
        

        

        
        

        

        -- 

        

          

            

              

                /chet 

                ----------------

                Chet Ensign

                Director of Standards Development and TC Administration 

                OASIS: Advancing open standards for the information
                society

                http://www.oasis-open.org

                

                Primary: +1 973-996-2298

                Mobile: +1 201-341-1393