TEX-PRETTY 1 "19 June 1995" "Version 0.00" [section 5 of 9]

FORMATTING ACTIONS

• Long lines are wrapped to obey the requested (or default) maximum output line width.
• Text inside LaTeX \begin ... \end environments is indented according to the environment nesting level, except for the outer document environment, which does not cause indentation.
• Brace, bracket, environment, mathematics mode, and parenthesis balance are checked for inconsistencies, except inside verbatim environments. Apart from environments, none of these are expected to contain empty lines signifying a paragraph break.

  If multiple paragraphs really are intended between opening and closing delimiters, you can suppress the warning messages by inserting \par on the empty lines to ensure that TeX sees the paragraph breaks, but tex-pretty does not. However, remember that TeX forbids paragraph breaks inside mathematics mode, so if you inserted blank lines there to improve readability, just change them to empty comment lines.

  For those rare cases where unmatched delimiters are intended, you can eliminate the warning messages by hiding matching delimiters inside comments in the same line or paragraph.

• Newlines are inserted before and/or after important control sequences to improve their visibility.
• Comment percent characters are inserted after open braces at end-of-line, to avoid unwanted space creeping into macro arguments.
• Ties before literature citations are removed; their use is a common error.
• Redundant consecutive newlines are reduced to just two, indicating a paragraph break.
• Whitespace (tabs, formfeeds, line breaks) other than literal space (ISO 8859/ASCII decimal 32) is converted to literal space.
• Redundant consecutive spaces are reduced to just one, or two after sentence-ending punctuation.
• End-of-line spaces are discarded.
• Spaces between certain control sequences and their arguments are discarded. These are cases where the arguments are generally short, and should appear on the same line as the control sequence.
• Backslash-newline is converted to backslash-space-percent-newline. The reason for this change is that automatic line wrapping and filling in text editors can break a backslash-space control sequence at a line boundary, which can potentially change the meaning of a document if backslash-newline is defined differently than backslash-space. Thus, you should not use tex-pretty on files where these two control sequences have different meanings.
• Control sequences (footnotes, glossary, index, label, and cross-reference) that must be tightly bound to the preceding word to avoid the possibility of an intervening space, line break, or page break, are output on a new line, with the preceding line ending with a comment percent character. TeX ignores text from the comment character up to just before the first non-blank character on the next line, so the control sequence is still tightly bound to the preceding word, but is more readable.
• In tabular environments, additional whitespace is produced to line up ampersand column separators at column positions that are multiples of 8, except when the -t command-line option has been specified to force verbatim output.

AmSLaTeX and LaTeX files that adhere to the markup defined in the LaTeX User's Guide and Reference Manual by Leslie Lamport (Addison-Wesley, 1985 (ISBN 0-201-15790-X), 1994 (ISBN 0-201-52983-1)), and the LaTeX Companion by Michel Goossens, Frank Mittelbach, and Alexander Samarin (Addison-Wesley, 1994 (0-201-54199-8)), will benefit most from tex-pretty's processing.