Update of /cvsroot/vim-latex/vimfiles/doc
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv20134
Modified Files:
latex-suite.xml latex-suite.txt
Log Message:
New: Description of the <M-i> mapping to insert \item commands.
Index: latex-suite.xml
===================================================================
RCS file: /cvsroot/vim-latex/vimfiles/doc/latex-suite.xml,v
retrieving revision 1.31
retrieving revision 1.32
diff -C2 -d -r1.31 -r1.32
*** latex-suite.xml 6 Dec 2003 02:45:57 -0000 1.31
--- latex-suite.xml 9 May 2004 22:11:48 -0000 1.32
***************
*** 838,843 ****
<para>
This mapping inserts an <literal>\item</literal> command at the
! current cursor location. Depending on the context, it might instead
! insert <literal>\item[]</literal>, <literal>\item[]{}</literal> etc.
</para>
</section>
--- 838,886 ----
<para>
This mapping inserts an <literal>\item</literal> command at the
! current cursor location depending on which environment the cursor is
! enclosed in. The style of the <literal>\item</literal> command is
! dependent on the enclosing environment. By default,
! <literal><Alt-I></literal> has styles defined forthe following
! environments:
! </para>
! <informaltable frame="all">
! <tgroup cols="2">
! <thead>
! <row>
! <entry>Environment</entry>
! <entry>Style</entry>
! </row>
! </thead>
! <tbody>
! <row><entry>itemize</entry><entry>\item </entry></row>
! <row><entry>enumerate</entry><entry>\item </entry></row>
! <row><entry>theindex</entry><entry>\item </entry></row>
! <row><entry>thebibliography</entry><entry>\item[<+biblabel+>]{<+bibkey+>} <++></entry></row>
! <row><entry>description</entry><entry>\item[<+label+>] <++></entry></row>
! </tbody>
! </tgroup>
! </informaltable>
! <para>
! <literal><Alt-I></literal> is intelligent enough to
! account for nested environments. For example,
! <programlisting>\begin{itemize}
! \item first item
! \item second item
! \begin{description}
! \item[label1] first desc
! \item[label2] second
! % <Alt-I> will insert "\item[<+label+>] <++>" if
! % used here
! \end{description}
! \item third item
! % <Alt-I> will insert "\item " when if used here.
! \end{itemize}
! % <Alt-I> will insert nothing ("") if used here</programlisting>
! </para>
! <para>
! The style used by <literal><Alt-I></literal> can be customized
! using the <link
! linkend="Tex_ItemStyle_environment"><literal>g:Tex_ItemStyle_environment</literal></link>
! variable.
</para>
</section>
***************
*** 1049,1069 ****
" Description:
function! AskVimFunc()
! let name = input('Name of the function : ')
! if name == ''
! let name = "<+Function Name+>"
! end
! let islocal = input('Is this function scriptlocal ? [y]/n : ', 'y')
! if islocal == 'y'
! let sidstr = '<SID>'
! else
! let sidstr = ''
! endif
! return IMAP_PutTextWithMovement(
! \ "\" ".name.": <+short description+> \<cr>" .
! \ "Description: <+long description+>\<cr>" .
! \ "\<C-u>function! ".name."(<+arguments+>)&ph;\<cr>" .
! \ "<+function body+>\<cr>" .
! \ "endfunction \" "
! \ )
endfunction</programlisting>
<para>
--- 1092,1112 ----
" Description:
function! AskVimFunc()
! let name = input('Name of the function : ')
! if name == ''
! let name = "<+Function Name+>"
! end
! let islocal = input('Is this function scriptlocal ? [y]/n : ', 'y')
! if islocal == 'y'
! let sidstr = '<SID>'
! else
! let sidstr = ''
! endif
! return IMAP_PutTextWithMovement(
! \ "\" ".name.": <+short description+> \<cr>" .
! \ "Description: <+long description+>\<cr>" .
! \ "\<C-u>function! ".name."(<+arguments+>)&ph;\<cr>" .
! \ "<+function body+>\<cr>" .
! \ "endfunction \" "
! \ )
endfunction</programlisting>
<para>
***************
*** 3378,3382 ****
<literal>eqnarray*</literal> expand to
<programlisting>\begin{eqnarray*}
! &ph; &=& &ph;
\end{eqnarray*}&ph;</programlisting>
</para>
--- 3421,3425 ----
<literal>eqnarray*</literal> expand to
<programlisting>\begin{eqnarray*}
! &ph; &=& &ph;
\end{eqnarray*}&ph;</programlisting>
</para>
***************
*** 3401,3404 ****
--- 3444,3483 ----
</para>
</section>
+ <section id="Tex_ItemStyle_environment">
+ <title>Tex_ItemStyle_environment</title>
+ <para>
+ This setting affects the style which &ls; uses to insert an
+ <literal>\item</literal> when <literal><Alt-I></literal> is
+ pressed as described <link linkend="Alt-I">here</link>. By default
+ &ls; defines styles for the following environments:
+ </para>
+ <informaltable frame="all">
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>Environment</entry>
+ <entry>Style</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row><entry>itemize</entry><entry>\item </entry></row>
+ <row><entry>enumerate</entry><entry>\item </entry></row>
+ <row><entry>theindex</entry><entry>\item </entry></row>
+ <row><entry>thebibliography</entry><entry>\item[<+biblabel+>]{<+bibkey+>} <++></entry></row>
+ <row><entry>description</entry><entry>\item[<+label+>] <++></entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ <para>
+ Each style is defined by a variable of the form
+ <literal>g:Tex_ItemStyle_{envname}</literal> where
+ <literal>envname</literal> is the name of the environment for which
+ the style is defined. For example, by default
+ <programlisting>g:Tex_ItemStyle_description = '\item[<+label+>] <++>'</programlisting>
+ Redefining the style for a particular environment or defining a style
+ for an entirely new environment is simply a matter of setting the
+ value of a variable of the corresponding name.
+ </para>
+ </section>
</section>
<section id="customizing-smart-keys">
Index: latex-suite.txt
===================================================================
RCS file: /cvsroot/vim-latex/vimfiles/doc/latex-suite.txt,v
retrieving revision 1.52
retrieving revision 1.53
diff -C2 -d -r1.52 -r1.53
*** latex-suite.txt 14 Dec 2003 07:25:04 -0000 1.52
--- latex-suite.txt 9 May 2004 22:11:49 -0000 1.53
***************
*** 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_dI|] 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_dJ|] for a list of people who
have helped.
[...1120 lines suppressed...]
--- 3089,3093 ----
================================================================================
! Credits *ls_11* *ls_a_dJ*
*latex-suite-credits*
***************
*** 3075,3079 ****
out who has done what.
! *latex-suite-maintainer* *ls_a_ep*
The current maintainer(s) of Latex-Suite is(are)
--- 3126,3130 ----
out who has done what.
! *latex-suite-maintainer* *ls_a_eq*
The current maintainer(s) of Latex-Suite is(are)
|