summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/support/latexindent/sec-introduction.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/support/latexindent/sec-introduction.tex')
-rw-r--r--Master/texmf-dist/doc/support/latexindent/sec-introduction.tex49
1 files changed, 48 insertions, 1 deletions
diff --git a/Master/texmf-dist/doc/support/latexindent/sec-introduction.tex b/Master/texmf-dist/doc/support/latexindent/sec-introduction.tex
index 67826d37c24..154ea633fe5 100644
--- a/Master/texmf-dist/doc/support/latexindent/sec-introduction.tex
+++ b/Master/texmf-dist/doc/support/latexindent/sec-introduction.tex
@@ -1,9 +1,10 @@
+% arara: pdflatex: {shell: yes, files: [latexindent]}
\section{Introduction}
\subsection{Thanks}
I first created \texttt{latexindent.pl} to help me format chapter files
in a big project. After I blogged about it on the
\TeX{} stack exchange \cite{cmhblog} I received some positive feedback and
- follow-up feature requests. A big thank you to Harish Kumar who
+ follow-up feature requests. A big thank you to Harish Kumar \cite{harish} who
helped to develop and test the initial versions of the script.
The \texttt{YAML}-based interface of \texttt{latexindent.pl} was inspired
@@ -47,3 +48,49 @@
\emph{If you have used any version 2.* of \texttt{latexindent.pl}, there
are a few changes to the interface; see \vref{app:differences} and the comments
throughout this document for details}.
+
+\subsection{About this documentation}
+ As you read through this documentation, you will see many listings; in this version of the documentation,
+ there are a total of \totallstlistings. This may seem a lot, but I deem it necessary in
+ presenting the various different options of \texttt{latexindent.pl} and the associated output that they are capable of
+ producing.
+
+ The different listings are presented using different styles:
+
+ \begin{minipage}{.4\textwidth}
+ \cmhlistingsfromfile*{demonstrations/demo-tex.tex}{\texttt{demo-tex.tex}}{lst:demo-tex}
+ \end{minipage}%
+ \hfill
+ \begin{minipage}{.4\textwidth}
+ This type of listing is a \texttt{.tex} file.
+ \end{minipage}%
+
+ \begin{minipage}{.4\textwidth}
+ \cmhlistingsfromfile*[style=fileExtensionPreference]{../defaultSettings.yaml}[width=.8\linewidth,before=\centering,yaml-TCB]{\texttt{fileExtensionPreference}}{lst:fileExtensionPreference-demo}
+ \end{minipage}%
+ \hfill
+ \begin{minipage}{.4\textwidth}
+ This type of listing is a \texttt{.yaml} file; when you see line numbers given (as here)
+ it means that the snippet is taken directly from \texttt{defaultSettings.yaml}, discussed in
+ detail in \vref{sec:defuseloc}.
+ \end{minipage}%
+
+ \begin{minipage}{.55\textwidth}
+ \cmhlistingsfromfile*[style=modifylinebreaks]{../defaultSettings.yaml}[MLB-TCB,width=.85\linewidth,before=\centering]{\texttt{modifyLineBreaks}}{lst:modifylinebreaks-demo}
+ \end{minipage}%
+ \hfill
+ \begin{minipage}{.4\textwidth}
+ This type of listing is a \texttt{.yaml} file, but it will only
+ be relevant when the \texttt{-m} switch is active; see \vref{sec:modifylinebreaks}
+ for more details.
+ \end{minipage}%
+
+ You will occasionally see dates shown in the margin (for example, next to this paragraph!)
+ \announce{2017-06-25}{announce} which detail the date of the version in which the feature was implemented;
+ the `N' stands for `new as of the date shown' and `U' stands for `updated as of the date shown'.
+ If you see \stardemo, it
+ means that the feature is either new (N) or updated (U) as of the release of the current version; if you see \stardemo\,
+ attached to a listing, then it means that listing is new (N) or updated (U) as of the current version. If you have
+ not read this document before (and even if you have!), then you can ignore every occurrence of the \stardemo;
+ they are simply there to highlight new and updated features.
+ The new and updated features in this documentation (\gitRel) are on the following pages: \listOfNewFeatures