latexindent.pl documentation

• 1. Introduction
  • 1.1. Thanks
  • 1.2. License
  • 1.3. About this documentation
  • 1.4. Quick start
• 2. Demonstration: before and after
• 3. How to use the script
  • 3.1. From the command line
  • 3.2. From arara
• 4. indentconfig.yaml, local settings and the -y switch
  • 4.1. indentconfig.yaml and .indentconfig.yaml
  • 4.2. localSettings.yaml
  • 4.3. The -y|yaml switch
  • 4.4. Settings load order
• 5. defaultSettings.yaml
  • 5.1. The code blocks known latexindent.pl
  • 5.2. noAdditionalIndent and indentRules
    • 5.2.1. Environments and their arguments
    • 5.2.2. Environments with items
    • 5.2.3. Commands with arguments
    • 5.2.4. ifelsefi code blocks
    • 5.2.5. specialBeginEnd code blocks
    • 5.2.6. afterHeading code blocks
    • 5.2.7. The remaining code blocks
      • keyEqualsValuesBracesBrackets
      • namedGroupingBracesBrackets
      • UnNamedGroupingBracesBrackets
      • filecontents
    • 5.2.8. Summary
  • 5.3. Commands and the strings between their arguments
• 6. The -m (modifylinebreaks) switch
  • 6.1. oneSentencePerLine: modifying line breaks for sentences
    • 6.1.1. sentencesFollow
    • 6.1.2. sentencesBeginWith
    • 6.1.3. sentencesEndWith
    • 6.1.4. Features of the oneSentencePerLine routine
  • 6.2. removeParagraphLineBreaks: modifying line breaks for paragraphs
  • 6.3. Poly-switches
  • 6.4. modifyLineBreaks for environments
    • 6.4.1. Adding line breaks using BeginStartsOnOwnLine and BodyStartsOnOwnLine
    • 6.4.2. Adding line breaks using EndStartsOnOwnLine and EndFinishesWithLineBreak
    • 6.4.3. poly-switches only add line breaks when necessary
    • 6.4.4. Removing line breaks (poly-switches set to \(-1\))
    • 6.4.5. About trailing horizontal space
    • 6.4.6. poly-switch line break removal and blank lines
  • 6.5. Poly-switches for other code blocks
  • 6.6. Partnering BodyStartsOnOwnLine with argument-based poly-switches
  • 6.7. Conflicting poly-switches: sequential code blocks
  • 6.8. Conflicting poly-switches: nested code blocks
• 7. Conclusions and known limitations
• 8. References
• 9. Appendices
  • 9.1. Required Perl modules
    • 9.1.1. Module installer script
    • 9.1.2. Manually installed modules
  • 9.2. Updating the path variable
    • 9.2.1. Add to path for Linux
    • 9.2.2. Add to path for Windows
  • 9.3. logFilePreferences
  • 9.4. Differences from Version 2.2 to 3.0