diff options
author | Karl Berry <karl@freefriends.org> | 2022-01-08 21:34:40 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2022-01-08 21:34:40 +0000 |
commit | a47a7cdd5e97b3173506c30afad63d5c1c7a92b5 (patch) | |
tree | c12a9df5a9a0853c7bb9c11b389e1895d35232d6 /Master/texmf-dist/doc/support | |
parent | 4674b6b4c73f8fc8cbbcf07ddf24956d2eb16d80 (diff) |
latexindent (8jan22)
git-svn-id: svn://tug.org/texlive/trunk@61535 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/support')
-rw-r--r-- | Master/texmf-dist/doc/support/latexindent/README | 2 | ||||
-rw-r--r-- | Master/texmf-dist/doc/support/latexindent/appendices.tex | 13 | ||||
-rw-r--r-- | Master/texmf-dist/doc/support/latexindent/latexindent-yaml-schema.json | 2 | ||||
-rw-r--r-- | Master/texmf-dist/doc/support/latexindent/latexindent.pdf | bin | 1074008 -> 1066210 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/support/latexindent/sec-default-user-local.tex | 18 | ||||
-rw-r--r-- | Master/texmf-dist/doc/support/latexindent/sec-how-to-use.tex | 29 | ||||
-rw-r--r-- | Master/texmf-dist/doc/support/latexindent/settings-alt.json | 5 | ||||
-rw-r--r-- | Master/texmf-dist/doc/support/latexindent/settings-alt1.json | 5 | ||||
-rw-r--r-- | Master/texmf-dist/doc/support/latexindent/settings.json | 6 | ||||
-rw-r--r-- | Master/texmf-dist/doc/support/latexindent/title.tex | 4 |
10 files changed, 43 insertions, 41 deletions
diff --git a/Master/texmf-dist/doc/support/latexindent/README b/Master/texmf-dist/doc/support/latexindent/README index 99ae485f0a4..50605df1312 100644 --- a/Master/texmf-dist/doc/support/latexindent/README +++ b/Master/texmf-dist/doc/support/latexindent/README @@ -1,5 +1,5 @@ %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% - latexindent.pl, version 3.13.5, 2022-01-02 + latexindent.pl, version 3.14, 2022-01-08 PERL script to indent code within environments, and align delimited environments in .tex files. diff --git a/Master/texmf-dist/doc/support/latexindent/appendices.tex b/Master/texmf-dist/doc/support/latexindent/appendices.tex index bea35044056..b69e2b34fe8 100644 --- a/Master/texmf-dist/doc/support/latexindent/appendices.tex +++ b/Master/texmf-dist/doc/support/latexindent/appendices.tex @@ -210,13 +210,16 @@ echo %path% \section{latexindent-yaml-schema.json} \texttt{latexindent.pl} - \announce*{2022-01-02}{latexindent-yaml-schema.json} ships with + \announce{2022-01-02}{latexindent-yaml-schema.json} ships with \texttt{latexindent-yaml-schema.json} which might help you when constructing your YAML files. + \index{json!schema for YAML files} \subsection{VSCode demonstration} To use \texttt{latexindent-yaml-schema.json} with \texttt{VSCode}, you can use the following steps: + \index{VSCode} + \index{json!VSCode} \begin{enumerate} \item download \texttt{latexindent-yaml-schema.json} from the \texttt{documentation} folder of \cite{latexindent-home}, save it in whichever directory you would like, noting it for @@ -229,14 +232,14 @@ echo %path% \end{enumerate} \begin{widepage} - \cmhlistingsfromfile*{settings.json}[yaml-TCB]{\texttt{settings.json}}{lst:settings.json} + \cmhlistingsfromfile*{demonstrations/settings.json}[yaml-TCB]{\texttt{settings.json}}{lst:settings.json} \end{widepage} Alternatively, if you would prefer not to download the json file, you might be able to use an adapted version of \cref{lst:settings-alt.json}. \begin{widepage} - \cmhlistingsfromfile*{settings-alt.json}[yaml-TCB]{\texttt{settings-alt.json}}{lst:settings-alt.json} + \cmhlistingsfromfile*{demonstrations/settings-alt.json}[yaml-TCB]{\texttt{settings-alt.json}}{lst:settings-alt.json} \end{widepage} Finally, if your TeX distribution is up to date, then @@ -244,7 +247,7 @@ echo %path% your installation, so an adapted version of \cref{lst:settings-alt1.json} may work. \begin{widepage} - \cmhlistingsfromfile*{settings-alt1.json}[yaml-TCB]{\texttt{settings-alt1.json}}{lst:settings-alt1.json} + \cmhlistingsfromfile*{demonstrations/settings-alt1.json}[yaml-TCB]{\texttt{settings-alt1.json}}{lst:settings-alt1.json} \end{widepage} If you have details of how to implement this schema in other editors, please feel @@ -252,13 +255,13 @@ echo %path% \section{Using conda} If you use conda you'll only need - \begin{commandshell} conda install latexindent.pl -c conda-forge \end{commandshell} this will install the executable and all its dependencies (including perl) in the activate environment. You don't even have to worry about \texttt{defaultSettings.yaml} as it included too, you can thus skip \cref{sec:requiredmodules,sec:updating-path}. + \index{conda} You can get a conda installation for example from \cite{conda} or from \cite{anacoda}. diff --git a/Master/texmf-dist/doc/support/latexindent/latexindent-yaml-schema.json b/Master/texmf-dist/doc/support/latexindent/latexindent-yaml-schema.json index 5c274242945..6aaf8d80dfc 100644 --- a/Master/texmf-dist/doc/support/latexindent/latexindent-yaml-schema.json +++ b/Master/texmf-dist/doc/support/latexindent/latexindent-yaml-schema.json @@ -2,7 +2,7 @@ "$schema": "http://json-schema.org/schema", "$id": "latexindent-yaml-schema.json", "title": "latexindent.pl YAML schema", - "description": "latexindent.pl YAML schema helper, V3.13.5 2022-01-02", + "description": "latexindent.pl YAML schema helper, V3.14 2022-01-08", "type": "object", "properties": { "fileExtensionPreference": { diff --git a/Master/texmf-dist/doc/support/latexindent/latexindent.pdf b/Master/texmf-dist/doc/support/latexindent/latexindent.pdf Binary files differindex 40747a7ab4a..90a746666f2 100644 --- a/Master/texmf-dist/doc/support/latexindent/latexindent.pdf +++ b/Master/texmf-dist/doc/support/latexindent/latexindent.pdf diff --git a/Master/texmf-dist/doc/support/latexindent/sec-default-user-local.tex b/Master/texmf-dist/doc/support/latexindent/sec-default-user-local.tex index 74c36b48c53..6be0bbe3f51 100644 --- a/Master/texmf-dist/doc/support/latexindent/sec-default-user-local.tex +++ b/Master/texmf-dist/doc/support/latexindent/sec-default-user-local.tex @@ -453,11 +453,9 @@ lookForAlignDelims: 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}; - \item \announce*{2021-12-13}{lookForChildCodeBlocks feature}{lookForChildCodeBlocks} optionally - instructs - \texttt{latexindent.pl} - to search for child code blocks or not (default: 1), discussed in - \cref{sec:lookForChildCodeBlocks}. + \item \announce{2021-12-13}{lookForChildCodeBlocks feature}{lookForChildCodeBlocks} 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 @@ -946,7 +944,7 @@ latexindent.pl tabbing1.tex -l=delimiterRegEx5.yaml -o=+-mod5 \subsubsection{lookForAlignDelims: lookForChildCodeBlocks}\label{sec:lookForChildCodeBlocks} There - \announce*{2021-12-13}{lookForChildCodeBlocks demonstration} may be scenarios in + \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. @@ -958,8 +956,8 @@ 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} + \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 @@ -970,8 +968,8 @@ latexindent.pl tabular-DM-1.tex -l=dontMeasure1a.yaml -o=+-mod1a 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} + \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} diff --git a/Master/texmf-dist/doc/support/latexindent/sec-how-to-use.tex b/Master/texmf-dist/doc/support/latexindent/sec-how-to-use.tex index 62e821fb0da..f5c79077292 100644 --- a/Master/texmf-dist/doc/support/latexindent/sec-how-to-use.tex +++ b/Master/texmf-dist/doc/support/latexindent/sec-how-to-use.tex @@ -1,11 +1,11 @@ % arara: pdflatex: { files: [latexindent]} \section{How to use the script} \texttt{latexindent.pl} ships as part of the \TeX Live distribution for - Linux and Mac users; \texttt{latexindent.exe} ships as part of the \TeX Live and - MiK\TeX{} distributions for Windows users. These files are also available from github - \cite{latexindent-home} should you wish to use them without a \TeX{} distribution; in - this case, you may like to read \vref{sec:updating-path} which details how the - \texttt{path} variable can be updated. + Linux and Mac users; \texttt{latexindent.exe} ships as part of the \TeX Live for Windows + users. These files are also available from github \cite{latexindent-home} should you wish + to use them without a \TeX{} distribution; in this case, you may like to read + \vref{sec:updating-path} which details how the \texttt{path} variable can be updated. + \index{TeXLive} In what follows, we will always refer to \texttt{latexindent.pl}, but depending on your operating system and preference, you might substitute \texttt{latexindent.exe} or simply @@ -24,6 +24,11 @@ \announce{2018-01-13}{perl module installer helper script} in particular, note that a module installer helper script is shipped with \texttt{latexindent.pl}. + MiKTeX users on Windows may like to see \cite{miktex-guide} for details of how to use + \texttt{latexindent.exe} without a Perl installation. + \index{MiKTeX} + \index{latexindent.exe} + \subsection{From the command line}\label{sec:commandline} \texttt{latexindent.pl} has a number of different switches/flags/options, which can be combined in any way that you like, either in short or long form as detailed below. @@ -38,14 +43,26 @@ \announce{2017-06-25}{version} \begin{commandshell} latexindent.pl -v +latexindent.pl --version \end{commandshell} This will output only the version number to the terminal. +\flagbox{-vv, --vversion} + \index{switches!-vv, --vversion definition and details} + \announce*{2022-01-08}{vversion switch} + \begin{commandshell} +latexindent.pl -vv +latexindent.pl --vversion +\end{commandshell} + This will output \emph{verbose} version details to the terminal, including the location + of \texttt{latexindent.pl} and \texttt{defaultSettings.yaml}. + \flagbox{-h, --help} \index{switches!-h, --help definition and details} \begin{commandshell} latexindent.pl -h +latexindent.pl --help \end{commandshell} As above this will output a welcome message to the terminal, including the version number @@ -485,7 +502,7 @@ latexindent.pl myfile.tex exit code & indentation & status \\ \midrule 0 & \faCheck & success; if \texttt{-k} or \texttt{-kv} active, indented text matches original \\ - 0 & \faClose & success; if \texttt{-version} or \texttt{-help}, no indentation performed \\ + 0 & \faClose & success; if \texttt{-version}, \texttt{-vversion} or \texttt{-help}, no indentation performed \\ 1 & \faCheck & success, and \texttt{-k} or \texttt{-kv} active; indented text \emph{different} from original \\ \midrule 2 & \faClose & failure, \texttt{defaultSettings.yaml} could not be read \\ diff --git a/Master/texmf-dist/doc/support/latexindent/settings-alt.json b/Master/texmf-dist/doc/support/latexindent/settings-alt.json deleted file mode 100644 index 63719f74a62..00000000000 --- a/Master/texmf-dist/doc/support/latexindent/settings-alt.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "yaml.schemas": { - "https://raw.githubusercontent.com/cmhughes/latexindent.pl/main/documentation/latexindent-yaml-schema.json": "/home/cmhughes/projects/latexindent/defaultSettings.yaml" - } -} diff --git a/Master/texmf-dist/doc/support/latexindent/settings-alt1.json b/Master/texmf-dist/doc/support/latexindent/settings-alt1.json deleted file mode 100644 index cdd10add4aa..00000000000 --- a/Master/texmf-dist/doc/support/latexindent/settings-alt1.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "yaml.schemas": { - "/usr/local/texlive/2021/texmf-dist/doc/support/latexindent/latexindent-yaml-schema.json": "/home/cmhughes/projects/latexindent/defaultSettings.yaml" - } -} diff --git a/Master/texmf-dist/doc/support/latexindent/settings.json b/Master/texmf-dist/doc/support/latexindent/settings.json deleted file mode 100644 index 7c3084347f9..00000000000 --- a/Master/texmf-dist/doc/support/latexindent/settings.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "yaml.schemas": { - "/home/cmhughes/projects/latexindent/documentation/latexindent-yaml-schema.json": "/home/cmhughes/projects/latexindent/defaultSettings.yaml" - }, - "redhat.telemetry.enabled": true -}
\ No newline at end of file diff --git a/Master/texmf-dist/doc/support/latexindent/title.tex b/Master/texmf-dist/doc/support/latexindent/title.tex index eb85f22363c..9384d7b1b92 100644 --- a/Master/texmf-dist/doc/support/latexindent/title.tex +++ b/Master/texmf-dist/doc/support/latexindent/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.5 + \centering\ttfamily\bfseries latexindent.pl\\[1cm] Version 3.14 \end{tcolorbox} } \author{Chris Hughes \thanks{and contributors! See \vref{sec:contributors}. For all communication, please visit \cite{latexindent-home}.}} -\date{2022-01-02} +\date{2022-01-08} \maketitle \begin{adjustwidth}{1cm}{1cm} \small |