10.2 Latex Suite Commands

10.2.1 :TMacro [{macro}]
10.2.2 :TMacroEdit [{macro}]
10.2.3 :TMacroNew
10.2.4 :TMacroDelete [{macro}]
10.2.5 :TPackage [{package, ...}]
10.2.6 :TPackageUpdate
10.2.7 :TPackageUpdateAll
10.2.8 :TTemplate [{template}]
10.2.9 :TSection [{argument}]
10.2.10 :TSectionAdvanced
10.2.11 :TLook
10.2.12 :TLookBib
10.2.13 :TLookAll
10.2.14 :TPartComp
10.2.15 :TPartView
10.2.16 :Tshortcuts [{arg}]

10.2.1 :TMacro [{macro}]

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).

10.2.2 :TMacroEdit [{macro}]

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).

10.2.3 :TMacroNew

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

10.2.4 :TMacroDelete [{macro}]

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)

10.2.5 :TPackage [{package, ...}]

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.

10.2.6 :TPackageUpdate

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

10.2.7 :TPackageUpdateAll

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.

10.2.8 :TTemplate [{template}]

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)

10.2.9 :TSection [{argument}]

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

0part
1chapter
2section
3subsection
4subsubsection
5paragraph
6subparagraph

+<n> inserts section name <n> logical levels above the last used comand
-<n> inserts section name <n> logical levels below the last used comand
+ inserts section name one logical level below the last used command (equal to +1).
++ inserts section name two logical levels below the last used command (equal to +2).
- inserts section name one logical level over the last used command (equal to -1).
-- inserts section name two logical levels over the last used command (equal to -2).

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

10.2.10 :TSectionAdvanced

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.

10.2.11 :TLook

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.

10.2.12 :TLookBib

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|.

Note

TLookBib uses :grep command and is using 'grepprg'. Its regular expressions can be different from those of Vim.

10.2.13 :TLookAll

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.

10.2.14 :TPartComp

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.

10.2.15 :TPartView

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

10.2.16 :Tshortcuts [{arg}]

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

gGeneral shortcuts
eEnvironment shortcuts
fFont shortcuts
sSection shortcuts
mMath shortcuts
aAll shortcuts