vimtex/doc/latex.txt

*latex.txt*    LaTeX plugin for Vim version 7.3 (and above)
*vim-latex*

Author:  Karl Yngve Lervåg <karl.yngve@gmail.com>
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                                                  *vim-latex-contents*

    1. Intro ................................ |vim-latex-intro|
    2. Main interface ....................... |vim-latex-main|
    3. Default mappings ..................... |vim-latex-mappings|
    4. Options .............................. |vim-latex-options|
    5. Omni completion ...................... |vim-latex-completion|
    6. Folding .............................. |vim-latex-folding|
    7. Latexmk .............................. |vim-latex-latexmk|
    8. Motion ............................... |vim-latex-motion|
    9. Change ............................... |vim-latex-change|
   10. Table of contents .................... |vim-latex-toc|
   11. Utility functions .................... |vim-latex-util|
   12. Function reference ................... |vim-latex-functions|
   13. Limitations .......................... |vim-latex-limitations|

==============================================================================
INTRO                                                        *vim-latex-intro*

This vim plugin provides some convenience 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.
The plugin will hereafter be referred to as |vim-latex|.

==============================================================================
MAIN INTERFACE                                                *vim-latex-main*

The |vim-latex| interface is based on the |autoload| feature of vim.  For each
new latex buffer, the function *latex#init* initializes the variables and
functionalities based on the desired options |vim-latex-options|.  The first
run performs some global initialization, which is mainly to define
autocommands.  Other functionality is provided by additional autoloaded
scripts, such as |vim-latex-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 |latex#init|.

The main interface provides some basic functionality.  |latex#view|, by
default mapped to '<localleader>lv', opens the current output file in
a viewer.  |latex#help| lists all mappings that are defined specifically for
the current buffer, by default mapped to '<localleader>lh'.  If the default
mappings are used, |latex#help| will display them.  |latex#info| echoes the
contents of |g:latex#data| and |b:latex|.  This is useful mainly for
debugging.  Finally, |latex#reinit| clears the current data in |g:latex#data|
and |b:latex|, stops running latexmk processes |latex#latexmk#stop_all|,  and
then performs a new initialization with |latex#init|.

For each latex project that is opened, a |Dictionary| is created and added to
the list |g:latex#data|.  The dictionary is initialized with information tied
to the current project, mainly the different associated file names.  In
addition, a dictonary is created for every buffer |b:latex|.  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 |vim-latex| to work properly for multi-file latex projects.  It also
allows the editing of different latex projects simultaneously in different
buffers.

                                                                *g:latex#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 dictonary 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
|vim-latex-latexmk| is enabled |g:latex_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 |latex#info|, by default
mapped to '<localleader>li'.

                                                                     *b:latex*
For each buffer, |vim-latex| defines a |Dictionary| that contains buffer local
information.  An example of such a dictonary 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:latex#data|.  Other entries may also be
exist, such as `fold_sections`.  The dictionary can be printed with the
function |latex#info|, by default mapped to '<localleader>li'.

Functions:
        |latex#info|
        |latex#help|
        |latex#reinit|
        |latex#view|

==============================================================================
DEFAULT MAPPINGS                                          *vim-latex-mappings*

The default mappings for |vim-latex| are given below.  See 'map-listing' for
an explanation of the format.  The function |latex#help| is provided for
convenience to list all the defined mappings, and it is by default mapped to
'<localleader>lh'.  The default mappings may be disabled with the option
|g:latex_mappings_enabled|, if the user wishes to create his own mappings.

n  %                *@:call latex#motion#find_matching_pair()<CR>
v  %                *@:<C-U>call latex#motion#find_matching_pair(1)<CR>
o  %                *@:normal v%<CR>

v  a$               *@:call latex#motion#select_inline_math()<CR>
v  i$               *@:call latex#motion#select_inline_math(1)<CR>
o  a$               *@:normal va$<CR>
o  i$               *@:normal vi$<CR>

v  ae               *@:call latex#motion#select_environment()<CR>
v  ie               *@:call latex#motion#select_environment(1)<CR>
o  ae               *@:normal vae<CR>
o  ie               *@:normal vie<CR>

