diff options
Diffstat (limited to 'Master/texmf-dist/doc/support/arara/chapters/rules.tex')
-rw-r--r-- | Master/texmf-dist/doc/support/arara/chapters/rules.tex | 27 |
1 files changed, 26 insertions, 1 deletions
diff --git a/Master/texmf-dist/doc/support/arara/chapters/rules.tex b/Master/texmf-dist/doc/support/arara/chapters/rules.tex index ace21a6fad5..39552b40cab 100644 --- a/Master/texmf-dist/doc/support/arara/chapters/rules.tex +++ b/Master/texmf-dist/doc/support/arara/chapters/rules.tex @@ -36,7 +36,7 @@ The best solution to avoid possible future name conflicts, according to the Imag \end{codebox} \item[\rulebox{asymptote}] -This rule executes the \rbox{asy} command line, referring to Asymptote, a powerful descriptive vector graphics language for technical drawings, inspired by Metapost but with an improved syntax. Please note that you will have to make the \rbox{.asy} extension known to \arara\ in order to compile Asymptote files. Furthermore, it is advised to use this in your regular \TeX\ document specifying the \abox{files} parameter to include all graphics you want to compile for inclusion in your document. +This rule executes the \rbox{asy} command line program, referring to Asymptote, a powerful descriptive vector graphics language for technical drawings, inspired by Metapost but with an improved syntax. Please note that you will have to make the \rbox{.asy} extension known to \arara\ in order to compile Asymptote files. Furthermore, it is advised to use this in your regular \TeX\ document specifying the \abox{files} parameter to include all graphics you want to compile for inclusion in your document. \begin{description} \item[\abox{color}] This option, as the name suggests, provides the underlying color model to be used in the current execution. Possible values are: @@ -78,12 +78,37 @@ This rule executes the \rbox{asy} command line, referring to Asymptote, a powerf \item[\abox{output}] This option, as the name suggests, sets an alternative output directory or file name. Make sure to take a look at the Asymptote manual for further details. \item[\abox{options}] This option, as the name indicates, takes a list of raw command line options and appends it to the actual system call. An error is thrown if any data structure other than a proper list is provided as the value. +\end{description} \begin{codebox}{Example}{teal}{\icnote}{white} % arara: asymptote: { files: [ mydrawing.asy ] } \end{codebox} + +\item[\rulebox{authorindex}] +This rule calls the \rbox{authorindex} wrapper, a Perl script that processes auxiliary files generated by the package of the same name, producing author index files, with the \rbox{ain} extension. + +\begin{description} +\item[\rpsbox{draft}] This option sets whether the script should write additional information to the produced file. For each author, the +labels of all references and the page numbers where they are cited are included as comments. This detail may help if you manually edit the generated author index. + +\item[\rpsbox{index}] This option sets whether the script should create a file suitable for further processing with \rbox{makeindex} or +the like. For example, you could use that to make a common author and subject index. Note the extension of the generated file still will be the default one. + +\item[\rpsbox{keep}] This option sets whether the script should retain the temporarily generated \rbox{bst} file after the run finishes. This information will give you a good starting point for advanced customization of the author index. + +\item[\rpsbox{print}] This option, as the name indicates, sets whether the script should print the result to standard output instead of writing it to the output file. + +\item[\rpsbox{recurse}] This option sets whether the script should automatically process auxiliary files produced by included files. This behaviour is enabled by default. + +\item[\abox{options}] This option, as the name indicates, takes a list of raw command line options and appends it to the actual system call. An error is thrown if any data structure other than a proper list is provided as the value. \end{description} +\begin{codebox}{Example}{teal}{\icnote}{white} +% arara: authorindex: { draft: yes } +\end{codebox} + + + \item[\rulebox{bib2gls}] This rule executes the \rbox{bib2gls} command line application which extracts glossary information stored in a \rbox{bib} file and converts it into glossary entry definitions in resource files. This rule passes the base name of the \mtbox{currentFile} reference (i.e, the name without the associated extension) as the mandatory argument. |