[Vim-latex-cvs] vimfiles/doc latex-suite.txt,1.13,1.14

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

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

Modified Files:
	latex-suite.txt 
Log Message:
add info abour F1 wrapper, few mispells, misformats and item in toc about texviewer.vim

Index: latex-suite.txt
===================================================================
RCS file: /cvsroot/vim-latex/vimfiles/doc/latex-suite.txt,v
retrieving revision 1.13
retrieving revision 1.14
diff -C2 -d -r1.13 -r1.14
*** latex-suite.txt	1 Apr 2003 16:47:26 -0000	1.13
--- latex-suite.txt	2 Apr 2003 20:59:21 -0000	1.14
***************
*** 24,28 ****
  
  {Vi of course does not have any of this}
! NOTE: If you are viewing this in vim 6.0+, then the sections should appear
        folded (see |folding|). Use |za| to toggle back and forth between open
        and closed views.
--- 24,28 ----
  
  {Vi of course does not have any of this}
! NOTE: If you are viewing this in Vim 6.0+, then the sections should appear
        folded (see |folding|). Use |za| to toggle back and forth between open
        and closed views.
***************
*** 53,57 ****
  <   set iskeyword+=: >
      " IMPORTANT: If you are a win32 user, then the following setting is
!     " necessary in order to have latex called correctly from within vim.
  <   set shellslash 
  
--- 53,57 ----
  <   set iskeyword+=: >
      " IMPORTANT: If you are a win32 user, then the following setting is
!     " necessary in order to have latex called correctly from within Vim.
  <   set shellslash 
  
***************
*** 70,81 ****
      |latex-macros|
          Insert mode and visual mode mappings and menu items for commonly used
!         LaTeX typesetting elements         
  
      |latex-smart-keys|
!         mappings of some common keys like <BS> to make editing faster
  
      |latex-bracketing-macros|
          A streamlined way of entering all the \left's and \right's while
!         typing latex
  
      |latex-templates|
--- 70,84 ----
      |latex-macros|
          Insert mode and visual mode mappings and menu items for commonly used
!         LaTeX typesetting elements.
  
      |latex-smart-keys|
!         Mappings of some common keys like <BS> to make editing faster.
! 
!     |latex-viewer|
!         Fast access to list of labels and bibliography keys.
  
      |latex-bracketing-macros|
          A streamlined way of entering all the \left's and \right's while
!         typing LaTeX.
  
      |latex-templates|
***************
*** 107,113 ****
  =======
      |latex-folding|       
!         manual folding based on LaTeX syntax elements. 
  
! Pacakge Support
  ===============
      |latex-packages|
--- 110,116 ----
  =======
      |latex-folding|       
!         Manual folding based on LaTeX syntax elements.
  
! Package Support
  ===============
      |latex-packages|
***************
*** 118,122 ****
  ===================
      |latex-help|          
!         LaTeX's tex-info file translated into a vim help file.
      
      |latex-dictionary|   
--- 121,125 ----
  ===================
      |latex-help|          
!         LaTeX's tex-info file translated into a Vim help file.
      
      |latex-dictionary|   
***************
*** 152,156 ****
  name, she can press Control-J (while still in insert-mode). This will take her
  directly to the next "place-holder". i.e, the <+caption text+> will be visually
! selected with vim in select mode again for typing in the caption. This saves
  on a lot of key presses.
  
--- 155,159 ----
  name, she can press Control-J (while still in insert-mode). This will take her
  directly to the next "place-holder". i.e, the <+caption text+> will be visually
! selected with Vim in select mode again for typing in the caption. This saves
  on a lot of key presses.
  
***************
*** 399,403 ****
  Smart Space
      Latex-suite maps the <space> key in such a way that $ characters are not
!     broken across lines. It does this by first setting tw=0 so that vim will
      not automatically break lines and then maps the <space> key to insert
      newlines keeping $$'s on the same line.
--- 402,406 ----
  Smart Space
      Latex-suite maps the <space> key in such a way that $ characters are not
!     broken across lines. It does this by first setting tw=0 so that Vim will
      not automatically break lines and then maps the <space> key to insert
      newlines keeping $$'s on the same line.
