Update of /cvsroot/vim-latex/vimfiles/doc
In directory sc8-pr-cvs1:/tmp/cvs-serv25637
Modified Files:
latex-suite.xml latex-suite.txt
Log Message:
- added the bit about how to over-ride macros set by latex-suite.
- the latest version of db2vim also folds up subsections within sections.
Index: latex-suite.xml
===================================================================
RCS file: /cvsroot/vim-latex/vimfiles/doc/latex-suite.xml,v
retrieving revision 1.11
retrieving revision 1.12
diff -C2 -d -r1.11 -r1.12
*** latex-suite.xml 27 Jul 2003 00:46:53 -0000 1.11
--- latex-suite.xml 22 Aug 2003 22:09:58 -0000 1.12
***************
*** 179,182 ****
--- 179,215 ----
</para>
</note>
+ <note id="overriding-macros">
+ <title>Over-riding &ls; Macros</title>
+ <para>
+ If you wish to change these macros from their default values, for
+ example, if you wish to change <literal>`w</literal> to expand to
+ <literal>\omega</literal> instead of its default expansion to
+ <literal>\wedge</literal>, you should use the <literal>IMAP</literal>
+ function as described in the <link linkend="ls-new-macros">Using
+ IMAP()</link> section.
+ </para>
+ <para>
+ An important thing to note is that if you wish to over-ride macros
+ created by &ls; rather than merely create new macros, you should place
+ the <literal>IMAP()</literal> calls in a script which gets sourced
+ after the files in &ls;. A good place typically is as a file-type
+ plugin file in the
+ <literal>~/.vim/after/ftplugin/</literal> directory. (Use
+ <literal>~/vimfiles</literal> if you are using
+ <literal>WINDOWS</literal>). For example to over-ride
+ <literal>`w</literal> to <literal>\omega</literal> instead of
+ <literal>\wedge</literal>, place the following line in (say)
+ <literal>~/.vim/after/ftplugin/tex_macros.vim</literal>:
+ <programlisting>call IMAP('`w', '\omega', 'tex')</programlisting>
+ </para>
+ <note>
+ <para>
+ It is important to use a file-name which will get sourced on a
+ <literal>FileType</literal> event. Therefore you must use a file-name
+ which conforms to the standards as described in
+ <literal>|ftplugin-name|</literal>.
+ </para>
+ </note>
+ </note>
<para>
The following sections describe the various editing macros provided
***************
*** 1716,1722 ****
<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>
--- 1749,1755 ----
<literal>.latexmain</literal> file can also be present in a directory
directly above the directory containing the present file. &ls; will
! scan upwards recursively 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>
Index: latex-suite.txt
===================================================================
RCS file: /cvsroot/vim-latex/vimfiles/doc/latex-suite.txt,v
retrieving revision 1.34
retrieving revision 1.35
diff -C2 -d -r1.34 -r1.35
*** latex-suite.txt 27 Jul 2003 00:46:53 -0000 1.34
--- latex-suite.txt 22 Aug 2003 22:09:58 -0000 1.35
***************
*** 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_do|] for a list of people who
[...2571 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*\\*.*',"",""),'^--','\ \ \ \ \ \ ','')
+ ================================================================================
|
