Skip to content

Latest commit

 

History

History
61 lines (44 loc) · 2.45 KB

README.md

File metadata and controls

61 lines (44 loc) · 2.45 KB
Raw

LaTeXFmt is a LaTeX-aware Vim formatter.

LaTeXFmt is a vim plugin for formatting paragraphs and other text selections in LaTeX files. It allows fine-grained control over lines containing keywords, commands, and environments. Here's an example:

Before creating this gif, I mapped 'K' to <Plug>latexfmt_format. In absence of a count or visual selection, the command formats the current paragraph. One might note several things about the way the paragraphs are formatted:

  1. In the first paragraph, nothing inside the align environment is formatted. That behavior is customizable, however.
  2. In the second paragraph, the individual items in the itemize environment are formatted while newlines after each item are retained. That behavior is also customizable.
  3. In both paragraphs, the cursor is at the same 'logical' position after formatting as before.
  4. In both paragraphs, multiple spaces outside the align environment collapse to a single space (except at the ends of sentences).

Installation

If you use pathogen or the native vim package manager, simply clone this repository to the appropriate directory. If you're using a more configurable package manager, you'll know what to do.

Configuration

LaTexFmt takes its instructions for how to format from a set of lists. To reproduce the behavior above, it is enough to define, in your .vimrc or elsewhere in your runtime path,

let g:latexfmt_no_join_any = [ '%', '\begin, '\end', '\vspace', '\noindent' ] 

let g:latexfmt_no_join_prev = [ '\item' ] 

let g:latexfmt_verbatim_envs = [ 'align' ]

The first list contains strings that prevent lines containing them from joining the following or previous lines, the second contains strings that prevent them from joining the previous lines but allow them to join the following lines (there is also a list named g:latexfmt_no_join_next that does the opposite), and the third contains environments that LaTeXFmt leaves completely alone. The default lists include more strings than those here, but are still pretty minimal. You'll probably want to construct your own lists.

Acknowledgment

This plugin is essentially a rewrite and extension of the inspirational script by 'lpb612,' at https://www.vim.org/scripts/script.php?script_id=2307. I thank that author for the inspiration.

For more information, type :help latexfmt.