*vimtex.txt* LaTeX plugin for Vim version 7.3 (and above) *vimtex* *latex* Author: Karl Yngve Lervåg License: MIT license {{{ Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. }}} ============================================================================== CONTENTS *vimtex-contents* 1. Intro ................................ |vimtex-intro| 2. Main interface ....................... |vimtex-main| 3. Default mappings ..................... |vimtex-mappings| 4. Commands ............................. |vimtex-commands| 5. Options .............................. |vimtex-options| 6. Omni completion ...................... |vimtex-completion| 7. Folding .............................. |vimtex-folding| 8. Indentation .......................... |vimtex-indent| 9. Latexmk .............................. |vimtex-latexmk| Latexmk tricks ....................... |vimtex-latexmk-tricks| Lacheck .............................. |vimtex-latexmk-lacheck| 10. View ................................. |vimtex-view| synctex .............................. |vimtex-synctex| 11. Motion ............................... |vimtex-motion| 12. Change ............................... |vimtex-change| 13. Table of contents .................... |vimtex-toc| 14. Utility functions .................... |vimtex-util| 15. Function reference ................... |vimtex-functions| 16. FAQ .................................. |vimtex-faq| 17. Credits .............................. |vimtex-credits| 18. Changelog ............................ |vimtex-changelog| ============================================================================== INTRO *vimtex-intro* |vimtex| provides functionality for editing LaTeX documents. The goal has been to create a minimalistic and functional plugin that is easy to customize and evolve. Most of the functionality provided is turned on by default, but the user may turn off features that are not desired. Note that vim itself ships with syntax hightlighting for LaTeX documents, please see |ft-tex-plugin| and |ft-tex-syntax|. |vimtex| does not provide its own syntax highlighting, but does expand it a little bit. *vimtex-requirements* Some of the functionalities of |vimtex| has certain requirements: |vimtex-latexmk| Requires that the user has installed both `latexmk` and `pgrep`. If these are not available, then the functionalities provided by |vimtex-latexmk| will not be available. If you use Vim under a terminal in Linux or MacOS, then Vim must be started as a command server with the command line option `--servername`, e.g. `vim --servername VIM`. For different ways of ensuring this, see: http://vim.wikia.com/wiki/Enable_servername_capability_in_vim/xterm |vimtex-completion| The function |vimtex#complete#bibtex| requires `bibtex` and `kpsewhich` to parse bib files for bibliography completion. ============================================================================== MAIN INTERFACE *vimtex-main* The |vimtex| interface is based on the |autoload| feature of vim. For each new latex buffer, the function *vimtex#init* initializes the variables and functionalities based on the desired options |vimtex-options|. The first run performs some global initialization, which is mainly to define autocommands. Other functionality is provided by additional autoloaded scripts, such as |vimtex-latexmk|. Every additional script should have an initialization script that sets default mappings, creates autocommands and performs other necessary initialization. This initialization script is then called from |vimtex#init|. The main interface provides some basic functionality. |vimtex#help| lists all `vimtex` mappings defined for the current buffer, by default mapped to 'lh'. If the default mappings are used, |vimtex#help| will display them. |vimtex#info| echoes the contents of |g:vimtex#data| and |b:vimtex|. This is useful mainly for debugging. Finally, |vimtex#reinit| clears the current data in |g:vimtex#data| and |b:vimtex|, stops running `latexmk` processes |vimtex#latexmk#stop_all|, and then performs a new initialization with |vimtex#init|. For each latex project that is opened, a |Dictionary| is created and added to the list |g:vimtex#data|. The dictionary is initialized with information tied to the current project, mainly the different associated file names. In addition, a dictionary is created for every buffer |b:vimtex|. This contains data that is specific to the current buffer, most importantly it contains the ID of the main latex project. This combination of local and global data enables |vimtex| to work properly for multi-file latex projects. It also allows the editing of different latex projects simultaneously in different buffers. *g:vimtex#data* A |List| of |Dictionaries|, each containing data specific to a given latex project. The ID of a latex project is the index of its dictionary in the list. An example of a dictionary is given here: > { 'pid': 0, 'name': 'main', 'base': 'main.tex', 'root': '/some/path', 'tex': '/some/path/main.tex', 'aux': function('202'), 'log': function('203'), 'out': function('204'), } Which entries are present in a given dictionary depends on the current settings. For example, the entry `pid` is only available if |vimtex-latexmk| is enabled |g:vimtex_latexmk_enabled|. Note that some of the file entries are functions. The functions are used to find the files when necessary, in case they do not exist when the latex file is opened. All defined dictionaries can be printed with the function |vimtex#info|, by default mapped to 'li'. *b:vimtex* For each buffer, |vimtex| defines a |Dictionary| that contains buffer local information. An example of such a dictionary is: > { 'id': 0, 'fold_sections': [], } The most important entry is `id`, which is the index of the corresponding entry in the list of latex projects |g:vimtex#data|. Other entries may also be exist, such as `fold_sections`. The dictionary can be printed with the function |vimtex#info|, by default mapped to 'li'. Functions: |vimtex#info| |vimtex#help| |vimtex#reinit| ------------------------------------------------------------------------------ Support for multi-file projects:~ *vimtex-multi-file* *tex-root* |vimtex| supports multi-file documents in the sense that the plugin automatically detects the root file of the project. This detection is based on a recursive search for files that include the current tex file, until a main file is recognized. A file is assumed to be the main file if it has the `\begin{document}` line. Files are assumed to live in the same folder or a parent folder of the current file. This should work in most cases, but it may fail if for instance the project structure is something like this: > path1/main.tex path2/chapter.tex That is, the main file detection will not work for the file `chapter.tex`, because the main file does not live in the same folder or a parent folder. It is also possible to specify the main TeX file with a comment in one of the first five lines of the current file similar to this: > %! TEX root = my-main.tex ============================================================================== DEFAULT MAPPINGS *vimtex-mappings* The default mappings for |vimtex| are given below. See 'map-listing' for an explanation of the format. The function |vimtex#help| is provided for convenience to list all the defined mappings, and it is by default mapped to 'lh'. The default mappings may be disabled with the option |g:vimtex_mappings_enabled|, if the user wishes to create his/her own mappings. n % *@:call vimtex#motion#find_matching_pair() v % *@:call vimtex#motion#find_matching_pair(1) o % *@:normal v% v a$ *@:call vimtex#motion#select_inline_math() v i$ *@:call vimtex#motion#select_inline_math(1) o a$ *@:normal va$ o i$ *@:normal vi$ v ae *@:call vimtex#motion#select_environment() v ie *@:call vimtex#motion#select_environment(1) o ae *@:normal vae o ie *@:normal vie v ad *@:call vimtex#motion#select_delimiter() v id *@:call vimtex#motion#select_delimiter(1) o ad *@:normal va( o id *@:normal vi( n [[ *@:call vimtex#motion#next_sec(0,1,0) n [] *@:call vimtex#motion#next_sec(1,1,0) n ][ *@:call vimtex#motion#next_sec(1,0,0) n ]] *@:call vimtex#motion#next_sec(0,0,0) v [[ *@:call vimtex#motion#next_sec(0,1,1) v [] *@:call vimtex#motion#next_sec(1,1,1) v ][ *@:call vimtex#motion#next_sec(1,0,1) v ]] *@:call vimtex#motion#next_sec(0,0,1) o [[ *@:normal v[[ o [] *@:normal v[] o ][ *@:normal v][ o ]] *@:normal v]] n li *@:call vimtex#info() n lh *@:call vimtex#help() n lR *@:call vimtex#reinit() n lt *@:call vimtex#toc#open() n lT *@:call vimtex#toc#toggle() n ll *@:call vimtex#latexmk#toggle() n lk *@:call vimtex#latexmk#stop(1) n lK *@:call vimtex#latexmk#stop_all() n le *@:call vimtex#latexmk#errors() n lo *@:call vimtex#latexmk#output() n lg *@:call vimtex#latexmk#status() n lG *@:call vimtex#latexmk#status(1) n lc *@:call vimtex#latexmk#clean() n lC *@:call vimtex#latexmk#clean(1) n lv *@:call vimtex#view#view() n lr *@:call vimtex#view#rsearch() n zx *@:call vimtex#fold#refresh() n dse *@:call vimtex#change#env('') n cse *@:call vimtex#change#env_prompt() n dsc @ds}dF\ n csc *@:call vimtex#change#command() n tse *@:call vimtex#change#toggle_env_star() n tsd *@:call vimtex#change#toggle_delim() n *@:call vimtex#change#to_command()i i *@:call vimtex#change#to_command() i ]] *@:call vimtex#change#close_environment() ============================================================================== COMMANDS *vimtex-commands* |vimtex| is mainly based on a function API as described in the section |vimtex-functions|. However, commands are also defined for convenience. Below the commands are listed in alphabetical order. *VimtexClean* call vimtex#latexmk#clean(0) *VimtexClean!* call vimtex#latexmk#clean(1) *VimtexCompile* call vimtex#latexmk#compile() *VimtexCompileSS* call vimtex#latexmk#compile_singleshot(0) *VimtexCompileSS!* call vimtex#latexmk#compile_singleshot(1) *VimtexCompileToggle* call vimtex#latexmk#toggle() *VimtexErrors* call vimtex#latexmk#errors() *VimtexHelp* call vimtex#help() *VimtexInfo* call vimtex#info() *VimtexLacheck* call vimtex#latexmk#lacheck() *VimtexOutput* call vimtex#latexmk#output() *VimtexRefreshFolds* call vimtex#fold#refresh() *VimtexReinitialize* call vimtex#reinit() *VimtexStatus* call vimtex#latexmk#status(0) *VimtexStatus!* call vimtex#latexmk#status(1) *VimtexStop* call vimtex#latexmk#stop() *VimtexStopAll* call vimtex#latexmk#stop_all() *VimtexTocOpen* call vimtex#toc#open() *VimtexTocToggle* call vimtex#toc#toggle() *VimtexView* call vimtex#view#view() *VimtexRSearch* call vimtex#view#rsearch() ============================================================================== OPTIONS *vimtex-options* This section describes the options for |vimtex|. The options are first listed in alphabetical order, before they are described in more detail. The descriptions also list the default values. Overview:~ |g:vimtex_enabled| |g:vimtex_complete_close_braces| |g:vimtex_complete_enabled| |g:vimtex_complete_recursive_bib| |g:vimtex_complete_patterns| |g:vimtex_fold_enabled| |g:vimtex_fold_automatic| |g:vimtex_fold_envs| |g:vimtex_fold_parts| |g:vimtex_fold_preamble| |g:vimtex_fold_sections| |g:vimtex_indent_enabled| |g:vimtex_latexmk_build_dir| |g:vimtex_latexmk_callback| |g:vimtex_latexmk_enabled| |g:vimtex_latexmk_continuous| |g:vimtex_latexmk_background| |g:vimtex_latexmk_options| |g:vimtex_mappings_enabled| |g:vimtex_motion_enabled| |g:vimtex_motion_matchparen| |g:vimtex_quickfix_autojump| |g:vimtex_quickfix_ignored_warnings| |g:vimtex_quickfix_ignore_all_warnings| |g:vimtex_quickfix_mode| |g:vimtex_toc_enabled| |g:vimtex_toc_fold_levels| |g:vimtex_toc_fold| |g:vimtex_toc_hide_help| |g:vimtex_toc_hide_preamble| |g:vimtex_toc_hide_line_numbers| |g:vimtex_toc_numbers| |g:vimtex_toc_numbers_width| |g:vimtex_toc_resize| |g:vimtex_toc_secnumdepth| |g:vimtex_toc_split_pos| |g:vimtex_toc_width| |g:vimtex_view_enabled| |g:vimtex_view_general_viewer| |g:vimtex_view_general_options| |g:vimtex_view_method| |g:vimtex_view_mupdf_options| |g:vimtex_view_okular_options| |g:vimtex_view_sumatrapdf_options| ------------------------------------------------------------------------------ Detailed descriptions and default values:~ *g:vimtex_enabled* If this variable exists and is 0, then |vimtex| is completely disabled. By default, it is not defined. *g:vimtex_complete_close_braces* When a label or a cite has been completed, this option controls whether it will be followed by a closing brace. > let g:vimtex_complete_close_braces = 0 < *g:vimtex_complete_enabled* Use this option to prevent the plugin from setting the 'omnifunc': > let g:vimtex_complete_enabled = 1 < *g:vimtex_complete_recursive_bib* This option toggles recursive searching for bibliography files. Note that this option may lead to a significant slowdown for large projects if enabled. > let g:vimtex_complete_recursive_bib = 0 < *g:vimtex_complete_patterns* Define patterns that control when the label and citation completion is triggered. > let g:vimtex_complete_patterns = { \ 'ref' : '\C\\v\?\(eq\|page\|[cC]\)\?ref\*\?\_\s*{[^{}]*', \ 'bib' : '\C\\\a*cite\a*\*\?\(\[[^\]]*\]\)*\_\s*{[^{}]*', \ }) < *g:vimtex_fold_enabled* Use this option to disable/enable folding. > let g:vimtex_fold_enabled = 1 < *g:vimtex_fold_automatic* Set manual or automatic updating of fold levels. For manual mode, one must use the |zx| mapping to update the foldlevels when desired. For automatic mode, the fold levels will be updated automatically. Beware that this may lead to some minor lags for large files. > let g:vimtex_fold_automatic = 1 < *g:vimtex_fold_envs* Decide whether environments should be folded or not. > let g:vimtex_fold_envs = 1 < *g:vimtex_fold_parts* List of parts that should be folded. > let g:vimtex_fold_parts = [ \ "appendix", \ "frontmatter", \ "mainmatter", \ "backmatter", \ ] < *g:vimtex_fold_preamble* Decide whether preamble should be folded or not. > let g:vimtex_fold_preamble = 1 < *g:vimtex_fold_sections* List of section constructs that should be folded. > let g:vimtex_fold_sections = [ \ "part", \ "chapter", \ "section", \ "subsection", \ "subsubsection", \ ] < *g:vimtex_indent_enabled* Use |vimtex| indentation function. Not as customizable as the official indentation function, but imho it is better. > let g:vimtex_indent_enabled = 1 < *g:vimtex_indent_bib_enabled* Use |vimtex| indentation function for bibliography files. > let g:vimtex_indent_bib_enabled = 1 < *g:vimtex_latexmk_build_dir* Set this variable in case a dedicated build dir is used with `latexmk`/`latex` compilations. > let g:vimtex_latexmk_build_dir = '.' < *g:vimtex_latexmk_callback* If enabled, this option tells `latexmk` to run |vimtex#latexmk#errors| after compilation is finished. Note that this feature only works if vim is compiled with the |+clientserver| option. > let g:vimtex_latexmk_callback = 1 < *g:vimtex_latexmk_enabled* Whether to enable the `latexmk` interface or not. Note that even if it is not enabled, the autoload functions will be available. However, the necessary variables and autocommands will not be defined, and the mappings will not be created. > let g:vimtex_latexmk_enabled = 1 < *g:vimtex_latexmk_background* If continuous mode is disabled, then this option may be used to set whether single compilations should be run in the foreground or the background. > let g:vimtex_latexmk_background = 0 < *g:vimtex_latexmk_continuous* If enabled, `latexmk` will run in continuous mode. This means that the document is compiled every time a document file has been changed. Set to 0 to disable. Note that the callback functions only work if continuous mode is enabled. > let g:vimtex_latexmk_continuous = 1 < *g:vimtex_latexmk_options* Set desired options for `latexmk` compilation. Note that options may also be specified indirectly through a `.latexmkrc` file. > let g:vimtex_latexmk_options = '-pdf' < *g:vimtex_quickfix_autojump* Whether to automatically jump to the first error whenever the |quickfix| window is opened. > let g:vimtex_latexmk_autojump = 0 < *g:vimtex_quickfix_ignore_all_warnings* If enabled, all LaTeX warnings are ignored and will not be listed in the quickfix window. LaTeX errors will of course still be listed. > let g:vimtex_quickfix_ignore_all_warnings = 0 < *g:vimtex_quickfix_ignored_warnings* List of warning messages that should be ignored. By default, the list is empty, thus no warnings are ignored. The list is a list of strings. Any LaTeX warning that contains a string in the list will be ignored. To ignore some common LaTeX warnings, try the following setting: > let g:vimtex_quickfix_ignored_warnings = [ \ 'Underfull', \ 'Overfull', \ 'specifier changed to', \ ] < *g:vimtex_quickfix_mode* This option controls the behaviour of the quickfix window in case errors and/or warnings are found. The recognized options are: Value Effect ~ 0 The quickfix window is never opened automatically. 1 The quickfix window is opened automatically when there are errors, and it becomes the active window. 2 The quickfix window is opened automatically when there are errors, but it does not become the active window. The default value is: > let g:vimtex_quickfix_mode = 2 < *g:vimtex_quickfix_open_on_warning* If it is 0, then the quickfix window will only be opened on errors or when it is forced open. > let g:vimtex_quickfix_open_on_warning = 1 < *g:vimtex_mappings_enabled* Whether to load the default mappings. If this is set to 0, then no mappings will be defined. Since all of the functionality is available as functions, this allows the user to define his or her own mappings. > let g:vimtex_mappings_enabled= 1 < *g:vimtex_motion_enabled* Whether to enable the motion interface. If it is disabled, then neither the default mappings nor the autocommands that enable highlighting of matching parens will be defined. > let g:vimtex_motion_enabled = 1 < *g:vimtex_motion_matchparen* Enable highlighting of matching parens. This gives better support for LaTeX, but disables the builtin |matchparen|. > let g:vimtex_motion_matchparen = 1 < *g:vimtex_toc_enabled* Enable interface for TOC. If it is disabled, then mappings for the TOC will not be created. > let g:vimtex_toc_enabled = 1 < *g:vimtex_toc_fold_levels* If TOC entries are folded, this option controls the number of fold levels that will be used. > let g:vimtex_toc_fold_levels = 0 < *g:vimtex_toc_fold* Turn on folding of TOC entries. > let g:vimtex_toc_fold = 0 < *g:vimtex_toc_hide_help* Allow the TOC help text to be hidden. > let g:vimtex_toc_hide_help = 0 < *g:vimtex_toc_hide_preamble* If enabled, the start of the preamble is not shown in the TOC. > let g:vimtex_toc_hide_preamble = 0 < *g:vimtex_toc_hide_line_numbers* If enabled, line numbers will be hidden in the TOC window. That is, |nonumber| and |norelativenumber| will be set locally for the TOC window. > let g:vimtex_toc_hide_line_numbers = 1 < *g:vimtex_toc_numbers* Toggle display of numbers in TOC. The numbers may also be toggled inside the TOC window with the `s` keybinding. > let g:vimtex_toc_numbers = 1 < *g:vimtex_toc_numbers_width* Set display width of numbers in TOC. If 0, the width is set based on the section depth. > let g:vimtex_toc_numbers_width = 0 < *g:vimtex_toc_resize* Automatically resize vim when the TOC window is opened. > let g:vimtex_toc_resize = 1 < *g:vimtex_toc_secnumdepth* Define number of section levels to display. Set level corresponding to the desired latex variable `secnumdepth`. Note that the variable may be updated directly through the TOC window. For more info on `secnumdepth` see e.g. http://en.wikibooks.org/w/index.php?title=LaTeX/Document_Structure > let g:vimtex_toc_secnumdepth = 3 < *g:vimtex_toc_split_pos* Define where the TOC window is opened. > let g:vimtex_toc_split_pos = 'vert leftabove' < *g:vimtex_toc_width* Set width of TOC window. > let g:vimtex_toc_width = 30 < *g:vimtex_view_enabled* Enable interface for view functionality. > let g:vimtex_view_enabled = 1 < *g:vimtex_view_general_viewer* Set general viewer. > let g:vimtex_view_general_viewer = 'xdg-open' < *g:vimtex_view_method* Set viewer method. If not set or set to `general`, it uses the general viewer, see |g:vimtex_view_general_viewer|. > let g:vimtex_view_method = '' The currently available choices are: > general mupdf okular sumatrapdf < *g:vimtex_view_general_options* *g:vimtex_view_mupdf_options* *g:vimtex_view_okular_options* *g:vimtex_view_sumatrapdf_options* Set custom options for the given viewer. > let g:vimtex_view_general_options = '' let g:vimtex_view_mupdf_options = '' let g:vimtex_view_okular_options = '' let g:vimtex_view_sumatrapdf_options = '' < *g:vimtex_view_mupdf_send_keys* String of keys sent to MuPDF after the PDF file has been opened. The keys are sent by the function |vimtex#view#mupdf_poststart|. > let g:vimtex_view_mupdf_send_keys = '' < ============================================================================== OMNI COMPLETION *vimtex-completion* |vimtex| provides an 'omnifunc' for omni completion, see |compl-omni| and |vimtex#complete#omnifunc|. The function is enabled by default, but may be disabled with |g:vimtex_complete_enabled|. Omni completion is accessible with |i_CTRL-X_CTRL-O|. The omni function completes labels and citations. The completion candidates are gathered with the functions |vimtex#complete#labels| and |vimtex#complete#bibtex|. If |g:vimtex_complete_close_braces| is set to 1, then the completion includes closing braces. Associated settings: |g:vimtex_complete_enabled| |g:vimtex_complete_patterns.ref| |g:vimtex_complete_patterns.bib| |g:vimtex_complete_close_braces| |g:vimtex_complete_recursive_bib| Functions: |vimtex#complete#omnifunc| |vimtex#complete#labels| |vimtex#complete#bibtex| ------------------------------------------------------------------------------ Complete labels~ Label completion is triggered by '\ref{' commands as defined with |g:vimtex_complete_patterns.ref|. The completion parses every relevant aux file to gather the completion candidates. This is important to note, because it means that the completion only works when the LaTeX document has been compiled. As an example: > \ref{sec: offers a list of all matching labels, with their associated value and page number. The label completion matches: 1. labels: > \ref{sec: < 2. numbers: > \eqref{2 < 3. labels and numbers together (separated by whitespace): > \eqref{eq 2 ------------------------------------------------------------------------------ Complete citations~ Citation completion is triggered by '\cite{' commands as defined with |g:vimtex_complete_patterns.bib|. The completion parses included bibliography files (`*.bib`) and `thebibliography` environments to gather the completion candidates. As an example, assume that a bibliography file is included with the following entry: > @book { knuth1981, author = "Donald E. Knuth", title = "Seminumerical Algorithms", publisher = "Addison-Wesley", year = "1981" } Then the bibliography key `knuth1981` will be completed with e.g.: > \cite{Knuth 1981 \cite{algo \cite{Don.*Knuth In particular, note that regular expressions (or vim patterns) can be used after '\cite{' to search for candidates. ============================================================================== FOLDING *vimtex-folding* |vimtex| can fold texts according to LaTeX structure (part, chapter, section and subsection). Folding is turned on by default, but it can be disabled if desired |g:vimtex_fold_enabled|. When folding is turned on and a LaTeX document is opened, the document is parsed once in order to define the highest fold level based on which parts (such as frontmatter, backmatter, and appendix) and section types (chapter, section, etc.) are present. If the document has been edited and a new fold level is required (or has become redundant), then |vimtex#fold#refresh| can be used to refresh the fold level settings. This function is mapped by default to 'zx'. Associated settings: |g:vimtex_fold_enabled| |g:vimtex_fold_automatic| |g:vimtex_fold_preamble| |g:vimtex_fold_parts| |g:vimtex_fold_sections| |g:vimtex_fold_envs| Functions: |vimtex#fold#level| |vimtex#fold#text| |vimtex#fold#refresh| ============================================================================== INDENTATION *vimtex-indent* The official indentation function is pretty good and allows for some customization. However, I am not quite satisfied, so I wrote my own indentation function that is not customizable, but that I think is better. It is enabled by default, but may be disabled if desired. *vimtex-bib-indent* I've also written an indentation file for bibliography files (`.bib` files). Associated settings: |g:vimtex_indent_enabled| |g:vimtex_indent_bib_enabled| ============================================================================== LATEXMK *vimtex-latexmk* |vimtex| provides a basic interface to `latexmk` for compilation. The interface may be disabled with |g:vimtex_latexmk_enabled|. The default mappings are: > nnoremap ll :call vimtex#latexmk#toggle() nnoremap lk :call vimtex#latexmk#stop() nnoremap lK :call vimtex#latexmk#stop_all() nnoremap le :call vimtex#latexmk#errors() nnoremap lo :call vimtex#latexmk#output() nnoremap lg :call vimtex#latexmk#status(0) nnoremap lG :call vimtex#latexmk#status(1) nnoremap lc :call vimtex#latexmk#clean(0) nnoremap lC :call vimtex#latexmk#clean(1) Compilation is started with |vimtex#latexmk#compile| or may be toggled by |vimtex#latexmk#toggle|. The default behaviour uses preview continuous mode of `latexmk`, which may be disabled with |g:vimtex_latexmk_continuous|. If it is disabled, then the option |g:vimtex_latexmk_background| may be used to decide if single shot compilation should run in the foreground or the background. Single shot compilation may always be issued with the function |vimtex#latexmk#compile_singleshot|. This function ignores the |g:vimtex_latexmk_background|` setting, though, and will by default hide the output from the `latexmk` command. The function is available through the command |VimtexCompileSS|, and if desired one may create a custom mapping such as > nnoremap ls :VimtexCompileSS A banged version of the command also exists, which will provide a more verbose output. If vim is compiled with the |+clientserver| option and if |g:vimtex_latexmk_callback| is enabled, then compilation errors are parsed automatically. This is done by utilizing the tricks explained in |vimtex-latexmk-tricks|. Note however that this only works for continuous compilation mode. To check for and view errors in the quickfix window, use |vimtex#latexmk#errors|. To check if background compilation is running, use |vimtex#latexmk#status|. Associated settings: |g:vimtex_latexmk_enabled| |g:vimtex_latexmk_callback| |g:vimtex_latexmk_autojump| |g:vimtex_latexmk_continuous| |g:vimtex_latexmk_background| |g:vimtex_latexmk_options| Functions: |vimtex#latexmk#clean| |vimtex#latexmk#compile| |vimtex#latexmk#compile_singleshot| |vimtex#latexmk#errors| |vimtex#latexmk#lacheck| |vimtex#latexmk#output| |vimtex#latexmk#status| |vimtex#latexmk#stop| |vimtex#latexmk#stop_all| |vimtex#latexmk#toggle| ------------------------------------------------------------------------------ *vimtex-latexmk-tricks* Latexmk tricks~ `latexmk` allows to set options through a configuration file `$HOME/.latexmkrc`. A particular set of options are very convenient for a good coupling between |vimtex| and `latexmk`: `$..._cmd`, where `...` refers to either `compiling`, `success`, or `failure`. These options can be used to specify commands that are run by `latexmk` before and after a compilation run. For instance, one may use these options: > $compiling_cmd = "xdotool search --name \"%D\" " . "set_window --name \"%D compiling...\""; $success_cmd = "xdotool search --name \"%D\" " . "set_window --name \"%D OK\"; " . "gvim --remote-expr 'vimtex#latexmk#callback(1)'"; $failure_cmd = "xdotool search --name \"%D\" " . "set_window --name \"%D FAILURE\"; " . "gvim --remote-expr 'vimtex#latexmk#callback(0)'"; Here `xdotool` (http://www.semicomplete.com/projects/xdotool/) is used to change the title of the pdf viewer during and after compilation. In addition, |vimtex#latexmk#errors| is called through the |clientserver| after each run to either open the quickfix window when there are errors/warnings, or to close the quickfix window in case all errors/warnings are gone. The latter trick is utilized in |vimtex| to automatically run the callback commands if vim has the option |+clientserver|, and if the option |g:vimtex_latexmk_callback| is enabled. The command that is used by `latexmk` is then on the following form: > gvim --servername v:servername --remote-expr 'vimtex#latexmk#callback(0)' This command is then appended to the existing `$success_cmd` and `$failure_cmd`. Note that if the existing commands are not empty, then they must end with a semicolon in order to allow |vimtex| to append safely. ------------------------------------------------------------------------------ *vimtex-latexmk-lacheck* Lacheck~ After compilation of a LaTeX document, the log file will contain errors that are parsed by |vimtex| as explained above. However, there are a syntax checkers for LaTeX, and we here provide a simple interface to `lacheck` for checking your LaTeX manuscript for errors. Your manuscript may be checked using `lacheck` with the command `VimtexLacheck`. ============================================================================== VIEW *vimtex-view* |vimtex| provides functions for viewing the compiled documents. A command and a mapping is defined for the multipurpose `view` function, which calls the chosen view method defined by |g:vimtex_view_method|. Associated settings: |g:vimtex_view_enabled| |g:vimtex_view_general_viewer| |g:vimtex_view_general_options| |g:vimtex_view_method| |g:vimtex_view_mupdf_options| |g:vimtex_view_okular_options| |g:vimtex_view_sumatrapdf_options| Functions: |vimtex#view#general| |vimtex#view#mupdf| |vimtex#view#mupdf_rsearch| |vimtex#view#okular| |vimtex#view#sumatrapdf| ------------------------------------------------------------------------------ SYNCTEX SUPPORT *vimtex-synctex* Synctex is a tool that enables synchronization of the text editor position and the pdf viewer position. The tool may be used to add mappings in vim to go to the current position in the compiled pdf document (forward search), and also to go from a specific position in the pdf file to the corresponding position in vim (inverse/backward search). To make synctex work, one must enable synctex manually by adding the line > $pdflatex = 'pdflatex -synctex=1 %O %S'; to `~/.latexmkrc`. Forward search~ |vimtex| currently supports forward search for a limited set of viewers. The functionality is enabled by choosing the desired viewer with the |g:vimtex_view_method| option. The currently supported viewers are: * MuPDF * Okular * SumatraPDF * Zathura Backward search~ Backward or inverse search is typially set up inside the specific viewer through an option named something like "inverse search command-line". A standard value for the option is: > gvim --remote-silent +%l "%f" Backward search is unfortunately not supported by all pdf viewers. The following is a list of viewers that to my knowledge should support backward search: * Okular * SumatraPDF * Evince (since version 2.91.3) * Zathura Note: Inverse search relies on the |clientserver| functionality of vim. Each instance of vim runs its own server. The above mentioned standard value implies the default server name, which might not be the actual name of the server for the vim instance you are using. Note: For backward search to work on windows, one must ensure that the folder that contains `gVim.exe` is in your `%PATH%` environment variable. MuPDF does not support inverse search. However, by the use of some semi ugly hacks, we have implemented a command inside vim that simulates the functionality. The command is |VimtexRSearch|, and is by default mapped to `lr` if MuPDF is chosen as the viewer. The command will go to the line in the tex project that corresponds to the FIRST line on the page that is open in MuPDF. For SumatraPDF one may set the inverse search setting from vim directly by adding some command line options as shown below. The advantage of doing this is that one may specify the vim server name explicitly, which means that the backward search will also work as expected if one has several vim instances running. To enable this, use the general viewer and: > let g:vimtex_view_general_viewer='SumatraPDF ' \ . '-reuse-instance -inverse-search ' \ . '"gvim --servername '.v:servername.' --remote-send \"^^' \ . ':drop \%f^:\%l^:normal\! zzzv^' \ . ':execute ''drop ''.fnameescape(''\%f'')^' \ . ':\%l^:normal\! zzzv^' \ . ':call remote_foreground('''.v:servername.''')^\""' ============================================================================== MOTION *vimtex-motion* |vimtex| provides some functions that can be used to give improved motions and text objects. For instance, |vimtex-motion| enables highlighting of matching parens or tags (such as begin/end structures). The functionality is enabled by default, but may be disabled if desired. Associated settings: |g:vimtex_motion_enabled| |g:vimtex_motion_matchparen| Functions: |vimtex#motion#find_matching_pair| |vimtex#motion#next_section| |vimtex#motion#sel_delimiter| |vimtex#motion#sel_environment| |vimtex#motion#sel_inline_math| ============================================================================== CHANGE *vimtex-change* |vimtex| provides mappings that are inspired by `surround.vim` (https://github.com/tpope/vim-surround) (if it is installed, see |surround.txt|). These mappings are: `cse` - change surrounding environment `dse` - delete surrounding environment `csc` - change surrounding command `dsc` - delete surrounding command Note: This mappings is only available if `surround.vim` is also available. `tsd` - toggle delimiters (add/remove `\left` and `\right`) `tse` - toggle starred environment An environment that has been opened but not closed may be closed by the mapping `]]`. In addition, some functionality is provided to wrap the current selection. This is not mapped to anything by default. For additional coupling with `surround.vim`, one may add the following lines to ones `.vimrc` file to obtain corresonding `yse` and `ysc` mappings. > augroup latexSurround autocmd! autocmd FileType tex call s:latexSurround() augroup END function! s:latexSurround() let b:surround_{char2nr("e")} = "\\begin{\1environment: \1}\n\t\r\n\\end{\1\1}" let b:surround_{char2nr("c")} = "\\\1command: \1{\r}" endfunction Functions: |vimtex#change#command| |vimtex#change#close_environment| |vimtex#change#env| |vimtex#change#env_prompt| |vimtex#change#to_command| |vimtex#change#toggle_delim| |vimtex#change#toggle_env_star| |vimtex#change#wrap_selection| |vimtex#change#wrap_selection_prompt| ============================================================================== UTILITY FUNCTIONS *vimtex-util* Several utility functions are available. Many of these are used as building blocks for other functionalities, but are also available for users to add additional functionality. Functions: |vimtex#util#convert_back| |vimtex#util#get_delim| |vimtex#util#get_env| |vimtex#util#has_syntax| |vimtex#util#in_comment| |vimtex#util#kpsewhich| |vimtex#util#tex2tree| |vimtex#util#tree2tex| ============================================================================== TABLE OF CONTENTS *vimtex-toc* |vimtex| provides a table of contents (TOC) window that can be opened |vimtex#toc#open| or toggled |vimtex#toc#toggle|. In the TOC, one can use '' on a selected entry to navigate. Associated settings: |g:vimtex_toc_enabled| |g:vimtex_toc_fold_levels| |g:vimtex_toc_fold| |g:vimtex_toc_hide_help| |g:vimtex_toc_hide_preamble| |g:vimtex_toc_hide_line_numbers| |g:vimtex_toc_numbers| |g:vimtex_toc_numbers_width| |g:vimtex_toc_resize| |g:vimtex_toc_secnumdepth| |g:vimtex_toc_split_pos| |g:vimtex_toc_width| Functions: |vimtex#toc#open| |vimtex#toc#toggle| ============================================================================== FUNCTION REFERENCE *vimtex-functions* The following is a reference of the available functions, sorted alphabetically. First a short overview is given, then more detailed descriptions follow. Overview:~ |vimtex#change#command| |vimtex#change#close_environment| |vimtex#change#env| |vimtex#change#env_prompt| |vimtex#change#to_command| |vimtex#change#toggle_delim| |vimtex#change#toggle_env_star| |vimtex#change#wrap_selection| |vimtex#change#wrap_selection_prompt| |vimtex#complete#omnifunc| |vimtex#complete#labels| |vimtex#complete#bibtex| |vimtex#fold#level| |vimtex#fold#text| |vimtex#fold#refresh| |vimtex#help| |vimtex#info| |vimtex#latexmk#clean| |vimtex#latexmk#compile| |vimtex#latexmk#compile_singleshot| |vimtex#latexmk#errors| |vimtex#latexmk#options| |vimtex#latexmk#status| |vimtex#latexmk#stop| |vimtex#latexmk#stop_all| |vimtex#latexmk#toggle| |vimtex#motion#find_matching_pair| |vimtex#motion#next_sec| |vimtex#motion#sel_delimiter| |vimtex#motion#sel_environment| |vimtex#motion#sel_inline_math| |vimtex#reinit| |vimtex#toc#open| |vimtex#toc#toggle| |vimtex#util#convert_back| |vimtex#util#get_delim| |vimtex#util#get_env| |vimtex#util#has_syntax| |vimtex#util#in_comment| |vimtex#util#kpsewhich| |vimtex#util#tex2tree| |vimtex#util#tree2tex| |vimtex#view#general| |vimtex#view#mupdf| |vimtex#view#mupdf_poststart| |vimtex#view#mupdf_rsearch| |vimtex#view#okular| |vimtex#view#sumatrapdf| ------------------------------------------------------------------------------ Detailed descriptions:~ *vimtex#change#command* Change the current command name to one typed at a prompt. *vimtex#change#close_environment* Closes current delimiter or environment command. The function is only useful when used as an insert mode command, since it returns the closing part of the delimiter or environment. *vimtex#change#env* Change the current environment name to the one passed as an argument. *vimtex#change#env_prompt* Change the current environment name to one typed at a prompt. *vimtex#change#to_command* Turn word under cursor into command. This essentially prepends a backslash and adds an opening brace. The function may be used both in an insert mode mapping and in a normal mode mapping. *vimtex#change#toggle_delim* Toggle delimiters between `(` `)` and `\left(` `\right)` (and similar). *vimtex#change#toggle_env_star* Toggle star for the current environment. *vimtex#change#wrap_selection* Wrap the current selection within a supplied command. *vimtex#change#wrap_selection_prompt* Wrap the current selection within a command given at a prompt. *vimtex#complete#omnifunc* An 'omnifunc' for label and citation completion, see |vimtex-completion|. *vimtex#complete#labels* Parses aux files to gather label candidates for completion. *vimtex#complete#bibtex* Parses included bibliography files and `thebibliography` environments to gather candidates for completion. *vimtex#fold#level* Sets fold level for each line. 'foldexpr' |fold-expr| *vimtex#fold#text* Sets fold title text. 'foldtext' *vimtex#fold#refresh* Refreshes fold levels based on which parts and sections used in the current file buffer. Also issues a |zx| call to update folds. *vimtex#help* Lists all mappings that are defined specifically for the current buffer. If the default mappings are used, then |vimtex#help| will display them. *vimtex#info* Echoes the contents of |g:vimtex#data| and |b:vimtex|. This is useful mainly for debugging. *vimtex#latexmk#clean* Clean up temporary files with `latexmk -c`. An optional argument may be supplied to indicate that the `-C` flag should be used, which also cleans output files. This will only be run if `latexmk` is not already running. *vimtex#latexmk#compile* Starts `latexmk -pvc ...` for the given buffer, if it is not already running. *vimtex#latexmk#compile_singleshot* Starts a single shot compile with `latexmk ...` for the given buffer (if it is not already running). *vimtex#latexmk#errors* Parse the log file for errors and warnings. If any errors or warnings are found, they are displayed in the quickfix window. The exact behaviour is controlled through the different quickfix specific option: |g:vimtex_quickfix_autojump| |g:vimtex_quickfix_ignore_all_warnings| |g:vimtex_quickfix_ignored_warnings| |g:vimtex_quickfix_mode| If the quickfix window is already open, then the function closes it. *vimtex#latexmk#output* Opens a new buffer that show the output from the `latexmk` command. To close the buffer, one may simply type `q`. *vimtex#latexmk#status* Show if `latexmk` has been started for the current buffer. An optional argument may be supplied, in which case the status for all buffers is shown. *vimtex#latexmk#stop* Stop the `latexmk` process running for the current buffer. An optional argument may be given, in which case the function becomes verbose. *vimtex#latexmk#stop_all* Stops all running `latexmk` processes. *vimtex#latexmk#toggle* Toggle compilation. Calls |vimtex#latexmk#compile| if `latexmk` is not running for the current file. Else it calls |vimtex#latexmk#stop|. *vimtex#motion#find_matching_pair* Finds a matching pair of parentheses or begin-end-tags. The functions is used to find the pair closest to the current cursor position. *vimtex#motion#next_sec* A motion command function that moves to the next section. Used to redefine the mappings for ']]', '[[', and similar. *vimtex#motion#sel_delimiter* A function that is used to create text objects for text contained within a set of delimiters. *vimtex#motion#sel_environment* A function that is used to create text objects for environments. *vimtex#motion#sel_inline_math* A function that is used to create text objects for inline math structures. *vimtex#reinit* Clears the current global and local data in |g:vimtex#data| and |b:vimtex|, stops running `latexmk` processes |vimtex#latexmk#stop_all|, and then performs a new initialization. *vimtex#toc#open* Open the TOC window. If it is already open, then simply move the cursor to the TOC window. *vimtex#toc#toggle* Toggle TOC window: If TOC window is open, then close it. If it is closed, then open it (but do not move the cursor to the window). *vimtex#util#convert_back* Convert from stuff like `\IeC{\"u}` to corresponding unicode symbols. *vimtex#util#get_delim* Get surrounding delimiters (with position). *vimtex#util#get_env* Get surrounding environment. If optional argument supplied, the function also returns the position (line and column number) of the begin and end structure. *vimtex#util#has_syntax* Checks if the given position (or current position) is within the given syntax structure. *vimtex#util#in_comment* Checks if the given position (or current position) is within a comment. *vimtex#util#kpsewhich* Parse file with `kpsewhich`. *vimtex#util#tex2tree* Turn tex structure to a tree composed of lists. E.g. > { testing { tex2tree { } } } => [ "testing" , [ "tex2tree", []]] < *vimtex#util#tree2tex* Turns a tree composed of lists into tex structure. E.g. > [ "testing" , [ "tex2tree", []]] => { testing { tex2tree { } } } < *vimtex#view#general* Open the output file with the viewer that is specified with the option |g:vimtex_view_general_viewer|. *vimtex#view#mupdf* *vimtex#view#okular* *vimtex#view#sumatrapdf* First open the output file if it is not open with MuPDF/Okular/SumatraPDF. Then perform a forward search. *vimtex#view#mupdf_poststart* Function that is called after the MuPDF window has been opened. The function is used to run `xdotool` commands, for instance to return focus to vim and to possibly send some keys to MuPDF as specified in |g:vimtex_view_mupdf_send_keys|. *vimtex#view#mupdf_rsearch* Perform a reverse search by use of `xdotool` and `synctex`. ============================================================================== FAQ *vimtex-faq* Q: Vim throws error when jumping to file with |gf|. A: This might be due to the |isfname| setting, which by default contains `{,}` on windows. |isfname| is a global option, and can therefore not be set by `vimtex`. Suggested solution is to remove `{,}` from |isfname| by: > set isfname-={,} ============================================================================== CREDITS *vimtex-credits* |vimtex| is developed by Karl Yngve Lervåg , and is distributed under the MIT license. The project is available as a Git repository: https://github.com/lervag/vimtex. |vimtex| was developed from scratch, but much of the code has been based on LaTeX-Box: https://github.com/LaTeX-Box-Team/LaTeX-Box. LaTeX-suite was also an inspiration: http://vim-latex.sourceforge.net/. The documentation of |vimtex| is structured with inspiration from CtrlP (https://github.com/kien/ctrlp.vim), simply because CtrlP has a very good documentation. ============================================================================== CHANGELOG *vimtex-changelog* The following changelog only logs important changes, such as changes that break backwards compatibility. See the git log for the detailed changelog. *vim-latex-namechange* 2015-03-08: Changed the name to |vimtex|~ The old name `vim-latex` was already used by LaTeX-Suite. I was not aware of the name clash in the beginning. Due to the rising popularity of this plugin, it has become clear that such a name clash is very inconvenient. The present change is therefore very much needed. The name change is reflected throughout the plugin in the names of commands, mappings, functions, and options. People should update their `vimrc` settings accordingly. For instance, every option name should be changed from > g:latex_... = ... to > g:vimtex_... = ... 2014-12-07: Added more general view functionality~ Added new module for view functionality. This allows more complex view functions (and commands), for instance to do forward (and possibly backwards) searching through `synctex`. In the first version, I added forward search for mupdf by use of the `synctex` command and `xdotools`. The `g:latex_viewer` option has now been deprecated. Instead one should use |g:vimtex_view_method| and |g:vimtex_view_general_viewer|. Deprecated option: *g:latex_viewer* 2014-06-13: Changed some option names~ Some |vimtex| option names were changed in an attempt to make the names more consistent. These options are listed here for reference: *g:latex_errorformat_ignore_warnings* *g:latex_errorformat_show_warnings* *g:latex_latexmk_autojump* *g:latex_latexmk_quickfix* The new names are, respectively: |g:vimtex_quickfix_ignored_warnings| |g:vimtex_quickfix_ignore_all_warnings| |g:vimtex_quickfix_autojump| |g:vimtex_quickfix_mode| 2013-10-05: First public release~ ============================================================================== vim:tw=78:ts=8:ft=help:norl: