[Vim-latex-cvs] vimfiles/doc latex-suite.txt,1.20,1.21

[<mi...@us...>]

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

Modified Files:
	latex-suite.txt 
Log Message:
Added reference to modes in doc, one mispell.


Index: latex-suite.txt
===================================================================
RCS file: /cvsroot/vim-latex/vimfiles/doc/latex-suite.txt,v
retrieving revision 1.20
retrieving revision 1.21
diff -C2 -d -r1.20 -r1.21
*** latex-suite.txt	23 Apr 2003 17:28:27 -0000	1.20
--- latex-suite.txt	19 May 2003 14:51:16 -0000	1.21
***************
*** 140,145 ****
  LATEX MACROS                                   *latex-macros* {{{
  
! Latex-Suite ships with a very comprehensive set of insert mode and visual mode
! mappings and menu items to typeset most of the LaTeX elements.
  
                                                *placeholders* *placeholder*
--- 140,145 ----
  LATEX MACROS                                   *latex-macros* {{{
  
! Latex-Suite ships with a very comprehensive set of insert mode and
! |visual-mode| mappings and menu items to typeset most of the LaTeX elements.
  
                                                *placeholders* *placeholder*
***************
*** 148,153 ****
  Kontra's JumpFunc() for handling place-holders. This consists of using
  "place-holders" to mark off locations where the next relevant editing has to
! be done. As an example, when the user types in "EFI" in insert mode, she will
! get the following: >
  
      \begin{figure}[h]
--- 148,153 ----
  Kontra's JumpFunc() for handling place-holders. This consists of using
  "place-holders" to mark off locations where the next relevant editing has to
! be done. As an example, when the user types in "EFI" in |insert-mode|, she
! will get the following: >
  
      \begin{figure}[h]
***************
*** 221,224 ****
--- 221,231 ----
              equation (_eq_uation)          ---> EEQ
  
+ <      Unfortunately there are some environments that cannot be split in two
+        words and first two letters in name are identical. In this case
+        shortcut is created from E, first and last letter.
+        Example: >
+             quote     (_q_uot_e_)          ---> EQE
+             quotation (_q_uotatio_n_)      ---> EQN
+ 
  <      Of course, not every last one of the environments can follow this rule
         because of ambiguities. In case of doubt, pull down the
***************
*** 231,235 ****
      ECE           --> ,ce
  and so on. i.e, the leading E becomes ',' and the next 2 letters are small
! case. Some of the visual mode mappings are sensetive to whether you choose
  line-wise or character wise. For example, if you choose a word and press
  ,ce, then you get \centerline{word}, whereas if you press ,ce on a line-wise
--- 238,242 ----
      ECE           --> ,ce
  and so on. i.e, the leading E becomes ',' and the next 2 letters are small
! case. Some of the visual mode mappings are sensitive to whether you choose
  line-wise or character wise. For example, if you choose a word and press
  ,ce, then you get \centerline{word}, whereas if you press ,ce on a line-wise
***************
*** 341,345 ****
  }}}
  ---------------------------------------------------------------------------
! Diacritics: (by Lubomir Host) {{{
  
  Diacritics speed up typing European languages.
--- 348,352 ----
  }}}
  ---------------------------------------------------------------------------
! Diacritics: (by Lubomir Host - currently disabled by default in texrc) {{{
  
  Diacritics speed up typing European languages.
***************
*** 550,557 ****
  |:TexTemplate|. The argument should be name of the corresponding template
  file.  If the command is called without arguments (preferred usage), then a
! list of avaiable templates is displayed and the user is asked to choose one of
  them.
  
! You can ofcourse place your own templates in this directory.
  
  }}}
--- 557,564 ----
  |:TexTemplate|. The argument should be name of the corresponding template
  file.  If the command is called without arguments (preferred usage), then a
! list of available templates is displayed and the user is asked to choose one of
  them.
  
! You can of course place your own templates in this directory.
  
  }}}
***************
*** 559,586 ****
  LATEX PROJECT                               *latex-project* {{{
  
! LaTeX-suite is quite smart with looking for components of LaTeX document. In 
! simple projects which can be put in one, two or three directories LaTeX-suite 
! can find bibliography, included or image files. But it is impossible to guess 
! all combinations, especially in projects dispersed in many directories, in 
  deep levels. For such situations you can create projects.
  
  Creating project
  
! To create project file make sure you don't have *.latexmain file 
! (|latex-master-file|). Open file which is the skelet of your whole work. Use 
! |:TProjectEdit| command. It will create file "yourmainfile.tex.latexmain" and 
! read in template of project file. This is just Vim file. Now you have two 
! commented variables: g:projName and g:projFiles. First isn't obligatory. It 
! will be visible in Explorer window to show you are editing project. This is 
! list of files separated with commas. File/dir name cannot contain 
! spaces. Example: 
! >
      let g:projFiles="main.tex,roz1/roz1.tex,roz1/roz1.bib,main.bib,newfile.tex"
  
  Editing project file
  
! After |:TProjectEdit| screen will be split and you can make corrections, 
! comments or new files to project. To make changes available to Vim issue
! command |:TProjectWrite|. This will save file and source it immediately.
  
  }}}
--- 566,594 ----
  LATEX PROJECT                               *latex-project* {{{
  
! LaTeX-suite is quite smart with looking for components of LaTeX document. In
! simple projects which can be put in one, two or three directories LaTeX-suite
! can find bibliography, included or image files. But it is impossible to guess
! all combinations, especially in projects dispersed in many directories, in
  deep levels. For such situations you can create projects.
  
  Creating project
  
! To create project file make sure you don't have *.latexmain file
! (|latex-master-file|). Open file which is the skelet of your whole work. Use
! |:TProjectEdit| command. It will create file "yourmainfile.tex.latexmain" and
! read in template of project file. This is just Vim file. Now you have two
! commented variables: g:projName and g:projFiles. First isn't obligatory. It
! will be visible in Explorer window to show you are editing project. This is
! list of files separated with commas. File/dir name cannot contain
! spaces. Example: >
! 
      let g:projFiles="main.tex,roz1/roz1.tex,roz1/roz1.bib,main.bib,newfile.tex"
  
  Editing project file
  
! After |:TProjectEdit| screen will be split and you can make corrections,
! comments or add new files to project (or remove them). To make changes
! available to Vim issue command |:TProjectWrite|. This will save file and
! source it immediately (simple ":write" don't change values of variables).
  
  }}}
***************
*** 600,604 ****
  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 |TexMacro| 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
--- 608,612 ----
  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
***************
*** 1046,1050 ****
  taking care about Macros, Templates and Packages.
  
! :TMacro [{macro}]                      *TMacro*
                  When used without any arguments lists all available macros
                  defined in latex-suite/macros/ directory and prompts you to
--- 1054,1058 ----
  taking care about Macros, Templates and Packages.
  
! :TMacro [{macro}]                      *:TMacro*
                  When used without any arguments lists all available macros
                  defined in latex-suite/macros/ directory and prompts you to
***************
*** 1053,1057 ****
                  With more than one argument it will not work :)
  
! :TMacroEdit [{macro}]                  *TMacroEdit*
                  Splits window for editing {macro}.
                  When used without any arguments lists all available macros
--- 1061,1065 ----
                  With more than one argument it will not work :)
  
! :TMacroEdit [{macro}]                  *:TMacroEdit*
                  Splits window for editing {macro}.
                  When used without any arguments lists all available macros
***************
*** 1059,1067 ****
                  choose one of them.
  
! :TMacroNew                             *TMacroNew*
                  Splits window to write new macro. Directory in new buffer is
                  locally changed to latex-suite/macros/.
  
! :TMacroDelete [{macro}]                *TMacroDelete*
                  Delets {macro} from latex-suite/macros/ directory.
                  When used without any arguments lists all available macros
--- 1067,1075 ----
                  choose one of them.
  
! :TMacroNew                             *:TMacroNew*
                  Splits window to write new macro. Directory in new buffer is
                  locally changed to latex-suite/macros/.
  
! :TMacroDelete [{macro}]                *:TMacroDelete*
                  Delets {macro} from latex-suite/macros/ directory.
                  When used without any arguments lists all available macros
***************
*** 1069,1073 ****
                  choose one of them.
  
! :TPackage [{package} [{package} ...]]  *TPackage*
                  When used without any arguments lists name of the packages for
                  which support is available. Report depends if you are using
--- 1077,1081 ----
                  choose one of them.
  
! :TPackage [{package} [{package} ...]]  *:TPackage*
                  When used without any arguments lists name of the packages for
                  which support is available. Report depends if you are using
