vim-latex-cvs

[<sri...@us...>]

Update of /cvsroot/vim-latex/vimfiles/doc
In directory sc8-pr-cvs1:/tmp/cvs-serv984

Modified Files:
	latex-suite.xml latex-suite.txt 
Log Message:
Description of Tex_Com_name


Index: latex-suite.xml
===================================================================
RCS file: /cvsroot/vim-latex/vimfiles/doc/latex-suite.xml,v
retrieving revision 1.19
retrieving revision 1.20
diff -C2 -d -r1.19 -r1.20
*** latex-suite.xml	12 Sep 2003 10:25:20 -0000	1.19
--- latex-suite.xml	13 Sep 2003 07:54:17 -0000	1.20
***************
*** 389,396 ****
      &ls; provides two simple mappings <literal>&lt;F7&gt;</literal> and
      <literal>&lt;S-F7&gt;</literal> which work in both insert and normal
!     mode in an idential manner. Pressing <literal>&lt;F7&gt;</literal>
!     prompts you with a list of commands to choose from and then inserts it
!     into the text of the document. The list of commands is constructed from
!     the <link
       linkend="Tex_PromptedCommands"><literal>g:Tex_PromptedCommands</literal></link>
      setting and also from commands which &ls; finds while scanning custom
--- 389,398 ----
      &ls; provides two simple mappings <literal>&lt;F7&gt;</literal> and
      <literal>&lt;S-F7&gt;</literal> which work in both insert and normal
!     mode in an idential manner. In insert mode, if the cursor is located on
!     (or just after) a non-whitespace character, then a command from the
!     last word (<literal>&lt;cword&gt;</literal>) is created. If the cursor
!     is located on a white-space character, then you will be prompted with a
!     list of commands to choose from. The list of commands is constructed
!     from the <link
       linkend="Tex_PromptedCommands"><literal>g:Tex_PromptedCommands</literal></link>
      setting and also from commands which &ls; finds while scanning custom
***************
*** 400,403 ****
--- 402,414 ----
     </para>
     <para>
+     For certain common commands, &ls; will expand them to include
+     additional arguments as needed. Otherwise, it will simply change the
+     word under the cursor as follows
+     <programlisting>word --> \word{&ph;}&ph;</programlisting>
+     You can define custom expansios of commands using the
+     <literal>Tex_Com_{name}</literal> setting as described in <link
+      linkend="Tex_Com_name">here</link>.
+    </para>
+    <para>
      In both insert and normal mode <literal>&lt;S-F7&gt;</literal> will
      find out if you are presently within an environment and then prompt you
***************
*** 589,598 ****
      the following template will be inserted:
      <programlisting>@BOOK{&lt;+key+&gt;,
! author = {&ph;},
! editor = {&ph;},
! title = {&ph;},
! publisher = {&ph;},
! year = {&ph;},
! otherinfo = {&ph;}
  }&ph;</programlisting>
     </para>
--- 600,609 ----
      the following template will be inserted:
      <programlisting>@BOOK{&lt;+key+&gt;,
!     author = {&ph;},
!     editor = {&ph;},
!     title = {&ph;},
!     publisher = {&ph;},
!     year = {&ph;},
!     otherinfo = {&ph;}
  }&ph;</programlisting>
     </para>
***************
*** 670,678 ****
       <literal>BBB</literal> inserts the following template by default
       <programlisting>@ARTICLE{&lt;+key+&gt;,
! author = {&ph;},
! title = {&ph;},
! journal = {&ph;},
! year = {&ph;},
! otherinfo = {&ph;}
  }&ph;</programlisting>
       However, if <literal>g:Bib_article_options</literal> is defined as
--- 681,689 ----
       <literal>BBB</literal> inserts the following template by default
       <programlisting>@ARTICLE{&lt;+key+&gt;,
!     author = {&ph;},
!     title = {&ph;},
!     journal = {&ph;},
!     year = {&ph;},
!     otherinfo = {&ph;}
  }&ph;</programlisting>
       However, if <literal>g:Bib_article_options</literal> is defined as
***************
*** 680,691 ****
       insert the following template
       <programlisting>@ARTICLE{&lt;+key+&gt;,
! author = {&ph;},
! title = {&ph;},
! journal = {&ph;},
! year = {&ph;},
! month = {&ph;},
! number = {&ph;},
! pages = {&ph;},
! otherinfo = {&ph;}
  }&ph;</programlisting>
      </para>
--- 691,702 ----
       insert the following template
       <programlisting>@ARTICLE{&lt;+key+&gt;,
!     author = {&ph;},
!     title = {&ph;},
!     journal = {&ph;},
!     year = {&ph;},
!     month = {&ph;},
!     number = {&ph;},
!     pages = {&ph;},
!     otherinfo = {&ph;}
  }&ph;</programlisting>
      </para>
***************
*** 3086,3093 ****
        </para>
       <para>
!       Notice how special characters such as carriage return are specified
!       using the <literal>"\&lt;key&gt;"</literal> notation. Also use double
!       quotes if you wish to enter such special keys. Also backslashes have
!       to be doubled.
       </para>
       <para>
--- 3097,3103 ----
        </para>
       <para>
!       If the expaniosn uses special keys such as carriage return etc, then
!       use double-quotes and use the <literal>"\&lt;key&gt;"</literal>
!       notation for special keys. Backslashes have to be doubled.
       </para>
       <para>
***************
*** 3109,3112 ****
--- 3119,3141 ----
  \end{eqnarray*}&ph;</programlisting>
       </para>
+    </section>
+    <section id="Tex_Com_name">
+     <title>Tex_Com_name</title>
+     <para>
+      If you wish to define new expansions for fast command insertion as
+      described <link linkend="latex-command-maps">here</link>, or redefine
+      expansios from the default values in &ls;, you will need to define
+      variables of the form <literal>g:Tex_Com_{name}</literal> where
+      <literal>name</literal> is a command name. For example, with the
+      setting
+      <programlisting>let g:Tex_Com_frac = "\\frac{&ph;}{&ph;}&ph;"</programlisting>
+      pressing <literal>&lt;F7&gt;</literal> after typing
+      <literal>frac</literal> will change it to <literal>\frac{&ph;}{&ph;}&ph;</literal>
+     </para>
+     <para>
+      See <link linkend="Tex_Env_name">Tex_Env_name</link> for additional
+      details on how to create this setting in various special
+      circumstances.
+     </para>
     </section>
    </section>

Index: latex-suite.txt
===================================================================
RCS file: /cvsroot/vim-latex/vimfiles/doc/latex-suite.txt,v
retrieving revision 1.42
retrieving revision 1.43
diff -C2 -d -r1.42 -r1.43
*** latex-suite.txt	12 Sep 2003 10:25:20 -0000	1.42
--- latex-suite.txt	13 Sep 2003 07:54:17 -0000	1.43
***************
*** 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_dy|] 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_dz|] for a list of people who
  have helped.
[...1054 lines suppressed...]
  
--- 2847,2851 ----
  
  ================================================================================
! Credits                                                        *ls_11* *ls_a_dz*
                                                             *latex-suite-credits*
  
***************
*** 2859,2863 ****
  out who has done what.
  
!                                               *latex-suite-maintainer* *ls_a_ed*
  The current maintainer(s) of latex-suite is(are)
  
--- 2882,2886 ----
  out who has done what.
  
!                                               *latex-suite-maintainer* *ls_a_ee*
  The current maintainer(s) of latex-suite is(are)