Latex-Suite provides the following ways to insert environments

quote     (_q_uot_e_)          ---> EQE
quotation (_q_uotatio_n_)      ---> EQN

Latex-Suite provides visual-mode mappings which enclose visually selected portions of text in environments. There are two ways provided to do this.

Some of the visual mode mappings are sensitive to whether you choose line-wise or character-wise. For example, if you choose a word and press ,ce, then you get \centerline{word}, whereas if you press ,ce on a line-wise selection, you get:

\begin{center}
    line
\end{center}

Pressing <S-F5> in normal mode detects which environment the cursor is presently located in and prompts you to replace it with a new one. The innermost environment is detected. For example, in the following source:

\begin{eqnarray}
  \begin{array}{ccc}
    2 & 3 & 4
  \end{array}
\end{eqnarray}

if you are located in the middle "2 & 3 & 4" line, then pressing <S-F5> will prompt you to change the array environment, not the eqnarray environment. In addition, Latex-Suite will also try to change lines within the environment to be consistent with the new environment. For example, if the original environment was an eqnarray environment with a \label command, then changing it to an eqnarray* environment will delete the \label.

Pressing <F5> in normal mode has the same effect as pressing <F5> in insert-mode, namely you will be prompted to choose an environment to insert.

Pressing <F7> in insert or normal mode while the cursor is touching a word will insert a command formed from the word touching the cursor.

For certain common commands, Latex-Suite will expand them to include additional arguments as needed. For example, frac becomes \frac{<++>}{<++>}<++>. Otherwise, it will simply change the word under the cursor as follows

word --> \word{<++>}<++>

You can define custom expansions of commands using the Tex_Com_{name} setting as described in here.

If <F7> is pressed when the cursor is on white-space, then Latex-Suite will prompt you to choose a command and insert that instead.The list of commands is constructed from the g:Tex_PromptedCommands setting and also from commands which Latex-Suite finds while scanning custom packages which Latex-Suite finds. See the Package actions section for details on which files are scanned etc.

You can select a portion of text visually and press <F7> while still in visual mode. This will prompt you with a list of commands. (This list can be customized via the g:Tex_PromptedCommands setting). You can either choose from this list or type in a new command name. Once the selection is done, Latex-Suite encloses the visually selected portion in the chosen command.

In both insert and normal mode <S-F7> will find out if you are presently within an environment and then prompt you with a list of commands to change it to.

If you wish the BBB command to insert a few additional fields in addition to the fields it creates, then you will need to define global variables of the form

g:Bib_{type}_options

in you $VIM/ftplugin/bib.vim file, where {type} is a string like 'article', 'book' etc. This variable should contain one of the letters defined in the following table

For example, by default, choosing 'article' via BBB inserts the following template by default

@ARTICLE{<+key+>,
    author = {<++>},
    title = {<++>},
    journal = {<++>},
    year = {<++>},
    otherinfo = {<++>}
}<++>

However, if g:Bib_article_options is defined as 'mnp', then 'article' will insert the following template

@ARTICLE{<+key+>,
    author = {<++>},
    title = {<++>},
    journal = {<++>},
    year = {<++>},
    month = {<++>},
    number = {<++>},
    pages = {<++>},
    otherinfo = {<++>}
}<++>

If you have some other fields you wish to associate with an article which are not listed above, then you will have to use the Bib_{type}_extrafields option. This is a newline separated string of complete field names which will be included in the template. For example, if you define

let g:Bib_article_extrafields = "crossref\nabstract"

then the article template will include the lines

crossref = {<++>},
abstract = {<++>},

This is a polymorphic insert-mode mapping which expands to one of the following depending on the character just before the cursor location.

If the character before the cursor is none of the above, then it will simply insert a \label{<++>}<++>.

This insert-mode mapping encloses the previous character in \mathbf{}.

In insert mode, this key is polymorphic as follows:

In visual mode, it will simply enclose the selection in \mathcal{}

This mapping inserts an \item command at the current cursor location depending on which environment the cursor is enclosed in. The style of the \item command is dependent on the enclosing environment. By default, <Alt-I> has styles defined forthe following environments:

