Thread: [Vim-latex-cvs] SF.net SVN: vim-latex:[1041] trunk/htdocs
Brought to you by:
srinathava,
tmaas
From: <tm...@us...> - 2008-08-07 13:45:05
|
Revision: 1041 http://vim-latex.svn.sourceforge.net/vim-latex/?rev=1041&view=rev Author: tmaas Date: 2008-08-07 13:45:14 +0000 (Thu, 07 Aug 2008) Log Message: ----------- - Add FAQ regarding let g:tex_flavor='latex' - Maintain only one place with recommended settings in .vimrc Modified Paths: -------------- trunk/htdocs/download.inc trunk/htdocs/faq.inc Modified: trunk/htdocs/download.inc =================================================================== --- trunk/htdocs/download.inc 2008-08-05 19:02:02 UTC (rev 1040) +++ trunk/htdocs/download.inc 2008-08-07 13:45:14 UTC (rev 1041) @@ -66,24 +66,9 @@ do not over-write any of your files.</p> <h4>Step 2 of 4: Set a few things in .vimrc</h4> -Make sure you have the following setting in your .vimrc -<pre> -" REQUIRED. This makes vim invoke latex-suite when you open a tex file. -filetype plugin on +The recommended settings for vim-latex in your .vimrc file are now only described in +the <a href="/documentation/latex-suite/recommended-settings.html/documentation/latex-suite/recommended-settings.html">vim-latex manual</a>. -" IMPORTANT: win32 users will need to have 'shellslash' set so that latex -" can be called correctly. -set shellslash - -" IMPORTANT: grep will sometimes skip displaying the file name if you -" search in a singe file. This will confuse latex-suite. Set your grep -" program to alway generate a file-name. -set grepprg=grep\ -nH\ $* - -" OPTIONAL: This enables automatic indentation as you type. -filetype indent on -</pre> - <h4>Step 3 of 4: Install the help files</h4> To install the included latex-suit.txt and latexhelp.txt files as vim help files, start vim and do the following: Modified: trunk/htdocs/faq.inc =================================================================== --- trunk/htdocs/faq.inc 2008-08-05 19:02:02 UTC (rev 1040) +++ trunk/htdocs/faq.inc 2008-08-07 13:45:14 UTC (rev 1041) @@ -23,6 +23,9 @@ a lot. But latex-suite always converts it into a <tt>\subsection{}<++></tt>. How do I get around this? (OR How do I disable a mapping created by Latex-suite?)</a></li> + <li><a class=question href="#faq-not-loaded-vim7"> + Why is vim-latex is no longer loaded when I open an empty .tex file after I upgraded to Vim 7? + </a> </ul> <h2>Answers</h2> @@ -287,6 +290,16 @@ </div> </blockquote> +<a name="faq-not-loaded-vim7"> +<div class=qa> +Q: Why is vim-latex is no longer loaded when I open an empty .tex file after I upgraded to Vim 7? +</div> +<blockquote> +<div class=ans> +If you look at the filetype of your opened file (with <pre>:se ft</pre>, you will notice, that it is not set to 'tex', but probably to 'plaintex'. +To change this, you need to add <pre>let g:tex_flavor='latex'</pre> to your .vimrc file. +</div> +</blockquote> <!-- A sample Q & A <a name="faq-#"> <div class=qa> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
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] |
From: <tm...@us...> - 2010-01-27 21:26:22
|
Revision: 1090 http://vim-latex.svn.sourceforge.net/vim-latex/?rev=1090&view=rev Author: tmaas Date: 2010-01-27 21:26:15 +0000 (Wed, 27 Jan 2010) Log Message: ----------- latexhelp.{html,txt} are available in download/ Modified Paths: -------------- trunk/htdocs/.htaccess Removed Paths: ------------- trunk/htdocs/latexhelp.html trunk/htdocs/latexhelp.txt Modified: trunk/htdocs/.htaccess =================================================================== --- trunk/htdocs/.htaccess 2010-01-27 21:14:43 UTC (rev 1089) +++ trunk/htdocs/.htaccess 2010-01-27 21:26:15 UTC (rev 1090) @@ -18,3 +18,6 @@ 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 Redirect seeother /tutorial http://vim-latex.sourceforge.net/documentation/latex-suite-quickstart/ + +Redirect seeother /latexhelp.txt http://vim-latex.sourceforge.net/download/latexhelp.txt +Redirect seeother /latexhelp.html http://vim-latex.sourceforge.net/download/latexhelp.html Deleted: trunk/htdocs/latexhelp.html =================================================================== --- trunk/htdocs/latexhelp.html 2010-01-27 21:14:43 UTC (rev 1089) +++ trunk/htdocs/latexhelp.html 2010-01-27 21:26:15 UTC (rev 1090) @@ -1,2440 +0,0 @@ -<html> -<head> -<title>Vim documentation: latexhelp</title> -<meta name="Generator" content="Vim/6.1"> -</head> -<body bgcolor="#ffffff" text="#000000"> -<h1>Vim documentation: latexhelp</h1><hr><pre> -<font color="#804040">*<a name="latexhelp.txt">latexhelp.txt</a>*</font> For <font color="#008080">Vim version 6.0.</font> Last change: 2001 Dec 20 - - - LATEX HELP 1.6 - translated (with minor changes) for vim - by Mikolaj Machowski - -This file documents LaTeX2e, a document preparation system. LaTeX2e is a -macro package for TeX. - - This is edition 1.6 of the LaTeX2e documentation, and is for the Texinfo -that is distributed as part of Version 19 of GNU Emacs. It uses version -2.134 or later of the texinfo.tex input file. - - This is translated from LATEX.HLP v1.0a in the VMS Help Library. The -pre-translation version was written by George D. Greenwade of Sam Houston -State University. - - The <A HREF="latexhelp.html#LaTeX">LaTeX</A> 2.09 version was written by Stephen Gilmore <st...@dc...>. - - The LaTeX2e version was adapted from this by Torsten Martinsen -<bul...@dk...>. - - Version for vim of this manual was written by Mikolaj Machowski -<mi...@wp...> - - Copyright 1988,1994 Free Software Foundation, Inc. Copyright 1994-1996 -Torsten Martinsen. Copyright for `translation' for vim Mikolaj Machowski 2001. - - Permission is granted to make and distribute <A HREF="latexhelp.html#verbatim">verbatim</A> copies of this manual -provided the copyright notice and this permission notice are preserved on -all copies. - - Permission is granted to copy and distribute modified versions of this -manual under the conditions for <A HREF="latexhelp.html#verbatim">verbatim</A> copying, provided that the entire -resulting derived work is distributed under the terms of a permission -notice identical to this one. - - Permission is granted to copy and distribute translations of this manual -into another language, under the above conditions for modified versions, -except that the sections entitled "Distribution" and "General Public -License" may be included in a translation approved by the author instead of -in the original English. - -<font color="#008080">==============================================================================</font> -<font color="#804040">*<a name="LaTeX">LaTeX</a>*</font> <font color="#804040">*<a name="latex">latex</a>*</font> - -The LaTeX command typesets a file of text using the TeX program and the LaTeX -Macro package for TeX. To be more specific, it processes an input file -containing the text of a document with interspersed commands that describe how -the text should be formatted. - -1. Commands <font color="#008080">|<A HREF="latexhelp.html#latex-commands">latex-commands</A>|</font> -2. Counters <font color="#008080">|<A HREF="latexhelp.html#latex-counters">latex-counters</A>|</font> -3. Cross References <font color="#008080">|<A HREF="latexhelp.html#latex-references">latex-references</A>|</font> -4. Definitions <font color="#008080">|<A HREF="latexhelp.html#latex-definitions">latex-definitions</A>|</font> -5. Document Classes <font color="#008080">|<A HREF="latexhelp.html#latex-classes">latex-classes</A>|</font> -6. Layout <font color="#008080">|<A HREF="latexhelp.html#latex-layout">latex-layout</A>|</font> -7. Environments <font color="#008080">|<A HREF="latexhelp.html#latex-environments">latex-environments</A>|</font> -8. Footnotes <font color="#008080">|<A HREF="latexhelp.html#latex-footnotes">latex-footnotes</A>|</font> -9. Lengths <font color="#008080">|latex-lengths|</font> -10. Letters <font color="#008080">|<A HREF="latexhelp.html#latex-letters">latex-letters</A>|</font> -11. Line & Page Breaking <font color="#008080">|<A HREF="latexhelp.html#latex-breaking">latex-breaking</A>|</font> -12. Making Paragraphs <font color="#008080">|<A HREF="latexhelp.html#latex-paragraphs">latex-paragraphs</A>|</font> -13. Margin Notes <font color="#008080">|<A HREF="latexhelp.html#latex-margin-notes">latex-margin-notes</A>|</font> -14. Math Formulae <font color="#008080">|<A HREF="latexhelp.html#latex-math">latex-math</A>|</font> -15. Modes <font color="#008080">|<A HREF="latexhelp.html#latex-modes">latex-modes</A>|</font> -16. Page Styles <font color="#008080">|<A HREF="latexhelp.html#latex-page-styles">latex-page-styles</A>|</font> -17. Sectioning <font color="#008080">|<A HREF="latexhelp.html#latex-sectioning">latex-sectioning</A>|</font> -18. Spaces & Boxes <font color="#008080">|<A HREF="latexhelp.html#latex-spaces-boxes">latex-spaces-boxes</A>|</font> -19. Special Characters <font color="#008080">|latex-special-char|</font> -20. Splitting the Input <font color="#008080">|<A HREF="latexhelp.html#latex-inputing">latex-inputing</A>|</font> -21. Starting & Ending <font color="#008080">|<A HREF="latexhelp.html#latex-start-end">latex-start-end</A>|</font> -22. Table of Contents <font color="#008080">|<A HREF="latexhelp.html#latex-toc">latex-toc</A>|</font> -23. Terminal Input/Output <font color="#008080">|<A HREF="latexhelp.html#latex-terminal">latex-terminal</A>|</font> -24. Typefaces <font color="#008080">|<A HREF="latexhelp.html#latex-typefaces">latex-typefaces</A>|</font> -25. Parameters <font color="#008080">|<A HREF="latexhelp.html#latex-parameters">latex-parameters</A>|</font> - -<font color="#008080">==============================================================================</font> -1. Commands <font color="#804040">*<a name="latex-commands">latex-commands</a>*</font> - -A <A HREF="latexhelp.html#LaTeX">LaTeX</A> command begins with the command name, which consists of a \ followed -by either - (a) a string of letters or - (b) a single non-letter. - -Arguments contained in square brackets, [], are optional while arguments -contained in braces, {}, are required. - -<span style="background-color: #ffff00"><font color="#0000ff">NOTE</font></span>: <A HREF="latexhelp.html#LaTeX">LaTeX</A> is case sensitive. Enter all commands in lower case unless -explicitly directed to do otherwise. - -<font color="#008080">==============================================================================</font> -2. Counters <font color="#804040">*<a name="latex-counters">latex-counters</a>*</font> - -<font color="#008080">|<A HREF="latexhelp.html#\addtocounter">\addtocounter</A>|</font> Add a quantity to a counter -<font color="#008080">|<A HREF="latexhelp.html#\alph">\alph</A>|</font> Print value of a counter using letters -<font color="#008080">|<A HREF="latexhelp.html#\arabic">\arabic</A>|</font> Print value of a counter using numerals -<font color="#008080">|<A HREF="latexhelp.html#\fnsymbol">\fnsymbol</A>|</font> Print value of a counter using symbols -<font color="#008080">|<A HREF="latexhelp.html#\newcounter">\newcounter</A>|</font> Define a new counter -<font color="#008080">|<A HREF="latexhelp.html#\refstepcounter">\refstepcounter</A>|</font> Add to counter, resetting subsidiary counters -<font color="#008080">|<A HREF="latexhelp.html#\roman">\roman</A>|</font> Print value of a counter using <A HREF="latexhelp.html#roman">roman</A> numerals -<font color="#008080">|<A HREF="latexhelp.html#\setcounter">\setcounter</A>|</font> Set the value of a counter -<font color="#008080">|<A HREF="latexhelp.html#\stepcounter">\stepcounter</A>|</font> Add to counter, resetting subsidiary counters -<font color="#008080">|<A HREF="latexhelp.html#\usecounter">\usecounter</A>|</font> Use a specified counter in a <A HREF="latexhelp.html#list">list</A> environment -<font color="#008080">|<A HREF="latexhelp.html#\value">\value</A>|</font> Use the value of a counter in an expression - -Everything <A HREF="latexhelp.html#LaTeX">LaTeX</A> numbers for you has a counter associated with it. The name of -the counter is the same as the name of the environment or command that -produces the number, except with no <font color="#008080">|<A HREF="latexhelp.html#\\">\\</A>|</font>. (<font color="#008080">|lc-enumi|</font> - <font color="#008080">|lc-enumiv|</font> are used -for the nested <font color="#008080">|\enumerate|</font> environment.) Below is a <A HREF="latexhelp.html#list">list</A> of the counters -used in LaTeX's standard document classes to control numbering. - - <font color="#008080">|part|</font> <font color="#008080">|paragraph|</font> <font color="#008080">|<A HREF="latexhelp.html#figure">figure</A>|</font> <font color="#008080">|enumi|</font> <font color="#008080">|itemi|</font> - <font color="#008080">|chapter|</font> <font color="#008080">|subparagraph|</font> <font color="#008080">|table|</font> <font color="#008080">|enumii|</font> <font color="#008080">|itemii|</font> - <font color="#008080">|section|</font> <font color="#008080">|page|</font> <font color="#008080">|footnote|</font> <font color="#008080">|enumiii|</font> <font color="#008080">|itemiii|</font> - <font color="#008080">|subsection|</font> <font color="#008080">|<A HREF="latexhelp.html#equation">equation</A>|</font> <font color="#008080">|mpfootnote|</font> <font color="#008080">|enumiv|</font> <font color="#008080">|itemiv|</font> - <font color="#008080">|subsubsection|</font> - - -\addtocounter<font color="#6a5acd">{counter}{value}</font> <font color="#804040">*<a name="\addtocounter">\addtocounter</a>*</font> - Increments the <font color="#6a5acd">{counter}</font> by the amount specified by the - <font color="#6a5acd">{value}</font> argument. The <font color="#6a5acd">{value}</font> argument can be negative. - -\alph<font color="#6a5acd">{counter}</font> <font color="#804040">*<a name="\alph">\alph</a>*</font> <font color="#804040">*<a name="\Alph">\Alph</a>*</font> -\Alph<font color="#6a5acd">{counter}</font> - This command causes the value of the counter to be printed in - alphabetic characters. <font color="#008080">|<A HREF="latexhelp.html#\alph">\alph</A>|</font> command uses lower case - alphabetic alphabetic characters, i.e., a, b, c... while the - <font color="#008080">|<A HREF="latexhelp.html#\Alph">\Alph</A>|</font> command uses upper case alphabetic characters, i.e., - A, B, C.... - -\arabic<font color="#6a5acd">{counter}</font> <font color="#804040">*<a name="\arabic">\arabic</a>*</font> - Causes the value of the <font color="#6a5acd">{counter}</font> to be printed in Arabic - numbers, i.e., 3. - -\fnsymbol<font color="#6a5acd">{counter}</font> <font color="#804040">*<a name="\fnsymbol">\fnsymbol</a>*</font> - Causes the value of the <font color="#6a5acd">{counter}</font> to be printed in a specific - sequence of nine symbols that can be used for numbering - footnotes. - <span style="background-color: #ffff00"><font color="#0000ff">Note</font></span>: counter must have a value between 1 and 9 inclusive. - -\newcounter<font color="#6a5acd">{foo}</font>[counter] <font color="#804040">*<a name="\newcounter">\newcounter</a>*</font> - Defines a new counter named <font color="#6a5acd">{foo}</font>. The counter is initialized - to zero. The optional argument <font color="#6a5acd">[counter]</font> causes the counter - <font color="#6a5acd">{foo}</font> to be reset whenever the counter named in the optional - argument is incremented. - -\refstepcounter<font color="#6a5acd">{counter}</font> <font color="#804040">*<a name="\refstepcounter">\refstepcounter</a>*</font> - Command works like <font color="#008080">|<A HREF="latexhelp.html#\stepcounter">\stepcounter</A>|</font>, except it also defines the - current <font color="#008080">|<A HREF="latexhelp.html#\ref">\ref</A>|</font> value to be the result of \thecounter. - -\roman<font color="#6a5acd">{counter}</font> <font color="#804040">*<a name="\roman">\roman</a>*</font> <font color="#804040">*<a name="\Roman">\Roman</a>*</font> -\Roman<font color="#6a5acd">{counter}</font> - Causes the value of the <font color="#6a5acd">{counter}</font> to be printed in Roman - numerals. The <font color="#008080">|<A HREF="latexhelp.html#\roman">\roman</A>|</font> command uses lower case <A HREF="latexhelp.html#Roman">Roman</A> numerals, - i.e., i, ii, iii..., while the <font color="#008080">|<A HREF="latexhelp.html#\Roman">\Roman</A>|</font> command uses upper case - <A HREF="latexhelp.html#Roman">Roman</A> numerals, i.e., I, II, III.... - -\stepcounter<font color="#6a5acd">{counter}</font> <font color="#804040">*<a name="\stepcounter">\stepcounter</a>*</font> - Adds one to the <font color="#6a5acd">{counter}</font> and resets all subsidiary counters. - -\setcounter<font color="#6a5acd">{counter}{value}</font> <font color="#804040">*<a name="\setcounter">\setcounter</a>*</font> - Sets the value of the <font color="#6a5acd">{counter}</font> to that specified by the - <font color="#6a5acd">{value}</font> argument. - -\usecounter<font color="#6a5acd">{counter}</font> <font color="#804040">*<a name="\usecounter">\usecounter</a>*</font> - Command is used in the second argument of the <font color="#008080">|<A HREF="latexhelp.html#list">list</A>|</font> - environment to allow the <font color="#6a5acd">{counter}</font> specified to be used to - number the <A HREF="latexhelp.html#list">list</A> items. - -\value<font color="#6a5acd">{counter}</font> <font color="#804040">*<a name="\value">\value</a>*</font> - Produces the value of the <font color="#6a5acd">{counter}</font> named in the mandatory - argument. It can be used where <A HREF="latexhelp.html#LaTeX">LaTeX</A> expects an integer or - number, such as the second argument of a <font color="#008080">|<A HREF="latexhelp.html#\setcounter">\setcounter</A>|</font> or - <font color="#008080">|<A HREF="latexhelp.html#\addtocounter">\addtocounter</A>|</font> command, or in:<font color="#ffffff"> ></font> -<font color="#008000"> \hspace{\value{foo}\parindent}</font> -<font color="#ffffff"><</font> It is useful for doing arithmetic with counters. - -<font color="#008080">==============================================================================</font> -3. Cross References <font color="#804040">*<a name="latex-references">latex-references</a>*</font> - -One reason for numbering things like figures and equations is to refer the -reader to them, as in "See Figure 3 for more details." - -<font color="#008080">|<A HREF="latexhelp.html#\label">\label</A>|</font> Assign a symbolic name to a piece of text -<font color="#008080">|<A HREF="latexhelp.html#\pageref">\pageref</A>|</font> Refer to a page number -<font color="#008080">|<A HREF="latexhelp.html#\ref">\ref</A>|</font> Refer to a section, <A HREF="latexhelp.html#figure">figure</A> or similar - - -\label<font color="#6a5acd">{key}</font> <font color="#804040">*<a name="\label">\label</a>*</font> - Command appearing in ordinary text assigns to the <font color="#6a5acd">{key}</font> the - number of the current sectional unit; one appearing inside a - numbered environment assigns that number to the <font color="#6a5acd">{key}</font>. - - A <font color="#6a5acd">{key}</font> can consist of any sequence of letters, digits, or - punctuation characters. Upper and lowercase letters are - different. - - To avoid accidentally creating two labels with the same name, - it is common to use labels consisting of a prefix and a suffix - separated by a colon. The prefixes conventionally used are -<font color="#804040"><b> </b></font>* <font color="#008000"><b>'cha'</b></font> for chapters -<font color="#804040"><b> </b></font>* <font color="#008000"><b>'sec'</b></font> for lower-level sectioning commands -<font color="#804040"><b> </b></font>* <font color="#008000"><b>'fig'</b></font> for figures -<font color="#804040"><b> </b></font>* <font color="#008000"><b>'tab'</b></font> for tables -<font color="#804040"><b> </b></font>* <font color="#008000"><b>'eq'</b></font> for equations - Thus, a label for a <A HREF="latexhelp.html#figure">figure</A> would look like:<font color="#ffffff"> ></font> -<font color="#008000"> \label{fig:bandersnatch}</font> - -\pageref<font color="#6a5acd">{key}</font> <font color="#804040">*<a name="\pageref">\pageref</a>*</font> - Command produces the page number of the place in the text - where the corresponding <font color="#008080">|<A HREF="latexhelp.html#\label">\label</A>|</font> command appears. ie. where - <A HREF="latexhelp.html#\label">\label</A><font color="#6a5acd">{key}</font> appears. - -\ref<font color="#6a5acd">{key}</font> <font color="#804040">*<a name="\ref">\ref</a>*</font> - Command produces the number of the sectional unit, equation - number, ... of the corresponding <font color="#008080">|<A HREF="latexhelp.html#\label">\label</A>|</font> command. - -<font color="#008080">==============================================================================</font> -4. Definitions <font color="#804040">*<a name="latex-definitions">latex-definitions</a>*</font> - -<font color="#008080">|<A HREF="latexhelp.html#\newcommand">\newcommand</A>|</font> Define a new command -<font color="#008080">|<A HREF="latexhelp.html#\newenvironment">\newenvironment</A>|</font> Define a new environment -<font color="#008080">|<A HREF="latexhelp.html#\newtheorem">\newtheorem</A>|</font> Define a new theorem-like environment -<font color="#008080">|<A HREF="latexhelp.html#\newfont">\newfont</A>|</font> Define a new font name - - -\newcommand<font color="#6a5acd">{cmd}</font>[args]<font color="#6a5acd">{definition}</font> <font color="#804040">*<a name="\newcommand">\newcommand</a>*</font> <font color="#804040">*<a name="\renewcommand">\renewcommand</a>*</font> -\newcommand<font color="#6a5acd">{cmd}</font>[args][default]<font color="#6a5acd">{definition}</font> -\renewcommand<font color="#6a5acd">{cmd}</font>[args]<font color="#6a5acd">{definition}</font> -\renewcommand<font color="#6a5acd">{cmd}</font>[args][default]<font color="#6a5acd">{definition}</font> - -These commands define (or redefine) a command. - -<font color="#6a5acd">{cmd}</font> A command name beginning with a <font color="#008080">|<A HREF="latexhelp.html#\\">\\</A>|</font>. For <font color="#008080">|<A HREF="latexhelp.html#\newcommand">\newcommand</A>|</font> it must - not be already defined and must not begin with <font color="#008080">|<A HREF="latexhelp.html#\end">\end</A>|</font>; for - <font color="#008080">|<A HREF="latexhelp.html#\renewcommand">\renewcommand</A>|</font> it must already be defined. - -<font color="#6a5acd">{args}</font> An integer from 1 to 9 denoting the number of arguments of the - command being defined. The default is for the command to have - no arguments. - -<font color="#6a5acd">{default}</font> If this optional parameter is present, it means that the - command's first argument is optional. The default value of the - optional argument is default. - -<font color="#6a5acd">{definition}</font> The text to be substituted for every occurrence of <font color="#6a5acd">{cmd}</font>; a - parameter of the form #n in <font color="#6a5acd">{cmd}</font> is replaced by the text of - the nth argument when this substitution takes place. - -<font color="#804040"><b> </b></font><font color="#804040">*<a name="\newenvironment">\newenvironment</a>*</font> <font color="#804040">*<a name="\renewenvironment">\renewenvironment</a>*</font> -\newenvironment<font color="#6a5acd">{nam}</font>[args]<font color="#6a5acd">{begdef}{enddef}</font> -\newenvironment<font color="#6a5acd">{nam}</font>[args][default]<font color="#6a5acd">{begdef}{enddef}</font> -\renewenvironment<font color="#6a5acd">{nam}</font>[args]<font color="#6a5acd">{begdef}{enddef}</font> - -These commands define or redefine an environment. - -<font color="#6a5acd">{nam}</font> The name of the environment. For <font color="#008080">|<A HREF="latexhelp.html#\newenvironment">\newenvironment</A>|</font> there must - be no currently defined environment by that name, and the - command \nam must be undefined. For <font color="#008080">|<A HREF="latexhelp.html#\renewenvironment">\renewenvironment</A>|</font> the - environment must already be defined. - -<font color="#6a5acd">{args}</font> An integer from 1 to 9 denoting the number of arguments of - the newly-defined environment. The default is no arguments. - -<font color="#6a5acd">{default}</font> If this is specified, the first argument is optional, and - default gives the default value for that argument. - -<font color="#6a5acd">{begdef}</font> The text substituted for every occurrence of <A HREF="latexhelp.html#\begin">\begin</A><font color="#6a5acd">{nam}</font>; a - parameter of the form #n in <font color="#6a5acd">{cmd}</font> is replaced by the text of - the nth argument when this substitution takes place. - -<font color="#6a5acd">{enddef}</font> The text substituted for every occurrence of <A HREF="latexhelp.html#\end">\end</A><font color="#6a5acd">{nam}</font>. It - may not contain any argument parameters. - - -\newtheorem<font color="#6a5acd">{envname}{caption}</font>[within] <font color="#804040">*<a name="\newtheorem">\newtheorem</a>*</font> -\newtheorem<font color="#6a5acd">{envname}</font>[numberedlike]<font color="#6a5acd">{caption}</font> - -This command defines a theorem-like environment. - -<font color="#6a5acd">{envname}</font> The name of the environment to be defined. A string of - letters. It must not be the name of an existing environment or - counter. - -<font color="#6a5acd">{caption}</font> The text printed at the beginning of the environment, right - before the number. This may simply say "Theorem", for example. - -<font color="#6a5acd">{within}</font> The name of an already defined counter, usually of a sectional - unit. Provides a means of resetting the new <A HREF="latexhelp.html#theorem">theorem</A> counter - within the sectional unit. - -<font color="#6a5acd">{numberedlike}</font> The name of an already defined theorem-like environment. - -The <font color="#008080">|<A HREF="latexhelp.html#\newtheorem">\newtheorem</A>|</font> command may have at most one optional argument. - - -\newfont<font color="#6a5acd">{cmd}{fontname}</font> <font color="#804040">*<a name="\newfont">\newfont</a>*</font> - Defines the command name <font color="#6a5acd">{cmd}</font>, which must not be currently - defined, to be a declaration that selects the font named - <font color="#6a5acd">{fontname}</font> to be the current font. - -<font color="#008080">==============================================================================</font> -5. Document Classes <font color="#804040">*<a name="latex-classes">latex-classes</a>*</font> - - -\documentclass[options]<font color="#6a5acd">{class}</font> <font color="#804040">*<a name="\documentclass">\documentclass</a>*</font> - -Valid <A HREF="latexhelp.html#LaTeX">LaTeX</A> document classes include: -<font color="#804040"><b> </b></font>*article <font color="#804040">*<a name="article-class">article-class</a>*</font> -<font color="#804040"><b> </b></font>*report <font color="#804040">*<a name="report-class">report-class</a>*</font> -<font color="#804040"><b> </b></font>*letter <font color="#804040">*<a name="letter-class">letter-class</a>*</font> -<font color="#804040"><b> </b></font>*book <font color="#804040">*<a name="book-class">book-class</a>*</font> -<font color="#804040"><b> </b></font>*slides <font color="#804040">*<a name="slides-class">slides-class</a>*</font> - -All the standard classes (except slides) accept the following options for -selecting the typeface size (10 pt is default): - -10pt, 11pt, 12pt - -All classes accept these options for selecting the paper size (default is -letter): - -a4paper, a5paper, b5paper, letterpaper, legalpaper, executivepaper - -Miscellaneous options: - -landscape <font color="#804040">*<a name="landscape">landscape</a>*</font> - Selects landscape format. Default is portrait. - -titlepage, notitlepage <font color="#804040">*<a name="notitlepage">notitlepage</a>*</font> - Selects if there should be a separate title page. - -leqno <font color="#804040">*<a name="leqno">leqno</a>*</font> <font color="#804040">*<a name="rqno">rqno</a>*</font> - Equation number on left side of equations. Default is - right side. - -fleqn <font color="#804040">*<a name="fleqn">fleqn</a>*</font> - Displayed formulas flush left. Default is centred. - -openbib <font color="#804040">*<a name="openbib">openbib</a>*</font> - Use "open" bibliography format. - -draft, final <font color="#804040">*<a name="draft">draft</a>*</font> <font color="#804040">*<a name="final">final</a>*</font> - Mark/do not mark overfull boxes with a rule. Default is - final. - -These options are not available with the slides class: - -oneside, twoside <font color="#804040">*<a name="oneside">oneside</a>*</font> <font color="#804040">*<a name="twoside">twoside</a>*</font> - Selects one- or twosided layout. Default is oneside, - except for the book class. - -openright, openany <font color="#804040">*<a name="openright">openright</a>*</font> <font color="#804040">*<a name="openany">openany</a>*</font> - Determines if a chapter should start on a right-hand page. - Default is openright for book. - -onecolumn, twocolumn <font color="#804040">*<a name="onecolumn">onecolumn</a>*</font> <font color="#804040">*<a name="twocolumn">twocolumn</a>*</font> - One or two columns. Defaults to one column. - -The slides class offers the option clock for printing the time at the bottom -of each <font color="#008080">|\note|</font>. - -If you specify more than one option, they must be separated by a comma. - -\usepackage[options]<font color="#6a5acd">{pkg}</font> <font color="#804040">*<a name="\usepackage">\usepackage</a>*</font> - Additional packages are loaded by this. If you - specify more than one package, they must be separated by a - comma. - -Any options given in the <font color="#008080">|<A HREF="latexhelp.html#\documentclass">\documentclass</A>|</font> command that are unknown by the -selected document class are passed on to the packages loaded with <font color="#008080">|<A HREF="latexhelp.html#\usepackage">\usepackage</A>|</font>. - -<font color="#008080">==============================================================================</font> -6. Layout <font color="#804040">*<a name="latex-layout">latex-layout</a>*</font> - -Miscellaneous commands for controlling the general layout of the page. - -<font color="#008080">|<A HREF="latexhelp.html#\flushbottom">\flushbottom</A>|</font> Make all text pages the same height. -<font color="#008080">|<A HREF="latexhelp.html#\onecolumn">\onecolumn</A>|</font> Use one-column layout. -<font color="#008080">|<A HREF="latexhelp.html#\raggedbottom">\raggedbottom</A>|</font> Allow text pages of differing height. -<font color="#008080">|<A HREF="latexhelp.html#\twocolumn">\twocolumn</A>|</font> Use two-column layout. - -\flushbottom <font color="#804040">*<a name="\flushbottom">\flushbottom</a>*</font> - Makes all text pages the same height, adding extra vertical - space when necessary to fill out the page. This is the - standard if <A HREF="latexhelp.html#twocolumn">twocolumn</A> mode is selected. - -\onecolumn <font color="#804040">*<a name="\onecolumn">\onecolumn</a>*</font> - Starts a new page and produces single-column output. - -\raggedbottom <font color="#804040">*<a name="\raggedbottom">\raggedbottom</a>*</font> - Makes all pages the height of the text on that page. No extra - vertical space is added. - -\twocolumn[text] <font color="#804040">*<a name="\twocolumn">\twocolumn</a>*</font> - Starts a new page and produces two-column output. If the - optional <font color="#6a5acd">[text]</font> argument is present, it is typeset in - one-column mode. - -<font color="#008080">==============================================================================</font> -7. Environments <font color="#804040">*<a name="latex-environments">latex-environments</a>*</font> - -<font color="#804040"><b> </b></font><font color="#804040">*<a name="\begin">\begin</a>*</font> <font color="#804040">*<a name="\end">\end</a>*</font> -<A HREF="latexhelp.html#LaTeX">LaTeX</A> provides a number of different paragraph-making environments. Each -environment begins and ends in the same manner:<font color="#ffffff"> ></font> - -<font color="#008000"> \begin{environment-name}</font> -<font color="#008000"> .</font> -<font color="#008000"> .</font> -<font color="#008000"> .</font> -<font color="#008000"> \end{environment-name}</font> -<font color="#ffffff"><</font> -a. <font color="#008080">|<A HREF="latexhelp.html#array">array</A>|</font> Math arrays -b. <font color="#008080">|<A HREF="latexhelp.html#center">center</A>|</font> Centred lines -c. <font color="#008080">|<A HREF="latexhelp.html#description">description</A>|</font> Labelled lists -d. <font color="#008080">|<A HREF="latexhelp.html#enumerate">enumerate</A>|</font> Numbered lists -e. <font color="#008080">|<A HREF="latexhelp.html#eqnarray">eqnarray</A>|</font> Sequences of aligned equations -f. <font color="#008080">|<A HREF="latexhelp.html#equation">equation</A>|</font> Displayed equation -g. <font color="#008080">|<A HREF="latexhelp.html#figure">figure</A>|</font> Floating figures -h. <font color="#008080">|<A HREF="latexhelp.html#flushleft">flushleft</A>|</font> Flushed left lines -i. <font color="#008080">|<A HREF="latexhelp.html#flushright">flushright</A>|</font> Flushed right lines -j. <font color="#008080">|<A HREF="latexhelp.html#itemize">itemize</A>|</font> Bulleted lists -k. <font color="#008080">|letter|</font> Letters -l. <font color="#008080">|<A HREF="latexhelp.html#list">list</A>|</font> Generic <A HREF="latexhelp.html#list">list</A> environment -m. <font color="#008080">|<A HREF="latexhelp.html#minipage">minipage</A>|</font> Miniature page -n. <font color="#008080">|<A HREF="latexhelp.html#picture">picture</A>|</font> Picture with text, arrows, lines and circles -o. <font color="#008080">|<A HREF="latexhelp.html#quotation">quotation</A>|</font> Indented environment with paragraph indentation -p. <font color="#008080">|<A HREF="latexhelp.html#quote-l">quote-l</A>|</font> Indented environment with no paragraph indentation -q. <font color="#008080">|<A HREF="latexhelp.html#tabbing">tabbing</A>|</font> Align text arbitrarily -r. <font color="#008080">|table|</font> Floating tables -s. <font color="#008080">|<A HREF="latexhelp.html#tabular">tabular</A>|</font> Align text in columns -t. <font color="#008080">|thebibliography|</font> Bibliography or reference list -u. <font color="#008080">|<A HREF="latexhelp.html#theorem">theorem</A>|</font> Theorems, lemmas, etc -v. <font color="#008080">|<A HREF="latexhelp.html#titlepage">titlepage</A>|</font> For hand crafted title pages -x. <font color="#008080">|<A HREF="latexhelp.html#verbatim">verbatim</A>|</font> Simulating typed input -y. <font color="#008080">|<A HREF="latexhelp.html#verse">verse</A>|</font> For poetry and other things - -<font color="#008080">==============================================================================</font> - a. array <font color="#804040">*<a name="array">array</a>*</font> -<font color="#ffffff">></font> -<font color="#008000"> \begin{array}{col1col2...coln}</font> -<font color="#008000"> column 1 entry & column 2 entry ... & column n entry <A HREF="latexhelp.html#\\">\\</A></font> -<font color="#008000"> .</font> -<font color="#008000"> .</font> -<font color="#008000"> .</font> -<font color="#008000"> \end{array}</font> - -Math arrays are produced with the <font color="#008080">|<A HREF="latexhelp.html#array">array</A>|</font> environment. It has a single mandatory -argument describing the number of columns and the alignment within them. Each -column, coln, is specified by a single letter that tells how items in that row -should be formatted. -<font color="#804040"><b> </b></font>* c -- for centred -<font color="#804040"><b> </b></font>* l -- for flush left -<font color="#804040"><b> </b></font>* r -- for flush right -Column entries must be separated by an <font color="#008080">|&|</font>. Column entries may include other -<A HREF="latexhelp.html#LaTeX">LaTeX</A> commands. Each row of the array must be terminated with the string <font color="#008080">|<A HREF="latexhelp.html#\\">\\</A>|</font>. - -<span style="background-color: #ffff00"><font color="#0000ff">Note</font></span> that the <font color="#008080">|<A HREF="latexhelp.html#array">array</A>|</font> environment can only be used in <font color="#008080">|<A HREF="latexhelp.html#math-mode">math-mode</A>|</font>, so normally -it is used inside an <font color="#008080">|<A HREF="latexhelp.html#equation">equation</A>|</font> environment. - -<font color="#008080">==============================================================================</font> -b. center <font color="#804040">*<a name="center">center</a>*</font> -<font color="#ffffff">></font> -<font color="#008000"> \begin{center}</font> -<font color="#008000"> Text on line 1 <A HREF="latexhelp.html#\\">\\</A></font> -<font color="#008000"> Text on line 2 <A HREF="latexhelp.html#\\">\\</A></font> -<font color="#008000"> .</font> -<font color="#008000"> .</font> -<font color="#008000"> .</font> -<font color="#008000"> \end{center}</font> - -The <font color="#008080">|\center|</font> environment allows you to create a paragraph consisting of lines -that are centred within the left and right margins on the current page. Each -line must be terminated with the string <font color="#008080">|<A HREF="latexhelp.html#\\">\\</A>|</font>. - -\centering <font color="#804040">*<a name="\centering">\centering</a>*</font> - This declaration corresponds to the <font color="#008080">|<A HREF="latexhelp.html#center">center</A>|</font> environment. This - declaration can be used inside an environment such as - <font color="#008080">|<A HREF="latexhelp.html#quote-l">quote-l</A>|</font> or in a <font color="#008080">|<A HREF="latexhelp.html#\parbox">\parbox</A>|</font>. The text of a <font color="#008080">|<A HREF="latexhelp.html#figure">figure</A>|</font> or <font color="#008080">|table|</font> - can be centred on the page by putting a <font color="#008080">|<A HREF="latexhelp.html#\centering">\centering</A>|</font> command - at the beginning of the <font color="#008080">|<A HREF="latexhelp.html#figure">figure</A>|</font> or <font color="#008080">|table|</font> environment. - Unlike the <font color="#008080">|<A HREF="latexhelp.html#center">center</A>|</font> environment, the <font color="#008080">|<A HREF="latexhelp.html#\centering">\centering</A>|</font> command does - not start a new paragraph; it simply changes how <A HREF="latexhelp.html#LaTeX">LaTeX</A> formats - paragraph units. To affect a paragraph unit's format, the - scope of the declaration must contain the blank line or <font color="#008080">|<A HREF="latexhelp.html#\end">\end</A>|</font> - command (of an environment like <font color="#008080">|<A HREF="latexhelp.html#quote-l">quote-l</A>|</font>) that ends the - paragraph unit. - -<font color="#008080">==============================================================================</font> -c. description <font color="#804040">*<a name="description">description</a>*</font> -<font color="#ffffff">></font> -<font color="#008000"> \begin{description}</font> -<font color="#008000"> <A HREF="latexhelp.html#\item">\item</A> [label] First item</font> -<font color="#008000"> <A HREF="latexhelp.html#\item">\item</A> [label] Second item</font> -<font color="#008000"> .</font> -<font color="#008000"> .</font> -<font color="#008000"> .</font> -<font color="#008000"> \end{description}</font> - -The <font color="#008080">|<A HREF="latexhelp.html#description">description</A>|</font> environment is used to make labelled lists. The label is -bold face and flushed right. - -<font color="#008080">==============================================================================</font> -d. enumerate <font color="#804040">*<a name="enumerate">enumerate</a>*</font> -<font color="#ffffff">></font> -<font color="#008000"> \begin{enumerate}</font> -<font color="#008000"> <A HREF="latexhelp.html#\item">\item</A> First item</font> -<font color="#008000"> <A HREF="latexhelp.html#\item">\item</A> Second item</font> -<font color="#008000"> .</font> -<font color="#008000"> .</font> -<font color="#008000"> .</font> -<font color="#008000"> \end{enumerate}</font> - -The <font color="#008080">|<A HREF="latexhelp.html#enumerate">enumerate</A>|</font> environment produces a numbered list. Enumerations can be -nested within one another, up to four levels deep. They can also be nested -within other paragraph-making environments. - -<A HREF="latexhelp.html#\item">\item</A> Each item of an enumerated <A HREF="latexhelp.html#list">list</A> begins with an <font color="#008080">|<A HREF="latexhelp.html#\item">\item</A>|</font> - command. There must be at least one <font color="#008080">|<A HREF="latexhelp.html#\item">\item</A>|</font> command - within the environment. - -The <font color="#008080">|<A HREF="latexhelp.html#enumerate">enumerate</A>|</font> environment uses the <font color="#008080">|\enumi|</font> through <font color="#008080">|\enumiv|</font> counters (see -section <font color="#008080">|<A HREF="latexhelp.html#latex-counters">latex-counters</A>|</font>). The type of numbering can be changed by redefining -\theenumi etc. - -<font color="#008080">==============================================================================</font> -e. eqnarray <font color="#804040">*<a name="eqnarray">eqnarray</a>*</font> -<font color="#ffffff">></font> -<font color="#008000"> \begin{eqnarray}</font> -<font color="#008000"> math formula 1 <A HREF="latexhelp.html#\\">\\</A></font> -<font color="#008000"> math formula 2 <A HREF="latexhelp.html#\\">\\</A></font> -<font color="#008000"> .</font> -<font color="#008000"> .</font> -<font color="#008000"> .</font> -<font color="#008000"> \end{eqnarray}</font> - -The <font color="#008080">|<A HREF="latexhelp.html#eqnarray">eqnarray</A>|</font> environment is used to display a sequence of equations or -inequalities. It is very much like a three-column <font color="#008080">|<A HREF="latexhelp.html#array">array</A>|</font> environment, with -consecutive rows separated by <font color="#008080">|<A HREF="latexhelp.html#\\">\\</A>|</font> and consecutive items within a row separated -by an <font color="#008080">|&|</font>. - -\nonumber <font color="#804040">*<a name="\nonumber">\nonumber</a>*</font> - An <A HREF="latexhelp.html#equation">equation</A> number is placed on every line unless that - line has a <font color="#008080">|<A HREF="latexhelp.html#\nonumber">\nonumber</A>|</font> command. - -\lefteqn <font color="#804040">*<a name="\lefteqn">\lefteqn</a>*</font> - The command <font color="#008080">|<A HREF="latexhelp.html#\lefteqn">\lefteqn</A>|</font> is used for splitting long - formulas across lines. It typesets its argument in - display style flush left in a box of zero width. - -<font color="#008080">==============================================================================</font> -f. equation <font color="#804040">*<a name="equation">equation</a>*</font> -<font color="#ffffff">></font> -<font color="#008000"> \begin{equation}</font> -<font color="#008000"> math formula</font> -<font color="#008000"> \end{equation}</font> - -The <font color="#008080">|<A HREF="latexhelp.html#equation">equation</A>|</font> environment centres your equation on the page and places the -equation number in the right margin. - -<font color="#008080">==============================================================================</font> -g. figure <font color="#804040">*<a name="figure">figure</a>*</font> -<font color="#ffffff">></font> -<font color="#008000"> \begin{figure}[placement]</font> -<font color="#008000"> body of the figure</font> -<font color="#008000"> \caption{figure title}</font> -<font color="#008000"> \end{figure}</font> - -Figures are objects that are not part of the normal text, and are usually -"floated" to a convenient place, like the top of a page. Figures will not be -split between two pages. - -The optional argument <font color="#6a5acd">[placement]</font> determines where <A HREF="latexhelp.html#LaTeX">LaTeX</A> will try to place -your figure. There are four places where <A HREF="latexhelp.html#LaTeX">LaTeX</A> can possibly put a float: - -h (Here) at the position in the text where the figure - environment appears. -t (Top) at the top of a text page. -b (Bottom) at the bottom of a text page. -p (Page of floats) on a separate float page, which is a page containing - no text, only floats. - -The standard <font color="#008080">|<A HREF="latexhelp.html#report-class">report-class</A>|</font> and <font color="#008080">|<A HREF="latexhelp.html#article-class">article-class</A>|</font> use the default placement -[tbp]. - -The body of the <font color="#008080">|<A HREF="latexhelp.html#figure">figure</A>|</font> is made up of whatever text, <A HREF="latexhelp.html#LaTeX">LaTeX</A> commands, etc. you -wish. - -The \caption command allows you to title your figure. - -<font color="#008080">==============================================================================</font> -h. flushleft <font color="#804040">*<a name="flushleft">flushleft</a>*</font> -<font color="#ffffff">></font> -<font color="#008000"> \begin{flushleft}</font> -<font color="#008000"> Text on line 1 <A HREF="latexhelp.html#\\">\\</A></font> -<font color="#008000"> Text on line 2 <A HREF="latexhelp.html#\\">\\</A></font> -<font color="#008000"> .</font> -<font color="#008000"> .</font> -<font color="#008000"> .</font> -<font color="#008000"> \end{flushleft}</font> - -The <font color="#008080">|<A HREF="latexhelp.html#flushleft">flushleft</A>|</font> environment allows you to create a paragraph consisting of -lines that are flushed left, to the left-hand margin. Each line must be -terminated with the string <font color="#008080">|<A HREF="latexhelp.html#\\">\\</A>|</font>. - -\raggedright <font color="#804040">*<a name="\raggedright">\raggedright</a>*</font> - This declaration corresponds to the <font color="#008080">|<A HREF="latexhelp.html#flushleft">flushleft</A>|</font> environment. - This declaration can be used inside an environment such as - <font color="#008080">|<A HREF="latexhelp.html#quote-l">quote-l</A>|</font> or in a <font color="#008080">|<A HREF="latexhelp.html#\parbox">\parbox</A>|</font>. Unlike the <font color="#008080">|<A HREF="latexhelp.html#flushleft">flushleft</A>|</font> - environment, the <font color="#008080">|<A HREF="latexhelp.html#\raggedright">\raggedright</A>|</font> command does not start a new - paragraph; it simply changes how <A HREF="latexhelp.html#LaTeX">LaTeX</A> formats paragraph - units. To affect a paragraph unit's format, the scope of the - declaration must contain the blank line or <font color="#008080">|<A HREF="latexhelp.html#\end">\end</A>|</font> command (of - an environment like <font color="#008080">|<A HREF="latexhelp.html#quote-l">quote-l</A>|</font>) that ends the paragraph unit. - -<font color="#008080">==============================================================================</font> -i. flushright <font color="#804040">*<a name="flushright">flushright</a>*</font> -<font color="#ffffff">></font> -<font color="#008000"> \begin{flushright}</font> -<font color="#008000"> Text on line 1 <A HREF="latexhelp.html#\\">\\</A></font> -<font color="#008000"> Text on line 2 <A HREF="latexhelp.html#\\">\\</A></font> -<font color="#008000"> .</font> -<font color="#008000"> .</font> -<font color="#008000"> .</font> -<font color="#008000"> \end{flushright}</font> - -The <font color="#008080">|<A HREF="latexhelp.html#flushright">flushright</A>|</font> environment allows you to create a paragraph consisting of -lines that are flushed right, to the right-hand margin. Each line must be -terminated with the string <font color="#008080">|<A HREF="latexhelp.html#\\">\\</A>|</font>. - -\raggedleft <font color="#804040">*<a name="\raggedleft">\raggedleft</a>*</font> - This declaration corresponds to the <font color="#008080">|<A HREF="latexhelp.html#flushright">flushright</A>|</font> environment. - This declaration can be used inside an environment such as - <font color="#008080">|<A HREF="latexhelp.html#quote-l">quote-l</A>|</font> or in a <font color="#008080">|<A HREF="latexhelp.html#\parbox">\parbox</A>|</font>. Unlike the <font color="#008080">|<A HREF="latexhelp.html#flushright">flushright</A>|</font> - environment, the <font color="#008080">|<A HREF="latexhelp.html#\raggedleft">\raggedleft</A>|</font> command does not start a new - paragraph; it simply changes how <A HREF="latexhelp.html#LaTeX">LaTeX</A> formats paragraph - units. To affect a paragraph unit's format, the scope of the - declaration must contain the blank line or <font color="#008080">|<A HREF="latexhelp.html#\end">\end</A>|</font> command (of - an environment like <font color="#008080">|<A HREF="latexhelp.html#quote-l">quote-l</A>|</font>) that ends the paragraph unit. - -<font color="#008080">==============================================================================</font> -j. itemize <font color="#804040">*<a name="itemize">itemize</a>*</font> -<font color="#ffffff">></font> -<font color="#008000"> \begin{itemize}</font> -<font color="#008000"> <A HREF="latexhelp.html#\item">\item</A> First item</font> -<font color="#008000"> <A HREF="latexhelp.html#\item">\item</A> Second item</font> -<font color="#008000"> .</font> -<font color="#008000"> .</font> -<font color="#008000"> .</font> -<font color="#008000"> \end{itemize}</font> - -The <font color="#008080">|<A HREF="latexhelp.html#itemize">itemize</A>|</font> environment produces a "bulleted" list. Itemizations can be -nested within one another, up to four levels deep. They can also be nested -within other paragraph-making environments. - -\item <font color="#804040">*<a name="\item">\item</a>*</font> - Each item of an itemized <A HREF="latexhelp.html#list">list</A> begins with an <font color="#008080">|<A HREF="latexhelp.html#\item">\item</A>|</font> command. - There must be at least one <font color="#008080">|<A HREF="latexhelp.html#\item">\item</A>|</font> command within the - environment. - -The <A HREF="latexhelp.html#itemize">itemize</A> environment uses the <font color="#008080">|\itemi|</font> through <font color="#008080">|\itemiv|</font> counters (see -section <font color="#008080">|<A HREF="latexhelp.html#latex-counters">latex-counters</A>|</font>). The type of numbering can be changed by redefining -\theitemi etc. - -<font color="#008080">==============================================================================</font> -k. letter <font color="#804040">*<a name="\letter">\letter</a>*</font> - -This environment is used for creating letters. See section <font color="#008080">|<A HREF="latexhelp.html#latex-letters">latex-letters</A>|</font>. - -<font color="#008080">==============================================================================</font> -l. list <font color="#804040">*<a name="list">list</a>*</font> - -The <font color="#008080">|<A HREF="latexhelp.html#list">list</A>|</font> environment is a generic environment which is used for defining many -of the more specific environments. It is seldom used in documents, but often -in macros. -<font color="#ffffff">></font> -<font color="#008000"> \begin{list}{label}{spacing}</font> -<font color="#008000"> <A HREF="latexhelp.html#\item">\item</A> First item</font> -<font color="#008000"> <A HREF="latexhelp.html#\item">\item</A> Second item</font> -<font color="#008000"> .</font> -<font color="#008000"> .</font> -<font color="#008000"> .</font> -<font color="#008000"> \end{list}</font> - -<font color="#008000"><b>'label'</b></font> The <font color="#6a5acd">{label}</font> argument specifies how items should be labelled. - This argument is a piece of text that is inserted in a box to - form the <font color="#6a5acd">{label}</font>. This argument can and usually does contain - other <A HREF="latexhelp.html#LaTeX">LaTeX</A> commands. - -<font color="#008000"><b>'spacing'</b></font> The <font color="#6a5acd">{spacing}</font> argument contains commands to change the spacing - parameters for the <font color="#008080">|<A HREF="latexhelp.html#list">list</A>|</font>. This argument will most often be - null, i.e., {}. This will select all default spacing which - should suffice for most cases. - -<font color="#008080">==============================================================================</font> -m. minipage <font color="#804040">*<a name="minipage">minipage</a>*</font> -<font color="#ffffff">></font> -<font color="#008000"> \begin{minipage}[position]{width}</font> -<font color="#008000"> text</font> -<font color="#008000"> \end{minipage}</font> - -The <font color="#008080">|<A HREF="latexhelp.html#minipage">minipage</A>|</font> environment is similar to a <font color="#008080">|<A HREF="latexhelp.html#\parbox">\parbox</A>|</font> command. It takes the -same optional <font color="#6a5acd">[position]</font> argument and mandatory <font color="#6a5acd">{width}</font> argument. You may use -other paragraph-making environments inside a <font color="#008080">|<A HREF="latexhelp.html#minipage">minipage</A>|</font>. Footnotes in a -minipage environment are handled in a way that is particularly useful for -putting footnotes in figures or tables. A <font color="#008080">|<A HREF="latexhelp.html#\footnote">\footnote</A>|</font> or <font color="#008080">|<A HREF="latexhelp.html#\footnotetext">\footnotetext</A>|</font> -command puts the footnote at the bottom of the minipage instead of at the -bottom of the page, and it uses the <font color="#008080">|\mpfootnote|</font> counter instead of the -ordinary footnote counter. See sections <font color="#008080">|<A HREF="latexhelp.html#latex-counters">latex-counters</A>|</font> and -<font color="#008080">|<A HREF="latexhelp.html#latex-footnotes">latex-footnotes</A>|</font>. - -<span style="background-color: #ffff00"><font color="#0000ff">NOTE</font></span>: Don't put one <font color="#008080">|<A HREF="latexhelp.html#minipage">minipage</A>|</font> inside another if you are using footnotes; they -may wind up at the bottom of the wrong minipage. - -<font color="#008080">==============================================================================</font> -n. picture <font color="#804040">*<a name="picture">picture</a>*</font> -<font color="#ffffff">></font> -<font color="#008000"> size position</font> -<font color="#008000"> \begin{picture}(width,height)(x offset,y offset)</font> -<font color="#008000"> .</font> -<font color="#008000"> .</font> -<font color="#008000"> picture commands</font> -<font color="#008000"> .</font> -<font color="#008000"> .</font> -<font color="#008000"> \end{picture}</font> - -The <font color="#008080">|<A HREF="latexhelp.html#picture">picture</A>|</font> environment allows you to create just about any kind of picture -you want containing text, lines, arrows and circles. You tell <A HREF="latexhelp.html#LaTeX">LaTeX</A> where to -put things in the picture by specifying their coordinates. A coordinate is a -number that may have a decimal point and a minus sign -- a number like 5, 2.3 -or -3.1416. A coordinate specifies a length in multiples of the unit length -<font color="#008080">|\unitlength|</font>, so if <font color="#008080">|\unitlength|</font> has been set to 1cm, then the coordinate -2.54 specifies a length of 2.54 centimetres. You can change the value of -<font color="#008080">|\unitlength|</font> anywhere you want, using the <font color="#008080">|<A HREF="latexhelp.html#\setlength">\setlength</A>|</font> command, but strange -things will happen if you try changing it inside the <font color="#008080">|<A HREF="latexhelp.html#picture">picture</A>|</font> environment. - -A position is a pair of coordinates, such as (2.4,-5), specifying the point -with x-coordinate 2.4 and y-coordinate -5. Coordinates are specified in the -usual way with respect to an origin, which is normally at the lower-left -corner of the <font color="#008080">|<A HREF="latexhelp.html#picture">picture</A>|</font>. -<span style="background-color: #ffff00"><font color="#0000ff">Note</font></span> that when a position appears as an argument, it is not enclosed in -braces; the paren... [truncated message content] |
From: <tm...@us...> - 2010-01-27 22:15:22
|
Revision: 1093 http://vim-latex.svn.sourceforge.net/vim-latex/?rev=1093&view=rev Author: tmaas Date: 2010-01-27 22:15:09 +0000 (Wed, 27 Jan 2010) Log Message: ----------- fix some broken internal links - remove static svn changelog file - update links to latex-suite html doc Modified Paths: -------------- trunk/htdocs/download.inc trunk/htdocs/faq.inc trunk/htdocs/manual.inc Modified: trunk/htdocs/download.inc =================================================================== --- trunk/htdocs/download.inc 2010-01-27 21:55:18 UTC (rev 1092) +++ trunk/htdocs/download.inc 2010-01-27 22:15:09 UTC (rev 1093) @@ -4,7 +4,6 @@ href="http://sourceforge.net/projects/vim-latex/files/">SourceForge Files for vim-latex</a> page. </p> -<a href="vimfiles/Changelog">Changelog</a> <a name=installation> <h2>Installation Instructions</h2> Modified: trunk/htdocs/faq.inc =================================================================== --- trunk/htdocs/faq.inc 2010-01-27 21:55:18 UTC (rev 1092) +++ trunk/htdocs/faq.inc 2010-01-27 22:15:09 UTC (rev 1093) @@ -149,7 +149,7 @@ <div class=ans> First check to make sure that you can call the programs specified by the <a -href="documentation/latex-suite/viewer-customization.html#Tex_ViewRule_format">viewing +href="documentation/latex-suite/customizing-viewing.html#Tex_ViewRule_format">viewing rules</a> from within vim. For example, if you specified the PDF viewing program as <tt>AcroRd32</tt>, then you should be able to do <pre>!start AcroRd32</pre> @@ -211,7 +211,7 @@ <div class=ans> Latex-suite maps certain <tt>Alt</tt> key sequences to some functions as described <a -href="documentation/latex-suite/bracketing-macros.html">here</a>. If you +href="documentation/latex-suite/altkey-mappings.html">here</a>. If you need to use these keys for regular editing, you will need to remap the Alt keys to something else as described in <a href="documentation/latex-suite/latex-suite-maps.html">here</a>. In Modified: trunk/htdocs/manual.inc =================================================================== --- trunk/htdocs/manual.inc 2010-01-27 21:55:18 UTC (rev 1092) +++ trunk/htdocs/manual.inc 2010-01-27 22:15:09 UTC (rev 1093) @@ -60,7 +60,7 @@ <h2>LaTeX Reference</h2> Latex-Suite comes ships with edition 1.6 of the LaTeX2e documentation translated into vim-help format. This file can be downloaded separately from -Latex-Suite <a href="documentation/latexhelp.txt">here</a>. After downloading +Latex-Suite <a href="download/latexhelp.txt">here</a>. After downloading this file to <tt>~/.vim/doc</tt>, you will need to run the <tt>:helptags</tt> command from within vim to view LaTeX help from within Vim. <p> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <tm...@us...> - 2010-01-27 22:18:19
|
Revision: 1094 http://vim-latex.svn.sourceforge.net/vim-latex/?rev=1094&view=rev Author: tmaas Date: 2010-01-27 22:18:12 +0000 (Wed, 27 Jan 2010) Log Message: ----------- fix another broken link and a typo Modified Paths: -------------- trunk/htdocs/download.inc trunk/htdocs/features.inc Modified: trunk/htdocs/download.inc =================================================================== --- trunk/htdocs/download.inc 2010-01-27 22:15:09 UTC (rev 1093) +++ trunk/htdocs/download.inc 2010-01-27 22:18:12 UTC (rev 1094) @@ -24,7 +24,7 @@ the <a href="/documentation/latex-suite/recommended-settings.html">vim-latex manual</a>. <h4>Step 3 of 4: Install the help files</h4> -To install the included latex-suit.txt and latexhelp.txt files as vim help +To install the included latex-suite.txt and latexhelp.txt files as vim help files, start vim and do the following: <p> <tt>helptags ~/.vim/doc</tt> (for *nix users) <br> Modified: trunk/htdocs/features.inc =================================================================== --- trunk/htdocs/features.inc 2010-01-27 22:15:09 UTC (rev 1093) +++ trunk/htdocs/features.inc 2010-01-27 22:18:12 UTC (rev 1094) @@ -43,7 +43,7 @@ href="index.php?subject=packages">the list of currently supported packages.</a><p></p> </li> -<li><a href="documentation/latexhelp.txt">LaTeX help file</a> +<li><a href="download/latexhelp.txt">LaTeX help file</a> Latex-suite ships with the standard texinfo file translated into vim help format so that you can get help for common latex commands from within vim. You can view the HTML version of this file <a This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <tm...@us...> - 2010-01-27 19:20:56
|
Revision: 1086 http://vim-latex.svn.sourceforge.net/vim-latex/?rev=1086&view=rev Author: tmaas Date: 2010-01-27 19:20:32 +0000 (Wed, 27 Jan 2010) Log Message: ----------- remove probably uneeded cscope files Removed Paths: ------------- trunk/htdocs/cscope.files trunk/htdocs/cscope.out Deleted: trunk/htdocs/cscope.files =================================================================== --- trunk/htdocs/cscope.files 2010-01-27 19:18:30 UTC (rev 1085) +++ trunk/htdocs/cscope.files 2010-01-27 19:20:32 UTC (rev 1086) @@ -1,2122 +0,0 @@ -\x8B |
From: <tm...@us...> - 2010-10-07 20:34:47
|
Revision: 1111 http://vim-latex.svn.sourceforge.net/vim-latex/?rev=1111&view=rev Author: tmaas Date: 2010-10-07 20:34:41 +0000 (Thu, 07 Oct 2010) Log Message: ----------- move refcard link to manual Modified Paths: -------------- trunk/htdocs/links.inc trunk/htdocs/manual.inc Modified: trunk/htdocs/links.inc =================================================================== --- trunk/htdocs/links.inc 2010-10-07 20:23:35 UTC (rev 1110) +++ trunk/htdocs/links.inc 2010-10-07 20:34:41 UTC (rev 1111) @@ -13,7 +13,6 @@ <li><a href="index.php?subject=branching&title=Branching%20Cheat%20Sheet">CVS Branching HOWTO</a></li> - <li><a href="http://users.physik.fu-berlin.de/~mgoerz/blog/2008/05/vim-latexsuite-refcard/">Vim-latex reference card</a></li> <!-- <li><a href="index.php?subject=patch&title=Submitting%20a%20patch">Submitting Modified: trunk/htdocs/manual.inc =================================================================== --- trunk/htdocs/manual.inc 2010-10-07 20:23:35 UTC (rev 1110) +++ trunk/htdocs/manual.inc 2010-10-07 20:34:41 UTC (rev 1111) @@ -70,6 +70,10 @@ </p> <p>Type <tt>:help helptags</tt> from within Vim for more information</p>. +<a name="vim-latex-ref-card"></a> +<h2>Vim-Latex Reference Card</h2> +Michael Goerz created a <a href="http://users.physik.fu-berlin.de/~mgoerz/blog/refcards/#latexsuite">a incomplete reference card for vim-latex key bindings</a>. + <?php // vim:ft=php:noet:ts=4 ?> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |