Update of /cvsroot/vim-latex/vimfiles/doc
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv25815
Modified Files:
latex-suite.txt latex-suite.xml
Log Message:
New: A desciption of how Tex_ProjectSourceFiles works.
Index: latex-suite.txt
===================================================================
RCS file: /cvsroot/vim-latex/vimfiles/doc/latex-suite.txt,v
retrieving revision 1.58
retrieving revision 1.59
diff -C2 -d -r1.58 -r1.59
*** latex-suite.txt 19 Nov 2005 22:35:47 -0000 1.58
--- latex-suite.txt 22 Dec 2005 21:28:47 -0000 1.59
***************
*** 12,16 ****
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_dM|] for a list of people who
have helped.
--- 12,16 ----
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_dO|] for a list of people who
have helped.
[...1896 lines suppressed...]
--- 3229,3233 ----
================================================================================
! Credits *ls_12* *ls_a_dO*
*latex-suite-credits*
***************
*** 3224,3228 ****
out who has done what.
! *latex-suite-maintainer* *ls_a_et*
The current maintainer(s) of Latex-Suite is(are)
--- 3266,3270 ----
out who has done what.
! *latex-suite-maintainer* *ls_a_ev*
The current maintainer(s) of Latex-Suite is(are)
Index: latex-suite.xml
===================================================================
RCS file: /cvsroot/vim-latex/vimfiles/doc/latex-suite.xml,v
retrieving revision 1.38
retrieving revision 1.39
diff -C2 -d -r1.38 -r1.39
*** latex-suite.xml 19 Nov 2005 22:35:47 -0000 1.38
--- latex-suite.xml 22 Dec 2005 21:28:49 -0000 1.39
***************
*** 1990,1996 ****
<para>
Here <literal>main.tex.latexmain</literal> is (obviously) a different
! file from <literal>main.tex</literal> itself. <literal>main.tex</literal>
! need not be renamed. The contents of
! <literal>main.tex.latexmain</literal> are not used. This ofcourse
restricts each directory to have a single master file.
</para>
--- 1990,1995 ----
<para>
Here <literal>main.tex.latexmain</literal> is (obviously) a different
! file from <literal>main.tex</literal> itself.
! <literal>main.tex</literal> need not be renamed. This ofcourse
restricts each directory to have a single master file.
</para>
***************
*** 2595,2598 ****
--- 2594,2622 ----
</section>
</section>
+ <section id="latex-project">
+ <title>Latex projects</title>
+ <para>
+ Most &latex; projects are divided into a set of files each of which
+ contains some related material, like a chapter, a section etc. &ls;
+ supports this in various ways. The per-project settings are stored in
+ the <link linkend="latex-master-file">master file</link>, which is of
+ the form <literal>main.tex.latexmain</literal>. In previous versions,
+ the contents of this file were ignored. However, this file is now
+ considered as if it is a &vim; source file and its contents are sourced
+ whenever a new project is edited. Thus you can put &ls; settings
+ specific to a given project in this file.
+ </para>
+ <para>
+ This file is used in various ways. Firstly, it is used to point to the
+ name of the file which should be compiled as described in <link
+ linkend="latex-master-file">latex-master-file</link>.
+ </para>
+ <para>
+ You can also put settings such as <link
+ linkend="Tex_ProjectSourceFiles">Tex_ProjectSourceFiles</link> in this
+ file to minimize the time it takes to search through all the relevant
+ project files.
+ </para>
+ </section>
<section id="latex-suite-commands-maps">
<title>&ls; Commands and Maps</title>
***************
*** 3690,3693 ****
--- 3714,3746 ----
</orderedlist>
</section>
+ <section id="Tex_ProjectSourceFiles">
+ <title>g:Tex_ProjectSourceFiles</title>
+ <informaltable frame="all">
+ <tgroup cols="2">
+ <tbody>
+ <row><entry>Type</entry><entry>String</entry></row>
+ <row><entry>Default Value</entry>
+ <entry><literal>''</literal></entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ <para>
+ This setting is meant to be initialized on a per-project basis using
+ the <link linkend="latex-master-file">&ls; master file</link> as
+ described in <link linkend="latex-project">&ls; Project</link>
+ section. It is a list of source files which are used in the project.
+ If defined, then instead of using the logic described in
+ <link
+ linkend="Tex_UseSimpleLabelSearch">Tex_UseSimpleLabelSearch</link> to
+ search for files in which to search for <literal>\label</literal>s, we
+ simply search for <literal>\label</literal>s in this list. This
+ significantly reduces the time it takes to generate the list of
+ possible completions for large projects.
+ </para>
+ <para>
+ The list is specified as a whitespace seperated list of filenames
+ relative to the location of the main file.
+ </para>
+ </section>
<section id="Tex_RememberCiteSearch">
<title>g:Tex_RememberCiteSearch</title>
|
