[Vim-latex-cvs] vimfiles/doc latex-suite.xml,1.9,1.10 latex-suite.txt,1.32,1.33
Brought to you by:
srinathava,
tmaas
From: <sri...@us...> - 2003-07-17 07:25:53
|
Update of /cvsroot/vim-latex/vimfiles/doc In directory sc8-pr-cvs1:/tmp/cvs-serv13977 Modified Files: latex-suite.xml latex-suite.txt Log Message: including documentation about Tex_MainFileExpression. Index: latex-suite.xml =================================================================== RCS file: /cvsroot/vim-latex/vimfiles/doc/latex-suite.xml,v retrieving revision 1.9 retrieving revision 1.10 diff -C2 -d -r1.9 -r1.10 *** latex-suite.xml 16 Jul 2003 05:27:14 -0000 1.9 --- latex-suite.xml 17 Jul 2003 07:25:49 -0000 1.10 *************** *** 1713,1717 **** <literal>main.tex</literal>). After doing this, when you press <literal>\ll</literal> while editing <literal>chapter1.tex</literal>, then ! &ls; will compile <literal>main.tex</literal> instead. </para> <note> --- 1713,1722 ---- <literal>main.tex</literal>). After doing this, when you press <literal>\ll</literal> while editing <literal>chapter1.tex</literal>, then ! &ls; will compile <literal>main.tex</literal> instead. The ! <literal>.latexmain</literal> file can also be present in a directory ! directly above the directory containing the present file. &ls; will ! scan upwards from the directory containing the present file and stop ! when it finds a <literal>.latexmain</literal> file, which points to the ! master file for the present file. </para> <note> *************** *** 1724,1727 **** --- 1729,1751 ---- </para> </note> + <anchor id="Tex_MainFileExpression" /> + <para> + If you wish to use some different logic to specify the main file name, + you can specify a custom expression via the + <literal>Tex_MainFileExpression</literal> variable. This is a string + containing a valid vim expression. In addition, you can use a variable + <literal>modifier</literal> which is in the format used for + <literal>|filename-modifiers|</literal>, for example, + <literal>':p:h'</literal>. You should utilize this variable to modify + the filename of the main file. + <programlisting>let g:Tex_MainFileExpression = 'MainFile(modifier)' + function! MainFile(fmod) + if glob('*.latexmain') != '' + return fnamemodify(glob('*.latexmain'), a:fmod) + else + return '' + endif + endif</programlisting> + </para> </section> <section id="compiler-output-customization"> Index: latex-suite.txt =================================================================== RCS file: /cvsroot/vim-latex/vimfiles/doc/latex-suite.txt,v retrieving revision 1.32 retrieving revision 1.33 diff -C2 -d -r1.32 -r1.33 *** latex-suite.txt 16 Jul 2003 05:27:14 -0000 1.32 --- latex-suite.txt 17 Jul 2003 07:25:49 -0000 1.33 *************** *** 191,195 **** *place-holder* *ls_a_dp* ! *place-holders* *ls_a_dS* NOTE: Place Holders ------------- --- 191,195 ---- *place-holder* *ls_a_dp* ! *place-holders* *ls_a_dT* NOTE: Place Holders ------------- *************** *** 375,379 **** These mappings insert font descriptions such as: \textsf{<++>}<++> with the ! cursor left in place of the first placeholder [|ls_a_dS|] (the <++> characters). Mnemonic: --- 375,379 ---- These mappings insert font descriptions such as: \textsf{<++>}<++> with the ! cursor left in place of the first placeholder [|ls_a_dT|] (the <++> characters). Mnemonic: *************** *** 710,714 **** 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 ! placeholders [|ls_a_dS|] if wanted. When you choose a macro from the menu, the corresponding file is read into the --- 710,714 ---- 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 ! placeholders [|ls_a_dT|] if wanted. When you choose a macro from the menu, the corresponding file is read into the *************** *** 862,866 **** triggered. What characters are used to display place-holders when you trigger an IMAP are controlled by the Imap_PlaceHolderStart ! [|ls_a_cB|] and Imap_PlaceHolderEnd [|ls_a_dG|] settings. --- 862,866 ---- triggered. What characters are used to display place-holders when you trigger an IMAP are controlled by the Imap_PlaceHolderStart ! [|ls_a_cB|] and Imap_PlaceHolderEnd [|ls_a_dH|] settings. *************** *** 1103,1107 **** choose a filename. ! *ls-set-grepprg* *ls_a_dT* NOTE: Before you start with Latex-Suite's completion function... ---------------------------------------------------------- --- 1103,1107 ---- choose a filename. ! *ls-set-grepprg* *ls_a_dU* NOTE: Before you start with Latex-Suite's completion function... ---------------------------------------------------------- *************** *** 1404,1408 **** directory containing chapter1.tex (and main.tex). After doing this, when you press \ll while editing chapter1.tex, then Latex-Suite will compile main.tex ! instead. NOTE: Here main.tex.latexmain is (obviously) a different file from main.tex --- 1404,1411 ---- directory containing chapter1.tex (and main.tex). After doing this, when you press \ll while editing chapter1.tex, then Latex-Suite will compile main.tex ! instead. The .latexmain file can also be present in a directory directly above ! the directory containing the present file. Latex-Suite will scan upwards from ! the directory containing the present file and stop when it finds a .latexmain ! file, which points to the master file for the present file. NOTE: Here main.tex.latexmain is (obviously) a different file from main.tex *************** *** 1412,1415 **** --- 1415,1434 ---- + *Tex_MainFileExpression* *ls_a_dx* + If you wish to use some different logic to specify the main file name, you can + specify a custom expression via the Tex_MainFileExpression variable. This is a + string containing a valid vim expression. In addition, you can use a variable + modifier which is in the format used for |filename-modifiers|, for example, + ':p:h'. You should utilize this variable to modify the filename of the main + file. > + let g:Tex_MainFileExpression = 'MainFile(modifier)' + function! MainFile(fmod) + if glob('*.latexmain') != '' + return fnamemodify(glob('*.latexmain'), a:fmod) + else + return '' + endif + endif + -------------------------------------------------------------------------------- *************** *** 1509,1513 **** placed. ! *enabling-searching* *ls_a_dx* NOTE: Enabling Forward and Inverse Searching -------------------------------------- --- 1528,1532 ---- placed. ! *enabling-searching* *ls_a_dy* NOTE: Enabling Forward and Inverse Searching -------------------------------------- *************** *** 1527,1531 **** source file at a given location when you double-click in the DVI viewer window. ! You will need to enable searching [|ls_a_dx|] in order to use this functionality. --- 1546,1550 ---- source file at a given location when you double-click in the DVI viewer window. ! You will need to enable searching [|ls_a_dy|] in order to use this functionality. *************** *** 1710,1714 **** *latex-suite-maps* ! *remapping-latex-suite-keys* *ls_a_dy* Most of the mappings used in Latex-Suite can be mapped to a different key combination to suit your particular needs. An example best explains the --- 1729,1733 ---- *latex-suite-maps* ! *remapping-latex-suite-keys* *ls_a_dz* Most of the mappings used in Latex-Suite can be mapped to a different key combination to suit your particular needs. An example best explains the *************** *** 1737,1747 **** These mappings are utlilized for jumping between placeholders as described here ! [|ls_a_dS|]. See the parent section [|ls_a_ce|] to find out how to use this information to change the default maps. ! *Plug_IMAP_JumpForward* *ls_a_dz* ! *Plug_IMAP_JumpBack* *ls_a_dA* ! *Plug_IMAP_DeleteAndJumpForward* *ls_a_dB* ! *Plug_IMAP_DeleteAndJumBack* *ls_a_dC* Plug map Default Key~ <Plug>IMAP_JumpForward <C-j> --- 1756,1766 ---- These mappings are utlilized for jumping between placeholders as described here ! [|ls_a_dT|]. See the parent section [|ls_a_ce|] to find out how to use this information to change the default maps. ! *Plug_IMAP_JumpForward* *ls_a_dA* ! *Plug_IMAP_JumpBack* *ls_a_dB* ! *Plug_IMAP_DeleteAndJumpForward* *ls_a_dC* ! *Plug_IMAP_DeleteAndJumBack* *ls_a_dD* Plug map Default Key~ <Plug>IMAP_JumpForward <C-j> *************** *** 1751,1757 **** <Plug>IMAP_JumpForward takes you to the location of the next place-holder ! [|ls_a_dS|]. ! <Plug>IMAP_JumpBack takes you to the previous place-holder [|ls_a_dS|]. <Plug>IMAP_DeleteAndJumpForward deletes the presently selected place-holder and --- 1770,1776 ---- <Plug>IMAP_JumpForward takes you to the location of the next place-holder ! [|ls_a_dT|]. ! <Plug>IMAP_JumpBack takes you to the previous place-holder [|ls_a_dT|]. <Plug>IMAP_DeleteAndJumpForward deletes the presently selected place-holder and *************** *** 1772,1781 **** These mappings are are described in the section Alt key macros [|ls_a_bw|]. See ! the parent section [|ls_a_dy|] to see how to use the following information to remap keys. ! *Plug_Tex_MathBF* *ls_a_dD* ! *Plug_Tex_MathCal* *ls_a_dE* ! *Plug_Tex_LeftRight* *ls_a_dF* Plug Mapping Default Key~ <Plug>Tex_MathBF <Alt-B> --- 1791,1800 ---- These mappings are are described in the section Alt key macros [|ls_a_bw|]. See ! the parent section [|ls_a_dz|] to see how to use the following information to remap keys. ! *Plug_Tex_MathBF* *ls_a_dE* ! *Plug_Tex_MathCal* *ls_a_dF* ! *Plug_Tex_LeftRight* *ls_a_dG* Plug Mapping Default Key~ <Plug>Tex_MathBF <Alt-B> *************** *** 2003,2007 **** *customizing-place-holders* ! Latex-Suite uses place-holders [|ls_a_dS|] to minimize using the movement keys while typing. The following settings affect how place-holders are used. --- 2022,2026 ---- *customizing-place-holders* ! Latex-Suite uses place-holders [|ls_a_dT|] to minimize using the movement keys while typing. The following settings affect how place-holders are used. *************** *** 2026,2030 **** *Imap_PlaceHolderStart* ! *Imap_PlaceHolderEnd* *ls_a_dG* Setting Type Value~ Imap_PlaceHolderStart String '<+' --- 2045,2049 ---- *Imap_PlaceHolderStart* ! *Imap_PlaceHolderEnd* *ls_a_dH* Setting Type Value~ Imap_PlaceHolderStart String '<+' *************** *** 2073,2082 **** setting each of the variables to zero will take away. ! *Tex_EnvironmentMaps* *ls_a_dH* ! *Tex_EnvironmentMenus* *ls_a_dI* ! *Tex_FontMaps* *ls_a_dJ* ! *Tex_FontMenus* *ls_a_dK* ! *Tex_SectionMaps* *ls_a_dL* ! *Tex_SectionMenus* *ls_a_dM* Setting Link to relevant section Default Value~ g:Tex_EnvironmentMaps Environment Mappings [|ls_a_bg|] 1 --- 2092,2101 ---- setting each of the variables to zero will take away. ! *Tex_EnvironmentMaps* *ls_a_dI* ! *Tex_EnvironmentMenus* *ls_a_dJ* ! *Tex_FontMaps* *ls_a_dK* ! *Tex_FontMenus* *ls_a_dL* ! *Tex_SectionMaps* *ls_a_dM* ! *Tex_SectionMenus* *ls_a_dN* Setting Link to relevant section Default Value~ g:Tex_EnvironmentMaps Environment Mappings [|ls_a_bg|] 1 *************** *** 2099,2103 **** then for selected environments, latex-suite asks a series of questions on the command line and inserts a template with the corresponding fields already filled ! in. Setting this to zero will insert a template with place-holders [|ls_a_dS|] marking off the places where fields need to be filled. --- 2118,2122 ---- then for selected environments, latex-suite asks a series of questions on the command line and inserts a template with the corresponding fields already filled ! in. Setting this to zero will insert a template with place-holders [|ls_a_dT|] marking off the places where fields need to be filled. *************** *** 2251,2258 **** These three settings affect the aesthetics of the completion functionality. ! *Tex_ViewerCwindowHeight* *ls_a_dN* ! *Tex_ViewerPreviewHeight* *ls_a_dO* ! *Tex_ExplorerHeight* *ls_a_dP* ! *Tex_ImageDir* *ls_a_dQ* Setting Explanation Default Value~ g:Tex_ViewerCwindowHeight The height of the cwindow which 5 --- 2270,2277 ---- These three settings affect the aesthetics of the completion functionality. ! *Tex_ViewerCwindowHeight* *ls_a_dO* ! *Tex_ViewerPreviewHeight* *ls_a_dP* ! *Tex_ExplorerHeight* *ls_a_dQ* ! *Tex_ImageDir* *ls_a_dR* Setting Explanation Default Value~ g:Tex_ViewerCwindowHeight The height of the cwindow which 5 *************** *** 2623,2627 **** out who has done what. ! *latex-suite-maintainer* *ls_a_dR* The current maintainer(s) of latex-suite is(are) --- 2642,2646 ---- out who has done what. ! *latex-suite-maintainer* *ls_a_dS* The current maintainer(s) of latex-suite is(are) |