<Alt-I> is intelligent enough to account for nested environments. For example,

\begin{itemize}
    \item first item
    \item second item
          \begin{description}
              \item[label1] first desc
              \item[label2] second
              % <Alt-I> will insert "\item[<+label+>] <++>" if
              % used here
          \end{description}
    \item third item
    % <Alt-I> will insert "\item " when if used here.
\end{itemize}
% <Alt-I> will insert nothing ("") if used here

The style used by <Alt-I> can be customized using the g:Tex_ItemStyle_environment variable.

Using IMAP instead of Vim's built-in :imap command has a couple of advantages:

Formally, the syntax which is used for the IMAP function is:

call IMAP (lhs, rhs, ft [, phs, phe])

call IMAP('BarFoo', 'something', 'tex')
call IMAP('Foo', 'something else', 'tex')

call IMAP('foo', 'something', 'tex')
call IMAP('foobar', 'something else', 'tex')

:call IMAP('EFE', "\\begin{figure}\<CR><++>\\end{figure}<++>", 'tex')

:call IMAP('FOO', "\<C-r>=MyFoonction()\<CR>", 'tex')

call IMAP('FOO', "\<C-r>=AskVimFunc()\<CR>", 'vim')
" Askvimfunc: Asks For Function Name And Sets Up Template 
" Description: 
function! AskVimFunc()
    let name = input('Name of the function : ')
    if name == ''
        let name = "<+Function Name+>"
    end
    let islocal = input('Is this function scriptlocal ? [y]/n : ', 'y')
    if islocal == 'y'
        let sidstr = '<SID>'
    else
        let sidstr = ''
    endif
    return IMAP_PutTextWithMovement( 
        \ "\" ".name.": <+short description+> \<cr>" .
        \ "Description: <+long description+>\<cr>" . 
        \ "\<C-u>function! ".name."(<+arguments+>)<++>\<cr>" . 
        \       "<+function body+>\<cr>" . 
        \ "endfunction \" "
        \ )
endfunction

Often times, the preamble can become too long, and some people prefer to put most of their personalization in a custom package and include that using a \usepackage line. Latex-Suite tries to search such customs package for other \usepackage lines, so that supported packages included in this indirect manner can also be used to create sub-menus, extend the 'dict' setting etc. The most obvious place to place such custom packages is in the same directory as the edited file. In addition, LaTeX also supports placing custom packages in places pointed to by the $TEXINPUTS environment variable.

If you use the $TEXINPUTS variable in LaTeX, and you wish Latex-Suite to search these custom packages for \usepackage lines, then you need to initialize the g:Tex_TEXINPUTS variable.

The g:Tex_TEXINPUTS variable needs to be set in the same format which Vim uses for the 'path' setting. This format is explained in detail if you do

:help file-searching

from within Vim.

Therefore the value of g:Tex_TEXINPUTS will most probably be different from $TEXINPUTS which your native LaTeX distribution uses.

Example:

let g:Tex_TEXINPUTS = '~/texmf/mypackages/**,./**'

The ** indicates that all directories below the directory ~/texmf/mypackages and ./ are to be scanned for custom packages.

This setting is a string containing a comma separated list of options supported by this package.

Example:

g:Tex_package_option_mypack = 'opt1,opt2=,sbr:group1,opt3,opt4'

The = suffix means that the option takes a value. Use sbr:group name to separate options into sub-menus. All successive options will be clubbed into the group1 sub-menu till the next sbr: option is encountered.

    g:TeX_package_<package> = "pre:Command,pre:Command1"
More detailed example is in latex-suite/packages/exmpl file (slightly
outdated).
Here is short summary of prefixes which can be used in package files:
(x - place with cursor, <++> - |placeholder|)

