summaryrefslogtreecommitdiff
path: root/support
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2020-04-24 03:03:14 +0000
committerNorbert Preining <norbert@preining.info>2020-04-24 03:03:14 +0000
commit18510c8052e3e5b3d9a373c6418289f70d0fc28d (patch)
treebe7605a3002eaf737fb2c748068ac9e720739a1a /support
parentb86f6f3256611ce04f593d897b9cf412d18fa062 (diff)
CTAN sync 202004240303
Diffstat (limited to 'support')
-rw-r--r--support/arara/README.md2
-rw-r--r--support/arara/doc/arara-manual.pdfbin1882028 -> 1890625 bytes
-rw-r--r--support/arara/doc/arara-manual.tex2
-rw-r--r--support/arara/doc/chapters/rules.tex27
-rw-r--r--support/arara/scripts/rules/authorindex.yaml53
5 files changed, 81 insertions, 3 deletions
diff --git a/support/arara/README.md b/support/arara/README.md
index 5c6b8dc2e1..9adb41b255 100644
--- a/support/arara/README.md
+++ b/support/arara/README.md
@@ -1,6 +1,6 @@
![arara](https://i.stack.imgur.com/hjUsN.png)
-# arara v5.1.2
+# arara v5.1.3
![Language: Kotlin](https://img.shields.io/badge/Language-Kotlin-blue.svg?style=flat-square)
![Minimum JRE: 8.0](https://img.shields.io/badge/Minimum_JRE-8-blue.svg?style=flat-square)
diff --git a/support/arara/doc/arara-manual.pdf b/support/arara/doc/arara-manual.pdf
index d6ce4e47fe..ed5a6b0eaa 100644
--- a/support/arara/doc/arara-manual.pdf
+++ b/support/arara/doc/arara-manual.pdf
Binary files differ
diff --git a/support/arara/doc/arara-manual.tex b/support/arara/doc/arara-manual.tex
index b93e2a10e6..196d1ce7a4 100644
--- a/support/arara/doc/arara-manual.tex
+++ b/support/arara/doc/arara-manual.tex
@@ -42,7 +42,7 @@
\usepackage[margin=2.5cm]{geometry}
\usepackage{arara}
-\newcommand{\araraversion}{5.1.2}
+\newcommand{\araraversion}{5.1.3}
\begin{document}
diff --git a/support/arara/doc/chapters/rules.tex b/support/arara/doc/chapters/rules.tex
index ace21a6fad..39552b40ca 100644
--- a/support/arara/doc/chapters/rules.tex
+++ b/support/arara/doc/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.
diff --git a/support/arara/scripts/rules/authorindex.yaml b/support/arara/scripts/rules/authorindex.yaml
new file mode 100644
index 0000000000..a7e32141a9
--- /dev/null
+++ b/support/arara/scripts/rules/authorindex.yaml
@@ -0,0 +1,53 @@
+!config
+# Arara, the cool TeX automation tool
+# Copyright (c) 2020, Island of TeX
+# All rights reserved.
+#
+# This rule is part of arara.
+identifier: authorindex
+name: AuthorIndex
+authors:
+- Island of TeX
+commands:
+- name: The AuthorIndex script
+ command: >
+ @{
+ return getCommand('authorindex', draft, index, keep, print,
+ recurse, options, getBasename(reference.getName()));
+ }
+arguments:
+- identifier: draft
+ flag: >
+ @{
+ return isTrue(parameters.draft, '-d');
+ }
+- identifier: index
+ flag: >
+ @{
+ return isTrue(parameters.index, '-i');
+ }
+- identifier: keep
+ flag: >
+ @{
+ return isTrue(parameters.keep, '-k');
+ }
+- identifier: print
+ flag: >
+ @{
+ return isTrue(parameters.print, '-p');
+ }
+- identifier: recurse
+ flag: >
+ @{
+ return isFalse(parameters.recurse, '-r');
+ }
+- identifier: options
+ flag: >
+ @{
+ if (isList(parameters.options)) {
+ return parameters.options;
+ }
+ else {
+ throwError('I was expecting a list of options.');
+ }
+ }