summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/support/arara/arara-manual.tex
blob: c46b529f0fc6b3f59327e938952775cd733556a8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
% arara: manual

% Arara, the cool TeX automation tool
% Copyright (c) 2012 -- 2018, Paulo Roberto Massa Cereda
% All rights reserved.
%
% Redistribution and  use in source  and binary forms, with  or without
% modification, are  permitted provided  that the  following conditions
% are met:
%
% 1. Redistributions  of source  code must  retain the  above copyright
% notice, this list of conditions and the following disclaimer.
%
% 2. Redistributions in binary form  must reproduce the above copyright
% notice, this list  of conditions and the following  disclaimer in the
% documentation and/or other materials provided with the distribution.
%
% 3. Neither  the name  of the  project's author nor  the names  of its
% contributors may be used to  endorse or promote products derived from
% this software without specific prior written permission.
%
% THIS SOFTWARE IS  PROVIDED BY THE COPYRIGHT  HOLDERS AND CONTRIBUTORS
% "AS IS"  AND ANY  EXPRESS OR IMPLIED  WARRANTIES, INCLUDING,  BUT NOT
% LIMITED  TO, THE  IMPLIED WARRANTIES  OF MERCHANTABILITY  AND FITNESS
% FOR  A PARTICULAR  PURPOSE  ARE  DISCLAIMED. IN  NO  EVENT SHALL  THE
% COPYRIGHT HOLDER OR CONTRIBUTORS BE  LIABLE FOR ANY DIRECT, INDIRECT,
% INCIDENTAL, SPECIAL, EXEMPLARY,  OR CONSEQUENTIAL DAMAGES (INCLUDING,
% BUT  NOT LIMITED  TO, PROCUREMENT  OF SUBSTITUTE  GOODS OR  SERVICES;
% LOSS  OF USE,  DATA, OR  PROFITS; OR  BUSINESS INTERRUPTION)  HOWEVER
% CAUSED AND  ON ANY THEORY  OF LIABILITY, WHETHER IN  CONTRACT, STRICT
% LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
% WAY  OUT  OF  THE USE  OF  THIS  SOFTWARE,  EVEN  IF ADVISED  OF  THE
% POSSIBILITY OF SUCH DAMAGE.
\documentclass[a4paper,oneside,12pt]{memoir}

\usepackage[T1]{fontenc}
\usepackage[utf8]{inputenc}
\usepackage[margin=2.5cm]{geometry}
\usepackage{arara}
\usepackage[record,postpunc=dot]{glossaries-extra}

\newcommand{\araraversion}{4.0}

\glssetcategoryattribute{abbreviation}{glossdesc}{firstuc}
\glssetcategoryattribute{general}{glossname}{firstuc}
\glssetcategoryattribute{general}{glossdesc}{firstuc}

\setabbreviationstyle{short-nolong-desc}
\renewcommand{\glsxtrshortdescname}{%
 \protect\glsabbrvfont{\the\glsshorttok} (\the\glslongtok)%
}

 \newabbreviation
 [description={an interface that allows users to interact
through graphical components, such as buttons and menus}]
 {GUI}{GUI}{Graphical User Interface}

 \newabbreviation
 [description={an organisation that develops and promotes Internet standards}]
 {IETF}{IETF}{Internet Engineering Task Force}

 \newabbreviation
 [description={a virtual machine that enables Java programs to be run}]
 {JVM}{JVM}{Java Virtual Machine}

 \newabbreviation
 [description={a hybrid, dynamic, statically typed, embeddable
 expression language and runtime for the Java platform},
 location={(See Chapter~\ref{chap:mvel}.)}]
 {MVEL}{MVEL}{MVFLEX Expression Language}

\newglossaryentry{orb-tag}{name={orb tag},
 description={a dynamic element of an \gls{MVEL} template which is
 evaluated at runtime},
 location={(See Section~\ref{sec:mvelbasictemplating}.)}}

\newabbreviation
 [description={a simple computer programming environment that takes
  a single expression (input), evaluates it and results the result}]
 {REPL}{REPL}{Read--Eval--Print Loop}

\newabbreviation
 [description={a database language}]
 {SQL}{SQL}{Structured Query Language}

\newabbreviation
 [description={a markup language that defines a set of rules for
encoding documents in a format that is both human-readable and
machine-readable}]
 {XML}{XML}{Extensible Markup Language}

\newabbreviation
 [description={human-friendly data, commonly used for configuration
files but also used for data storage or transmission},
 location={(See Chapter~\ref{chap:yaml}.)}]
 {YAML}{YAML}{YAML Ain't Markup Language}
 
\begin{document}

\begin{titlingpage}
\vspace*{2em}

\begin{center}
\includegraphics[scale=0.7]{../logos/logo2.pdf}

\vspace{4em}

\begin{tcolorbox}[
  boxrule=0pt,
  colback=araracolour,
  top=1em,
  bottom=1em
]
  \color{white}
  \centering
  \Huge
  \sffamily
  \bfseries User manual
\end{tcolorbox}

\vspace{6em}

{\large\em Paulo Cereda, Marco Daniel,\\
Brent Longborough, and Nicola Talbot\par}

\vspace{3em}

\href{mailto:cereda.paulo@gmail.com}{\fpemail{0.4}}%
\quad\href{https://github.com/cereda/arara}{\fpgithub{0.4}}%
\quad\href{http://twitter.com/paulocereda}{\fptwitter{0.4}}

\vfill

{\color{araracolour}
\LARGE
\sffamily
\bfseries
Version \araraversion}

\end{center}
\end{titlingpage}

\chapterstyle{araraheadings}
\pagestyle{headings}
\frontmatter
\nouppercaseheads

\cleardoublepage

\vspace*{25em}

\begin{flushright}
\em No birds were harmed in the making of this manual.
\end{flushright}

\include{chapters/foreword}
\include{chapters/prologue}
\include{chapters/license}
\printunsrtglossary

\cleardoublepage

\vspace*{25em}

\thispagestyle{empty}
\begin{flushright}
\em To Marco's son Niclas.
\end{flushright}

\cleardoublepage

\tableofcontents*

\cleardoublepage

\mainmatter

\include{chapters/introduction}

\part{The application}
\label{part:application}

\include{chapters/concepts}
\include{chapters/cli}
\include{chapters/configuration}
\include{chapters/logging}
\include{chapters/methods}
\include{chapters/rules}

\part{Development and deployment}
\label{part:developmentanddeployment}

\include{chapters/building}
\include{chapters/deploying}

\part{A primer on formats and scripting}
\label{part:primer}

\include{chapters/yaml}
\include{chapters/mvel}

\end{document}