doc/rendition.texi

   1 @c This is part of GNU tar manual.
   2 @c Copyright (C) 1992, 1994, 1995, 1996, 1997, 1999, 2000, 2001,
   3 @c 2003, 2004, 2006 Free Software Foundation, Inc.
   4 @c See file tar.texi for copying conditions.
   5
   6 @c This file contains support for 'renditions' by Fran@,{c}ois Pinard
   7 @c I extended it by adding a FIXME_FOOTNOTE variable, which controls
   8 @c whether FIXME information should be placed in footnotes or
   9 @c inlined. --gray
  10
  11 @c ======================================================================
  12 @c This document has three levels of rendition: PUBLISH, DISTRIB or PROOF,
  13 @c as decided by @set symbols.  The PUBLISH rendition does not show
  14 @c notes or marks asking for revision.  Most users will prefer having more
  15 @c information, even if this information is not fully revised for adequacy,
  16 @c so DISTRIB is the default for distributions.  The PROOF rendition
  17 @c show all marks to the point of ugliness, but is nevertheless useful to
  18 @c those working on the manual itself.
  19 @c ======================================================================
  20
  21 @c Set this symbol if you wish FIXMEs to appear in footnotes, instead
  22 @c of being inserted into the text.
  23 @c @set PROOF_FOOTNOTED
  24
  25 @ifclear PUBLISH
  26 @ifclear DISTRIB
  27 @ifclear PROOF
  28 @set DISTRIB
  29 @end ifclear
  30 @end ifclear
  31 @end ifclear
  32
  33 @ifset PUBLISH
  34 @set RENDITION The book, version
  35 @end ifset
  36
  37 @ifset DISTRIB
  38 @set RENDITION FTP release, version
  39 @end ifset
  40
  41 @ifset PROOF
  42 @set RENDITION Proof reading version
  43 @end ifset
  44
  45 @c Output marks for nodes needing revision, but not in PUBLISH rendition.
  46
  47 @macro UNREVISED
  48 @ifclear PUBLISH
  49 @quotation
  50 @emph{(This message will disappear, once this node revised.)}
  51 @end quotation
  52 @end ifclear
  53 @end macro
  54
  55 @c Output various FIXME information only in PROOF rendition.
  56
  57 @macro FIXME{string}
  58 @ifset PROOF
  59 @ifset PROOF_FOOTNOTED
  60 @footnote{@strong{FIXME:} \string\}
  61 @end ifset
  62 @ifclear PROOF_FOOTNOTED
  63 @cartouche
  64 @strong{<FIXME>} \string\ @strong{</>}
  65 @end cartouche
  66 @end ifclear
  67 @end ifset
  68
  69 @end macro
  70
  71 @macro FIXME-ref{string}
  72 @ifset PROOF
  73 @strong{<REF>} \string\ @strong{</>}
  74 @end ifset
  75 @ifclear PROOF
  76 @cite{\string\}
  77 @end ifclear
  78 @end macro
  79
  80 @macro FIXME-pxref{string}
  81 @ifset PROOF
  82 See @strong{<PXREF>} \string\ @strong{</>}
  83 @end ifset
  84 @ifclear PROOF
  85 See @cite{\string\}
  86 @end ifclear
  87
  88 @end macro
  89
  90 @macro FIXME-xref{string}
  91 @ifset PROOF
  92 See @strong{<XREF>} \string\ @strong{</>}
  93 @end ifset
  94 @ifclear PROOF
  95 See @cite{\string\}
  96 @end ifclear
  97 @end macro
  98
  99 @c End of rendition.texi