{env:command}  Environment: creates simple environment template
            \begin{command}
                x
            \end{command}<++>
{eno:command}  Environment with option:
            \begin[x]{command}
                <++>
            \end{command}<++>
{ens:command[<<option>>]...}  Environment special:
            \begin[<<option>>]...{command}
                <++>
            \end{command}<++>
{bra:command} Brackets:
            \command{x}<++>
{brd:command} Brackets double:
            \command{x}{<++>}<++>
{brs:command[<<option>>]...} Brackets special (as environment special:
            \command[<+x+>]{<++>}{<++>}<++>
{nor:command} Normal:
            \command<Space
{noo:command} Normal with option:
            \command[x]<++>
{nob:command} Normal with option and brackets:
            \command[x]{<++>}<++>
{pla:command} Plain:
            command<Space
{spe:command} Special:
            command   <-literal insertion of command
{sep:command} creates separator. Good for aesthetics and usability :)
{sbr:command} Breaks menu into submenus. <command> will be title of submenu.
            Can be used also in package variable.

Command can be also given without prefix:. The result is
           \command
          

Often times, the editing cycle proceeds by first laying out a comprehensive bibliography and then completing all the \cite commands in one session. In such situations, it is inefficient to scan the whole list of bibliography files for bib-keys each time. Latex-Suite provides a way to cache the results of the cite completion search using the Tex_RememberCiteSearch variable. If set, Latex-Suite will perform the search only the first time <F9> is used. Next time on, it will reuse the search results. If you wish to redo the search results, issue the command

TClearCiteHist

This will redo the completion list next time you use <F9>.

This entry defines which sections will be folded. This setting is a comma separated list of section names. The default value is:

part,chapter,section,%%fakesection,
subsection,subsubsection,paragraph

Each of the entries in the list will fold up a section of the corresponding name. The %%fakesection section is provided as a means for the user to group lines into "fake" sections. A %%fakesection is assumed to start on a line which begins with the string %%fakesection and continue till the start of the next \section, \subsection or any other section.

See also advanced fold settings.

This entry defines which environments will be folded. It is a comma separated string of words each of which defines a single environment. The default setting is

verbatim,comment,eq,gather,
align,figure,table,thebibliography,
keywords,abstract,titlepage

The words need not be standard Latex environments. You can add any word you like. Also, each word will fold up all environments whose name begins with that word. For example, in the setting above, the word "eq" folds up the \begin{equation}, \begin{eqnarray}, \begin{eqnarray*} environments. To avoid this, you can replace the word "eq" with "eq}".

See also advanced fold settings.

This entry defines which commands will be folded. It is a comma separated string of words each of which defines a single command. The default setting is empty, i.e no commands are folded. The words need not be standard Latex commands. You can use whatever words you like. Each word will fold all commands whose name begins with that word as in the case of the Tex_FoldedEnvironments variable.

\mycommand{This is a line
and some more text on the next line
}

\mycommand{This is a \textbf{line}
and some more text
}

See also advanced fold settings.

This entry defines fold syntax for certain items which do not naturally fit into the section, environment of command lists. It is a comma separated list of words. The default value is:

item,preamble,<<<

See also advanced fold settings.

The order of the words in the Tex_FoldedXXXX variables is important. The order defines the order in which the folds are nested. For example, the value "subsection,section" for the Tex_FoldedSections variable will not fold any subsections at all. This is because the folds are created in the reverse order in which they occur in the Tex_FoldedSections setting and also, once a fold is created, the interior of the fold is not examined for creating additional folds. In the above case, this means that a \section is folded first and then its interior is not examined further. The correct value should have been "section,subsection"

Each of the fold setting variables Tex_FoldedSections, Tex_FoldedEnvironments etc., as explained previously is a comma separated string of variables. However, to make it easier to add to the default settings without having to repeat the whole default setting again, Latex-Suite uses the following logic in forming the complete setting string from the Tex_FoldedXXXX variables. If the variable starts with a comma, then Tex_FoldedXXXX is added to the end of the default string rather than replacing it. Similarly, if it ends with a comma, then it will be prepended to the beginning of the default setting rather than replacing it.

For example, if Tex_FoldedEnvironments is set to the string "myenv", then only an environment of the form \begin{myenv} will be folded. However, if the Tex_FoldedEnvironments setting is ",myenv", then the \begin{myenv} environment will be folded after all other environments in the default setting have been folded. On the other hand if Tex_FoldedEnvironments is of the form "myenv,", the \begin{myenv} environment will be folded before the rest of the environments in the default setting.