v  ad               *@:<C-U>call latex#motion#select_delimiter()<CR>
v  id               *@:<C-U>call latex#motion#select_delimiter(1)<CR>
o  ad               *@:normal va(<CR>
o  id               *@:normal vi(<CR>

n  [[               *@:call latex#motion#next_sec(0,1,0)<CR>
n  []               *@:call latex#motion#next_sec(1,1,0)<CR>
n  ][               *@:call latex#motion#next_sec(1,0,0)<CR>
n  ]]               *@:call latex#motion#next_sec(0,0,0)<CR>
v  [[               *@:<C-U>call latex#motion#next_sec(0,1,1)<CR>
v  []               *@:<C-U>call latex#motion#next_sec(1,1,1)<CR>
v  ][               *@:<C-U>call latex#motion#next_sec(1,0,1)<CR>
v  ]]               *@:<C-U>call latex#motion#next_sec(0,0,1)<CR>
o  [[               *@:normal v[[<CR>
o  []               *@:normal v[]<CR>
o  ][               *@:normal v][<CR>
o  ]]               *@:normal v]]<CR>

n  <localleader>li  *@:call latex#info()<cr>
n  <localleader>lh  *@:call latex#help()<cr>
n  <localleader>lv  *@:call latex#view()<cr>
n  <localleader>lR  *@:call latex#reinit()<cr>
n  <localleader>lt  *@:call latex#toc#open()<cr>
n  <localleader>lT  *@:call latex#toc#toggle()<cr>
n  <localleader>ll  *@:call latex#latexmk#compile()<cr>
n  <localleader>lk  *@:call latex#latexmk#stop(1)<cr>
n  <localleader>lK  *@:call latex#latexmk#stop_all()<cr>
n  <localleader>le  *@:call latex#latexmk#errors()<cr>
n  <localleader>lg  *@:call latex#latexmk#status()<cr>
n  <localleader>lG  *@:call latex#latexmk#status(1)<cr>
n  <localleader>lc  *@:call latex#latexmk#clean()<cr>
n  <localleader>lC  *@:call latex#latexmk#clean(1)<cr>

n  <localleader>li  *@:call latex#info()<CR>
n  <localleader>lh  *@:call latex#help()<CR>
n  <localleader>lv  *@:call latex#view()<CR>
n  <localleader>lR  *@:call latex#reinit()<CR>
n  <localleader>lt  *@:call latex#toc#open()<CR>
n  <localleader>lT  *@:call latex#toc#toggle()<CR>
n  <localleader>ll  *@:call latex#latexmk#compile()<CR>
n  <localleader>lk  *@:call latex#latexmk#stop(1)<CR>
n  <localleader>lK  *@:call latex#latexmk#stop_all()<CR>
n  <localleader>le  *@:call latex#latexmk#errors()<CR>
n  <localleader>lg  *@:call latex#latexmk#status()<CR>
n  <localleader>lG  *@:call latex#latexmk#status(1)<CR>
n  <localleader>lc  *@:call latex#latexmk#clean()<CR>
n  <localleader>lC  *@:call latex#latexmk#clean(1)<CR>

n  zx               *@:call latex#fold#refresh()<cr>zx
n  dse              *@:call latex#change#env('')<CR>
n  cse              *@:call latex#change#env_prompt()<CR>
n  tse              *@:call latex#change#env_toggle_star()<CR>
n  tse              *@:call latex#change#env_toggle_star()<cr>
n  tsd              *@:call latex#change#delim_toggle()<CR>

==============================================================================
OPTIONS                                                    *vim-latex-options*

This section describes the options for |vim-latex|.  The options are first
listed in alphabetical order, before they are described in more detail.  The
descriptions also list the default values.

Overview:~

  |g:latex_enabled|
  |g:latex_build_dir|
  |g:latex_complete_close_braces|
  |g:latex_complete_enabled|
  |g:latex_complete_patterns|
  |g:latex_errorformat_ignore_warnings|
  |g:latex_errorformat_show_warnings|
  |g:latex_fold_enabled|
  |g:latex_fold_envs|
  |g:latex_fold_parts|
  |g:latex_fold_preamble|
  |g:latex_fold_sections|
  |g:latex_indent_enabled|
  |g:latex_latexmk_autojump|
  |g:latex_latexmk_enabled|
  |g:latex_latexmk_options|
  |g:latex_latexmk_output|
  |g:latex_main_tex_candidates|
  |g:latex_mappings_enabled|
  |g:latex_motion_enabled|
  |g:latex_motion_matchparen|
  |g:latex_toc_enabled|
  |g:latex_toc_fold_levels|
  |g:latex_toc_fold|
  |g:latex_toc_hide_help|
  |g:latex_toc_resize|
  |g:latex_toc_split_side|
  |g:latex_toc_width|
  |g:latex_viewer|

------------------------------------------------------------------------------
Detailed descriptions and default values:~

                                                             *g:latex_enabled*
If this variable exists and is 0, then |vim-latex| is completely disabled.  By
default, it is not defined.

                                                           *g:latex_build_dir*
Set this variable in case a dedicated build dir is used with latexmk/latex
compilations. >
  let g:latex_build_dir = '.'
<

                                               *g:latex_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:latex_complete_close_braces = 0
<

                                                    *g:latex_complete_enabled*
Use this option to prevent the plugin from setting the 'omnifunc': >
  let g:latex_complete_enabled = 1
<

                                                   *g:latex_complete_patterns*
Define patterns that control when the label and citation completion is
triggered. >
  let g:latex_complete_patterns = {
      \ 'ref' : '\C\\v\?\(eq\|page\|[cC]\)\?ref\*\?\_\s*{[^{}]*',
      \ 'bib' : '\C\\\a*cite\a*\*\?\(\[[^\]]*\]\)*\_\s*{[^{}]*',
      \ })
<

                                         *g:latex_errorformat_ignore_warnings*
List of warning messages that should be ignored. >
  let g:latex_errorformat_ignore_warnings = [
        \ 'Underfull',
        \ 'Overfull',
        \ 'specifier changed to',
      \ ]
<

                                           *g:latex_errorformat_show_warnings*
Show warnings in quickfix window. >
  let g:latex_errorformat_show_warnings = 1
<

                                                        *g:latex_fold_enabled*
Use this option to disable/enable folding. >
  let g:latex_fold_enabled = 1
<

                                                           *g:latex_fold_envs*
Decide whether environments should be folded or not. >
  let g:latex_fold_envs = 1
<

                                                          *g:latex_fold_parts*
List of parts that should be folded. >
  let g:latex_fold_parts = [
        \ "appendix",
        \ "frontmatter",
        \ "mainmatter",
        \ "backmatter",
      \ ]
<

                                                       *g:latex_fold_preamble*
Decide whether preamble should be folded or not. >
  let g:latex_fold_preamble = 1
<

                                                       *g:latex_fold_sections*
List of section constructs that should be folded. >
  let g:latex_fold_sections = [
        \ "part",
        \ "chapter",
        \ "section",
        \ "subsection",
        \ "subsubsection",
      \ ]

                                                      *g:latex_indent_enabled*
Use |vim-latex| indentation function.  Not as customizable as the official
indentation function, but imho it is better.

                                                    *g:latex_latexmk_autojump*
Whether to automatically jump to the first error when the error window is
opened with the default mapping or |latex#latexmk#errors|. >
  let g:latex_latexmk_autojump = '0'
<

                                                     *g:latex_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:latex_latexmk_enabled = 1
<

                                                     *g:latex_latexmk_options*
Set extra options for latexmk compilation. >
  let g:latex_latexmk_options = ''
<

                                                      *g:latex_latexmk_output*
Set desired output for latexmk compilation. >
  let g:latex_latexmk_output = 'pdf'
<

                                                 *g:latex_main_tex_candidates*
A list of common names for main tex-file candidates.  This is used to find the
main tex file in multi-file projects. >
  let g:latex_main_tex_candidates = [
        \ 'main',
        \ 'memo',
        \ 'note',
        \ 'report',
        \ 'thesis',
      \]
<

                                                    *g:latex_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:latex_default_mappings = 1
<

                                                      *g:latex_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:latex_motion_enabled = 1
<

                                                   *g:latex_motion_matchparen*
Enable highlighting of matching parens.  This gives better support for LaTeX,
but disables the builtin |matchparen|. >
  let g:latex_motion_matchparen = 1
<

                                                         *g:latex_toc_enabled*
Enable interface for TOC.  If it is disabled, then mappings for the TOC will
not be created. >
  let g:latex_toc_enabled = 0
<

                                                     *g:latex_toc_fold_levels*
If TOC entries are folded, this option controls the number of fold levels that
will be used. >
  let g:latex_toc_fold_levels = 0
<

                                                            *g:latex_toc_fold*
Turn on folding of TOC entries. >
  let g:latex_toc_fold = 0
<

                                                       *g:latex_toc_hide_help*
Allow the TOC help text to be hidden. >
  let g:latex_toc_hide_help = 0
<

                                                          *g:latex_toc_resize*
Automatically resize vim when the TOC window is opened. >
  let g:latex_toc_resize = 1
<

                                                      *g:latex_toc_split_side*
Define where the TOC window is opened. >
  let g:latex_toc_split_side = 'leftabove'
<

                                                           *g:latex_toc_width*
Set width of TOC window. >
  let g:latex_toc_width = 30
<

                                                              *g:latex_viewer*
Set default viewer application. >
  let g:latex_viewer = 'xdg-open'
<

==============================================================================
OMNI COMPLETION                                         *vim-latex-completion*

|vim-latex| provides an 'omnifunc' for omni completion, see |compl-omni| and
|latex#complete#omnifunc|.  The function is enabled by default, but may be
disabled with |g:latex_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 |latex#complete#labels| and
|latex#complete#bibtex|.  If |g:latex_complete_close_braces| is set to 1, then
the completion includes closing braces.

Associated settings:
        |g:latex_complete_enabled|
        |g:latex_complete_patterns.ref|
        |g:latex_complete_patterns.bib|
        |g:latex_complete_close_braces|

Functions:
        |latex#complete#omnifunc|
        |latex#complete#labels|
        |latex#complete#bibtex|

------------------------------------------------------------------------------
Complete labels~

Label completion is triggered by '\ref{' commands as defined with
|g:latex_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:<CTRL-X><CTRL-O>

offers a list of all matching labels, with their associated value and page
number.  The label completion matches:

    1. labels: >
        \ref{sec:<CTRL-X><CTRL-O>
<    2. numbers: >
        \eqref{2<CTRL-X><CTRL-O>
<    3. labels and numbers together (separated by whitespace): >
        \eqref{eq 2<CTRL-X><CTRL-O>

------------------------------------------------------------------------------
Complete citations~

Citation completion is triggered by '\cite{' commands as defined with
|g:latex_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<CTRL-X><CTRL-O>
        \cite{algo<CTRL-X><CTRL-O>
        \cite{Don.*Knuth<CTRL-X><CTRL-O>

In particular, note that regular expressions (or vim patterns) can be used
after '\cite{' to search for candidates.

==============================================================================
FOLDING                                                    *vim-latex-folding*

LatexBox 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:latex_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 |latex#fold#refresh| can be
used to refresh the fold level settings.  This function is mapped by default
to `zx`.

Associated settings:
    |g:latex_fold_enabled|
    |g:latex_fold_preamble|
    |g:latex_fold_parts|
    |g:latex_fold_sections|
    |g:latex_fold_envs|

Functions:
    |latex#fold#level|
    |latex#fold#text|
    |latex#fold#refresh|

==============================================================================
LATEXMK                                                    *vim-latex-latexmk*

|vim-latex| provides a basic interface to `latexmk` for background
compilation.  The interface may be disabled with |g:latex_latexmk_enabled|.
The default mappings are: >

  nnoremap <localleader>ll :call latex#latexmk#compile()<cr>
  nnoremap <localleader>lk :call latex#latexmk#stop(1)<cr>
  nnoremap <localleader>lK :call latex#latexmk#stop_all()<cr>
  nnoremap <localleader>le :call latex#latexmk#errors()<cr>
  nnoremap <localleader>lg :call latex#latexmk#status(0)<cr>
  nnoremap <localleader>lG :call latex#latexmk#status(1)<cr>
  nnoremap <localleader>lc :call latex#latexmk#clean(0)<cr>
  nnoremap <localleader>lC :call latex#latexmk#clean(1)<cr>

The background compilation is started with |latex#latexmk#compile|, and relies
on the preview continuous mode of `latexmk`.  Compilation errors are not
parsed automatically, since there is no way of knowing when the document has
been compiled.  To view errors, use |latex#latexmk#errors|.  To check if
compilation is running in the background, use |latex#latexmk#status|.

Associated settings:
    |g:latex_latexmk_enabled|
    |g:latex_latexmk_autojump|
    |g:latex_latexmk_options|
    |g:latex_latexmk_output|

Functions:
    |latex#latexmk#clean|
    |latex#latexmk#compile|
    |latex#latexmk#errors|
    |latex#latexmk#status|
    |latex#latexmk#stop|
    |latex#latexmk#stop_all|

==============================================================================
MOTION                                                      *vim-latex-motion*

|vim-latex| provides some functions that can be used to give improved motions
and text objects.  For instance, |vim-latex-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:latex_motion_enabled|
    |g:latex_motion_matchparen|
    |g:latex_motion_open_pats|
    |g:latex_motion_close_pats|

Functions:
    |latex#motion#find_matching_pair|
    |latex#motion#next_sec|
    |latex#motion#select_current_env|
    |latex#motion#select_inline_math|

==============================================================================
CHANGE                                                      *vim-latex-change*

Utility functions are provided to manipulate the current environments or
delimiters.

Functions:
    |latex#change#env|
    |latex#change#env_prompt|
    |latex#change#toggle_delim|
    |latex#change#toggle_env_star|
    |latex#change#wrap_selection|
    |latex#change#wrap_selection_prompt|

==============================================================================
UTILITY FUNCTIONS                                             *vim-latex-util*

Functions:
    |latex#util#convert_back|
    |latex#util#get_delim|
    |latex#util#get_env|
    |latex#util#has_syntax|
    |latex#util#in_comment|
    |latex#util#kpsewhich|
    |latex#util#set_default|
    |latex#util#tex2tree|
    |latex#util#tree2tex|

==============================================================================
TABLE OF CONTENTS                                              *vim-latex-toc*

|vim-latex| provides a table of contents (TOC) window that can be opened
|latex#toc#open|  or toggled |latex#toc#toggle|.  In the TOC, one can use
'<CR>' on a selected entry to navigate.

Associated settings:
    |g:latex_toc_enabled|
    |g:latex_toc_fold_levels|
    |g:latex_toc_fold|
    |g:latex_toc_hide_help|
    |g:latex_toc_resize|
    |g:latex_toc_split_side|
    |g:latex_toc_width|

Functions:
    |latex#toc#open|
    |latex#toc#toggle|

==============================================================================
FUNCTION REFERENCE                                       *vim-latex-functions*

The following is a reference of the available functions, sorted
alphabetically.  First a short overview is given, then more detailed
descriptions follow.

Overview:~

  |latex#change#env|
  |latex#change#env_prompt|
  |latex#change#toggle_delim|
  |latex#change#toggle_env_star|
  |latex#change#wrap_selection|
  |latex#change#wrap_selection_prompt|
  |latex#complete#omnifunc|
  |latex#complete#labels|
  |latex#complete#bibtex|
  |latex#fold#level|
  |latex#fold#text|
  |latex#fold#refresh|
  |latex#help|
  |latex#info|
  |latex#latexmk#clean|
  |latex#latexmk#compile|
  |latex#latexmk#errors|
  |latex#latexmk#status|
  |latex#latexmk#stop|
  |latex#latexmk#stop_all|
  |latex#motion#find_matching_pair|
  |latex#motion#next_sec|
  |latex#motion#select_current_env|
  |latex#motion#select_inline_math|
  |latex#reinit|
  |latex#toc#open|
  |latex#toc#toggle|
  |latex#util#convert_back|
  |latex#util#get_delim|
  |latex#util#get_env|
  |latex#util#has_syntax|
  |latex#util#in_comment|
  |latex#util#kpsewhich|
  |latex#util#set_default|
  |latex#util#tex2tree|
  |latex#util#tree2tex|
  |latex#view|

------------------------------------------------------------------------------
Detailed descriptions:~

                                                             *latex#change#env*

                                                      *latex#change#env_prompt*

                                                    *latex#change#toggle_delim*

                                                 *latex#change#toggle_env_star*

                                                  *latex#change#wrap_selection*

                                           *latex#change#wrap_selection_prompt*

                                                     *latex#complete#omnifunc*
An 'omnifunc' for label and citation completion, see |vim-latex-completion|.

                                                       *latex#complete#labels*
Parses aux files to gather label candidates for completion.

                                                       *latex#complete#bibtex*
Parses included bibliography files and `thebibliography` environments to
gather candidates for completion.

                                                            *latex#fold#level*
Sets fold level for each line. 'foldexpr' |fold-expr|

                                                             *latex#fold#text*
Sets fold title text. 'foldtext'

                                                          *latex#fold#refresh*
Refreshes fold levels based on which parts and sections used in the current
file buffer.

                                                                  *latex#help*
Lists all mappings that are defined specifically for the current buffer.  If
the default mappings are used, then |latex#help| will display them.

                                                                  *latex#info*
Echoes the contents of |g:latex#data| and |b:latex|.  This is useful mainly
for debugging.

                                                         *latex#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.

                                                       *latex#latexmk#compile*
Starts `latexmk -pvc ...` for the given buffer, if it is not already running.

                                                        *latex#latexmk#errors*
Displays the log file in the quickfix window.  The output may be controlled
slightly with the options |g:latex_errorformat_show_warnings| and
|g:latex_errorformat_ignore_warnings|.

                                                        *latex#latexmk#status*
Show if the `latexmk` has been started for the current buffer.  An optional
argument may be supplied, in which case the status for all buffers is shown.

                                                          *latex#latexmk#stop*
Stop the `latexmk` process running for the current buffer.  An optional
argument may be given, in which case the function becomes verbose.

                                                      *latex#latexmk#stop_all*
Stops all running `latexmk` processes.

                                             *latex#motion#find_matching_pair*
Finds a matching pair of parenthesis or begin-end-tags.  The functions is used

                                                       *latex#motion#next_sec*
A motion command function that moves to the next section.  Used to redefine
the mappings for ']]', '[[', and similar.

                                             *latex#motion#select_current_env*
A function that is used to create text objects for environments.

                                             *latex#motion#select_inline_math*
A function that is used to create text objects for inline math structures.

                                                                *latex#reinit*
Clears the current global and local data in |g:latex#data| and |b:latex|,
stops running latexmk processes |latex#latexmk#stop_all|,  and then performs
a new initialization.

                                                              *latex#toc#open*
Open the TOC window.  If it is already open, then simply move the cursor to
the TOC window.

                                                            *latex#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).

                                                      *latex#util#convert_back*

                                                         *latex#util#get_delim*

                                                           *latex#util#get_env*

                                                        *latex#util#has_syntax*

                                                        *latex#util#in_comment*

                                                         *latex#util#kpsewhich*

                                                       *latex#util#set_default*

                                                          *latex#util#tex2tree*

                                                          *latex#util#tree2tex*

                                                                  *latex#view*
Open the output file (specified with |g:latex_latexmk_output|) with the
default viewer |g:latex_viewer|.

==============================================================================
LIMITATIONS                                            *vim-latex-limitations*

This plugin is written for Linux/Unix environments, and so it does NOT support
Windows.  I do not plan to add support.

==============================================================================
CREDITS                                                    *vim-latex-credits*

|vim-latex| is developed by Karl Yngve Lervåg <karl.yngve@gmail.com>, and is
distributed under the MIT license.  The project is available as a Git
repository:  https://github.com/lervag/vim-latex.

|vim-latex| 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 |vim-latex| is structured with inspiration from CtrlP
(https://github.com/kien/ctrlp.vim), simply because CtrlP has a very good
documentation.

==============================================================================
CHANGELOG                                                *vim-latex-changelog*

First public release: 2013/10/05~

==============================================================================
 vim:tw=78:ts=8:ft=help:norl: