|
From: <sri...@us...> - 2004-07-22 00:41:34
|
Update of /cvsroot/vim-latex/vimfiles/doc In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv5140 Modified Files: latex-suite-quickstart.xml latex-suite.txt latex-suite.xml Log Message: New: Updated documentation of the Tex_ViewRuleComplete_format variable. Index: latex-suite-quickstart.xml =================================================================== RCS file: /cvsroot/vim-latex/vimfiles/doc/latex-suite-quickstart.xml,v retrieving revision 1.1 retrieving revision 1.2 diff -C2 -d -r1.1 -r1.2 *** latex-suite-quickstart.xml 16 Dec 2003 04:04:45 -0000 1.1 --- latex-suite-quickstart.xml 22 Jul 2004 00:41:17 -0000 1.2 *************** *** 265,269 **** 17 +-- 4 lines: eqnarray (eqn:simple) : \label{eqn:simple}--------------------- 21 This is my contribution to mathematics. ! 22 This is a reference to (\ref{}&lt;++&gt;)&lt;++&gt; 23 \end{document} ~ --- 265,269 ---- 17 +-- 4 lines: eqnarray (eqn:simple) : \label{eqn:simple}--------------------- 21 This is my contribution to mathematics. ! 22 This is a reference to (\ref{}<++>)<++> 23 \end{document} ~ Index: latex-suite.txt =================================================================== RCS file: /cvsroot/vim-latex/vimfiles/doc/latex-suite.txt,v retrieving revision 1.55 retrieving revision 1.56 diff -C2 -d -r1.55 -r1.56 *** latex-suite.txt 22 May 2004 01:30:39 -0000 1.55 --- latex-suite.txt 22 Jul 2004 00:41:17 -0000 1.56 *************** *** 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_dK|] 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_dM|] for a list of people who have helped. [...2021 lines suppressed...] --- 3167,3171 ---- ================================================================================ ! Credits *ls_11* *ls_a_dM* *latex-suite-credits* *************** *** 3150,3154 **** out who has done what. ! *latex-suite-maintainer* *ls_a_er* The current maintainer(s) of Latex-Suite is(are) --- 3204,3208 ---- out who has done what. ! *latex-suite-maintainer* *ls_a_et* 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.34 retrieving revision 1.35 diff -C2 -d -r1.34 -r1.35 *** latex-suite.xml 22 May 2004 01:30:39 -0000 1.34 --- latex-suite.xml 22 Jul 2004 00:41:18 -0000 1.35 *************** *** 2080,2110 **** <section id="latex-viewing"> <title>Latex Viewing and Searching</title> ! <para> ! If you are usingly commonly used &latex; tools to view output files, ! then you should be able to view compiled files from within &vim; by ! simply pressing <literal>\lv</literal>. ! </para> ! <note> <para> ! The viewing function also takes the <link ! linkend="latex-master-file"><literal>*.latexmain</literal></link> file ! into account to decide which file to show. </para> ! </note> ! <para> ! If pressing <literal>\lv</literal> does not work, then it most probably ! has to do with incorrect settings of the <literal><link ! linkend="Tex_ViewRule_format">g:Tex_ViewRule_<format></link></literal> ! where <literal><format></literal> is the format you are attempting ! to view. See the link above for how to set this according to your ! system. ! </para> ! <para> ! In addition to viewing the files, &ls; also supports forward and inverse ! searching for certain common tools for viewiing DVI documents. At the ! moment, there is built-in support for YAP on windows (which ships with ! MikTeX), and the popular <literal>xdvi</literal> on *nix platforms. See ! the next few sections for details on forward and inverse searching. ! </para> <section id="forward-searching"> <title>Forward Searching DVI documents</title> --- 2080,2120 ---- <section id="latex-viewing"> <title>Latex Viewing and Searching</title> ! <section id="latex-viewing-rules"> ! <title>Setting Viewing rules</title> <para> ! In order to view the output files created by compiling the source ! files, you need to specify which external program &ls; should call. You ! can specify the external program using one of two settings ! <link linkend="Tex_ViewRule_format">Tex_ViewRule_format</link> or <link ! linkend="Tex_ViewRuleComplete_format">Tex_ViewRuleComplete_format</link>. ! By default, &ls; has default settings for viewing various common output ! formats via the <literal>Tex_ViewRule_format</literal> settings, so ! that if you are using commonly used programs, you should be all set to ! view compiled files from within &vim; by simply pressing ! <literal>\lv</literal>. </para> ! <note> ! <para> ! The viewing function also takes the <link ! linkend="latex-master-file"><literal>*.latexmain</literal></link> file ! into account to decide which file to show. ! </para> ! </note> ! <para> ! If pressing <literal>\lv</literal> does not work, then it most probably ! has to do with incorrect settings of the <link ! linkend="Tex_ViewRule_format"><literal>g:Tex_ViewRule_<format></literal></link> ! where <literal><format></literal> is the format you are ! attempting to view. See the link above for how to set this according to ! your system. ! </para> ! <para> ! In addition to viewing the files, &ls; also supports forward and inverse ! searching for certain common tools for viewiing DVI documents. At the ! moment, there is built-in support for YAP on windows (which ships with ! MikTeX), and the popular <literal>xdvi</literal> on *nix platforms. See ! the next few sections for details on forward and inverse searching. ! </para> ! </section> <section id="forward-searching"> <title>Forward Searching DVI documents</title> *************** *** 3935,3938 **** --- 3945,3962 ---- for Mac, the system choice will be over-ridden. </para> + <para> + &ls; appends <literal>file.format</literal> to the above settings + while calling the external programs. For example, with + <programlisting>let g:Tex_ViewRule_dvi = 'yap -1'</programlisting> + <literal>yap</literal> is called as + <programlisting>!start yap -1 file.dvi</programlisting> from within + &vim;. (The initial <literal>start</literal> is used on + <literal>Windows</literal> platforms is to make <literal>yap</literal> + start as a seperate process.) If you find the way &ls; constructs the + command line too restrictive, you can use the <link + linkend="Tex_ViewRuleComplete_format"><literal>Tex_ViewRuleComplete_format</literal></link> + setting for more complete control on how the command line is + constructed while calling the external program for viewing. + </para> <note> <para> *************** *** 3952,3955 **** --- 3976,4019 ---- </note> </section> + <section id="Tex_ViewRuleComplete_format"> + <title>Tex_ViewRuleComplete_<format></title> + <para> + Here <literal><format></literal> refers to the extension of a + output format such as <literal>dvi</literal>, <literal>html</literal> + etc. + </para> + <para> + <literal>Tex_ViewRuleComplete_format</literal> takes precedence over + <literal>Tex_ViewRule_format</literal> if both are specified. By + default, &ls; does not define values for + <literal>Tex_ViewRuleComplete_format</literal> for any + <literal>format</literal>. Unlike in the case of + <literal>Tex_ViewRule_format</literal>, &ls; does not modify + <literal>Tex_ViewRuleComplete_format</literal> at all in constructing + the command line. The only modification is to substitute + <literal>'$*'</literal> everywhere in the string with the name of the + file being viewed (without the extension). + </para> + <note> + <title>IMPORTANT</title> + <para> + Make sure you make the process go into the background otherwise vim + will wait for the viewer to terminate before letting you edit the file + again. + </para> + <para> + To make a process go into the background on a <literal>*nix</literal> + platform, use a trailing <literal>&</literal> in the setting. On + <literal>Windows</literal>, use <literal>start</literal> at the + beginning of the setting. Example: Suppose you have a latex->html + converter which converts a file say foo.tex to a file foo/index.html. + Then you would use: + <programlisting>" On *nix platform + let g:Tex_ViewRuleComplete_html = 'MozillaFirebird $*/index.html &' + " On windows platform + let g:Tex_ViewRuleComplete_html = 'start MozillaFirebird $*/index.html'</programlisting> + </para> + </note> + </section> </section> <section id="customizing-menus"> |