These mappings are utilized for jumping between placeholders as described here. See the parent section to find out how to use this information to change the default maps.

<Plug>IMAP_JumpForward takes you to the location of the next place-holder.

<Plug>IMAP_JumpBack takes you to the previous place-holder.

<Plug>IMAP_DeleteAndJumpForward deletes the presently selected place-holder and jumps to the next place-holder irrespective of whether the present placeholder is empty or not and ignoring the value of place-holder settings like g:Imap_DeleteEmptyPlaceHolders and g:Imap_StickyPlaceHolders

<Plug>IMAP_DeleteAndJumpBack deletes the presently selected place-holder and jumps to the previous place-holder irrespective of whether the present placeholder is empty or not and ignoring the value of place-holder settings like g:Imap_DeleteEmptyPlaceHolders and g:Imap_StickyPlaceHolders

These mappings are are described in the section Alt key macros. See the parent section to see how to use the following information to remap keys.

When used without any arguments lists all available macros defined in runtime ftplugin/latex-suite/macros/ directories and prompts you to choose one of them. With one argument |:read| this macro under cursor position. With more than one argument it will not work :) In Vim >= 6.2 works completion of names of macros (see 'wildmenu', 'wildmode' for more about command-line completion).

Splits window for editing {macro}. When used without any arguments lists all available macros defined in runtime ftplugin/latex-suite/macros/ directories and prompt you to choose one of them. When you try to edit {macro} not from local directory Latex-Suite will copy it to your local directory with suffix "-local". If local copy already exists Latex-Suite prompt for overwriting it. In Vim >= 6.2 works completion of names of macros (see 'wildmenu', 'wildmode' for more about command-line completion).

Splits window to write new macro. Directory in new buffer is locally changed to Latex-Suite/macros/.

Delets {macro} from your local ftplugin/latex-suite/macros/ directory. When used without any arguments lists all available macros defined in Latex-Suite/macros/ directory and prompt you to choose one of them. When you choose to delete {macro} which is not in your local directory Latex-Suite will refuse to delete it. In Vim >= 6.2 works completion of names of macros (see 'wildmenu', 'wildmode' for more about command-line completion)

When used without any arguments lists name of the packages for which support is available. If you are using Vim GUI and have Tex_Menus set to 1, then it will list all files found in the $VIM/ftplugin/latex-suite/packages directory. Otherwise, Latex-Suite will list files found in the $VIM/ftplugin/latex-suite/dictionaries directory. Choosing a file from the list will insert a

\usepackage[<++>]{<packname>}

line into the buffer at the current cursor location. For Vim 6.2 and above, you can use command-line completion to choose a package file. You can also call TPackage with one or more package names separated with spaces in which case, Latex-Suite will insert \usepackage lines for each of them in turn.

After inserting the \usepackage line(s), Latex-Suite will support it (them) in various ways as described in the section Actions taken for supported packages.

