latexindent.pl documentation

• 1. Introduction
  • 1.1. Thanks
  • 1.2. License
  • 1.3. Quick start
  • 1.4. Required perl modules
  • 1.5. About this documentation
  • 1.6. A word about regular expressions
• 2. Demonstration: before and after
• 3. How to use the script
  • 3.1. Requirements
    • 3.1.1. Perl users
    • 3.1.2. Windows users without perl
    • 3.1.3. Ubuntu Linux users without perl
    • 3.1.4. macOS users without perl
    • 3.1.5. conda users
    • 3.1.6. docker users
  • 3.2. From the command line
  • 3.3. From arara
  • 3.4. Summary of exit codes
• 4. indentconfig.yaml, local settings and the -y switch
  • 4.1. indentconfig.yaml and .indentconfig.yaml
  • 4.2. localSettings.yaml and friends
  • 4.3. The -y|yaml switch
  • 4.4. Settings load order
• 5. defaultSettings.yaml
  • 5.1. Backup and log file preferences
  • 5.2. Verbatim code blocks
  • 5.3. filecontents and preamble
  • 5.4. Indentation and horizontal space
  • 5.5. Aligning at delimiters
    • 5.5.1. lookForAlignDelims: spacesBeforeAmpersand
    • 5.5.2. lookForAlignDelims: alignFinalDoubleBackSlash
    • 5.5.3. lookForAlignDelims: the dontMeasure feature
    • 5.5.4. lookForAlignDelims: the delimiterRegEx and delimiterJustification feature
    • 5.5.5. lookForAlignDelims: lookForChildCodeBlocks
    • 5.5.6. lookForAlignDelims: alignContentAfterDoubleBackSlash
  • 5.6. Indent after items, specials and headings
  • 5.7. The code blocks known latexindent.pl
  • 5.8. noAdditionalIndent and indentRules
    • 5.8.1. Environments and their arguments
    • 5.8.2. Environments with items
    • 5.8.3. Commands with arguments
    • 5.8.4. ifelsefi code blocks
    • 5.8.5. specialBeginEnd code blocks
    • 5.8.6. afterHeading code blocks
    • 5.8.7. The remaining code blocks
      • 5.8.7.1. keyEqualsValuesBracesBrackets
      • 5.8.7.2. namedGroupingBracesBrackets
      • 5.8.7.3. UnNamedGroupingBracesBrackets
      • 5.8.7.4. filecontents
    • 5.8.8. Summary
  • 5.9. Commands and the strings between their arguments
• 6. The -m (modifylinebreaks) switch
  • 6.1. Text Wrapping
    • 6.1.1. Text wrap: overview
    • 6.1.2. Text wrap: simple examples
    • 6.1.3. Text wrap: blocksFollow examples
    • 6.1.4. Text wrap: blocksBeginWith examples
    • 6.1.5. Text wrap: blocksEndBefore examples
    • 6.1.6. Text wrap: trailing comments and spaces
    • 6.1.7. Text wrap: when before/after
    • 6.1.8. Text wrap: wrapping comments
    • 6.1.9. Text wrap: huge, tabstop and separator
  • 6.2. oneSentencePerLine: modifying line breaks for sentences
    • 6.2.1. oneSentencePerLine: overview
    • 6.2.2. oneSentencePerLine: sentencesFollow
    • 6.2.3. oneSentencePerLine: sentencesBeginWith
    • 6.2.4. oneSentencePerLine: sentencesEndWith
    • 6.2.5. oneSentencePerLine: sentencesDoNOTcontain
    • 6.2.6. Features of the oneSentencePerLine routine
    • 6.2.7. oneSentencePerLine: text wrapping and indenting sentences
    • 6.2.8. oneSentencePerLine: text wrapping and indenting sentences, when before/after
    • 6.2.9. oneSentencePerLine: text wrapping sentences and comments
  • 6.3. Poly-switches
    • 6.3.1. Poly-switches for environments
      • 6.3.1.1. Adding line breaks: BeginStartsOnOwnLine and BodyStartsOnOwnLine
      • 6.3.1.2. Adding line breaks: EndStartsOnOwnLine and EndFinishesWithLineBreak
      • 6.3.1.3. poly-switches 1, 2, and 3 only add line breaks when necessary
      • 6.3.1.4. Removing line breaks (poly-switches set to \(-1\))
      • 6.3.1.5. About trailing horizontal space
      • 6.3.1.6. poly-switch line break removal and blank lines
    • 6.3.2. Poly-switches for double backslash
      • 6.3.2.1. Double backslash starts on own line
      • 6.3.2.2. Double backslash finishes with line break
      • 6.3.2.3. Double backslash poly-switches for specialBeginEnd
      • 6.3.2.4. Double backslash poly-switches for optional and mandatory arguments
      • 6.3.2.5. Double backslash optional square brackets
    • 6.3.3. Poly-switches for other code blocks
    • 6.3.4. Partnering BodyStartsOnOwnLine with argument-based poly-switches
    • 6.3.5. Conflicting poly-switches: sequential code blocks
    • 6.3.6. Conflicting poly-switches: nested code blocks
• 7. The -r, -rv and -rr switches
  • 7.1. Introduction to replacements
  • 7.2. The two types of replacements
  • 7.3. Examples of replacements
• 8. The –lines switch
• 9. Fine tuning
• 10. Conclusions and known limitations
• 11. References
• 12. Appendices
  • 12.1. Required Perl modules
    • 12.1.1. Module installer script
    • 12.1.2. Manually installing modules
    • 12.1.3. Linux
      • 12.1.3.1. perlbrew
      • 12.1.3.2. Ubuntu/Debian
      • 12.1.3.3. Ubuntu: using the texlive from apt-get
      • 12.1.3.4. Ubuntu: users without perl
      • 12.1.3.5. Arch-based distributions
      • 12.1.3.6. Alpine
    • 12.1.4. Mac
    • 12.1.5. Windows
    • 12.1.6. The GCString switch
  • 12.2. Updating the path variable
    • 12.2.1. Add to path for Linux
    • 12.2.2. Add to path for Windows
  • 12.3. Batches of files
    • 12.3.1. location of indent.log
    • 12.3.2. interaction with -w switch
    • 12.3.3. interaction with -o switch
    • 12.3.4. interaction with lines switch
    • 12.3.5. interaction with check switches
    • 12.3.6. when a file does not exist
  • 12.4. latexindent-yaml-schema.json
    • 12.4.1. VSCode demonstration
  • 12.5. Using conda
    • 12.5.1. Sample conda installation on Ubuntu
  • 12.6. Using docker
    • 12.6.1. Sample docker installation on Ubuntu
    • 12.6.2. How to format on Docker
  • 12.7. pre-commit
    • 12.7.1. Sample pre-commit installation on Ubuntu
    • 12.7.2. pre-commit defaults
    • 12.7.3. pre-commit using CPAN
    • 12.7.4. pre-commit using conda
    • 12.7.5. pre-commit using docker
    • 12.7.6. pre-commit example using -l, -m switches
  • 12.8. indentconfig options
    • 12.8.1. Why to change the configuration location
    • 12.8.2. How to change the configuration location
    • 12.8.3. Linux
    • 12.8.4. Windows
    • 12.8.5. Mac
  • 12.9. paths demonstration
  • 12.10. logFilePreferences
  • 12.11. Encoding
  • 12.12. dos2unix linebreak adjustment
  • 12.13. Differences from Version 2.2 to 3.0