latexindent.pl documentation

• 1. Introduction
  • 1.1. License
  • 1.2. Quick start
  • 1.3. Requirements
    • 1.3.1. Perl users
    • 1.3.2. Windows users without perl
    • 1.3.3. Ubuntu Linux users without perl
    • 1.3.4. macOS users without perl
    • 1.3.5. conda users
    • 1.3.6. docker users
  • 1.4. About this documentation
  • 1.5. A word about regular expressions
• 2. How to use the script
  • 2.1. From the command line
  • 2.2. From arara
  • 2.3. switches via yaml
  • 2.4. Summary of exit codes
• 3. Config
  • 3.1. Backup and log file preferences
  • 3.2. Verbatim code blocks
  • 3.3. filecontents and preamble
  • 3.4. Indentation and horizontal space
  • 3.5. Aligning at delimiters
    • 3.5.1. lookForAlignDelims: spacesBeforeAmpersand
    • 3.5.2. lookForAlignDelims: the dontMeasure feature
    • 3.5.3. lookForAlignDelims: the delimiterRegEx and delimiterJustification feature
    • 3.5.4. lookForAlignDelims: lookForChildCodeBlocks
    • 3.5.5. lookForAlignDelims: alignContentAfterDoubleBackSlash
    • 3.5.6. lookForAlignDelims: other
  • 3.6. Indent after items, specials and headings
  • 3.7. Arguments and the strings allowed between them
  • 3.8. The code blocks known to latexindent.pl
  • 3.9. noAdditionalIndent and indentRules
    • 3.9.1. Environments and their arguments
    • 3.9.2. Environments with items
    • 3.9.3. Commands with arguments
    • 3.9.4. ifelsefi code blocks
    • 3.9.5. specialBeginEnd code blocks
    • 3.9.6. afterHeading code blocks
    • 3.9.7. The remaining code blocks
      • 3.9.7.1. keyEqualsValuesBracesBrackets
      • 3.9.7.2. namedGroupingBracesBrackets
      • 3.9.7.3. UnNamedGroupingBracesBrackets
    • 3.9.8. Summary
• 4. The -m (modifylinebreaks) switch
  • 4.1. Text Wrapping
    • 4.1.1. Text wrap: overview
    • 4.1.2. Text wrap: simple examples
    • 4.1.3. Text wrap: blocksFollow examples
    • 4.1.4. Text wrap: blocksBeginWith examples
    • 4.1.5. Text wrap: blocksEndBefore examples
    • 4.1.6. Text wrap: trailing comments and spaces
    • 4.1.7. Text wrap: when before/after
    • 4.1.8. Text wrap: wrapping comments
    • 4.1.9. Text wrap: huge, tabstop and separator
  • 4.2. oneSentencePerLine: modifying line breaks for sentences
    • 4.2.1. oneSentencePerLine: overview
    • 4.2.2. oneSentencePerLine: sentencesFollow
    • 4.2.3. oneSentencePerLine: sentencesBeginWith
    • 4.2.4. oneSentencePerLine: sentencesEndWith
    • 4.2.5. oneSentencePerLine: sentencesDoNOTcontain
    • 4.2.6. Features of the oneSentencePerLine routine
    • 4.2.7. oneSentencePerLine: text wrapping and indenting sentences
    • 4.2.8. oneSentencePerLine: text wrapping and indenting sentences, when before/after
    • 4.2.9. oneSentencePerLine: text wrapping sentences and comments
  • 4.3. Poly-switches
    • 4.3.1. Poly-switches for environments
      • 4.3.1.1. Adding line breaks: BeginStartsOnOwnLine and BodyStartsOnOwnLine
      • 4.3.1.2. Adding line breaks: EndStartsOnOwnLine and EndFinishesWithLineBreak
      • 4.3.1.3. poly-switches 1, 2, and 3 only add line breaks when necessary
      • 4.3.1.4. Removing line breaks (poly-switches set to \(-1\))
      • 4.3.1.5. About trailing horizontal space
      • 4.3.1.6. poly-switch line break removal and blank lines
    • 4.3.2. Poly-switches for double backslash
      • 4.3.2.1. Double backslash starts on own line
      • 4.3.2.2. Double backslash finishes with line break
      • 4.3.2.3. Double backslash poly-switches for specialBeginEnd
      • 4.3.2.4. Double backslash poly-switches for optional and mandatory arguments
      • 4.3.2.5. Double backslash optional square brackets
    • 4.3.3. Poly-switches for commas
      • 4.3.3.1. Comma starts on own line
      • 4.3.3.2. Comma finishes with line break
    • 4.3.4. Poly-switches for other code blocks
    • 4.3.5. Conflicting poly-switches: sequential code blocks
    • 4.3.6. Conflicting poly-switches: nested code blocks
• 5. The -r, -rv and -rr switches
  • 5.1. Introduction to replacements
  • 5.2. The two types of replacements
  • 5.3. Examples of replacements
• 6. The –lines switch
• 7. Fine tuning
  • 7.1. fineTuning trailing comments
  • 7.2. fineTuning environments
  • 7.3. fineTuning itemsRegex
  • 7.4. fineTuning arguments
  • 7.5. fineTuning ifElseFi
  • 7.6. fineTuning lookForAlignDelims
  • 7.7. fineTuning using -y switch
• 8. Conclusions and known limitations
• 9. References
• 10. Appendices
  • 10.1. Required Perl modules
    • 10.1.1. Module installer script
    • 10.1.2. Manually installing modules
    • 10.1.3. Linux
      • 10.1.3.1. perlbrew
      • 10.1.3.2. Ubuntu/Debian
      • 10.1.3.3. Ubuntu: using the texlive from apt-get
      • 10.1.3.4. Ubuntu: users without perl
      • 10.1.3.5. Arch-based distributions
      • 10.1.3.6. Alpine
    • 10.1.4. Mac
    • 10.1.5. Windows
    • 10.1.6. The GCString switch
  • 10.2. Updating the path variable
    • 10.2.1. Add to path for Linux
    • 10.2.2. Add to path for Windows
  • 10.3. Batches of files
    • 10.3.1. location of indent.log
    • 10.3.2. interaction with -w switch
    • 10.3.3. interaction with -o switch
    • 10.3.4. interaction with lines switch
    • 10.3.5. interaction with check switches
    • 10.3.6. when a file does not exist
  • 10.4. latexindent-yaml-schema.json
    • 10.4.1. VSCode demonstration
  • 10.5. Using conda
    • 10.5.1. Sample conda installation on Ubuntu
  • 10.6. Using docker
    • 10.6.1. Sample docker installation on Ubuntu
    • 10.6.2. How to format on Docker
  • 10.7. pre-commit
    • 10.7.1. Sample pre-commit installation on Ubuntu
    • 10.7.2. pre-commit defaults
    • 10.7.3. pre-commit using CPAN
    • 10.7.4. pre-commit using conda
    • 10.7.5. pre-commit using docker
    • 10.7.6. pre-commit example using -l, -m switches
  • 10.8. indentconfig options
    • 10.8.1. indentconfig.yaml and .indentconfig.yaml
    • 10.8.2. localSettings.yaml and friends
    • 10.8.3. The -y|yaml switch
    • 10.8.4. Settings load order
    • 10.8.5. indentconfig options
    • 10.8.6. Why to change the configuration location
    • 10.8.7. How to change the configuration location
    • 10.8.8. Linux
    • 10.8.9. Windows
    • 10.8.10. Mac
  • 10.9. paths demonstration
  • 10.10. logFilePreferences
  • 10.11. Encoding
  • 10.12. dos2unix linebreak adjustment
  • 10.13. Thanks