-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathfixme.dtx
More file actions
4543 lines (4419 loc) · 170 KB
/
fixme.dtx
File metadata and controls
4543 lines (4419 loc) · 170 KB
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
% \iffalse
%
% fixme.dtx --- docTeX file for FiXme
%
% Copyright (C) 1998-2002, 2004-2007, 2009, 2013, 2017-2019 Didier Verna
%
% Author: Didier Verna <didier@didierverna.net>
%
% This file is part of FiXme.
%
% FiXme may be distributed and/or modified under the conditions of the LaTeX
% Project Public License, either version 1.3 of this license or (at your
% option) any later version. The latest version of this license is in
% http://www.latex-project.org/lppl.txt and version 1.3 or later is part of
% all distributions of LaTeX version 2005/12/01 or later.
%
% FiXme consists of the files listed in the file `README.md'.
%
%
% Commentary:
%
%
% Code:
%
%<*driver>
\documentclass[a4paper]{ltxdoc}
\usepackage{xspace}
\usepackage{dox}[2009/09/21]
\doxitem[idxtype=env.]{Env}{environment}{environments}
\doxitem[idxtype=opt.]{Option}{option}{options}
\doxitem[idxtype=cnt.]{Counter}{counter}{counters}
\doxitem[idxtype=lang.]{Lang}{lang}{languages}
\doxitem[idxtype=cond.]{Cond}{cond}{conditionals}
\doxitem{Face}{face}{faces}
\doxitem{Color}{color}{colors}
\doxitem[idxtype={note lt.}]{Layout}{layout}{note layouts}
\doxitem[idxtype={env. lt.}]{EnvLayout}{envlayout}{env. layouts}
\doxitem[idxtype={target lt.}]{TargetLayout}{targetlayout}{target layouts}
\doxitem{Theme}{theme}{themes}
% #### NOTE: I don't want to \usepackage{fixme} just for getting the file
% information. So here what I do: generate a header with only the
% \ProvidesPackage command, and also the \fixmelogo. Then, I \input it so that
% \GetFileInfo works. However, I need to manually set the current file name
% and extension that would normally be set by \RequirePackage. Also, note that
% the call to \GetFileInfo below needs to use the extension of the header,
% that is inc instead of sty, even the file fixme.inc does not really exist.
\makeatletter
\def\@currname{fixme}
\def\@currext{inc}
\makeatother
\input{header.inc}
% \OnlyDescription
\CodelineIndex
% \RecordChanges
\setcounter{secnumdepth}{4}
\begin{document}
\DocInput{fixme.dtx}
\end{document}
%</driver>
%
% \fi
%
% \CheckSum{1769}
% \GetFileInfo{fixme.inc}
%% \CharacterTable
%% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z
%% Lower-case \a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z
%% Digits \0\1\2\3\4\5\6\7\8\9
%% Exclamation \! Double quote \" Hash (number) \#
%% Dollar \$ Percent \% Ampersand \&
%% Acute accent \' Left paren \( Right paren \)
%% Asterisk \* Plus \+ Comma \,
%% Minus \- Point \. Solidus \/
%% Colon \: Semicolon \; Less than \<
%% Equals \= Greater than \> Question mark \?
%% Commercial at \@ Left bracket \[ Backslash \\
%% Right bracket \] Circumflex \^ Underscore \_
%% Grave accent \` Left brace \{ Vertical bar \|
%% Right brace \} Tilde \~}
%
% \MakeShortVerb{\|}
%
% \makeatletter
% \def\ps@mystyle{
% \def\@oddfoot{\hfil\thepage\hfil}
% \def\@evenfoot{\hfil\thepage\hfil}
% \def\@evenhead{\hfil\slshape\leftmark}
% \def\@oddhead{\slshape\rightmark\hfil}}
% \renewcommand\paragraph{\@startsection{paragraph}{4}{\z@}{%
% -3.25ex\@plus -1ex \@minus -.2ex}{%
% 1.5ex \@plus .2ex}{%
% \normalfont\normalsize\bfseries}}
% \makeatother
%
% \newcommand*\DescribeBooleanOption[1]{%
% {\let\oldpdo\PrintDescribeOption%
% \def\PrintDescribeOption##1{\oldpdo{[no]##1}}%
% \let\oldsoi\SpecialOptionIndex%
% \def\SpecialOptionIndex##1{\oldsoi{##1}\oldsoi{no##1}}%
% \DescribeOption{#1}}}
%
% \newenvironment{booleanoption}[1]{%
% \let\oldpon\PrintOptionName%
% \def\PrintOptionName##1{\oldpon{[no]##1}}%
% \let\oldsmoi\SpecialMainOptionIndex%
% \def\SpecialMainOptionIndex##1{\oldsmoi{##1}\oldsmoi{no##1}}%
% \begin{option}{#1}}{%
% \end{option}}
%
% ^^A Let's not depend on varioref for just that:
% \newcommand\sectionref[1]{\ref{#1} on page \pageref{#1}}
%
% \newcommand\etc{\textit{etc.}\xspace}
% \newcommand\vs{\textit{vs.}\xspace}
% \newcommand\ie{\textit{i.e.}\xspace}
% \newcommand\komascript{\textsc{Koma}-Script\xspace}
% \newcommand\auctex{AUC\TeX\xspace}
% \newcommand\emacs{\textsf{Emacs}\xspace}
%
% \newcommand\fx{\fixmelogo\xspace}
% \newcommand\packagecopyright{%
% Copyright \copyright{} 1998--2002, 2004--2007, 2009, 2013, 2017-2019 Didier Verna}
%
% \pagestyle{mystyle}
% \newcommand\fxmarkright{%
% \markright{\hskip-.5\marginparwidth \fx \fileversion{} (\filedate)}}
% \fxmarkright
%
% \date{\texttt{\fileversion{} (\filedate)}}
% \title{\fx{} -- Collaborative annotation tool for \LaTeX\footnote{%
% \fx homepage: %
% \texttt{http://www.lrde.epita.fr/\~{}didier/software/latex.php\#fixme}}}
% \author{Didier Verna\\
% \texttt{mailto:didier@didierverna.net}\\
% \texttt{http://www.lrde.epita.fr/\~{}didier/}}
% \maketitle
%
%
% \begin{abstract}
% \fx is a collaborative annotation tool for \LaTeX{} documents. Annotating
% a document here refers to inserting meta-notes, that is, notes that do not
% belong to the document itself, but rather to its development or reviewing
% process. Such notes may involve things of different importance levels,
% ranging from simple ``fix the spelling'' flags to critical ``this
% paragraph is a lie'' mentions. Annotations like this should be visible
% during the development or reviewing phase, but should normally disapear in
% the final version of the document.
%
% \fx is designed to ease and automate the process of managing collaborative
% annotations, by offering a set of predefined note levels and layouts, the
% possibility to register multiple authors, to reference annotations by
% listing and indexing \etc \fx is extensible, giving you the possibility to
% create new layouts or even complete ``themes'', and also comes with
% support for \auctex.
%
% The \fx package is \packagecopyright{}, and distributed under the
% terms of the LPPL license.
% \end{abstract}
%
% \tableofcontents
%
% \section{Installation}
% \subsection{Extraction}
% If you are building \fx from the tarball you need to execute the following
% steps in order to extract the necessary files. \fx also requires the
% \textsf{DoX} package (version 2.0, release date 2009/09/21 or later), to
% build. It is not required to use the package.
% \begin{verbatim}
% [pdf]latex fixme.ins
% [pdf]latex fixme.dtx
% [pdf]latex fixme.dtx
% makeindex -s gind fixme.idx
% [pdf]latex fixme.dtx
% [pdf]latex fixme.dtx
% \end{verbatim}
% After that, you need to install the generated documentation and style files
% to a location where \LaTeX{} can find them.
%
% \subsection{TDS-compliant layout}
% For a TDS-compliant layout, the following locations are suggested:
% \begin{verbatim}
% [TEXMF]/tex/latex/fixme/fixme.sty
% [TEXMF]/tex/latex/fixme/layouts/fxlayout*.sty
% [TEXMF]/tex/latex/fixme/layouts/env/fxenvlayout*.sty
% [TEXMF]/tex/latex/fixme/layouts/target/fxtargetlayout*.sty
% [TEXMF]/tex/latex/fixme/themes/fxtheme*.sty
% [TEXMF]/doc/latex/fixme/fixme.[pdf|dvi]
% \end{verbatim}
%
% \subsection{\auctex support}
% \auctex is a powerful major mode for editing \TeX{} documents in
% \emacs. In particular, it provides automatic completion of command names
% once they are known. \fx supports \auctex by providing a style file named
% \texttt{fixme.el} which contains \auctex definitions for the relevant
% commands. This file should be installed in a place where \auctex can find it
% (usually in a subdirectory of your \LaTeX{} styles directory). Please refer
% to the \auctex documentation for more information on this.
%
% \section{Features summary}
% If you're new to \fx, you might be interested in a brief summary of the
% features it provides. Otherwise, you may only take a look at the History
% section (section \sectionref{sec:manual:history}) to see what's new.
% \subparagraph{Annotation levels} \fx annotations may be of four different
% importance levels, ranging from simple not-so-important notices to critical
% things that must absolutely be fixed in the final version.
% \subparagraph{Layouts and themes} \fx gives you full and extensible control
% on the layout of these annotations: they can be displayed inline, as
% marginal paragraphs, as footnotes and also in any kind of user-defined way.
% All these ``layouts'' may be combined together. \fx also comes with support
% for ``themes'', globally modifying existing layouts, or providing new ones.
% \subparagraph{Annotation targets} Annotations may be ``targeted'' to a
% specific portion of text that will be highlighted, and on the contrary
% ``floating'' around, in which case they may even appear in the document's
% preamble.
% \subparagraph{Listing and indexing} Annotations may be indexed and
% summarized in a ``list of fixmes''.
% \subparagraph{Logging} Annotations are recorded in the log file, and
% (depending on their importance level) some of them are displayed on the
% terminal during compilation. A final summary is also created at the end of
% the compilation process.
% \subparagraph{Modes} All these features are actually available when you're
% working in \texttt{draft} mode. In \texttt{final} mode, the behavior is
% slightly different: any remaining critical note generates an error (the
% compilation aborts), while non critical ones are just removed from the
% document's body (they're still recorded in the log file though).
% \subparagraph{Authoring} \fx provides support for collaborative annotating
% by allowing you to ``register'' several authors.
% \subparagraph{Internationalization} \fx currently supports 7 different
% languages and features automatic language tracking for multilingual
% documents.
%
% \section{Using \fx}
% \subsection{Initialization}
% \subsubsection{Requirements}
% In order to work properly, \fx requires the presence of some \LaTeX{}
% packages. You don't have to load them explicitly though. As long as
% \LaTeX{} can locate them, they will be used automatically. \fx currently
% depends on \texttt{xspace}, \texttt{ifthen}, \texttt{verbatim} and
% \texttt{xkeyval} (version 2.5f, release date 2006/11/18 or later).
%
% \subsubsection{Loading the package}
% In order to load \fx, simply say |\usepackage[|\meta{options}|]{fixme}|
% in the preamble of your document. There is an important number of options
% that you can use in order to customize \fx's default or global behavior.
% These options will be discussed when appropriate.
%
% There might be times where you would like to use \LaTeX{} commands in
% package options (for example, see section \sectionref{sec:manual:faces}). In
% such a case, you should know that \LaTeX{} normally can't handle this. In
% order to make it work, you need to use the \texttt{xkvltxp} package first,
% like this:
% \begin{verbatim}
% \usepackage{xkvltxp}
% \usepackage[myoption=\mymacro]{fixme}
% \end{verbatim}
%
% \subsubsection{Global setup modification}
% \DescribeMacro{\fxsetup}\marg{options}\\
% Another way of customizing \fx's global behavior is to use the
% \cs{fxsetup} command. \cs{fxsetup} understands the same options as the
% package itself and can be used in the preamble as well as in the document's
% body.
%
% \subsubsection{Local setup modification}
% Finally, note that unless specified otherwise, all package options are also
% understood by the annotation commands or environments described in
% section \sectionref{sec:manual:insertion}. The effect is then local to that
% particular command.
%
% \subsection{Inserting \fx notes\label{sec:manual:insertion}}
% \subsubsection{Commands}
% \DescribeMacro{\fxnote}
% \DescribeMacro{\fxwarning}
% \DescribeMacro{\fxerror}
% \DescribeMacro{\fxfatal}\oarg{options}\marg{note}\\
% \fx provides four annotation commands corresponding to different
% levels of importance (notes, warnings, errors and fatal errors).
% \cs{fxfatal} is a bit different from the other ones, as will be explained in
% section \sectionref{sec:manual:behavior}.\par
% \begin{quotation}\itshape
% \DescribeMacro{\fixme}
% \textbf{Warning:} as of version 4, the \cs{fixme} command is a synonym for
% \cs{fxfatal} and is considered deprecated.
% \end{quotation}
%
% \subsubsection{Targeted commands}
% \DescribeMacro{\fxnote*}
% \DescribeMacro{\fxwarning*}
% \DescribeMacro{\fxerror*}
% \DescribeMacro{\fxfatal*}\oarg{options}\marg{note}\marg{text}\\
% Sometimes, you might not only want to issue a \fx note, but also highlight
% the relevant part of the text to which it applies. This is what I call
% ``targeting'' the annotation. As of version 4, \fx provides starred versions
% of its annotation commands to do that. In star form, these commands expect
% an additional mandatory argument containing the text to be highlighted.
%
% \subsubsection{Environments}
% \begin{quotation}\itshape
% \textbf{Warning:} as of version 4.0, the environment interface has changed
% and is \emph{not} backward-compatible.
% \end{quotation}
% \DescribeEnv{anfxnote}
% \DescribeEnv{anfxwarning}
% \DescribeEnv{anfxerror}
% \DescribeEnv{anfxfatal}\oarg{options}\marg{summary}\\
% \fx annotations are normally meant to be short: consider that they are
% likely to go in the list of fixmes and in the index for instance. If you
% feel the need for writing longer comments, the environments described below
% might come in handy. \fx provides four annotation environments; one for
% every note level. These environments take one mandatory argument (meant to
% be a short summary of the long note) and behave in exactly the same way as
% their command counterpart. The layout policy is a bit different though (see
% section \sectionref{sec:manual:layout}): the environment's contents will
% always appear inline, and the \meta{summary} will obey all active annotation
% layouts except for the \texttt{inline} one, just as if it had been passed to
% one of the \fx annotation commands described in the previous section.
% \begin{quotation}\itshape
% \DescribeEnv{afixme}
% \textbf{Warning:} as of version 4, the \texttt{afixme} environement is a
% synonym for \texttt{anfxfatal}, and is considered deprecated.
% \end{quotation}
%
%
%
% \subsubsection{Targeted environments}
% \DescribeEnv{anfxnote*}
% \DescribeEnv{anfxwarning*}
% \DescribeEnv{anfxerror*}
% \DescribeEnv{anfxfatal*}\oarg{options}\marg{summary}\marg{text}\\
% \fx environments can also be targeted to a specific portion of text. When
% using the starred version, the environments expect one additional mandatory
% argument: the text in question that will be highlighted.
%
% \subsection{List of \fx's\label{sec:manual:lox}}
% \DescribeMacro{\listoffixmes}
% \fx remembers where you put your annotations in a toc-like file whose
% extension is \texttt{lox}. The \cs{listoffixmes} command generates the
% annotations lists in a manner similar to that of the ``list of figures''. A
% standard layout is automatically selected for the \texttt{article},
% \texttt{report} and \texttt{book} classes and the AMS ones. If loaded, \fx
% will also use the \texttt{tocbasic} package which makes it compliant with
% the \komascript classes and any other document using it. If another class
% is used, the \texttt{article} layout is selected. Also, note that if there
% isn't any annotation left in the document, this command doesn't generate an
% empty list, but rather stays silent. It also stays silent in \texttt{final}
% mode, regardless of the presence of remaining annotations (see
% section \sectionref{sec:manual:behavior}).
%
% \subsection{Controlling the behavior of \fx\label{sec:manual:behavior}}
% \DescribeOption{final}
% \DescribeOption{draft}
% The behavior of \fx is controlled by the two standard options
% \texttt{final} and \texttt{draft}. These options are usually given to
% \cs{documentclass} which in turn passes them to all packages. In addition,
% you can also use them as options to \cs{usepackage}, in the call to
% \cs{fxsetup}, and even to the annotation commands and environments.
%
% In \texttt{draft} mode, annotations are recorded in the log file and appear
% in the document as specified by the layout settings (see section
% \sectionref{sec:manual:layout}). Additionally, warnings, errors and fatal
% errors are also displayed on the terminal.
%
% In final mode, non fatal annotations (those generated by \cs{fxnote},
% \cs{fxwarning}, \cs{fxerror} and their corresponding environments) are still
% logged, but they're not typeset. On the other hand, fatal ones (those
% generated by the \cs{fxfatal} command and the \texttt{anfxfatal}
% environment) will throw a \LaTeX{} error and thus interrupt or abort
% compilation with an informative message. This will help you track down
% forgotten important caveats in your document.
%
% Let me rephrase: final documents can only have \fx notes, warnings, and (non
% fatal) errors left. Of course, this is not completely true: remember that
% these options are understood locally by all the annotation commands and
% environments, so even in \texttt{final} mode, you can use something like
% this:
% \begin{verbatim}
% \fxfatal[draft]{bla bla}
% \end{verbatim}
%
% \DescribeOption{status}
% By default, \fx is in \texttt{final} mode (\LaTeX{} itself behaves that
% way). If you're manipulating the document status at the level of \fx
% itself (as opposed to the \cs{documentclass} level), then the preferred way
% to do this is to use the \texttt{status} option, and give it the value
% \texttt{final} or \texttt{draft}.
%
% \subsection{Controlling the layout of annotations\label{sec:manual:layout}}
% Annotations can appear in several forms in your document. Each of these
% forms can be individually selected, or they can be combined together to some
% extend.
%
% \subsubsection{Selecting a layout}
% \paragraph{Individual control}
% For each annotation layout, there is a corresponding boolean option (for
% instance, the ``inline'' layout is controlled by the \texttt{inline}
% option). These options are understood by the package itself, the
% \cs{fxsetup} command and also locally by every annotation command or
% environment. There are some restrictions on their usage however, as
% discussed in the next section.
%
% To activate a layout, use the option alone or give it a value of
% \texttt{true}. For instance, these two forms are equivalent:
% \begin{verbatim}
% \fxnote[inline]{note...}
% \fxnote[inline=true]{note...}
% \end{verbatim}
% For convenience, each layout option has a counterpart that deactivates the
% corresponding layout. The counterpart option has the same name, prefixed
% with \texttt{no} (for instance, \texttt{noinline}). Again, these options are
% understood by the package itself, the \cs{fxsetup} command and also locally
% by every annotation command or environment (with the same usage
% restrictions, discussed in the next section). For instance, these two forms
% are equivalent:
% \begin{verbatim}
% \fxsetup{inline=false}
% \fxsetup{noinline}
% \end{verbatim}
%
% \paragraph{Global control}
% \DescribeOption{layout}
% \DescribeOption{morelayout}
% An even more convenient way to specify the required layout is to use the
% \texttt{layout} and \texttt{morelayout} options. In fact, the use of
% individual control is considered more or less deprecated. Both of these
% options take a comma-separated list of the individual options described
% above (this includes the \texttt{no}\meta{option} form as well).
%
% While the \texttt{morelayout} option \emph{adds} to the current layout
% configuration, the \texttt{layout} one completely overrides it. For
% instance, knowing that by default, only the \texttt{margin} layout is
% active, the following forms are all equivalent:
% \begin{verbatim}
% \usepackage[nomargin,inline,index]{fixme}
% \usepackage[margin=false,inline=true,index=true]{fixme}
% \usepackage[morelayout={nomargin,inline,index}]{fixme}
% \usepackage[layout={inline,index}]{fixme}
% \end{verbatim}
% Again, these two options are understood by the package itself, the
% \cs{fxsetup} command and also locally by every annotation command or
% environment (with the same usage restrictions, discussed in the next
% section).
%
% \noindent\DescribeMacro{\fxuselayouts}\marg{name,\ldots}\\
% Finally, an alternative way of selecting (or deselecting) several layouts
% simultaneously is to use the \cs{fxuselayouts} command, giving it a
% comma-separated list of layout options as its only, mandatory, argument.
%
% \subsubsection{Built-in \vs external layouts}
% Annotation layouts are provided either in the core of \fx, or in separate
% files loaded dynamically on demand. Simple layouts are typically built-in,
% whereas those requiring additional packages are external, so that they don't
% consume \TeX{} resources if not used. As a consequence, selecting an
% external layout might involve loading the relevant file first.
%
% For technical reasons, it is not possible to do such a thing outside the
% preamble, neither in the middle of processing \cs{usepackage} options. As a
% result, layout options are restricted and you have three possibilities for
% using an external layout:
% \begin{enumerate}
% \item Use its corresponding option in a call to \cs{fxsetup} in the
% preamble, like this: |\fxsetup{|\meta{option}|}|. This will load it
% \emph{and} select it immediately.
% \item Use the \cs{fxuselayouts} command in the preamble like this:\\
% |\fxuselayouts{|\meta{name}|}|. This is strictly equivalent to the
% previous solution.
% \end{enumerate}
% \DescribeMacro{\fxloadlayouts}\marg{name,\ldots}
% \begin{enumerate}
% \item[3]
% If on the other hand you want to load one or several external layouts
% \emph{without} using them immediately (perhaps in order to use them
% locally in some specific annotation), use the \cs{fxloadlayouts} command
% in the preamble like this: |\fxloadlayouts{|\meta{name}|,...}|. After
% that, you can select any of those layouts anywhere you wish.
% \end{enumerate}
%
% \subsubsection{Available layouts}
% \DescribeBooleanOption{inline}
% \DescribeBooleanOption{margin}
% \DescribeBooleanOption{footnote}
% \DescribeBooleanOption{index}
% \DescribeLayout[noprint]{inline}
% \DescribeLayout[noprint]{margin}
% \DescribeLayout[noprint]{footnote}
% \DescribeLayout[noprint]{index}
% Table \ref{table:layouts} lists the annotation layouts currently distributed
% with \fx. By default, only the \texttt{margin} layout is active. Most of
% these layouts should be self-explanatory, but some precisions are given
% below.
% \begin{table}
% \centering
% \DeleteShortVerb{\|}
% \begin{tabular}{|l|c|p{7cm}|}
% \hline
% \textbf{Name} & \textbf{External} & \textbf{Description}\\
% \hline\hline
% \texttt{inline} & & Display note inline\\
% \texttt{margin} & & Display note in the margin\\
% \texttt{footnote} & & Display note in a footnote\\
% \texttt{index} & & Display note in the index\\
% \texttt{marginclue} & & Display a marginal clue\\
% \texttt{marginnote} & \texttt{*} & Display non-floating note in the
% margin\\
% \texttt{pdfnote} & \texttt{*} & Display note as inline PDF comment\\
% \texttt{pdfmargin} & \texttt{*} & Display note as marginal PDF
% comment\\
% \texttt{pdfsignote} & \texttt{*} & Display signed note ala
% \texttt{pdfnote}\\
% \texttt{pdfsigmargin} & \texttt{*} & Display signed note ala
% \texttt{pdfmargin}\\
% \texttt{pdfcnote} & \texttt{*} & Display colored note ala
% \texttt{pdfnote}\\
% \texttt{pdfcmargin} & \texttt{*} & Display colored note ala
% \texttt{pdfmargin}\\
% \texttt{pdfcsignote} & \texttt{*} & Display colored note ala
% \texttt{pdfcsignote}\\
% \texttt{pdfcsigmargin} & \texttt{*} & Display colored note ala
% \texttt{pdfsigmargin}\\
% \hline
% \end{tabular}
% \MakeShortVerb{\|}
% \caption{Available annotation layouts}
% \label{table:layouts}
% \end{table}
% \paragraph{\texttt{marginclue}}
% \DescribeBooleanOption{marginclue}
% \DescribeLayout[noprint]{marginclue}
% If your preferred layout is \texttt{inline} or say, \texttt{footnote}, it
% might be somewhat difficult to localize the annotation on the page,
% especially its vertical position. That's where marginal clues come into
% play. A marginal clue does not display the annotation's contents, but only
% an indication that there is one at that (vertical) position. So you need to
% use another layout as well (again, typically \texttt{inline} or
% \texttt{footnote}) in order to get the actual annotation.
%
% Obviously, the margin and margin clue layouts are mutually exclusive, so if
% you try to activate both, only the most recently activated one will be
% enabled (and you'll get a notice in the log file and on the terminal).
%
% \paragraph{\texttt{marginnote}}\label{sec:manual:marginnote}
% \DescribeBooleanOption{marginnote}
% \DescribeLayout[noprint]{marginnote}
% The \texttt{marginnote} layout is an alternate (external) way to display
% annotations in the margin, using the eponymous package. Contrary to \LaTeX's
% standard marginal paragraphs, the ones issued by \texttt{marginnote} are
% constructed in a non-floating way. This might be an advantage in some
% situations but \texttt{marginnote} also comes with some disadvantages of its
% own. For more information, please refer to \texttt{marginnote}'s
% documentation, and also read the next section. Also, note that it is not
% currently possible to pass options to the \cs{marginnote} command through
% this layout.
%
% For a reasonably robust marginal layout accross all annotations, including
% those issued in floats, consider using \texttt{marginnote} in conjunction
% with \texttt{innerlayout=noinline} (see
% section \sectionref{sec:manual:inner}).
%
% \paragraph{PDF comments}
% \DescribeBooleanOption{pdfnote}
% \DescribeLayout[noprint]{pdfnote}
% \DescribeBooleanOption{pdfmargin}
% \DescribeLayout[noprint]{pdfmargin}
% \DescribeBooleanOption{pdfsignote}
% \DescribeLayout[noprint]{pdfsignote}
% \DescribeBooleanOption{pdfsigmargin}
% \DescribeLayout[noprint]{pdfsigmargin}
% \DescribeBooleanOption{pdfcnote}
% \DescribeLayout[noprint]{pdfcnote}
% \DescribeBooleanOption{pdfcmargin}
% \DescribeLayout[noprint]{pdfcmargin}
% \DescribeBooleanOption{pdfcsignote}
% \DescribeLayout[noprint]{pdfcsignote}
% \DescribeBooleanOption{pdfcsigmargin}
% \DescribeLayout[noprint]{pdfcsigmargin}
% The PDF format comes with a concept of \emph{comment}, which \fx can use to
% display its own annotations. Support for PDF comments varies across PDF
% viewers. Acrobat Reader is usually considered a reference, and MacOS X's
% Preview supports them reasonably well. The \texttt{pdfnote} and
% \texttt{pdfmargin} layouts use the \texttt{pdfcomment} package to display
% annotations as PDF inline or marginal comments.
%
% The \texttt{sig} versions additionally display the author's tag (see
% \sectionref{sec:manual:modes}) as a signature instead of as a prefix.
%
% The versions with a \texttt{c} in their name (as in \textbf{c}olor) use one
% of four different colors named \texttt{fx}\meta{level} (according to the
% annotation's importance level). They also avoid printing the annotation's
% level since this information is already conveyed by the color.
%
% \subsubsection{Inner layout}\label{sec:manual:inner}
% There might be various reasons for you to change the layout locally for one
% particular annotation: creating a floating one is an example, see also
% section \sectionref{sec:manual:othercommonproblems} for some others. One
% frequent reason (described below) can be handled automatically by \fx.
%
% Remember that the default layout is to use margin paragraphs. Unfortunately,
% margin paragraphs are forbidden by \TeX{} in several situations, like a
% figure's caption for instance. If you try that, you will get a cryptic ``Not
% in outer par mode'' error message.
%
% \DescribeOption{innerlayout}
% The good news is that this situation can be detected automatically. \fx
% provides an option named \texttt{innerlayout} that allows you to specify an
% alternative layout setting to use when \TeX{} is in \emph{inner} mode. In
% addition to that, \fx automatically disables the \texttt{margin} and
% \texttt{marginclue} layouts. If you really want to use marginal paragraphs
% in inner mode, a good idea is then to set your inner layout to
% \texttt{marginnote} (see section \ref{sec:manual:marginnote}).
%
% Using \texttt{innerlayout} is not as trivial as it may seem: it
% \emph{really} is an alternative layout configuration, and as such, you can
% use any combination you like of individual layout options, or you can even
% use the \texttt{layout} and \texttt{morelayout} options. This means that
% your alternative layout can either \emph{add} to the existing one, or
% \emph{override} it. Here are some examples to clarify things a little. You
% should try to understand them.
% \begin{itemize}
% \item By default, the \fx inner layout is set to just \texttt{inline}.
% This can be simulated by the following call:
% \begin{verbatim}
% \usepackage[layout=margin,innerlayout={layout=inline}]{fixme}
% \end{verbatim}
% \item The following happens to give the same result in our particular case,
% while having a different semantics:
% \begin{verbatim}
% \usepackage[layout=margin,innerlayout=inline]{fixme}
% \end{verbatim}
% \item If you have set \fx to use a safe layout globally (for instance,
% \texttt{inline} and \texttt{index}), and you want to use the same layout
% in inner mode, then you should provide an \emph{empty} inner layout, like
% this:
% \begin{verbatim}
% \fxsetup{layout={inline,index},innerlayout=}
% \end{verbatim}
% What would happen if you didn't provide the \texttt{innerlayout} option?
% \end{itemize}
%
% One final remark on the \texttt{innerlayout} option: this option is not
% processed immediately when you specify it, but instead, its value is stored
% and used only when needed. As a result, if you plan to use an external
% layout in inner mode (typically, \texttt{marginnote})~, you need to load it
% explicitely in the preamble first. Use \cs{fxloadlayouts} for that.
%
% \subsubsection{Other common layout
% problems\label{sec:manual:othercommonproblems}}
% This section describes some other common problems that people have
% encountered using \fx. Although \fx might not be directly responsible
% for them, it is still good to keep them in mind.
%
% \subparagraph{Annotations in captions being counted twice} You are most
% likely using \cs{listofsomething} (figure, table, or any other kind of
% float). Note that a caption will be used twice here: once in the float
% itself, and once in the list of floats. Any \fx annotation in the caption
% will consequently be generated twice as well. The solution to this problem
% is to use the optional argument to \cs{caption}, for example:
% \begin{verbatim}
% \caption[caption text]{caption text\fxnote{yuck!}}
% \end{verbatim}
%
% \subparagraph{Footnotes and margin paragraphs in floats} Using footnotes in
% figures (and \emph{a fortiori} in a figure's caption) does not work in
% general. Although there are some workarounds out there (for instance, using
% \cs{footnotemark} and \cs{footnotetext} directly), there is no completely
% reliable solution and it is not possible to detect that situation
% automatically. Similarly, marginal paragraphs will cause problems in a
% figure (even when not in its caption) because floats can't be nested in
% \LaTeX. Usual symptoms of these situations are: a footnote not being
% typeset, compilation breakage with the ``Floats lost'' message \etc If
% you're facing this problem, you need to change your layout locally.
%
% \subparagraph{Marginal paragraphs showing up on the wrong margin} You want
% to look at the \texttt{mparhack} package.
%
% \subparagraph{ACM classes compatibility} The ACM \textsc{Sig} classes
% (\texttt{acm\_proc\_article-sp} and \texttt{sig-alternate}) forbid the use
% of \cs{marginpar}, so if you use these classes, don't forget to choose
% another layout for \fx, and also avoid using marginal clues.
%
% \subparagraph{Annotation indexing}
% Remember that some characters are special in an index entry (the \texttt{!}
% for instance). \fx currently does nothing to escape those characters, so
% avoid using them in your annotations.
%
% \subsection{Corollary: floating annotations}
% At some point, people suggested that it would be nice to have global
% annotations, not related to any portion of the text in particular. Such
% annotations could be general comments about the whole document, and could
% even be issued in the preamble. This is what I call ``floating''
% annotations.
%
% I know you don't care, but originally, I started writing a new set of
% commands to do just that. However, with the flexibility that \fx 4.0
% provides, I quickly realized that such commands were an unnecessary
% addition.
%
% Since floating anotations are not supposed to relate to any part of the
% text, they should not be typeset anywhere in it. This is especially true if
% you want to put some of them in the document's preamble. However, even a
% preamble annotation could be recorded and displayed in the index or in the
% list of fixmes. And it turns out that you can specify all that with the
% layout options described in section \sectionref{sec:manual:layout}.
%
% \DescribeOption{target}
% The only remaining problem is the page number, which normally appears in the
% list of fixmes and in the index: if you choose to reference a floating
% annotation that way, the page number is likely to be completely meaningless.
% To compensate, a new option named \texttt{target} is provided. When used,
% the given value will replace the page number in both the index and the list
% of fixmes. The target can be anything you like, but should remain rather
% short. By default, \texttt{target} is set the special value
% \texttt{thepage}, which as you guessed means to use the page number.
%
% The name "target" bears an intentional resemblance to \fx's targeted
% commands and environments, because we are indeed targetting the annotation
% to something. The only difference is that in the case of floating
% annotations, the target is non-textual.
%
% Here is an example of a floating annotation that would typically appear in
% the document's preamble:
% \begin{verbatim}
% \usepackage{hyperref}
% \fxfatal[layout=index,target=hyperref]{Fill in PDF fields (title etc.)}
% \end{verbatim}
%
% \subsection{Controlling the layout of
% environments\label{sec:manual:envlayoutcontrol}}
% As discussed in section \sectionref{sec:manual:insertion}, the contents of a
% \fx environment (a longer annotation) always appears inline. However, the
% exact way this contents is typeset (in draft mode only) is subject to a
% layout of its own, called the ``environment layout''.
%
% \subsubsection{Selecting a layout}
% \DescribeOption{envlayout}
% The desired environment layout can be selected with the \texttt{envlayout}
% option. Contrary to the annotation layouts, only one environment layout can
% be active at a time. The \texttt{envlayout} option is understood by the
% package itself, the \cs{fxsetup} command and all the annotation environments
% (not the commands!). There are some restrictions on its usage however, as
% discussed in the next section.
%
% \noindent\DescribeMacro{\fxuseenvlayout}\marg{name}\\
% An alternative way of selecting an environment layout is to use the
% \cs{fxuseenvlayout} command, giving it the layout's name as its only,
% mandatory, argument.
%
% \subsubsection{Built-in \vs external layouts}
% Environments layouts are provided either in the core of \fx, or in separate
% files loaded dynamically on demand. Simple layouts are typically built-in,
% whereas those requiring additional packages are external, so that they don't
% consume \TeX{} resources if not used. As a consequence, selecting an
% external layout with the \texttt{envlayout} option might involve loading the
% relevant file first.
%
% \noindent\DescribeMacro{\fxloadenvlayouts}\marg{name,\ldots}\\
% For technical reasons, it is not possible to do such a thing outside the
% preamble, neither in the middle of processing \cs{usepackage} options. As a
% result, the \texttt{envlayout} option is restricted and you have three
% possibilities for using an external layout:
% \begin{enumerate}
% \item Use the \texttt{envlayout} option in a call to \cs{fxsetup} in the
% preamble, like this: |\fxsetup{envlayout=name}|. This will load it
% \emph{and} select it immediately.
% \item Use the \cs{fxuseenvlayout} command in the preamble like this:\\
% |\fxuseenvlayout{name}|. This is strictly equivalent to the previous
% solution.
% \item If on the other hand you want to load one or several environment
% layouts \emph{without} using them immediately (perhaps in order to use
% them locally in some specific annotation), use the \cs{fxloadenvlayouts}
% command in the preamble like this: |\fxloadenvlayouts{|\meta{name}|,...}|.
% After that, you can select any of those layouts anywhere you wish.
% \end{enumerate}
%
% \subsubsection{Available layouts\label{sec:manual:envlayoutslist}}
% Table \ref{table:envlayouts} lists the environment layouts currently
% distributed with \fx.
% \begin{itemize}
% \item \DescribeEnvLayout{plain}
% The \texttt{plain} environment layout prints its contents as-is, only
% in bold font (by default) in order to distinguish it from the surrounding
% text.
% \item \DescribeEnvLayout{signature}
% The \texttt{signature} environment layout prints the author's tag (see
% \sectionref{sec:manual:modes}) as a signature instead of as a prefix. This
% layout is used by the \texttt{signature} theme (see section
% \sectionref{sec:manual:themes}).
% \item \DescribeEnvLayout{color}
% \DescribeColor{fxnote}
% \DescribeColor{fxwarning}
% \DescribeColor{fxerror}
% \DescribeColor{fxfatal}
% The \texttt{color} environment layout uses one of four colors named
% \texttt{fx}\meta{level} (according to the annotation's importance level)
% to display its contents. It also avoids printing the annotation level,
% since that information is already conveyed by the color. This layout is
% used by the \texttt{color} theme (see section
% \sectionref{sec:manual:themes}).
% \item \DescribeEnvLayout{colorsig}
% The \texttt{colorsig} environment layout combines the features of the
% \texttt{signature} and \texttt{color} ones. This layout is used by the
% \texttt{colorsig} theme (see section \sectionref{sec:manual:themes}).
% \end{itemize}
% \begin{table}
% \centering
% \DeleteShortVerb{\|}
% \begin{tabular}{|l|c|p{7cm}|}
% \hline
% \textbf{Name} & \textbf{External} & \textbf{Description}\\
% \hline\hline
% \texttt{plain} & & Display contents as-is\\
% \texttt{signature} & & Display signed contents\\
% \texttt{color} & \texttt{*} & Display contents in color\\
% \texttt{colorsig} & \texttt{*} & Display signed contents in color\\
% \hline
% \end{tabular}
% \MakeShortVerb{\|}
% \caption{Available environment layouts}
% \label{table:envlayouts}
% \end{table}
%
% \subsection{Controlling the layout of
% targets\label{sec:manual:targetlayoutcontrol}}
% As discussed in section \sectionref{sec:manual:insertion}, the starred
% versions of the \fx annotation commands and environments let you highlight a
% portion of text which is relevant to the current annotation. The exact way
% this textual target is typeset (in draft mode only; otherwise it is typeset
% as-is) is subject to a layout of its own, called the ``target layout''.
%
% \subsubsection{Selecting a layout}
% \DescribeOption{targetlayout}
% The desired layout can be selected with the \texttt{targetlayout} option.
% Contrary to the annotation layouts, only one target layout can be active at
% a time. The \texttt{targetlayout} option is understood by the package
% itself, the \cs{fxsetup} command and all the starred versions of the
% annotation commands and environments. There are some restrictions on its
% usage however, as discussed in the next section.
%
% \noindent\DescribeMacro{\fxusetargetlayout}\marg{name}\\
% An alternative way of selecting a target layout is to use the
% \cs{fxusetargetlayout} command, giving it the layout's name as its only,
% mandatory, argument.
%
% \subsubsection{Built-in \vs external layouts}
% Target layouts are provided either in the core of \fx, or in separate files
% loaded dynamically on demand. Simple layouts are typically built-in, whereas
% those requiring additional packages are external, so that they don't consume
% \TeX{} resources if not used. As a consequence, selecting an external layout
% with the \texttt{targetlayout} option might involve loading the relevant
% file first.
%
% \noindent\DescribeMacro{\fxloadtargetlayouts}\marg{name,\ldots}\\
% For technical reasons, it is not possible to do such a thing outside the
% preamble, neither in the middle of processing \cs{usepackage} options. As a
% result, the \texttt{targetlayout} option is restricted and you have two
% possibilities for using an external layout:
% \begin{enumerate}
% \item Use the \texttt{targetlayout} option in a call to \cs{fxsetup} in the
% preamble, like this: |\fxsetup{targetlayout=name}|. This will load it
% \emph{and} select it immediately.
% \item Use the \cs{fxusetargetlayout} command in the preamble like this:\\
% |\fxusetargetlayout{name}|. This is strictly equivalent to the previous
% solution.
% \item If on the other hand you want to load one or several target layouts
% \emph{without} using them immediately (perhaps in order to use them
% locally in some specific annotation), use the \cs{fxloadtargetlayouts}
% command in the preamble like this:
% |\fxloadtargetlayouts{|\meta{name}|,...}|. After that, you can select any
% of those layouts anywhere you wish.
% \end{enumerate}
%
% \subsubsection{Available layouts\label{sec:manual:targetlayoutslist}}
% Table \ref{table:targetlayouts} lists the target layouts currently
% distributed with \fx.
% \begin{itemize}
% \item \DescribeTargetLayout{plain}
% The \texttt{plain} target layout displays its contents as-is, only in
% italics (by default) in order to distinguish it from the surrounding text.
% \item \DescribeTargetLayout{changebar}
% The \texttt{changebar} target layout displays a vertical bar in the
% margin, on the side of the target text.
% \item \DescribeTargetLayout{color}
% \DescribeColor{fxtarget}
% The \texttt{color} target layout uses the color named \texttt{fxtarget}
% to display the target text. This layout is used by the \texttt{color}
% and \texttt{colorsig} themes (see section \sectionref{sec:manual:themes}).
% \item \DescribeTargetLayout{colorcb}
% \DescribeColor{fxnote}
% \DescribeColor{fxwarning}
% \DescribeColor{fxerror}
% \DescribeColor{fxfatal}
% The \texttt{colorcb} target layout uses one of four colors named
% \texttt{fx}\meta{level} (according to the annotation's importance
% level) to display a colored vertical bar in the margin, on the side of the
% target text.
% \end{itemize}
% \begin{table}
% \centering
% \DeleteShortVerb{\|}
% \begin{tabular}{|l|c|p{7cm}|}
% \hline
% \textbf{Name} & \textbf{External} & \textbf{Description}\\
% \hline\hline
% \texttt{plain} & & Display target as-is\\
% \texttt{changebar} & \texttt{*} & Display a vertical bar aside target\\
% \texttt{color} & \texttt{*} & Display target in color\\
% \texttt{colorcb} & \texttt{*} & Display a colored vertical bar aside
% target\\
% \hline
% \end{tabular}
% \caption{Available target layouts}
% \label{table:targetlayouts}
% \MakeShortVerb{\|}
% \end{table}
%
% \subsection{Faces\label{sec:manual:faces}}
% In the \fx jargon, a ``face'' characterizes the visual aspect of some
% portion of text. If you're familiar with the \emacs editor, this will come
% as no surprise to you. \fx provides several faces that allow you to further
% customize the layout of annotations or their targets.
%
% \subsubsection{Setting face values}
% There are different ways to customize a face. The first one is to use the
% corresponding face option. For each face \meta{name}, their is a
% \meta{name}\texttt{face} option. For instance, the ``inline'' face is
% controlled by the \texttt{inlineface} option. Face options are
% understood by the package itself, the \cs{fxsetup} command and locally by
% all annotation commands or environments. Here is an example:
% \begin{verbatim}
% \fxsetup{inlineface=\bfseries}
% \end{verbatim}
%
% Since you will probably want to use \LaTeX{} commands in face values, you
% should know that \LaTeX{} normally can't handle such commands in package
% options. If you want this to work, you need to use the \texttt{xkvltxp}
% package first, like this:
% \begin{verbatim}
% \usepackage{xkvltxp}
% \usepackage[inlineface=\bfseries]{fixme}
% \end{verbatim}
%
% \noindent\DescribeMacro{\fxsetface}\marg{name}\marg{value}\\
% Another way to customize a face is to use the \cs{fxsetface} command by
% providing the face name and the face value as two mandatory arguments. For
% example:
% \begin{verbatim}
% \fxsetface{inline}{\bfseries}
% \end{verbatim}
%
% \subsubsection{Available faces}
% \subparagraph{The \texttt{inline} face}
% \DescribeFace{inline}
% By default, the \texttt{inline} annotation layout displays its contents in
% bold font, to distinguish the note from the surrounding text. This is
% controlled by the \texttt{inline} face whose value is \cs{bfseries} by
% default.
%
% \subparagraph{The \texttt{margin} face}
% \DescribeFace{margin}
% By default, the \texttt{margin} and \texttt{marginclue} layouts display
% their contents in footnote size. This is controlled by the \texttt{margin}
% face whose value is \cs{footnotesize} by default.
%
% \subparagraph{The \texttt{env} face}
% \DescribeFace{env}
% By default, the \texttt{plain} environment layout displays its contents in
% bold font, to distinguish it from the surrounding text. This is controlled
% by the \texttt{env} face whose value is \cs{bfseries} by default. The
% \texttt{color} and \texttt{colorsig} environment layouts honor this face as
% well, but reset it to \meta{nothing} first. You should probably keep the
% same value for the \texttt{inline} and \texttt{env} faces, since they are
% both used to display annotations within the document's body.
%
% \subparagraph{The \texttt{signature} face}
% \DescribeFace{signature}
% The \texttt{signature} environment layout honors the \texttt{env} face, and
% adds a \texttt{signature} face on top of it for the signature part. It is
% set to \cs{itshape} by default. The \texttt{colorsig} environment layout
% honors this face as well.
%
% \subparagraph{The \texttt{target} face}
% \DescribeFace{target}
% By default, the \texttt{plain} target layout displays its contents in
% italics, to distinguish it from the surrounding text. This is controlled by
% the \texttt{target} face whose value is \cs{itshape} by default. The
% \texttt{changebar}, \texttt{color} and \texttt{colorcb} target layouts honor
% this face as well, but reset it to \meta{nothing} first.
%
% \subsection{Controlling the logging of annotations}
% As well as being displayed in the document itself, all annotations are
% ``logged'' in different ways: by default, simple notes are recorded in the
% log file while the others (warnings, errors and fatal errors) are also
% displayed on the terminal output during compilation.
%
% \DescribeBooleanOption{silent}
% You have the ability to suppress logging altogether by using the
% \texttt{silent} option. This option is understood by the package itself, the
% \cs{fxsetup} command and all annotation commands and environments. Just
% as individual layout options, \texttt{silent} is a boolean option, so all
% those forms are possible: \texttt{silent}, equivalent to