[SAGA-RG] latex annotation macros (update)

Andre Merzky andre at merzky.net
Fri Mar 2 06:03:55 CST 2007


The macros changed to:

   % security fix
   \XSec[n]{text related to security update}
   
   % spelling fix
   \XSpell[n]{text wit connect speling} :-P
   
   % clarification fix
   \XCorr[n]{corrected and improved text}
   
   % error fix
   \XErr[n]{fixed text}
   
   % removed text
   \XRem[n]{deleted text}
   
   % added text
   \XAdd[n]{new text}
   
   % comment, e.g. to comment changes in an image}
   \XComm[n]{comment text}
   
   % replace text
   \XRep[n]{old text}{new text}
   
   % mark lines as changed
   \XMark[n]

The optional [n] parameter denotes the number of lines which
should be marked as changed by a side bar.  Please use these
macros when editing the spec.

Cheers, Andre.


Quoting [Andre Merzky] (Feb 12 2007):
> 
> Hi Folx, 
> 
> we started to address the public comments in the SAGA API
> CVS.  We have to deliver a annotated version of the document
> to the editor.  In order to simplify this, we created a
> number of latex macros for annotation.  A short description
> is included below - if you edit the document, please use
> these.
> 
> Thanks, Andre.
> 
> 
> ----- Forwarded message from Andre Merzky <andre at merzky.net> -----
> 
> > To: saga-cvs at cct.lsu.edu
> > From: Andre Merzky <andre at merzky.net>
> > Subject: [saga-cvs] "SAGA-RG/Strawman strawman.tex strawman_error.tex
> > 	strawman_intro.tex strawman_logicalfiles.tex"
> > 
> > Update of /projects/SAGA-RG/Strawman
> > In directory asylum.cct.lsu.edu:/tmp/cvs-serv9678
> > 
> > Modified Files:
> > ---------------
> > 	strawman.tex strawman_error.tex strawman_intro.tex 
> > 	strawman_logicalfiles.tex 
> > 
> > Log Message:
> > ------------
> > Start to add marker for text changes.  We need to re-submit the doc with changes
> > marked...  please use:
> > 
> >  \XN{new text}
> >    -> mark text as new
> > 
> >  \XX{old text}{new text}
> >    -> mark text as changed from old to new
> > 
> >  \XL[lnum]
> >    -> mark the last 'lnum' lines as changed
> > 
> > In verbatim mode, use '!', '+' and '-' in the FIRST column, e.g.
> > 
> >
> > \begin{myspec}
> > 
> > ! package file
> >   {
> > -   class saga::file inherits saga::ns_entry
> > +   class saga::file inherits saga::namespace_entry
> >     ...
> >   }
> > 
> > \end{myspec}
> > 
> > 
> > No need to mark small typo corrections, everything else SHOULD be marked.
> > 
> > Cheers, Andre.
> > 
> > _______________________________________________
> > saga-cvs mailing list
> > saga-cvs at cct.lsu.edu
> > https://mail.cct.lsu.edu/mailman/listinfo/saga-cvs
> 
> ----- End forwarded message -----
-- 
"So much time, so little to do..."  -- Garfield



More information about the saga-rg mailing list