|
From: <sri...@us...> - 2005-12-24 06:24:13
|
Update of /cvsroot/vim-latex/vimfiles/doc In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv32589 Modified Files: latex-suite.txt latex-suite.xml Log Message: Further clarifications in the environment and command macro sections. Index: latex-suite.txt =================================================================== RCS file: /cvsroot/vim-latex/vimfiles/doc/latex-suite.txt,v retrieving revision 1.60 retrieving revision 1.61 diff -C2 -d -r1.60 -r1.61 *** latex-suite.txt 23 Dec 2005 07:54:25 -0000 1.60 --- latex-suite.txt 24 Dec 2005 06:23:58 -0000 1.61 *************** *** 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_dQ|] 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_dU|] for a list of people who have helped. [...3014 lines suppressed...] --- 3279,3283 ---- ================================================================================ ! Credits *ls_12* *ls_a_dU* *latex-suite-credits* *************** *** 3307,3311 **** out who has done what. ! *latex-suite-maintainer* *ls_a_ez* The current maintainer(s) of Latex-Suite is(are) --- 3316,3320 ---- out who has done what. ! *latex-suite-maintainer* *ls_a_eC* The current maintainer(s) of Latex-Suite is(are) Index: latex-suite.xml =================================================================== RCS file: /cvsroot/vim-latex/vimfiles/doc/latex-suite.xml,v retrieving revision 1.40 retrieving revision 1.41 diff -C2 -d -r1.40 -r1.41 *** latex-suite.xml 23 Dec 2005 07:54:25 -0000 1.40 --- latex-suite.xml 24 Dec 2005 06:23:59 -0000 1.41 *************** *** 229,292 **** <title>Environment Mappings</title> &ls; provides a rich set of mappings to insert, enclose and modify ! &latex; environments. ! <section id="insert-mode-environment-mappings"> ! <title id="insert-mode-environment-mappings.title">Insert-mode Mappings</title> ! <para> ! These mappings insert LaTeX "environments" such as: ! <programlisting>\begin{center} ! &ph; ! \end{center}&ph;</programlisting> ! with the cursor left at the first |placeholder|. There are ! various ways of inserting environments into the source file. If ! the environment is a standard latex environment, then latex suite ! might also include common fields associated with it. ! </para> <para> ! See <link linkend="Tex_Env_name">this section</link> for details on ! how to customize the way &ls; will expand various environments. </para> ! <section id="ls-imap-f5"> ! <title>Method 1</title> <para> ! If you press <literal><F5></literal> in the ! insert mode while on an empty line, &ls; prompts you ! with a list of environments you might want to insert. You can ! either choose one from the list or type in a new environment ! name. This list can be customized via the <link ! linkend="Tex_PromptedEnvironments"><literal>g:Tex_PromptedEnvironments</literal></link> ! setting. </para> <para> ! In addition to the <literal>Tex_PromptedEnvironments</literal> ! variable, &ls; also lists envionments found in custom packages as ! described in the section <link linkend="package-actions">Package ! actions.</link> </para> - </section> - <section> - <title>Method 2</title> <para> ! If you press <literal><F5></literal> while on a line ! containing a single word, then &ls; creates a ! environment of that name. </para> </section> ! <section> ! <title>Method 3</title> <para> The shifted function keys, <literal><S-F1></literal> to ! <literal><S-F4></literal> can also be optionally mapped ! to some common environments which you insert most often. The ! environments mapped to each key can also be customized via the <link linkend="Tex_HotKeyMappings">g:Tex_HotKeyMappings</link> setting. </para> </section> ! <section> ! <title>Method 4</title> <para> ! Environments can also be inserted by pressing a 3 capital ! letter sequence starting with an <literal>E</literal>. The following subsection ! describes this in detail. The sequence of 3 letters generally ! tries to follow the following rules: </para> <orderedlist> --- 229,283 ---- <title>Environment Mappings</title> &ls; provides a rich set of mappings to insert, enclose and modify ! &latex; environments, i.e, <literal>\begin{...} ... \end{...}</literal> ! pairs. ! <section id="inserting-environments"> ! <title>Inserting Environments</title> <para> ! &ls; provides the following ways to insert environments </para> ! <section id="inserting-env-f5"> ! <title>Method 1: Pressing <literal><F5></literal></title> <para> ! If you press <literal><F5></literal> in the insert or normal ! mode while on an empty line, &ls; prompts you with a list of ! environments you might want to insert. You can either choose one ! from the list or type in a new environment name. If you press ! <literal><F5></literal> on a line which already has a word, ! then that word is used instead of prompting. </para> <para> ! See <link linkend="Tex_Env_name">Tex_Env_name</link> for a ! description of how &ls; uses the word to form the expansion and how ! to modify &ls;'s behavior. </para> <para> ! The list of environments which &ls; prompts you with (when ! <literal><F5></literal> is pressed on an empty line) is formed ! from the <link ! linkend="Tex_PromptedEnvironments">Tex_PromptedEnvironments</link> ! setting. ! </para> ! <para> ! In addition to this setting, &ls; also lists envionments found in ! custom packages as described in the section <link ! linkend="package-actions">Package actions.</link> </para> </section> ! <section id="inserting-env-shift-f1"> ! <title>Method 2: Using <literal><S-F1></literal>-<literal><S-F4></literal></title> <para> The shifted function keys, <literal><S-F1></literal> to ! <literal><S-F4></literal> can be mapped to insert very commonly ! used environments. The environments mapped to each key can be ! customized via the <link linkend="Tex_HotKeyMappings">g:Tex_HotKeyMappings</link> setting. </para> </section> ! <section id="inserting-env-threeletter"> ! <title>Method 3: Using three letter sequences</title> <para> ! Environments can also be inserted by pressing a 3 capital letter ! sequence starting with an <literal>E</literal>. The sequence of 3 ! letters generally tries to follow the following rules: </para> <orderedlist> *************** *** 322,345 **** </section> </section> ! <section id="visual-mode-environment-mapings"> ! <title>Visual-mode Mappings</title> <para> &ls; provides visual-mode mappings which enclose visually ! selected portions of text in environments. These mappings are ! derived from the corresponding insert-mode environment mappings ! according to the following simple rule: ! ! <programlisting>ECE --> ,ce</programlisting> ! The rule simply says that the leading <literal>E</literal> is ! converted to <literal>,</literal> and the next 2 letters are ! small case. ! ! Here <literal>ECE</literal> is the insert-mode map which inserts ! the <literal>\begin{center} ... \end{center}</literal> ! environment. Correspondingly, if you select a portion of text ! visually and press <literal>,ce</literal> while still in visual ! mode, then the selected portion will be enclosed in ! <literal>\begin{center} ... \end{center}</literal>. ! Some of the visual mode mappings are sensitive to whether you choose line-wise or character-wise. For example, if you choose a --- 313,358 ---- </section> </section> ! <section id="enclosing-environments"> ! <title>Enclosing in Environments</title> <para> &ls; provides visual-mode mappings which enclose visually ! selected portions of text in environments. There are two ways provided ! to do this. ! </para> ! <section id="enclosing-env-f5"> ! <title>Method 1: Pressing <literal><F5></literal></title> ! <para> ! You can also select a portion of text visually and press ! <literal><F5></literal> while still in visual mode. This will ! prompt you with a list of environments. (This list can be customized ! via the <link ! linkend="Tex_PromptedEnvironments">g:Tex_PromptedEnvironments</link> ! setting). You can either choose from this list or type in a new ! environment name. Once the selection is done, &ls; encloses the ! visually selected portion in the chosen environment. ! </para> ! </section> ! <section id="enclosing-env-threeletter"> ! <title>Method 2: Using three letter mappings</title> ! <para> ! You can also select text visually and press a sequence of three ! characters beginning with <literal>,</literal> (the single comma ! character) and the selected text will be enclosed in the chosen ! environment. The three letter sequence follows directly from the ! three letter sequence used to insert environments as described <link ! linkend="inserting-env-threeletter">here</link>. The following ! example describes the rule used: ! </para> ! <para> ! If <literal>ECE</literal> inserts a ! <literal>\begin{center}...\end{center}</literal> environment, then to ! enclose a block of selected text in ! <literal>\begin{center}...\end{center}</literal>, simply select the ! text and press <literal>,ce</literal>. The rule simply says that the ! leading <literal>E</literal> is converted to <literal>,</literal> and ! the next 2 letters are small case. ! </para> ! </section> ! <para> Some of the visual mode mappings are sensitive to whether you choose line-wise or character-wise. For example, if you choose a *************** *** 351,368 **** \end{center}</programlisting> </para> - <anchor id="ls-vmap-f5" /> - <para> - You can also select a portion of text visually and press - <literal><F5></literal> while still in visual mode. This will - prompt you with a list of environments. (This list can be customized - via the <link - linkend="Tex_PromptedEnvironments">g:Tex_PromptedEnvironments</link> - setting). You can either choose from this list or type in a new - environment name. Once the selection is done, &ls; encloses the - visually selected portion in the chosen environment. - </para> </section> ! <section id="normal-mode-environment-mappings"> ! <title>Normal Mode Mappings</title> <para> Pressing <literal><S-F5></literal> in normal mode detects which --- 364,370 ---- \end{center}</programlisting> </para> </section> ! <section id="changing-environments"> ! <title>Changing Environments</title> <para> Pressing <literal><S-F5></literal> in normal mode detects which *************** *** 394,446 **** <section id="latex-command-maps"> <title>Command Mappings</title> ! <anchor id="ls-imap-f7" /> ! <anchor id="ls-imap-s-f7" /> ! <para> ! &ls; provides two simple mappings <literal><F7></literal> and ! <literal><S-F7></literal> which work in both insert and normal ! mode in an idential manner. In insert mode, if the cursor is touching a ! word, then that word is replaced by a command constructed with that ! word. 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 ! packages which &ls; finds. See the <link ! linkend="package-actions">Package actions</link> section for details ! on which files are scanned etc. ! </para> ! <para> ! For certain common commands, &ls; will expand them to include ! additional arguments as needed. For example, <literal>frac</literal> ! becomes <literal>\frac{&ph;}{&ph;}&ph;</literal>. 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> ! Pressing <literal><F7></literal> in normal mode is equivalent to ! pressing <literal>i</literal> to go to insert mode and then pressing ! <literal><F7></literal>. In other words, if the cursor is in or ! just after a word, then that word will become a command, otherwise, the ! user is prompted to choose a command to insert. ! </para> ! <para> ! In both insert and normal mode <literal><S-F7></literal> will ! find out if you are presently within an environment and then prompt you ! with a list of commands to change it to. ! </para> ! <anchor id="ls-vmap-f7" /> ! <para> ! You can also select a portion of text visually and press ! <literal><F7></literal> while still in visual mode. This will ! prompt you with a list of commands. (This list can be customized ! via the <link ! linkend="Tex_PromptedCommands">g:Tex_PromptedCommands</link> ! setting). You can either choose from this list or type in a new ! command name. Once the selection is done, &ls; encloses the ! visually selected portion in the chosen command. ! </para> </section> <section id="font-maps"> --- 396,453 ---- <section id="latex-command-maps"> <title>Command Mappings</title> ! &ls; provides a rich set of mappings to insert, enclose and modify ! &latex; commands. ! <section id="inserting-commands"> ! <title>Inserting &latex; commands</title> ! <anchor id="ls-imap-f7" /> ! <anchor id="ls-imap-s-f7" /> ! <para> ! Pressing <literal><F7></literal> in insert or normal mode while ! the cursor is touching a word will insert a command formed from the ! word touching the cursor. ! </para> ! <para> ! For certain common commands, &ls; will expand them to include ! additional arguments as needed. For example, <literal>frac</literal> ! becomes <literal>\frac{&ph;}{&ph;}&ph;</literal>. Otherwise, it will ! simply change the word under the cursor as follows ! <programlisting>word --> \word{&ph;}&ph;</programlisting> ! You can define custom expansions ! of commands using the <literal>Tex_Com_{name}</literal> setting as ! described in <link linkend="Tex_Com_name">here</link>. ! </para> ! <para> ! If <literal><F7></literal> is pressed when the cursor is on ! white-space, then &ls; will prompt you to choose a command and insert ! that instead.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 ! packages which &ls; finds. See the <link ! linkend="package-actions">Package actions</link> section for details ! on which files are scanned etc. ! </para> ! </section> ! <section id="enclosing-commands"> ! <title>Enclosing in a command</title> ! <para> ! You can select a portion of text visually and press ! <literal><F7></literal> while still in visual mode. This will ! prompt you with a list of commands. (This list can be customized ! via the <link ! linkend="Tex_PromptedCommands">g:Tex_PromptedCommands</link> ! setting). You can either choose from this list or type in a new ! command name. Once the selection is done, &ls; encloses the ! visually selected portion in the chosen command. ! </para> ! </section> ! <section id="changing-commands"> ! <title>Changing commands</title> ! <anchor id="ls-vmap-f7" /> ! <para> ! In both insert and normal mode <literal><S-F7></literal> will ! find out if you are presently within an environment and then prompt you ! with a list of commands to change it to. ! </para> ! </section> </section> <section id="font-maps"> *************** *** 1274,1278 **** environments found to the list of commands and environments which you are prompted with when you press <link ! linkend="ls-imap-f5"><literal><F5></literal></link> or <link linkend="ls-imap-f7"><literal><F7></literal></link> in insert mode. --- 1281,1285 ---- environments found to the list of commands and environments which you are prompted with when you press <link ! linkend="inserting-env-f5"><literal><F5></literal></link> or <link linkend="ls-imap-f7"><literal><F7></literal></link> in insert mode. *************** *** 3359,3363 **** </thead> <tbody> ! <row><entry><literal>g:Tex_EnvironmentMaps </literal></entry><entry><link linkend="insert-mode-environment-mappings">Environment Mappings</link></entry><entry>1</entry></row> <row><entry><literal>g:Tex_EnvironmentMenus</literal></entry><entry></entry><entry>1</entry></row> <row><entry><literal>g:Tex_FontMaps </literal></entry><entry><link linkend="font-maps">Font Mappings</link></entry><entry>1</entry></row> --- 3366,3371 ---- </thead> <tbody> ! <row><entry><literal>g:Tex_EnvironmentMaps ! </literal></entry><entry><link linkend="environment-mappings">Environment Mappings</link></entry><entry>1</entry></row> <row><entry><literal>g:Tex_EnvironmentMenus</literal></entry><entry></entry><entry>1</entry></row> <row><entry><literal>g:Tex_FontMaps </literal></entry><entry><link linkend="font-maps">Font Mappings</link></entry><entry>1</entry></row> *************** *** 3483,3489 **** <para> In order to avoid clashes between the large number of visual mode macros ! provided, the <link linkend="visual-mode-environment-mapings">visual mode macros for environments</link> and sections start with a character ! different from <literal>g:Tex_Leade</literal>. </para> </section> --- 3491,3497 ---- <para> In order to avoid clashes between the large number of visual mode macros ! provided, the <link linkend="enclosing-env-threeletter">visual mode macros for environments</link> and sections start with a character ! different from <literal>g:Tex_Leader</literal>. </para> </section> |
