The files

All the files that follow are for VIM version 6.0+ only. Instead of having one big file, I have collected several mappings, functions and ideas from different sources, arranged them to fit my needs and my taste, and split them into several thematic files.

This way, it becomes easier to maintain the whole stuff : ones can download the LaTeX tools ftplugin and bind the different functionalities to his favorite keystrokes ; without having to rebind everything every time a new version of the ftplugin is out. On the other hand, the number of files can gives an justified impression of complexity. It may be annoying to install the whole stuff the first time, but on the long run it's worth the price.

You could also only download lh-tex.tar.gz [27th  January  2004] that contains all the files presented on this page plus the plugins they required and some other bonuses you could find elsewhere like on sourceforge.

Editing stuff

tex-set.vim <raw file> 25th  August  2003 help on : <C-F1>	This file is required by different other TeX ftplugins : it defines some commands that ease the definition of menus and mappings in one function call (acts as a wrapper to menu-map.vim). It also defines different settings (VIM's options) plus mappings and menus that ease the insertion of different LaTeX commands (mainly font attributes) and environments. Like html_set.vim, the macros defined are also available in both normal and visual mode. Moreover, they are quite the same. And this time again, the set of mappings is not exhaustive. Requires help.vim (facultative), menu-map.vim, common_brackets.vim, compiler/tex.vim, vim-tex.sh (recommended), and misc_map.vim. more info...
tex-macros.vim <raw file> 2nd  August  2002	This file is a compilation of functions dedicated to the insertion of different environments and sections. Initially these functions have been writen by Ralf Arens and Tomer Kol. I have slightly patched them to : correctly indent the environnments, make silent insertions, add a dialog box that proposes a list of environments to insert. N.B.: There are only functions : no mappings are provided ; cf. my low coupling fixation between the functions and the keybindings that will differ for every one -- not all keyboards are equal regarding the accessibility of the different keys. In my particular environment, the keybindings for tex-macros.vim can be found in tex-maps.vim. more info...
tex-maps.vim <raw file> 27th  January  2004 help on : <C-L><F1>	This file defines several mappings plus the menus and the help messages associated. The mappings : - call the different tools (from tex-tools.vim), insert environments (tex-macros.vim), and ease the navigation through LaTeX errors. A callback function for the extended modeline functionality is also defined : it permits to define the name of the main file for the current document. Built on top of : tx_macros.vim and TKLaTeX.vim. more info...
texmenus.vim <raw file> 23rd  July  2002	The texmenus file defined and maintained by other people, but with specific alterations to fit my taste and my keyboard. I still have future plans for this file.
tex-smart_chars.vim <raw file> 7th  July  2003	This file is a compilation of other well known smart mappings for LaTeX. You will found in this file : a smart quote function (from Benji Fisher), a smart dots function (... -> \dots), a smart <BS> function (Lubomir Host's patch), and a smart underscore function : _ -> \_ in default context, _ -> _ in math context, __ -> _{}^{«»}«» in math context, N.B.: If you want to use the smart-dots, uncomment the corresponding mapping -- I never use ..., but \etc instead. Smart-underscore can take advantage of common_brackets.vim, and misc_map.vim if installed. more info...

tex-tools.vim <raw file> 27th  January  2004	Here is a big piece of ftplugin. It defines commands that will compile LaTeX files, transform them and view the results. Well quite common, isn't it ? Except that it checks dependencies (tex->dvi->ps & other combinaisons involving pdf) ; re-run latex if references have changed (number of pages, labels, etc) ; run bibtex if there are bibliographic entries ; run makeindex if needed. May be not every possible case is taken into account, but a lot are. You can thanks Tomer Kol for the first version of this ftplugin. I've just reorganised different stuff and extend some functionnalities. This version has been tested under a PC under WindowsNT with Zsh and cmd32 -- I had some troubles with my installation of cygwin-bash to run ps2pdf. It should works under unixes with no modifications. Unfortunately the todo list is not empty and many things are still to be done like a full documentation. I strongly recommend you use vim-tex.sh (my little patch for e/=\(pdf\)\=\(la\)\=tex over Srinath Avadhanula shell script) to filter error messages -- facultative nevetheless. And you have to use "my" version of compiler/tex.vim -- or at least a version that defines the command TeXSetEFM in order to assign the errorformat option of vim. more info...
tex.vim <raw file> 28th  May  2002	This is the tex compiler file defined by Artem Chuprina and then customized by Srinath Avadhanula. My contribution is to define a command (TeXSetEFM) that could be invoked without needing to re-source the file. Why ? because latex needs one errorformat, while bibtex, makeindex, dvips and ps2pdf need other particular values for this VIM setting.
vim-tex.sh <raw file> 9th  October  2002	This shell script pre-parses latex errors before VIM parses them again. This is just a little patch over Srinath Avadhanula's version in order to be able to execute other programs than latex (like pdftex, etex, etc.). I also tried to find a way to return the shell error from latex (/the first compilation tool executed). tex-tools.vim will search for this shell script into two folders accessible from your vim-runtime path : tools and compiler ; or into your $PATH directories. To do so, tex-tools.vim requires searchInRuntime.vim. Of course, if you are under windows like I am, it requires you use a true shell. Note that this shell script requires sed and cat. Don't forget to correct the first line of the script to match the location of your bourne-shell interpreter.

Some settings
Commands for other tex ftplugin (help & menu+map)
Command for customizing the character delimiter used by \verb
Loads my spellchecker plugin
Generic menu & maps (+ help messages) to insert different LaTeX commands and environments ; they work in the three modes (insert, visual and normal) and an exhaustive list can be obtained by hitting <C-F1> -- help.vim required.
In the future, different things may fusion with texmenus.vim

Some features en vrac...

• dependencies checked when producing any new documentation,
• \(pdf\)\=latex automatically re-run when needed
• bibtex, makeindex automatically invoked if required
• can produces dvi, ps, pdf (with pdflatex or from ps) ; no support for html (Tex4ht, ...)
• can invoke the different viewers in interactive mode if possible ; BTW, you have to check the function s:TKSetDefaultProgNames(), to be sure your environment matches the default programs I propose.
• enhanced error format used if the appropriate scripts are present on your system.
• You can specify the main file of your (La)TeX project in two ways : - Srinath Avadhanula's way using, in the current directory, a file named <{main-file-name}.latexmain> ; - or by setting the global variable : g:TeXfile (my let-modeline plugin can be of a great help with this approach).
To conclude : take a look at the comments at the top and at the bottom of the file if have have troubles, or contact me.

Can support Benji Fisher's aux2tags.vim ftplugin if found on the system ; i.e. provide a keybinding to directly invoke the parser command.
Can support Michael Geddes's bufferoption.vim plugin if found on the system and if desired (g:want_buffer_menu_for_tex == 1).
Provides two new commands used by itself and texmenus.vim to ease the definition of buffer-relative mappings and menus.

Back to the ftplugins page

hermitte at free.fr