***************
*** 411,451 ****
  LATEX VIEWER                                *latex-viewer* {{{
  
! Latex suite provides easy way of looking through BibTeX keys and completing 
  them.  The same for completion of \ref-like entries.
  
! After you insert \cite{, you can press <F9> key (still in Insert mode). Two 
! small windows will open.  Just below your main window will be list of 
! bibliography keys completed from all .bib files in directory of .tex file. 
! Name this window as cwindow.  Third window is context window to show next few 
! lines of current entry (usually the most important info like author, title 
  etc.).
  
! In cwindow you can move with j and k keys. Contex window will be automatically 
! updated. If information visible in context window is not enough you can use 
! J and K keys to move content of context window (without leaving cwindow). 
! After you choose correct bibentry press <cr>. Additional windows will close 
! and \cite{ will be completed to \cite{bibentry}. q returns to main window and 
  closes additional windows.
  
! If you remember beginning of desired key enter \cite{be. In cwindow will be 
  shown only bibkeys beginning with "be".
  
! Very similar thing you can do with \ref{, after <F9> in cwindow will be 
  visible all lines containing \label{...}. Also here use of prefix is possible.
  
! This works with all commads with "ref" or "cite" in them. Thus you will get 
! bib completion with \citen, \citenum or \pageref. If you want to create your 
! own command which use cite or ref mechanism make sure proper word is inside 
  it. Example: >
  
          \newcommand{\pref}[1]{~(p.~\pageref{#1})}
  <
! <F9> works also with normal words. You can use it here: "Its name is 
! tetr<F9>". Now Latex-suite will look in all .tex files in directory of edited 
! file word which is beginning with "tetr". Note: <cr> has here different 
! behavior. It does not try to complete word but moves you to location chosen in 
  cwindow.
  
! Viewer module provides also three command-line utilities: |TLook|, |TLookBib| 
  and |TLookAll|.
  
--- 414,454 ----
  LATEX VIEWER                                *latex-viewer* {{{
  
! Latex suite provides easy way of looking through BibTeX keys and completing
  them.  The same for completion of \ref-like entries.
  
! After you insert \cite{, you can press <F9> key (still in Insert mode). Two
! small windows will open.  Just below your main window will be list of
! bibliography keys completed from all .bib files in directory of .tex file.
! Name this window as cwindow.  Third window is context window to show next few
! lines of current entry (usually the most important info like author, title
  etc.).
  
! In cwindow you can move with j and k keys. Contex window will be automatically
! updated. If information visible in context window is not enough you can use
! J and K keys to move content of context window (without leaving cwindow).
! After you choose correct bibentry press <cr>. Additional windows will close
! and \cite{ will be completed to \cite{bibentry}. q returns to main window and
  closes additional windows.
  
! If you remember beginning of desired key enter \cite{be. In cwindow will be
  shown only bibkeys beginning with "be".
  
! Very similar thing you can do with \ref{, after <F9> in cwindow will be
  visible all lines containing \label{...}. Also here use of prefix is possible.
  
! This works with all commads with "ref" or "cite" in them. Thus you will get
! bib completion with \citen, \citenum or \pageref. If you want to create your
! own command which use cite or ref mechanism make sure proper word is inside
  it. Example: >
  
          \newcommand{\pref}[1]{~(p.~\pageref{#1})}
  <
! <F9> works also with normal words. You can use it here: "Its name is
! tetr<F9>". Now Latex-suite will look in all .tex files in directory of edited
! file word which is beginning with "tetr". Note: <cr> has here different
! behavior. It does not try to complete word but moves you to location chosen in
  cwindow.
  
! Viewer module provides also three command-line utilities: |TLook|, |TLookBib|
  and |TLookAll|.
  
***************
*** 591,597 ****
  NOTE: For win32 users user MikTeX, sometimes the latex compiler's output has a
  bug where a single number is split across different lines. In this case, put
! the included vimlatex utility somehwere in your $PATH, make it executable and
! point g:tex_flavor to it. This is not always necessary, and you might want to
! try it without vimlatex till you first notice any problem.
  
                                                          *latex-master-file*
--- 594,600 ----
  NOTE: For win32 users user MikTeX, sometimes the latex compiler's output has a
  bug where a single number is split across different lines. In this case, put
! the included vim-latexSuite somewhere in your $PATH, make it executable and
! point g:tex_flavor to it. This is not always necessary, and you
! might want to try it without vim-latexSuite till you first notice any problem.
  
                                                          *latex-master-file*
***************
*** 760,764 ****
                                                    *latex-package-dictionary*
  Furthermore, if a file with the same name is found in the
! latex-suite/dictionaries/ directory, then that file will be added to vim's
  'dictionary' setting for use with the |i_CTRL-X_CTRL-K| command.  Package
  dictionary file should follow outlines specified in 'dictionary'.
--- 763,767 ----
                                                    *latex-package-dictionary*
  Furthermore, if a file with the same name is found in the
! latex-suite/dictionaries/ directory, then that file will be added to Vim's
  'dictionary' setting for use with the |i_CTRL-X_CTRL-K| command.  Package
  dictionary file should follow outlines specified in 'dictionary'.
***************
*** 766,770 ****
  
                                                          *latex-package-file*
! A latex-package-file is a simple vim script which defines some global
  variables. These global variables are used by latex-suite to create the custom
  menu. See the |latex-package-file-writing| section how to define a customized
--- 769,773 ----
  
                                                          *latex-package-file*
! A latex-package-file is a simple Vim script which defines some global
  variables. These global variables are used by latex-suite to create the custom
  menu. See the |latex-package-file-writing| section how to define a customized
***************
*** 786,790 ****
  add options to the package etc.
      
! NOTE: Since the package file is a vim-script, you could define custom
  functions there, add mappings etc.
  
--- 789,793 ----
  add options to the package etc.
      
! NOTE: Since the package file is a Vim script, you could define custom
  functions there, add mappings etc.
  
***************
*** 874,883 ****
  LATEX HELP                                       *latex-help*  {{{
  
! latexhelp.txt is a collection of latex.info files `translated' into vim help
! format. Now you can seek for help for specific LaTeX item without exiting vim.
  
  Example: >
      :help \kill
! gives help for the LaTeX \kill command.
  
  In order to use this help file, you will need to run |:helptags| once after
--- 877,889 ----
  LATEX HELP                                       *latex-help*  {{{
  
! latexhelp.txt is a collection of latex.info files `translated' into Vim help
! format. Now you can seek for help for specific LaTeX item without exiting Vim.
  
  Example: >
      :help \kill
! gives help for the LaTeX \kill command. 
! 
! You can also place cursor on LaTeX \item and press <F1>. If in latexhelp.txt
! is something about this you would be immediately taken there.
  
  In order to use this help file, you will need to run |:helptags| once after
***************
*** 890,894 ****
  Latex-suite ships with a dictionary of over 600 commands from LaTeX and
  popular packages. When latex-suite starts up, it automatically adds this
! dictionary to vim's 'dictionary' option for use with vim's |i_CTRL-X_CTRL-K|
  command. 
  
--- 896,900 ----
  Latex-suite ships with a dictionary of over 600 commands from LaTeX and
  popular packages. When latex-suite starts up, it automatically adds this
! dictionary to Vim's 'dictionary' option for use with Vim's |i_CTRL-X_CTRL-K|
  command.