diff options
Diffstat (limited to 'doc/rendition.texi')
-rw-r--r-- | doc/rendition.texi | 94 |
1 files changed, 94 insertions, 0 deletions
diff --git a/doc/rendition.texi b/doc/rendition.texi new file mode 100644 index 0000000..45ac068 --- /dev/null +++ b/doc/rendition.texi @@ -0,0 +1,94 @@ +@c Let's use the concept of 'renditions' by Fra@,{c}ois Pinard +@c I extended it by adding a FIXME_FOOTNOTE variable, which controls +@c whether FIXME information should be placed in footnotes or +@c inlined. + +@c ====================================================================== +@c This document has three levels of rendition: PUBLISH, DISTRIB or PROOF, +@c as decided by @set symbols. The PUBLISH rendition does not show +@c notes or marks asking for revision. Most users will prefer having more +@c information, even if this information is not fully revised for adequacy, +@c so DISTRIB is the default for distributions. The PROOF rendition +@c show all marks to the point of ugliness, but is nevertheless useful to +@c those working on the manual itself. +@c ====================================================================== + +@c Set this symbol if you wish FIXMEs to appear in footnotes, instead +@c of being inserted into the text. +@c @set PROOF_FOOTNOTED + +@ifclear PUBLISH +@ifclear DISTRIB +@ifclear PROOF +@set DISTRIB +@end ifclear +@end ifclear +@end ifclear + +@ifset PUBLISH +@set RENDITION The book, version +@end ifset + +@ifset DISTRIB +@set RENDITION FTP release, version +@end ifset + +@ifset PROOF +@set RENDITION Proof reading version +@end ifset + +@c Output marks for nodes needing revision, but not in PUBLISH rendition. + +@macro WRITEME +@ifclear PUBLISH +@quotation +@emph{This node is to be written.} +@end quotation +@end ifclear +@end macro + +@macro UNREVISED +@ifclear PUBLISH +@quotation +(@emph{The information in this node may be obsolete or otherwise inaccurate.} +This message will disappear, once this node revised.) +@end quotation +@end ifclear +@end macro + +@c Output various FIXME information only in PROOF rendition. + +@macro FIXME{string} +@ifset PROOF +@ifset PROOF_FOOTNOTED +@footnote{@strong{FIXME:} \string\} +@end ifset +@ifclear PROOF_FOOTNOTED +@cartouche +@strong{<FIXME>} \string\ @strong{</>} +@end cartouche +@end ifclear +@end ifset + +@end macro + +@macro FIXME-ref{string} +@ifset PROOF +@strong{<REF>} \string\ @strong{</>} +@end ifset + +@end macro + +@macro FIXME-pxref{string} +@ifset PROOF +@strong{<PXREF>} \string\ @strong{</>} +@end ifset + +@end macro + +@macro FIXME-xref{string} +@ifset PROOF +@strong{<XREF>} \string\ @strong{</>} +@end ifset + +@end macro |