Skip to content
Perl script to indent latex files
TeX Perl Shell
Find file

readme.md

PERL script to indent code within environments, and align delimited environments in .texfiles.

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

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.

See http://www.gnu.org/licenses/

C. M. Hughes



For complete details, please see documentation/manual.pdf

Note: latexindent.exe was created using

  pp -o latexindent.exe latexindent.pl

using the Par::Packer perl module.


USAGE

You'll need

    latexindent.pl
    defaultSettings.yaml

in the same directory. Windows users might prefer to grab latexindent.exe

Testing

A nice way to test the script is to navigate to the success directory, and then run the command:

    find -name "*.tex"|while read file; do arara "$file";done

or, without arara (note that this uses localSettings.yaml for every file)

    find . -type f \( -name "*.tex" -or -name "*.cls" \) | while read file; do echo $file; latexindent.pl -w -s -l "$file";done

IMPORTANT

This script may not work for your style of formatting; I highly recommend comparing the outputfile.tex to make sure that nothing has been changed (or removed) in a way that will damage your file.

I recommend using both of the following:

  • a visual check, at the very least, make sure that each file has the same number of lines
  • a check using latexdiff inputfile.tex outputfile.tex
Something went wrong with that request. Please try again.