summaryrefslogtreecommitdiff
path: root/support/latexindent/documentation/subsec-noAdditionalIndent-indentRules.tex
blob: ec0e699aaa46dd5d8a449cd9f18c8e0aac0bb5fa (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
% arara: pdflatex: { files: [latexindent]}
% arara: pdflatex: { files: [latexindent]}
\index{indentation!no additional indent}
\index{indentation!removing indentation per-code block}
\index{indentation!customising indentation per-code block}
\index{indentation!customising per-name}
\index{indentation!no additional indent global}
\subsection{noAdditionalIndent and indentRules}\label{sec:noadd-indent-rules}
 \texttt{latexindent.pl} operates on files by looking for code blocks, as detailed in
 \vref{subsubsec:code-blocks};
 for each type of code block in \vref{tab:code-blocks} (which we will call a
 \emph{$\langle$thing$\rangle$} in what follows) it searches YAML fields for information
 in the following order:
 \begin{enumerate}
  \item \texttt{noAdditionalIndent} for the \emph{name} of the current
        \emph{$\langle$thing$\rangle$};
  \item \texttt{indentRules} for the \emph{name} of the current \emph{$\langle$thing$\rangle$};
  \item \texttt{noAdditionalIndentGlobal} for the \emph{type} of the current
        \emph{$\langle$thing$\rangle$};
  \item \texttt{indentRulesGlobal} for the \emph{type} of the current
        \emph{$\langle$thing$\rangle$}.
 \end{enumerate}

 Using the above list, the first piece of information to be found will be used; failing
 that, the value of \texttt{defaultIndent} is used. If information is found in multiple
 fields, the first one according to the list above will be used; for example, if
 information is present in both \texttt{indentRules} and in
 \texttt{noAdditionalIndentGlobal}, then the information from \texttt{indentRules} takes
 priority.

 We now present details for the different type of code blocks known to
 \texttt{latexindent.pl}, as detailed in \vref{tab:code-blocks}; for reference, there
 follows a list of the code blocks covered.

 \startcontents[noAdditionalIndent]
 \printcontents[noAdditionalIndent]{}{0}{}