|
From: <sri...@us...> - 2003-06-23 09:13:54
|
Update of /cvsroot/vim-latex/vimfiles/doc
In directory sc8-pr-cvs1:/tmp/cvs-serv23766
Modified Files:
latex-suite.xml latex-suite.txt
Log Message:
Index: latex-suite.xml
===================================================================
RCS file: /cvsroot/vim-latex/vimfiles/doc/latex-suite.xml,v
retrieving revision 1.5
retrieving revision 1.6
diff -C2 -d -r1.5 -r1.6
*** latex-suite.xml 21 Jun 2003 22:13:07 -0000 1.5
--- latex-suite.xml 23 Jun 2003 09:13:51 -0000 1.6
***************
*** 54,58 ****
</articleinfo>
<section id="recommended-settings">
! <title>Recommended Settings</title>
<para>
Make sure that you create a few necessary settings in your
--- 54,65 ----
</articleinfo>
<section id="recommended-settings">
! <title>Installation and recommended Settings</title>
! <para>
! If you are reading this, it most probably means that you have already
! installed &ls; and the help files. If this is not the case, follow the
! detailed instructions on <ulink
! url="http://vim-latex.sourceforge.net/index.php?subject=download">&ls;'s
! download page</ulink>.
! </para>
<para>
Make sure that you create a few necessary settings in your
***************
*** 148,151 ****
--- 155,159 ----
</para>
</note>
+ <anchor id="place-holder" />
<note id="place-holders">
<title>Place Holders</title>
***************
*** 238,242 ****
<listitem>
All environment mappings begin with <literal>E</literal>
! </listitem>
<listitem>
If the environment can be broken up into 2 distinct words,
--- 246,250 ----
<listitem>
All environment mappings begin with <literal>E</literal>
! </listitem>
<listitem>
If the environment can be broken up into 2 distinct words,
***************
*** 295,299 ****
line
\end{center}</programlisting>
! </para>
</section>
<section id="normal-mode-environment-mappings">
--- 303,318 ----
line
\end{center}</programlisting>
! </para>
! <anchor id="ls-vmap-f5" />
! <para>
! You can also select a portion of text visually and press
! <literal><F5></literal> while still in visual mode. This will
! prompt you with a list of environments. (This list can be customized
! via the <link
! linkend="Tex_PromptedEnvironments">g:Tex_PromptedEnvironments</link>
! setting). You can either choose from this list or type in a new
! environment name. Once the selection is done, &ls; encloses the
! visually selected portion in the chosen environment.
! </para>
</section>
<section id="normal-mode-environment-mappings">
***************
*** 329,332 ****
--- 348,352 ----
<title>&latex; command maps</title>
<anchor id="ls-imap-f7" />
+ <anchor id="ls-imap-s-f7" />
<para>
&ls; provides two simple mappings <literal><F7></literal> and
***************
*** 347,350 ****
--- 367,381 ----
with a list of commands to change it to.
</para>
+ <anchor id="ls-vmap-f7" />
+ <para>
+ You can also select a portion of text visually and press
+ <literal><F7></literal> while still in visual mode. This will
+ prompt you with a list of commands. (This list can be customized
+ via the <link
+ linkend="Tex_PromptedCommands">g:Tex_PromptedCommands</link>
+ setting). You can either choose from this list or type in a new
+ command name. Once the selection is done, &ls; encloses the
+ visually selected portion in the chosen command.
+ </para>
</section>
<section id="font-maps">
***************
*** 1059,1075 ****
<para>
This module provides an easy way to insert references to labels and
! bibliographic entries.
! </para>
! <para>
! Consider the situation where you are editing a file with two equations
! labelled <literal>eqn:euler</literal> and <literal>eqn:einstein</literal>.
! Now you want to insert a reference to one of these equations. To do this,
! you type the <literal>\ref{eqn:}</literal> command and with the cursor
! placed after <literal>eqn:</literal>, press <literal><F9></literal>.
! This will bring up two new windows beneath the main window you were working
! in as shown in the figure below.
</para>
! <programlisting>
! 7
8 These are a couple of equations:
9 +-- 4 lines: eqnarray (eqn:euler) : e^{j\pi} + 1 &=& 0---------------
--- 1090,1142 ----
<para>
This module provides an easy way to insert references to labels and
! bibliographic entries. Although the completion capabilites are very
! diverse, &ls; only uses a single key (<literal><F9></literal> by
! default) to do all of it. Pressing the <literal><F9></literal> key
! does different things based on where you are located. &ls; tries to
! guess what you might be trying to complete at the location where you
! pressed <literal><F9></literal>. For example, pressing
! <literal><F9></literal> when you are within a
! <literal>\ref</literal> command will try to list the
! <literal>\label</literal>'s in the present directory. Pressing it when
! you are in a <literal>\cite</literal> command will list bibliography
! keys. &ls; also recognizes commands which need a file name argument and
! will put up an explorer window for you to choose a filename.
</para>
! <note id="ls-set-grepprg">
! <title>Before you start with &ls;'s completion function...</title>
! <para>
! All of &ls;'s completion capabilities depend on a external program
! being available on your system which can search through a number of
! files for a reg-exp pattern. On *nix systems, the pre-installed
! <literal>grep</literal> utility is more than adequate. Most windows
! systems come with a utility <literal>findstr</literal>, but that has
! proven to be very inadequate (for one, it does not have an option to
! force the file name to be displayed when searching through a single
! file). Your best bet is to install <ulink
! url="http://www.cygwin.com">cygwin</ulink>, but if you think thats
! overkill, you can <ulink
! url="http://www.google.com/search?q=windows%20gnu%20grep">search
! for</ulink> a windows implementation of GNU grep. (&ls; testing on
! windows has been done with cygwin's port of GNU grep).
! </para>
! <para>
! Once you have a <literal>grep</literal> program installed, you need to
! set the <literal>'grepprg'</literal> option for vim. Make sure you use a
! setting which forces the program to display file names even when you are
! searching through a single file. For GNU grep, the syntax is
! <programlisting>set grepprg=grep\ -nH\ $*</programlisting>
! </para>
! </note>
! <section id="ls-completion-usage">
! <title id="ls-completion-usage.title">&ls; completion example</title>
! <para>
! Consider the situation where you are editing a file with two equations
! labelled <literal>eqn:euler</literal> and <literal>eqn:einstein</literal>.
! Now you want to insert a reference to one of these equations. To do this,
! you type the <literal>\ref{eqn:}</literal> command and with the cursor
! placed after <literal>eqn:</literal>, press <literal><F9></literal>.
! This will bring up two new windows beneath the main window you were working
! in as shown in the figure below.
! <programlisting>
8 These are a couple of equations:
9 +-- 4 lines: eqnarray (eqn:euler) : e^{j\pi} + 1 &=& 0---------------
***************
*** 1088,1101 ****
~
~
- ~
- ~
- ~
- ~
newfile.tex 34,32 Bot
newfile.tex|11| \label{eqn:euler}
newfile.tex|15| \label{eqn:einstein}
~
- ~
- ~
[Error List] 1,1 All
7
--- 1155,1162 ----
***************
*** 1111,1220 ****
newfile.tex [Preview] 11,3 21%
</programlisting>
! <para>
! The first window (shown as <literal>[Error List]</literal> above) is a
! <literal>|cwindow|</literal> containing a list of possible matches for the
! reference. The cursor will be located in the first line of this window. The
! bottom window is a <literal>preview-window</literal> showing the context of
! the <literal>\label</literal>. Moving around in the
! <literal>[Error List]</literal> window automatically scrolls the
! preview window so as to always keep showing the context of the
! <literal>\label</literal> being viewed in the
! <literal>[Error List]</literal> window. You can also press
! <literal>J</literal> and <literal>K</literal> in the
! <literal>[ErrorList]</literal> window to scroll the preview window up and
! down.
! </para>
! <para>
! To insert one of the labels, simply position the cursor in the correct line
! in the <literal>[Error List]</literal> window and press
! <literal><enter></literal>. This will immediately close the two newly
! opened windows, get back to the correct location in the original file being
! edited and insert the label into the <literal>\ref</literal> command.
! </para>
! <para>
! If you notice carefully in the example above, the
! <literal>[Error List]</literal> window only showed the matches for the
! equations and did not list any of the figure labels. This is because we
! pressed <literal><F9></literal> after <literal>\ref{eqn:</literal>
! instead of simply after <literal>\ref{</literal>. This caused &ls; to
! search only for those labels which started with the string
! <literal>eqn:</literal>. If you had pressed
! <literal><F9></literal> after a <literal>\ref{</literal>, you would
! have been shown matches from <emphasis>all</emphasis> labels, not just
! those starting with <literal>eqn:</literal>.
! </para>
! <para>
! Thus prefixing all your labels with <literal>eqn:</literal>,
! <literal>fig:</literal>, <literal>tab:</literal> etc. depending on what you
! are labelling will lead to an easier time completing references.
! </para>
! <para>
! The same mechanism also works with citations by pressing <F9>
! after typing "\cite{". In the case of citations, Latex-suite
! automatically displays a list of bibliographic entries found in various
! files in the present directory.
! </para>
! <para>
! This mechanism in fact works with all commands with "ref" or "cite" in them.
! Thus you will get completion with \citen, \citenum or \pageref. If you want
! to create your own command which uses cite or ref mechanism make sure proper
! word is inside it. Example:
! <programlisting>\newcommand{\pref}[1]{~(p.~\pageref{#1})}</programlisting>
! </para>
! <para>
! F9> works also with normal words. You can use it as: "Its name is tetr<F9>".
! Now Latex-suite will look in all .tex files in directory of edited file word
! which is beginning with "tetr". Note: <cr> has here different behavior. It
! does not try to complete word but moves you to location chosen in cwindow.
! </para>
! <para>
! Under MS-Windows you may need to make additional configuration of 'grepgrg'
! option. If you have grep program default value "grep -n" doesn't show file
! names if there is only one matching file. Place
! <programlisting>set grepprg=grep\ -Hn</programlisting>
! in your _vimrc.
! </para>
! <para>
! The functionality in this module is also available via three command-line
! utilities: |TLook|, |TLookBib| and |TLookAll|.
! </para>
! <para>
! You can use the <link
! linkend="Tex_ViewerCwindowHeight">g:Tex_ViewerCwindowHeight</link> and
! <link linkend="Tex_ViewerPreviewHeight">g:Tex_ViewerPreviewHeight</link>
! options in texrc to configure the heights of the "[Error List]" and preview
! window.
! </para>
! <para>
! Latex-suite is distributed with slightly changed explorer.vim. This
! modification allows to perform custom operations in explorer buffer.
! </para>
! <para>
! After \includegraphics{<F9> Latex-suite will open explorer buffer with current
! directory or directory defined with g:Tex_ImageDir variable. When you choose
! graphic file with <cr> its name will be inserted into file as bib key or
! label. If g:Tex_ImageDir is set Latex-suite assume you also defined
! \graphicspath{} command and will insert just file name (without extension). If
! g:Tex_ImageDir is empty (default) it will put relative path to graphic file.
! </para>
! <para>
! After \bibliography{<F9> Latex-suite will open explorer buffer with current
! directory. After <cr> name of relative path to chosen file (without extension)
! will be inserted.
! </para>
! <para>
! In both cases explorer window will open with basic filter. You should not see
! uninteresting in current context files.
! </para>
! <para>
! You can regulate height of explorer window with g:Tex_ExplorerHeight variable
! (default 10).
! </para>
<section id="latex-completion-cite">
<title>&ls; <literal>\cite</literal> completion</title>
<para>
! When you press <literal><F9></literal> in insert mode after a
! <literal>\cite{</literal>, &ls; will try to complete it with
! bibliographic entries.
</para>
<para>
--- 1172,1268 ----
newfile.tex [Preview] 11,3 21%
</programlisting>
! </para>
! <para>
! The first window (shown as <literal>[Error List]</literal> above) is a
! <literal>|cwindow|</literal> containing a list of possible matches for the
! reference. The cursor will be located in the first line of this window. The
! bottom window is a <literal>preview-window</literal> showing the context of
! the <literal>\label</literal>. Moving around in the
! <literal>[Error List]</literal> window automatically scrolls the
! preview window so as to always keep showing the context of the
! <literal>\label</literal> being viewed in the
! <literal>[Error List]</literal> window. You can also press
! <literal>J</literal> and <literal>K</literal> in the
! <literal>[ErrorList]</literal> window to scroll the preview window up and
! down.
! </para>
! <para>
! To insert one of the labels, simply position the cursor in the correct line
! in the <literal>[Error List]</literal> window and press
! <literal><enter></literal>. This will immediately close the two newly
! opened windows, get back to the correct location in the original file being
! edited and insert the label into the <literal>\ref</literal> command.
! </para>
! <para>
! If you notice carefully in the example above, the
! <literal>[Error List]</literal> window only showed the matches for the
! equations and did not list any of the figure labels. This is because we
! pressed <literal><F9></literal> after <literal>\ref{eqn:</literal>
! instead of simply after <literal>\ref{</literal>. This caused &ls; to
! search only for those labels which started with the string
! <literal>eqn:</literal>. If you had pressed
! <literal><F9></literal> after a <literal>\ref{</literal>, you would
! have been shown matches from <emphasis>all</emphasis> labels, not just
! those starting with <literal>eqn:</literal>.
! </para>
! <para>
! Thus prefixing all your labels with <literal>eqn:</literal>,
! <literal>fig:</literal>, <literal>tab:</literal> etc. depending on what you
! are labelling will lead to an easier time completing references.
! </para>
! </section>
! <section id="ls-completion-ref">
! <title>&ls; \ref completion</title>
! <para>
! To complete a <literal>|\ref|</literal> command, position yourself
! between the curly braces of a <literal>\ref</literal> command and press
! <literal><F9></literal>. For example, you can press
! <literal><F9></literal> just after <literal>\ref{</literal> or
! after <literal>\ref{eqn:</literal>. &ls; will search for
! <literal>\label</literal>'s in all tex files in the current directory
! and display the results in two windows as desribed in section <link
! linkend="ls-completion-usage"
! endterm="ls-completion-usage.title"></link>.
! </para>
! <para>
! Any command which contains the pattern <literal>ref</literal> in it is
! treated as if it is a way to call <literal>\ref</literal> indirectly.
! Thus pressing <literal><F9></literal> after something like
! <literal>\pref{</literal> will also search for
! <literal>\label</literal>'s.
! </para>
! <para>
! When you press <literal><F9></literal> after typing
! <literal>\ref{eqn:</literal> then &ls; will only list
! <literal>\label</literal>'s which begin with <literal>eqn:</literal>
! If you press <literal><F9></literal> after a simple
! <literal>\ref{</literal>, then &ls; will list all
! <literal>\label</literal>'s in all the tex files in the present
! directory.
! </para>
! <note>
! <title>HINT</title>
! <para>
! By prefixing your labels with eqn:, fig: etc, you can easily filter
! out a lot of undesirable results.
! </para>
! </note>
! </section>
<section id="latex-completion-cite">
<title>&ls; <literal>\cite</literal> completion</title>
<para>
! When you press <literal><F9></literal> in insert mode after
! <literal>\cite{pre</literal>, &ls; will present a list of valid
! bibliographic keys starting with <literal>"pre"</literal> and ask you
! to choose from one of them. ("pre" can be left empty in which case all
! valid bibliographic keys will be listed). The window setup is as
! described in section <link linkend="ls-completion-usage"
! endterm="ls-completion-usage.title"></link>.
! </para>
! <para>
! <literal><F9></literal> will also work in a similar way after any
! command which contains the word <literal>cite</literal> in it. For
! example, pressing <literal><F9></literal> will also work with
! <literal>\citenum</literal> etc.
</para>
<para>
***************
*** 1294,1297 ****
--- 1342,1398 ----
</section>
</section>
+ <section id="ls-filename-completion">
+ <title>&ls; filename completion</title>
+ <para>
+ When you press <literal><F9></literal> at a location where &ls;
+ guesses a filename needs to be typed, then a new explorer window will
+ open up with the list of files. You can use this window to change
+ directories etc. Pressing <literal><enter></literal> on a filename
+ in the explorer window will automatically close the explorer window,
+ return to the location where you pressed <literal><F9></literal>
+ from and insert the filename into that position.
+ </para>
+ <para>
+ &ls; also tries to guess what kinds of files you might not want to
+ insert and hides those accordingly. For example, if you press
+ <literal><F9></literal> when you are located at
+ <literal>\includegraphics{</literal>, then &ls; knows that you will not
+ want to insert <literal>.tex</literal> files. Therefore, the explorer
+ window will automatically hide these files.
+ </para>
+ <para>
+ As of now, &ls; recognizes the following commands for filename
+ completion. Along with the commands, this table also lists the
+ files which &ls; will not show for completing each command.
+ </para>
+ <informaltable frame="all">
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>command</entry>
+ <entry>hide pattern</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><literal>\bibliography</literal></entry>
+ <entry><literal>'^\.,\.[^b]..$'</literal></entry>
+ </row>
+ <row>
+ <entry><literal>\include</literal> <literal>\includeonly</literal></entry>
+ <entry><literal>'^\.,\.[^t]..$'</literal></entry>
+ </row>
+ <row>
+ <entry><literal>\includegraphics</literal> <literal>\psfig</literal></entry>
+ <entry><literal>'^\.,\.tex$,\.bib$,\.bbl$,\.zip$,\.gz$'</literal></entry>
+ </row>
+ <row>
+ <entry><literal>\input</literal></entry>
+ <entry><literal>''</literal></entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </section>
</section>
<section id="latex-compiling">
***************
*** 1595,1599 ****
meaningful fold-text, otherwise the second line of the environment is displayed
along with the name of the environment. In other words, the following
- </para>
<programlisting>\begin{figure}[h]
\centerline{\psfig{figure=slidercrank.eps,height=6cm}}
--- 1696,1699 ----
***************
*** 1605,1614 ****
\sin(\pi) = 0
\end{eqnarray}</programlisting>
<para>
will be shown as:
- </para>
<programlisting>+--- 5 lines: figure (fig:slidercrank) : The Slider Crank Mechanism. -----
% a LaTeX comment.
+--- 3 lines: eqnarray () : \sin(\pi) = 0 --------------------------------</programlisting>
<section id="default-folding">
<title>Default Folding Scheme in &ls;</title>
--- 1705,1715 ----
\sin(\pi) = 0
\end{eqnarray}</programlisting>
+ </para>
<para>
will be shown as:
<programlisting>+--- 5 lines: figure (fig:slidercrank) : The Slider Crank Mechanism. -----
% a LaTeX comment.
+--- 3 lines: eqnarray () : \sin(\pi) = 0 --------------------------------</programlisting>
+ </para>
<section id="default-folding">
<title>Default Folding Scheme in &ls;</title>
***************
*** 2118,2124 ****
don't have to enclose argument in "". <cr> takes you to
location. Other keys work as described in |latex-viewer|.
- Note: TLookBib uses :grep command and is using 'grepprg'. Its
- regular expressions can be different from those of Vim.
</para>
</section>
<section id="TLookAll">
--- 2219,2229 ----
don't have to enclose argument in "". <cr> takes you to
location. Other keys work as described in |latex-viewer|.
</para>
+ <note>
+ <para>
+ TLookBib uses :grep command and is using 'grepprg'. Its
+ regular expressions can be different from those of Vim.
+ </para>
+ </note>
</section>
<section id="TLookAll">
***************
*** 2477,2480 ****
--- 2582,2610 ----
</para>
</note>
+ </section>
+ <section id="Tex_PromptedCommands">
+ <title>g:Tex_PromptedCommands</title>
+ <informaltable frame="all">
+ <tgroup cols="2">
+ <tbody>
+ <row><entry>Type</entry><entry>String</entry></row>
+ <row><entry>Default Value</entry>
+ <entry>
+ <literal>'footnote,cite,pageref,label'</literal>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ <para>
+ This string represents a comma seperated list of &latex; commands
+ which &ls; uses for the <literal><F7></literal> and
+ <literal><S-F7></literal> maps as described <link
+ linkend="latex-command-maps">here</link>.
+ </para>
+ <para>
+ Leaving this string empty will leave the <literal><F7></literal>
+ key unmapped.
+ </para>
</section>
</section>
Index: latex-suite.txt
===================================================================
RCS file: /cvsroot/vim-latex/vimfiles/doc/latex-suite.txt,v
retrieving revision 1.29
retrieving revision 1.30
diff -C2 -d -r1.29 -r1.30
*** latex-suite.txt 21 Jun 2003 22:16:15 -0000 1.29
--- latex-suite.txt 23 Jun 2003 09:13:51 -0000 1.30
***************
*** 12,17 ****
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 [|latex-suite-credits|] for a list
! of people who have helped.
Latex-suite is released under the Vim charityware license. For license and
--- 12,17 ----
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 [|ls_a_dk|] for a list of people who
[...2763 lines suppressed...]
! ================================================================================
! About this file
!
! This file was created automatically from its XML variant using db2vim. db2vim is
! a python script which understands a very limited subset of the Docbook XML 4.2
! DTD and outputs a plain text file in vim help format.
!
! db2vim can be obtained via anonymous CVS from sourceforge.net. Use
!
! cvs -d:pserver:ano...@cv...:/cvsroot/vim-latex co db2vim
!
! Or you can visit the web-interface to sourceforge CVS at:
! http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/vim-latex/db2vim/
!
! The following modelines should nicely fold up this help manual.
!
! vim:ft=help:fdm=expr:nowrap
vim:foldexpr=getline(v\:lnum-1)=~'-\\{80}'?'>2'\:getline(v\:lnum-1)=~'=\\{80}'?'>1'\:getline(v\:lnum)=~'=\\{80}'?'0'\:getline(v\:lnum)=~'-\\{80}'?'1'\:'='
! vim:foldtext=substitute(v\:folddashes.substitute(getline(v\:foldstart),'\\s*\\*.*',"",""),'^--','\ \ \ \ \ \ ','')
================================================================================
|
