|
From: <mi...@us...> - 2003-10-03 07:43:21
|
Update of /cvsroot/vim-latex/vimfiles/doc
In directory sc8-pr-cvs1:/tmp/cvs-serv9774
Modified Files:
latex-suite.txt latex-suite.xml
Log Message:
update docs
Index: latex-suite.txt
===================================================================
RCS file: /cvsroot/vim-latex/vimfiles/doc/latex-suite.txt,v
retrieving revision 1.43
retrieving revision 1.44
diff -C2 -d -r1.43 -r1.44
*** latex-suite.txt 13 Sep 2003 07:54:17 -0000 1.43
--- latex-suite.txt 3 Oct 2003 07:43:14 -0000 1.44
***************
*** 141,148 ****
provides a way to insert custom templates at the beginning of the current file.
! When latex-suite first starts up, it scans the
! $VIM/ftplugin/latex-suite/templates/ directory and creates menu items based on
! the files found there. When you select a template from this menu, the file will
! be read in above the first line of the current file.
A template file can utlilize placeholders for initializing the cursor position
--- 141,149 ----
provides a way to insert custom templates at the beginning of the current file.
! When latex-suite first starts up, it scans
! ftplugin/latex-suite/templates/ directories in 'runtimepath' and creates
! menu items based on the files found there. When you select a template
! from this menu, the file will be read in above the first line of the
! current file.
A template file can utlilize placeholders for initializing the cursor position
***************
*** 151,158 ****
by using vim expressions.
! You can place your own templates in the $VIM/ftplugin/latex-suite/templates/
! directory in order for them to be available via the menu. Unless Latex-Suite
releases a template with the same name, these files should not get over-written
! when you install a new release over an existing one.
NOTE: Templates are also accessible for non-gui users with the command
--- 152,162 ----
by using vim expressions.
! You can place your own templates in the $HOME/.vim/ftplugin/latex-suite/templates/
! directory in order for them to be available via the menu. Unless LaTeX-Suite
releases a template with the same name, these files should not get over-written
! when you install a new release over an existing one. If name of your
! template is equal to default template from LaTeX-Suite it will
! overshadow default template and from menu (and :TTemplate command) will
! be read local template.
NOTE: Templates are also accessible for non-gui users with the command
***************
*** 165,169 ****
================================================================================
! Latex-Suite Macros *ls_3* *ls_a_be*
*latex-macros*
--- 169,173 ----
================================================================================
! LaTeX-Suite Macros *ls_3* *ls_a_be*
*latex-macros*
***************
*** 746,760 ****
*custom-macros-menu*
! This functionality available via the TeX-Suite.Macros menu, provides a way of
! inserting customized macros into the current file via the menu.
! When latex-suite starts up, it scans the $VIM/ftplugin/latex-suite/macros/
! 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_ef|] if wanted.
When you choose a macro from the menu, the corresponding file is read into the
current buffer after the current cursor position. In non-gui mode, you can use
! the |TMacro| command instead of choosing from the menu. This command takes the
macro file name as an argument. When called without arguments (preferred usage),
then a list of avaiable macro files is displayed and the user is prompted to
--- 750,764 ----
*custom-macros-menu*
! This functionality available via the TeX-Suite > Macros menu, provides
! a way of inserting customized macros into the current file via the menu.
! When LaTeX-Suite starts up, it scans the ftplugin/latex-suite/macros/
! directories in runtimepath and creates a menu from the files found
! there. Each file is considered as a single macro. You can place your own
! macros in local directory, using placeholders [|ls_a_ef|] if wanted.
When you choose a macro from the menu, the corresponding file is read into the
current buffer after the current cursor position. In non-gui mode, you can use
! the |:TMacro| command instead of choosing from the menu. This command takes the
macro file name as an argument. When called without arguments (preferred usage),
then a list of avaiable macro files is displayed and the user is prompted to
***************
*** 766,774 ****
{New} Creates a new (unnamed) buffer in the latex-suite/macros/ directory.
Use the command :TexMacroNew in non-gui mode.
! {Edit} Opens up the corresponding macro file for editing. Use :TexMacroEdit
! in non-gui mode.
{Delete} Deletes the corresponding macro. Use the prefixed numbers for fast
! navigation of menus. Use :TexMacroDelete in non-gui mode.
! {Redraw} Rescans the macros/ directory and refreshes the macros list.
--------------------------------------------------------------------------------
--- 770,783 ----
{New} Creates a new (unnamed) buffer in the latex-suite/macros/ directory.
Use the command :TexMacroNew in non-gui mode.
! {Edit} Opens up the corresponding macro file for editing. Use
! |:TexMacroEdit| in non-gui mode. When you try to edit
! {macro} not from local directory LaTeX-Suite will copy it to
! your local directory with suffix "-local". If local copy
! already exists LaTeX-Suite prompt for overwriting it.
{Delete} Deletes the corresponding macro. Use the prefixed numbers for fast
! navigation of menus. Use |:TexMacroDelete| in non-gui mode.
! When you choose to delete {macro} which is not in your local
! directory LaTeX-Suite will refuse to delete it.
! {Redraw} Rescans the macros/ directories and refreshes the macros list.
--------------------------------------------------------------------------------
***************
*** 1947,1961 ****
When used without any arguments lists all available macros defined in
! latex-suite/macros/ directory and prompts you to choose one of them. With one
! argument |:read| this macro under cursor position. With more than one argument
! it will not work :)
! TMacroEdit [{macro}] *ls_9_2_2* *ls_a_cm*
*TMacroEdit*
! Splits window for editing {macro}. When used without any arguments lists all
! available macros defined in latex-suite/macros/ directory and prompt you to
! choose one of them.
--- 1956,1977 ----
When used without any arguments lists all available macros defined in
! runtime ftplugin/latex-suite/macros/ directories and prompts you to
! choose one of them. With one argument |:read| this macro under cursor
! position. With more than one argument it will not work :)
! In Vim >= 6.2 works completion of names of macros (see 'wildmenu',
! 'wildmode' for more about command-line completion).
! :TMacroEdit [{macro}] *ls_9_2_2* *ls_a_cm*
*TMacroEdit*
! Splits window for editing {macro}. When used without any arguments lists
! all available macros defined in runtime ftplugin/latex-suite/macros/
! directories and prompt you to choose one of them.
! When you try to edit {macro} not from local directory LaTeX-Suite
! will copy it to your local directory with suffix "-local". If local copy
! already exists LaTeX-Suite prompt for overwriting it.
! In Vim >= 6.2 works completion of names of macros (see 'wildmenu',
! 'wildmode' for more about command-line completion).
***************
*** 1970,1976 ****
*TMacroDelete*
! Delets {macro} from latex-suite/macros/ directory. When used without any
! arguments lists all available macros defined in latex-suite/macros/ directory
! and prompt you to choose one of them.
--- 1986,1996 ----
*TMacroDelete*
! Delets {macro} from your local ftplugin/latex-suite/macros/ directory.
! When used without any arguments lists all available macros defined in
! latex-suite/macros/ directory and prompt you to choose one of them.
! When you choose to delete {macro} which is not in your local directory
! LaTeX-Suite will refuse to delete it.
! In Vim >= 6.2 works completion of names of macros (see 'wildmenu',
! 'wildmode' for more about command-line completion)
***************
*** 2016,2019 ****
--- 2036,2041 ----
argument :0|read| {template} file. With more than one argument it will not work
:)
+ In Vim >= 6.2 works completion of names of macros (see 'wildmenu',
+ 'wildmode' for more about command-line completion)
***************
*** 2052,2056 ****
! TSectionAdvanced *ls_9_2_10* *ls_a_cu*
*TSectionAdvanced*
--- 2074,2078 ----
! :TSectionAdvanced *ls_9_2_10* *ls_a_cu*
*TSectionAdvanced*
***************
*** 2061,2065 ****
! TLook *ls_9_2_11* *ls_a_cv* *TLook*
Accepts one argument. Will look through .tex files in directory of edited file
--- 2083,2087 ----
! :TLook *ls_9_2_11* *ls_a_cv* *TLook*
Accepts one argument. Will look through .tex files in directory of edited file
***************
*** 2070,2074 ****
! TLookBib *ls_9_2_12* *ls_a_cw*
*TLookBib*
--- 2092,2096 ----
! :TLookBib *ls_9_2_12* *ls_a_cw*
*TLookBib*
***************
*** 2083,2087 ****
! TLookAll *ls_9_2_13* *ls_a_cx*
*TLookAll*
--- 2105,2109 ----
! :TLookAll *ls_9_2_13* *ls_a_cx*
*TLookAll*
***************
*** 2093,2097 ****
! TPartComp *ls_9_2_14* *ls_a_cy*
*TPartComp*
--- 2115,2119 ----
! :TPartComp *ls_9_2_14* *ls_a_cy*
*TPartComp*
***************
*** 2101,2105 ****
! TPartView *ls_9_2_15* *ls_a_cz*
*TPartView*
--- 2123,2127 ----
! :TPartView *ls_9_2_15* *ls_a_cz*
*TPartView*
***************
*** 2107,2111 ****
! Tshortcuts [{arg}] *ls_9_2_16* *ls_a_cA*
*Tshortcuts*
--- 2129,2133 ----
! :Tshortcuts [{arg}] *ls_9_2_16* *ls_a_cA*
*Tshortcuts*
Index: latex-suite.xml
===================================================================
RCS file: /cvsroot/vim-latex/vimfiles/doc/latex-suite.xml,v
retrieving revision 1.20
retrieving revision 1.21
diff -C2 -d -r1.20 -r1.21
*** latex-suite.xml 13 Sep 2003 07:54:17 -0000 1.20
--- latex-suite.xml 3 Oct 2003 07:43:14 -0000 1.21
***************
*** 866,871 ****
<entry>{Edit}</entry>
<entry>
! Opens up the corresponding macro file for
! editing. Use :TexMacroEdit in non-gui mode.
</entry>
</row>
--- 866,874 ----
<entry>{Edit}</entry>
<entry>
! Opens up the corresponding macro file for editing. Use
! |:TexMacroEdit| in non-gui mode. When you try to edit {macro}
! not from local directory LaTeX-Suite will copy it to your local
! directory with suffix "-local". If local copy already exists
! LaTeX-Suite prompt for overwriting it.
</entry>
</row>
***************
*** 873,879 ****
<entry>{Delete}</entry>
<entry>
! Deletes the corresponding macro. Use the
! prefixed numbers for fast navigation of menus.
! Use :TexMacroDelete in non-gui mode.
</entry>
</row>
--- 876,883 ----
<entry>{Delete}</entry>
<entry>
! Deletes the corresponding macro. Use the prefixed numbers for
! fast navigation of menus. Use |:TexMacroDelete| in non-gui mode.
! When you choose to delete {macro} which is not in your local
! directory LaTeX-Suite will refuse to delete it.
</entry>
</row>
***************
*** 881,886 ****
<entry>{Redraw}</entry>
<entry>
! Rescans the macros/ directory and refreshes the
! macros list.
</entry>
</row>
--- 885,889 ----
<entry>{Redraw}</entry>
<entry>
! Rescans the macros/ directories and refreshes the macros list.
</entry>
</row>
***************
*** 2444,2460 ****
<title>:TMacro [{macro}]</title>
<para>
! When used without any arguments lists all available macros defined
! in latex-suite/macros/ directory and prompts you to choose one of
! them. With one argument |:read| this macro under cursor position.
! With more than one argument it will not work :)
</para>
</section>
<section id="TMacroEdit">
! <title>TMacroEdit [{macro}]</title>
<para>
! Splits window for editing {macro}.
! When used without any arguments lists all available macros
! defined in latex-suite/macros/ directory and prompt you to
! choose one of them.
</para>
</section>
--- 2447,2469 ----
<title>:TMacro [{macro}]</title>
<para>
! When used without any arguments lists all available macros defined
! in runtime ftplugin/latex-suite/macros/ directories and prompts you
! to choose one of them. With one argument |:read| this macro under
! cursor position. With more than one argument it will not work :) In
! Vim >= 6.2 works completion of names of macros (see 'wildmenu',
! 'wildmode' for more about command-line completion).
</para>
</section>
<section id="TMacroEdit">
! <title>:TMacroEdit [{macro}]</title>
<para>
! Splits window for editing {macro}. When used without any arguments
! lists all available macros defined in runtime
! ftplugin/latex-suite/macros/ directories and prompt you to choose
! one of them. When you try to edit {macro} not from local directory
! LaTeX-Suite will copy it to your local directory with suffix
! "-local". If local copy already exists LaTeX-Suite prompt for
! overwriting it. In Vim >= 6.2 works completion of names of macros
! (see 'wildmenu', 'wildmode' for more about command-line completion).
</para>
</section>
***************
*** 2469,2476 ****
<title>:TMacroDelete [{macro}]</title>
<para>
! Delets {macro} from latex-suite/macros/ directory.
! When used without any arguments lists all available macros
! defined in latex-suite/macros/ directory and prompt you to
! choose one of them.
</para>
</section>
--- 2478,2488 ----
<title>:TMacroDelete [{macro}]</title>
<para>
! Delets {macro} from your local ftplugin/latex-suite/macros/
! directory. When used without any arguments lists all available
! macros defined in latex-suite/macros/ directory and prompt you to
! choose one of them. When you choose to delete {macro} which is not
! in your local directory LaTeX-Suite will refuse to delete it. In
! Vim >= 6.2 works completion of names of macros (see 'wildmenu',
! 'wildmode' for more about command-line completion)
</para>
</section>
***************
*** 2523,2526 ****
--- 2535,2540 ----
With one argument :0|read| {template} file.
With more than one argument it will not work :)
+ In Vim >= 6.2 works completion of names of macros (see 'wildmenu',
+ 'wildmode' for more about command-line completion)
</para>
</section>
***************
*** 2611,2615 ****
</section>
<section id="TSectionAdvanced">
! <title>TSectionAdvanced</title>
<para>
Accepts the same arguments as |TSection| but leads to a couple
--- 2625,2629 ----
</section>
<section id="TSectionAdvanced">
! <title>:TSectionAdvanced</title>
<para>
Accepts the same arguments as |TSection| but leads to a couple
***************
*** 2621,2625 ****
</section>
<section id="TLook">
! <title>TLook</title>
<para>
Accepts one argument. Will look through .tex files in
--- 2635,2639 ----
</section>
<section id="TLook">
! <title>:TLook</title>
<para>
Accepts one argument. Will look through .tex files in
***************
*** 2632,2636 ****
</section>
<section id="TLookBib">
! <title>TLookBib</title>
<para>
Accepts one argument. Will look through .bib files in
--- 2646,2650 ----
</section>
<section id="TLookBib">
! <title>:TLookBib</title>
<para>
Accepts one argument. Will look through .bib files in
***************
*** 2647,2651 ****
</section>
<section id="TLookAll">
! <title>TLookAll</title>
<para>
Accepts one argument. Will look through all files in directory
--- 2661,2665 ----
</section>
<section id="TLookAll">
! <title>:TLookAll</title>
<para>
Accepts one argument. Will look through all files in directory
***************
*** 2653,2662 ****
to enclose argument in "". <cr> takes you to location. Other
keys work as described in |latex-viewer|.
! Note: TLookuses :grep command and is using 'grepprg'. Its
regular expressions can be different from those of Vim.
</para>
</section>
<section id="TPartComp">
! <title>TPartComp</title>
<para>
No argument allowed but accepts range in all formats. Define
--- 2667,2676 ----
to enclose argument in "". <cr> takes you to location. Other
keys work as described in |latex-viewer|.
! Note: TLook uses :grep command and is using 'grepprg'. Its
regular expressions can be different from those of Vim.
</para>
</section>
<section id="TPartComp">
! <title>:TPartComp</title>
<para>
No argument allowed but accepts range in all formats. Define
***************
*** 2666,2670 ****
</section>
<section id="TPartView">
! <title>TPartView</title>
<para>
Show last compiled fragment. All rules of viewing apply but
--- 2680,2684 ----
</section>
<section id="TPartView">
! <title>:TPartView</title>
<para>
Show last compiled fragment. All rules of viewing apply but
***************
*** 2673,2677 ****
</section>
<section id="Tshortcuts">
! <title>Tshortcuts [{arg}]</title>
<para>
Show shortcuts in terminal (not using menu). Without {arg}
--- 2687,2691 ----
</section>
<section id="Tshortcuts">
! <title>:Tshortcuts [{arg}]</title>
<para>
Show shortcuts in terminal (not using menu). Without {arg}
|
