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.tex90
1 files changed, 47 insertions, 43 deletions
diff --git a/Master/texmf-dist/doc/support/latexindent/sec-introduction.tex b/Master/texmf-dist/doc/support/latexindent/sec-introduction.tex
index 453851d7383..c869b84596e 100644
--- a/Master/texmf-dist/doc/support/latexindent/sec-introduction.tex
+++ b/Master/texmf-dist/doc/support/latexindent/sec-introduction.tex
@@ -1,44 +1,45 @@
% 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 \cite{harish} who
- helped to develop and test the initial versions of the script.
+ 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.
- 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 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.
+ 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
+ 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.
- 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 valued contributions, and thank you to those who report bugs and request features
- at \cite{latexindent-home}.
+ 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
+ valued contributions, and thank you to those who report bugs and request features at
+ \cite{latexindent-home}.
\subsection{License}
\texttt{latexindent.pl} is free and open source, and it always will be; it
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:
+ 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:
\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
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 works as you expect it to; if it does not, please first of all
- make sure that you have the correct settings, and then feel free to let me know at \cite{latexindent-home} with a
+ There is certainly no malicious intent in releasing this script, and I do hope that it
+ works as you expect it to; if it does not, please first of all make sure that you have
+ the correct settings, and then feel free to let me know at \cite{latexindent-home} with a
complete minimum working example as I would like to improve the code as much as possible.
\begin{warning}
Before you try the script on anything important (like your thesis), test it
@@ -50,10 +51,10 @@
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.
+ 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:
@@ -86,15 +87,17 @@
\end{minipage}%
% \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
+ 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}
\subsection{Quick start}\label{sec:quickstart}
@@ -102,15 +105,16 @@
\begin{commandshell}
latexindent.pl myfile.tex
\end{commandshell}
- from the command line. If you receive an error message such as that given in \cref{lst:poss-errors},
- then you need to install the missing perl modules.
+ from the command line. If you receive an error message such as that given in
+ \cref{lst:poss-errors}, then you need to install the missing perl modules.
\begin{cmhlistings}[style=tcblatex,language=Perl]{Possible error messages}{lst:poss-errors}
Can't locate File/HomeDir.pm in @INC (@INC contains: /Library/Perl/5.12/darwin-thread-multi-2level /Library/Perl/5.12 /Network/Library/Perl/5.12/darwin-thread-multi-2level /Network/Library/Perl/5.12 /Library/Perl/Updates/5.12.4/darwin-thread-multi-2level /Library/Perl/Updates/5.12.4 /System/Library/Perl/5.12/darwin-thread-multi-2level /System/Library/Perl/5.12 /System/Library/Perl/Extras/5.12/darwin-thread-multi-2level /System/Library/Perl/Extras/5.12 .) at helloworld.pl line 10.
BEGIN failed--compilation aborted at helloworld.pl line 10.
\end{cmhlistings}
- \texttt{latexindent.pl} ships with a script to help with this process; if you run the following script, you should be prompted
- to install the appropriate modules.
+ \texttt{latexindent.pl} ships with a script to help with this process; if you run the
+ following script, you should be prompted to install the appropriate modules.
\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}.