This command `reads' name of package under cursor and turns on possible support.

After issuing this command latexSuite scans the file in looking for not declared packages, removing not needed entries from Packages menu and turning off not necessary packages' dictionaries.

When used without any arguments lists all available templates from latex-suite/templates/ directory and prompts to choose one of them. With one argument :0|read| {template} file. With more than one argument it will not work :) In Vim >= 6.2 works completion of names of macros (see 'wildmenu', 'wildmode' for more about command-line completion)

Used without any arguments inserts last section type (|latex-sectioning|). Accepts arguments: n> inserts section name in <n> logical level. Levels are:

Command accepts also latexSuite mappings (|latex-macros|) without preceding S and in lowercase:

:TSection pa

will result in \part{}. It is possible to use full names of sections: :TSection part

Accepts the same arguments as |TSection| but leads to a couple of questions (whether you want to include the section in the table of contents, whether there is a shorter name for the table of contents) and then creates a more intelligent template.

Accepts one argument. Will look through .tex files in directory of edited file for argument. It can be regexp. You don't have to enclose argument in "". <cr> takes you to location. Other keys work as described in |latex-viewer|. Note: TLook uses :grep command and is using 'grepprg'. Its regular expressions can be different from those of Vim.

Accepts one argument. Will look through .bib files in directory of edited file for argument. It can be regexp. You don't have to enclose argument in "". <cr> takes you to location. Other keys work as described in |latex-viewer|.

Accepts one argument. Will look through all files in directory of edited file for argument. It can be regexp. You don't have to enclose argument in "". <cr> takes you to location. Other keys work as described in |latex-viewer|. Note: TLook uses :grep command and is using 'grepprg'. Its regular expressions can be different from those of Vim.

No argument allowed but accepts range in all formats. Define fragment of interest with :'a,'b, :/a/,/b/, :'<,'> or :20,30. All other rules of compilation apply.

Show last compiled fragment. All rules of viewing apply but |latex-searching|.

Show shortcuts in terminal (not using menu). Without {arg} you will see simple menu prompting for one of them. Possible arguments:

If set to 1, then Latex-Suite will create certain global debug statements which can be printed by doing

:call Tex_PrintDebug()

If Latex-Suite detects that your vim is python enabled (using has('python')), then it tries to use python in certain places to speed things up. If this misbehaves, you can set this to zero, in which case, Latex-Suite will use vimscript to accomplish the same.

Setting this to zero completely disables using place-holders.

These settings affect the strings displayed at the beginning and end of the place-holder string. Set these strings to a value different than a commonly occurring sequence of characters.

When set to one, non-descriptive or empty place-holders are deleted on pressing <Ctrl-J>.

When set to 1, in visual mode, <Ctrl-J> takes you to the next placeholder without deleting the current placeholder.

If you wish to wish to expand certain environments differently from the way Latex-Suite does it, you can define custom expansions using global variables of the form Tex_Env_{name} where name corresponds to the environment.

For example, if you press <F5> after typing theorem, Latex-Suite will by default expand it to

\begin{theorem}
     \label{<++>}<++>
\end{theorem}<++>

However, if you wish change this to

\begin{theorem}
     <++>
\end{theorem}<++>

then define the following variable

let g:Tex_Env_theorem = "\\begin{theorem}\<CR><++>\<CR>\\end{theorem}"

If the expansion uses special keys such as carriage return etc, then use double-quotes and use the "\<key>" notation for special keys. Backslashes have to be doubled.

You could even use strings returned by functions as the expansion by using the IMAP_PutTextWithMovement() function.

If the name of the environment contains special characters (for example, the eqnarray* environment), then use the following form:

let g:Tex_Env_{'eqnarray*'} = 
        \ "\\begin{eqnarray*}\<CR><++> &=& <++>\<CR>\\end{eqnarray*}<++>"

This will make pressing <F5> after eqnarray* expand to

\begin{eqnarray*}
    <++> &=& <++>
\end{eqnarray*}<++>

If you wish to define new expansions for fast command insertion as described here, or redefine expansions from the default values in Latex-Suite, you will need to define variables of the form g:Tex_Com_{name} where name is a command name. For example, with the setting

let g:Tex_Com_frac = "\\frac{<++>}{<++>}<++>"

pressing <F7> after typing frac will change it to \frac{<++>}{<++>}<++>

See Tex_Env_name for additional details on how to create this setting in various special circumstances.

The following variables disable various parts of the macro functionality of Latex-Suite. See the links to the relevant sections to see what functionality setting each of the variables to zero will take away.

If this variable is set to 1, then when an environment is chosen from the menu then for selected environments, Latex-Suite asks a series of questions on the command line and inserts a template with the corresponding fields already filled in. Setting this to zero will insert a template with place-holders marking off the places where fields need to be filled.

This option when set to 1, temporarily freezes Latex-Suite's macro expansion. It might be useful when you are using some other keymap which is causing excessive macro expansion. Use a buffer-local variable of the same name if you wish to affect just the present buffer.

With so many visual maps, its helpful to have a way of catching typing errors made in visual mode. What this does is to prompt you to correct your visual mode mapping if you start out with g:Tex_Leader and then type some illegal keys. It basically maps just the g:Tex_Leader character to a function.

Whether or not you want to use diacritics.

The mappings in Latex-Suite are by default prefixed with the back-tick character. For example, `/ inserts \frac{<++>}{<++>}<++> etc. You can change the prefix with the following setting. ',', '/', '`' are preferred values. '' or '\' will lead to a lot of trouble.

