Debian Codegraph @

texmf-dist/source/latex/fixme/fixme.dtx

raw
1 % \iffalse
2 %
3 % fixme.dtx --- docTeX file for FiXme
4 %
5 % Copyright (C) 1998-2002, 2004-2007, 2009, 2013, 2017-2019 Didier Verna
6 %
7 % Author: Didier Verna <[email protected]>
8 %
9 % This file is part of FiXme.
10 %
11 % FiXme may be distributed and/or modified under the conditions of the LaTeX
12 % Project Public License, either version 1.3 of this license or (at your
13 % option) any later version. The latest version of this license is in
14 % http://www.latex-project.org/lppl.txt and version 1.3 or later is part of
15 % all distributions of LaTeX version 2005/12/01 or later.
16 %
17 % FiXme consists of the files listed in the file `README.md'.
18 %
19 %
20 % Commentary:
21 %
22 %
23 % Code:
24 %
25 %<*driver>
26 \documentclass[a4paper]{ltxdoc}
27 \usepackage{xspace}
28
29 \usepackage{dox}[2009/09/21]
30 \doxitem[idxtype=env.]{Env}{environment}{environments}
31 \doxitem[idxtype=opt.]{Option}{option}{options}
32 \doxitem[idxtype=cnt.]{Counter}{counter}{counters}
33 \doxitem[idxtype=lang.]{Lang}{lang}{languages}
34 \doxitem[idxtype=cond.]{Cond}{cond}{conditionals}
35 \doxitem{Face}{face}{faces}
36 \doxitem{Color}{color}{colors}
37 \doxitem[idxtype={note lt.}]{Layout}{layout}{note layouts}
38 \doxitem[idxtype={env. lt.}]{EnvLayout}{envlayout}{env. layouts}
39 \doxitem[idxtype={target lt.}]{TargetLayout}{targetlayout}{target layouts}
40 \doxitem{Theme}{theme}{themes}
41
42 % #### NOTE: I don't want to \usepackage{fixme} just for getting the file
43 % information. So here what I do: generate a header with only the
44 % \ProvidesPackage command, and also the \fixmelogo. Then, I \input it so that
45 % \GetFileInfo works. However, I need to manually set the current file name
46 % and extension that would normally be set by \RequirePackage. Also, note that
47 % the call to \GetFileInfo below needs to use the extension of the header,
48 % that is inc instead of sty, even the file fixme.inc does not really exist.
49 \makeatletter
50 \def\@currname{fixme}
51 \def\@currext{inc}
52 \makeatother
53 \input{header.inc}
54 % \OnlyDescription
55 \CodelineIndex
56 % \RecordChanges
57 \setcounter{secnumdepth}{4}
58 \begin{document}
59 \DocInput{fixme.dtx}
60 \end{document}
61 %</driver>
62 %
63 % \fi
64 %
65 % \CheckSum{1769}
66 % \GetFileInfo{fixme.inc}
67 %% \CharacterTable
68 %% {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
69 %% 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
70 %% Digits \0\1\2\3\4\5\6\7\8\9
71 %% Exclamation \! Double quote \" Hash (number) \#
72 %% Dollar \$ Percent \% Ampersand \&
73 %% Acute accent \' Left paren \( Right paren \)
74 %% Asterisk \* Plus \+ Comma \,
75 %% Minus \- Point \. Solidus \/
76 %% Colon \: Semicolon \; Less than \<
77 %% Equals \= Greater than \> Question mark \?
78 %% Commercial at \@ Left bracket \[ Backslash \\
79 %% Right bracket \] Circumflex \^ Underscore \_
80 %% Grave accent \` Left brace \{ Vertical bar \|
81 %% Right brace \} Tilde \~}
82 %
83 % \MakeShortVerb{\|}
84 %
85 % \makeatletter
86 % \def\ps@mystyle{
87 % \def\@oddfoot{\hfil\thepage\hfil}
88 % \def\@evenfoot{\hfil\thepage\hfil}
89 % \def\@evenhead{\hfil\slshape\leftmark}
90 % \def\@oddhead{\slshape\rightmark\hfil}}
91 % \renewcommand\paragraph{\@startsection{paragraph}{4}{\z@}{%
92 % -3.25ex\@plus -1ex \@minus -.2ex}{%
93 % 1.5ex \@plus .2ex}{%
94 % \normalfont\normalsize\bfseries}}
95 % \makeatother
96 %
97 % \newcommand*\DescribeBooleanOption[1]{%
98 % {\let\oldpdo\PrintDescribeOption%
99 % \def\PrintDescribeOption##1{\oldpdo{[no]##1}}%
100 % \let\oldsoi\SpecialOptionIndex%
101 % \def\SpecialOptionIndex##1{\oldsoi{##1}\oldsoi{no##1}}%
102 % \DescribeOption{#1}}}
103 %
104 % \newenvironment{booleanoption}[1]{%
105 % \let\oldpon\PrintOptionName%
106 % \def\PrintOptionName##1{\oldpon{[no]##1}}%
107 % \let\oldsmoi\SpecialMainOptionIndex%
108 % \def\SpecialMainOptionIndex##1{\oldsmoi{##1}\oldsmoi{no##1}}%
109 % \begin{option}{#1}}{%
110 % \end{option}}
111 %
112 % ^^A Let's not depend on varioref for just that:
113 % \newcommand\sectionref[1]{\ref{#1} on page \pageref{#1}}
114 %
115 % \newcommand\etc{\textit{etc.}\xspace}
116 % \newcommand\vs{\textit{vs.}\xspace}
117 % \newcommand\ie{\textit{i.e.}\xspace}
118 % \newcommand\komascript{\textsc{Koma}-Script\xspace}
119 % \newcommand\auctex{AUC\TeX\xspace}
120 % \newcommand\emacs{\textsf{Emacs}\xspace}
121 %
122 % \newcommand\fx{\fixmelogo\xspace}
123 % \newcommand\packagecopyright{%
124 % Copyright \copyright{} 1998--2002, 2004--2007, 2009, 2013, 2017-2019 Didier Verna}
125 %
126 % \pagestyle{mystyle}
127 % \newcommand\fxmarkright{%
128 % \markright{\hskip-.5\marginparwidth \fx \fileversion{} (\filedate)}}
129 % \fxmarkright
130 %
131 % \date{\texttt{\fileversion{} (\filedate)}}
132 % \title{\fx{} -- Collaborative annotation tool for \LaTeX\footnote{%
133 % \fx homepage: %
134 % \texttt{http://www.lrde.epita.fr/\~{}didier/software/latex.php\#fixme}}}
135 % \author{Didier Verna\\
136 % \texttt{mailto:[email protected]}\\
137 % \texttt{http://www.lrde.epita.fr/\~{}didier/}}
138 % \maketitle
139 %
140 %
141 % \begin{abstract}
142 % \fx is a collaborative annotation tool for \LaTeX{} documents. Annotating
143 % a document here refers to inserting meta-notes, that is, notes that do not
144 % belong to the document itself, but rather to its development or reviewing
145 % process. Such notes may involve things of different importance levels,
146 % ranging from simple ``fix the spelling'' flags to critical ``this
147 % paragraph is a lie'' mentions. Annotations like this should be visible
148 % during the development or reviewing phase, but should normally disapear in
149 % the final version of the document.
150 %
151 % \fx is designed to ease and automate the process of managing collaborative
152 % annotations, by offering a set of predefined note levels and layouts, the
153 % possibility to register multiple authors, to reference annotations by
154 % listing and indexing \etc \fx is extensible, giving you the possibility to
155 % create new layouts or even complete ``themes'', and also comes with
156 % support for \auctex.
157 %
158 % The \fx package is \packagecopyright{}, and distributed under the
159 % terms of the LPPL license.
160 % \end{abstract}
161 %
162 % \tableofcontents
163 %
164 % \section{Installation}
165 % \subsection{Extraction}
166 % If you are building \fx from the tarball you need to execute the following
167 % steps in order to extract the necessary files. \fx also requires the
168 % \textsf{DoX} package (version 2.0, release date 2009/09/21 or later), to
169 % build. It is not required to use the package.
170 % \begin{verbatim}
171 % [pdf]latex fixme.ins
172 % [pdf]latex fixme.dtx
173 % [pdf]latex fixme.dtx
174 % makeindex -s gind fixme.idx
175 % [pdf]latex fixme.dtx
176 % [pdf]latex fixme.dtx
177 % \end{verbatim}
178 % After that, you need to install the generated documentation and style files
179 % to a location where \LaTeX{} can find them.
180 %
181 % \subsection{TDS-compliant layout}
182 % For a TDS-compliant layout, the following locations are suggested:
183 % \begin{verbatim}
184 % [TEXMF]/tex/latex/fixme/fixme.sty
185 % [TEXMF]/tex/latex/fixme/layouts/fxlayout*.sty
186 % [TEXMF]/tex/latex/fixme/layouts/env/fxenvlayout*.sty
187 % [TEXMF]/tex/latex/fixme/layouts/target/fxtargetlayout*.sty
188 % [TEXMF]/tex/latex/fixme/themes/fxtheme*.sty
189 % [TEXMF]/doc/latex/fixme/fixme.[pdf|dvi]
190 % \end{verbatim}
191 %
192 % \subsection{\auctex support}
193 % \auctex is a powerful major mode for editing \TeX{} documents in
194 % \emacs. In particular, it provides automatic completion of command names
195 % once they are known. \fx supports \auctex by providing a style file named
196 % \texttt{fixme.el} which contains \auctex definitions for the relevant
197 % commands. This file should be installed in a place where \auctex can find it
198 % (usually in a subdirectory of your \LaTeX{} styles directory). Please refer
199 % to the \auctex documentation for more information on this.
200 %
201 % \section{Features summary}
202 % If you're new to \fx, you might be interested in a brief summary of the
203 % features it provides. Otherwise, you may only take a look at the History
204 % section (section \sectionref{sec:manual:history}) to see what's new.
205 % \subparagraph{Annotation levels} \fx annotations may be of four different
206 % importance levels, ranging from simple not-so-important notices to critical
207 % things that must absolutely be fixed in the final version.
208 % \subparagraph{Layouts and themes} \fx gives you full and extensible control
209 % on the layout of these annotations: they can be displayed inline, as
210 % marginal paragraphs, as footnotes and also in any kind of user-defined way.
211 % All these ``layouts'' may be combined together. \fx also comes with support
212 % for ``themes'', globally modifying existing layouts, or providing new ones.
213 % \subparagraph{Annotation targets} Annotations may be ``targeted'' to a
214 % specific portion of text that will be highlighted, and on the contrary
215 % ``floating'' around, in which case they may even appear in the document's
216 % preamble.
217 % \subparagraph{Listing and indexing} Annotations may be indexed and
218 % summarized in a ``list of fixmes''.
219 % \subparagraph{Logging} Annotations are recorded in the log file, and
220 % (depending on their importance level) some of them are displayed on the
221 % terminal during compilation. A final summary is also created at the end of
222 % the compilation process.
223 % \subparagraph{Modes} All these features are actually available when you're
224 % working in \texttt{draft} mode. In \texttt{final} mode, the behavior is
225 % slightly different: any remaining critical note generates an error (the
226 % compilation aborts), while non critical ones are just removed from the
227 % document's body (they're still recorded in the log file though).
228 % \subparagraph{Authoring} \fx provides support for collaborative annotating
229 % by allowing you to ``register'' several authors.
230 % \subparagraph{Internationalization} \fx currently supports 7 different
231 % languages and features automatic language tracking for multilingual
232 % documents.
233 %
234 % \section{Using \fx}
235 % \subsection{Initialization}
236 % \subsubsection{Requirements}
237 % In order to work properly, \fx requires the presence of some \LaTeX{}
238 % packages. You don't have to load them explicitly though. As long as
239 % \LaTeX{} can locate them, they will be used automatically. \fx currently
240 % depends on \texttt{xspace}, \texttt{ifthen}, \texttt{verbatim} and
241 % \texttt{xkeyval} (version 2.5f, release date 2006/11/18 or later).
242 %
243 % \subsubsection{Loading the package}
244 % In order to load \fx, simply say |\usepackage[|\meta{options}|]{fixme}|
245 % in the preamble of your document. There is an important number of options
246 % that you can use in order to customize \fx's default or global behavior.
247 % These options will be discussed when appropriate.
248 %
249 % There might be times where you would like to use \LaTeX{} commands in
250 % package options (for example, see section \sectionref{sec:manual:faces}). In
251 % such a case, you should know that \LaTeX{} normally can't handle this. In
252 % order to make it work, you need to use the \texttt{xkvltxp} package first,
253 % like this:
254 % \begin{verbatim}
255 % \usepackage{xkvltxp}
256 % \usepackage[myoption=\mymacro]{fixme}
257 % \end{verbatim}
258 %
259 % \subsubsection{Global setup modification}
260 % \DescribeMacro{\fxsetup}\marg{options}\\
261 % Another way of customizing \fx's global behavior is to use the
262 % \cs{fxsetup} command. \cs{fxsetup} understands the same options as the
263 % package itself and can be used in the preamble as well as in the document's
264 % body.
265 %
266 % \subsubsection{Local setup modification}
267 % Finally, note that unless specified otherwise, all package options are also
268 % understood by the annotation commands or environments described in
269 % section \sectionref{sec:manual:insertion}. The effect is then local to that
270 % particular command.
271 %
272 % \subsection{Inserting \fx notes\label{sec:manual:insertion}}
273 % \subsubsection{Commands}
274 % \DescribeMacro{\fxnote}
275 % \DescribeMacro{\fxwarning}
276 % \DescribeMacro{\fxerror}
277 % \DescribeMacro{\fxfatal}\oarg{options}\marg{note}\\
278 % \fx provides four annotation commands corresponding to different
279 % levels of importance (notes, warnings, errors and fatal errors).
280 % \cs{fxfatal} is a bit different from the other ones, as will be explained in
281 % section \sectionref{sec:manual:behavior}.\par
282 % \begin{quotation}\itshape
283 % \DescribeMacro{\fixme}
284 % \textbf{Warning:} as of version 4, the \cs{fixme} command is a synonym for
285 % \cs{fxfatal} and is considered deprecated.
286 % \end{quotation}
287 %
288 % \subsubsection{Targeted commands}
289 % \DescribeMacro{\fxnote*}
290 % \DescribeMacro{\fxwarning*}
291 % \DescribeMacro{\fxerror*}
292 % \DescribeMacro{\fxfatal*}\oarg{options}\marg{note}\marg{text}\\
293 % Sometimes, you might not only want to issue a \fx note, but also highlight
294 % the relevant part of the text to which it applies. This is what I call
295 % ``targeting'' the annotation. As of version 4, \fx provides starred versions
296 % of its annotation commands to do that. In star form, these commands expect
297 % an additional mandatory argument containing the text to be highlighted.
298 %
299 % \subsubsection{Environments}
300 % \begin{quotation}\itshape
301 % \textbf{Warning:} as of version 4.0, the environment interface has changed
302 % and is \emph{not} backward-compatible.
303 % \end{quotation}
304 % \DescribeEnv{anfxnote}
305 % \DescribeEnv{anfxwarning}
306 % \DescribeEnv{anfxerror}
307 % \DescribeEnv{anfxfatal}\oarg{options}\marg{summary}\\
308 % \fx annotations are normally meant to be short: consider that they are
309 % likely to go in the list of fixmes and in the index for instance. If you
310 % feel the need for writing longer comments, the environments described below
311 % might come in handy. \fx provides four annotation environments; one for
312 % every note level. These environments take one mandatory argument (meant to
313 % be a short summary of the long note) and behave in exactly the same way as
314 % their command counterpart. The layout policy is a bit different though (see
315 % section \sectionref{sec:manual:layout}): the environment's contents will
316 % always appear inline, and the \meta{summary} will obey all active annotation
317 % layouts except for the \texttt{inline} one, just as if it had been passed to
318 % one of the \fx annotation commands described in the previous section.
319 % \begin{quotation}\itshape
320 % \DescribeEnv{afixme}
321 % \textbf{Warning:} as of version 4, the \texttt{afixme} environement is a
322 % synonym for \texttt{anfxfatal}, and is considered deprecated.
323 % \end{quotation}
324 %
325 %
326 %
327 % \subsubsection{Targeted environments}
328 % \DescribeEnv{anfxnote*}
329 % \DescribeEnv{anfxwarning*}
330 % \DescribeEnv{anfxerror*}
331 % \DescribeEnv{anfxfatal*}\oarg{options}\marg{summary}\marg{text}\\
332 % \fx environments can also be targeted to a specific portion of text. When
333 % using the starred version, the environments expect one additional mandatory
334 % argument: the text in question that will be highlighted.
335 %
336 % \subsection{List of \fx's\label{sec:manual:lox}}
337 % \DescribeMacro{\listoffixmes}
338 % \fx remembers where you put your annotations in a toc-like file whose
339 % extension is \texttt{lox}. The \cs{listoffixmes} command generates the
340 % annotations lists in a manner similar to that of the ``list of figures''. A
341 % standard layout is automatically selected for the \texttt{article},
342 % \texttt{report} and \texttt{book} classes and the AMS ones. If loaded, \fx
343 % will also use the \texttt{tocbasic} package which makes it compliant with
344 % the \komascript classes and any other document using it. If another class
345 % is used, the \texttt{article} layout is selected. Also, note that if there
346 % isn't any annotation left in the document, this command doesn't generate an
347 % empty list, but rather stays silent. It also stays silent in \texttt{final}
348 % mode, regardless of the presence of remaining annotations (see
349 % section \sectionref{sec:manual:behavior}).
350 %
351 % \subsection{Controlling the behavior of \fx\label{sec:manual:behavior}}
352 % \DescribeOption{final}
353 % \DescribeOption{draft}
354 % The behavior of \fx is controlled by the two standard options
355 % \texttt{final} and \texttt{draft}. These options are usually given to
356 % \cs{documentclass} which in turn passes them to all packages. In addition,
357 % you can also use them as options to \cs{usepackage}, in the call to
358 % \cs{fxsetup}, and even to the annotation commands and environments.
359 %
360 % In \texttt{draft} mode, annotations are recorded in the log file and appear
361 % in the document as specified by the layout settings (see section
362 % \sectionref{sec:manual:layout}). Additionally, warnings, errors and fatal
363 % errors are also displayed on the terminal.
364 %
365 % In final mode, non fatal annotations (those generated by \cs{fxnote},
366 % \cs{fxwarning}, \cs{fxerror} and their corresponding environments) are still
367 % logged, but they're not typeset. On the other hand, fatal ones (those
368 % generated by the \cs{fxfatal} command and the \texttt{anfxfatal}
369 % environment) will throw a \LaTeX{} error and thus interrupt or abort
370 % compilation with an informative message. This will help you track down
371 % forgotten important caveats in your document.
372 %
373 % Let me rephrase: final documents can only have \fx notes, warnings, and (non
374 % fatal) errors left. Of course, this is not completely true: remember that
375 % these options are understood locally by all the annotation commands and
376 % environments, so even in \texttt{final} mode, you can use something like
377 % this:
378 % \begin{verbatim}
379 % \fxfatal[draft]{bla bla}
380 % \end{verbatim}
381 %
382 % \DescribeOption{status}
383 % By default, \fx is in \texttt{final} mode (\LaTeX{} itself behaves that
384 % way). If you're manipulating the document status at the level of \fx
385 % itself (as opposed to the \cs{documentclass} level), then the preferred way
386 % to do this is to use the \texttt{status} option, and give it the value
387 % \texttt{final} or \texttt{draft}.
388 %
389 % \subsection{Controlling the layout of annotations\label{sec:manual:layout}}
390 % Annotations can appear in several forms in your document. Each of these
391 % forms can be individually selected, or they can be combined together to some
392 % extend.
393 %
394 % \subsubsection{Selecting a layout}
395 % \paragraph{Individual control}
396 % For each annotation layout, there is a corresponding boolean option (for
397 % instance, the ``inline'' layout is controlled by the \texttt{inline}
398 % option). These options are understood by the package itself, the
399 % \cs{fxsetup} command and also locally by every annotation command or
400 % environment. There are some restrictions on their usage however, as
401 % discussed in the next section.
402 %
403 % To activate a layout, use the option alone or give it a value of
404 % \texttt{true}. For instance, these two forms are equivalent:
405 % \begin{verbatim}
406 % \fxnote[inline]{note...}
407 % \fxnote[inline=true]{note...}
408 % \end{verbatim}
409 % For convenience, each layout option has a counterpart that deactivates the
410 % corresponding layout. The counterpart option has the same name, prefixed
411 % with \texttt{no} (for instance, \texttt{noinline}). Again, these options are
412 % understood by the package itself, the \cs{fxsetup} command and also locally
413 % by every annotation command or environment (with the same usage
414 % restrictions, discussed in the next section). For instance, these two forms
415 % are equivalent:
416 % \begin{verbatim}
417 % \fxsetup{inline=false}
418 % \fxsetup{noinline}
419 % \end{verbatim}
420 %
421 % \paragraph{Global control}
422 % \DescribeOption{layout}
423 % \DescribeOption{morelayout}
424 % An even more convenient way to specify the required layout is to use the
425 % \texttt{layout} and \texttt{morelayout} options. In fact, the use of
426 % individual control is considered more or less deprecated. Both of these
427 % options take a comma-separated list of the individual options described
428 % above (this includes the \texttt{no}\meta{option} form as well).
429 %
430 % While the \texttt{morelayout} option \emph{adds} to the current layout
431 % configuration, the \texttt{layout} one completely overrides it. For
432 % instance, knowing that by default, only the \texttt{margin} layout is
433 % active, the following forms are all equivalent:
434 % \begin{verbatim}
435 % \usepackage[nomargin,inline,index]{fixme}
436 % \usepackage[margin=false,inline=true,index=true]{fixme}
437 % \usepackage[morelayout={nomargin,inline,index}]{fixme}
438 % \usepackage[layout={inline,index}]{fixme}
439 % \end{verbatim}
440 % Again, these two options are understood by the package itself, the
441 % \cs{fxsetup} command and also locally by every annotation command or
442 % environment (with the same usage restrictions, discussed in the next
443 % section).
444 %
445 % \noindent\DescribeMacro{\fxuselayouts}\marg{name,\ldots}\\
446 % Finally, an alternative way of selecting (or deselecting) several layouts
447 % simultaneously is to use the \cs{fxuselayouts} command, giving it a
448 % comma-separated list of layout options as its only, mandatory, argument.
449 %
450 % \subsubsection{Built-in \vs external layouts}
451 % Annotation layouts are provided either in the core of \fx, or in separate
452 % files loaded dynamically on demand. Simple layouts are typically built-in,
453 % whereas those requiring additional packages are external, so that they don't
454 % consume \TeX{} resources if not used. As a consequence, selecting an
455 % external layout might involve loading the relevant file first.
456 %
457 % For technical reasons, it is not possible to do such a thing outside the
458 % preamble, neither in the middle of processing \cs{usepackage} options. As a
459 % result, layout options are restricted and you have three possibilities for
460 % using an external layout:
461 % \begin{enumerate}
462 % \item Use its corresponding option in a call to \cs{fxsetup} in the
463 % preamble, like this: |\fxsetup{|\meta{option}|}|. This will load it
464 % \emph{and} select it immediately.
465 % \item Use the \cs{fxuselayouts} command in the preamble like this:\\
466 % |\fxuselayouts{|\meta{name}|}|. This is strictly equivalent to the
467 % previous solution.
468 % \end{enumerate}
469 % \DescribeMacro{\fxloadlayouts}\marg{name,\ldots}
470 % \begin{enumerate}
471 % \item[3]
472 % If on the other hand you want to load one or several external layouts
473 % \emph{without} using them immediately (perhaps in order to use them
474 % locally in some specific annotation), use the \cs{fxloadlayouts} command
475 % in the preamble like this: |\fxloadlayouts{|\meta{name}|,...}|. After
476 % that, you can select any of those layouts anywhere you wish.
477 % \end{enumerate}
478 %
479 % \subsubsection{Available layouts}
480 % \DescribeBooleanOption{inline}
481 % \DescribeBooleanOption{margin}
482 % \DescribeBooleanOption{footnote}
483 % \DescribeBooleanOption{index}
484 % \DescribeLayout[noprint]{inline}
485 % \DescribeLayout[noprint]{margin}
486 % \DescribeLayout[noprint]{footnote}
487 % \DescribeLayout[noprint]{index}
488 % Table \ref{table:layouts} lists the annotation layouts currently distributed
489 % with \fx. By default, only the \texttt{margin} layout is active. Most of
490 % these layouts should be self-explanatory, but some precisions are given
491 % below.
492 % \begin{table}
493 % \centering
494 % \DeleteShortVerb{\|}
495 % \begin{tabular}{|l|c|p{7cm}|}
496 % \hline
497 % \textbf{Name} & \textbf{External} & \textbf{Description}\\
498 % \hline\hline
499 % \texttt{inline} & & Display note inline\\
500 % \texttt{margin} & & Display note in the margin\\
501 % \texttt{footnote} & & Display note in a footnote\\
502 % \texttt{index} & & Display note in the index\\
503 % \texttt{marginclue} & & Display a marginal clue\\
504 % \texttt{marginnote} & \texttt{*} & Display non-floating note in the
505 % margin\\
506 % \texttt{pdfnote} & \texttt{*} & Display note as inline PDF comment\\
507 % \texttt{pdfmargin} & \texttt{*} & Display note as marginal PDF
508 % comment\\
509 % \texttt{pdfsignote} & \texttt{*} & Display signed note ala
510 % \texttt{pdfnote}\\
511 % \texttt{pdfsigmargin} & \texttt{*} & Display signed note ala
512 % \texttt{pdfmargin}\\
513 % \texttt{pdfcnote} & \texttt{*} & Display colored note ala
514 % \texttt{pdfnote}\\
515 % \texttt{pdfcmargin} & \texttt{*} & Display colored note ala
516 % \texttt{pdfmargin}\\
517 % \texttt{pdfcsignote} & \texttt{*} & Display colored note ala
518 % \texttt{pdfcsignote}\\
519 % \texttt{pdfcsigmargin} & \texttt{*} & Display colored note ala
520 % \texttt{pdfsigmargin}\\
521 % \hline
522 % \end{tabular}
523 % \MakeShortVerb{\|}
524 % \caption{Available annotation layouts}
525 % \label{table:layouts}
526 % \end{table}
527 % \paragraph{\texttt{marginclue}}
528 % \DescribeBooleanOption{marginclue}
529 % \DescribeLayout[noprint]{marginclue}
530 % If your preferred layout is \texttt{inline} or say, \texttt{footnote}, it
531 % might be somewhat difficult to localize the annotation on the page,
532 % especially its vertical position. That's where marginal clues come into
533 % play. A marginal clue does not display the annotation's contents, but only
534 % an indication that there is one at that (vertical) position. So you need to
535 % use another layout as well (again, typically \texttt{inline} or
536 % \texttt{footnote}) in order to get the actual annotation.
537 %
538 % Obviously, the margin and margin clue layouts are mutually exclusive, so if
539 % you try to activate both, only the most recently activated one will be
540 % enabled (and you'll get a notice in the log file and on the terminal).
541 %
542 % \paragraph{\texttt{marginnote}}\label{sec:manual:marginnote}
543 % \DescribeBooleanOption{marginnote}
544 % \DescribeLayout[noprint]{marginnote}
545 % The \texttt{marginnote} layout is an alternate (external) way to display
546 % annotations in the margin, using the eponymous package. Contrary to \LaTeX's
547 % standard marginal paragraphs, the ones issued by \texttt{marginnote} are
548 % constructed in a non-floating way. This might be an advantage in some
549 % situations but \texttt{marginnote} also comes with some disadvantages of its
550 % own. For more information, please refer to \texttt{marginnote}'s
551 % documentation, and also read the next section. Also, note that it is not
552 % currently possible to pass options to the \cs{marginnote} command through
553 % this layout.
554 %
555 % For a reasonably robust marginal layout accross all annotations, including
556 % those issued in floats, consider using \texttt{marginnote} in conjunction
557 % with \texttt{innerlayout=noinline} (see
558 % section \sectionref{sec:manual:inner}).
559 %
560 % \paragraph{PDF comments}
561 % \DescribeBooleanOption{pdfnote}
562 % \DescribeLayout[noprint]{pdfnote}
563 % \DescribeBooleanOption{pdfmargin}
564 % \DescribeLayout[noprint]{pdfmargin}
565 % \DescribeBooleanOption{pdfsignote}
566 % \DescribeLayout[noprint]{pdfsignote}
567 % \DescribeBooleanOption{pdfsigmargin}
568 % \DescribeLayout[noprint]{pdfsigmargin}
569 % \DescribeBooleanOption{pdfcnote}
570 % \DescribeLayout[noprint]{pdfcnote}
571 % \DescribeBooleanOption{pdfcmargin}
572 % \DescribeLayout[noprint]{pdfcmargin}
573 % \DescribeBooleanOption{pdfcsignote}
574 % \DescribeLayout[noprint]{pdfcsignote}
575 % \DescribeBooleanOption{pdfcsigmargin}
576 % \DescribeLayout[noprint]{pdfcsigmargin}
577 % The PDF format comes with a concept of \emph{comment}, which \fx can use to
578 % display its own annotations. Support for PDF comments varies across PDF
579 % viewers. Acrobat Reader is usually considered a reference, and MacOS X's
580 % Preview supports them reasonably well. The \texttt{pdfnote} and
581 % \texttt{pdfmargin} layouts use the \texttt{pdfcomment} package to display
582 % annotations as PDF inline or marginal comments.
583 %
584 % The \texttt{sig} versions additionally display the author's tag (see
585 % \sectionref{sec:manual:modes}) as a signature instead of as a prefix.
586 %
587 % The versions with a \texttt{c} in their name (as in \textbf{c}olor) use one
588 % of four different colors named \texttt{fx}\meta{level} (according to the
589 % annotation's importance level). They also avoid printing the annotation's
590 % level since this information is already conveyed by the color.
591 %
592 % \subsubsection{Inner layout}\label{sec:manual:inner}
593 % There might be various reasons for you to change the layout locally for one
594 % particular annotation: creating a floating one is an example, see also
595 % section \sectionref{sec:manual:othercommonproblems} for some others. One
596 % frequent reason (described below) can be handled automatically by \fx.
597 %
598 % Remember that the default layout is to use margin paragraphs. Unfortunately,
599 % margin paragraphs are forbidden by \TeX{} in several situations, like a
600 % figure's caption for instance. If you try that, you will get a cryptic ``Not
601 % in outer par mode'' error message.
602 %
603 % \DescribeOption{innerlayout}
604 % The good news is that this situation can be detected automatically. \fx
605 % provides an option named \texttt{innerlayout} that allows you to specify an
606 % alternative layout setting to use when \TeX{} is in \emph{inner} mode. In
607 % addition to that, \fx automatically disables the \texttt{margin} and
608 % \texttt{marginclue} layouts. If you really want to use marginal paragraphs
609 % in inner mode, a good idea is then to set your inner layout to
610 % \texttt{marginnote} (see section \ref{sec:manual:marginnote}).
611 %
612 % Using \texttt{innerlayout} is not as trivial as it may seem: it
613 % \emph{really} is an alternative layout configuration, and as such, you can
614 % use any combination you like of individual layout options, or you can even
615 % use the \texttt{layout} and \texttt{morelayout} options. This means that
616 % your alternative layout can either \emph{add} to the existing one, or
617 % \emph{override} it. Here are some examples to clarify things a little. You
618 % should try to understand them.
619 % \begin{itemize}
620 % \item By default, the \fx inner layout is set to just \texttt{inline}.
621 % This can be simulated by the following call:
622 % \begin{verbatim}
623 % \usepackage[layout=margin,innerlayout={layout=inline}]{fixme}
624 % \end{verbatim}
625 % \item The following happens to give the same result in our particular case,
626 % while having a different semantics:
627 % \begin{verbatim}
628 % \usepackage[layout=margin,innerlayout=inline]{fixme}
629 % \end{verbatim}
630 % \item If you have set \fx to use a safe layout globally (for instance,
631 % \texttt{inline} and \texttt{index}), and you want to use the same layout
632 % in inner mode, then you should provide an \emph{empty} inner layout, like
633 % this:
634 % \begin{verbatim}
635 % \fxsetup{layout={inline,index},innerlayout=}
636 % \end{verbatim}
637 % What would happen if you didn't provide the \texttt{innerlayout} option?
638 % \end{itemize}
639 %
640 % One final remark on the \texttt{innerlayout} option: this option is not
641 % processed immediately when you specify it, but instead, its value is stored
642 % and used only when needed. As a result, if you plan to use an external
643 % layout in inner mode (typically, \texttt{marginnote})~, you need to load it
644 % explicitely in the preamble first. Use \cs{fxloadlayouts} for that.
645 %
646 % \subsubsection{Other common layout
647 % problems\label{sec:manual:othercommonproblems}}
648 % This section describes some other common problems that people have
649 % encountered using \fx. Although \fx might not be directly responsible
650 % for them, it is still good to keep them in mind.
651 %
652 % \subparagraph{Annotations in captions being counted twice} You are most
653 % likely using \cs{listofsomething} (figure, table, or any other kind of
654 % float). Note that a caption will be used twice here: once in the float
655 % itself, and once in the list of floats. Any \fx annotation in the caption
656 % will consequently be generated twice as well. The solution to this problem
657 % is to use the optional argument to \cs{caption}, for example:
658 % \begin{verbatim}
659 % \caption[caption text]{caption text\fxnote{yuck!}}
660 % \end{verbatim}
661 %
662 % \subparagraph{Footnotes and margin paragraphs in floats} Using footnotes in
663 % figures (and \emph{a fortiori} in a figure's caption) does not work in
664 % general. Although there are some workarounds out there (for instance, using
665 % \cs{footnotemark} and \cs{footnotetext} directly), there is no completely
666 % reliable solution and it is not possible to detect that situation
667 % automatically. Similarly, marginal paragraphs will cause problems in a
668 % figure (even when not in its caption) because floats can't be nested in
669 % \LaTeX. Usual symptoms of these situations are: a footnote not being
670 % typeset, compilation breakage with the ``Floats lost'' message \etc If
671 % you're facing this problem, you need to change your layout locally.
672 %
673 % \subparagraph{Marginal paragraphs showing up on the wrong margin} You want
674 % to look at the \texttt{mparhack} package.
675 %
676 % \subparagraph{ACM classes compatibility} The ACM \textsc{Sig} classes
677 % (\texttt{acm\_proc\_article-sp} and \texttt{sig-alternate}) forbid the use
678 % of \cs{marginpar}, so if you use these classes, don't forget to choose
679 % another layout for \fx, and also avoid using marginal clues.
680 %
681 % \subparagraph{Annotation indexing}
682 % Remember that some characters are special in an index entry (the \texttt{!}
683 % for instance). \fx currently does nothing to escape those characters, so
684 % avoid using them in your annotations.
685 %
686 % \subsection{Corollary: floating annotations}
687 % At some point, people suggested that it would be nice to have global
688 % annotations, not related to any portion of the text in particular. Such
689 % annotations could be general comments about the whole document, and could
690 % even be issued in the preamble. This is what I call ``floating''
691 % annotations.
692 %
693 % I know you don't care, but originally, I started writing a new set of
694 % commands to do just that. However, with the flexibility that \fx 4.0
695 % provides, I quickly realized that such commands were an unnecessary
696 % addition.
697 %
698 % Since floating anotations are not supposed to relate to any part of the
699 % text, they should not be typeset anywhere in it. This is especially true if
700 % you want to put some of them in the document's preamble. However, even a
701 % preamble annotation could be recorded and displayed in the index or in the
702 % list of fixmes. And it turns out that you can specify all that with the
703 % layout options described in section \sectionref{sec:manual:layout}.
704 %
705 % \DescribeOption{target}
706 % The only remaining problem is the page number, which normally appears in the
707 % list of fixmes and in the index: if you choose to reference a floating
708 % annotation that way, the page number is likely to be completely meaningless.
709 % To compensate, a new option named \texttt{target} is provided. When used,
710 % the given value will replace the page number in both the index and the list
711 % of fixmes. The target can be anything you like, but should remain rather
712 % short. By default, \texttt{target} is set the special value
713 % \texttt{thepage}, which as you guessed means to use the page number.
714 %
715 % The name "target" bears an intentional resemblance to \fx's targeted
716 % commands and environments, because we are indeed targetting the annotation
717 % to something. The only difference is that in the case of floating
718 % annotations, the target is non-textual.
719 %
720 % Here is an example of a floating annotation that would typically appear in
721 % the document's preamble:
722 % \begin{verbatim}
723 % \usepackage{hyperref}
724 % \fxfatal[layout=index,target=hyperref]{Fill in PDF fields (title etc.)}
725 % \end{verbatim}
726 %
727 % \subsection{Controlling the layout of
728 % environments\label{sec:manual:envlayoutcontrol}}
729 % As discussed in section \sectionref{sec:manual:insertion}, the contents of a
730 % \fx environment (a longer annotation) always appears inline. However, the
731 % exact way this contents is typeset (in draft mode only) is subject to a
732 % layout of its own, called the ``environment layout''.
733 %
734 % \subsubsection{Selecting a layout}
735 % \DescribeOption{envlayout}
736 % The desired environment layout can be selected with the \texttt{envlayout}
737 % option. Contrary to the annotation layouts, only one environment layout can
738 % be active at a time. The \texttt{envlayout} option is understood by the
739 % package itself, the \cs{fxsetup} command and all the annotation environments
740 % (not the commands!). There are some restrictions on its usage however, as
741 % discussed in the next section.
742 %
743 % \noindent\DescribeMacro{\fxuseenvlayout}\marg{name}\\
744 % An alternative way of selecting an environment layout is to use the
745 % \cs{fxuseenvlayout} command, giving it the layout's name as its only,
746 % mandatory, argument.
747 %
748 % \subsubsection{Built-in \vs external layouts}
749 % Environments layouts are provided either in the core of \fx, or in separate
750 % files loaded dynamically on demand. Simple layouts are typically built-in,
751 % whereas those requiring additional packages are external, so that they don't
752 % consume \TeX{} resources if not used. As a consequence, selecting an
753 % external layout with the \texttt{envlayout} option might involve loading the
754 % relevant file first.
755 %
756 % \noindent\DescribeMacro{\fxloadenvlayouts}\marg{name,\ldots}\\
757 % For technical reasons, it is not possible to do such a thing outside the
758 % preamble, neither in the middle of processing \cs{usepackage} options. As a
759 % result, the \texttt{envlayout} option is restricted and you have three
760 % possibilities for using an external layout:
761 % \begin{enumerate}
762 % \item Use the \texttt{envlayout} option in a call to \cs{fxsetup} in the
763 % preamble, like this: |\fxsetup{envlayout=name}|. This will load it
764 % \emph{and} select it immediately.
765 % \item Use the \cs{fxuseenvlayout} command in the preamble like this:\\
766 % |\fxuseenvlayout{name}|. This is strictly equivalent to the previous
767 % solution.
768 % \item If on the other hand you want to load one or several environment
769 % layouts \emph{without} using them immediately (perhaps in order to use
770 % them locally in some specific annotation), use the \cs{fxloadenvlayouts}
771 % command in the preamble like this: |\fxloadenvlayouts{|\meta{name}|,...}|.
772 % After that, you can select any of those layouts anywhere you wish.
773 % \end{enumerate}
774 %
775 % \subsubsection{Available layouts\label{sec:manual:envlayoutslist}}
776 % Table \ref{table:envlayouts} lists the environment layouts currently
777 % distributed with \fx.
778 % \begin{itemize}
779 % \item \DescribeEnvLayout{plain}
780 % The \texttt{plain} environment layout prints its contents as-is, only
781 % in bold font (by default) in order to distinguish it from the surrounding
782 % text.
783 % \item \DescribeEnvLayout{signature}
784 % The \texttt{signature} environment layout prints the author's tag (see
785 % \sectionref{sec:manual:modes}) as a signature instead of as a prefix. This
786 % layout is used by the \texttt{signature} theme (see section
787 % \sectionref{sec:manual:themes}).
788 % \item \DescribeEnvLayout{color}
789 % \DescribeColor{fxnote}
790 % \DescribeColor{fxwarning}
791 % \DescribeColor{fxerror}
792 % \DescribeColor{fxfatal}
793 % The \texttt{color} environment layout uses one of four colors named
794 % \texttt{fx}\meta{level} (according to the annotation's importance level)
795 % to display its contents. It also avoids printing the annotation level,
796 % since that information is already conveyed by the color. This layout is
797 % used by the \texttt{color} theme (see section
798 % \sectionref{sec:manual:themes}).
799 % \item \DescribeEnvLayout{colorsig}
800 % The \texttt{colorsig} environment layout combines the features of the
801 % \texttt{signature} and \texttt{color} ones. This layout is used by the
802 % \texttt{colorsig} theme (see section \sectionref{sec:manual:themes}).
803 % \end{itemize}
804 % \begin{table}
805 % \centering
806 % \DeleteShortVerb{\|}
807 % \begin{tabular}{|l|c|p{7cm}|}
808 % \hline
809 % \textbf{Name} & \textbf{External} & \textbf{Description}\\
810 % \hline\hline
811 % \texttt{plain} & & Display contents as-is\\
812 % \texttt{signature} & & Display signed contents\\
813 % \texttt{color} & \texttt{*} & Display contents in color\\
814 % \texttt{colorsig} & \texttt{*} & Display signed contents in color\\
815 % \hline
816 % \end{tabular}
817 % \MakeShortVerb{\|}
818 % \caption{Available environment layouts}
819 % \label{table:envlayouts}
820 % \end{table}
821 %
822 % \subsection{Controlling the layout of
823 % targets\label{sec:manual:targetlayoutcontrol}}
824 % As discussed in section \sectionref{sec:manual:insertion}, the starred
825 % versions of the \fx annotation commands and environments let you highlight a
826 % portion of text which is relevant to the current annotation. The exact way
827 % this textual target is typeset (in draft mode only; otherwise it is typeset
828 % as-is) is subject to a layout of its own, called the ``target layout''.
829 %
830 % \subsubsection{Selecting a layout}
831 % \DescribeOption{targetlayout}
832 % The desired layout can be selected with the \texttt{targetlayout} option.
833 % Contrary to the annotation layouts, only one target layout can be active at
834 % a time. The \texttt{targetlayout} option is understood by the package
835 % itself, the \cs{fxsetup} command and all the starred versions of the
836 % annotation commands and environments. There are some restrictions on its
837 % usage however, as discussed in the next section.
838 %
839 % \noindent\DescribeMacro{\fxusetargetlayout}\marg{name}\\
840 % An alternative way of selecting a target layout is to use the
841 % \cs{fxusetargetlayout} command, giving it the layout's name as its only,
842 % mandatory, argument.
843 %
844 % \subsubsection{Built-in \vs external layouts}
845 % Target layouts are provided either in the core of \fx, or in separate files
846 % loaded dynamically on demand. Simple layouts are typically built-in, whereas
847 % those requiring additional packages are external, so that they don't consume
848 % \TeX{} resources if not used. As a consequence, selecting an external layout
849 % with the \texttt{targetlayout} option might involve loading the relevant
850 % file first.
851 %
852 % \noindent\DescribeMacro{\fxloadtargetlayouts}\marg{name,\ldots}\\
853 % For technical reasons, it is not possible to do such a thing outside the
854 % preamble, neither in the middle of processing \cs{usepackage} options. As a
855 % result, the \texttt{targetlayout} option is restricted and you have two
856 % possibilities for using an external layout:
857 % \begin{enumerate}
858 % \item Use the \texttt{targetlayout} option in a call to \cs{fxsetup} in the
859 % preamble, like this: |\fxsetup{targetlayout=name}|. This will load it
860 % \emph{and} select it immediately.
861 % \item Use the \cs{fxusetargetlayout} command in the preamble like this:\\
862 % |\fxusetargetlayout{name}|. This is strictly equivalent to the previous
863 % solution.
864 % \item If on the other hand you want to load one or several target layouts
865 % \emph{without} using them immediately (perhaps in order to use them
866 % locally in some specific annotation), use the \cs{fxloadtargetlayouts}
867 % command in the preamble like this:
868 % |\fxloadtargetlayouts{|\meta{name}|,...}|. After that, you can select any
869 % of those layouts anywhere you wish.
870 % \end{enumerate}
871 %
872 % \subsubsection{Available layouts\label{sec:manual:targetlayoutslist}}
873 % Table \ref{table:targetlayouts} lists the target layouts currently
874 % distributed with \fx.
875 % \begin{itemize}
876 % \item \DescribeTargetLayout{plain}
877 % The \texttt{plain} target layout displays its contents as-is, only in
878 % italics (by default) in order to distinguish it from the surrounding text.
879 % \item \DescribeTargetLayout{changebar}
880 % The \texttt{changebar} target layout displays a vertical bar in the
881 % margin, on the side of the target text.
882 % \item \DescribeTargetLayout{color}
883 % \DescribeColor{fxtarget}
884 % The \texttt{color} target layout uses the color named \texttt{fxtarget}
885 % to display the target text. This layout is used by the \texttt{color}
886 % and \texttt{colorsig} themes (see section \sectionref{sec:manual:themes}).
887 % \item \DescribeTargetLayout{colorcb}
888 % \DescribeColor{fxnote}
889 % \DescribeColor{fxwarning}
890 % \DescribeColor{fxerror}
891 % \DescribeColor{fxfatal}
892 % The \texttt{colorcb} target layout uses one of four colors named
893 % \texttt{fx}\meta{level} (according to the annotation's importance
894 % level) to display a colored vertical bar in the margin, on the side of the
895 % target text.
896 % \end{itemize}
897 % \begin{table}
898 % \centering
899 % \DeleteShortVerb{\|}
900 % \begin{tabular}{|l|c|p{7cm}|}
901 % \hline
902 % \textbf{Name} & \textbf{External} & \textbf{Description}\\
903 % \hline\hline
904 % \texttt{plain} & & Display target as-is\\
905 % \texttt{changebar} & \texttt{*} & Display a vertical bar aside target\\
906 % \texttt{color} & \texttt{*} & Display target in color\\
907 % \texttt{colorcb} & \texttt{*} & Display a colored vertical bar aside
908 % target\\
909 % \hline
910 % \end{tabular}
911 % \caption{Available target layouts}
912 % \label{table:targetlayouts}
913 % \MakeShortVerb{\|}
914 % \end{table}
915 %
916 % \subsection{Faces\label{sec:manual:faces}}
917 % In the \fx jargon, a ``face'' characterizes the visual aspect of some
918 % portion of text. If you're familiar with the \emacs editor, this will come
919 % as no surprise to you. \fx provides several faces that allow you to further
920 % customize the layout of annotations or their targets.
921 %
922 % \subsubsection{Setting face values}
923 % There are different ways to customize a face. The first one is to use the
924 % corresponding face option. For each face \meta{name}, their is a
925 % \meta{name}\texttt{face} option. For instance, the ``inline'' face is
926 % controlled by the \texttt{inlineface} option. Face options are
927 % understood by the package itself, the \cs{fxsetup} command and locally by
928 % all annotation commands or environments. Here is an example:
929 % \begin{verbatim}
930 % \fxsetup{inlineface=\bfseries}
931 % \end{verbatim}
932 %
933 % Since you will probably want to use \LaTeX{} commands in face values, you
934 % should know that \LaTeX{} normally can't handle such commands in package
935 % options. If you want this to work, you need to use the \texttt{xkvltxp}
936 % package first, like this:
937 % \begin{verbatim}
938 % \usepackage{xkvltxp}
939 % \usepackage[inlineface=\bfseries]{fixme}
940 % \end{verbatim}
941 %
942 % \noindent\DescribeMacro{\fxsetface}\marg{name}\marg{value}\\
943 % Another way to customize a face is to use the \cs{fxsetface} command by
944 % providing the face name and the face value as two mandatory arguments. For
945 % example:
946 % \begin{verbatim}
947 % \fxsetface{inline}{\bfseries}
948 % \end{verbatim}
949 %
950 % \subsubsection{Available faces}
951 % \subparagraph{The \texttt{inline} face}
952 % \DescribeFace{inline}
953 % By default, the \texttt{inline} annotation layout displays its contents in
954 % bold font, to distinguish the note from the surrounding text. This is
955 % controlled by the \texttt{inline} face whose value is \cs{bfseries} by
956 % default.
957 %
958 % \subparagraph{The \texttt{margin} face}
959 % \DescribeFace{margin}
960 % By default, the \texttt{margin} and \texttt{marginclue} layouts display
961 % their contents in footnote size. This is controlled by the \texttt{margin}
962 % face whose value is \cs{footnotesize} by default.
963 %
964 % \subparagraph{The \texttt{env} face}
965 % \DescribeFace{env}
966 % By default, the \texttt{plain} environment layout displays its contents in
967 % bold font, to distinguish it from the surrounding text. This is controlled
968 % by the \texttt{env} face whose value is \cs{bfseries} by default. The
969 % \texttt{color} and \texttt{colorsig} environment layouts honor this face as
970 % well, but reset it to \meta{nothing} first. You should probably keep the
971 % same value for the \texttt{inline} and \texttt{env} faces, since they are
972 % both used to display annotations within the document's body.
973 %
974 % \subparagraph{The \texttt{signature} face}
975 % \DescribeFace{signature}
976 % The \texttt{signature} environment layout honors the \texttt{env} face, and
977 % adds a \texttt{signature} face on top of it for the signature part. It is
978 % set to \cs{itshape} by default. The \texttt{colorsig} environment layout
979 % honors this face as well.
980 %
981 % \subparagraph{The \texttt{target} face}
982 % \DescribeFace{target}
983 % By default, the \texttt{plain} target layout displays its contents in
984 % italics, to distinguish it from the surrounding text. This is controlled by
985 % the \texttt{target} face whose value is \cs{itshape} by default. The
986 % \texttt{changebar}, \texttt{color} and \texttt{colorcb} target layouts honor
987 % this face as well, but reset it to \meta{nothing} first.
988 %
989 % \subsection{Controlling the logging of annotations}
990 % As well as being displayed in the document itself, all annotations are
991 % ``logged'' in different ways: by default, simple notes are recorded in the
992 % log file while the others (warnings, errors and fatal errors) are also
993 % displayed on the terminal output during compilation.
994 %
995 % \DescribeBooleanOption{silent}
996 % You have the ability to suppress logging altogether by using the
997 % \texttt{silent} option. This option is understood by the package itself, the
998 % \cs{fxsetup} command and all annotation commands and environments. Just
999 % as individual layout options, \texttt{silent} is a boolean option, so all
1000 % those forms are possible: \texttt{silent}, equivalent to
1001 % \texttt{silent=true}, and \texttt{nosilent}, equivalent to
1002 % \texttt{silent=false} (the default).
1003 %
1004 % \subsection{Controlling the language of \fx\label{sec:manual:i18n}}
1005 % \subsubsection{Available languages}
1006 % \DescribeOption{english}
1007 % \DescribeOption{french}
1008 % \DescribeOption{francais}
1009 % \DescribeOption{spanish}
1010 % \DescribeOption{italian}
1011 % \DescribeOption{german}
1012 % \DescribeOption{ngerman}
1013 % \DescribeOption{danish}
1014 % \DescribeOption{croatian}
1015 % \fx currently supports English (the default), French, Spanish, Italian,
1016 % German, Danish and Croatian. You can select your preferred language by using
1017 % the corresponding language option. These options usually appear in the call
1018 % to \cs{documentclass} or \cs{usepackage}, but they are also understood by
1019 % \cs{fxsetup} and all the annotation commands or environments. This
1020 % allows you to change the selected language either globally or locally, and
1021 % at any point in the document. The \texttt{french} and \texttt{francais}
1022 % options are synonyms. The \texttt{german} and \texttt{ngerman} options are
1023 % currently equivalent.
1024 %
1025 % \DescribeOption{lang}
1026 % If you're manipulating language settings at the level of \fx itself (as
1027 % opposed to the \cs{documentclass} level), then the preferred way to specify
1028 % a language is to use the \texttt{lang} option, and give it the language name
1029 % as a value. For instance:
1030 % \begin{verbatim}
1031 % \usepackage[lang=french]{fixme}
1032 % \end{verbatim}
1033 %
1034 % \subsubsection{Language tracking}
1035 % \DescribeOption{langtrack}
1036 % If the document you're working on has parts written in different languages,
1037 % it might be the case that the annotations should follow the current language
1038 % as well (especially if you're in collaborative mode; see section
1039 % \sectionref{sec:manual:modes}). \fx provides a boolean option named
1040 % \texttt{langtrack}. When specified, \fx assumes that you're using
1041 % \texttt{babel} and automatically switches to the current language (as
1042 % specified by \texttt{babel}'s \cs{languagename} command), without requiring
1043 % an explicit language option.
1044 %
1045 % \DescribeOption{defaultlang}
1046 % In the case where tracking falls on a language unsupported by \fx, a
1047 % warning will be issued and \fx will switch to the language specified by
1048 % the \texttt{defaultlang} option (\texttt{english} by default). If you happen
1049 % to get one of these warnings, please consider sending me a patch with
1050 % support for this new language (see section \sectionref{sec:code:i18n}).
1051 %
1052 % Finally, note that specifying a language explicitely (by means of a language
1053 % option) in the annotation commands and environments always takes
1054 % precedence over the language tracking behavior.
1055 %
1056 % \subsubsection{Indexing in different languages}
1057 % If your document contains annotations written in different languages, and
1058 % you have requested the \texttt{index} layout, \fx will not only classify the
1059 % notes by their level of importance, but also by language. For example, if
1060 % you have \fx warnings in both English and French, you will find two
1061 % different subcategories for warnings in the index: one called ``Warnings''
1062 % and one called ``Avertissements''.
1063 %
1064 % \subsection{Standalone or collaborative mode\label{sec:manual:modes}}
1065 % \fx supports collaborative annotations as well as ``standalone'',
1066 % single-author documents.
1067 %
1068 % \subsubsection{Standalone mode}
1069 % By default, \fx is in standalone mode, meaning that it assumes there is
1070 % only one person annotating the document. This has several implications on
1071 % the layout. If you've tried it already, you may have noticed the following
1072 % points.
1073 % \begin{itemize}
1074 % \item All the built-in annotation layouts (index excepted) put the \fx logo
1075 % in front of every note. This is also true for the environments. The idea
1076 % is to distinguish \fx contents from the rest of the document (for instance
1077 % other marginal notes or footnotes).
1078 % \item All annotations are indexed under the main \fx category, and sorted by
1079 % importance level, but the \fx logo is not repeated constantly (that would
1080 % be useless).
1081 % \item Similarly, the list of fixmes does not clutter itself with the logo,
1082 % because we already know that its contents is specific to \fx.
1083 % \end{itemize}
1084 % As a matter of fact, when you see the \fx logo appear somewhere, you're not
1085 % actually contemplating it, but rather the annotation's \emph{author}. It
1086 % just happens that by default (meaning in standalone mode), the only author
1087 % is \fx itself.
1088 %
1089 % \DescribeOption{author}
1090 % In standalone mode, you might be annoyed by this orgy of \fx logos. This
1091 % might happen if for instance you're using the \texttt{margin} layout and you
1092 % \emph{know} there is nothing but \fx annotations in there. In such a case,
1093 % you will most likely want to change the author to \emph{nothing}. This can
1094 % be acomplished by using the \texttt{author} option, which is understood by
1095 % the package itself, the \cs{fxsetup} command and all the annotation
1096 % commands or environments. Doing something like the following will get rid of
1097 % the damn logo for good:
1098 % \begin{verbatim}
1099 % \usepackage[author=]{fixme}
1100 % \end{verbatim}
1101 %
1102 % \subsubsection{Collaborative mode}
1103 % If, on the other hand, you're working in collaboration with other people,
1104 % every potential ``fixer'' might want to tag his or her own annotations. So
1105 % assuming that John Doe is another author, he would most likely do something
1106 % like this:
1107 % \begin{verbatim}
1108 % \fxfatal[author=JD]{rephrase this}
1109 % \end{verbatim}
1110 % And suddenly, John's fatal comment will be prefixed with his initials. This
1111 % is not a very satisfactory solution however, because it would require you to
1112 % explicitely provide the author's tag in every single note you create.
1113 % Fortunately, \fx offers an easier way to achieve this.
1114 %
1115 % \paragraph{Registering new authors}
1116 % \DescribeMacro{\FXRegisterAuthor}\marg{cmdprefix}\marg{envprefix}\marg{tag}\\
1117 % The command \cs{FXRegisterAuthor} registers a new author with \fx. It takes
1118 % three arguments: the last one (\meta{tag}) is just the same as the value you
1119 % would pass to the \texttt{author} option: it will serve as a prefix (or
1120 % signature) for John's annotations. In addition to that, a complete new set
1121 % of user-level commands (prefixed with \meta{cmdprefix}) and environments
1122 % (prefixed with \meta{envprefix}) will be created. To clarify, suppose that
1123 % we have registered John like this:
1124 % \begin{verbatim}
1125 % \FXRegisterAuthor{jd}{ajd}{JD}
1126 % \end{verbatim}
1127 % Now, John can use the commands \cs{jdnote}, \cs{jdwarning} \etc, along with
1128 % their starred versions, and he can also use the environments
1129 % \texttt{ajdnote}, \texttt{ajdwarning} \etc, along with their starred
1130 % versions as well. If you really want to know the whole story, it turns out
1131 % that the main \fx interface described in section
1132 % \sectionref{sec:manual:insertion} is created with this single line of code:
1133 % \begin{verbatim}
1134 % \FXRegisterAuthor{fx}{anfx}{fixme}
1135 % \end{verbatim}
1136 %
1137 % \textbf{Warning!} \meta{cmdprefix} and \meta{envprefix} need to be
1138 % different, or you will get very strange errors. The technical reason is that
1139 % in \LaTeX, an environment named \texttt{foo} is defined in terms of two
1140 % commands: \cs{foo} and \cs{endfoo} (yes, this is silly; the first one should
1141 % really be \cs{beginfoo}). As a consequence, if you use the same prefix, you
1142 % will get a name clash between the annotation commands and environments.
1143 %
1144 % \paragraph{Fun with the \texttt{author} option}
1145 % Some precisions about the author option are in order here. When a new
1146 % author is registered with \fx, the generated commands and environments
1147 % work by \emph{presetting} the author option to the specified \meta{tag}.
1148 % This means that it is still possible to override it explicitely like this:
1149 % \begin{verbatim}
1150 % \jdfatal[author=Anonymous]{For $500.00, you got your Ph.D.}
1151 % \end{verbatim}
1152 % I don't see any good reason for doing it though, the above example
1153 % notwithstanding.^^A $ AUCTeX hack to prevent math-mode
1154 %
1155 % The final remark is about the default \texttt{fx*} user interface: the
1156 % \texttt{fixme} default user is special in that it is the only registered
1157 % user to honor a global \texttt{author} option (provided in the call to
1158 % \cs{usepackage} or \cs{fxsetup}). The intended use of this is that the
1159 % \emph{main} author of the document uses the \texttt{fx*} interface
1160 % (preferably with a personal \texttt{author} setting, different from the \fx
1161 % logo), and all other authors are registered via \cs{FXRegisterAuthor}.
1162 %
1163 % \paragraph{Globally switching to collaborative mode}
1164 % We're getting close, but we're not quite there yet. Perhaps you would like
1165 % to see the tags from the different authors in the list of fixmes, or even in
1166 % the index? Remember that \fx is in standalone mode by default, so the
1167 % (only) tag does not appear in those places.
1168 %
1169 % \noindent
1170 % \DescribeOption{singleuser}
1171 % \DescribeOption{multiuser}
1172 % \DescribeOption{mode}
1173 % If you want this additional information, you've got to ask \fx to
1174 % globally switch to collaborative mode. This can be done with either one of
1175 % the three options \texttt{singleuser}, \texttt{mutliuser} or \texttt{mode}.
1176 % \texttt{singleuser} and \texttt{multiuser} are boolean options. The
1177 % \texttt{mode} option takes a value of either \texttt{singleuser} or
1178 % \texttt{multiuser}. This is the preferred way to switch the mode. These
1179 % options are understood globally by \cs{usepackage} or \cs{fxsetup}, and also
1180 % locally by the annotation commands or environments.
1181 %
1182 % When collaborative mode is active, \fx adjusts the list of fixmes layout to
1183 % display the authors tags as well. Additionally, the annotations are indexed
1184 % as before, but additional index entries, sorted by author, are generated as
1185 % well.
1186 %
1187 % \subsection{Themes\label{sec:manual:themes}}
1188 % Themes are orthogonal to layouts: they provide a way to modify the overall
1189 % appearance of \fx by overriding the existing layouts and/or by providing new
1190 % ones. In fact, a theme can be any kind of customization that you would
1191 % otherwise put in your preamble.
1192 %
1193 % \subsubsection{Using themes}
1194 % \DescribeOption{theme}
1195 % The interface for using a theme is quite simple: use the \texttt{theme}
1196 % option and give it the name of the theme you want to use. Themes are always
1197 % external: there are none in the core of \fx but instead they are provided
1198 % as independent files. As a consequence, the \texttt{theme} option has the
1199 % same usage restrictions as all the layout options we've encountered so far.
1200 % Moreover, it is not possible to ``maintain'' several themes and switch
1201 % between them in a single document. Themes can be loaded only in the
1202 % preamble.
1203 %
1204 % \noindent\DescribeMacro{\fxusetheme}\marg{name}\\
1205 % An alternative to the \texttt{theme} option is to use the \cs{fxusetheme}
1206 % command, which takes the theme's name as its only mandatory argument.
1207 %
1208 % \subsubsection{Available themes}
1209 % \fx comes with a number of predefined themes listed below.
1210 %
1211 % \paragraph{The \texttt{signature} theme}
1212 % \DescribeTheme{signature}
1213 % This theme uses the \texttt{signature} environment layout (see section
1214 % \sectionref{sec:manual:envlayoutslist}), and overrides the built-in ones to
1215 % display the author tags as a signature (\ie at the end of the annotations)
1216 % instead of as a prefix. All original layout faces are honored.
1217 %
1218 % \paragraph{The \texttt{color} theme}
1219 % \DescribeTheme{color}
1220 % This theme uses the \texttt{color} environment and target layouts (see
1221 % sections \sectionref{sec:manual:envlayoutslist} and
1222 % \sectionref{sec:manual:targetlayoutslist}), and overrides the built-in ones
1223 % to use different colors for the different annotation levels. As a
1224 % consequence, it also avoids printing the annotation names because this
1225 % information is already contained in the colors themselves. All original
1226 % layout faces are honored, but the \texttt{inline} one is reset to
1227 % \meta{nothing}. Remember that the \texttt{env} and \texttt{target} faces are
1228 % reset as well (this is actually done by the \texttt{color} environment and
1229 % target layouts).
1230 %
1231 % \paragraph{The \texttt{colorsig} theme}
1232 % \DescribeTheme{colorsig}
1233 % This theme combines the features of the \texttt{color} and
1234 % \texttt{signature} ones. All original layout faces are honored, but
1235 % the \texttt{inline} one is reset to \meta{nothing}.
1236 %
1237 % \section{Extending \fx}
1238 % Hear hear, this is where you start spending more time hacking \LaTeX{} than
1239 % actually writing your document\ldots
1240 %
1241 % \subsection{Modifying existing layouts}
1242 % \fx annotations, environment and target layouts are implemented as a (set
1243 % of) commands conforming to strict prototypes. If you're not happy with the
1244 % way they perform, you have the possibility to \cs{renewcommand} them (in
1245 % fact, you should use \cs{renewcommand*} for annotation and environment
1246 % layouts). In such a case, it is probably best to have a look at the code in
1247 % order to figure out how the original ones are written. However, a
1248 % description of their prototypes is given below.
1249 %
1250 % \subsubsection{Modifying existing annotation layouts}
1251 % \DescribeMacro[noindex]{\FXLayout\meta{name}}
1252 % \marg{type}\marg{annotation}\marg{author}\\
1253 % \DescribeMacro[noprint]{\FXLayoutInline}
1254 % \DescribeMacro[noprint]{\FXLayoutMargin}
1255 % \DescribeMacro[noprint]{\FXLayoutFootnote}
1256 % \DescribeMacro[noprint]{\FXLayoutIndex}
1257 % \DescribeMacro[noprint]{\FXLayoutMarginClue}
1258 % Each annotation layout is implemented as a macro taking three mandatory
1259 % arguments. By convention, this macro is named \cs{FXLayout}\meta{name}, for
1260 % instance \cs{FXLayoutInline}. \meta{type} is the annotation type. It can be
1261 % one of \texttt{note}, \texttt{warning}, \texttt{error} and \texttt{fatal}.
1262 % \meta{annotation} is the annotation itself, and \meta{author} is the
1263 % author's tag.
1264 %
1265 % \subsubsection{Modifying existing environment layouts}
1266 % \DescribeMacro[noindex]{\FXEnvLayout\meta{name}Begin}
1267 % \DescribeMacro[noindex]{\FXEnvLayout\meta{name}End}\marg{type}\marg{author}\\
1268 % \DescribeMacro[noprint]{\FXEnvLayoutPlainBegin}
1269 % \DescribeMacro[noprint]{\FXEnvLayoutPlainEnd}
1270 % \DescribeMacro[noprint]{\FXEnvLayoutSignatureBegin}
1271 % \DescribeMacro[noprint]{\FXEnvLayoutSignatureEnd}
1272 % \DescribeMacro[noprint]{\FXEnvLayoutColorBegin}
1273 % \DescribeMacro[noprint]{\FXEnvLayoutColorEnd}
1274 % \DescribeMacro[noprint]{\FXEnvLayoutColorSigBegin}
1275 % \DescribeMacro[noprint]{\FXEnvLayoutColorSigEnd}
1276 % \begin{sloppypar}\noindent
1277 % Each environment layout is implemented as two macros taking two mandatory
1278 % arguments. By convention, these macros are named
1279 % \cs{FXEnvLayout}\meta{name}\texttt{Begin} and
1280 % \cs{FXEnvLayout}\meta{name}\texttt{End}, for instance
1281 % \cs{FXEnvLayoutPlainBegin} and \cs{FXEnvLayoutPlainEnd}. \meta{type} is
1282 % the annotation type. It can be one of \texttt{note}, \texttt{warning},
1283 % \texttt{error} and \texttt{fatal}. \meta{author} is the author's tag.
1284 % \end{sloppypar}
1285 %
1286 % \subsubsection{Modifying existing target layouts}
1287 % \DescribeMacro[noindex]{\FXTargetLayout\meta{name}}\marg{type}\marg{target}\\
1288 % \DescribeMacro[noprint]{\FXTargetLayoutPlain}
1289 % \DescribeMacro[noprint]{\FXTargetLayoutColor}
1290 % Each target layout is implemented as a macro taking two mandatory arguments.
1291 % By convention, this macro is named \cs{FXTargetLayout}\meta{name}, for
1292 % instance \cs{FXTargetLayoutPlain}. \meta{type} is the annotation type. It
1293 % can be one of \texttt{note}, \texttt{warning}, \texttt{error} and
1294 % \texttt{fatal}. \meta{target} is the textual target.
1295 %
1296 % \subsection{Creating new layouts}
1297 % Creating a new layout first requires that you write new layout macros as
1298 % described in the previous section. Once you've done that, the next step is
1299 % to make \fx aware of this addition. This is called ``registering'' a layout.
1300 %
1301 % \subsubsection{Registering a new annotation layout}
1302 % \paragraph{Early \vs late layouts} Normally, \fx typesets your annotations
1303 % at the current position in the text, using a sensible order for built-in
1304 % layouts. For instance, the \texttt{footnote} layout, if active, is performed
1305 % before the \texttt{inline} one, so that the footnote mark is sticked to the
1306 % preceding text and not to the annotation. When using targeted commands or
1307 % environments, the situation is a bit more complex: some layouts make more
1308 % sense at the beginning of the textual target, and some others at the end.
1309 % The former ones are called ``early layouts'' and the later ones are called
1310 % ``late layouts''. A typical example of an early layout is the
1311 % \texttt{margin} one: if you're highlighting a long portion of text, it is
1312 % more convenient to see the marginal note appear near the top of that text,
1313 % rather than near the end of it (a nice illustration of this is to combine
1314 % the \texttt{changebar} target layout and \texttt{margin} annotation layout).
1315 % As for built-in layouts, only the \texttt{margin} and \texttt{marginclue}
1316 % ones are early. All others are late. When you create a new layout, you need
1317 % to decide whether it is an early or a late one.
1318 %
1319 % \paragraph{Registering late layouts}
1320 % \begin{sloppypar}
1321 % \DescribeMacro{\FXRegisterLayout}\oarg{mutex}\marg{name}\marg{macro}\\
1322 % In order to register a late annotation layout with \fx, use the command
1323 % \cs{FXRegisterLayout}. This macro has two mandatory arguments: the layout
1324 % \meta{name} (at least 3 characters long) and the associated layout
1325 % \meta{macro}. For instance, the \texttt{inline} layout is registered like
1326 % this:
1327 % \end{sloppypar}
1328 % \begin{verbatim}
1329 % \FXRegisterLayout{inline}{\FXLayoutInline}
1330 % \end{verbatim}
1331 % Once registered, the new layout gets a boolean option \meta{name} and is
1332 % also recognized by the \texttt{layout} and \texttt{morelayout} options, as
1333 % well as by the \cs{fxuselayouts} command as \meta{name}.
1334 %
1335 % The first (optional) argument \meta{mutex} is a comma-separated list of
1336 % other layout names that should be in mutual exclusion with the layout we are
1337 % registering (for example, the \texttt{margin} and \texttt{marginclue}
1338 % layouts are in mutual exclusion). Note that mutual exclusion between two
1339 % layouts need only be registered once. In other words, a previsouly
1340 % registered layout will automatically be made aware of subsequent mutex
1341 % declarations.
1342 %
1343 % \paragraph{Registering early layouts}
1344 % \DescribeMacro{\FXRegisterLayout*}\oarg{mutex}\marg{name}\marg{macro}\\
1345 % In order to register an early annotation layout with \fx, use the starred
1346 % form of \cs{FXRegisterLayout}. Everything else behaves the same.
1347 %
1348 % \paragraph{Providing a layout}
1349 % \DescribeMacro{\FXProvidesLayout}\marg{name}\oarg{release information}\\
1350 % If you want to save your layout externally, you need to store it in a file
1351 % named \texttt{fxlayout}\meta{name}\texttt{.sty} and advertise it by calling
1352 % \cs{FXProvidesLayout}. It will then be recognized by the \cs{fxloadlayouts}
1353 % command as \meta{name}.
1354 %
1355 % \subsubsection{Registering a new environment layout}
1356 % \begin{sloppypar}
1357 % \DescribeMacro{\FXRegisterEnvLayout}\marg{name}\marg{begin}\marg{end}\\
1358 % In order to register a new environment layout with \fx, use the command
1359 % \cs{FXRegisterEnvLayout}. This macro has three mandatory arguments: the
1360 % layout \meta{name} and the associated \meta{begin} and \meta{end} macros.
1361 % For instance, the \texttt{color} layout is registered like this:
1362 % \end{sloppypar}
1363 % \begin{verbatim}
1364 % \FXRegisterEnvLayout{color}{\FXEnvLayoutColorBegin}{\FXEnvLayoutColorEnd}
1365 % \end{verbatim}
1366 % Once registered, the new layout is recognized by the \texttt{envlayout}
1367 % option and by the \cs{fxuseenvlayout} command as \meta{name}.
1368 %
1369 % \noindent
1370 % \DescribeMacro{\FXProvidesEnvLayout}\marg{name}\oarg{release information}\\
1371 % If you want to save your layout externally, you need to store it in a file
1372 % named \texttt{fxenvlayout}\meta{name}\texttt{.sty} and advertise it by
1373 % calling \cs{FXProvidesEnvLayout}. It will then be recognized by the
1374 % \cs{fxloadenvlayouts} commands as \meta{name}.
1375 %
1376 % \subsubsection{Registering a new target layout}
1377 % \begin{sloppypar}
1378 % \DescribeMacro{\FXRegisterTargetLayout}\marg{name}\marg{macro}\\
1379 % In order to register a new target layout with \fx, use the command
1380 % \cs{FXRegisterTargetLayout}. This macro has two mandatory arguments: the
1381 % layout \meta{name} and the associated \meta{macro}. For instance, the
1382 % \texttt{color} layout is registered like this:
1383 % \end{sloppypar}
1384 % \begin{verbatim}
1385 % \FXRegisterTargetLayout{color}{\FXTargetLayoutColor}
1386 % \end{verbatim}
1387 % Once registered, the new layout is recognized by the \texttt{targetlayout}
1388 % option and by the \cs{fxusetargetlayout} as \meta{name}.
1389 %
1390 % \noindent
1391 % \DescribeMacro{\FXProvidesTargetLayout}\marg{name}\oarg{release
1392 % information}\\
1393 % If you want to save your layout externally, you need to store it in a file
1394 % named \texttt{fxtargetlayout}\meta{name}\texttt{.sty} and advertise it by
1395 % calling \cs{FXProvidesTargetLayout}. It will then be recognized by the
1396 % \cs{fxloadtargetlayouts} commands as \meta{name}.
1397 %
1398 % \subsection{Adding new options}
1399 % \begin{quotation}\itshape
1400 % \textbf{Note:} \fx uses the \texttt{xkeyval} package for its underlying
1401 % options management, so some knowledge of this package is required in order
1402 % to understand the remainder of this section.
1403 % \end{quotation}
1404 % Yet another way to customize \fx is to plug additional behavior in, by way
1405 % of options. As of version 4.5, \fx provides a convenient interface for
1406 % creating new options, and associate them with code to execute.
1407 %
1408 % First of all, new options must belong to a ``family'', which essentially
1409 % defines exactly where they make sense. \fx currently provides three option
1410 % families: \texttt{Layout}, \texttt{EnvLayout}, and
1411 % \texttt{TargetLayout}. Obviously, these families allow you to define options
1412 % that will affect the behavior of the corresponding three kinds of layouts.
1413 %
1414 % For each family, \fx provides five commands wrapping around \texttt{xkeyval}
1415 % to define special kinds of options (\emph{keys} in the \texttt{xkeyval}
1416 % jargon). They are explained below.
1417 %
1418 % \noindent\DescribeMacro[noindex]{\FXDefine\meta{family}Key}
1419 % \marg{key}\oarg{default}\marg{function}\\
1420 % \DescribeMacro[noprint]{\FXDefineLayoutKey}
1421 % \DescribeMacro[noprint]{\FXDefineEnvLayoutKey}
1422 % \DescribeMacro[noprint]{\FXDefineTargetLayoutKey}
1423 % Define an \texttt{xkeyval} ordinary \meta{key} belonging to \meta{family}.
1424 %
1425 % \noindent\DescribeMacro[noindex]{\FXDefine\meta{family}CmdKey}
1426 % \oarg{mp}\marg{key}\oarg{default}\marg{function}\\
1427 % \DescribeMacro[noprint]{\FXDefineLayoutCmdKey}
1428 % \DescribeMacro[noprint]{\FXDefineEnvLayoutCmdKey}
1429 % \DescribeMacro[noprint]{\FXDefineTargetLayoutCmdKey}
1430 % Define an \texttt{xkeyval} command \meta{key} belonging to \meta{family}.
1431 %
1432 % \noindent\DescribeMacro[noindex]{\FXDefine\meta{family}ChoiceKey}
1433 % \marg{key}\oarg{bin}\marg{alternatives}\oarg{default}\marg{function}\\
1434 % \DescribeMacro[noprint]{\FXDefineLayoutChoiceKey}
1435 % \DescribeMacro[noprint]{\FXDefineEnvLayoutChoiceKey}
1436 % \DescribeMacro[noprint]{\FXDefineTargetLayoutChoiceKey}
1437 % Define an \texttt{xkeyval} choice \meta{key} belonging to \meta{family}.
1438 %
1439 % \noindent\DescribeMacro[noindex]{\FXDefine\meta{family}VoidKey}
1440 % \marg{key}\marg{func}\\
1441 % \DescribeMacro[noprint]{\FXDefineLayoutVoidKey}
1442 % \DescribeMacro[noprint]{\FXDefineEnvLayoutVoidKey}
1443 % \DescribeMacro[noprint]{\FXDefineTargetLayoutVoidKey}
1444 % A ``void \meta{key}'' is an option that is not supposed to get an
1445 % argument. This property is automatically checked everytime the option is
1446 % used.
1447 %
1448 % \noindent\DescribeMacro[noindex]{\FXDefine\meta{family}BoolKey}
1449 % \oarg{func}\marg{key}\\
1450 % \DescribeMacro[noprint]{\FXDefineLayoutBoolKey}
1451 % \DescribeMacro[noprint]{\FXDefineEnvLayoutBoolKey}
1452 % \DescribeMacro[noprint]{\FXDefineTargetLayoutBoolKey}
1453 % Finally, a ``boolean \meta{key}'' is like an \texttt{xkeyval} one, with the
1454 % addition that for every such \texttt{key}, there is a void \texttt{nokey}
1455 % counterpart.
1456 %
1457 % Every new option you define is inserted into the global options management
1458 % mechanism, which has some implications.
1459 % \begin{itemize}
1460 % \item First of all, new options are automatically available almost
1461 % everywhere, and in particular in the \cs{fxsetup} macro, in the
1462 % annotations commands and environments, \etc Note however that the
1463 % \texttt{EnvLayout} and \texttt{TargetLayout} family options are only
1464 % processed when it makes sense, that is, when environments or targeted
1465 % commands are involved.
1466 % \item Because new options are treated globally, they may affect every layout
1467 % (existing, loaded in the future, \etc) and of course, also the built-in
1468 % ones. Suppose, for example, that you want the ability to adjust the
1469 % vertical position of the marginal notes layout. One solution is to create
1470 % a \texttt{vadj} option like this:
1471 % |\FXDefineLayoutKey{vadj}{\def\marginnotevadjust{#1}}|, which you can then
1472 % use like that: |\fxnote[vadj=.5ex]{...}|.
1473 % \item Finally, and again, because options are treated globally, beware of
1474 % name clashes! Every option name must be unique within a family.
1475 % \end{itemize}
1476 %
1477 % \subsection{Creating a new theme}
1478 % Creating a new theme may involve anything from using (by way of
1479 % \cs{fxsetup}) or modifying existing layouts, to providing new ones. If your
1480 % new theme has specific layouts, you may consider writing them in seperate
1481 % files as described before, in order to make them more generally available.
1482 %
1483 % \noindent
1484 % \DescribeMacro{\FXRequireLayouts}\marg{layout names}\\
1485 % In order to use external layouts in a theme, use the command
1486 % \cs{FXRequireLayouts}, passing it a list of \meta{layout names} as
1487 % argument.\\
1488 % \DescribeMacro{\FXRequireEnvLayout}
1489 % \DescribeMacro{\FXRequireTargetLayout}\marg{name}\\
1490 % In order to use and external environment or target layout in a theme, use
1491 % the commands \cs{FXRequire*Layout} and give them the layout's name as
1492 % argument.
1493 %
1494 % \noindent
1495 % \DescribeMacro{\FXProvidesTheme}\marg{name}\oarg{release information}\\
1496 % A theme should be saved in a file named
1497 % \texttt{fxtheme}\meta{name}\texttt{.sty} and advertised by calling
1498 % \cs{FXProvidesTheme}. It will then be recognized by the \texttt{theme}
1499 % option and the \cs{fxusetheme} command.
1500 %
1501 % \subsection{Internationalization}
1502 % \DescribeMacro[noindex]{\fx\meta{lang}name}
1503 % \DescribeMacro[noindex]{\fx\meta{lang}sname}
1504 % \DescribeMacro[noprint]{\fxenglishnotename}
1505 % \DescribeMacro[noprint]{\fxenglishnotesname}
1506 % \DescribeMacro[noprint]{\fxenglishwarningname}
1507 % \DescribeMacro[noprint]{\fxenglishwarningsname}
1508 % \DescribeMacro[noprint]{\fxenglisherrorname}
1509 % \DescribeMacro[noprint]{\fxenglisherrorsname}
1510 % \DescribeMacro[noprint]{\fxenglishfatalname}
1511 % \DescribeMacro[noprint]{\fxenglishfatalsname}
1512 % \DescribeMacro[noprint]{\fxfrenchnotename}
1513 % \DescribeMacro[noprint]{\fxfrenchnotesname}
1514 % \DescribeMacro[noprint]{\fxfrenchwarningname}
1515 % \DescribeMacro[noprint]{\fxfrenchwarningsname}
1516 % \DescribeMacro[noprint]{\fxfrencherrorname}
1517 % \DescribeMacro[noprint]{\fxfrencherrorsname}
1518 % \DescribeMacro[noprint]{\fxfrenchfatalname}
1519 % \DescribeMacro[noprint]{\fxfrenchfatalsname}
1520 % \DescribeMacro[noprint]{\fxspanishnotename}
1521 % \DescribeMacro[noprint]{\fxspanishnotesname}
1522 % \DescribeMacro[noprint]{\fxspanishwarningname}
1523 % \DescribeMacro[noprint]{\fxspanishwarningsname}
1524 % \DescribeMacro[noprint]{\fxspanisherrorname}
1525 % \DescribeMacro[noprint]{\fxspanisherrorsname}
1526 % \DescribeMacro[noprint]{\fxspanishfatalname}
1527 % \DescribeMacro[noprint]{\fxspanishfatalsname}
1528 % \DescribeMacro[noprint]{\fxitaliannotename}
1529 % \DescribeMacro[noprint]{\fxitaliannotesname}
1530 % \DescribeMacro[noprint]{\fxitalianwarningname}
1531 % \DescribeMacro[noprint]{\fxitalianwarningsname}
1532 % \DescribeMacro[noprint]{\fxitalianerrorname}
1533 % \DescribeMacro[noprint]{\fxitalianerrorsname}
1534 % \DescribeMacro[noprint]{\fxitalianfatalname}
1535 % \DescribeMacro[noprint]{\fxitalianfatalsname}
1536 % \DescribeMacro[noprint]{\fxgermannotename}
1537 % \DescribeMacro[noprint]{\fxgermannotesname}
1538 % \DescribeMacro[noprint]{\fxgermanwarningname}
1539 % \DescribeMacro[noprint]{\fxgermanwarningsname}
1540 % \DescribeMacro[noprint]{\fxgermanerrorname}
1541 % \DescribeMacro[noprint]{\fxgermanerrorsname}
1542 % \DescribeMacro[noprint]{\fxgermanfatalname}
1543 % \DescribeMacro[noprint]{\fxgermanfatalsname}
1544 % \DescribeMacro[noprint]{\fxdanishnotename}
1545 % \DescribeMacro[noprint]{\fxdanishnotesname}
1546 % \DescribeMacro[noprint]{\fxdanishwarningname}
1547 % \DescribeMacro[noprint]{\fxdanishwarningsname}
1548 % \DescribeMacro[noprint]{\fxdanisherrorname}
1549 % \DescribeMacro[noprint]{\fxdanisherrorsname}
1550 % \DescribeMacro[noprint]{\fxdanishfatalname}
1551 % \DescribeMacro[noprint]{\fxdanishfatalsname}
1552 % \DescribeMacro[noprint]{\fxcroatiannotename}
1553 % \DescribeMacro[noprint]{\fxcroatiannotesname}
1554 % \DescribeMacro[noprint]{\fxcroatianwarningname}
1555 % \DescribeMacro[noprint]{\fxcroatianwarningsname}
1556 % \DescribeMacro[noprint]{\fxcroatianerrorname}
1557 % \DescribeMacro[noprint]{\fxcroatianerrorsname}
1558 % \DescribeMacro[noprint]{\fxcroatianfatalname}
1559 % \DescribeMacro[noprint]{\fxcroatianfatalsname}
1560 % \fx's language control has been described in section
1561 % \sectionref{sec:manual:i18n}. For every supported language \meta{lang}, a
1562 % number of macros define the language-dependent part of \fx. The commands
1563 % \cs{fx}\meta{lang}\texttt{notename}, \cs{fx}\meta{lang}\texttt{notesname},
1564 % and their equivalent for the other annotation levels define the singular and
1565 % plural forms of the note names.\\
1566 % \DescribeMacro[noindex]{\ \unskip\meta{lang}listfixmename}
1567 % \DescribeMacro[noprint]{\englishlistfixmename}
1568 % \DescribeMacro[noprint]{\frenchlistfixmename}
1569 % \DescribeMacro[noprint]{\spanishlistfixmename}
1570 % \DescribeMacro[noprint]{\italianlistfixmename}
1571 % \DescribeMacro[noprint]{\germanlistfixmename}
1572 % \DescribeMacro[noprint]{\danishlistfixmename}
1573 % \DescribeMacro[noprint]{\croatianlistfixmename}
1574 % The title for the list of fixmes is defined by the command
1575 % \cs{}\meta{lang}\texttt{listfixmename}.
1576 %
1577 % All of these commands may be renewed, and their values will be honored by
1578 % \fx in all situations, including potential language changes across the
1579 % document.
1580 %
1581 % \section{History\label{sec:manual:history}}
1582 % \begin{itemize}
1583 % \item[v4.5] Public interface for extending \fx with new key/value options.\\
1584 % Revamp the \auctex support, with help from Arash Esbati and
1585 % Ikumi Keita.\\
1586 % Fix PDF signature layouts not working anymore, reported by Soeren
1587 % Wolfers.\\
1588 % Fix spurious space at the end of environments contents, reported
1589 % by Frank Mittelbach.
1590 % \item[v4.4] Handle existing yet empty lox file properly, meaning don't
1591 % actually typeset an empty list of corrections.\\
1592 % Don't update the \texttt{lox} file in final mode, avoiding potential
1593 % typesetting artifacts, reported by Lars Madsen.\\
1594 % Various internals and documentation improvements.
1595 % \item[v4.3] Add a paragraph about the duplication of notes in captions, upon
1596 % exchange with Kreuvf.\\
1597 % Update support for the \komascript classes by using the
1598 % \texttt{tocbasic} interface when available, reported by Dirk Surmann.\\
1599 % Separate inline notes from the text they follow, suggested by Victor
1600 % Porton.\\
1601 % Fix potential inline layouts color leakage, reported by Victor Porton.\\
1602 % Fix several parsing problems when passing optional arguments containing
1603 % brackets, thanks to Joseph Wright and Lars Madsen.
1604 % \item[v4.2] Improve Danish translation, thanks to Lars Madsen.\\
1605 % Fix buglet in \cs{@wrindex} redefinition, reported by Norman Gray.
1606 % \item[v4.1] 8 new PDF-specific annotation layouts.\\
1607 % New annotation layout: \texttt{marginnote}, suggested by S\'ebastien
1608 % Mengin.\\
1609 % Better mechanism for handling layout mutual exclusion.\\
1610 % Fix bug in inner layout processing.
1611 % \item[v4.0] Support for collaborative annotations, suggested by Michael
1612 % Kubovy.\\
1613 % Support for ``targeted'' notes and environments (highlighting a portion of
1614 % text), suggested by Mark Edgington.\\
1615 % Support for ``floating notes'' (not specific to any portion of text),
1616 % suggested by Rasmus Villemoes.\\
1617 % Support for alternative layout autoswitch in \TeX's inner mode, suggested
1618 % by Will Robertson.\\
1619 % Support for automatic language tracking in multilingual documents.\\
1620 % Support for themes.\\
1621 % Extended support for user-provided layouts.\\
1622 % Support for \texttt{key=value} argument syntax in the whole user
1623 % interface.\\
1624 % New command \cs{fxsetup}.\\
1625 % Homogenize the log and console messages.\\
1626 % Heavy internals refactoring.
1627 % \item[v3.4] \cs{fixme}, \cs{fxerror}, \cs{fxwarning} and \cs{fxnote} are now
1628 % robust, thanks to Will Robertson.\\
1629 % Fix incompatibility with \komascript classes version of \cs{@starttoc}
1630 % when the lox file is inexistent, reported by Philipp Stephani.
1631 % \item[v3.3] Document incompatibility between marginal layout and the ACM
1632 % SIG classes, reported by Jochen Wuttke.\\
1633 % Honor \texttt{twoside} option in marginal layout, suggested by Jens
1634 % Remus.\\
1635 % Support for \komascript classes version 2006/07/30 v2.95b, suggested by
1636 % Jens Remus.\\
1637 % Documentation improvements suggested by Brian van den Broek.\\
1638 % Fix incompatibility with \texttt{amsart} reported by Lars Madsen:
1639 % \cs{@starttoc} takes two arguments.\\
1640 % Fix bug reported by Stefan Mann: a typo in the \cs{fixme@footnotetrue}
1641 % macro name.
1642 % \item[v3.2] Added the marginclue layout option which only signals a fixme in
1643 % the margin, withtout the actual contents.\\
1644 % Support for Croatian thanks to Marcel Maretic.\\
1645 % Fix incompatibility with \texttt{amsbook} reported by Claude
1646 % Lacoursi\`ere: \cs{@starttoc} takes two arguments.\\
1647 % Fix incompatibility with Beamer reported by Akim Demaille: protect
1648 % contents of lox file.
1649 % \item[v3.1] Fix bug reported by Arnold Beckmann: the environments were
1650 % visible in final mode.
1651 % \item[v3.0] Added environments corresponding to the annotation
1652 % commands.\\
1653 % Added an optional first argument to the annotation commands
1654 % to change the layout locally.\\
1655 % Fix bug reported by Akim Demaille: marginal notes could mess up the
1656 % document's layout by flushing it right.
1657 % \item[v2.2] New option \texttt{silent} to suppress notes logging.\\
1658 % Support for Danish thanks to Kim Rud Bille.
1659 % \item[v2.1] Use \cs{nobreakspace} instead of the tilda character. This
1660 % avoids conflicts with Babel in Spanish environments.\\
1661 % Fix bug reported by Knut Lickert: index entries were unconditionally
1662 % built.
1663 % \item[v2.0] New feature: note levels.\\
1664 % New feature: \fx note counters and usage summary.\\
1665 % Suggestions from Kasper B. Graversen.\\
1666 % Support for Spanish thanks to Agust\'in Mart\'in.
1667 % \item[v1.5] New appearance option: \texttt{inline}.
1668 % \item[v1.4] Support for the \komascript classes.\\
1669 % Fix bug reported by Ulf Jaenicke-Roessler: the \cs{listoffixmes} command
1670 % didn't work when called before the first \fx note.
1671 % \item[v1.3] Support for Italian thanks to Riccardo Murri.
1672 % \item[v1.2] Support for German thanks to Harald Harders.
1673 % \end{itemize}
1674 %
1675 % \StopEventually{\vfill\hfill\small \packagecopyright{}.}
1676 %
1677 % \section{Implementation}
1678 % \subsection{Preamble}
1679 % \begin{macrocode}
1680 %<fixme>
1681 \NeedsTeXFormat{LaTeX2e}
1682 %<*header>
1683 \ProvidesPackage{fixme}[2019/01/03 v4.5 Collaborative annotations for LaTeX2e]
1684
1685 %</header>
1686 % \end{macrocode}
1687 % Some required packages:
1688 % \begin{macrocode}
1689 %<*fixme>
1690 \RequirePackage{ifthen}
1691 \RequirePackage{verbatim}
1692 \RequirePackage{xkeyval}[2006/11/18]
1693
1694 %</fixme>
1695 % \end{macrocode}
1696 % \begin{macro}{\fixmelogo}
1697 % The \fx logo:
1698 % \begin{macrocode}
1699 %<*header>
1700 \newcommand\fixmelogo{\textsf{FiXme}}
1701
1702 %</header>
1703 % \end{macrocode}
1704 % \end{macro}
1705 %
1706 % \subsection{Utilities}
1707 % \subsubsection{Miscellaneous}
1708 % \begin{macro}{\@fxpkginfo}
1709 % \begin{macro}{\@fxpkgwarning}
1710 % \marg{msg}\\
1711 % Issue a \fx package info or warning:
1712 % \begin{macrocode}
1713 %<*fixme>
1714 \newcommand\@fxpkginfo{\PackageInfo{FiXme}}
1715 \newcommand\@fxpkgwarning{\PackageWarning{FiXme}}
1716 % \end{macrocode}
1717 % \end{macro}
1718 % \end{macro}
1719 % \begin{macro}{\@fxpkgerror}
1720 % \marg{shortmsg}\marg{longmsg}\\
1721 % Issue a \fx package error:
1722 % \begin{macrocode}
1723 \newcommand\@fxpkgerror{\PackageError{FiXme}}
1724
1725 % \end{macrocode}
1726 % \end{macro}
1727 % \begin{macro}{\@fxaddtolist}
1728 % \marg{list}\marg{elt}\\
1729 % Add \meta{elt} at the end of \meta{list}. We should check for duplicates,
1730 % but this is not currently done.
1731 % \begin{macrocode}
1732 \newcommand*\@fxaddtolist[2]{%
1733 \expandafter\ifx\csname #1\endcsname\relax%
1734 \expandafter\def\csname #1\endcsname{#2}%
1735 \else%
1736 \expandafter\ifx\csname #1\endcsname\empty%
1737 \expandafter\g@addto@macro\csname #1\endcsname{#2}%
1738 \else%
1739 \expandafter\g@addto@macro\csname #1\endcsname{,#2}%
1740 \fi%
1741 \fi}
1742
1743 % \end{macrocode}
1744 % \end{macro}
1745 % \subsubsection{Key-value management (\texttt{xkeyval})}
1746 % \paragraph{Shortcuts}
1747 % The following macros are simple shortcuts for using \texttt{xkeyval} with
1748 % the \texttt{fx} prefix.
1749 % \begin{macro}{\@fxkeyifundefined}
1750 % \marg{families}\marg{key}\marg{then}\marg{else}
1751 % \begin{macrocode}
1752 \newcommand\@fxkeyifundefined{\key@ifundefined[fx]}
1753 % \end{macrocode}
1754 % \end{macro}
1755 % \begin{macro}{\@fxdefinekey}
1756 % \marg{family}\marg{key}\oarg{default}\marg{function}
1757 % \begin{macrocode}
1758 \newcommand\@fxdefinekey{\define@key[fx]}
1759 % \end{macrocode}
1760 % \end{macro}
1761 % \begin{macro}{\@fxdefinecmdkey}
1762 % \marg{family}\oarg{mp}\marg{key}\oarg{default}\marg{function}
1763 % \begin{macrocode}
1764 \newcommand\@fxdefinecmdkey{\define@cmdkey[fx]}
1765 % \end{macrocode}
1766 % \end{macro}
1767 % \begin{macro}{\@fxdefinechoicekey}
1768 % \marg{family}\marg{key}\oarg{bin}\marg{alternatives}\ignorespaces
1769 % \oarg{default}\marg{function}
1770 % \begin{macrocode}
1771 \newcommand\@fxdefinechoicekey{\define@choicekey[fx]}
1772 % \end{macrocode}
1773 % \end{macro}
1774 % \begin{macro}{\@fxsetkeys}
1775 % \marg{families}\oarg{na}\marg{keys}
1776 % \begin{macrocode}
1777 \newcommand\@fxsetkeys{\setkeys[fx]}
1778 % \end{macrocode}
1779 % \end{macro}
1780 % \begin{macro}{\@fxpresetkeys}
1781 % \marg{families}\marg{head keys}\marg{tail keys}
1782 % \begin{macrocode}
1783 %% Note: currently unused
1784 %% \newcommand\@fxpresetkeys{\presetkeys[fx]}
1785
1786 % \end{macrocode}
1787 % \end{macro}
1788 %
1789 % \paragraph{Wrappers}
1790 % \begin{macro}{\@fxvoidkeyerror}
1791 % \marg{key}\marg{value}\\
1792 % Issue a \fx error about a void \meta{key} misuse (see below):
1793 % \begin{macrocode}
1794 \newcommand*\@fxvoidkeyerror[2]{%
1795 \@fxpkgerror{misuse of key '#1'}{%
1796 You have given the key '#1' the argument '#2' but it takes
1797 none.\MessageBreak
1798 Type X to quit, fix that key and re-run LaTeX.\MessageBreak}}
1799 % \end{macrocode}
1800 % \end{macro}
1801 % \begin{macro}{\@fxdefinevoidkey}
1802 % \marg{family}\marg{key}\marg{func}\\
1803 % A \fx ``void \meta{key}'' isn't supposed to get an argument.
1804 % \begin{macrocode}
1805 \newcommand*\@fxdefinevoidkey[3]{%
1806 \define@key[fx]{#1}{#2}[]{%
1807 \ifthenelse{\equal{##1}{}}{%
1808 #3}{%
1809 \@fxvoidkeyerror{#2}{##1}}}}
1810
1811 % \end{macrocode}
1812 % \end{macro}
1813 % \begin{macro}{\@fxdefineboolkey}
1814 % \oarg{func}\marg{family}\marg{key}\\
1815 % A \fx ``boolean \meta{key}'' is like an \texttt{xkeyval} one, with the
1816 % addition that for every such \texttt{key}, there is a void \texttt{nokey}
1817 % counterpart.
1818 % \begin{macrocode}
1819 \newcommand*\@fxdefineboolkey[3][]{%
1820 \define@boolkey[fx]{#2}{#3}[true]{#1}
1821 \@fxdefinevoidkey{#2}{no#3}{\@nameuse{fx@#2@#3}{false}}}
1822
1823 % \end{macrocode}
1824 % \end{macro}
1825 %
1826 % \paragraph{Extension-level option creation interface}
1827 % \begin{macro}{\@fxdefineoptioninterface}
1828 % \marg{family}\marg{infix}
1829 % \begin{macro}[noindex]{\FXDefine...Key}
1830 % \begin{macro}[noindex]{\FXDefine...CmdKey}
1831 % \begin{macro}[noindex]{\FXDefine...ChoiceKey}
1832 % \begin{macro}[noindex]{\FXDefine...VoidKey}
1833 % \begin{macro}[noindex]{\FXDefine...BoolKey}
1834 % This macro defines the extension-level interface allowing users to define
1835 % new \texttt{xkeyval} options for a certain \meta{family}. Note that the core
1836 % of \fx could use those interfaces once defined, but it wouldn't bring much
1837 % to the picture. Indeed, it basically boils down to using a \meta{family}
1838 % within the names of the macros instead of as an argument (and avoiding the
1839 % use of the ``at'' character).
1840 % \begin{macrocode}
1841 \newcommand*\@fxdefineoptioninterface[2]{%
1842 \expandafter\newcommand\csname FXDefine#2Key\endcsname{%
1843 \@fxdefinekey{#1}}%
1844 \expandafter\newcommand\csname FXDefine#2CmdKey\endcsname{%
1845 \@fxdefinecmdkey{#1}}%
1846 \expandafter\newcommand\csname FXDefine#2ChoiceKey\endcsname{%
1847 \@fxdefinechoicekey{#1}}%
1848 \expandafter\newcommand\csname FXDefine#2VoidKey\endcsname{%
1849 \@fxdefinevoidkey{#1}}%
1850 \expandafter\newcommand\expandafter*\csname FXDefine#2BoolKey\endcsname[2][]{%
1851 \@fxdefineboolkey[##1]{#1}{##2}}}
1852
1853 % \end{macrocode}
1854 % \end{macro}
1855 % \end{macro}
1856 % \end{macro}
1857 % \end{macro}
1858 % \end{macro}
1859 % \end{macro}
1860 %
1861 % \subsection{List macros}
1862 % \subsubsection{Contents lines\label{sec:code:contentsline}}
1863 % \begin{macro}{\l@fixme}
1864 % We use the same layout as for the list of figures.
1865 % \begin{macrocode}
1866 \let\l@fixme\l@figure
1867 % \end{macrocode}
1868 % \end{macro}
1869 % \begin{macro}{\@fxdottedtocline}
1870 % \marg{tocdepth}\marg{indent}\marg{numwidth}\marg{contents}\marg{target}\\
1871 % This macro is copied almost verbatim from \LaTeX's core. The intent is to
1872 % do a similar layout, but replacing the last argument, normally a page
1873 % number, by arbitrary text (in our case, a note's target). The original
1874 % macro defines a restricted width to typeset the page number which is much
1875 % too short for us, so we just let the \meta{target} text take all the space
1876 % it needs.
1877 % \begin{macrocode}
1878 \newcommand*\@fxdottedtocline[5]{%
1879 \ifnum #1>\c@tocdepth \else
1880 \vskip \z@ \@plus.2\p@
1881 {\leftskip #2\relax \rightskip \@tocrmarg \parfillskip -\rightskip
1882 \parindent #2\relax\@afterindenttrue
1883 \interlinepenalty\@M
1884 \leavevmode
1885 \@tempdima #3\relax
1886 \advance\leftskip \@tempdima \null\nobreak\hskip -\leftskip
1887 {#4}\nobreak
1888 \leaders\hbox{$\m@th
1889 \mkern \@dotsep mu\hbox{.}\mkern \@dotsep
1890 mu$}\hfill
1891 \nobreak
1892 #5\par}%
1893 \fi}
1894 % \end{macrocode}
1895 % \end{macro}
1896 % \begin{macro}{\fxcontentsline}
1897 % \marg{contents}\marg{target}\\
1898 % Similar to \LaTeX's \cs{contentsline} macro, but temporarily bind
1899 % \cs{@dottedtocline} to our own version. The nice thing about this
1900 % implementation is that we can still use \cs{l@fixme} (remember that it is
1901 % bound to \cs{l@figure}) without exactly knowing what its definition is.
1902 % This macro is at the user level because \cs{contentsline} is, but it is
1903 % not currently documented in the user manual.
1904 % \begin{macrocode}
1905 \newcommand*\fxcontentsline[2]{%
1906 \begingroup%
1907 \let\@dottedtocline\@fxdottedtocline%
1908 \l@fixme{#1}{#2}%
1909 \endgroup}
1910
1911 % \end{macrocode}
1912 % \end{macro}
1913 % \begin{macro}{\fxaddcontentsline}
1914 % \marg{contents}\\
1915 % Wrapper around \LaTeX's \cs{addcontentsline} macro to handle the
1916 % \texttt{target} option. If a specific target is provided, we can't use the
1917 % normal \cs{addcontentsline} macro for reasons explained above, so we use
1918 % our own version of \cs{contentsline} instead. This macro is at the user
1919 % level because \cs{addcontentsline} is, but it is not currently documented
1920 % in the user manual.
1921 % \begin{macrocode}
1922 \newcommand*\fxaddcontentsline[1]{%
1923 \ifthenelse{\equal{\cmdfx@note@target}{thepage}}{%
1924 \addcontentsline{lox}{fixme}{#1}}{%
1925 \addtocontents{lox}{\protect\fxcontentsline{#1}{\cmdfx@note@target}}}}
1926
1927 % \end{macrocode}
1928 % \end{macro}
1929 %
1930 % \subsubsection{List headers}
1931 % \fx recognizes the standard \texttt{article}, \texttt{report} and
1932 % \texttt{book} classes, the AMS ones, and adapts the list header
1933 % accordingly. It also detects when the package \texttt{basictoc} is loaded
1934 % and uses it, which notably makes it compliant with the \komascript classes
1935 % as well. Otherwise, the standard \texttt{article} layout is used.
1936 %
1937 % \paragraph{\texttt{article} version}
1938 % \begin{macro}{\@lox@prtc@article}
1939 % \begin{macro}{\@lox@psttc@article}
1940 % \mbox{}
1941 % \begin{macrocode}
1942 \newcommand\@lox@prtc@article{%
1943 \section*{\@fxlistfixmename%
1944 \@mkboth{\MakeUppercase\@fxlistfixmename}{\MakeUppercase\@fxlistfixmename}}}
1945 \let\@lox@psttc@article\relax
1946
1947 % \end{macrocode}
1948 % \end{macro}
1949 % \end{macro}
1950 % \paragraph{\texttt{report} version}
1951 % \begin{macro}{\@lox@prtc@report}
1952 % \begin{macro}{\@lox@psttc@report}
1953 % \mbox{}
1954 % \begin{macrocode}
1955 \newcommand\@lox@prtc@report{%
1956 \if@twocolumn
1957 \@restonecoltrue\onecolumn
1958 \else
1959 \@restonecolfalse
1960 \fi
1961 \chapter*{\@fxlistfixmename%
1962 \@mkboth{\MakeUppercase\@fxlistfixmename}{\MakeUppercase\@fxlistfixmename}}}
1963 \newcommand\@lox@psttc@report{\if@restonecol\twocolumn\fi}
1964
1965 % \end{macrocode}
1966 % \end{macro}
1967 % \end{macro}
1968 % \paragraph{\texttt{book} version}
1969 % \begin{macro}{\@lox@prtc@book}
1970 % \begin{macro}{\@lox@psttc@book}
1971 % \mbox{}
1972 % \begin{macrocode}
1973 \newcommand\@lox@prtc@book{%
1974 \if@twocolumn
1975 \@restonecoltrue\onecolumn
1976 \else
1977 \@restonecolfalse
1978 \fi
1979 \chapter*{\@fxlistfixmename%
1980 \@mkboth{\MakeUppercase\@fxlistfixmename}{\MakeUppercase\@fxlistfixmename}}}
1981 \newcommand\@lox@psttc@book{\if@restonecol\twocolumn\fi}
1982
1983 % \end{macrocode}
1984 % \end{macro}
1985 % \end{macro}
1986 %
1987 % \subsubsection{Status/class-dependent implementation}
1988 % \begin{macro}{\lox@final}
1989 % \begin{macro}{\lox@draft}
1990 % In the new implementation of the \texttt{draft} mode below, we not only
1991 % check that the \texttt{lox} file exists, but also that it is not empty
1992 % before actually typesetting anything.
1993 % \begin{macrocode}
1994 \let\lox@final\relax
1995
1996 \newread\lox@file
1997 \newif\iflox@typeset
1998 \def\lox@eol{\par}
1999 \newcommand\lox@draft{%
2000 \lox@typesetfalse%
2001 \openin\lox@file\jobname.lox\relax
2002 \ifeof\lox@file\else
2003 \read\lox@file to \lox@maybeeol
2004 \ifeof\lox@file
2005 \ifx\lox@maybeeol\lox@eol\else\lox@typesettrue\fi
2006 \else
2007 \lox@typesettrue
2008 \fi
2009 \fi
2010 \closein\lox@file
2011 \iflox@typeset\@lox@prtc\@starttoc{lox}\@lox@psttc\else\@starttoc{lox}\fi}
2012 % \end{macrocode}
2013 % \end{macro}
2014 % \end{macro}
2015 % \begin{macro}{\lox@draft@ams}
2016 % The \texttt{amsbook} and \texttt{amsart} classes have the very ugly idea
2017 % of redefining the \cs{@starttoc} macro to take two arguments. Therefore, I
2018 % need to provide a specific version of the \cs{listoffixmes} macro:
2019 % \begin{macrocode}
2020 \newcommand\lox@draft@ams{\@starttoc{lox}\@fxlistfixmename}
2021
2022 % \end{macrocode}
2023 % \end{macro}
2024 %
2025 % \subsection{Faces}
2026 % \begin{macro}{\fxsetface}
2027 % \marg{name}\marg{value}
2028 % \begin{macrocode}
2029 \newcommand*\fxsetface[2]{\@fxsetkeys{face}{#1face=#2}}
2030 % \end{macrocode}
2031 % \end{macro}
2032 % \begin{macro}{\@fxnewface}
2033 % \oarg{default}\marg{name}\\
2034 % A face is just a command key:
2035 % \begin{macrocode}
2036 \newcommand*\@fxnewface[2][]{%
2037 \@fxdefinecmdkey{face}{#2face}{}%
2038 \fxsetface{#2}{#1}}
2039 % \end{macrocode}
2040 % \end{macro}
2041 % \begin{macro}{\@fxuseface}
2042 % \marg{name}
2043 % \begin{macrocode}
2044 \newcommand*\@fxuseface[1]{\@nameuse{cmdfx@face@#1face}}
2045
2046 % \end{macrocode}
2047 % \end{macro}
2048 %
2049 % \subsection{Annotation layouts}
2050 % \subsubsection{Layout modes}
2051 % \begin{option}{multiuser}
2052 % \begin{option}{singleuser}
2053 % \begin{option}{mode}
2054 % These options specify whether \fx should function in standalone or
2055 % collaborative mode, allowing the different layouts to tweak their output.
2056 % \begin{macrocode}
2057 \@fxdefineboolkey[%
2058 \ifthenelse{\equal{#1}{true}}{%
2059 \fx@mode@singleuserfalse}{%
2060 \fx@mode@singleusertrue}]{%
2061 mode}{multiuser}
2062 \@fxdefineboolkey[%
2063 \ifthenelse{\equal{#1}{true}}{%
2064 \fx@mode@multiuserfalse}{%
2065 \fx@mode@multiusertrue}]{%
2066 mode}{singleuser}
2067 \@fxdefinechoicekey{mode}{mode}{multiuser,singleuser}{\@fxsetkeys{mode}{#1}}
2068
2069 % \end{macrocode}
2070 % \end{option}
2071 % \end{option}
2072 % \end{option}
2073 %
2074 % \subsubsection{Layout creation}
2075 % Separating between ``early'' and ``late'' layouts is needed in starred
2076 % context, that is, when we are using targeted commands or environments.
2077 % \begin{macro}{\@fxearlylayouts}
2078 % \begin{macro}{\@fxlatelayouts}
2079 % Comma-separated lists of available early and late layouts.
2080 % \begin{macrocode}
2081 \let\@fxearlylayouts\empty
2082 \let\@fxlatelayouts\empty
2083 % \end{macrocode}
2084 % \end{macro}
2085 % \end{macro}
2086 % \begin{macro}{\FXProvidesLayout}
2087 % \marg{name}\oarg{release information}
2088 % \begin{macrocode}
2089 \newcommand*\FXProvidesLayout[1]{\ProvidesPackage{fxlayout#1}}
2090 % \end{macrocode}
2091 % \end{macro}
2092 % \begin{macro}{\@fxrecordlayoutmutex}
2093 % \marg{layout}\marg{layouts}\\
2094 % Record mutual exclusion between \meta{layout} and the comma-separated list
2095 % of \meta{layouts}. For each \meta{layout}, the mutual exclusion list is
2096 % stored in \cs{@fxlayout@}\meta{layout}\texttt{@mutex}.
2097 % \begin{macrocode}
2098 \newcommand*\@fxrecordlayoutmutex[2]{%
2099 \edef\@fxlts{\zap@space#2 \@empty}%
2100 \def\@fxexpr{\@fxaddtolist{@fxlayout@#1@mutex}}%
2101 \expandafter\@fxexpr\expandafter{\@fxlts}%
2102 \@for\@fxlt:=\@fxlts\do{\@fxaddtolist{@fxlayout@\@fxlt @mutex}{#1}}}
2103 % \end{macrocode}
2104 % \end{macro}
2105 % \begin{macro}{\@fxhandlelayoutmutex}
2106 % \marg{layout}\\
2107 % Handle \meta{layout}'s mutual exclusion list.
2108 % \begin{macrocode}
2109 \newcommand*\@fxhandlelayoutmutex[1]{%
2110 \ifthenelse{\boolean{fx@layout@#1}}{%
2111 \def\@fxexpr{\@for\@fxlt:=}%
2112 \expandafter\@fxexpr\csname @fxlayout@#1@mutex\endcsname\do{%
2113 \@ifundefined{iffx@layout@\@fxlt}{}{%
2114 \ifthenelse{\boolean{fx@layout@\@fxlt}}{%
2115 \@fxpkgwarning{%
2116 #1 layout requested;\MessageBreak
2117 turning \@fxlt\space layout off}%
2118 \@nameuse{fx@layout@\@fxlt}{false}}{}}}}{}}
2119
2120 % \end{macrocode}
2121 % \end{macro}
2122 % \begin{macro}{\@FXRegisterLayout}
2123 % \marg{when}\oarg{mutex}\marg{name}\marg{funcname}\\
2124 % Register a new layout with \fx. This currently involves creating the
2125 % boolean layout option with an optional function argument, constructing the
2126 % translation macro to call the actual layout macro, and updating the
2127 % appropriate layout list (early or late). The translation macro can't be
2128 % \cs{let} to the real one, because themes might want to redefine latter. An
2129 % optional mutual exclusion list may also be given.
2130 % \begin{macrocode}
2131 \def\@FXRegisterLayout#1[#2]#3#4{%
2132 \@fxkeyifundefined{layout}{#3}{%
2133 \@fxrecordlayoutmutex{#3}{#2}%
2134 \@fxdefineboolkey[\@fxhandlelayoutmutex{#3}]{layout}{#3}%
2135 \expandafter\def\csname @fxlayout@#3\endcsname{#4}%
2136 \@fxaddtolist{@fx#1layouts}{#3}}{%
2137 \@fxpkgerror{layout '#3' already registered}{%
2138 You have called \string\FXRegisterLayout\space with a name already
2139 in use.\MessageBreak
2140 If you want to modify an existing layout, renew its
2141 command.\MessageBreak
2142 Otherwise, you must choose a different name.}}}
2143 % \end{macrocode}
2144 % \end{macro}
2145 % \begin{macro}{\FXRegisterLayout}
2146 % \begin{macro}{\FXRegisterLayout*}
2147 % \meta{\texttt{*}}\oarg{mutex}\marg{name}\marg{funcname}\\
2148 % And the use-level interface:
2149 % \begin{macrocode}
2150 \newcommand\FXRegisterLayout{%
2151 \@ifstar{%
2152 \@ifnextchar[%]
2153 {\@FXRegisterLayout{early}}{\@FXRegisterLayout{early}[]}}{%
2154 \@ifnextchar[%]
2155 {\@FXRegisterLayout{late}}{\@FXRegisterLayout{late}[]}}}
2156
2157 % \end{macrocode}
2158 % \end{macro}
2159 % \end{macro}
2160 % \begin{macro}[noindex]{\FXDefineLayout...Key}
2161 % \begin{macro}[noprint]{\FXDefineLayoutKey}
2162 % \begin{macro}[noprint]{\FXDefineLayoutCmdKey}
2163 % \begin{macro}[noprint]{\FXDefineLayoutChoiceKey}
2164 % \begin{macro}[noprint]{\FXDefineLayoutVoidKey}
2165 % \begin{macro}[noprint]{\FXDefineLayoutBoolKey}
2166 % Finally, the extension-level option creation interface:
2167 % \begin{macrocode}
2168 \@fxdefineoptioninterface{layout}{Layout}
2169
2170 % \end{macrocode}
2171 % \end{macro}
2172 % \end{macro}
2173 % \end{macro}
2174 % \end{macro}
2175 % \end{macro}
2176 % \end{macro}
2177 %
2178 % \subsubsection{Standard textual dispositions}
2179 % \begin{macro}{\@fxtextstd}
2180 % \marg{type}\marg{note}\marg{author}\\
2181 % The standard text disposition.
2182 % \begin{macrocode}
2183 \newcommand*\@fxtextstd[3]{\ignorespaces#3 \fxnotename{#1}: #2}
2184 % \end{macrocode}
2185 % \end{macro}
2186 % \begin{macro}{\@fxsignature}
2187 % \marg{author}\\
2188 % Typeset the signature part unless \meta{author} is empty. Note that
2189 % \cs{ifthenelse} is fragile, so we need to make the signature stuff robust.
2190 % \begin{macrocode}
2191 \DeclareRobustCommand*\@fxsignature[1]{%
2192 \ifthenelse{\equal{#1}{}}{}{ -- {\@fxuseface{signature}#1}}}
2193 % \end{macrocode}
2194 % \end{macro}
2195 % \begin{macro}{\@fxsigstd}
2196 % \marg{type}\marg{note}\marg{author}\\
2197 % The standard signature disposition.
2198 % \begin{macrocode}
2199 \newcommand*\@fxsigstd[3]{\fxnotename{#1}: #2\@fxsignature{#3}}
2200 % \end{macrocode}
2201 % \end{macro}
2202 %
2203 % \subsubsection{Built-in layouts}
2204 % Let's start with the early layouts, and continue with the late ones.
2205 % \paragraph{Margin}
2206 % \begin{layout}[noprint]{margin}
2207 % \begin{face}{margin}
2208 % \mbox{}
2209 % \begin{macrocode}
2210 \@fxnewface{margin}
2211 % \end{macrocode}
2212 % \end{face}
2213 % \begin{macro}{\FXLayoutMargin}
2214 % \marg{type}\marg{note}\marg{author}
2215 % \begin{macrocode}
2216 \newcommand*\FXLayoutMargin[3]{%
2217 \marginpar[\raggedleft\@fxuseface{margin}\@fxtextstd{#1}{#2}{#3}]{%
2218 \raggedright\@fxuseface{margin}\@fxtextstd{#1}{#2}{#3}}}
2219 % \end{macrocode}
2220 % \end{macro}
2221 % \begin{macro}{\@fxlayout@margin}
2222 % \begin{booleanoption}{margin}
2223 % \mbox{}
2224 % \begin{macrocode}
2225 \FXRegisterLayout*{margin}{\FXLayoutMargin}
2226 % \end{macrocode}
2227 % \end{booleanoption}
2228 % \end{macro}
2229 % \end{layout}
2230 %
2231 % \paragraph{Margin clue}
2232 % \begin{layout}[noprint]{marginclue}
2233 % \begin{macro}{\FXLayoutMarginCLue}
2234 % \marg{type}\marg{note}\marg{author}
2235 % \begin{macrocode}
2236 \newcommand*\FXLayoutMarginClue[3]{%
2237 \marginpar[%
2238 {\raggedleft\@fxuseface{margin}\ignorespaces#3 \fxnotename{#1}!}]{%
2239 \raggedright\@fxuseface{margin}\ignorespaces#3 \fxnotename{#1}!}}
2240 % \end{macrocode}
2241 % \end{macro}
2242 % \begin{macro}{\@fxlayout@marginclue}
2243 % \begin{booleanoption}{marginclue}
2244 % \mbox{}
2245 % \begin{macrocode}
2246 \FXRegisterLayout*[margin]{marginclue}{\FXLayoutMarginClue}
2247 % \end{macrocode}
2248 % \end{booleanoption}
2249 % \end{macro}
2250 % \end{layout}
2251 %
2252 % \paragraph{Footnote}
2253 % \begin{layout}[noprint]{footnote}
2254 % \begin{macro}{\FXLayoutFootnote}
2255 % \marg{type}\marg{note}\marg{author}
2256 % \begin{macrocode}
2257 \newcommand*\FXLayoutFootnote[3]{\footnote{\@fxtextstd{#1}{#2}{#3}}}
2258 % \end{macrocode}
2259 % \end{macro}
2260 % \begin{macro}{\@fxlayout@footnote}
2261 % \begin{booleanoption}{footnote}
2262 % \mbox{}
2263 % \begin{macrocode}
2264 \FXRegisterLayout{footnote}{\FXLayoutFootnote}
2265 % \end{macrocode}
2266 % \end{booleanoption}
2267 % \end{macro}
2268 % \end{layout}
2269 %
2270 % \paragraph{Inline}
2271 % \begin{layout}[noprint]{inline}
2272 % \begin{face}{inline}
2273 % \mbox{}
2274 % \begin{macrocode}
2275 \@fxnewface{inline}
2276 % \end{macrocode}
2277 % \end{face}
2278 % \begin{macro}{\FXLayoutInline}
2279 % \marg{type}\marg{note}\marg{author}
2280 % \begin{macrocode}
2281 \newcommand*\FXLayoutInline[3]{ \@fxuseface{inline}\@fxtextstd{#1}{#2}{#3}}
2282 % \end{macrocode}
2283 % \end{macro}
2284 % \begin{macro}{\@fxlayout@inline}
2285 % \begin{booleanoption}{inline}
2286 % \mbox{}
2287 % \begin{macrocode}
2288 \FXRegisterLayout{inline}{\FXLayoutInline}
2289 % \end{macrocode}
2290 % \end{booleanoption}
2291 % \end{macro}
2292 % \end{layout}
2293 %
2294 % \paragraph{Index}
2295 % \begin{layout}[noprint]{index}
2296 % \begin{macro}{\fixmeindexname}
2297 % \mbox{}
2298 % \begin{macrocode}
2299 \newcommand\fixmeindexname{\fixmelogo}
2300 % \end{macrocode}
2301 % \end{macro}
2302 % \begin{macro}{\@wrindex}
2303 % \marg{contents}\\
2304 % A replacement for \LaTeX's standard \cs{@wrindex} macro to deal with the
2305 % \texttt{target} option. When given, it is supposed to replace the page
2306 % number, just as in the list of fixmes.
2307 % \begin{macrocode}
2308 \def\@wrindex#1{%
2309 \ifthenelse{\equal{\cmdfx@note@target}{thepage}}{%
2310 \protected@write\@indexfile{}{\string\indexentry{#1}{\thepage}}}{%
2311 \protected@write\@indexfile{}{\string\indexentry{#1}{\cmdfx@note@target}}}%
2312 \endgroup
2313 \@esphack}
2314 % \end{macrocode}
2315 % \end{macro}
2316 % \begin{macro}{\@fxnotekey}
2317 % \begin{macro}{\@fxwarningkey}
2318 % \begin{macro}{\@fxerrorkey}
2319 % \begin{macro}{\@fxfatalkey}
2320 % The keys used to sort indexed annotations by importance level:
2321 % \begin{macrocode}
2322 \newcommand\@fxnotekey{***a}
2323 \newcommand\@fxwarningkey{***b}
2324 \newcommand\@fxerrorkey{***c}
2325 \newcommand\@fxfatalkey{***d}
2326 % \end{macrocode}
2327 % \end{macro}
2328 % \end{macro}
2329 % \end{macro}
2330 % \end{macro}
2331 % \begin{macro}{\FXLayoutIndex}
2332 % \marg{type}\marg{note}\marg{author}
2333 % \begin{macrocode}
2334 \newcommand*\FXLayoutIndex[3]{%
2335 \iffx@mode@multiuser%
2336 \index{***@\fixmeindexname:%
2337 !\@nameuse{@fx#1key}@\fxnotesname{#1}:%
2338 !\@nameuse{thefx#1count}: #3: #2}%
2339 \index{***#3@\fixmeindexname{} (#3):%
2340 !\@nameuse{@fx#1key}@\fxnotesname{#1}:%
2341 !\@nameuse{thefx#1count}: #2}%
2342 \else%
2343 \index{***@\fixmeindexname:%
2344 !\@nameuse{@fx#1key}@\fxnotesname{#1}:%
2345 !\@nameuse{thefx#1count}: #2}%
2346 \fi}
2347 % \end{macrocode}
2348 % \end{macro}
2349 % \begin{macro}{\@fxlayout@index}
2350 % \begin{booleanoption}{index}
2351 % \mbox{}
2352 % \begin{macrocode}
2353 \FXRegisterLayout{index}{\FXLayoutIndex}
2354 % \end{macrocode}
2355 % \end{booleanoption}
2356 % \end{macro}
2357 % \end{layout}
2358 %
2359 % \paragraph{Contents line\label{sec:code:contentslinelayout}}
2360 % The contents of the \texttt{lox} file is handled through this
2361 % pseudo-layout. It follows the normal layout design, but is not registered
2362 % the usual way because we don't want to give the user control over it. It is
2363 % triggered explicitely by \cs{@@@fxnote@late@draft}.
2364 % \begin{macro}{\FXLayoutContentsLine}
2365 % \marg{type}\marg{note}\marg{author}\\
2366 % \begin{macrocode}
2367 \newcommand*\FXLayoutContentsLine[3]{%
2368 \iffx@mode@multiuser%
2369 \fxaddcontentsline{\@fxtextstd{#1}{#2}{#3}}%
2370 \else%
2371 \fxaddcontentsline{\fxnotename{#1}: #2}%
2372 \fi}
2373
2374 % \end{macrocode}
2375 % \end{macro}
2376 %
2377 % \subsubsection{Layout loading}
2378 % \begin{macro}{\fxloadlayouts}
2379 % \marg{name,\ldots}
2380 % \begin{macrocode}
2381 \newcommand*\fxloadlayouts[1]{%
2382 \edef\@fxlts{\zap@space#1 \@empty}%
2383 \@for\@fxlt:=\@fxlts\do{\usepackage{fxlayout#1}}}
2384
2385 % \end{macrocode}
2386 % \end{macro}
2387 %
2388 % \subsubsection{Layout control}
2389 % \begin{macro}{\@fxsetlayoutkeys}
2390 % \marg{keys}
2391 % This macro would probably be overkill if we didn't need to
2392 % \cs{expandafter} it at some point (See \cs{@fxhandleinnermode}).
2393 % \begin{macrocode}
2394 \newcommand\@fxsetlayoutkeys{\@fxsetkeys{layout}}
2395 % \end{macrocode}
2396 % \end{macro}
2397 % \begin{macro}{\@fxparselayout}
2398 % Utility macro to detect the \texttt{no}\meta{name} form of layout options.
2399 % The drawback of this technique is that layout options must be at least 3
2400 % characters long. No big deal though\ldots
2401 % \begin{macrocode}
2402 \def\@fxparselayout#1#2#3\relax{\def\@fxltprefix{#1#2}\def\@fxltrest{#3}}
2403 % \begin{macro}{\fxuselayouts}
2404 % \marg{[no]names}\\
2405 % First, ensure that those layouts are available, then activate them.
2406 % \cs{\FXRequireLayouts} is a better style for theme programming.
2407 % \begin{macrocode}
2408 \newcommand*\fxuselayouts[1]{%
2409 \edef\@fxlts{\zap@space#1 \@empty}%
2410 \@for\@fxlt:=\@fxlts\do{%
2411 \expandafter\@fxparselayout\@fxlt\relax%
2412 \ifthenelse{\equal{\@fxltprefix}{no}}{%
2413 \let\@fxltname\@fxltrest}{%
2414 \let\@fxltname\@fxlt}%
2415 \@fxkeyifundefined{layout}{\@fxltname}{\fxloadlayouts{\@fxltname}}{}}%
2416 \@fxsetkeys{layout}{#1}}
2417 \let\FXRequireLayouts\fxuselayouts
2418
2419 % \end{macrocode}
2420 % \end{macro}
2421 % \begin{option}{innerlayout}
2422 % The alternative inner mode layout:
2423 % \begin{macrocode}
2424 \@fxdefinecmdkey{layout}{innerlayout}{}
2425 % \end{macrocode}
2426 % \end{option}
2427 % \begin{option}{morelayout}
2428 % The \texttt{morelayout} option adds to the existing layout configuration.
2429 % The implementation is trivial, as it simply boils down to calling
2430 % \cs{setkeys} on its argument. There are several advantages in doing this.
2431 % \begin{enumerate}
2432 % \item It is possible to disable a layout by using the
2433 % \texttt{no}\meta{layout} form. For example,
2434 % |morelayout={inline,nomargin}| will work.
2435 % \item A wrong layout name (for instance, misspelled) will trigger an
2436 % \texttt{xkeyval} error.
2437 % \end{enumerate}
2438 % \begin{macrocode}
2439 \@fxdefinekey{layout}{morelayout}{\fxuselayouts{#1}}
2440 % \end{macrocode}
2441 % \end{option}
2442 % \begin{option}{layout}
2443 % The \texttt{layout} option lets the user specify exactly which ones she
2444 % wants to use. Not very difficult to implement either: it works by first
2445 % deactivating all layouts, and then activating the provided ones as before.
2446 % Note that the use of the \texttt{no}\meta{layout} form is valid but has no
2447 % effect.
2448 % \begin{macrocode}
2449 \@fxdefinekey{layout}{layout}{%
2450 \edef\@fxlayouts{\@fxearlylayouts,\@fxlatelayouts}%
2451 \@for\@fxlt:=\@fxlayouts\do{%
2452 \@nameuse{fx@layout@\@fxlt}{false}}%
2453 \fxuselayouts{#1}}
2454
2455 % \end{macrocode}
2456 % \end{option}
2457 %
2458 % \subsection{Environment Layouts}
2459 % \subsubsection{Layout creation}
2460 % \begin{macro}{\FXProvidesEnvLayout}
2461 % \marg{name}\oarg{release information}
2462 % \begin{macrocode}
2463 \newcommand*\FXProvidesEnvLayout[1]{\ProvidesPackage{fxenvlayout#1}}
2464 % \end{macrocode}
2465 % \end{macro}
2466 % \begin{macro}{\FXRegisterEnvLayout}
2467 % \marg{name}\marg{beginfuncname}\marg{endfuncname}\\
2468 % Register a new environment layout with \fx. This currently only involves
2469 % constructing the translation macros. The translation macros in question
2470 % can't be \cs{let} to the real ones, because themes or users might want to
2471 % redefine the latter.
2472 % \begin{macrocode}
2473 \newcommand*\FXRegisterEnvLayout[3]{%
2474 \@ifundefined{@fxenvlayout@#1@begin}{%
2475 \expandafter\def\csname @fxenvlayout@#1@begin\endcsname{#2}%
2476 \expandafter\def\csname @fxenvlayout@#1@end\endcsname{#3}}{%
2477 \@fxpkgerror{environment layout '#2' already registered}{%
2478 You have called \string\FXRegisterEnvLayout\space with a name already in
2479 use.\MessageBreak
2480 If you want to modify an existing environment layout, renew its
2481 commands.\MessageBreak
2482 Otherwise, you must choose a different name.}}}
2483
2484 % \end{macrocode}
2485 % \end{macro}
2486 % \begin{macro}[noindex]{\FXDefineEnvLayout...Key}
2487 % \begin{macro}[noprint]{\FXDefineEnvLayoutKey}
2488 % \begin{macro}[noprint]{\FXDefineEnvLayoutCmdKey}
2489 % \begin{macro}[noprint]{\FXDefineEnvLayoutChoiceKey}
2490 % \begin{macro}[noprint]{\FXDefineEnvLayoutVoidKey}
2491 % \begin{macro}[noprint]{\FXDefineEnvLayoutBoolKey}
2492 % The extension-level option creation interface:
2493 % \begin{macrocode}
2494 \@fxdefineoptioninterface{envlayout}{EnvLayout}
2495
2496 % \end{macrocode}
2497 % \end{macro}
2498 % \end{macro}
2499 % \end{macro}
2500 % \end{macro}
2501 % \end{macro}
2502 % \end{macro}
2503 %
2504 % \subsubsection{Built-in layouts}
2505 % \paragraph{Plain}
2506 % \begin{envlayout}[noprint]{plain}
2507 % \begin{face}{env}
2508 % \mbox{}
2509 % \begin{macrocode}
2510 \@fxnewface{env}
2511 % \end{macrocode}
2512 % \end{face}
2513 % \begin{macro}{\FXEnvLayoutPlainBegin}
2514 % \begin{macro}{\FXEnvLayoutPlainEnd}
2515 % \marg{type}\marg{author}
2516 % \begin{macrocode}
2517 \newcommand*\FXEnvLayoutPlainBegin[2]{%
2518 \@fxuseface{env}\ignorespaces#2 \fxnotename{#1}: \ignorespaces}
2519 \newcommand*\FXEnvLayoutPlainEnd[2]{}
2520 % \end{macrocode}
2521 % \end{macro}
2522 % \end{macro}
2523 % \begin{macro}{\@fxenvlayout@plain@begin}
2524 % \begin{macro}{\@fxenvlayout@plain@end}
2525 % \begin{macrocode}
2526 \FXRegisterEnvLayout{plain}{\FXEnvLayoutPlainBegin}{\FXEnvLayoutPlainEnd}
2527
2528 % \end{macrocode}
2529 % \end{macro}
2530 % \end{macro}
2531 % \end{envlayout}
2532 %
2533 % \paragraph{Signature}
2534 % \begin{envlayout}{signature}
2535 % \begin{face}{signature}
2536 % \mbox{}
2537 % \begin{macrocode}
2538 \@fxnewface[\itshape]{signature}
2539 % \end{macrocode}
2540 % \end{face}
2541 % \begin{macro}{\FXEnvLayoutSignatureBegin}
2542 % \begin{macro}{\FXEnvLayoutSignatureEnd}
2543 % \marg{type}\marg{author}
2544 % \begin{macrocode}
2545 \newcommand*\FXEnvLayoutSignatureBegin[2]{%
2546 \@fxuseface{env}\fxnotename{#1}: \ignorespaces}
2547 \newcommand*\FXEnvLayoutSignatureEnd[2]{\@fxsignature{#2}}
2548 % \end{macrocode}
2549 % \end{macro}
2550 % \end{macro}
2551 % \begin{macro}{\@fxenvlayout@signature@begin}
2552 % \begin{macro}{\@fxenvlayout@signature@end}
2553 % \mbox{}
2554 % \begin{macrocode}
2555 \FXRegisterEnvLayout{signature}{%
2556 \FXEnvLayoutSignatureBegin}{\FXEnvLayoutSignatureEnd}
2557
2558 % \end{macrocode}
2559 % \end{macro}
2560 % \end{macro}
2561 % \end{envlayout}
2562 %
2563 % \subsubsection{Layout selection}
2564 % \begin{macro}{\@fxselectenvlayout}
2565 % \marg{name}
2566 % \begin{macro}{\@fxenvlayout@begin}
2567 % \begin{macro}{\@fxenvlayout@end}
2568 % \marg{type}\marg{author}\\
2569 % This is much simpler than standard layout management because only one
2570 % environment layout at a time is possible. Using a specific environment
2571 % layout boils down to possibly loading it, and binding the beginning and
2572 % ending macros to the proper translation ones.
2573 % \begin{macrocode}
2574 \newcommand*\@fxselectenvlayout[1]{%
2575 \expandafter\let\expandafter\@fxenvlayout@begin%
2576 \csname @fxenvlayout@#1@begin\endcsname%
2577 \expandafter\let\expandafter\@fxenvlayout@end%
2578 \csname @fxenvlayout@#1@end\endcsname}
2579
2580 % \end{macrocode}
2581 % \end{macro}
2582 % \end{macro}
2583 % \end{macro}
2584 %
2585 % \subsubsection{Layout loading}
2586 % \begin{macro}{\fxloadenvlayouts}
2587 % \marg{name,\ldots}
2588 % \begin{macrocode}
2589 \newcommand*\fxloadenvlayouts[1]{%
2590 \edef\@fxlts{\zap@space#1 \@empty}%
2591 \@for\@fxlt:=\@fxlts\do{\usepackage{fxenvlayout#1}}}
2592
2593 % \end{macrocode}
2594 % \end{macro}
2595 %
2596 % \subsubsection{Layout control}
2597 % \begin{macro}{\fxuseenvlayout}
2598 % \begin{macro}{\FXRequireEnvLayout}
2599 % \marg{name}\\
2600 % \cs{FXRequireEnvLayout} is a better style for theme programming.
2601 % \begin{macrocode}
2602 \newcommand*\fxuseenvlayout[1]{%
2603 \@ifundefined{@fxenvlayout@#1@begin}{\fxloadenvlayouts{#1}}{}%
2604 \@fxselectenvlayout{#1}}
2605 \let\FXRequireEnvLayout\fxuseenvlayout
2606 % \end{macrocode}
2607 % \end{macro}
2608 % \end{macro}
2609 % \begin{option}{envlayout}
2610 % \mbox{}
2611 % \begin{macrocode}
2612 \@fxdefinekey{envlayout}{envlayout}{\fxuseenvlayout{#1}}
2613
2614 % \end{macrocode}
2615 % \end{option}
2616 %
2617 % \subsection{Target Layouts}
2618 % \subsubsection{Layout creation}
2619 % \begin{macro}{\FXProvidesTargetLayout}
2620 % \marg{name}\oarg{release information}
2621 % \begin{macrocode}
2622 \newcommand*\FXProvidesTargetLayout[1]{\ProvidesPackage{fxtargetlayout#1}}
2623 % \end{macrocode}
2624 % \end{macro}
2625 % \begin{macro}{\FXRegisterTargetLayout}
2626 % \marg{name}\marg{funcname}\\
2627 % Register a new target layout with \fx. This currently only involves
2628 % constructing the translation macro. The translation macro in question
2629 % can't be \cs{let} to the real one, because themes or user might want to
2630 % redefine the latter.
2631 % \begin{macrocode}
2632 \newcommand*\FXRegisterTargetLayout[2]{%
2633 \@ifundefined{@fxtargetlayout@#1}{%
2634 \expandafter\def\csname @fxtargetlayout@#1\endcsname{#2}}{%
2635 \@fxpkgerror{target layout '#1' already registered}{%
2636 You have called \string\FXRegisterTargetLayout\space with a name
2637 already in use.\MessageBreak
2638 If you want to modify an existing target layout, renew its
2639 command.\MessageBreak
2640 Otherwise, you must choose another name.}}}
2641
2642 % \end{macrocode}
2643 % \end{macro}
2644 % \begin{macro}[noindex]{\FXDefineTargetLayout...Key}
2645 % \begin{macro}[noprint]{\FXDefineTargetLayoutKey}
2646 % \begin{macro}[noprint]{\FXDefineTargetLayoutCmdKey}
2647 % \begin{macro}[noprint]{\FXDefineTargetLayoutChoiceKey}
2648 % \begin{macro}[noprint]{\FXDefineTargetLayoutVoidKey}
2649 % \begin{macro}[noprint]{\FXDefineTargetLayoutBoolKey}
2650 % The extension-level option creation interface:
2651 % \begin{macrocode}
2652 \@fxdefineoptioninterface{targetlayout}{TargetLayout}
2653
2654 % \end{macrocode}
2655 % \end{macro}
2656 % \end{macro}
2657 % \end{macro}
2658 % \end{macro}
2659 % \end{macro}
2660 % \end{macro}
2661 %
2662 % \subsubsection{Built-in layouts}
2663 % \paragraph{Plain}
2664 % \begin{targetlayout}[noprint]{plain}
2665 % \begin{face}{target}
2666 % \mbox{}
2667 % \begin{macrocode}
2668 \@fxnewface{target}
2669 % \end{macrocode}
2670 % \end{face}
2671 % \begin{macro}{\FXTargetLayoutPlain}
2672 % \marg{target}
2673 % \begin{macrocode}
2674 \newcommand\FXTargetLayoutPlain[2]{\@fxuseface{target}#2}
2675 % \end{macrocode}
2676 % \end{macro}
2677 % \begin{macro}{\@fxtargetlayout@plain}
2678 % \begin{macrocode}
2679 \FXRegisterTargetLayout{plain}{\FXTargetLayoutPlain}
2680
2681 % \end{macrocode}
2682 % \end{macro}
2683 % \end{targetlayout}
2684 %
2685 % \subsubsection{Layout selection}
2686 % \begin{macro}{\@fxselecttargetlayout}
2687 % \marg{name}
2688 % \begin{macro}{\@@fxtargetlayout}
2689 % \marg{target}\\
2690 % This is much simpler than standard layout management because only one
2691 % target layout at a time is possible. Using a specific target layout boils
2692 % down to possibly loading it, and binding the layout macro to the proper
2693 % translation one.
2694 % \begin{macrocode}
2695 \newcommand*\@fxselecttargetlayout[1]{%
2696 \expandafter\let\expandafter\@@fxtargetlayout%
2697 \csname @fxtargetlayout@#1\endcsname}
2698
2699 % \end{macrocode}
2700 % \end{macro}
2701 % \end{macro}
2702 %
2703 % \subsubsection{Target layout loading}
2704 % \begin{macro}{\fxloadtargetlayouts}
2705 % \marg{name,\ldots}
2706 % \begin{macrocode}
2707 \newcommand*\fxloadtargetlayouts[1]{%
2708 \edef\@fxlts{\zap@space#1 \@empty}%
2709 \@for\@fxlt:=\@fxlts\do{\usepackage{fxtargetlayout#1}}}
2710
2711 % \end{macrocode}
2712 % \end{macro}
2713 %
2714 % \subsubsection{Target layout control}
2715 % \begin{macro}{\fxusetargetlayout}
2716 % \begin{macro}{\FXRequireTargetLayout}
2717 % \marg{name}\\
2718 % \cs{FXRequireTargetLayout} is a better style for theme programming.
2719 % \begin{macrocode}
2720 \newcommand*\fxusetargetlayout[1]{%
2721 \@ifundefined{@fxtargetlayout@#1}{\fxloadtargetlayouts{#1}}{}%
2722 \@fxselecttargetlayout{#1}}
2723 \let\FXRequireTargetLayout\fxusetargetlayout
2724 % \end{macrocode}
2725 % \end{macro}
2726 % \end{macro}
2727 % \begin{option}{targetlayout}
2728 % \mbox{}
2729 % \begin{macrocode}
2730 \@fxdefinekey{targetlayout}{targetlayout}{\fxusetargetlayout{#1}}
2731
2732 % \end{macrocode}
2733 % \end{option}
2734 %
2735 % \subsubsection{Status-dependant versions}
2736 % \begin{macro}{\@fxtargetlayout@final}
2737 % \begin{macro}{\@fxtargetlayout@draft}
2738 % \marg{target}\\
2739 % In \texttt{final} mode, the target is typeset as-is. In \texttt{draft}
2740 % mode, we use the selected layout.
2741 % \begin{macrocode}
2742 \newcommand\@fxtargetlayout@final[2]{#2}
2743 \newcommand\@fxtargetlayout@draft[2]{%
2744 \begingroup\@@fxtargetlayout{#1}{#2}\endgroup}
2745
2746 % \end{macrocode}
2747 % \end{macro}
2748 % \end{macro}
2749 %
2750 % \subsection{Logging}
2751 % \subsubsection{Logging macros}
2752 % \begin{macro}{\FXLogNote}
2753 % \begin{macro}{\FXLogWarning}
2754 % \begin{macro}{\FXLogerror}
2755 % \begin{macro}{\FXLogFatal}
2756 % \marg{msg}
2757 % \begin{macrocode}
2758 \newcommand*\FXLogNote[1]{%
2759 \GenericInfo{%
2760 (FiXme)\@spaces\@spaces\@spaces\@spaces}{%
2761 FiXme Note: '#1'}}
2762 \newcommand*\FXLogWarning[1]{%
2763 \GenericWarning{%
2764 (FiXme)\@spaces\@spaces\@spaces\@spaces}{%
2765 FiXme Warning: '#1'}}
2766 \newcommand*\FXLogError[1]{%
2767 \GenericWarning{%
2768 (FiXme)\@spaces\@spaces\@spaces\@spaces}{%
2769 FiXme Error: '#1'}}
2770 \newcommand*\FXLogFatal[1]{%
2771 \GenericWarning{%
2772 (FiXme)\@spaces\@spaces\@spaces\@spaces}{%
2773 FiXme Fatal Error: '#1'}}
2774
2775 % \end{macrocode}
2776 % \end{macro}
2777 % \end{macro}
2778 % \end{macro}
2779 % \end{macro}
2780 % \begin{macro}{\@fxlog@note}
2781 % \begin{macro}{\@fxlog@warning}
2782 % \begin{macro}{\@fxlog@error}
2783 % \begin{macro}{\@fxlog@fatal}
2784 % In order for the generic note dispatcher to be able to call the logging
2785 % macros (see section \sectionref{sec:code:lowlevelcmd}), we need an easier
2786 % translation mechanism from the annotation type to the actual macro
2787 % name. The translation macros in question can't be \cs{let} to the real
2788 % one, because users might want to redefine the actual log macros later.
2789 % \begin{macrocode}
2790 \def\@fxlog@note{\FXLogNote}
2791 \def\@fxlog@warning{\FXLogWarning}
2792 \def\@fxlog@error{\FXLogError}
2793 \def\@fxlog@fatal{\FXLogFatal}
2794
2795 % \end{macrocode}
2796 % \end{macro}
2797 % \end{macro}
2798 % \end{macro}
2799 % \end{macro}
2800 %
2801 % \subsubsection{Logging control}
2802 % \begin{booleanoption}{silent}
2803 % Whether to log the annotations:
2804 % \begin{macrocode}
2805 \@fxdefineboolkey{log}{silent}
2806
2807 % \end{macrocode}
2808 % \end{booleanoption}
2809 %
2810 % \subsection{\fx notes}
2811 % \subsubsection{Note parameters}
2812 % \begin{counter}{fixmecount}
2813 % \begin{counter}{fxnotecount}
2814 % \begin{counter}{fxwarningcount}
2815 % \begin{counter}{fxerrorcount}
2816 % \begin{counter}{fxfatalcount}
2817 % \texttt{fixmecount} maintains the total of all annotations, regardless of
2818 % their level. Each note type also gets its own counter:
2819 % \begin{macrocode}
2820 \newcounter{fixmecount}
2821 \newcounter{fxnotecount}
2822 \newcounter{fxwarningcount}
2823 \newcounter{fxerrorcount}
2824 \newcounter{fxfatalcount}
2825
2826 % \end{macrocode}
2827 % \end{counter}
2828 % \end{counter}
2829 % \end{counter}
2830 % \end{counter}
2831 % \end{counter}
2832 % \begin{option}{author}
2833 % An annotation ``author'' allows to distinguish notes from different
2834 % persons in collaborative mode.
2835 % \begin{macrocode}
2836 \@fxdefinecmdkey{note}{author}{}
2837 % \end{macrocode}
2838 % \end{option}
2839 % \begin{option}{target}
2840 % An annotation ``target'' may replace the page number in the list of
2841 % corrections or in the index (see also section
2842 % \sectionref{sec:code:contentslinelayout}).
2843 % \begin{macrocode}
2844 \@fxdefinecmdkey{note}{target}{}
2845 % \end{macrocode}
2846 % \end{option}
2847 %
2848 % \subsubsection{Layout dispatch\label{sec:code:layoutdispatch}}
2849 % \begin{macro}{\@fxhandleinnermode}
2850 % Handle the case where \TeX{} is in inner mode. We use the alternative
2851 % layout provided by the \texttt{innerlayout} option, and we make sure to
2852 % disable both the \texttt{margin} and \texttt{marginclue} layout forms.
2853 % This is done by appending \texttt{nomargin} and \texttt{nomarginclue} to
2854 % the inner layout value (this also renders nasty user settings harmless).
2855 % Before that, we provide some informative message if risky layout forms
2856 % were active.
2857 % \begin{macrocode}
2858 \newcommand\@fxhandleinnermode{%
2859 \ifinner%
2860 \ifthenelse{\boolean{fx@layout@margin}}{%
2861 \@fxpkginfo{%
2862 inner mode detected;\MessageBreak
2863 turning margin layout form off}}{%
2864 \ifthenelse{\boolean{fx@layout@marginclue}}{%
2865 \@fxpkginfo{%
2866 inner mode detected;\MessageBreak
2867 turning marginclue layout form off}}{}}%
2868 \expandafter\@fxsetlayoutkeys\expandafter{%
2869 \cmdfx@layout@innerlayout,nomargin,nomarginclue}%
2870 \fi}
2871 % \end{macrocode}
2872 % \end{macro}
2873 % \begin{macro}{\@fxissueearlydraftlayouts}
2874 % \begin{macro}{\@fxissuelatedraftlayouts}
2875 % \marg{type}\marg{note}\\
2876 % Dispatch all active draft mode layouts. \cs{@fxissueearlydraftlayouts}
2877 % takes care of dispatching early layouts, but before that, handles the
2878 % inner mode case. \cs{@fxissuelatedraftlayouts} just dispatches late
2879 % layouts.
2880 % \begin{macrocode}
2881 \newcommand*\@fxissueearlydraftlayouts[2]{%
2882 \@fxhandleinnermode%
2883 \@for\@fxlt:=\@fxearlylayouts\do{%
2884 \@nameuse{iffx@layout@\@fxlt}%
2885 \@nameuse{@fxlayout@\@fxlt}{#1}{#2}{\cmdfx@note@author}%
2886 \fi}}
2887 \newcommand*\@fxissuelatedraftlayouts[2]{%
2888 \@for\@fxlt:=\@fxlatelayouts\do{%
2889 \@nameuse{iffx@layout@\@fxlt}%
2890 \@nameuse{@fxlayout@\@fxlt}{#1}{#2}{\cmdfx@note@author}%
2891 \fi}}
2892 % \end{macrocode}
2893 % \end{macro}
2894 % \end{macro}
2895 % \begin{macro}{\@fxissuecommonlayouts}
2896 % \marg{type}\marg{note}\\
2897 % Dispatch all mode-independent layouts (actually, ``layout'' is to be taken
2898 % in a slightly broader sense here). This macro executes all operations that
2899 % need to be performed regardless of the document status. This currently
2900 % means logging the annotations. Previously, this code also updated the
2901 % \texttt{lox} file, but this could lead to typesetting artifacts even in
2902 % final mode (because of the whatsit introduced by \cs{write}), which is
2903 % highly undesirable, and besides, there's no point in keeping that
2904 % information up to date, since it won't be typeset. So from now on, the
2905 % contents lines are only generated in \texttt{draft} mode by
2906 % \cs{@@@fxnote@late@draft}.
2907 % \begin{macrocode}
2908 \newcommand*\@fxissuecommonlayouts[2]{%
2909 \iffx@log@silent\else\@nameuse{@fxlog@#1}{#2}\fi}
2910
2911 % \end{macrocode}
2912 % \end{macro}
2913 %
2914 % \subsubsection{Status-dependent implementation\label{sec:code:lowlevelcmd}}
2915 % \begin{macro}{\@@@fxnote@early@final}
2916 % \begin{macro}{\@@@fxnote@late@final}
2917 % \begin{macro}{\@@@fxnote@early@draft}
2918 % \begin{macro}{\@@@fxnote@late@draft}
2919 % \marg{type}\marg{note}\\
2920 % The lower-level macros that perform the real job. In \texttt{final} mode,
2921 % early work is only to check for remaining fatal annotations and late work
2922 % is to dispatch common layouts.
2923 % \begin{macrocode}
2924 \newcommand*\@@@fxnote@early@final[2]{%
2925 \ifthenelse{\equal{#1}{fatal}}{%
2926 \@fxpkgerror{'#2' fatal error left in final version}{%
2927 You are currently processing in final mode,\MessageBreak
2928 but you still have some FiXme fatal errors left behind.\MessageBreak
2929 Type X to quit, fix your document (or switch back to draft
2930 mode),\MessageBreak
2931 and rerun LaTeX.}}{}}
2932 \newcommand*\@@@fxnote@late@final[2]{\@fxissuecommonlayouts{#1}{#2}}
2933 % \end{macrocode}
2934 % In \texttt{draft} mode, early work is to dispatch early layouts, while late
2935 % work is to dispatch both late \emph{and} common layouts, and update the
2936 % \texttt{lox} file.
2937 % \begin{macrocode}
2938 \newcommand*\@@@fxnote@early@draft[2]{%
2939 \@fxissueearlydraftlayouts{#1}{#2}}
2940 \newcommand*\@@@fxnote@late@draft[2]{%
2941 \@fxissuelatedraftlayouts{#1}{#2}%
2942 \FXLayoutContentsLine{#1}{#2}{\cmdfx@note@author}%
2943 \@fxissuecommonlayouts{#1}{#2}}
2944
2945 % \end{macrocode}
2946 % \end{macro}
2947 % \end{macro}
2948 % \end{macro}
2949 % \end{macro}
2950 %
2951 % \subsubsection{Standard version}
2952 % \begin{macro}{\@fxpostconfigure}
2953 % This macro is used in \cs{@@fxnote@early} below, after processing user
2954 % options (even when there is none), to postconfigure some aspects of the
2955 % annotations. Currently, this involves two things: setting the author to
2956 % \cs{fixmelogo} if it still is \texttt{fixme}, and automatically tracking
2957 % the current language if required (note that all other language options
2958 % turn tracking off, meaning that one can override language tracking locally
2959 % by providing a language explicitely). Since environments need the
2960 % post-configuration done sooner, they perform it themselves and rebind this
2961 % macro to \cs{relax}.
2962 % \begin{macrocode}
2963 \newcommand*\@fxpostconfigure{%
2964 \ifthenelse{\equal{\cmdfx@note@author}{fixme}}{%
2965 \@fxsetkeys{note}{author=\fixmelogo}}{}%
2966 \iffx@lang@langtrack%
2967 \@fxkeyifundefined{lang}{\languagename}{%
2968 \@fxpkgwarning{unknown language '\languagename';\MessageBreak
2969 falling back to \@fxdefaultlang}%
2970 \@fxsetkeys{lang}{\@fxdefaultlang}}{%
2971 \@fxsetkeys{lang}{\languagename}}
2972 \fi}
2973
2974 % \end{macrocode}
2975 % \end{macro}
2976 % \begin{macro}{\@fxendgroup}
2977 % This macro is used in \cs{@@fxnote@late} below to close the group opened
2978 % at the user level. Since environments need the group opened for a longer
2979 % time, they rebind it to \cs{relax} and close the group themselves later
2980 % on.
2981 % \begin{macrocode}
2982 \let\@fxendgroup\endgroup
2983 % \end{macrocode}
2984 % \end{macro}
2985 % \begin{macro}{\@@fxnote@early}
2986 % \marg{type}\marg{note}\\
2987 % Counters need to be updated regardless of the mode.
2988 % \begin{macrocode}
2989 \def\@@fxnote@early#1#2{%
2990 \@fxpostconfigure%
2991 \stepcounter{fixmecount}%
2992 \stepcounter{fx#1count}%
2993 \@@@fxnote@early{#1}{#2}}
2994 % \end{macrocode}
2995 % \end{macro}
2996 % \begin{macro}{\@@fxnote@late}
2997 % \begin{macrocode}
2998 \def\@@fxnote@late#1#2{%
2999 \@@@fxnote@late{#1}{#2}%
3000 \@fxendgroup}
3001 % \end{macrocode}
3002 % \end{macro}
3003 % \begin{macro}{\@@fxnote}
3004 % \marg{type}\marg{note}\\
3005 % This macro is used everywhere outside a starred context, because in that
3006 % case, we do early and late work in a row.
3007 % \begin{macrocode}
3008 \def\@@fxnote#1#2{%
3009 \@@fxnote@early{#1}{#2}%
3010 \@@fxnote@late{#1}{#2}}
3011 % \end{macrocode}
3012 % \end{macro}
3013 % \begin{macro}{\@fxnote}
3014 % \marg{type}\oarg{options}\marg{note}
3015 % \begin{macrocode}
3016 \def\@fxnote#1[#2]#3{%
3017 \@fxsetkeys{mode,status,lang,log,note,face,layout}{#2}%
3018 \@@fxnote{#1}{#3}}
3019
3020 % \end{macrocode}
3021 % \end{macro}
3022 %
3023 % \subsubsection{Starred version}
3024 % \begin{macro}{\@@fxsnote}
3025 % \marg{type}\marg{note}\marg{text}\\
3026 % Post-configuration is done here because it's the code path confluent for
3027 % all starred commands. Relaxing post-configuration afterwards is to prevent
3028 % \cs{@@fxnote@early} from doing it again. Note that this is the only place
3029 % where we actually do early and late work not in a row.
3030 % \begin{macrocode}
3031 \long\def\@@fxsnote#1#2#3{%
3032 \@fxpostconfigure\let\@fxpostconfigure\relax%
3033 \@@fxnote@early{#1}{#2}\@fxtargetlayout{#1}{#3}\@@fxnote@late{#1}{#2}}
3034 % \end{macrocode}
3035 % \end{macro}
3036 % \begin{macro}{\@fxsnote}
3037 % \marg{type}\oarg{options}\marg{note}\marg{text}\\
3038 % Note the \texttt{targetlayout} family here.
3039 % \begin{macrocode}
3040 \long\def\@fxsnote#1[#2]#3#4{%
3041 \@fxsetkeys{mode,status,lang,log,note,face,layout,targetlayout}{#2}%
3042 \@@fxsnote{#1}{#3}{#4}}
3043
3044 % \end{macrocode}
3045 % \end{macro}
3046 %
3047 % \subsubsection{User-level interface generation}
3048 % \begin{macro}{\@fxpreconfigure}
3049 % \marg{author}\\
3050 % This macro is used at the beginning of every user-level entry point (here
3051 % for notes, and also in the environments section), to preconfigure some
3052 % aspects of the annotations, before possibly processing options. Currently,
3053 % this only involves presetting the note's author to the one specified in
3054 % the call to \cs{FXRegisterAuthor}. This however is not done for the
3055 % built-in \texttt{fixme} author, because this one should honor a global
3056 % setting.
3057 % \begin{macrocode}
3058 \newcommand*\@fxpreconfigure[1]{%
3059 \ifthenelse{\equal{#1}{fixme}}{}{\@fxsetkeys{note}{author=#1}}}
3060 % \end{macrocode}
3061 % \end{macro}
3062 % \begin{macro}{\@fxnewnotemacro}
3063 % \marg{prefix}\marg{type}\marg{author}\\
3064 % This macro defines the user-level interface:
3065 % \begin{macrocode}
3066 \newcommand*\@fxnewnotemacro[3]{%
3067 \expandafter\DeclareRobustCommand\csname #1#2\endcsname{%
3068 \begingroup%
3069 \@fxpreconfigure{#3}%
3070 \@ifstar{%
3071 \@ifnextchar[%]
3072 {\@fxsnote{#2}}{\@@fxsnote{#2}}}{%
3073 \@ifnextchar[%]
3074 {\@fxnote{#2}}{\@@fxnote{#2}}}}}
3075 % \end{macrocode}
3076 % \end{macro}
3077 %
3078 % \subsection{\fx environments}
3079 % A \fx environment's summary is laid out by the corresponding macro, but
3080 % the \texttt{inline} layout is disabled. This is as easy as appending
3081 % \texttt{noinline} to the end of the options list.
3082 % \subsubsection{Status-dependent implementation}
3083 % \begin{macro}{\@@@@fxbeginenv@final}
3084 % \begin{macro}{\@@@@fxbeginenv@draft}
3085 % \begin{macro}{\@fxendenv@final}
3086 % \begin{macro}{\@fxendenv@draft}
3087 % \marg{type}\\
3088 % In final mode, \texttt{verbatim}'s \texttt{comment} environment is used to
3089 % suppress output.
3090 % \begin{macrocode}
3091 \def\@@@@fxbeginenv@final#1{\comment}
3092 \def\@@@@fxbeginenv@draft#1{\@fxenvlayout@begin{#1}{\cmdfx@note@author}}
3093 \def\@fxendenv@final#1{\endcomment}
3094 \def\@fxendenv@draft#1{\unskip\@fxenvlayout@end{#1}{\cmdfx@note@author}}
3095
3096 % \end{macrocode}
3097 % \end{macro}
3098 % \end{macro}
3099 %
3100 % \subsubsection{Standard versions}
3101 % \begin{macro}{\@@@fxbeginenv}
3102 % \begin{macro}{\@@fxbeginenv}
3103 % \marg{type}\marg{summary}\\
3104 % Post-configuration is done here (it's the code path confluent for all
3105 % non-starred environments). Relaxing post-configuration afterwards is to
3106 % prevent \cs{@@fxnote} from doing it again.
3107 % \begin{macrocode}
3108 \def\@@@fxbeginenv#1#2{%
3109 \@fxpostconfigure\let\@fxpostconfigure\relax%
3110 \@@fxnote{#1}{#2}%
3111 \@@@@fxbeginenv{#1}}
3112 \def\@@fxbeginenv#1#2{%
3113 \@fxsetkeys{layout}{noinline}%
3114 \@@@fxbeginenv{#1}{#2}}
3115 % \end{macrocode}
3116 % \end{macro}
3117 % \end{macro}
3118 % \begin{macro}{\@fxbeginenv}
3119 % \marg{type}\oarg{options}\marg{summary}
3120 % \begin{macrocode}
3121 \def\@fxbeginenv#1[#2]#3{%
3122 \@fxsetkeys{mode,status,lang,log,note,face,layout,envlayout}{#2,noinline}%
3123 \@@@fxbeginenv{#1}{#3}}
3124
3125 % \end{macrocode}
3126 % \end{macro}
3127 % \end{macro}
3128 %
3129 % \subsubsection{Starred versions}
3130 % \begin{macro}{\@@@fxbeginsenv}
3131 % \begin{macro}{\@@fxbeginsenv}
3132 % \marg{type}\marg{summary}\marg{text}\\
3133 % Post-configuration is done here (it's the code path confluent for all
3134 % starred environments). Relaxing post-configuration afterwards is to
3135 % prevent \cs{@@fxsnote} from doing it again.
3136 % \begin{macrocode}
3137 \long\def\@@@fxbeginsenv#1#2#3{%
3138 \@fxpostconfigure\let\@fxpostconfigure\relax%
3139 \@@fxsnote{#1}{#2}{#3}%
3140 \@@@@fxbeginenv{#1}}
3141 \long\def\@@fxbeginsenv#1#2#3{%
3142 \@fxsetkeys{layout}{noinline}%
3143 \@@@fxbeginsenv{#1}{#2}{#3}}
3144 % \end{macrocode}
3145 % \end{macro}
3146 % \end{macro}
3147 % \begin{macro}{\@fxbeginenv}
3148 % \marg{type}\oarg{options}\marg{summary}\marg{text}\\
3149 % Note the \texttt{targetlayout} family here.
3150 % \begin{macrocode}
3151 \long\def\@fxbeginsenv#1[#2]#3#4{%
3152 \@fxsetkeys{mode,status,lang,log,note,face,layout,envlayout,targetlayout}{%
3153 #2,noinline}%
3154 \@@@fxbeginsenv{#1}{#3}{#4}}
3155
3156 % \end{macrocode}
3157 % \end{macro}
3158 % \end{macro}
3159 %
3160 % \subsubsection{User-level interface generation}
3161 % \begin{macro}{\@fxnewnoteenvs}
3162 % \marg{prefix}\marg{type}\marg{author}\\
3163 % This macro defines the user-level interface. The ending macros are
3164 % identical. Also, the environments close their own group, so we prevent
3165 % \cs{@@fxnote} from doing so by temporarily rebinding \cs{@fxendgroup} to
3166 % \cs{relax}.
3167 % \begin{macrocode}
3168 \newcommand*\@fxnewnoteenvs[3]{%
3169 \expandafter\def\csname #1#2\endcsname{%
3170 \begingroup%
3171 \let\@fxendgroup\relax%
3172 \@fxpreconfigure{#3}%
3173 \@ifnextchar[%]
3174 {\@fxbeginenv{#2}}{\@@fxbeginenv{#2}}}
3175 \expandafter\def\csname end#1#2\endcsname{%
3176 \@fxendenv{#2}%
3177 \endgroup}%
3178 \expandafter\long\expandafter\def\csname #1#2*\endcsname{%
3179 \begingroup%
3180 \let\@fxendgroup\relax%
3181 \@fxpreconfigure{#3}%
3182 \@ifnextchar[%]
3183 {\@fxbeginsenv{#2}}{\@@fxbeginsenv{#2}}}
3184 \expandafter\def\csname end#1#2*\endcsname{%
3185 \@fxendenv{#2}%
3186 \endgroup}}
3187
3188 % \end{macrocode}
3189 % \end{macro}
3190 %
3191 % \subsection{\fx authors}
3192 % \begin{macro}{\FXRegisterAuthor}
3193 % \marg{cmdprefix}\marg{envprefix}\marg{name}\\
3194 % This macro creates the whole user-level interface for a particular author:
3195 % \begin{macrocode}
3196 \newcommand*\FXRegisterAuthor[3]{%
3197 \@ifundefined{#1note}{}{%
3198 \@fxpkgerror{command prefix '#1' already in use}{%
3199 You have called \string\FXRegisterAuthor\space with a command prefix
3200 already in use.\MessageBreak
3201 Please choose another one.}}%
3202 \@ifundefined{#2note}{}{%
3203 \@fxpkgerror{environment prefix '#2' already in use}{%
3204 You have called \string\FXRegisterAuthor\space with an environment
3205 prefix already in use.\MessageBreak
3206 Please choose another one.}}%
3207 \@fxnewnotemacro{#1}{note}{#3}%
3208 \@fxnewnotemacro{#1}{warning}{#3}%
3209 \@fxnewnotemacro{#1}{error}{#3}%
3210 \@fxnewnotemacro{#1}{fatal}{#3}%
3211 \@fxnewnoteenvs{#2}{note}{#3}%
3212 \@fxnewnoteenvs{#2}{warning}{#3}%
3213 \@fxnewnoteenvs{#2}{error}{#3}%
3214 \@fxnewnoteenvs{#2}{fatal}{#3}}
3215
3216 % \end{macrocode}
3217 % \end{macro}
3218 % \begin{macro}[noindex]{\fx...[*]}
3219 % \begin{environment}[noindex]{anfx...[*]}
3220 % \begin{macro}[noprint]{\fxnote}
3221 % \begin{macro}[noprint]{\fxwarning}
3222 % \begin{macro}[noprint]{\fxerror}
3223 % \begin{macro}[noprint]{\fxfatal}
3224 % \begin{macro}[noprint]{\fxnote*}
3225 % \begin{macro}[noprint]{\fxwarning*}
3226 % \begin{macro}[noprint]{\fxerror*}
3227 % \begin{macro}[noprint]{\fxfatal*}
3228 % \begin{environment}[noprint]{anfxnote}
3229 % \begin{environment}[noprint]{anfxwarning}
3230 % \begin{environment}[noprint]{anfxerror}
3231 % \begin{environment}[noprint]{anfxfatal}
3232 % \begin{environment}[noprint]{anfxnote*}
3233 % \begin{environment}[noprint]{anfxwarning*}
3234 % \begin{environment}[noprint]{anfxerror*}
3235 % \begin{environment}[noprint]{anfxfatal*}
3236 % And we use it to create the \fx default user:
3237 % \begin{macrocode}
3238 \FXRegisterAuthor{fx}{anfx}{fixme}
3239 % \end{macrocode}
3240 % \end{environment}
3241 % \end{environment}
3242 % \end{environment}
3243 % \end{environment}
3244 % \end{environment}
3245 % \end{environment}
3246 % \end{environment}
3247 % \end{environment}
3248 % \end{macro}
3249 % \end{macro}
3250 % \end{macro}
3251 % \end{macro}
3252 % \end{macro}
3253 % \end{macro}
3254 % \end{macro}
3255 % \end{macro}
3256 % \end{environment}
3257 % \end{macro}
3258 % \begin{macro}{\fixme}
3259 % \oarg{options}\marg{note}\\
3260 % Deprecate \cs{fixme}:
3261 % \begin{macrocode}
3262 \DeclareRobustCommand\fixme{%
3263 \@fxpkgwarning{\string\fixme\space is deprecated;\MessageBreak
3264 please use \string\fxfatal\space instead}%
3265 \fxfatal}
3266 % \end{macrocode}
3267 % \end{macro}
3268 % \begin{environment}{afixme}
3269 % Deprecate the \texttt{afixme} environment:
3270 % \begin{macrocode}
3271 \def\afixme{%
3272 \@fxpkgwarning{The 'afixme' environment is deprecated;\MessageBreak
3273 please use 'anfxfatal' instead}%
3274 \anfxfatal}
3275 \let\endafixme\endanfxfatal
3276 % \end{macrocode}
3277 % \end{environment}
3278 %
3279 % \subsection{Internationalization\label{sec:code:i18n}}
3280 % \begin{macro}{\@fxlanguages}
3281 % This macro lists all the supported languages, including aliases:
3282 % \begin{macrocode}
3283 \newcommand*\@fxlanguages{%
3284 english,french,francais,spanish,italian,german,ngerman,danish,croatian}
3285
3286 % \end{macrocode}
3287 % \end{macro}
3288 %
3289 % \subsubsection{Language definitions}
3290 % \paragraph{English}
3291 % \begin{lang}{english}
3292 % \begin{macro}[noindex]{\fxenglish...[s]name}
3293 % \begin{macro}[noprint]{\fxenglishnotename}
3294 % \begin{macro}[noprint]{\fxenglishnotesname}
3295 % \begin{macro}[noprint]{\fxenglishwarningname}
3296 % \begin{macro}[noprint]{\fxenglishwarningsname}
3297 % \begin{macro}[noprint]{\fxenglisherrorname}
3298 % \begin{macro}[noprint]{\fxenglisherrorsname}
3299 % \begin{macro}[noprint]{\fxenglishfatalname}
3300 % \begin{macro}[noprint]{\fxenglishfatalsname}
3301 % \begin{macro}{\englishlistfixmename}
3302 % \mbox{}
3303 % \begin{macrocode}
3304 \newcommand\fxenglishnotename{Note}
3305 \newcommand\fxenglishnotesname{Notes}
3306 \newcommand\fxenglishwarningname{Warning}
3307 \newcommand\fxenglishwarningsname{Warnings}
3308 \newcommand\fxenglisherrorname{Error}
3309 \newcommand\fxenglisherrorsname{Errors}
3310 \newcommand\fxenglishfatalname{Fatal}
3311 \newcommand\fxenglishfatalsname{Fatal errors}
3312 \newcommand\englishlistfixmename{List of Corrections}
3313
3314 % \end{macrocode}
3315 % \end{macro}
3316 % \end{macro}
3317 % \end{macro}
3318 % \end{macro}
3319 % \end{macro}
3320 % \end{macro}
3321 % \end{macro}
3322 % \end{macro}
3323 % \end{macro}
3324 % \end{macro}
3325 % \end{lang}
3326 %
3327 % \paragraph{French}
3328 % \begin{lang}{french}
3329 % \begin{lang}{francais}
3330 % \begin{macro}[noindex]{\fxfrench...[s]name}
3331 % \begin{macro}[noprint]{\fxfrenchnotename}
3332 % \begin{macro}[noprint]{\fxfrenchnotesname}
3333 % \begin{macro}[noprint]{\fxfrenchwarningname}
3334 % \begin{macro}[noprint]{\fxfrenchwarningsname}
3335 % \begin{macro}[noprint]{\fxfrencherrorname}
3336 % \begin{macro}[noprint]{\fxfrencherrorsname}
3337 % \begin{macro}[noprint]{\fxfrenchfatalname}
3338 % \begin{macro}[noprint]{\fxfrenchfatalsname}
3339 % \begin{macro}{\frenchlistfixmename}
3340 % \mbox{}
3341 % \begin{macrocode}
3342 \newcommand\fxfrenchnotename{Note}
3343 \newcommand\fxfrenchnotesname{Notes}
3344 \newcommand\fxfrenchwarningname{Attention}
3345 \newcommand\fxfrenchwarningsname{Avertissements}
3346 \newcommand\fxfrencherrorname{Erreur}
3347 \newcommand\fxfrencherrorsname{Erreurs}
3348 \newcommand\fxfrenchfatalname{Fatal}
3349 \newcommand\fxfrenchfatalsname{Erreurs fatales}
3350 \newcommand\frenchlistfixmename{Liste des Corrections}
3351
3352 % \end{macrocode}
3353 % \end{macro}
3354 % \end{macro}
3355 % \end{macro}
3356 % \end{macro}
3357 % \end{macro}
3358 % \end{macro}
3359 % \end{macro}
3360 % \end{macro}
3361 % \end{macro}
3362 % \end{macro}
3363 % \end{lang}
3364 % \end{lang}
3365 %
3366 % \paragraph{Spanish}
3367 % \begin{lang}{spanish}
3368 % \begin{macro}[noindex]{\fxspanish...[s]name}
3369 % \begin{macro}[noprint]{\fxspanishnotename}
3370 % \begin{macro}[noprint]{\fxspanishnotesname}
3371 % \begin{macro}[noprint]{\fxspanishwarningname}
3372 % \begin{macro}[noprint]{\fxspanishwarningsname}
3373 % \begin{macro}[noprint]{\fxspanisherrorname}
3374 % \begin{macro}[noprint]{\fxspanisherrorsname}
3375 % \begin{macro}[noprint]{\fxspanishfatalname}
3376 % \begin{macro}[noprint]{\fxspanishfatalsname}
3377 % \begin{macro}{\spanishlistfixmename}
3378 % \mbox{}
3379 % \begin{macrocode}
3380 \newcommand\fxspanishnotename{Nota}
3381 \newcommand\fxspanishnotesname{Notas}
3382 \newcommand\fxspanishwarningname{Aviso}
3383 \newcommand\fxspanishwarningsname{Avisos}
3384 \newcommand\fxspanisherrorname{Error}
3385 \newcommand\fxspanisherrorsname{Errores}
3386 \newcommand\fxspanishfatalname{Fatal}
3387 \newcommand\fxspanishfatalsname{Errores fatales}
3388 \newcommand\spanishlistfixmename{Lista de Correcciones}
3389
3390 % \end{macrocode}
3391 % \end{macro}
3392 % \end{macro}
3393 % \end{macro}
3394 % \end{macro}
3395 % \end{macro}
3396 % \end{macro}
3397 % \end{macro}
3398 % \end{macro}
3399 % \end{macro}
3400 % \end{macro}
3401 % \end{lang}
3402 %
3403 % \paragraph{Italian}
3404 % \begin{lang}{italian}
3405 % \begin{macro}[noindex]{\fxitalian...[s]name}
3406 % \begin{macro}[noprint]{\fxitaliannotename}
3407 % \begin{macro}[noprint]{\fxitaliannotesname}
3408 % \begin{macro}[noprint]{\fxitalianwarningname}
3409 % \begin{macro}[noprint]{\fxitalianwarningsname}
3410 % \begin{macro}[noprint]{\fxitalianerrorname}
3411 % \begin{macro}[noprint]{\fxitalianerrorsname}
3412 % \begin{macro}[noprint]{\fxitalianfatalname}
3413 % \begin{macro}[noprint]{\fxitalianfatalsname}
3414 % \begin{macro}{\italianlistfixmename}
3415 % \mbox{}
3416 % \begin{macrocode}
3417 \newcommand\fxitaliannotename{Nota}
3418 \newcommand\fxitaliannotesname{Note}
3419 \newcommand\fxitalianwarningname{Avviso}
3420 \newcommand\fxitalianwarningsname{Avvisi}
3421 \newcommand\fxitalianerrorname{Errore}
3422 \newcommand\fxitalianerrorsname{Errori}
3423 \newcommand\fxitalianfatalname{Fatale}
3424 \newcommand\fxitalianfatalsname{Errori fatali}
3425 \newcommand\italianlistfixmename{Corrigenda}
3426
3427 % \end{macrocode}
3428 % \end{macro}
3429 % \end{macro}
3430 % \end{macro}
3431 % \end{macro}
3432 % \end{macro}
3433 % \end{macro}
3434 % \end{macro}
3435 % \end{macro}
3436 % \end{macro}
3437 % \end{macro}
3438 % \end{lang}
3439 %
3440 % \paragraph{German}
3441 % \begin{lang}{german}
3442 % \begin{lang}{ngerman}
3443 % \begin{macro}[noindex]{\fxgerman...[s]name}
3444 % \begin{macro}[noprint]{\fxgermannotename}
3445 % \begin{macro}[noprint]{\fxgermannotesname}
3446 % \begin{macro}[noprint]{\fxgermanwarningname}
3447 % \begin{macro}[noprint]{\fxgermanwarningsname}
3448 % \begin{macro}[noprint]{\fxgermanerrorname}
3449 % \begin{macro}[noprint]{\fxgermanerrorsname}
3450 % \begin{macro}[noprint]{\fxgermanfatalname}
3451 % \begin{macro}[noprint]{\fxgermanfatalsname}
3452 % \begin{macro}{\germanlistfixmename}
3453 % \mbox{}
3454 % \begin{macrocode}
3455 \newcommand\fxgermannotename{Anm}
3456 \newcommand\fxgermannotesname{Anmerkungen}
3457 \newcommand\fxgermanwarningname{Warnung}
3458 \newcommand\fxgermanwarningsname{Warnungen}
3459 \newcommand\fxgermanerrorname{Fehler}
3460 \newcommand\fxgermanerrorsname{Fehler}
3461 \newcommand\fxgermanfatalname{Verh\"angnisvoll}
3462 \newcommand\fxgermanfatalsname{Verh\"angnisvolle fehler}
3463 \newcommand\germanlistfixmename{Verzeichnis der Korrekturen}
3464
3465 % \end{macrocode}
3466 % \end{macro}
3467 % \end{macro}
3468 % \end{macro}
3469 % \end{macro}
3470 % \end{macro}
3471 % \end{macro}
3472 % \end{macro}
3473 % \end{macro}
3474 % \end{macro}
3475 % \end{macro}
3476 % \end{lang}
3477 % \end{lang}
3478 %
3479 % \paragraph{Danish}
3480 % \begin{lang}{danish}
3481 % \begin{macro}[noindex]{\fxdanish...[s]name}
3482 % \begin{macro}[noprint]{\fxdanishnotename}
3483 % \begin{macro}[noprint]{\fxdanishnotesname}
3484 % \begin{macro}[noprint]{\fxdanishwarningname}
3485 % \begin{macro}[noprint]{\fxdanishwarningsname}
3486 % \begin{macro}[noprint]{\fxdanisherrorname}
3487 % \begin{macro}[noprint]{\fxdanisherrorsname}
3488 % \begin{macro}[noprint]{\fxdanishfatalname}
3489 % \begin{macro}[noprint]{\fxdanishfatalsname}
3490 % \begin{macro}{\danishlistfixmename}
3491 % \mbox{}
3492 % \begin{macrocode}
3493 \newcommand\fxdanishnotename{Note}
3494 \newcommand\fxdanishnotesname{Noter}
3495 \newcommand\fxdanishwarningname{Advarsel}
3496 \newcommand\fxdanishwarningsname{Advarsler}
3497 \newcommand\fxdanisherrorname{Fejl}
3498 \newcommand\fxdanisherrorsname{Fejl}
3499 \newcommand\fxdanishfatalname{Fatal}
3500 \newcommand\fxdanishfatalsname{Fatale fejl}
3501 \newcommand\danishlistfixmename{Rettelser}
3502
3503 % \end{macrocode}
3504 % \end{macro}
3505 % \end{macro}
3506 % \end{macro}
3507 % \end{macro}
3508 % \end{macro}
3509 % \end{macro}
3510 % \end{macro}
3511 % \end{macro}
3512 % \end{macro}
3513 % \end{macro}
3514 % \end{lang}
3515 %
3516 % \paragraph{Croatian}
3517 % \begin{lang}{croatian}
3518 % \begin{macro}[noindex]{\fxcroatian...[s]name}
3519 % \begin{macro}[noprint]{\fxcroatiannotename}
3520 % \begin{macro}[noprint]{\fxcroatiannotesname}
3521 % \begin{macro}[noprint]{\fxcroatianwarningname}
3522 % \begin{macro}[noprint]{\fxcroatianwarningsname}
3523 % \begin{macro}[noprint]{\fxcroatianerrorname}
3524 % \begin{macro}[noprint]{\fxcroatianerrorsname}
3525 % \begin{macro}[noprint]{\fxcroatianfatalname}
3526 % \begin{macro}[noprint]{\fxcroatianfatalsname}
3527 % \begin{macro}{\croatianlistfixmename}
3528 % \mbox{}
3529 % \begin{macrocode}
3530 \newcommand\fxcroatiannotename{Poruka}
3531 \newcommand\fxcroatiannotesname{Poruke}
3532 \newcommand\fxcroatianwarningname{Upozorenja}
3533 \newcommand\fxcroatianwarningsname{Upozorenje}
3534 \newcommand\fxcroatianerrorname{Gre\v ska}
3535 \newcommand\fxcroatianerrorsname{Greske}
3536 \newcommand\fxcroatianfatalname{Fatalan}
3537 \newcommand\fxcroatianfatalsname{Kobne gre\v ske}
3538 \newcommand\croatianlistfixmename{Popis korekcija}
3539
3540 % \end{macrocode}
3541 % \end{macro}
3542 % \end{macro}
3543 % \end{macro}
3544 % \end{macro}
3545 % \end{macro}
3546 % \end{macro}
3547 % \end{macro}
3548 % \end{macro}
3549 % \end{macro}
3550 % \end{macro}
3551 % \end{lang}
3552 %
3553 % \subsubsection{Language tracking}
3554 % \begin{option}{langtrack}
3555 % Whether to track the value of \cs{languagename} automatically:
3556 % \begin{macrocode}
3557 \@fxdefineboolkey{lang}{langtrack}
3558 % \end{macrocode}
3559 % \end{option}
3560 % \begin{option}{defaultlang}
3561 % Which language to use when tracking leads to an unsuported language:
3562 % \begin{macrocode}
3563 \def\@fxexpr{\@fxdefinechoicekey{lang}{defaultlang}[\@fxdefaultlang]}
3564 \expandafter\@fxexpr\expandafter{\@fxlanguages}{}
3565
3566 % \end{macrocode}
3567 % \end{option}
3568 %
3569 % \subsubsection{Language options}
3570 % \begin{option}{lang}
3571 % \begin{macro}{\@fxlang}
3572 % Store the current language in \cs{@fxlang} after having handled language
3573 % aliases, and disable language tracking:
3574 % \begin{macrocode}
3575 \def\@fxexpr{\@fxdefinechoicekey{lang}{lang}[\@fxlang]}
3576 \expandafter\@fxexpr\expandafter{\@fxlanguages}{%
3577 \ifthenelse{\equal{#1}{francais}}{\def\@fxlang{french}}{%
3578 \ifthenelse{\equal{#1}{ngerman}}{\def\@fxlang{german}}{}}%
3579 \@fxsetkeys{lang}{langtrack=false}}
3580
3581 % \end{macrocode}
3582 % \end{macro}
3583 % \end{option}
3584 % \begin{option}{english}
3585 % \begin{option}{french}
3586 % \begin{option}{francais}
3587 % \begin{option}{spanish}
3588 % \begin{option}{italian}
3589 % \begin{option}{german}
3590 % \begin{option}{ngerman}
3591 % \begin{option}{danish}
3592 % \begin{option}{croatian}
3593 % Create individual language options:
3594 % \begin{macrocode}
3595 \@for\@fxlg:=\@fxlanguages\do{
3596 \def\@fxexprone{\@fxdefinevoidkey{lang}}
3597 \edef\@fxexprtwo{{\@fxlg}{\noexpand\@fxsetkeys{lang}{lang=\@fxlg}}}
3598 \expandafter\@fxexprone\@fxexprtwo}
3599
3600 % \end{macrocode}
3601 % \end{option}
3602 % \end{option}
3603 % \end{option}
3604 % \end{option}
3605 % \end{option}
3606 % \end{option}
3607 % \end{option}
3608 % \end{option}
3609 % \end{option}
3610 %
3611 % \subsubsection{Language abstraction layer}
3612 % \begin{macro}{\@fxlistfixmename}
3613 % Construct the ``list of fixmes'' title in a language dependent fashion:
3614 % \begin{macrocode}
3615 \newcommand*\@fxlistfixmename{\@nameuse{\@fxlang listfixmename}}
3616 % \end{macrocode}
3617 % \end{macro}
3618 % \begin{macro}{\fxnotename}
3619 % \begin{macro}{\fxnotesname}
3620 % \marg{type}\\
3621 % Construct the notes names in a language dependent fashion:
3622 % \begin{macrocode}
3623 \newcommand*\fxnotename[1]{\@nameuse{fx\@fxlang#1name}}
3624 \newcommand*\fxnotesname[1]{\@nameuse{fx\@fxlang#1sname}}
3625
3626 % \end{macrocode}
3627 % \end{macro}
3628 % \end{macro}
3629 %
3630 % \subsection{Document status processing}
3631 % \begin{macro}{\@@@fxnote@early}
3632 % \begin{macro}{\@@@fxnote@late}
3633 % \begin{macro}{\@@@@fxbeginenv}
3634 % \begin{macro}{\@fxendenv}
3635 % \begin{macro}{\@fxtargetlayout}
3636 % \begin{macro}{\listoffixmes}
3637 % \begin{option}{final}
3638 % \begin{option}{draft}
3639 % \begin{option}{status}
3640 % Select draft or final versions of internal macros (some of
3641 % them also depending on the document class):
3642 % \begin{macrocode}
3643 \@fxdefinevoidkey{status}{final}{%
3644 \let\@@@fxnote@early\@@@fxnote@early@final%
3645 \let\@@@fxnote@late\@@@fxnote@late@final%
3646 \let\@@@@fxbeginenv\@@@@fxbeginenv@final
3647 \let\@fxendenv\@fxendenv@final%
3648 \let\@fxtargetlayout\@fxtargetlayout@final%
3649 \let\listoffixmes\lox@final}
3650 \@fxdefinevoidkey{status}{draft}{%
3651 \let\@@@fxnote@early\@@@fxnote@early@draft%
3652 \let\@@@fxnote@late\@@@fxnote@late@draft%
3653 \let\@@@@fxbeginenv\@@@@fxbeginenv@draft
3654 \let\@fxendenv\@fxendenv@draft%
3655 \let\@fxtargetlayout\@fxtargetlayout@draft%
3656 \let\listoffixmes\lox@draft}
3657 \@fxdefinechoicekey{status}{status}{final,draft}{\@fxsetkeys{status}{#1}}
3658
3659 % \end{macrocode}
3660 % \end{option}
3661 % \end{option}
3662 % \end{option}
3663 % \end{macro}
3664 % \end{macro}
3665 % \end{macro}
3666 % \end{macro}
3667 % \end{macro}
3668 % \end{macro}
3669 %
3670 % \subsection{Theme support}
3671 % \begin{macro}{\FXProvidesTheme}
3672 % \marg{name}\oarg{release information}
3673 % \begin{macrocode}
3674 \newcommand*\FXProvidesTheme[1]{\ProvidesPackage{fxtheme#1}}
3675 % \end{macrocode}
3676 % \end{macro}
3677 % \begin{macro}{\fxusetheme}
3678 % \marg{name}
3679 % \begin{macrocode}
3680 \newcommand*\fxusetheme[1]{\usepackage{fxtheme#1}}
3681 % \end{macrocode}
3682 % \end{macro}
3683 % \begin{option}{theme}
3684 % \mbox{}
3685 % \begin{macrocode}
3686 \@fxdefinekey{theme}{theme}{\fxusetheme{#1}}
3687 % \end{macrocode}
3688 % \end{option}
3689 %
3690 % \subsection{Finale}
3691 % \subsubsection{Class-dependent settings}
3692 % Currently, our class dependencies only matter in draft mode, so one could
3693 % argue that it is not optimal to handle this here. However, it would be
3694 % incorrect to do it in the \texttt{draft} option code because this option can
3695 % be switched at any point in the document (remember that it is understood
3696 % even by the annotation macros and environments) and the stuff below
3697 % should only be executed once. Besides, \cs{@ifclassloaded} is an
3698 % \cs{@onlypreamble} macro\ldots
3699 %
3700 % As documented, marginal notes are incompatible with the ACM SIG classes.
3701 % Initially, I thought I would detect these classes and issue an error if
3702 % marginal layout (or clue) is active. However, I changed my mind, because
3703 % nothing prevents somebody to write a new class on top of these ones and
3704 % authorize \cs{marginpar} back again. Normally these classes issue an error
3705 % if \cs{marginpar} is used. However, the 2.3 / June 2007 versions are buggy
3706 % and the error actually triggers a stack overflow in \LaTeX\ldots (patch
3707 % submitted). Oh boy, these classes are a mess.
3708 % \begin{macro}{\@lox@prtc}
3709 % \begin{macro}{\@lox@psttc}
3710 % \begin{macro}{\@lox@draft}
3711 % \begin{macrocode}
3712 \@ifclassloaded{article}{%
3713 \let\@lox@prtc\@lox@prtc@article%
3714 \let\@lox@psttc\@lox@psttc@article}{%
3715 \@ifclassloaded{report}{%
3716 \let\@lox@prtc\@lox@prtc@report%
3717 \let\@lox@psttc\@lox@psttc@report}{%
3718 \@ifclassloaded{book}{%
3719 \let\@lox@prtc\@lox@prtc@book%
3720 \let\@lox@psttc\@lox@psttc@book}{%
3721 \@ifclassloaded{amsbook}{%
3722 \let\lox@draft\lox@draft@ams}{%
3723 \@ifclassloaded{amsart}{%
3724 \let\lox@draft\lox@draft@ams}{%
3725 %% Use the article layout by default.
3726 \let\@lox@prtc\@lox@prtc@article%
3727 \let\@lox@psttc\@lox@psttc@article}}}}}
3728
3729 % \end{macrocode}
3730 % This overrides any previous class-based settings but makes the list of
3731 % corrections compliant with the \komascript classes and any document using
3732 % the \texttt{tocbasic} package.
3733 % \begin{macrocode}
3734 \@ifpackageloaded{tocbasic}{%
3735 \addtotoclist[fixme]{lox}%
3736 \renewcommand\lox@draft{\listoftoc[\@fxlistfixmename]{lox}}}{}
3737 % \end{macrocode}
3738 % \end{macro}
3739 % \end{macro}
3740 % \end{macro}
3741 %
3742 % \subsubsection{Options Processing}
3743 % First, we execute some options to initialize \fx to something sensible,
3744 % and then we process the user ones. Note the abscence of the \texttt{theme}
3745 % family here.
3746 % \begin{macrocode}
3747 \ExecuteOptionsX[fx]<%
3748 mode,status,lang,log,note,face,layout,envlayout,targetlayout>{%
3749 mode=singleuser,%
3750 status=final,%
3751 lang=english,%
3752 langtrack=false,%
3753 defaultlang=english,%
3754 nosilent,%
3755 author=fixme,%
3756 target=thepage,%
3757 layout=margin,%
3758 innerlayout={layout=inline},%
3759 envlayout=plain,%
3760 targetlayout=plain,%
3761 inlineface=\bfseries,%
3762 marginface=\footnotesize,%
3763 envface=\bfseries,%
3764 targetface=\itshape}
3765 \ProcessOptionsX*[fx]<%
3766 mode,status,lang,log,note,face,layout,envlayout,targetlayout>
3767
3768 % \end{macrocode}
3769 %
3770 % \subsubsection{The \cs{fxsetup} macro}
3771 % \begin{macro}{\fxsetup}
3772 % \marg{options}\\
3773 % The inevitable setup macro, extremely impressive yet as trivial as can be
3774 % with the \texttt{xkeyval} package\ldots \cs{fxsetup} is the only place
3775 % where the \texttt{theme} family is processed.
3776 % \begin{macrocode}
3777 \newcommand*\fxsetup[1]{%
3778 \@fxsetkeys{%
3779 mode,status,lang,log,note,face,layout,envlayout,targetlayout,theme}{%
3780 #1}}
3781
3782 % \end{macrocode}
3783 % \end{macro}
3784 %
3785 % \subsubsection{\fx summary}
3786 % Finally, output a summary giving the number of fixme notes at the end of the
3787 % compilation:
3788 % \begin{macrocode}
3789 \AtEndDocument{%
3790 \iffx@log@silent\else
3791 \GenericWarning{%
3792 (FiXme)\@spaces\@spaces}{%
3793 FiXme Summary: Number of notes: \thefxnotecount,\MessageBreak%
3794 Number of warnings: \thefxwarningcount,\MessageBreak%
3795 Number of errors: \thefxerrorcount,\MessageBreak%
3796 Number of fatal errors: \thefxfatalcount,\MessageBreak%
3797 Total: \thefixmecount\@gobble}%
3798 \fi}
3799 %</fixme>
3800 % \end{macrocode}
3801 %
3802 % \appendix
3803 % \section{External Layouts}
3804 % \subsection{Annotation layouts}
3805 % \subsubsection{The \texttt{marginnote} layout}
3806 % \begin{layout}{marginnote}
3807 % \mbox{}
3808 % \begin{macrocode}
3809 %<*fxlayoutmarginnote>
3810 \NeedsTeXFormat{LaTeX2e}
3811 \FXProvidesLayout{marginnote}
3812
3813 \RequirePackage{marginnote}
3814
3815 % \end{macrocode}
3816 % \begin{macro}{\FXLayoutMarginNote}
3817 % \marg{type}\marg{note}\marg{author}
3818 % \begin{macrocode}
3819 \newcommand*\FXLayoutMarginNote[3]{%
3820 \marginnote[\raggedleft\@fxuseface{margin}\@fxtextstd{#1}{#2}{#3}]{%
3821 \raggedright\@fxuseface{margin}\@fxtextstd{#1}{#2}{#3}}}
3822 % \end{macrocode}
3823 % \end{macro}
3824 % \begin{macro}{\@fxlayout@marginnote}
3825 % \begin{booleanoption}{marginnote}
3826 % \begin{macrocode}
3827 \FXRegisterLayout*[margin,marginclue]{marginnote}{\FXLayoutMarginNote}
3828 %</fxlayoutmarginnote>
3829 % \end{macrocode}
3830 % \end{booleanoption}
3831 % \end{macro}
3832 % \end{layout}
3833 %
3834 % \subsubsection{The \texttt{pdfnote} layout}
3835 % \begin{layout}{pdfnote}
3836 % \mbox{}
3837 % \begin{macrocode}
3838 %<*fxlayoutpdfnote>
3839 \NeedsTeXFormat{LaTeX2e}
3840 \FXProvidesLayout{pdfnote}
3841
3842 \RequirePackage{pdfcomment}
3843
3844 % \end{macrocode}
3845 % \begin{macro}{\FXLayoutPDFNote}
3846 % \marg{type}\marg{note}\marg{author}
3847 % \begin{macrocode}
3848 \newcommand*\FXLayoutPDFNote[3]{%
3849 \pdfcomment[author={#3}]{\@fxtextstd{#1}{#2}{#3}}}
3850 % \end{macrocode}
3851 % \end{macro}
3852 % \begin{macro}{\@fxlayout@pdfnote}
3853 % \begin{booleanoption}{pdfnote}
3854 % \begin{macrocode}
3855 \FXRegisterLayout{pdfnote}{\FXLayoutPDFNote}
3856 %</fxlayoutpdfnote>
3857 % \end{macrocode}
3858 % \end{booleanoption}
3859 % \end{macro}
3860 % \end{layout}
3861 %
3862 % \subsubsection{The \texttt{pdfmargin} layout}
3863 % \begin{layout}{pdfmargin}
3864 % \mbox{}
3865 % \begin{macrocode}
3866 %<*fxlayoutpdfmargin>
3867 \NeedsTeXFormat{LaTeX2e}
3868 \FXProvidesLayout{pdfmargin}
3869
3870 \RequirePackage{pdfcomment}
3871
3872 % \end{macrocode}
3873 % \begin{macro}{\FXLayoutPDFMargin}
3874 % \marg{type}\marg{note}\marg{author}
3875 % \begin{macrocode}
3876 \newcommand*\FXLayoutPDFMargin[3]{%
3877 \pdfmargincomment[author={#3}]{\@fxtextstd{#1}{#2}{#3}}}
3878 % \end{macrocode}
3879 % \end{macro}
3880 % \begin{macro}{\@fxlayout@pdfmargin}
3881 % \begin{booleanoption}{pdfmargin}
3882 % \begin{macrocode}
3883 \FXRegisterLayout*[margin,marginclue,marginnote]{pdfmargin}{%
3884 \FXLayoutPDFMargin}
3885 %</fxlayoutpdfmargin>
3886 % \end{macrocode}
3887 % \end{booleanoption}
3888 % \end{macro}
3889 % \end{layout}
3890 %
3891 % \subsubsection{The \texttt{pdfsignote} layout}
3892 % \begin{layout}{pdfsignote}
3893 % \mbox{}
3894 % \begin{macrocode}
3895 %<*fxlayoutpdfsignote>
3896 \NeedsTeXFormat{LaTeX2e}
3897 \FXProvidesLayout{pdfsignote}
3898
3899 \RequirePackage{pdfcomment}
3900
3901 % \end{macrocode}
3902 % \begin{macro}{\FXLayoutPDFSigNote}
3903 % \marg{type}\marg{note}\marg{author}\\
3904 % Warning: this layout cannot use \cs{@fxsignature} properly, because of the
3905 % presence of an \cs{ifthenelse} inside, and that, eventough it was declared
3906 % robust. This problem seems to affect PDF layouts only. The workaround I use
3907 % below is to externalize the conditional and temporarily redefine
3908 % \cs{@fxsignature} accordingly. This is a bit clumsy but it works\ldots
3909 % \begin{macrocode}
3910 \newcommand*\FXLayoutPDFSigNote[3]{%
3911 \begingroup%
3912 \ifthenelse{\equal{#3}{}}{%
3913 \def\@fxsignature##1{}}{%
3914 \def\@fxsignature##1{ -- {\@fxuseface{signature}#1}}}%
3915 \pdfcomment[author={#3}]{\@fxsigstd{#1}{#2}{#3}}%
3916 \endgroup}
3917 % \end{macrocode}
3918 % \end{macro}
3919 % \begin{macro}{\@fxlayout@pdfsignote}
3920 % \begin{booleanoption}{pdfsignote}
3921 % \begin{macrocode}
3922 \FXRegisterLayout[pdfnote]{pdfsignote}{\FXLayoutPDFSigNote}
3923 %</fxlayoutpdfsignote>
3924 % \end{macrocode}
3925 % \end{booleanoption}
3926 % \end{macro}
3927 % \end{layout}
3928 %
3929 % \subsubsection{The \texttt{pdfsigmargin} layout}
3930 % \begin{layout}{pdfsigmargin}
3931 % \mbox{}
3932 % \begin{macrocode}
3933 %<*fxlayoutpdfsigmargin>
3934 \NeedsTeXFormat{LaTeX2e}
3935 \FXProvidesLayout{pdfsigmargin}
3936
3937 \RequirePackage{pdfcomment}
3938
3939 % \end{macrocode}
3940 % \begin{macro}{\FXLayoutPDFSigMargin}
3941 % \marg{type}\marg{note}\marg{author}\\
3942 % Warning: this layout cannot use \cs{@fxsignature} properly, because of the
3943 % presence of an \cs{ifthenelse} inside, and that, eventough it was declared
3944 % robust. This problem seems to affect PDF layouts only. The workaround I use
3945 % below is to externalize the conditional and temporarily redefine
3946 % \cs{@fxsignature} accordingly. This is a bit clumsy but it works\ldots
3947 % \begin{macrocode}
3948 \newcommand*\FXLayoutPDFSigMargin[3]{%
3949 \begingroup%
3950 \ifthenelse{\equal{#3}{}}{%
3951 \def\@fxsignature##1{}}{%
3952 \def\@fxsignature##1{ -- {\@fxuseface{signature}#1}}}%
3953 \pdfmargincomment[author={#3}]{\@fxsigstd{#1}{#2}{#3}}%
3954 \endgroup}
3955 % \end{macrocode}
3956 % \end{macro}
3957 % \begin{macro}{\@fxlayout@pdfsigmargin}
3958 % \begin{booleanoption}{pdfsigmargin}
3959 % \begin{macrocode}
3960 \FXRegisterLayout*[margin,marginclue,marginnote,pdfmargin]{pdfsigmargin}{%
3961 \FXLayoutPDFSigMargin}
3962 %</fxlayoutpdfsigmargin>
3963 % \end{macrocode}
3964 % \end{booleanoption}
3965 % \end{macro}
3966 % \end{layout}
3967 %
3968 % \subsubsection{The \texttt{pdfcnote} layout}
3969 % \begin{layout}{pdfcnote}
3970 % \mbox{}
3971 % \begin{macrocode}
3972 %<*fxlayoutpdfcnote>
3973 \NeedsTeXFormat{LaTeX2e}
3974 \FXProvidesLayout{pdfcnote}
3975
3976 \RequirePackage{pdfcomment}
3977 \RequirePackage{xcolor}
3978
3979 % \end{macrocode}
3980 % \begin{color}{fxnote}
3981 % \begin{color}{fxwarning}
3982 % \begin{color}{fxerror}
3983 % \begin{color}{fxfatal}
3984 % Environments use the same colors as the notes themselves because
3985 % their contents really is a longer note.
3986 % \begin{macrocode}
3987 \definecolor{fxnote}{rgb}{0.0000,0.6000,0.0000}
3988 \definecolor{fxwarning}{rgb}{1.0000,0.5490,0.0000}
3989 \definecolor{fxerror}{rgb}{1.0000,0.2706,0.0000}
3990 \definecolor{fxfatal}{rgb}{1.0000,0.0000,0.0000}
3991
3992 % \end{macrocode}
3993 % \end{color}
3994 % \end{color}
3995 % \end{color}
3996 % \end{color}
3997 % \begin{macro}{\@fxdocolon}
3998 % \marg{author}\\
3999 % Add a colon after the author tag, unless empty.
4000 % \begin{macrocode}
4001 \providecommand*\@fxdocolon[1]{%
4002 \ifthenelse{\equal{#1}{}}{\def\@fxcolon{}}{\def\@fxcolon{: }}}
4003
4004 % \end{macrocode}
4005 % \end{macro}
4006 % \begin{macro}{\FXLayoutPDFCNote}
4007 % \marg{type}\marg{note}\marg{author}
4008 % \begin{macrocode}
4009 \newcommand*\FXLayoutPDFCNote[3]{%
4010 \@fxdocolon{#3}%
4011 \pdfcomment[author={#3},color={fx#1}]{\ignorespaces#3\@fxcolon#2}}
4012 % \end{macrocode}
4013 % \end{macro}
4014 % \begin{macro}{\@fxlayout@pdfcnote}
4015 % \begin{booleanoption}{pdfcnote}
4016 % \begin{macrocode}
4017 \FXRegisterLayout[pdfnote]{pdfcnote}{\FXLayoutPDFCNote}
4018 %</fxlayoutpdfcnote>
4019 % \end{macrocode}
4020 % \end{booleanoption}
4021 % \end{macro}
4022 % \end{layout}
4023 %
4024 % \subsubsection{The \texttt{pdfcmargin} layout}
4025 % \begin{layout}{pdfcmargin}
4026 % \mbox{}
4027 % \begin{macrocode}
4028 %<*fxlayoutpdfcmargin>
4029 \NeedsTeXFormat{LaTeX2e}
4030 \FXProvidesLayout{pdfcmargin}
4031
4032 \RequirePackage{pdfcomment}
4033 \RequirePackage{xcolor}
4034
4035 % \end{macrocode}
4036 % \begin{color}{fxnote}
4037 % \begin{color}{fxwarning}
4038 % \begin{color}{fxerror}
4039 % \begin{color}{fxfatal}
4040 % Environments use the same colors as the notes themselves because their
4041 % contents really is a longer note.
4042 % \begin{macrocode}
4043 \definecolor{fxnote}{rgb}{0.0000,0.6000,0.0000}
4044 \definecolor{fxwarning}{rgb}{1.0000,0.5490,0.0000}
4045 \definecolor{fxerror}{rgb}{1.0000,0.2706,0.0000}
4046 \definecolor{fxfatal}{rgb}{1.0000,0.0000,0.0000}
4047
4048 % \end{macrocode}
4049 % \end{color}
4050 % \end{color}
4051 % \end{color}
4052 % \end{color}
4053 % \begin{macro}{\@fxdocolon}
4054 % \marg{author}\\
4055 % Add a colon after the author tag, unless empty.
4056 % \begin{macrocode}
4057 \providecommand*\@fxdocolon[1]{%
4058 \ifthenelse{\equal{#1}{}}{\def\@fxcolon{}}{\def\@fxcolon{: }}}
4059
4060 % \end{macrocode}
4061 % \end{macro}
4062 % \begin{macro}{\FXLayoutPDFCMargin}
4063 % \marg{type}\marg{note}\marg{author}
4064 % \begin{macrocode}
4065 \newcommand*\FXLayoutPDFCMargin[3]{%
4066 \@fxdocolon{#3}%
4067 \pdfmargincomment[author={#3},color={fx#1}]{\ignorespaces#3\@fxcolon#2}}
4068 % \end{macrocode}
4069 % \end{macro}
4070 % \begin{macro}{\@fxlayout@pdfcmargin}
4071 % \begin{booleanoption}{pdfcmargin}
4072 % \begin{macrocode}
4073 \FXRegisterLayout*[margin,marginclue,marginnote,pdfmargin]{pdfcmargin}{%
4074 \FXLayoutPDFCMargin}
4075 %</fxlayoutpdfcmargin>
4076 % \end{macrocode}
4077 % \end{booleanoption}
4078 % \end{macro}
4079 % \end{layout}
4080 %
4081 % \subsubsection{The \texttt{pdfcsignote} layout}
4082 % \begin{layout}{pdfcsignote}
4083 % \mbox{}
4084 % \begin{macrocode}
4085 %<*fxlayoutpdfcsignote>
4086 \NeedsTeXFormat{LaTeX2e}
4087 \FXProvidesLayout{pdfcsignote}
4088
4089 \RequirePackage{pdfcomment}
4090 \RequirePackage{xcolor}
4091
4092 % \end{macrocode}
4093 % \begin{color}{fxnote}
4094 % \begin{color}{fxwarning}
4095 % \begin{color}{fxerror}
4096 % \begin{color}{fxfatal}
4097 % Environments use the same colors as the notes themselves because their
4098 % contents really is a longer note.
4099 % \begin{macrocode}
4100 \definecolor{fxnote}{rgb}{0.0000,0.6000,0.0000}
4101 \definecolor{fxwarning}{rgb}{1.0000,0.5490,0.0000}
4102 \definecolor{fxerror}{rgb}{1.0000,0.2706,0.0000}
4103 \definecolor{fxfatal}{rgb}{1.0000,0.0000,0.0000}
4104
4105 % \end{macrocode}
4106 % \end{color}
4107 % \end{color}
4108 % \end{color}
4109 % \end{color}
4110 % \begin{macro}{\FXLayoutPDFCSigNote}
4111 % \marg{type}\marg{note}\marg{author}
4112 % \begin{macrocode}
4113 \newcommand*\FXLayoutPDFCSigNote[3]{%
4114 \pdfcomment[author={#3},color={fx#1}]{#2\@fxsignature{#3}}}
4115 % \end{macrocode}
4116 % \end{macro}
4117 % \begin{macro}{\@fxlayout@pdfcsignote}
4118 % \begin{booleanoption}{pdfcsignote}
4119 % \begin{macrocode}
4120 \FXRegisterLayout[pdfnote,pdfcnote]{pdfcsignote}{\FXLayoutPDFCSigNote}
4121 %</fxlayoutpdfcsignote>
4122 % \end{macrocode}
4123 % \end{booleanoption}
4124 % \end{macro}
4125 % \end{layout}
4126 %
4127 % \subsubsection{The \texttt{pdfcsigmargin} layout}
4128 % \begin{layout}{pdfcsigmargin}
4129 % \mbox{}
4130 % \begin{macrocode}
4131 %<*fxlayoutpdfcsigmargin>
4132 \NeedsTeXFormat{LaTeX2e}
4133 \FXProvidesLayout{pdfcsigmargin}
4134
4135 \RequirePackage{pdfcomment}
4136 \RequirePackage{xcolor}
4137
4138 % \end{macrocode}
4139 % \begin{color}{fxnote}
4140 % \begin{color}{fxwarning}
4141 % \begin{color}{fxerror}
4142 % \begin{color}{fxfatal}
4143 % Environments use the same colors as the notes themselves because their
4144 % contents really is a longer note.
4145 % \begin{macrocode}
4146 \definecolor{fxnote}{rgb}{0.0000,0.6000,0.0000}
4147 \definecolor{fxwarning}{rgb}{1.0000,0.5490,0.0000}
4148 \definecolor{fxerror}{rgb}{1.0000,0.2706,0.0000}
4149 \definecolor{fxfatal}{rgb}{1.0000,0.0000,0.0000}
4150
4151 % \end{macrocode}
4152 % \end{color}
4153 % \end{color}
4154 % \end{color}
4155 % \end{color}
4156 % \begin{macro}{\FXLayoutPDFCSigMargin}
4157 % \marg{type}\marg{note}\marg{author}
4158 % \begin{macrocode}
4159 \newcommand*\FXLayoutPDFCSigMargin[3]{%
4160 \pdfmargincomment[author={#3},color={fx#1}]{#2\@fxsignature{#3}}}
4161 % \end{macrocode}
4162 % \end{macro}
4163 % \begin{macro}{\@fxlayout@pdfcsigmargin}
4164 % \begin{booleanoption}{pdfcsigmargin}
4165 % \begin{macrocode}
4166 \FXRegisterLayout*[margin,marginclue,marginnote,pdfmargin,pdfsigmargin]{%
4167 pdfcsigmargin}{%
4168 \FXLayoutPDFCSigMargin}
4169 %</fxlayoutpdfcsigmargin>
4170 % \end{macrocode}
4171 % \end{booleanoption}
4172 % \end{macro}
4173 % \end{layout}
4174 %
4175 % \subsection{Environment layouts}
4176 % \subsubsection{The \texttt{color} layout}
4177 % \begin{envlayout}{color}
4178 % \mbox{}
4179 % \begin{macrocode}
4180 %<*fxenvlayoutcolor>
4181 \NeedsTeXFormat{LaTeX2e}
4182 \FXProvidesEnvLayout{color}
4183
4184 \RequirePackage{color}
4185
4186 % \end{macrocode}
4187 % \begin{macro}{\@fxdocolon}
4188 % \marg{author}\\
4189 % Add a colon after the author tag, unless empty.
4190 % \begin{macrocode}
4191 \providecommand*\@fxdocolon[1]{%
4192 \ifthenelse{\equal{#1}{}}{\def\@fxcolon{}}{\def\@fxcolon{: }}}
4193
4194 % \end{macrocode}
4195 % \end{macro}
4196 % \begin{color}{fxnote}
4197 % \begin{color}{fxwarning}
4198 % \begin{color}{fxerror}
4199 % \begin{color}{fxfatal}
4200 % Environments use the same colors as the notes themselves because their
4201 % contents really is a longer note.
4202 % \begin{macrocode}
4203 \definecolor{fxnote}{rgb}{0.0000,0.6000,0.0000}
4204 \definecolor{fxwarning}{rgb}{1.0000,0.5490,0.0000}
4205 \definecolor{fxerror}{rgb}{1.0000,0.2706,0.0000}
4206 \definecolor{fxfatal}{rgb}{1.0000,0.0000,0.0000}
4207
4208 \fxsetface{env}{}
4209
4210 % \end{macrocode}
4211 % \end{color}
4212 % \end{color}
4213 % \end{color}
4214 % \end{color}
4215 % \begin{macro}{\FXEnvLayoutColorBegin}
4216 % \begin{macro}{\FXEnvLayoutColorEnd}
4217 % \marg{type}\marg{author}
4218 % \begin{macrocode}
4219 \newcommand*\FXEnvLayoutColorBegin[2]{%
4220 \@fxdocolon{#2}%
4221 \@fxuseface{env}\color{fx#1}\ignorespaces#2\@fxcolon\ignorespaces}
4222 \newcommand*\FXEnvLayoutColorEnd[2]{}
4223 % \end{macrocode}
4224 % \end{macro}
4225 % \end{macro}
4226 % \begin{macro}{\@fxenvlayout@color@begin}
4227 % \begin{macro}{\@fxenvlayout@color@end}
4228 % \begin{macrocode}
4229 \FXRegisterEnvLayout{color}{\FXEnvLayoutColorBegin}{\FXEnvLayoutColorEnd}
4230 %</fxenvlayoutcolor>
4231 % \end{macrocode}
4232 % \end{macro}
4233 % \end{macro}
4234 % \end{envlayout}
4235 %
4236 % \subsubsection{The \texttt{colorsig} layout}
4237 % \begin{envlayout}{colorsig}
4238 % \mbox{}
4239 % \begin{macrocode}
4240 %<*fxenvlayoutcolorsig>
4241 \NeedsTeXFormat{LaTeX2e}
4242 \FXProvidesEnvLayout{colorsig}
4243
4244 \RequirePackage{color}
4245
4246 % \end{macrocode}
4247 % \begin{face}{signature}
4248 % \mbox{}
4249 % \begin{macrocode}
4250 \@fxnewface[\itshape]{signature}
4251 % \end{macrocode}
4252 % \end{face}
4253 % \begin{color}{fxnote}
4254 % \begin{color}{fxwarning}
4255 % \begin{color}{fxerror}
4256 % \begin{color}{fxfatal}
4257 % Environments use the same colors as the notes themselves because their
4258 % contents really is a longer note.
4259 % \begin{macrocode}
4260 \definecolor{fxnote}{rgb}{0.0000,0.6000,0.0000}
4261 \definecolor{fxwarning}{rgb}{1.0000,0.5490,0.0000}
4262 \definecolor{fxerror}{rgb}{1.0000,0.2706,0.0000}
4263 \definecolor{fxfatal}{rgb}{1.0000,0.0000,0.0000}
4264
4265 \fxsetface{env}{}
4266
4267 % \end{macrocode}
4268 % \end{color}
4269 % \end{color}
4270 % \end{color}
4271 % \end{color}
4272 % \begin{macro}{\FXEnvLayoutColorSigBegin}
4273 % \begin{macro}{\FXEnvLayoutColorSigEnd}
4274 % \marg{type}\marg{author}
4275 % \begin{macrocode}
4276 \newcommand*\FXEnvLayoutColorSigBegin[2]{\@fxuseface{env}\color{fx#1}}
4277 \newcommand*\FXEnvLayoutColorSigEnd[2]{\@fxsignature{#2}}
4278 % \end{macrocode}
4279 % \end{macro}
4280 % \end{macro}
4281 % \begin{macro}{\@fxenvlayout@colorsig@begin}
4282 % \begin{macro}{\@fxenvlayout@colorsig@end}
4283 % \begin{macrocode}
4284 \FXRegisterEnvLayout{colorsig}{%
4285 \FXEnvLayoutColorSigBegin}{\FXEnvLayoutColorSigEnd}
4286 %</fxenvlayoutcolorsig>
4287 % \end{macrocode}
4288 % \end{macro}
4289 % \end{macro}
4290 % \end{envlayout}
4291 %
4292 % \subsection{Target Layouts}
4293 % Since target layouts don't include author information, they're orthogonal to
4294 % (and hence usable in) prefix/signature display.
4295 %
4296 % \subsubsection{The \texttt{changebar} layout}
4297 % \begin{targetlayout}{changebar}
4298 % \mbox{}
4299 % \begin{macrocode}
4300 %<*fxtargetlayoutchangebar>
4301 \NeedsTeXFormat{LaTeX2e}
4302 \FXProvidesTargetLayout{changebar}
4303
4304 \RequirePackage{changebar}
4305 \setlength{\changebarsep}{5pt}
4306
4307 \fxsetface{target}{}
4308 % \end{macrocode}
4309 % \begin{macro}{\FXTargetLayoutChangeBar}
4310 % \marg{target}
4311 % \begin{macrocode}
4312 \newcommand\FXTargetLayoutChangeBar[2]{\cbstart\@fxuseface{target}#2\cbend}
4313 % \end{macrocode}
4314 % \end{macro}
4315 % \begin{macro}{\@fxtargetlayout@changebar}
4316 % \begin{macrocode}
4317 \FXRegisterTargetLayout{changebar}{\FXTargetLayoutChangeBar}
4318 %</fxtargetlayoutchangebar>
4319 % \end{macrocode}
4320 % \end{macro}
4321 % \end{targetlayout}
4322 %
4323 % \subsubsection{The \texttt{color} layout}
4324 % \begin{targetlayout}{color}
4325 % \mbox{}
4326 % \begin{macrocode}
4327 %<*fxtargetlayoutcolor>
4328 \NeedsTeXFormat{LaTeX2e}
4329 \FXProvidesTargetLayout{color}
4330
4331 \RequirePackage{color}
4332 \definecolor{fxnote}{rgb}{0.0000,0.6000,0.0000}
4333 \definecolor{fxwarning}{rgb}{1.0000,0.5490,0.0000}
4334 \definecolor{fxerror}{rgb}{1.0000,0.2706,0.0000}
4335 \definecolor{fxfatal}{rgb}{1.0000,0.0000,0.0000}
4336
4337 % \end{macrocode}
4338 % \begin{color}{fxtarget}
4339 % \mbox{}
4340 % \begin{macrocode}
4341 \definecolor{fxtarget}{rgb}{0.3725,0.6196,0.6275}
4342
4343 \fxsetface{target}{}
4344
4345 % \end{macrocode}
4346 % \end{color}
4347 % \begin{macro}{\FXTargetLayoutColor}
4348 % \marg{target}
4349 % \begin{macrocode}
4350 \newcommand\FXTargetLayoutColor[2]{\@fxuseface{target}\color{fxtarget}#2}
4351 % \end{macrocode}
4352 % \end{macro}
4353 % \begin{macro}{\@fxtargetlayout@color}
4354 % \begin{macrocode}
4355 \FXRegisterTargetLayout{color}{\FXTargetLayoutColor}
4356 %</fxtargetlayoutcolor>
4357 % \end{macrocode}
4358 % \end{macro}
4359 % \end{targetlayout}
4360 %
4361 % \subsubsection{The \texttt{colorcb} layout}
4362 % \begin{targetlayout}{colorcb}
4363 % \mbox{}
4364 % \begin{macrocode}
4365 %<*fxtargetlayoutcolorcb>
4366 \NeedsTeXFormat{LaTeX2e}
4367 \FXProvidesTargetLayout{colorcb}
4368
4369 \RequirePackage{color}
4370
4371 \RequirePackage[color]{changebar}
4372 \setlength{\changebarsep}{5pt}
4373
4374 \fxsetface{target}{}
4375 % \end{macrocode}
4376 % \begin{macro}{\FXTargetLayoutColorCB}
4377 % \marg{target}
4378 % \begin{macrocode}
4379 \newcommand\FXTargetLayoutColorCB[2]{%
4380 \cbstart\cbcolor{fx#1}\@fxuseface{target}#2\cbend}
4381 % \end{macrocode}
4382 % \end{macro}
4383 % \begin{macro}{\@fxtargetlayout@colorcb}
4384 % \begin{macrocode}
4385 \FXRegisterTargetLayout{colorcb}{\FXTargetLayoutColorCB}
4386 %</fxtargetlayoutcolorcb>
4387 % \end{macrocode}
4388 % \end{macro}
4389 % \end{targetlayout}
4390 %
4391 % \section{Themes}
4392 % \subsection{The \texttt{signature} theme}
4393 % \begin{theme}{signature}
4394 % \mbox{}
4395 % \begin{macrocode}
4396 %<*fxthemesignature>
4397 \NeedsTeXFormat{LaTeX2e}
4398 \FXProvidesTheme{signature}
4399
4400 \fxuseenvlayout{signature}
4401
4402 \renewcommand*\FXLayoutFootnote[3]{\footnote{\@fxsigstd{#1}{#2}{#3}}}
4403 \renewcommand*\FXLayoutMargin[3]{%
4404 \marginpar[{\raggedleft\@fxuseface{margin}\@fxsigstd{#1}{#2}{#3}}]{%
4405 \raggedright\@fxuseface{margin}\@fxsigstd{#1}{#2}{#3}}}
4406 \renewcommand*\FXLayoutMarginClue[3]{%
4407 \marginpar[{\raggedleft\@fxuseface{margin}\fxnotename{#1}!\@fxsignature{#3}}]{%
4408 \raggedright\@fxuseface{margin}\fxnotename{#1}!\@fxsignature{#3}}}
4409 \renewcommand*\FXLayoutInline[3]{{ \@fxuseface{inline}\@fxsigstd{#1}{#2}{#3}}}
4410 \renewcommand*\FXLayoutIndex[3]{%
4411 \iffx@mode@multiuser%
4412 \index{***@\fixmeindexname:%
4413 !\@nameuse{@fx#1key}@\fxnotesname{#1}:%
4414 !\@nameuse{thefx#1count}: #2\@fxsignature{#3}}%
4415 \index{***#3@\fixmeindexname{} (#3):%
4416 !\@nameuse{@fx#1key}@\fxnotesname{#1}:%
4417 !\@nameuse{thefx#1count}: #2}%
4418 \else%
4419 \index{***@\fixmeindexname:%
4420 !\@nameuse{@fx#1key}@\fxnotesname{#1}:%
4421 !\@nameuse{thefx#1count}: #2}%
4422 \fi}
4423 \renewcommand*\FXLayoutContentsLine[3]{%
4424 \iffx@mode@multiuser%
4425 \fxaddcontentsline{\@fxsigstd{#1}{#2}{#3}}%
4426 \else%
4427 \fxaddcontentsline{\fxnotename{#1}: #2}%
4428 \fi}
4429 %</fxthemesignature>
4430 % \end{macrocode}
4431 % \end{theme}
4432 %
4433 % \subsection{The \texttt{color} theme}
4434 % \begin{theme}{color}
4435 % \mbox{}
4436 % \begin{macrocode}
4437 %<*fxthemecolor>
4438 \NeedsTeXFormat{LaTeX2e}
4439 \FXProvidesTheme{color}
4440
4441 \RequirePackage{color}
4442
4443 \FXRequireEnvLayout{color}
4444 \FXRequireTargetLayout{color}
4445
4446 \fxsetface{inline}{}
4447
4448 \renewcommand*\FXLayoutFootnote[3]{%
4449 \@fxdocolon{#3}%
4450 \footnote{\color{fx#1}\ignorespaces#3\@fxcolon#2}}
4451 \renewcommand*\FXLayoutMargin[3]{%
4452 \@fxdocolon{#3}%
4453 \marginpar[%
4454 {\raggedleft\@fxuseface{margin}\color{fx#1}\ignorespaces#3\@fxcolon#2}]{%
4455 \raggedright\@fxuseface{margin}\color{fx#1}\ignorespaces#3\@fxcolon#2}}
4456 \renewcommand*\FXLayoutMarginClue[3]{%
4457 \marginpar[{\raggedleft\@fxuseface{margin}\color{fx#1}\ignorespaces#3!}]{%
4458 \raggedright\@fxuseface{margin}\color{fx#1}\ignorespaces#3!}}
4459 \renewcommand*\FXLayoutInline[3]{%
4460 \@fxdocolon{#3}%
4461 { \textcolor{fx#1}{\@fxuseface{inline}\ignorespaces#3\@fxcolon#2}}}
4462 \renewcommand*\FXLayoutIndex[3]{%
4463 \iffx@mode@multiuser%
4464 \index{***@\fixmeindexname:%
4465 !\@nameuse{@fx#1key}@\fxnotesname{#1}:%
4466 !{\color{fx#1}\@nameuse{thefx#1count}: #3: #2}}%
4467 \index{***#3@\fixmeindexname{} (#3):%
4468 !\@nameuse{@fx#1key}@\fxnotesname{#1}:%
4469 !{\color{fx#1}\@nameuse{thefx#1count}: #2}}%
4470 \else%
4471 \index{***@\fixmeindexname:%
4472 !\@nameuse{@fx#1key}@\fxnotesname{#1}:%
4473 !{\color{fx#1}\@nameuse{thefx#1count}: #2}}%
4474 \fi}
4475
4476 \renewcommand*\FXLayoutContentsLine[3]{%
4477 \@fxdocolon{#3}%
4478 \iffx@mode@multiuser%
4479 \fxaddcontentsline{\color{fx#1}\ignorespaces#3\@fxcolon#2}%
4480 \else%
4481 \fxaddcontentsline{\color{fx#1}#2}%
4482 \fi}
4483 %</fxthemecolor>
4484 % \end{macrocode}
4485 % \end{theme}
4486 %
4487 % \subsection{The \texttt{colorsig} theme}
4488 % \begin{theme}{colorsig}
4489 % \begin{macrocode}
4490 %<*fxthemecolorsig>
4491 \NeedsTeXFormat{LaTeX2e}
4492 \FXProvidesTheme{colorsig}
4493
4494 \RequirePackage{color}
4495
4496 \FXRequireEnvLayout{colorsig}
4497 \FXRequireTargetLayout{color}
4498
4499 \fxsetface{inline}{}
4500
4501 \renewcommand*\FXLayoutFootnote[3]{\footnote{\color{fx#1}#2\@fxsignature{#3}}}
4502 \renewcommand*\FXLayoutMargin[3]{%
4503 \marginpar[{\raggedleft\@fxuseface{margin}\color{fx#1}#2\@fxsignature{#3}}]{%
4504 \raggedright\@fxuseface{margin}\color{fx#1}#2\@fxsignature{#3}}}
4505 \renewcommand*\FXLayoutMarginClue[3]{%
4506 \marginpar[{\raggedleft\@fxuseface{margin}\color{fx#1}!\@fxsignature{#3}}]{%
4507 \raggedright\@fxuseface{margin}\color{fx#1}!\@fxsignature{#3}}}
4508 \renewcommand*\FXLayoutInline[3]{%
4509 { \textcolor{fx#1}{\@fxuseface{inline}#2\@fxsignature{#3}}}}
4510 \renewcommand*\FXLayoutIndex[3]{%
4511 \iffx@mode@multiuser%
4512 \index{***@\fixmeindexname:%
4513 !\@nameuse{@fx#1key}@\fxnotesname{#1}:%
4514 !{\color{fx#1}\@nameuse{thefx#1count}: #2\@fxsignature{#3}}}%
4515 \index{***#3@\fixmeindexname{} (#3):%
4516 !\@nameuse{@fx#1key}@\fxnotesname{#1}:%
4517 !{\color{fx#1}\@nameuse{thefx#1count}: #2}}%
4518 \else%
4519 \index{***@\fixmeindexname:%
4520 !\@nameuse{@fx#1key}@\fxnotesname{#1}:%
4521 !{\color{fx#1}\@nameuse{thefx#1count}: #2}}%
4522 \fi}
4523 \renewcommand*\FXLayoutContentsLine[3]{%
4524 \iffx@mode@multiuser%
4525 \fxaddcontentsline{\color{fx#1}#2\@fxsignature{#3}}%
4526 \else%
4527 \fxaddcontentsline{\color{fx#1}#2}%
4528 \fi}
4529 %</fxthemecolorsig>
4530 % \end{macrocode}
4531 % \end{theme}
4532 %
4533 % ^^A \PrintChanges
4534 % ^^A Nobody messes up with the marks in this document, but \index@prologue.
4535 % ^^A That sucks.
4536 % \makeatletter{\let\markboth\@gobbletwo\PrintIndex}\makeatother
4537 % \Finale
4538 %
4539 % ^^A Local variables:
4540 % ^^A eval : (add-hook 'TeX-update-style-hook (lambda () (doxitems "option" "counter" "lang" "cond" "face" "color" "theme")) nil t)
4541 % ^^A eval: (add-hook 'TeX-update-style-hook (lambda () (doxitem "\\(env\\|target\\)?layout")) nil t)
4542 % ^^A End:
4543 % ^^A fixme.dtx ends here.