latexindent.pl documentation
- 1. Introduction
- 2. Demonstration: before and after
- 3. How to use the script
- 4. indentconfig.yaml, local settings and the -y switch
- 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.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. Features of the oneSentencePerLine routine
- 6.2.6. oneSentencePerLine: text wrapping and indenting sentences
- 6.2.7. oneSentencePerLine: text wrapping and indenting sentences, when before/after
- 6.2.8. 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.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
- 6.3.1. Poly-switches for environments
- 6.1. Text Wrapping
- 7. The -r, -rv and -rr switches
- 8. The –lines switch
- 9. Fine tuning
- 10. Conclusions and known limitations
- 11. References
- 12. Appendices
- 12.1. Required Perl modules
- 12.2. Updating the path variable
- 12.3. Batches of files
- 12.4. latexindent-yaml-schema.json
- 12.5. Using conda
- 12.6. Using docker
- 12.7. pre-commit
- 12.8. indentconfig options
- 12.9. logFilePreferences
- 12.10. Encoding indentconfig.yaml
- 12.11. dos2unix linebreak adjustment
- 12.12. Differences from Version 2.2 to 3.0