sponsor Vim development Vim logo go to HTTPS page Vim Book Ad

tex-syntax : Vim TeX syntax file

 script karma  Rating 17/5, Downloaded by 336    Comments, bugs, improvements  Vim wiki

created by
gi1242 gi1242
 
script type
syntax
 
description
# vim-tex-syntax

This is a rewrite of the default `syntax/tex.vim` used for [TeX]/[LaTeX], because I finally got fed-up with the default `syntax/tex.vim` file. My main complaints were that syntax folding is painfully slow for large files and doesn't work the way I want. Also spell checking checking missed many things I wanted checked (and erratically failed).

## Features

1. *Syntax folding.*
   If you set `fdm=syntax`, the document will be folded like this:

        +--  6 lines: \documentclass[draft]{amsart}-------------
        \begin{document}
        +-- 27 lines: \title[Continuity theorem for Bernstein tr
        +--169 lines: \section{Introduction.}\label{sxnIntro}---
        +-- 12 lines: \section{Continuity theorem.}\label{sxnCT}
        +--  3 lines: \bibliographystyle{habbrv}----------------
        \end{document}

     Additionally theorems, lemmas, proofs etc. are folded. Additional environment names for folding can be configured using `g:tex_fold_envs`. For one time folds, you can also use the markers `%{{{{` and `%}}}}`. (Note the extra brace, which is added to avoid double folding when editing a file with fold markers.)

     Also syntax folding is about 3 to 4 times faster than the default syntax script shipped with Vim. This only make a difference if you edit large files. On my system, a file with 15,000 lines (and multiple sections / subsections / etc.) takes about 7 seconds to highlight and fold with this script, and it takes about 27 with the Vim default syntax script. (Both scripts are snappy if folding is disabled.)

2. *Spell checking.*
   Most everything that should be spell checked is. Arguments of all commands (except special commands in `g:tex_special_commands`) are spell checked, and arguments of environments (except theorem like environments in `g:tex_thm_envs`) are not spell checked.

3. *Brace matching.*
   Extra open braces in an environment will produce an error in the enclosing `\end{...}` statement. Extra closed braces are flagged. Braces denoting command and script script arguments are highlighted differently.

## Configuration options.

`g:tex_special_commands`
: Space separated list of special commands (e.g. `usepackage`). Arguments of these commands will be colored and not spell checked.

`g:tex_section_commands`
: Space separated list of sectioning commands (e.g. `chapter`).

`g:tex_thm_envs`
: Space separated list of theorem like environments (e.g. `theorem`). Arguments of these commands are spell checked (and not colored).

`g:tex_math_envs`
: Space separated list of environment names that start a math zone (e.g. `equation` etc.),

`g:tex_fold_envs`
: Set this to a space separated list of environment names that should start a fold. For one time folds, you can also use the markers `%{{{{` and `%}}}}`.

`g:tex_isk`
: `iskeyword` option for [TeX]/[LaTeX] files.

## Links

* [Github page](https://github.com/gi1242/vim-tex-syntax)

* [Vim script page](http://www.vim.org/scripts/script.php?script_id=5076)
 
install details
Put tex.vim in ~/.vim/syntax/tex.vim. Set fdm=syntax for folding.
 

Rating scripts is only available on the HTTPS page

script versions (upload new version)

Click on the package to download.

package script version date Vim version user release notes
tex-syntax.tgz 0.1 2014-12-27 7.0 gi1242 gi1242 Initial upload
ip used for rating: 54.166.150.10

If you have questions or remarks about this site, visit the vimonline development pages. Please use this site responsibly.
Questions about Vim should go to the maillist. Help Bram help Uganda.
   
SourceForge.net Logo