summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/support/arara
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2019-09-16 22:06:50 +0000
committerKarl Berry <karl@freefriends.org>2019-09-16 22:06:50 +0000
commit2df6cdd1319db65426bc5b1d645c0fe8d7759528 (patch)
tree53c6c47246bebb29c74e37ffc5bc98f2791e22b1 /Master/texmf-dist/doc/support/arara
parent7372400fb86d4bd41833af4d447d68f04a8c60d9 (diff)
arara (16sep19)
git-svn-id: svn://tug.org/texlive/trunk@52106 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/support/arara')
-rw-r--r--Master/texmf-dist/doc/support/arara/README.md6
-rw-r--r--Master/texmf-dist/doc/support/arara/arara-manual.pdfbin1838719 -> 1840860 bytes
-rw-r--r--Master/texmf-dist/doc/support/arara/chapters/methods.tex6
3 files changed, 9 insertions, 3 deletions
diff --git a/Master/texmf-dist/doc/support/arara/README.md b/Master/texmf-dist/doc/support/arara/README.md
index d65679d4ba0..dc4cc359eea 100644
--- a/Master/texmf-dist/doc/support/arara/README.md
+++ b/Master/texmf-dist/doc/support/arara/README.md
@@ -3,11 +3,11 @@
# arara
![Version: 4.0](https://img.shields.io/badge/current_version-4.0-blue.svg?style=flat-square)
-![Revision: 1](https://img.shields.io/badge/revision-1-blue.svg?style=flat-square)
+![Revision: 2](https://img.shields.io/badge/revision-2-blue.svg?style=flat-square)
![Language: Java](https://img.shields.io/badge/language-Java-blue.svg?style=flat-square)
![Minimum JRE: 5.0](https://img.shields.io/badge/minimum_JRE-5.0-blue.svg?style=flat-square)
[![License: New BSD](https://img.shields.io/badge/license-New_BSD-blue.svg?style=flat-square)](https://opensource.org/licenses/bsd-license)
-![CTAN packaging: 4.0.6](https://img.shields.io/badge/CTAN_packaging-4.0.6-blue.svg?style=flat-square)
+![CTAN packaging: 4.0.7](https://img.shields.io/badge/CTAN_packaging-4.0.7-blue.svg?style=flat-square)
`arara` is a TeX automation tool based on rules and directives. It gives you a way to enhance your TeX experience. The tool is an effort to provide a concise way to automate the daily TeX workflow for users and also package writers. Users might write their own rules when the provided ones do not suffice.
@@ -30,7 +30,7 @@ Now when you run `arara myfile`, that directive (`% arara: ...`) will be seen an
![Current version: 4.0](https://img.shields.io/badge/current_version-4.0-blue.svg?style=flat-square)
![Development version: 5.0](https://img.shields.io/badge/development_version-5.0-red.svg?style=flat-square)
-The stable major version of `arara` is the 4.0 series (note that revision numbers may vary). Please refer to the development branch for more information on the upcoming 5.0 series release. The master branch always refers to the stable version (including potential revisions). The CTAN packaging for the current version is 4.0.6 (for internal use).
+The stable major version of `arara` is the 4.0 series (note that revision numbers may vary). Please refer to the development branch for more information on the upcoming 5.0 series release. The master branch always refers to the stable version (including potential revisions). The CTAN packaging for the current version is 4.0.7 (for internal use).
For historical purposes, the source code for older versions of `arara` is available in the [releases](https://github.com/cereda/arara/releases) section of our repository. However, be mindful that these versions are unsupported.
diff --git a/Master/texmf-dist/doc/support/arara/arara-manual.pdf b/Master/texmf-dist/doc/support/arara/arara-manual.pdf
index ef749492084..bb3f7be9538 100644
--- a/Master/texmf-dist/doc/support/arara/arara-manual.pdf
+++ b/Master/texmf-dist/doc/support/arara/arara-manual.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/support/arara/chapters/methods.tex b/Master/texmf-dist/doc/support/arara/chapters/methods.tex
index 4570e01c7fc..b8cca6a5f3f 100644
--- a/Master/texmf-dist/doc/support/arara/chapters/methods.tex
+++ b/Master/texmf-dist/doc/support/arara/chapters/methods.tex
@@ -1037,6 +1037,12 @@ result = unsafelyExecuteSystemCommand(getCommand('ls'));
Please \emph{do not abuse} this method! Keep in mind that this particular feature is included for very specific scenarios in which the command streams are needed ahead of time for proper decision making.
\end{messagebox}
+\item[\mdbox{R}{isSubdirectory(File directory)}{boolean}] This method checks whether the provided \rbox{File} reference is a valid subdirectory under the project hierarchy, return a corresponding boolean value. This is a check to impose a possible restriction in the rule scope, so that users can change down to subdirectories in their projects but not up, outside of the root directory.
+
+\begin{codebox}{Example}{teal}{\icnote}{white}
+valid = isSubdirectory(toFile('chapters/'));
+\end{codebox}
+
\item[\mdbox{R}{\parbox{0.62\textwidth}{mergeVelocityTemplate(File input, File output,\\\hspace*{1em} Map<String, Object> map)}}{void}] This method, as the name implies, merges the provided \rbox{File} template reference written in the Velocity Template Language 1.7 specification with the \rbox{Map} data object in order to produce a corresponding \rbox{File} output. It is important to observe that this method will raise an exception if the provided input file does not exist or if there is an error with the underlying template language.
\begin{ncodebox}{Source file}{teal}{\icnote}{white}{input.txt}