g:Tex_Leader is also used for visual mode mappings for fonts.

In order to avoid clashes between the large number of visual mode macros provided, the visual mode macros for environments and sections start with a character different from g:Tex_Leader.

This string represents a comma separated list of fields corresponding to environments. Pressing <F5> in insert-mode in the body of the document asks you to choose from one of these environments to insert.

Leaving this string empty will leave the <F5> key unmapped

This string represents a comma separated list of environments which are mapped to <Shift-F-1> through <Shift-F-4>. For example, pressing <Shift-F-2> with this setting inserts the eqnarray environment.

Leaving this string empty will leave <Shift-F-1> through <Shift-F-4> unmapped.

This string represents a comma separated list of LaTeX commands which Latex-Suite uses for the <F7> and <S-F7> maps as described here.

Leaving this string empty will leave the <F7> key unmapped.

This setting affects the style which Latex-Suite uses to insert an \item when <Alt-I> is pressed as described here. By default Latex-Suite defines styles for the following environments:

Each style is defined by a variable of the form g:Tex_ItemStyle_{envname} where envname is the name of the environment for which the style is defined. For example, by default

g:Tex_ItemStyle_description = '\item[<+label+>] <++>'

Redefining the style for a particular environment or defining a style for an entirely new environment is simply a matter of setting the value of a variable of the corresponding name.

Whether or not <Backspace> deletes diacritics.

Whether or not the smart quotes functionality is available.

If enabled, the quote characters can be customized by setting the following variables:

Non-English users will want to change these settings to their locale. These global variables will be ignored if there are buffer-local variables (with the same name), which may be set in the language specific package files, such as $VIM/ftplugin/latex-suite/packages/german.

These three settings affect the aesthetics of the completion functionality.

This string describes the directories which are scanned while trying to search for .bib and .bbl files. See the cite completion section for more details.

This string should be set in the syntax accepted by Vim's native 'path' setting. Do not include the present directory '.'. While searching for bibliography files, the present directory will be prepended to this variable.

When set to 1, Latex-Suite searches for \labels in all .tex files in the directory containing the file being edited when <F9> is pressed. See \ref completion for details.

This setting is meant to be initialized on a per-project basis using the Latex-Suite master file as described in Latex-Suite Project section. It is a list of source files which are used in the project. If defined, then instead of using the logic described in Tex_UseSimpleLabelSearch to search for files in which to search for \labels, we simply search for \labels in this list. This significantly reduces the time it takes to generate the list of possible completions for large projects.

The list is specified as a whitespace separated list of filenames relative to the location of the main file.

When this variable is non-zero, then Latex-Suite will try to remember results from the \cite completion as described in this section.

Use this setting to choose the default target format. For example, setting this to pdf makes Latex-Suite compile a pdf file when you press \ll and fire up the pdf viewer on pressing \lv. Make sure that a rules for compiling and viewing have been defined for this target format as described here and here.

Here <format> refers to the target format for which this rule is defined. Latex-Suite supports compiling into dvi, ps and pdf by default. All these rules are strings defined by default as follows:

If you desire forward and inverse searching via Latex-Suite, you will need to change g:Tex_CompileRule_dvi to include -src-specials. However, this has been known to cause problems with the output file. Therefore, use this with care.

By default, there are no format dependencies defined. Each definition is of the form above where <format> is a string such as 'dvi' etc.

The value of each string is a comma separated string such as 'dvi,ps'. See the Compiler dependency section to see how to use/specify this setting

This is a comma separated string of formats for which the compiler needs to be called multiple times in order to get cross-references, citations etc right. See the Compiling multiple times section for details.

The default value of this setting is

\"Underfull\n".
\"Overfull\n".
\"specifier changed to\n".
\"You have requested\n".
\"Missing number, treated as zero.\n".
\"There were undefined references\n"
\"Citation %.%# undefined"

This setting defines a set of patterns which will be filtered out when displaying the output from the latex compiler. This is to aid in filtering out very common warnings/errors.

