1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
|
\input texinfo @c -*-texinfo-*-
@c %**start of header
@setfilename imprimatur.info
@settitle Imprimatur Manual
@c %**end of header
@setchapternewpage odd
@c The UPDATED date is updated automatically by the Emacs magic at the
@c end of this file.
@set UPDATED 27 February 2015
@set VERSION 1.0
@c This document contains examples of all the rendition macros, so it
@c must be rendered in PROOF mode.
@set PROOF
@include rendition.texi
@defcodeindex op
@defcodeindex fl
@syncodeindex fn cp
@syncodeindex vr cp
@syncodeindex ky cp
@syncodeindex pg cp
@syncodeindex tp cp
@syncodeindex op cp
@syncodeindex fl cp
@copying
Published by the Free Software Foundation,
51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301 USA
Copyright @copyright{} 2011, 2015 Sergey Poznyakoff
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.2 or
any later version published by the Free Software Foundation; with no
Invariant Sections, with any Front and Back-Cover. A copy of the license
is included in the section entitled ``GNU Free Documentation License''.
@end copying
@titlepage
@title Imprimatur -- a Texinfo Document Checker
@subtitle version @value{VERSION}, @value{UPDATED}
@author Sergey Poznyakoff.
@page
@vskip 0pt plus 1filll
@insertcopying
@end titlepage
@ifnothtml
@page
@summarycontents
@page
@end ifnothtml
@contents
@ifnottex
@node Top
@top Imprimatur
@ifclear WEBDOCS
This edition of the @cite{Imprimatur Manual}, last updated @value{UPDATED},
documents @command{Imprimatur} Version @value{VERSION}.
@end ifclear
@end ifnottex
@menu
* Preface::
* Intro:: Introduction to Imprimatur.
* Renditions:: Renditions Define How the Document is Printed.
* Quick Start:: Integrating and Using Imprimatur
* Init:: Initializing the Package.
* Macros:: Texinfo Macros for Annotating the Document.
* Rules:: Makefile Rules Help Verify the Document.
* check-docs.sh:: Check for Missing Documentation Items.
* Reporting Bugs:: How to Report Bugs and Suggestions.
Appendices
@ifhtml
@ifset WEBDOCS
* This Manual in Other Formats::
@end ifset
@end ifhtml
* Copying This Manual:: The GNU Free Documentation License.
* Concept Index:: Index of Concepts.
@detailmenu
--- The Detailed Node Listing ---
Integrating and Using Imprimatur
* Integration:: How to Integrate Imprimatur to a Project.
* Usage:: How to Use Imprimatur
@end detailmenu
@end menu
@node Preface
@chapter Preface
@cindex Fran@,{c}ois Pinard
@command{Imprimatur} is a set of Texinfo macros and Makefile rules to
verify consistency and, to certain extent, completeness of
Texinfo documentation.
This package was inspired in part by Fran@,{c}ois Pinard's
@file{rendition.texi} file we used in GNU tar's documentation. It was
developed between 2005 and 2011 while writing documentation for
several other free software projects its author maintains: GNU
Mailutils, Dico and Pies, to name a few. It was reorganized into a
standalone submodule project in 2011.
@ifhtml
@ifset WEBDOCS
This edition of the @cite{Imprimatur Manual}, last updated @value{UPDATED},
documents @command{Imprimatur} Version @value{VERSION}. It is
available in various formats. @xref{This Manual in Other Formats}, to
select another format.
@end ifset
@end ifhtml
@node Intro
@chapter Introduction
@cindex annotation
Creating a documentation for software is a difficult task which is
equally important as writing the software itself. In particular, it
is important that the documentation be consistent with the software it
describes and that it cover all aspects of its functionality and usage.
Usually the documentation, as well as the program itself, is not
written in one pass. Rather it is created in a series of edits
and proofreadings. During this process the author often needs to
insert @dfn{annotations} which are not intended for the end user,
but which, instead, serve as a reminder for the author himself about
pending editing tasks. One may, for example, put a note saying that
certain paragraph needs to be reworded or that some feature needs to
be explained in greater detail and return to that note later in order
to fix it. Quite often several authors take part in creating the
documentation. In this case such annotations help coordinate their
work.
When preparing the document for publishing, it is important to make
sure that all such notes has been revised and none of them remain in
the document.
Keeping documentation in sync with the software is another
challenging task. After adding a new feature the author not always
edits the documentation to reflect that. In fact, quite often it is
impossible or undesirable, because the feature may imply some further
changes to another parts of the program, and the author may prefer to
update the docs when all the changes will have been finished. In
this case, putting annotations in appropriate places of the document
will remind him that certain parts of it have become inaccurate and
need to be attended later.
@cindex imprimatur
@cindex Texinfo
@command{Imprimatur}@footnote{@samp{Imprimatur} is Latin for @samp{let
it be printed}. Historically, this term was used to indicate that
there are no obstacles for printing a book.} aims to facilitate all
these tasks. It is intended for documents written in Texinfo
(@pxref{Top, Texinfo,,texinfo,Texinfo Manual}). The package provides
a mechanism for editor's annotations and a set of Makefile rules for
verifying the consistency of the document.
@node Renditions
@chapter Renditions
@cindex rendition, defined
The basic concept used in @command{Imprimatur} is the document
@dfn{rendition}. The rendition defines how much editor's information
and annotations should appear in the resulting document. There are
three possible renditions:
@defvr {Rendition} PROOF
This rendition is used for proofreading the document. It inserts all
annotations in a prominent form, which makes it easy to revise the document.
@end defvr
@defvr {Rendition} DISTRIB
This rendition is intended for the documentation distributed with the
packaged versions and its online copies on the Web. It inserts most
important annotations, so that the reader is aware about which parts
of the document are not fully revised for adequacy. Dangling
cross-references are also prominently marked as such (@pxref{Dangling
cross-reference}).
@end defvr
@defvr {Rendition} PUBLISH
This rendition is intended for publishing printed copies of the
documentation. It is supposed that by the time the document is ready
for publishing, all editor's and proofreader's annotations and
dangling references have been resolved and removed from the document.
Consequently, the use of annotation macros in this rendition results
in translation errors. This helps prevent publishing incomplete or
inaccurate documentation.
@end defvr
@vrindex RENDITION
Default rendition is determined when configuring the package. It can
be redefined when building the output, by using the @samp{RENDITION}
Makefile variable, e.g.:
@example
$ make RENDITION=PUBLISH
@end example
@node Quick Start
@chapter Integrating and Using Imprimatur
This chapter describes how to integrate @command{Imprimatur} to your
project and provides a brief overview on using it.
The project wishing to use @command{Imprimatur} must meet the
following requirements: it must use Autoconf and Automake and
it must use Git as a version control system.
@menu
* Integration:: How to Integrate Imprimatur to a Project.
* Usage:: How to Use Imprimatur
@end menu
@node Integration
@section Integration
@command{Imprimatur} is designed to be used as a Git submodule. If
your project uses @command{git}, integrating it is quite
straightforward.
@enumerate 1
@item
@cindex submodule
@cindex git
First of all, you need to declare a submodule. To do so, change into
the top source directory of your project and run:
@example
git submodule add git://git.gnu.org.ua/imprimatur.git imprimatur
git submodule init
@end example
This step needs to be done only once. The first command will clone
the project to the directory @file{imprimatur}. If you want another
name or need to place it deeper in the directory hierarchy, change the
last argument accordingly. For example, to place @command{Imprimatur}
to the directory @file{doc/aux} use:
@example
git submodule add git://git.gnu.org.ua/imprimatur.git doc/aux
@end example
The second command initializes the submodule.
@item
@cindex Makefile.am, top level
@vrindex ACLOCAL_AMFLAGS
@vrindex SUBDIRS
Next step is to edit the top-level @file{Makefile.am}. Add @option{-I
imprimatur} to the @samp{ACLOCAL_AMFLAGS} variable, and
@samp{imprimatur} directory to the @samp{SUBDIRS} variable. For example:
@example
ACLOCAL_AMFLAGS = -I m4 -I imprimatur
SUBDIRS = imprimatur
@end example
If you chose another directory name during the first step, use it
instead of @samp{imprimatur} in the above example.
@item
@flindex configure.ac
Next, you need to edit the @file{configure.ac} file and add a call to
@samp{IMPRIMATUR_INIT}. Normally no parameters are needed, just like
that:
@example
IMPRIMATUR_INIT
@end example
However, if you cloned @command{Imprimatur} into a directory with
another name, the actual directory name must be supplied as the first
argument. For example:
@example
IMPRIMATUR_INIT(doc/aux)
@end example
@xref{Init}, for a detailed description of the @samp{IMPRIMATUR_INIT}
macro.
@item
@flindex doc/Makefile.am
Now edit the file @file{Makefile.am} located in the subdirectory where
you have your Texinfo sources.
@enumerate A
@item
@vrindex AM_MAKEINFOFLAGS
@vrindex IMPRIMATUR_MAKEINFOFLAGS
To the value of @samp{AM_MAKEINFOFLAGS} variable add
@samp{@@IMPRIMATUR_MAKEINFOFLAGS@@}. This will inform
@command{makeinfo} and related tools about the location of
@command{Imprimatur} files (in particular, @file{rendition.texi}) and
the selected rendition (@pxref{Renditions}).
@item
@vrindex imprimatur_INPUT
Define the variable @samp{imprimatur_INPUT}. It must contain the
names of Texinfo sources to be verified by @command{Imprimatur}.
Normally, the following definition is sufficient:
@example
imprimatur_INPUT=$(info_TEXINFOS) $(@var{base}_TEXINFOS)
@end example
@noindent
where @var{base} stands for the base name of your Texinfo document (e.g.
@samp{foo}, if it is named @file{foo.texi}).
@xref{Rules,imprimatur_INPUT}, for a discussion of this variable and
its purposes.
@item
@flindex imprimatur.mk
Include the file @file{imprimatur.mk} from the @command{Imprimatur}
directory using relative addressing. For example, if your
documentation subdirectory is located at the same nesting level
as the directory you cloned @command{Imprimatur} to, use:
@example
include ../imprimatur/imprimatur.mk
@end example
@emph{Do not use Automake substitutions nor Makefile variables in the
argument to include.}
@item
@flindex check-docs.sh
If you plan to use the @file{check-docs.sh} script, define a Makeinfo
variable to access it, e.g.:
@example
CHECK_DOCS=$(top_srcdir)/@@IMPRIMATUR_MODULE_DIR@@/check-docs.sh
@end example
@xref{check-docs.sh}, for a discussion of this script.
@end enumerate
Let's summarize this step by an example:
@example
AM_MAKEINFOFLAGS = @@IMPRIMATUR_MAKEINFOFLAGS@@
imprimatur_INPUT=$(info_TEXINFOS) $(foo_TEXINFOS)
include ../imprimatur/imprimatur.mk
CHECK_DOCS=$(top_srcdir)/@@IMPRIMATUR_MODULE_DIR@@/check-docs.sh
@end example
@end enumerate
@node Usage
@section How to Use Imprimatur
@flindex rendition.texi
To use @command{Imprimatur}, you need to include the file
@file{rendition.texi} into your main Texifo source file:
@example
@@include rendition.texi
@end example
This file provides you with macros for annotating your documentation.
These macros are described in detail in @ref{Macros}. Here we present
a short overview.
The most common form of annotation is the @samp{@@FIXME} macro. It
introduces an editor's note about something that needs a revision or
clarification. For example:
@example
The @@var@{fmt@} argument is a database format identifier.
If it is valid, the function returns expiration interval for that
format.
@@FIXME@{It is not clear how to obtain negative expiration
values.@}
@end example
In @samp{PROOF} rendition, this Texinfo excerpt produces the following
output:
@quotation
The @var{fmt} argument is a database format identifier.
If it is valid, the function returns expiration interval for that
format. @example-FIXME{It is not clear how to obtain negative expiration
values.}
@end quotation
In other renditions, the @samp{@@FIXME} macro produces no output at
all.
It is supposed that you will be progressively @dfn{resolving} your
@samp{@@FIXME}s while reviewing your document. During this process
you can obtain a listing of all pending @samp{@@FIXME} notes by
running @code{make imprimatur-fixmes}, e.g.:
@example
@group
$ make imprimatur-fixmes
Unresolved FIXMEs:
functions.texi:2231: It is not clear how to obtain negative expiration
@end group
@end example
It is especially handy if you use @samp{compile} mode of GNU Emacs, as
you can then easily move editing point to the place when
a particular note appears by placing the cursor on the corresponding
line and hitting @kbd{Enter} (@pxref{Compilation Mode,,,emacs,The Emacs
Editor}).
Another common annotation is the @samp{@@UNREVISED} macro. Placed
after a sectioning command, it will draw reviewer's attention to nodes
that need a revision. A listing of such nodes can be obtaining using
the @samp{imprimatur-unrevised} rule:
@example
@group
$ make imprimatur-unrevised
Unrevised nodes:
mailfromd.texi:2567:@@UNREVISED
functions.texi:1508:@@UNREVISED
@end group
@end example
The @samp{@@UNREVISED} macro produces output in @samp{PROOF} and
@samp{DISTRIB} renditions. In @samp{PUBLISH} rendition it results in
compilation error. This behavior is intended to help avoid unrevised
nodes from appearing in final published texts.
When writing initial revision of a node you may need to mark a point
where a cross-reference to another, not yet written node should be.
The intent is to replace this mark with an actual cross-reference
command when the node referred to has already been written. For that
purpose @command{Imprimatur} provides three annotations:
@samp{@@FIXME-ref}, @samp{@@FIXME-xref}, and @samp{@@FIXME-pxref}.
These macros are similar to corresponding Texinfo commands, except
that they take a single argument. In fact in @samp{PUBLISH} rendition
these macros are equivalent to their Texinfo counterparts. In
@samp{PROOF} and @samp{DISTRIB} rendition, however, they produce a
cross-reference explicitly marked as referencing a non-existent node.
For example:
@example
@group
Enable transcript of @@acronym@{SMTP@} sessions to the log
channel. @@FIXME-xref@{Logging and Debugging@}.
@end group
@end example
This Texinfo fragment produces:
@quotation
Enable transcript of @acronym{SMTP} sessions to the log
channel. @example-FIXME-xref{Logging and Debugging}.
@end quotation
To list unresolved cross-reference use the @samp{imprimatur-refs}
Makefile rule:
@example
@group
$ make imprimatur-refs
Unresolved cross-references:
options.texi:4951: Logging and Debugging
@end group
@end example
@node Init
@chapter Initialization
@deffn {Autoconf Macro} IMPRIMATUR_INIT (@var{dir}, @var{options})
Initializes @command{Imprimatur} framework. Both arguments are
optional. The @var{dir} argument, if supplied, specifies the
directory you cloned @command{Imprimatur} into. It defaults to
@samp{imprimatur}, so that if you follow the default setup described
in @ref{Usage} you don't need to supply this argument.
The @var{options} argument is a whitespace-separated list of options.
Following options are recognized:
@cindex rendition, default
@cindex default rendition
@defvr {Option} PROOF
Set the default rendition to @samp{PROOF}.
@end defvr
@defvr {Option} DISTRIB
Set the default rendition to @samp{DISTRIB}.
@end defvr
@defvr {Option} PUBLISH
Set the default rendition to @samp{PUBLISH}.
@end defvr
@vindex VERSION
@kindex AC_INIT
If none of these three options is given, @command{IMPRIMATUR_INIT}
will select default rendition based on the version number of the
hosting package, i.e. the @samp{VERSION} variable, as set
by @code{AC_INIT} macro. The version number should consist of
up to three integers, separated by dots. The first integer is the
@dfn{major number}, the second one is the @dfn{minor number}, and the
third one is the @dfn{patchlevel}. Given that, the following
algorithm is used:
@enumerate 1
@item
If patchlevel is present, then:
@enumerate a
@item
If it is less than 50, @samp{DISTRIB} rendition is selected.
@item
Otherwise, the package is considered an alpha release and @samp{PROOF}
rendition is selected.
@end enumerate
@item
If patchlevel is not present, @samp{DISTRIB} is used.
@end enumerate
@defvr {Option} frenchspacing
Assume French sentence spacing. @xref{frenchspacing,,,texinfo,
Texinfo Manual}, for a description of the two possible sentence
spacings.
By default, American sentence spacing is assumed. This option affects
the @samp{imprimatur-check-sentence-spacing} Makefile rule, which
verifies whether sentence spacing is used consistently throughout the
document. @xref{imprimatur-check-sentence-spacing}.
@end defvr
@defvr {Option} makedoc
@flindex Makedoc
Enables creation of a separate makefile for building
@command{Imprimatur} documentation. This file is called
@file{Makedoc} and contains rules for building this manual in various
output formats. It is the responsibility of the caller to include
@file{Makedoc.am} to the list of configured files, e.g.:
@example
AC_CONFIG_FILES(imprimatur/Makedoc)
@end example
With this option on, the @file{Makefile} in the
@file{imprimatur} subdirectory will also contain several additional
shortcut rules, namely:
@table @option
@item make info
@itemx make imprimatur.info
Creates the manual in info format (a shortcut for @command{make -f
Makedoc imprimatur.info}).
@item make pdf
Creates a PDF output (a shortcut for @command{make -f Makedoc pfd}).
@item make dvi
Creates a DVI output.
@item make ps
Creates a PostScript output.
@end table
This option is intended mostly for @command{Imprimatur} maintainers,
but you may use it to build your own, perhaps customized, copies of
this manual.
@end defvr
@defvr {Option} dist-info
Distribute the @file{imprimatur.info} file. This option is valid only
in conjunction with @option{makedoc}.
@end defvr
@end deffn
The @code{IMPRIMATUR_INIT} macro defines several substitution
variables, which you can use in your @file{Makefile.am} files.
@defvr {Substitution Variable} IMPRIMATUR_MODULE_DIR
The name of the directory @command{Imprimatur} was cloned into. This
name is relative to the top source directory. It helps address files
from the @command{Imprimatur} subdirectory. For example:
@example
CHECK_DOCS=$(top_srcdir)/@@IMPRIMATUR_MODULE_DIR@@/check-docs.sh
@end example
@end defvr
@vindex AM_MAKEINFOFLAGS
@defvr {Substitution Variable} IMPRIMATUR_MAKEINFOFLAGS
Additional options for @command{makeinfo} and compatible tools, which
inform them about location of @command{Imprimatur} Texinfo files. You
need to add this variable to your @samp{AM_MAKEINFOFLAGS} variable:
@example
AM_MAKEINFOFLAGS = @@IMPRIMATUR_MAKEINFOFLAGS@@
@end example
@end defvr
@defvr {Substitution Variable} RENDITION
Default rendition. You may need this variable to inform various tools
about the selected rendition level, e.g.:
@example
TEXI2DVI=texi2dvi -t '@@set $(RENDITION)'
@end example
Note, that @samp{IMPRIMATUR_MAKEINFOFLAGS} includes the option
@option{-D $(RENDITION)}, so you don't need to define it explicitly if
the tool in question uses this variable.
@end defvr
@node Macros
@chapter Texinfo Macros
@flindex rendition.texi
The file @file{rendition.texi} defines helper macros which serve to
annotate Texinfo sources. Expansion of these macros depends on the
rendition of the document.
@defmac WRITEME
Use this macro to mark the nodes which need to be written. Normally,
you would place it immediately after a sectioning command. When in
@samp{PUBLISH} rendition, this macro forces compilation error, because
one would hardly want empty nodes to appear in the published document.
Otherwise, it produces the following text:
@quotation
@example-WRITEME
@end quotation
@end defmac
@defmac UNREVISED
Use this macro to mark the nodes which need a revision. Normally,
you would place it immediately after a sectioning command.
This macro acts similarly to @samp{@@WRITEME}. When in
@samp{PUBLISH} rendition, it forces a compilation error. In
@samp{PROOF} and @samp{DISTRIB} renditions, it produces the following
expansion:
@quotation
@example-UNREVISED
@end quotation
@end defmac
@defmac FIXME (@var{text})
The @samp{@@FIXME} macro adds an editor's note to the file. The
argument @var{text} gives the content of the note.
The purpose of the note is to draw reviewer's attention to
something near this point of the document. It is of some importance
only to the author and reviewers of the document, so it produces
output only in @samp{PROOF} revision. Consider, for example, this
text:
@example
The @@option@{-I @@var@{DIR@}@} command line option adds a directory
to the program's search path. @@FIXME@{Document the initial value
of the search path.@}
@end example
In @samp{PROOF} rendition it would produce the following:
@quotation
The @option{-I @var{DIR}} command line option adds a directory to the
program's search path. @example-FIXME{Document the initial value of the
search path.}
@end quotation
@end defmac
The three macros below serve as placeholders for the corresponding
cross-reference commands:
@defmac FIXME-ref (@var{text})
Use this macro for @samp{@@ref}-style cross-references. In
@samp{PUBLISH} rendition it is entirely equivalent to
@code{@@ref@{@var{text}@}}.
@end defmac
@defmac FIXME-xref (@var{text})
Use this macro for @samp{@@xref}-style cross-references. In
@samp{PUBLISH} rendition it is equivalent to
@code{@@xref@{@var{text}@}}.
@end defmac
@defmac FIXME-pxref (@var{text})
Use this macro for @samp{@@pxref}-style cross-references. In
@samp{PUBLISH} rendition it is entirely equivalent to
@code{@@pxref@{@var{text}@}}.
@end defmac
@anchor{Dangling cross-reference}
Use one of these macros when you need to add a cross-reference to a node or
anchor which does not exist yet. They will create a @dfn{dangling reference}
which allows for translating Texinfo source without errors, and at the
same time serves a
|