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