[Vim-latex-cvs] SF.net SVN: vim-latex:[1088] trunk/htdocs
Brought to you by:
srinathava,
tmaas
From: <tm...@us...> - 2010-01-27 21:06:18
|
Revision: 1088 http://vim-latex.svn.sourceforge.net/vim-latex/?rev=1088&view=rev Author: tmaas Date: 2010-01-27 21:06:02 +0000 (Wed, 27 Jan 2010) Log Message: ----------- remove outdated latex-suite docs from webroot, redirect to currenty one Modified Paths: -------------- trunk/htdocs/.htaccess Removed Paths: ------------- trunk/htdocs/latex-suite.html trunk/htdocs/latex-suite.txt Modified: trunk/htdocs/.htaccess =================================================================== --- trunk/htdocs/.htaccess 2010-01-27 21:01:29 UTC (rev 1087) +++ trunk/htdocs/.htaccess 2010-01-27 21:06:02 UTC (rev 1088) @@ -14,3 +14,6 @@ Redirect permanent /latexSuite.tar.gz https://sourceforge.net/projects/vim-latex/files/very-old-releases/latexSuite.tar.gz/download Redirect permanent /latexSuite.zip https://sourceforge.net/projects/vim-latex/files/very-old-releases/latexSuite.zip/download + +Redirect seeother /latex-suite.txt http://vim-latex.sourceforge.net/documentation/latex-suite.txt +Redirect seeother /latex-suite.html http://vim-latex.sourceforge.net/documentation/latex-suite.html Deleted: trunk/htdocs/latex-suite.html =================================================================== --- trunk/htdocs/latex-suite.html 2010-01-27 21:01:29 UTC (rev 1087) +++ trunk/htdocs/latex-suite.html 2010-01-27 21:06:02 UTC (rev 1088) @@ -1,850 +0,0 @@ -<h1>Vim documentation: <A HREF="latex-suite.html#latex-suite">latex-suite</A></h1><hr><pre> -<font color="#804040">*<a name="latex-suite">latex-suite</a>*</font> Tools for an enhanced <A HREF="latexhelp.html#LaTeX">LaTeX</A> environment in Vim - For <font color="#008080">Vim version 6.0</font> and above. - Last Change: Fri Nov 15 12:00 PM 2002 PST - - By Srinath Avadhanula <sr...@fa...>, - Mikolaj Machowski <mi...@wp...> - et. al (<font color="#008080">|<A HREF="latex-suite.html#latex-suite-credits">latex-suite-credits</A>|</font>) - - -Latex-Suite attempts to provide a comprehensive set of tools to view, edit and -compile <A HREF="latexhelp.html#LaTeX">LaTeX</A> documents in Vim. Together, they provide tools starting from -macros to speed up editing <A HREF="latexhelp.html#LaTeX">LaTeX</A> documents to functions for forward searching -.dvi documents. Latex-suite has been possible because of the contributions of -many people. Please see <font color="#008080">|<A HREF="latex-suite.html#latex-suite-credits">latex-suite-credits</A>|</font> for a <A HREF="latexhelp.html#list">list</A> of people who have -helped. - -<font color="#6a5acd">{Vi of course does not have any of this}</font> -<span style="background-color: #ffff00"><font color="#0000ff">NOTE</font></span>: If you are viewing this in vim 6.0+, then the sections should appear - folded (see <font color="#008080">|folding|</font>). Use <font color="#008080">|za|</font> to toggle back and forth between open - and closed views. -<span style="background-color: #ffff00"><font color="#0000ff">NOTE</font></span>: If the sections do not appear folded, press za in normal mode. This will - fold up everything and it will be much easier to navigate. - -<font color="#008080">===========================================================================</font> -<font color="#804040"><b>OVERVIEW </b></font><font color="#804040">*<a name="latex-suite-overview">latex-suite-overview</a>*</font> - -<font color="#804040"><b> </b></font><font color="#804040">*<a name="latex-suite-optimal-settings">latex-suite-optimal-settings</a>*</font> -Latex-Suite works best if you have the following settings in your ~/.vimrc: -<font color="#ffffff">></font> -<font color="#008000"> " this line is responsible for loading <A HREF="latex-suite.html#latex-suite">latex-suite</A> when a .tex file is</font> -<font color="#008000"> " opened.</font> -<font color="#ffffff"><</font> filetype plugin on<font color="#ffffff"> ></font> -<font color="#008000"> " for automatic indentation specific to LaTeX.</font> -<font color="#ffffff"><</font> filetype indent on<font color="#ffffff"> ></font> - -In addition, the following settings could go in your ~/.vim/ftplugin/tex.vim -file: <font color="#ffffff"> ></font> - -<font color="#008000"> " this is mostly a matter of taste. but <A HREF="latexhelp.html#LaTeX">LaTeX</A> looks good with just a bit</font> -<font color="#008000"> " of indentation.</font> -<font color="#ffffff"><</font> set sw=2<font color="#ffffff"> ></font> -<font color="#008000"> " TIP: if you write your \label's as \label{fig:something}, then if you</font> -<font color="#008000"> " type in \ref{fig: and press <C-n> you will automatically cycle through </font> -<font color="#008000"> " all the <A HREF="latexhelp.html#figure">figure</A> labels.</font> -<font color="#ffffff"><</font> set iskeyword+=:<font color="#ffffff"> ></font> - - -The tools which are included in <A HREF="latexhelp.html#LaTeX">LaTeX</A> suite can be grouped together into the -following. Almost every feature described here can be customized to some -degree. Please see the included file latex-suite/texrc file for the complete -<A HREF="latexhelp.html#list">list</A> of variables which can be customized. - -<font color="#804040"><b>TABLE OF CONTENTS </b></font><font color="#804040">*<a name="latex-suite-toc">latex-suite-toc</a>*</font> - -<font color="#008080">|<A HREF="latex-suite.html#latex-macros">latex-macros</A>|</font> Insert and visual mode mappings and menu items for - commonly used <A HREF="latexhelp.html#LaTeX">LaTeX</A> typesetting elements - -<font color="#008080">|<A HREF="latex-suite.html#latex-compiling">latex-compiling</A>|</font> This version of <A HREF="latex-suite.html#latex-suite">latex-suite</A> ships with a version of the - compiler specification which produces slightly less - verbose output. It can also be dynamically re-configured - to change the verbosity level. - -<font color="#008080">|<A HREF="latex-suite.html#latex-viewing">latex-viewing</A>|</font> This is a set of functions which open up the compiled .dvi - document using the specified DVI viewer. - -<font color="#008080">|<A HREF="latex-suite.html#latex-searching">latex-searching</A>|</font> Xdvi (for UNIX) and Yap (for Windows) both provide ways - for "forward searching" <A HREF="latexhelp.html#LaTeX">LaTeX</A> documents. This section - describes how to use these features and how to set up your - dvi viewer to best use this feature. - -<font color="#008080">|<A HREF="latex-suite.html#latex-folding">latex-folding</A>|</font> manual folding based on <A HREF="latexhelp.html#LaTeX">LaTeX</A> syntax elements. - -<font color="#008080">|<A HREF="latex-suite.html#latex-packages">latex-packages</A>|</font> This module provides a way to generate custom menus based - on the packages used in the file being edited. - -<font color="#008080">|<A HREF="latex-suite.html#latex-templates">latex-templates</A>|</font> Custom templates - -<font color="#008080">|<A HREF="latex-suite.html#latex-macros">latex-macros</A>|</font> Custom macros - -<font color="#008080">|<A HREF="latex-suite.html#latex-help">latex-help</A>|</font> LaTeX's tex-info file translated into a vim help file. - -<font color="#008080">|<A HREF="latex-suite.html#latex-dictionary">latex-dictionary</A>|</font> A dictionary of standard <A HREF="latexhelp.html#LaTeX">LaTeX</A> terms. - -<font color="#008080">|latex-tools|</font> This version of <A HREF="latex-suite.html#latex-suite">latex-suite</A> also ships with 2 external - tools: - 1. <font color="#008080">|vimlatex|</font> an external utility which filters the output - of the <A HREF="latexhelp.html#LaTeX">LaTeX</A> compiler in order to ensure a more robust - error-parsing. - 2. <font color="#008080">|ltags|</font> A script to generate a tags file. It recognizes - files being \input'ed into a main file. - (ltags is written by Dimitri Antoniou) - -<font color="#008080">===========================================================================</font> -<font color="#804040"><b>LATEX MACROS </b></font><font color="#804040">*<a name="latex-macros">latex-macros</a>*</font> - -Latex-Suite ships with a very comprehensive set of insert mode and visual mode -mappings and menu items to typeset most of the <A HREF="latexhelp.html#LaTeX">LaTeX</A> elements. - -We use a "macro" to refer to the collection of 3 objects, an insert mode -mapping, a visual mode mapping and a menu item. For example, a <A HREF="latexhelp.html#figure">figure</A> macro -refers to the insert mode mapping 'EFI', the visual mode mapping ',fi' and the -menu item Tex-Environments.figure. - -For environments, sections and fonts, the insert mode mappings are a sequence -of 3 capital letters. The visual mode mapping follows from the insert mode -mapping by replacing the first character by a comma (',') (for environments -and sections) or back-tick ('`') (for fonts) and converting the rest to lower -case.<font color="#ffffff"> ></font> -<font color="#008000"> | Insert Mode | Visual Mode</font> -<font color="#008000"> -------------+---------------+-------------</font> -<font color="#008000"> environmnts | EFI | ,fi</font> -<font color="#008000"> fonts | FSF | `sf</font> - -The menu item also specifies the insert and visual mode macros. The menus -behave differently from the insert mode macros in that they ask questions on -the command line in a "wizard" sort of manner and then generate a template -which includes the information gathered. By contrast, the insert mode macros -do not ask any questions and generate a template with <font color="#008080">|<A HREF="latex-suite.html#placeholders">placeholders</A>|</font> at each -input location. - -<font color="#804040"><b> </b></font><font color="#804040">*<a name="placeholders">placeholders</a>*</font> <font color="#804040">*<a name="placeholder">placeholder</a>*</font> -<font color="#804040"><b> </b></font><font color="#804040">*<a name="place-holder">place-holder</a>*</font> <font color="#804040">*<a name="place-holders">place-holders</a>*</font> -<span style="background-color: #ffff00"><font color="#0000ff">NOTE</font></span>: All these macros implement Stephen Riem's bracketing system and Gergely -Kontra's JumpFunc() for handling place-holders. This consists of using -"place-holders" to mark off locations where the next relevant editing has to -be done. As an example, when the user types in "EFI" in insert mode, she will -get the following:<font color="#ffffff"> ></font> - -<font color="#008000"> \begin{figure}[h]</font> -<font color="#008000"> \centerline{\psfig{figure=\xABeps file\xBB}}</font> -<font color="#008000"> \caption{\xABcaption text\xBB}</font> -<font color="#008000"> \label{fig:\xABlabel\xBB}</font> -<font color="#008000"> \end{figure}\xAB\xBB</font> -<font color="#ffffff"><</font> -The text \xABeps file\xBB will be selected and she will be left in <font color="#008080">|select-mode|</font> so -that she can continue typing straight away. After having typed in the file -name, she can press Control-J (while still in insert-mode). This will take her -directly to the next "place-holder". i.e, the \xABcaption text\xBB will be visually -selected with vim in select mode again for typing in the caption. This saves -on a lot of key presses. - -<span style="background-color: #ffff00"><font color="#0000ff">NOTE</font></span>: Furthermore these mappings are are not standard mappings in the sense -that only the last character is mapped. See plugin/imaps.vim for further -documentation. For example, in the example above, you can press the characters -'E', 'F' and 'I' as slowly as you wish. The characters are visible as you type -them and you can use the movement or backspace key to correct yourself unlike -normal mappings. - -The macros can be divided into the following main categories: -<font color="#008080">---------------------------------------------------------------------------</font> -Environment Mappings - -These mappings insert <A HREF="latexhelp.html#LaTeX">LaTeX</A> "environments" such as<font color="#ffffff"> ></font> -<font color="#008000"> \begin{center}</font> -<font color="#008000"> \xAB\xBB</font> -<font color="#008000"> \end{center}\xAB\xBB</font> -with the cursor left at the first <font color="#008080">|<A HREF="latex-suite.html#placeholder">placeholder</A>|</font>. -(The environment above is generated by typing ECE in insert mode) - -Rule for remembering shortcuts: -<font color="#008080">-------------------------------</font> -1. All environment mappings begin with 'E' - -2. If the environment can be broken up into 2 distinct words, such as - <A HREF="latexhelp.html#flushright">flushright</A> (flush + right), then the next 2 letters are the first letters - of the 2 words. - Example:<font color="#ffffff"> ></font> -<font color="#008000"> <A HREF="latexhelp.html#flushleft">flushleft</A> (_f_lush + _l_eft) ---> EFL</font> -<font color="#008000"> <A HREF="latexhelp.html#flushright">flushright</A> (_f_lush + _r_ight) ---> EFR</font> -<font color="#008000"> <A HREF="latexhelp.html#eqnarray">eqnarray</A> (_e_qn + _a_rray) ---> EEA</font> - -<font color="#ffffff"><</font> If on the other hand, the environment name cannot be broken up into 2 - distinct words, then the next 2 letters are the first 2 letters of the name - of the environment. - Example:<font color="#ffffff"> ></font> -<font color="#008000"> <A HREF="latexhelp.html#equation">equation</A> (_eq_uation) ---> EEQ</font> - -Of course, not every last one of the environments can follow this rule because -of ambiguities. In case of doubt, pull down the Tex-Environments menu. The -menu item should give the hint for the map. - -Along with the insert mode mappings, a set of visual mode mappings is -provided which encloses the visually selected region in an environment. -These maps are related to the corresponding insert mode mappings by the -following rule:<font color="#ffffff"> ></font> -<font color="#008000"> ECE --> ,ce</font> -and so on. i.e, the leading E becomes ',' and the next 2 letters are small -case. Some of the visual mode mappings are sensetive to whether you choose -line-wise or character wise. For example, if you choose a word and press -,ce, then you get \centerline<font color="#6a5acd">{word}</font>, whereas if you press ,ce on a line-wise -selection, you get:<font color="#ffffff"> ></font> -<font color="#008000"> \begin{center}</font> -<font color="#008000"> line</font> -<font color="#008000"> \end{center}</font> - - -<font color="#008080">---------------------------------------------------------------------------</font> -Font Mappings: - -These mappings insert font descriptions such as:<font color="#ffffff"> ></font> -<font color="#008000"> \textsf{\xAB\xBB}\xAB\xBB</font> -again with the cursor at the first place-holder. - -Mnemonic: - -1. first letter is always F (F for font) -2. next 2 letters are the 2 letters describing the font. - -Example: the above mapping is triggered by FSF. - -Just like environment mappings, you can visually select an area and press -`sf to have it enclosed in:<font color="#ffffff"> ></font> -<font color="#008000"> \textsf{word}</font> -or<font color="#ffffff"> ></font> -<font color="#008000"> {\sffamily</font> -<font color="#008000"> line</font> -<font color="#008000"> }</font> -depending on character-wise or line-wise selection. - - -<font color="#008080">---------------------------------------------------------------------------</font> -Section Mappings: - -Inserts <A HREF="latexhelp.html#LaTeX">LaTeX</A> sections:<font color="#ffffff"> ></font> -<font color="#008000"> <A HREF="latexhelp.html#\section">\section</A></font> -etc. Just as in the case of environments and fonts, can be enclosed with a -visual selection. The enclosing is not sensetive to character or line-wise -selection. - -Mnemonic: (make your own!)<font color="#ffffff"> ></font> -<font color="#008000"> SPA for part</font> -<font color="#008000"> SCH for chapter</font> -<font color="#008000"> SSE for section</font> -<font color="#008000"> SSS for subsection</font> -<font color="#008000"> SS2 for subsubsection</font> -<font color="#008000"> SPG for paragraph</font> -<font color="#008000"> SSP for subparagraph</font> - -Example: - SSE in insert mode inserts<font color="#ffffff"> ></font> -<font color="#008000"> \section{\xAB\xBB}\xAB\xBB</font> -<font color="#ffffff"><</font> If you select a word or line and press `se, then you get<font color="#ffffff"> ></font> -<font color="#008000"> \section{section name}</font> -<font color="#ffffff"><</font> The menu item in Tex-Environments.Sections have a sub-menu called - 'Advanced'. Choosing an item from this sub-menu asks 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. - - -<font color="#008080">---------------------------------------------------------------------------</font> -AUC-TEX key bindings: - -These are simple 2 key expansions for some very commonly used <A HREF="latexhelp.html#LaTeX">LaTeX</A> elements. - Examples:<font color="#ffffff"> ></font> - -<font color="#008000"> `^ expands to \hat{\xAB\xBB}\xAB\xBB</font> -<font color="#008000"> `_ expands to \bar{\xAB\xBB}\xAB\xBB</font> -<font color="#008000"> `6 expands to \partial</font> -<font color="#008000"> `8 expands to \infty</font> -<font color="#008000"> `/ expands to \frac{\xAB\xBB}{\xAB\xBB}\xAB\xBB</font> -<font color="#008000"> `% expands to \frac{\xAB\xBB}{\xAB\xBB}\xAB\xBB</font> -<font color="#008000"> `@ expands to \circ</font> -<font color="#008000"> `0 expands to ^\circ</font> -<font color="#008000"> `= expands to \equiv</font> -<font color="#008000"> `\ expands to \setminus</font> -<font color="#008000"> `. expands to \cdot</font> -<font color="#008000"> `* expands to \times</font> -<font color="#008000"> `& expands to \wedge</font> -<font color="#008000"> `- expands to \bigcap</font> -<font color="#008000"> `+ expands to \bigcup</font> -<font color="#008000"> `( expands to \subset</font> -<font color="#008000"> `) expands to \supset</font> -<font color="#008000"> `< expands to \le</font> -<font color="#008000"> `> expands to \ge</font> -<font color="#008000"> `, expands to <A HREF="latexhelp.html#\nonumber">\nonumber</A></font> -<font color="#008000"> `~ expands to \tilde{\xAB\xBB}\xAB\xBB</font> -<font color="#008000"> `; expands to \dot{\xAB\xBB}\xAB\xBB</font> -<font color="#008000"> `: expands to \ddot{\xAB\xBB}\xAB\xBB</font> -<font color="#008000"> `2 expands to \sqrt{\xAB\xBB}\xAB\xBB</font> -<font color="#008000"> `| expands to \Big|</font> -<font color="#008000"> `I expands to \int_{\xAB\xBB}^{\xAB\xBB}\xAB\xBB"</font> -<font color="#ffffff"><</font> - (again, notice the convenient place-holders) - -In addition the visual mode macros are provided: -<font color="#ffffff">></font> -<font color="#008000"> `( encloses selection in \left( and \right)</font> -<font color="#008000"> `[ encloses selection in \left[ and \right]</font> -<font color="#008000"> `{ encloses selection in \left\{ and \right\}</font> -<font color="#008000"> `$ encloses selection in $$ or \[ \] depending on characterwise or</font> -<font color="#008000"> linewise selection</font> - -<span style="background-color: #ffff00"><font color="#0000ff">NOTE</font></span>: There is no menu item for these mappings. (as of this writing). - - -<font color="#008080">---------------------------------------------------------------------------</font> -Diacritics: (by Lubomir Host) - -Diacritics speed up typing European languages. - -<font color="#ffffff">></font> -<font color="#008000"> +<l> expands to \v{<l>}</font> -<font color="#008000"> =<l> expands to \'{<l>}</font> -<font color="#ffffff"><</font> where <font color="#6a5acd"><l></font> is a letter ('a' to 'z' and 'A' to 'Z') -<font color="#ffffff">></font> -<font color="#008000"> +} expands to \"{a} </font> -<font color="#008000"> +: expands to \^{o} </font> -<font color="#ffffff"><</font> -Latex-Suite also ships with a function SmartBS(), which offers another -convinience, i.e diacritic characters are treated as a single character for -backspacing. - - -<font color="#008080">---------------------------------------------------------------------------</font> -Greek Letters: -<font color="#ffffff">></font> -<font color="#008000"> Lower case:</font> -<font color="#008000"> `a through `z expand to \alpha through \zeta.</font> -<font color="#008000"> Upper case:</font> -<font color="#008000"> `D = \Delta</font> -<font color="#008000"> `F = \Phi</font> -<font color="#008000"> `G = \Gamma</font> -<font color="#008000"> `Q = \Theta</font> -<font color="#008000"> `L = \Lambda</font> -<font color="#008000"> `X = \Xi</font> -<font color="#008000"> `Y = \Psi</font> -<font color="#008000"> `S = \Sigma</font> -<font color="#008000"> `U = \Upsilon</font> -<font color="#008000"> `W = \Omega</font> - -<span style="background-color: #ffff00"><font color="#0000ff">NOTE</font></span>: <A HREF="latexhelp.html#LaTeX">LaTeX</A> does not support upper case for all greek alphabets. - - -<font color="#008080">---------------------------------------------------------------------------</font> -<A HREF="latexhelp.html#LaTeX">LaTeX</A> Math Menu: -<font color="#804040"><b> </b></font><font color="#804040">*<a name="latex-math-menu">latex-math-menu</a>*</font> - -This menu contains over 600 commands for inserting math signs into LaTeX -document. They are grouped into submenus as: Arrows, MathFonts, Greek -(letters), BinaryRel(ations) and many others. At the top are basic signs -leading into math mode. Some of symbols have hints for mappings in AUC-TeX -style. - - -<font color="#008080">---------------------------------------------------------------------------</font> - - -<font color="#008080">===========================================================================</font> -<font color="#804040"><b>LATEX COMPILING </b></font><font color="#804040">*<a name="latex-compiling">latex-compiling</a>*</font> - -This functionality is available via the TeX-Suite menu. - -Latex-suite ships with a set of tools to compile <A HREF="latexhelp.html#LaTeX">LaTeX</A> files into various -formats and view them. - -If you are using commonly used <A HREF="latexhelp.html#LaTeX">LaTeX</A> tools, then you should be all set as soon -as you download and install latex-suite. In order to compile a <A HREF="latexhelp.html#LaTeX">LaTeX</A> file, -simply press \ll while editing the file. This runs <A HREF="latexhelp.html#latex">latex</A> on the current file -and displays the errors in a <font color="#008080">|quickfix-window|</font>. You can then scroll through -the errors and press <font color="#6a5acd"><enter></font> to be taken to the location of the corresponding -error. - -<font color="#008080">|<A HREF="latex-suite.html#latex-compiler-target">latex-compiler-target</A>|</font> : specifying a different target format for - compilation. -<font color="#008080">|<A HREF="latex-suite.html#latex-suite-compiler">latex-suite-compiler</A>|</font> : specifying a diffrent compiler. -<font color="#008080">|<A HREF="latex-suite.html#latex-master-file">latex-master-file</A>|</font> : specifying a different file for compilation - instead of file being edited. -<font color="#008080">|<A HREF="latex-suite.html#latex-compiler-customization">latex-compiler-customization</A>|</font> : customizing the output of the - latex-compiler. - -<font color="#804040"><b> </b></font><font color="#804040">*<a name="latex-compiler-target">latex-compiler-target</a>*</font> -In order to effectively use <A HREF="latex-suite.html#latex-suite">latex-suite</A> to compile and view formats other than -DVI, you will need to edit the <font color="#008080">|texrc|</font> file and set the variables: -<font color="#ffffff">></font> -<font color="#008000"> g:Tex_CompileRule_<format></font> -<font color="#008000"> g:Tex_ViewRule_<format></font> - -where <font color="#6a5acd"><format></font> is a string like "pdf", "dvi" etc. These variables define -``rules'' for compiling and viewing the corresponding target. - -Example: In texrc, the compilation rule for dvi is by default:<font color="#ffffff"> ></font> -<font color="#008000"> g:Tex_CompileRule_dvi = 'latex --interaction=nonstopmode $*'</font> - -Default values are also provided for ps and pdf formats. You might want to -change these rules in texrc according to your local tex environment. - -Once a ``rule'' has been set up for a format, you can set the target format by -using the {TeX-Suite.Target Format} menu item. Alternatively, you can use the -<font color="#008080">|:TTarget|</font> command. You can also set the viewer and compiler to different -formats, by using the menu items or using the commands <font color="#008080">|:TCTarget|</font> and -<font color="#008080">|:TVTarget|</font>. - -<span style="background-color: #ffff00"><font color="#0000ff">NOTE</font></span>: If you try choosing a format for which a rule is not defined, you -will get a short warning message and no action will be taken. - -<span style="background-color: #ffff00"><font color="#0000ff">NOTE</font></span>: Specifying a different format does not automatically account for -dependencies. For example, if in your case you do: - .tex -> .dvi -> .ps -> .pdf -then you will need to choose dvi first, compile, change format to ps, compile, -change format and so on. - -<font color="#804040"><b> </b></font><font color="#804040">*<a name="latex-suite-compiler">latex-suite-compiler</a>*</font> -The simplest way to choose a different compiler is to edit the<font color="#ffffff"> ></font> -<font color="#008000"> g:Tex_CompileRule_dvi</font> -variable. - -If however, you are only using the compiler/tex.vim module from latex-suite, -there are a couple of other ways to change things. - -Just as in the case of the standard tex compiler, ``if b:tex_flavor or -g:tex_flavor (in this precedence) variable exists, it defines TeX flavor for -:make (actually, this is the name of executed command), and if both variables -do not exist, it defaults to "<A HREF="latexhelp.html#latex">latex</A>"'' (from <font color="#008080">|compiler-tex|</font>) - -<span style="background-color: #ffff00"><font color="#0000ff">NOTE</font></span>: For win32 users user MikTeX, sometimes the <A HREF="latexhelp.html#latex">latex</A> compiler's output has a -bug where a single number is split across different lines. In this case, put -the included vimlatex utility somehwere in your $PATH, make it executable and -point g:tex_flavor to it. This is not always necessary, and you might want to -try it without vimlatex till you first notice any problem. - -<font color="#804040"><b> </b></font><font color="#804040">*<a name="latex-master-file">latex-master-file</a>*</font> -Often times the file you are currently editing is only a fragment being -\input'ed into a master tex file. In such cases you will need to do create a -dummy file in the directory containing the current file. This dummy file is of -the form: -<font color="#ffffff">></font> -<font color="#008000"> <mailfilename>.latexmain</font> - -In other words, if the current file is ~/thesis/chapter.tex, where -chapter.tex is being \input'ed into ~/thesis/main.tex, then create a file -called<font color="#ffffff"> ></font> -<font color="#008000"> main.tex.latexmain </font> -<font color="#ffffff"><</font> -in the ~/thesis directory. This will then run "latex main.tex" -<span style="background-color: #ffff00"><font color="#0000ff">NOTE</font></span>: Here main.tex.latexmain is a different file from main.tex itself. -main.tex need not be renamed. The contents of main.tex.latexmain are not used. -This ofcourse restricts each directory to have a single master file. - -<font color="#804040"><b> </b></font><font color="#804040">*<a name="latex-compiler-customization">latex-compiler-customization</a>*</font> -Latex-suite ships with a modified (enhanced ?) version of the standard tex -compiler plugin maintained by Artem Chuprina. The modifications allow this -version to be customizable. i.e the user can set a verbosity level for the -compiler. - -By default it is set up in a "non-verbose", "ignore-common-warnings" mode, -which means that irrelevant lines from the compilers output will be -ignored and also some very common warnings are ignored. - -Depending on the "ignore-level", (which can be set with the command TCLevel as -described below) the following kinds of messages are ignored. An ignore level -of 3 for instance means that messages of type 1-3 will be ignored. By default, -the ignore level is set to 4. (You can change this by setting -g:Tex_IgnoreLevel in your .vimrc). - -1. <A HREF="latexhelp.html#LaTeX">LaTeX</A> Warning: Underfull box ... -2. <A HREF="latexhelp.html#LaTeX">LaTeX</A> Warning: Overfull box ... - both these warnings (very common) are due to \hbox settings not being - satisfied nicely. -3. <A HREF="latexhelp.html#LaTeX">LaTeX</A> Warning: Specifier 'h' changed to 't'. - This errors occurs when TeX is not able to correctly place a floating - object at a specified location, because of which it defaulted to the - top of the page. -4. <A HREF="latexhelp.html#LaTeX">LaTeX</A> Warning: You have requested ..., - This warning occurs in slitex when using the xypic package. -5. Missing number error: - Usually, when the name of an included eps file is spelled incorrectly, - then the \bb-error message is accompanied by a bunch of "missing - number, treated as zero" error messages. This level ignores these - warnings. - <span style="background-color: #ffff00"><font color="#0000ff">NOTE</font></span>: number 5 is actually a <A HREF="latexhelp.html#LaTeX">LaTeX</A> error, not a warning! - -Use<font color="#ffffff"> ></font> - -<font color="#008000"> TCLevel <level></font> - -where level is a number to set the ignore level dynamically. This will re-do -the <font color="#008000"><b>'efm'</b></font> so that next time you do \ll, you will not be shown those kinds of -warnings. Use "TCLevel 0" to ignore no warnings at all, but still remain in a -"non-verbose", i.e ignore unmatched lines mode. - -When TCLevel is called with the unquoted string strict as<font color="#ffffff"> ></font> - -<font color="#008000"> TClevel strict</font> - -then the <font color="#008000"><b>'efm'</b></font> switches to a "verbose", "no-lines-ignored" mode which is -useful when you want to make <A HREF="latexhelp.html#final">final</A> checks of your document and want to be -careful not to let things slip by. - -You can also choose to ignore other kinds of patterns by setting -g:IgnoreWarnings in your ~/.vimrc. This is a '\xA1' seperated <A HREF="latexhelp.html#list">list</A> of commands. -Its default value is:<font color="#ffffff"> ></font> -<font color="#008000"> let g:Tex_IgnoredWarnings =</font> -<font color="#008000"> \'Underfull\xA1'.</font> -<font color="#008000"> \'Overfull\xA1'.</font> -<font color="#008000"> \'specifier changed to\xA1'.</font> -<font color="#008000"> \'You have requested\xA1'.</font> -<font color="#008000"> \'Missing number, treated as zero.'</font> - - -<font color="#008080">===========================================================================</font> -<font color="#804040"><b>LATEX VIEWING AND SEARCHING </b></font><font color="#804040">*<a name="latex-viewing">latex-viewing</a>*</font> - -Latex-suite ships with a set of functios for viewing .dvi files generated by -LaTeX. Press \lv while viewing a tex file. This will start the dvi viewer on -your system and display the current file in it. If the variable g:DviViewer -exists, then it is used as the program for viewing DVI files, otherwise it -defaults to yap for windows or xdvi for unix. -<span style="background-color: #ffff00"><font color="#0000ff">NOTE</font></span>: These programs are called with some additional arguments. If you DVI -viewer doesnt accept these, then you will need to change the code itself. This -will be configurable by a variable in the future. - -Like in the case of the compiler, you can specify the master file for the -current file (see <font color="#008080">|<A HREF="latex-suite.html#latex-master-file">latex-master-file</A>|</font>) - -<font color="#804040"><b> </b></font><font color="#804040">*<a name="latex-searching">latex-searching</a>*</font> -Yap for windows and some versions of xdvi for windows provide the ability to -do "forward searching" on the .dvi file. This means that you can have the DVI -viewer jump to a specified location. - -Pressing \ls while viewing a <A HREF="latexhelp.html#LaTeX">LaTeX</A> file will perform this function, i.e the -viewer will jump to the location under the cursor. - -<span style="background-color: #ffff00"><font color="#0000ff">NOTE</font></span>: MikTeX requires that the dvi file be generated using the --src-specials -flag in order to enable forward/reverse searching. By default, latex-suite -will call <A HREF="latexhelp.html#LaTeX">LaTeX</A> with this argument on windows (where yap is assumed). - -These functions were added after a tip from Dimitri Antoniou on vim.sf.net. -See<font color="#ffffff"> ></font> -<font color="#008000"> http://vim.sourceforge.net/tips/tip.php?tip_id=225</font> -for a <A HREF="latexhelp.html#description">description</A> on how to get xdvik/yap to play along with Vim. - - -<font color="#008080">===========================================================================</font> -<font color="#804040"><b>LATEX FOLDING </b></font><font color="#804040">*<a name="latex-folding">latex-folding</a>*</font> - -Latex-suite ships with the plugin SyntaxFolds.vim which is a plugin for -creating "fake" syntax folds on the fly. The fold method is actually manual -but the folding is based on <A HREF="latexhelp.html#LaTeX">LaTeX</A> syntax. This offers a speed increase over -regular syntax folding. Ofcourse it has the disadvantage that the folds are -not dynamic, i.e newly created syntax items are not automatically folded up. -(This is a compromise between speed and convinience). - -When you open up a <A HREF="latexhelp.html#LaTeX">LaTeX</A> file, all the portions will be automatically folded -up. However, no new folds will be created until you press <font color="#6a5acd"><F6></font> or \rf. (rf -stands for "refresh folds"). - -The fold-text is set to the first line of the folded text unless the fold is a -table, <A HREF="latexhelp.html#figure">figure</A> etc. (an environment). In this case, if a \caption and/or a -label is found in the folded region, then those are used to make a more -meaningful fold-tex, otherwise the second line of the environment is displayed -along with the name of the environment. In other words, the following<font color="#ffffff"> ></font> - -<font color="#008000"> \begin{figure}[h]</font> -<font color="#008000"> \centerline{\psfig{figure=slidercrank.eps,height=6cm}}</font> -<font color="#008000"> \caption{The Slider Crank Mechanism.}</font> -<font color="#008000"> \label{fig:slidercrank}</font> -<font color="#008000"> \end{figure}</font> -<font color="#008000"> % a <A HREF="latexhelp.html#LaTeX">LaTeX</A> comment.</font> -<font color="#008000"> \begin{eqnarray}</font> -<font color="#008000"> \sin(\pi) = 0</font> -<font color="#008000"> \end{eqnarray}</font> -<font color="#ffffff"><</font> -will be shown as:<font color="#ffffff"> ></font> - -<font color="#008000"> +--- 5 lines: <A HREF="latexhelp.html#figure">figure</A> (fig:slidercrank) : The Slider Crank Mechanism. -----</font> -<font color="#008000"> % a <A HREF="latexhelp.html#LaTeX">LaTeX</A> comment.</font> -<font color="#008000"> +--- 3 lines: <A HREF="latexhelp.html#eqnarray">eqnarray</A> () : \sin(\pi) = 0 --------------------------------</font> -<font color="#ffffff"><</font> - -<font color="#008080">===========================================================================</font> -<font color="#804040"><b>PACKAGE HANDLING </b></font><font color="#804040">*<a name="latex-packages">latex-packages</a>*</font> -<font color="#804040"><b> </b></font><font color="#804040">*<a name="latex-menu-packages">latex-menu-packages</a>*</font> - -This functionality is avaiable via the Tex-Packages menu. - -This module provides ways of customizing the menus based on which packages -are being used in the current <A HREF="latexhelp.html#LaTeX">LaTeX</A> file. When <A HREF="latex-suite.html#latex-suite">latex-suite</A> first starts up, it -scans the <font color="#008080">|<A HREF="latex-suite.html#latex-master-file">latex-master-file</A>|</font> for<font color="#ffffff"> ></font> -<font color="#008000"> \usepackage{name}</font> -lines and if the corresponding package is found in the latex-suite/packages/ -directory, then creates a sub-menu based on the specification found in that -file. - -<font color="#804040"><b> </b></font><font color="#804040">*<a name="latex-package-dictionary">latex-package-dictionary</a>*</font> -Furthermore, if a file with the same name is found in the -latex-suite/dictionaries/ directory, then that file will be added to vim's -<font color="#008000"><b>'dictionary'</b></font> setting for use with the <font color="#008080">|i_CTRL-X_CTRL-K|</font> command. Package -dictionary file should follow outlines specified in <font color="#008000"><b>'dictionary'</b></font>. - - -<font color="#804040"><b> </b></font><font color="#804040">*<a name="latex-package-file">latex-package-file</a>*</font> -A latex-package-file is a simple vim script which defines some global -variables. These global variables are used by <A HREF="latex-suite.html#latex-suite">latex-suite</A> to create the custom -menu. See the latex-suite/packages/exmpl file for a simple example of how to -define a customized package file. - -If you do make a package file for latex-suite, please consider contacting the -<font color="#008080">|<A HREF="latex-suite.html#latex-suite-maintainer">latex-suite-maintainer</A>|</font>. - -Example: - -From the packages menu, choose the<font color="#ffffff"> ></font> -<font color="#008000"> Tex-Packages.Supported1.SIunits </font> -option. This will insert a line of form:<font color="#ffffff"> ></font> -<font color="#008000"> \usepackage[\xAB\xBB]\xAB\xBB{SIunits}\xAB\xBB</font> -at the beginning of the file (with the cursor placed at the first -<font color="#008080">|<A HREF="latex-suite.html#placeholder">placeholder</A>|</font>. You will also notice that the packages menu now contains a -sub-menu called SIunits, which contains the commands and options for the -SIunits package.You can use this sub-menu to insert commands from the package, -add options to the package etc. - -<span style="background-color: #ffff00"><font color="#0000ff">NOTE</font></span>: Since the package file is a vim-script, you could define custom -functions there, add mappings etc. - -You can perform the following actions via the packages menu: - -<font color="#6a5acd">{Update}</font> This command is to be invoked with the cursor placed on the - package name. If the corresponding package is found, then a - sub-menu with the supported commands, options is created. - A <font color="#008080">|<A HREF="latex-suite.html#latex-package-dictionary">latex-package-dictionary</A>|</font> might also be created. - -<font color="#6a5acd">{UpdateAll}</font> This function reads the preamble of the document for - <A HREF="latexhelp.html#\usepackage">\usepackage</A> lines and if latexSuite supports the detected - packages, then sub-menus containing the package options and - commands is created. - A <font color="#008080">|<A HREF="latex-suite.html#latex-package-dictionary">latex-package-dictionary</A>|</font> might also be created. - -<font color="#6a5acd">{Supported}</font> This sub-menu contains a <A HREF="latexhelp.html#list">list</A> of all the package files stored in - latex-suite/packages directory. When you choose one of - these, a \usepackage{package_name} line will inserted in - the preamble of the <font color="#008080">|<A HREF="latex-suite.html#latex-master-file">latex-master-file</A>|</font> and a sub-menu for - the package will be created. - If options are detected, then the inserted line is of the - form: - \usepackage[\xAB\xBB]{package_name} - A <font color="#008080">|<A HREF="latex-suite.html#latex-package-dictionary">latex-package-dictionary</A>|</font> might also be created. - - -<font color="#008080">===========================================================================</font> -<font color="#804040"><b>CUSTOM TEMPLATES </b></font><font color="#804040">*<a name="latex-templates">latex-templates</a>*</font> - -This functionality is available via the TeX-Suite.Templates menu. - -This module provides a way to insert custom templates at the beginning of the -current file. - -When <A HREF="latex-suite.html#latex-suite">latex-suite</A> first starts up, it scans the latex-suite/templates/ directory -and creates menu items based on the files found there. When you select a -template from this menu, the file will be read in above the first line of the -current file. - -A template file can use <font color="#008080">|<A HREF="latex-suite.html#placeholders">placeholders</A>|</font> for easy cursor movement. In addition, -you can use lines such as the following for inserting dates, names -dynamically:<font color="#ffffff"> ></font> -<font color="#008000"> % File: \xA1expand("%")\xA1</font> - -This will create a line of the form:<font color="#ffffff"> ></font> -<font color="#008000"> % File: name.tex</font> - -if the current file name is name.tex. - -<span style="background-color: #ffff00"><font color="#0000ff">NOTE</font></span>: Templates are also accessible for non-gui users with the command -<font color="#008080">|:TexTemplate|</font>. The argument should be name of the corresponding template -file. If the command is called without arguments (preferred usage), then a -<A HREF="latexhelp.html#list">list</A> of avaiable templates is displayed and the user is asked to choose one of -them. - -You can ofcourse place your own templates in this directory. - - -<font color="#008080">===========================================================================</font> -<font color="#804040"><b>CUSTOM MACROS </b></font><font color="#804040">*<a name="latex-custom-macros">latex-custom-macros</a>*</font> - -This functionality is available via the TeX-Suite.Macros menu. - -This module provides a way of inserting customized macros into the current -file. - -When <A HREF="latex-suite.html#latex-suite">latex-suite</A> starts up, it scans the latex-suite/macros/ directory and -creates a menu from the files found there. Each file is considered as a single -macro. You can place your own macros in this directory, using <font color="#008080">|<A HREF="latex-suite.html#placeholders">placeholders</A>|</font> -if wanted. - -When you choose a macro from the menu, the corresponding file is read into the -current buffer after the current cursor position. In non-gui mode, you can -use the <font color="#008080">|<A HREF="latex-suite.html#TexMacro">TexMacro</A>|</font> command instead of choosing from the menu. This command -takes the macro file name as an argument. When called without arguments -(preferred usage), then a <A HREF="latexhelp.html#list">list</A> of avaiable macro files is displayed and the -user is prompted to choose one of them). - -There are some other tools provided in this menu, namely: - -<font color="#6a5acd">{New}</font> Creates a new (unnamed) buffer in the latex-suite/macros/ - directory. - Use the command :TexMacroNew in non-gui mode. - -<font color="#6a5acd">{Edit}</font> Opens up the corresponding macro file for editing. - Use :TexMacroEdit in non-gui mode. - -<font color="#6a5acd">{Delete}</font> Deletes the corresponding macro. - Use the prefixed numbers for fast navigation of menus. - Use :TexMacroDelete in non-gui mode. - -<font color="#6a5acd">{Redraw}</font> Rescans the macros/ directory and refreshes the macros list. - - -<font color="#008080">===========================================================================</font> -<font color="#804040"><b>LATEX MENU CONFIGURATION </b></font><font color="#804040">*<a name="latex-menu-configuration">latex-menu-configuration</a>*</font> - -<font color="#804040"><b> </b></font><font color="#804040">*<a name="latex-menu-configure">latex-menu-configure</a>*</font> - -Generally latex-suite's menus should be configured by setting options in the -<font color="#008080">|texrc|</font> file. But if you feel the need to change after startup, then use the -'TeX-Suite.Configure Menu' menu option to turn some of the menus off and on, -control the nested-ness of some of the menus etc. - - -<font color="#008080">===========================================================================</font> -<font color="#804040"><b>LATEX HELP </b></font><font color="#804040">*<a name="latex-help">latex-help</a>*</font> - -<A HREF="latexhelp.html#latexhelp.txt">latexhelp.txt</A> is a collection of latex.info files `translated' into vim help -format. Now you can seek for help for specific <A HREF="latexhelp.html#LaTeX">LaTeX</A> item without exiting vim. - -Example:<font color="#ffffff"> ></font> -<font color="#008000"> :help <A HREF="latexhelp.html#\kill">\kill</A></font> -gives help for the <A HREF="latexhelp.html#LaTeX">LaTeX</A> <A HREF="latexhelp.html#\kill">\kill</A> command. - -In order to use this help file, you will need to run <font color="#008080">|:helptags|</font> once after -you download and unzip latex-suite. - - -<font color="#008080">===========================================================================</font> -<font color="#804040"><b>LATEX DICTIONARY </b></font><font color="#804040">*<a name="latex-dictionary">latex-dictionary</a>*</font> - -Latex-suite ships with a dictionary of over 600 commands from <A HREF="latexhelp.html#LaTeX">LaTeX</A> and -popular packages. When <A HREF="latex-suite.html#latex-suite">latex-suite</A> starts up, it automatically adds this -dictionary to vim's <font color="#008000"><b>'dictionary'</b></font> option for use with vim's <font color="#008080">|i_CTRL-X_CTRL-K|</font> -command. - -It is also possible to load custom dictionaries automatically when packages -load. This will happen if a package definition file<font color="#ffffff"> ></font> -<font color="#008000"> latex-suite/packages/package.vim</font> -has a corrresponding dictionary<font color="#ffffff"> ></font> -<font color="#008000"> latex-suite/dictionaries/package</font> - - - -<font color="#008080">===========================================================================</font> -<font color="#804040"><b>LATEX SUITE COMMANDS </b></font><font color="#804040">*<a name="latex-suite-commands">latex-suite-commands</a>*</font> - -LatexSuite defines set of commands for non-GUI and power users. They are -taking care about Macros, Templates and Packages. - -:TexMacro [<font color="#6a5acd">{macro}</font>] <font color="#804040">*<a name="TexMacro">TexMacro</a>*</font> - When used without any arguments lists all available macros - defined in latex-suite/macros/ directory and prompt you to - choose one of them. - With one argument <font color="#008080">|:read|</font> this macro under cursor position. - With more than one argument it will not work :) - -:TexMacroEdit [<font color="#6a5acd">{macro}</font>] <font color="#804040">*<a name="TexMacroEdit">TexMacroEdit</a>*</font> - Splits window for editing <font color="#6a5acd">{macro}</font>. - When used without any arguments lists all available macros - defined in latex-suite/macros/ directory and prompt you to - choose one of them. - -:TexMacroNew <font color="#804040">*<a name="TexMacroNew">TexMacroNew</a>*</font> - Splits window to write new macro. Directory in new buffer is - locally changed to latex-suite/macros/. - -:TexMacroDelete [<font color="#6a5acd">{macro}</font>] <font color="#804040">*<a name="TexMacroDelete">TexMacroDelete</a>*</font> - Delets <font color="#6a5acd">{macro}</font> from 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. - -:TexPackage [<font color="#6a5acd">{package}</font> [<font color="#6a5acd">{package}</font> ...]] <font color="#804040">*<a name="TexPackage">TexPackage</a>*</font> - When used without any arguments lists name of the packages for - which support is available. Report depends if you are using - GUI version and/or g:Tex_Menus is set to 1 or not. When you - are not using menus command lists files from - latex-suite/dictionaries/ (this is main support for non-menus - version of latexSuite) if menus are on <font color="#008080">|<A HREF="latex-suite.html#TexPackage">TexPackage</A>|</font> lists - files from latex-suite/packages/ directory. - - When <font color="#6a5acd">{package}</font> is given command turns on all possible support - for this <font color="#6a5acd">{package}</font> (<font color="#008080">|<A HREF="latex-suite.html#latex-menu-packages">latex-menu-packages</A>|</font>, - <font color="#008080">|latex-packages-dictionary|</font>). Number of arguments separated - with spaces is limited only with common sense. - -:TexPackageUpdate <font color="#804040">*<a name="TexPackageUpdate">TexPackageUpdate</a>*</font> - This command `reads' name of package under cursor and turns on - possible support. - -:TexPackageUpdateAll <font color="#804040">*<a name="TexPackageUpdateAll">TexPackageUpdateAll</a>*</font> - 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. - -:TexTemplate [<font color="#6a5acd">{template}</font>] <font color="#804040">*<a name="TexTemplate">TexTemplate</a>*</font> - 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<font color="#008080">|read|</font> <font color="#6a5acd">{template}</font> file. - With more than one argument it will not work :) - - -<font color="#008080">===========================================================================</font> -<font color="#804040"><b>CREDITS </b></font><font color="#804040">*<a name="latex-suite-credits">latex-suite-credits</a>*</font> - -And finally, the credits: - -Benji Fisher : a large number of functions, environments and valuable - guidance. (You'll see the name often if you browse the - files). -Lubomir Host : provided the diacritics and also helped in development. -Alexander Wagner : valuable suggestions during development. -Luc Hermitte : his variation of Stephen Riehm's bracketing system is used - in latex-suite. -Gergely Kontra : the clever little JumpFunc() in imaps.vim is due to him. - The implementation of the templates also borrows from - mu-template.vim by him. -Dimitri Antoniou : author of ltags and also provided the nice tip about - forward / reverse search on DVI documents. -Stephen Riehm : the extremely helpful bracketing system is from him. -Alan Schmitt : provided some macros/folding elements. -Hari Krishna Dara : for ExecMap(), the clever little function which makes - typing visual mode mappings so much easier and error-free. -Alan G Isac : for the comprehensive BibT() function for entering bibtex - entries. -Gontran Baerts : for libList.vim - -A large number of functions in <A HREF="latex-suite.html#latex-suite">latex-suite</A> come from various other people. -Some of those people might have been missed here. Each function should however -have the author's name/e-mail above it. Thats the more authoritative place to -check out who has done what. - -<font color="#804040"><b> </b></font><font color="#804040">*<a name="latex-suite-maintainer">latex-suite-maintainer</a>*</font> -The current maintainer(s) of <A HREF="latex-suite.html#latex-suite">latex-suite</A> is(are) - -Srinath Avadhanula <sr...@fa...> -Mikolaj Machowski <mi...@wp...> - - -<font color="#008080">===========================================================================</font> - -</pre><hr><p><i>Generated by <tt>vim2html.pl 3.2</tt> on Tue Apr 30 01:13:50 2002</i></p> Deleted: trunk/htdocs/latex-suite.txt =================================================================== --- trunk/htdocs/latex-suite.txt 2010-01-27 21:01:29 UTC (rev 1087) +++ trunk/htdocs/latex-suite.txt 2010-01-27 21:06:02 UTC (rev 1088) @@ -1,849 +0,0 @@ -*latex-suite* Tools for an enhanced LaTeX environment in Vim - For Vim version 6.0 and above. - Last Change: Mon Apr 29 05:00 PM 2002 PDT - - By Srinath Avadhanula <sr...@fa...>, - Mikolaj Machowski <mi...@wp...> - et. al (|latex-suite-credits|) - - -Latex-Suite attempts to provide a comprehensive set of tools to view, edit and -compile LaTeX documents in Vim. Together, they provide tools starting from -macros to speed up editing LaTeX documents to functions for forward searching -.dvi documents. Latex-suite has been possible because of the contributions of -many people. Please see |latex-suite-credits| for a list of people who have -helped. - -{Vi of course does not have any of this} -NOTE: If you are viewing this in vim 6.0+, then the sections should appear - folded (see |folding|). Use |za| to toggle back and forth between open - and closed views. -NOTE: If the sections do not appear folded, press za in normal mode. This will - fold up everything and it will be much easier to navigate. - -=========================================================================== -OVERVIEW *latex-suite-overview* {{{ - - *latex-suite-optimal-settings* -Latex-Suite works best if you have the following settings in your ~/.vimrc: -> - " this line is responsible for loading latex-suite when a .tex file is - " opened. -< filetype plugin on > - " for automatic indentation specific to LaTeX. -< filetype indent on > - -In addition, the following settings could go in your ~/.vim/ftplugin/tex.vim -file: > - - " this is mostly a matter of taste. but LaTeX looks good with just a bit - " of indentation. -< set sw=2 > - " TIP: if you write your \label's as \label{fig:something}, then if you - " type in \ref{fig: and press <C-n> you will automatically cycle through - " all the figure labels. -< set iskeyword+=: > - - -The tools which are included in LaTeX suite can be grouped together into the -following. Almost every feature described here can be customized to some -degree. Please see the included file latex-suite/texrc file for the complete -list of variables which can be customized. - -TABLE OF CONTENTS *latex-suite-toc* - -|latex-macros| Insert and visual mode mappings and menu items for - commonly used LaTeX typesetting elements - -|latex-compiling| This version of latex-suite ships with a version of the - compiler specification which produces slightly less - verbose output. It can also be dynamically re-configured - to change the verbosity level. - -|latex-viewing| This is a set of functions which open up the compiled .dvi - document using the specified DVI viewer. - -|latex-searching| Xdvi (for UNIX) and Yap (for Windows) both provide ways - for "forward searching" LaTeX documents. This section - describes how to use these features and how to set up your - dvi viewer to best use this feature. - -|latex-folding| manual folding based on LaTeX syntax elements. - -|latex-packages| This module provides a way to generate custom menus based - on the packages used in the file being edited. - -|latex-templates| Custom templates - -|latex-macros| Custom macros - -|latex-help| LaTeX's tex-info file translated into a vim help file. - -|latex-dictionary| A dictionary of standard LaTeX terms. - -|latex-tools| This version of latex-suite also ships with 2 external - tools: - 1. |vimlatex| an external utility which fil... [truncated message content] |