This setting defines a "filter level" or an "ignore level". A value of 7 for instance means that any warning/error matching with any of the first 7 fields of g:Tex_IgnoredWarnings will be ignored. Setting this value to zero will mean that no error/warning is ignored. However, even with a value of zero, Latex-Suite will filter out most of the text which a LaTeX compiler typically produces. Use

TCLevel strict

from within Vim in order to see all the lines from the compiler's output.

When set to 1, then if a makefile or Makefile is present in the current directory, then Latex-Suite sets the makeprg option to just "make <target>", where <target> is the target format chosen using the TCTarget or TTarget commands.

When set to 0, then Latex-Suite will set the makeprg setting to whatever is defined by the g:Tex_CompileRule_target setting.

If set to 1, then pressing \ll will take you to the location of the first warning/error, otherwise you will remain in the original location but the errors/warnings will be listed in the preview window.

Here <format> refers to a format such as dvi, ps, etc. This variable defines the program which will be called to display a file of that format.

By default, Latex-Suite defines viewer programs for viewing DVI, PS and PDF formats as follows:

For Macintosh systems, these strings are left empty by default. This lets the system pick the program for each format. If you define these variables for Mac, the system choice will be over-ridden.

Latex-Suite appends file.format to the above settings while calling the external programs. For example, with

let g:Tex_ViewRule_dvi = 'yap -1'

yap is called as

!start yap -1 file.dvi

from within Vim. (The initial start is used on Windows platforms is to make yap start as a separate process.) If you find the way Latex-Suite constructs the command line too restrictive, you can use the Tex_ViewRuleComplete_format setting for more complete control on how the command line is constructed while calling the external program for viewing.

Here <format> refers to the extension of a output format such as dvi, html etc.

Tex_ViewRuleComplete_format takes precedence over Tex_ViewRule_format if both are specified. By default, Latex-Suite does not define values for Tex_ViewRuleComplete_format for any format. Unlike in the case of Tex_ViewRule_format, Latex-Suite does not modify Tex_ViewRuleComplete_format at all in constructing the command line. The only modification is to substitute '$*' everywhere in the string with the name of the file being viewed (without the extension).

" On *nix platform
let g:Tex_ViewRuleComplete_html = 'MozillaFirebird $*/index.html &'
" On windows platform
let g:Tex_ViewRuleComplete_html = 'start MozillaFirebird $*/index.html'

If set to 0, Latex-Suite will suppress showing all menus. Useful if you mostly work in terminals.

This setting decides the location of the first top-level Latex-Suite menu. You can for example shift all the menus created by Latex-Suite to the very end by setting this value to a large number like 990.

The Tex-Math menu consists of hundreds of mathematical symbols used in LaTeX. This menu comprises about 75% of the menus.

This setting controls the "compactness" of the menus. If set to 1, then the Font, Counter and Dimensioning menus are collected together in a single menu called Tex-Elements, otherwise, they will each get a separate menu.

Setting this to zero will stop Latex-Suite from automatically creating the TeX-Suite > Packages > Supported menu at startup. You can still create the menu after startup by going to TeX-Suite > Configure Menu.

This string is the prefix added to all the menus created by Latex-Suite. If you define this variable with a dot ('.') as the last character, then all the menus created by Latex-Suite will be nested under a single master menu. For example, set this to '&LaTeX-Suite.' to nest all menus under a menu called &LaTeX-Suite.

This setting controls whether Latex-Suite uses utf-8 symbols to display some of the mathematical symbols in the TeX-Math menu. It is necessary for your system/GUI to support utf-8. Setting this to 1 has the side-effect of setting the 'encoding' option of Vim to 'utf-8'.

Setting this to zero completely disables Latex-Suite's folding functionality. However, the TexFoldTextFunction() is still available in case you want to use another folding scheme but still want to continue using the fold text function.

This setting controls whether Latex-Suite automatically creates manual folds for a file when it is opened. You can still use the \rf mapping to refresh/create folds even when this variable is set to zero.

This setting describes the directories scanned by Latex-Suite while searching for custom user packages as described in the custom packages section. Do not include the present directory in this setting. The present directory is always scanned for custom packages.

This string should be set in the syntax accepted by Vim's native 'path' setting.