summaryrefslogtreecommitdiff
path: root/support/latexindent/documentation/sec-introduction.tex
diff options
context:
space:
mode:
Diffstat (limited to 'support/latexindent/documentation/sec-introduction.tex')
-rw-r--r--support/latexindent/documentation/sec-introduction.tex62
1 files changed, 31 insertions, 31 deletions
diff --git a/support/latexindent/documentation/sec-introduction.tex b/support/latexindent/documentation/sec-introduction.tex
index 887a096887..c9915e4fcc 100644
--- a/support/latexindent/documentation/sec-introduction.tex
+++ b/support/latexindent/documentation/sec-introduction.tex
@@ -2,17 +2,16 @@
\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 \cite{harish} who helped to develop and test the
- initial versions of the script.
+ 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
+ \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 by the
- wonderful \texttt{arara} tool; any similarities are deliberate, and I hope that
- it is perceived as the compliment that it is. Thank you to Paulo Cereda and the team for
+ wonderful \texttt{arara} tool; any similarities are deliberate, and I hope that it is
+ perceived as the compliment that it is. Thank you to Paulo Cereda and the team for
releasing this awesome tool; I initially worried that I was going to have to make a GUI
- for \texttt{latexindent.pl}, but the release of \texttt{arara} has meant there is
- no need.
+ for \texttt{latexindent.pl}, but the release of \texttt{arara} has meant there is no
+ need.
There have been several contributors to the project so far (and hopefully more in the
future!); thank you very much to the people detailed in \vref{sec:contributors} for their
@@ -24,17 +23,17 @@
is released under the GNU General Public License v3.0.
Before you start using it on any important files, bear in mind that
- \texttt{latexindent.pl} has the option to overwrite your \texttt{.tex} files. It
- will always make at least one backup (you can choose how many it makes, see
- \cpageref{page:onlyonebackup}) but you should still be careful when using it. The script has
- been tested on many files, but there are some known limitations (see
- \cref{sec:knownlimitations}). You, the user, are responsible for ensuring that you maintain
- backups of your files before running \texttt{latexindent.pl} on them. I think it is
- important at this stage to restate an important part of the license here:
+ \texttt{latexindent.pl} has the option to overwrite your \texttt{.tex} files. It will
+ always make at least one backup (you can choose how many it makes, see
+ \cpageref{page:onlyonebackup}) but you should still be careful when using it. The script
+ has been tested on many files, but there are some known limitations (see
+ \cref{sec:knownlimitations}). You, the user, are responsible for ensuring that you
+ maintain backups of your files before running \texttt{latexindent.pl} on them. I think it
+ is important at this stage to restate an important part of the license here:
\begin{quote}\itshape
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
\end{quote}
There is certainly no malicious intent in releasing this script, and I do hope that it
@@ -101,16 +100,16 @@
% \begin{latexonly}
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
- % \end{latexonly}
+ \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 % \end{latexonly}
\subsection{Quick start}\label{sec:quickstart}
If you'd like to get started with \texttt{latexindent.pl} then simply type
@@ -128,12 +127,13 @@ BEGIN failed--compilation aborted at helloworld.pl line 10.
\begin{commandshell}
perl latexindent-module-installer.pl
\end{commandshell}
- You might also like to see \href{https://stackoverflow.com/questions/19590042/error-cant-locate-file-homedir-pm-in-inc}{https://stackoverflow.com/questions/19590042/error-cant-locate-file-homedir-pm-in-inc}, for example, as well as
- \vref{sec:requiredmodules}.
+ You might also like to see
+ \href{https://stackoverflow.com/questions/19590042/error-cant-locate-file-homedir-pm-in-inc}{https://stackoverflow.com/questions/19590042/error-cant-locate-file-homedir-pm-in-inc},
+ for example, as well as \vref{sec:requiredmodules}.
\subsection{A word about regular expressions}
\index{regular expressions!a word about}
- As you read this documentation, you may encounter the term \emph{regular expressions}. I've
- tried to write this documentation in such a way so as to allow you to engage with them or
- not, as you prefer. This documentation is not designed to be a guide to regular
+ As you read this documentation, you may encounter the term \emph{regular expressions}.
+ I've tried to write this documentation in such a way so as to allow you to engage with
+ them or not, as you prefer. This documentation is not designed to be a guide to regular
expressions, and if you'd like to read about them, I recommend \cite{masteringregexp}.