***************
*** 1083,1091 ****
                  with spaces is limited only with common sense.
  
! :TPackageUpdate                        *TPackageUpdate*
                  This command `reads' name of package under cursor and turns on
                  possible support.
  
! :TPackageUpdateAll                     *TPackageUpdateAll*
                  After issuing this command latexSuite scans the file in
                  looking for not declared packages, removing not needed entries
--- 1091,1099 ----
                  with spaces is limited only with common sense.
  
! :TPackageUpdate                        *:TPackageUpdate*
                  This command `reads' name of package under cursor and turns on
                  possible support.
  
! :TPackageUpdateAll                     *:TPackageUpdateAll*
                  After issuing this command latexSuite scans the file in
                  looking for not declared packages, removing not needed entries
***************
*** 1093,1097 ****
                  dictionaries.
  
! :TTemplate [{template}]                *TTemplate*
                  When used without any arguments lists all available templates
                  from latex-suite/templates/ directory and prompts to choose
--- 1101,1105 ----
                  dictionaries.
  
! :TTemplate [{template}]                *:TTemplate*
                  When used without any arguments lists all available templates
                  from latex-suite/templates/ directory and prompts to choose
***************
*** 1100,1104 ****
                  With more than one argument it will not work :)
  
! :TSection [{argument}]                 *TSection*
                  Used without any arguments inserts last section type
                  (|latex-sectioning|).
--- 1108,1112 ----
                  With more than one argument it will not work :)
  
! :TSection [{argument}]                 *:TSection*
                  Used without any arguments inserts last section type
                  (|latex-sectioning|).
***************
*** 1139,1143 ****
                          :TSection part
  <
! :TSectionAdvanced                      *TSectionAdvanced*
                  Accepts the same arguments as |TSection| but leads to a couple
                  of questions (whether you want to include the section in the
--- 1147,1151 ----
                          :TSection part
  <
! :TSectionAdvanced                      *:TSectionAdvanced*
                  Accepts the same arguments as |TSection| but leads to a couple
                  of questions (whether you want to include the section in the
***************
*** 1146,1150 ****
                  template.
  
! :TLook                                 *TLook*
                  Accepts one argument. Will look through .tex files in
                  directory of edited file for argument. It can be regexp. You
--- 1154,1158 ----
                  template.
  
! :TLook                                 *:TLook*
                  Accepts one argument. Will look through .tex files in
                  directory of edited file for argument. It can be regexp. You
***************
*** 1154,1158 ****
                  regular expressions can be different from those of Vim.
  
! :TLookBib                              *TLookBib*
                  Accepts one argument. Will look through .bib files in
                  directory of edited file for argument. It can be regexp. You
--- 1162,1166 ----
                  regular expressions can be different from those of Vim.
  
! :TLookBib                              *:TLookBib*
                  Accepts one argument. Will look through .bib files in
                  directory of edited file for argument. It can be regexp. You
***************
*** 1162,1166 ****
                  regular expressions can be different from those of Vim.
  
! :TLookAll                              *TLookAll*
                  Accepts one argument. Will look through all files in directory
                  of edited file for argument. It can be regexp. You don't have
--- 1170,1174 ----
                  regular expressions can be different from those of Vim.
  
! :TLookAll                              *:TLookAll*
                  Accepts one argument. Will look through all files in directory
                  of edited file for argument. It can be regexp. You don't have
***************
*** 1170,1179 ****
                  regular expressions can be different from those of Vim.
  
! :TPartComp                             *TPartComp*
                  No argument allowed but accepts range in all formats. Define
                  fragment of interest with :'a,'b, :/a/,/b/, :'<,'> or :20,30.
                  All other rules of compilation apply.
  
! :TPartView                             *TPartView*
                  Show last compiled fragment. All rules of viewing apply but
                  |latex-searching|.
--- 1178,1187 ----
                  regular expressions can be different from those of Vim.
  
! :TPartComp                             *:TPartComp*
                  No argument allowed but accepts range in all formats. Define
                  fragment of interest with :'a,'b, :/a/,/b/, :'<,'> or :20,30.
                  All other rules of compilation apply.
  
! :TPartView                             *:TPartView*
                  Show last compiled fragment. All rules of viewing apply but
                  |latex-searching|.