summaryrefslogtreecommitdiff
path: root/support/latexindent/documentation
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2021-12-15 03:01:18 +0000
committerNorbert Preining <norbert@preining.info>2021-12-15 03:01:18 +0000
commit0efaa39c6d0b17b58df9a68ae1319ea20aaabc28 (patch)
tree677b276738cd1c52e8778f985da1705c64a4b729 /support/latexindent/documentation
parent829614e28f2055883ff74da11eb4e5e57d199be3 (diff)
CTAN sync 202112150301
Diffstat (limited to 'support/latexindent/documentation')
-rw-r--r--support/latexindent/documentation/latexindent.pdfbin1053582 -> 1056865 bytes
-rw-r--r--support/latexindent/documentation/latexindent.tex2
-rw-r--r--support/latexindent/documentation/sec-default-user-local.tex54
-rw-r--r--support/latexindent/documentation/sec-fine-tuning.tex2
-rw-r--r--support/latexindent/documentation/title.tex4
5 files changed, 48 insertions, 14 deletions
diff --git a/support/latexindent/documentation/latexindent.pdf b/support/latexindent/documentation/latexindent.pdf
index 293588a68d..df19f75e9e 100644
--- a/support/latexindent/documentation/latexindent.pdf
+++ b/support/latexindent/documentation/latexindent.pdf
Binary files differ
diff --git a/support/latexindent/documentation/latexindent.tex b/support/latexindent/documentation/latexindent.tex
index eb8399c32e..f97f5f74ba 100644
--- a/support/latexindent/documentation/latexindent.tex
+++ b/support/latexindent/documentation/latexindent.tex
@@ -522,7 +522,7 @@
\lstdefinestyle{fineTuning}{
style=yaml-LST,
- firstnumber=629,linerange={629-652},
+ firstnumber=629,linerange={629-654},
numbers=left,
}
diff --git a/support/latexindent/documentation/sec-default-user-local.tex b/support/latexindent/documentation/sec-default-user-local.tex
index ec1ae8bf21..6e92e4aeb1 100644
--- a/support/latexindent/documentation/sec-default-user-local.tex
+++ b/support/latexindent/documentation/sec-default-user-local.tex
@@ -138,7 +138,7 @@ copy myfile.bak4 to myfile.bak3
\texttt{latexindent.pl} will \emph{always} prioritize \texttt{verbatimEnvironments}.
You can, optionally, specify
- \announce*{2021-10-30}{verbatim name feature} the
+ \announce{2021-10-30}{verbatim name feature} the
\texttt{verbatim} field using the \texttt{name} field which takes a regular expression as
its argument; thank you to \cite{XuehaiPan} for contributing this feature.
@@ -147,8 +147,8 @@ copy myfile.bak4 to myfile.bak3
then the listings given in \cref{lst:nameAsRegex1,lst:nameAsRegex2} are equivalent.
\begin{cmhtcbraster}[raster column skip=.1\linewidth]
- \cmhlistingsfromfile*{demonstrations/nameAsRegex1.yaml}[yaml-TCB]{\texttt{nameAsRegex1.yaml}}{lst:nameAsRegex1}
- \cmhlistingsfromfile*{demonstrations/nameAsRegex2.yaml}[yaml-TCB]{\texttt{nameAsRegex2.yaml}}{lst:nameAsRegex2}
+ \cmhlistingsfromfile{demonstrations/nameAsRegex1.yaml}[yaml-TCB]{\texttt{nameAsRegex1.yaml}}{lst:nameAsRegex1}
+ \cmhlistingsfromfile{demonstrations/nameAsRegex2.yaml}[yaml-TCB]{\texttt{nameAsRegex2.yaml}}{lst:nameAsRegex2}
\end{cmhtcbraster}
With reference to \cref{lst:nameAsRegex2}:
@@ -174,7 +174,7 @@ copy myfile.bak4 to myfile.bak3
example, \lstinline|\verb!x+3!| is treated as a \texttt{verbatimCommands}.
You can, optionally, specify
- \announce*{2021-10-30}{verbatimCommands name feature} the
+ \announce{2021-10-30}{verbatimCommands name feature} the
\texttt{verbatimCommands} field using the \texttt{name} field which takes a regular
expression as its argument; thank you to \cite{XuehaiPan} for contributing this feature.
@@ -183,8 +183,8 @@ copy myfile.bak4 to myfile.bak3
\cref{lst:nameAsRegex3,lst:nameAsRegex4} are equivalent.
\begin{cmhtcbraster}[raster column skip=.1\linewidth]
- \cmhlistingsfromfile*{demonstrations/nameAsRegex3.yaml}[yaml-TCB]{\texttt{nameAsRegex3.yaml}}{lst:nameAsRegex3}
- \cmhlistingsfromfile*{demonstrations/nameAsRegex4.yaml}[yaml-TCB]{\texttt{nameAsRegex4.yaml}}{lst:nameAsRegex4}
+ \cmhlistingsfromfile{demonstrations/nameAsRegex3.yaml}[yaml-TCB]{\texttt{nameAsRegex3.yaml}}{lst:nameAsRegex3}
+ \cmhlistingsfromfile{demonstrations/nameAsRegex4.yaml}[yaml-TCB]{\texttt{nameAsRegex4.yaml}}{lst:nameAsRegex4}
\end{cmhtcbraster}
With reference to \cref{lst:nameAsRegex4}:
@@ -263,7 +263,7 @@ latexindent.pl -l noindent3.yaml noindent1
We will demonstrate this feature later in the documentation in \cref{lst:href3}.
You can, optionally, specify
- \announce*{2021-10-30}{noIndentBlock name feature} the
+ \announce{2021-10-30}{noIndentBlock name feature} the
\texttt{noIndentBlock} field using the \texttt{name} field which takes a regular
expression as its argument; thank you to \cite{XuehaiPan} for contributing this feature.
@@ -273,8 +273,8 @@ latexindent.pl -l noindent3.yaml noindent1
\begin{widepage}
\begin{cmhtcbraster}[raster column skip=.1\linewidth]
- \cmhlistingsfromfile*{demonstrations/nameAsRegex5.yaml}[yaml-TCB]{\texttt{nameAsRegex5.yaml}}{lst:nameAsRegex5}
- \cmhlistingsfromfile*{demonstrations/nameAsRegex6.yaml}[yaml-TCB]{\texttt{nameAsRegex6.yaml}}{lst:nameAsRegex6}
+ \cmhlistingsfromfile{demonstrations/nameAsRegex5.yaml}[yaml-TCB]{\texttt{nameAsRegex5.yaml}}{lst:nameAsRegex5}
+ \cmhlistingsfromfile{demonstrations/nameAsRegex6.yaml}[yaml-TCB]{\texttt{nameAsRegex6.yaml}}{lst:nameAsRegex6}
\end{cmhtcbraster}
\end{widepage}
@@ -452,7 +452,11 @@ lookForAlignDelims:
\item \announce{2020-03-21}{delimiter justification}{delimiterJustification} optionally
specifies the justification for the alignment delimeters (default: left); note that this
feature is only useful if you have delimiters of different lengths in the same column,
- discussed in \cref{sec:delimiter-reg-ex}.
+ discussed in \cref{sec:delimiter-reg-ex};
+ \item \announce*{2021-12-13}{lookForChildCodeBlocks feature} optionally instructs
+ \texttt{latexindent.pl}
+ to search for child code blocks or not (default: 1), discussed in
+ \cref{sec:lookForChildCodeBlocks}.
\end{itemize}
We will explore most of these features using the file \texttt{tabular2.tex} in
@@ -939,6 +943,36 @@ latexindent.pl tabbing1.tex -l=delimiterRegEx5.yaml -o=+-mod5
Note that in \cref{lst:tabbing1-mod5} the second set of delimiters have been \emph{right
aligned} -- it is quite subtle!
+\subsection{The lookForChildCodeBlocks feature}\label{sec:lookForChildCodeBlocks}
+ There
+ \announce*{2021-12-13}{lookForChildCodeBlocks demonstration} may be scenarios in
+ which you would prefer to instruct \texttt{latexindent.pl} \emph{not} to search for child
+ blocks; in which case setting \texttt{lookForChildCodeBlocks} to 0 may be a good way to
+ proceed.
+
+ Using the settings from \vref{lst:dontMeasure1} on the file in \cref{lst:tabular-DM-1}
+ and running the command
+ \begin{commandshell}
+latexindent.pl tabular-DM-1.tex -l=dontMeasure1.yaml -o=+-mod1
+\end{commandshell}
+ gives the output in \cref{lst:tabular-DM-1-mod1}.
+ \begin{cmhtcbraster}
+ \cmhlistingsfromfile*{demonstrations/tabular-DM-1.tex}{\texttt{tabular-DM-1.tex}}{lst:tabular-DM-1}
+ \cmhlistingsfromfile*{demonstrations/tabular-DM-1-mod1.tex}{\texttt{tabular-DM-1-mod1.tex}}{lst:tabular-DM-1-mod1}
+ \end{cmhtcbraster}
+
+ We can improve the output from \cref{lst:tabular-DM-1-mod1} by employing the settings in
+ \cref{lst:dontMeasure1a}
+ \begin{commandshell}
+latexindent.pl tabular-DM-1.tex -l=dontMeasure1a.yaml -o=+-mod1a
+\end{commandshell}
+ which gives the output in \cref{lst:dontMeasure1a}.
+
+ \begin{cmhtcbraster}
+ \cmhlistingsfromfile*{demonstrations/tabular-DM-1-mod1a.tex}{\texttt{tabular-DM-1-mod1a.tex}}{lst:tabular-DM-1-mod1a}
+ \cmhlistingsfromfile*{demonstrations/dontMeasure1a.yaml}[yaml-TCB]{\texttt{dontMeasure1a.yaml}}{lst:dontMeasure1a}
+ \end{cmhtcbraster}
+
\subsection{Indent after items, specials and headings}
\yamltitle{indentAfterItems}*{fields}
The environment names specified in \texttt{indentAfterItems} tell \texttt{latexindent.pl}
diff --git a/support/latexindent/documentation/sec-fine-tuning.tex b/support/latexindent/documentation/sec-fine-tuning.tex
index 0a0739adc8..9aa24fd9c8 100644
--- a/support/latexindent/documentation/sec-fine-tuning.tex
+++ b/support/latexindent/documentation/sec-fine-tuning.tex
@@ -30,7 +30,7 @@
\end{warning}
\begin{widepage}
- \cmhlistingsfromfile[style=fineTuning]{../defaultSettings.yaml}[width=.95\linewidth,before=\centering,yaml-TCB]{\texttt{fineTuning}}{lst:fineTuning}
+ \cmhlistingsfromfile*[style=fineTuning]{../defaultSettings.yaml}[width=.95\linewidth,before=\centering,yaml-TCB]{\texttt{fineTuning}}{lst:fineTuning}
\end{widepage}
The fields given in \cref{lst:fineTuning} are all \emph{regular expressions}. This manual
diff --git a/support/latexindent/documentation/title.tex b/support/latexindent/documentation/title.tex
index d4bfdb25f3..f1229c071a 100644
--- a/support/latexindent/documentation/title.tex
+++ b/support/latexindent/documentation/title.tex
@@ -8,14 +8,14 @@
sharp corners,
enhanced,
overlay={\node[anchor=north east,outer sep=2pt] at ([xshift=3cm,yshift=4mm]frame.north east) {\includegraphics[width=3cm]{logo}}; }]
- \centering\ttfamily\bfseries latexindent.pl\\[1cm] Version 3.13.2
+ \centering\ttfamily\bfseries latexindent.pl\\[1cm] Version 3.13.3
\end{tcolorbox}
}
\author{Chris Hughes \thanks{and contributors!
See \vref{sec:contributors}.
For
all communication, please visit \cite{latexindent-home}.}}
-\date{2021-11-15}
+\date{2021-12-13}
\maketitle
\begin{adjustwidth}{1cm}{1cm}
\small