Perl script to indent latex files
TeX Perl Shell Other

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/latexindent.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
    LatexIndent/*.pm
    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 test-cases directory, and then run the command (on Linux/Mac -- sorry, not created a Windows test-case version):

    ./test-cases.sh

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
  • git status myfile.tex