vim-latex-devel

[Vim-latex-devel] Vim LaTeX Suite Tutorial -WIP

[Animesh N. <an...@gm...>]

hi all,

\begin{introduction}
   Name: Animesh N. Nerurkar
   mailid: 
      <ba...@sy...>
      <an...@gm...>

   i use vim 6.x on debian 3.0 (woody) -my default system at home ...also
use knoppix, SuSe 8.1
   i don't know and don't use vim on Winxx. my understanding of Winxx is
rudimentary at best -have an aversion for Winxx.

   am an Automobile Engg.
   am working with the Centre for monitoring Indian Economy (CMIE)

   am currently based in Goa
\end{introduction}

now, to get down to the business...

i am writing the tutorial (Work in Progress) for Vim LaTeX Suite. This
tutorial is being composed for inclusion in the LaTeX Primer. If that comes out in
time, it might get included in the next TeX Live CD set. It might also be
modified and put online by Mikolaj. The LaTeX Primer and this tutorial are
aimed squarely at rank newbies to LaTeX.

i am currently planning the following layout for this tutorial and invite
your comments, inputs, opinions & suggestions:

1) introduction (naturally)
2) download and install instructions for Vim LaTeX Suite (i'll shorten this
to VLS hencforth).
3) instructions to setup and use VLS help in (g)vim 6.x
4) recommend gvim as a starter for newbies (they can switch to vim later as
their skill levels increase).
5) VLS menu items. HOWTO use VLS menu items.
6) VLS "insert mode" keymap stds. (E for environment etc.) and HOWTO use
these.
7) VLS "visual mode" keymap stds. and HOWTO use these.
8) HOWTO use templates and add custom templates.
9) HOWTO use various packages bundled into VLS.
10) table the available keymaps for both modes and list what they do. (shud
this be included as a tear-off cheat sheet?)
 
i'm planning on omiting all advanced features of VLS from the LaTeX Primer.
we could add that to the online version at vim-latex.sf.net

material collection and collation for this tutorial has already commenced.
material collected so far:
1) snarfed contents of all online pages from vim-latex.sf.net
2) initial list of keymas provided by mikolaj
3) sri is busy but, has still managed to take some time out and send in some
explanations on macros (more -much, much more is reqd.)
4) required: list of features exist (very imp) in VLS and howto use them.

i could discover all this and finish the writeup on my own but, that would
consume a lot of time -perhaps making this too late for TeX Live. however, if
y'all could pitch in and help me compile the material, we could as a team
finish this in far less time. some of you could volunteer to compile material
for a limited part of the VLS features list and send them in.

it is possible to compile and post a set of questionaires to help y'all with
that search.

what do y'all say? ...awaiting your responses and feedback.

regards
animesh

--
-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*
-* Animesh N. Nerurkar | Automobile Engineer
-*<an...@gm...>, <ba...@sy...>
-* F-4, Mandovi Apartments, Dr. Dada Vaidya Road,
-* Panaji, Goa, India, 403 001
-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*


-- 
+++ GMX - Mail, Messaging & more  http://www.gmx.net +++
Bitte lächeln! Fotogalerie online mit GMX ohne eigene Homepage!

Re: [Vim-latex-devel] Vim LaTeX Suite Tutorial -WIP

[Mikolaj M. <mi...@wp...>]

On Mon, May 19, 2003 at 09:30:46AM +0200, Animesh Nerurkar wrote:
> 1) introduction (naturally)
> 2) download and install instructions for Vim LaTeX Suite (i'll shorten this
> to VLS hencforth).
> 3) instructions to setup and use VLS help in (g)vim 6.x
> 4) recommend gvim as a starter for newbies (they can switch to vim later as
> their skill levels increase).

Gvim also offers more - menus, I am currently working on utf-8 menus:
most symbols will be visible beside their names, tips for shortcuts, and
so on. Also some of shortcuts don't work properly in various terminals
(of course it is bug in terminals not in lS :).

Also gvim more cross-platform: I hear Vim in Mac's term can behave
strange, also for Windows there is no real terminal.

> 5) VLS menu items. HOWTO use VLS menu items.
> 6) VLS "insert mode" keymap stds. (E for environment etc.) and HOWTO use
> these.
> 7) VLS "visual mode" keymap stds. and HOWTO use these.
> 8) HOWTO use templates and add custom templates.
> 9) HOWTO use various packages bundled into VLS.
> 10) table the available keymaps for both modes and list what they do. (shud
> this be included as a tear-off cheat sheet?)

I would suggest make it in form of guide through writing of document.
After description of download and installation it would be:
1) Choose template. Nothing appropriate (eg non-standard documentclass).
Write my own. Use that template.
2) Make additions to preamble - it will be introduction of how to use
packages system, scanning preamble for \newcommand etc.
3) Write document - insert, change environments (you could shortly
explain Environment Wizard - disabled by default in favour of
placeholders):
<F5>, <S-F5> - maps
4) Here you could make copy&paste two or three paragraphs from word
processor or text/plain and edit them with Visual mappings.
5) Describe making of bibliography with bibtex.vim - unfortunately this
part has NULL documentation AFAIK and use <F9> for inserting bibkeys.

IMO this type of tutorial will be easier to understand (not necessarily
to write!). HOWTO style instructions should better be in main doc file.

BTW. In what form this tutorial will be originally? LaTeX, html, text?
If LaTeX you could just describe how you are writing it :) Only add some
math.

m.

Re: [Vim-latex-devel] Vim LaTeX Suite Tutorial -WIP

[Animesh N N. <an...@gm...>]

Hi Mikolaj,

On Monday 19 May 2003 17:05, Mikolaj Machowski wrote:

> Gvim also offers more - menus,
...
> I am currently working on utf-8 menus:
> most symbols will be visible beside their names, tips for shortcuts, and
> so on. Also some of shortcuts don't work properly in various terminals
> (of course it is bug in terminals not in lS :).

Oh boy... more to write about... good, good, keep it coming...

> Also gvim more cross-platform: I hear Vim in Mac's term can behave
> strange, also for Windows there is no real terminal.

Ummm... yeah, and that's been worrying me as well... i'm in no position to test it out on anything other than debian and SuSE

> I would suggest make it in form of guide through writing of document.

that's a good idea.

> After description of download and installation it would be:
> 1) Choose template. Nothing appropriate (eg non-standard documentclass).
> Write my own. Use that template.

ok, point noted ...we could also add some more templates to the existing collection for article, book, presentation, etc.

> 2) Make additions to preamble - it will be introduction of how to use
> packages system, scanning preamble for \newcommand etc.

ok. good idea

> 3) Write document - insert, change environments (you could shortly
> explain Environment Wizard - disabled by default in favour of
> placeholders):

yes ...actually, i need that explanation myself :)

> <F5>, <S-F5> - maps

yes -list as many maps as possible.

> 4) Here you could make copy&paste two or three paragraphs from word
> processor or text/plain and edit them with Visual mappings.

yes

> 5) Describe making of bibliography with bibtex.vim - unfortunately this
> part has NULL documentation AFAIK and use <F9> for inserting bibkeys.

ok. but, i'll need to know how this is done before i can write about it.

> IMO this type of tutorial will be easier to understand (not necessarily
> to write!). HOWTO style instructions should better be in main doc file.

you hit the nail on the head.

may i offer a suggestion... you tutor me (online) to exploit all the known features of VLS and i'll contribute/maintain the tutorial to this proj. fair deal ?

> BTW. In what form this tutorial will be originally? LaTeX, html, text?

composing content in plain text,  typeseting with LaTeX.

> If LaTeX you could just describe how you are writing it :) Only add some math.

have a look at  http://www.tug.org.in/tutorials.html ...you'll find the last edition of the book ...a printable version is also available there ...you can download, print and distribute or sell. what we need for the coming edition are the missing pieces -AucTeX and VLS.

warm regards
animesh

-- 
:
####[ GNU/Linux One Stanza Tip (LOST) ]###########################
  
Sub : Sha-bang !                                     LOST #163

The sha-bang (#!) at the beginning of a script is actually a 2
byte "magic number" which designates an executable script. See
'man magic' for details. Tells the system that  ensuing  lines
are to be fed to the command interpreter indicated.
 
####<bi...@nd...>####################################
:

Re: [Vim-latex-devel] Vim LaTeX Suite Tutorial -WIP

[Mikolaj M. <mi...@wp...>]

On Mon, May 19, 2003 at 11:55:03PM +0530, Animesh N Nerurkar wrote:
> Hi Mikolaj,
> On Monday 19 May 2003 17:05, Mikolaj Machowski wrote:
> > Gvim also offers more - menus,
> ...
> > I am currently working on utf-8 menus:
> > most symbols will be visible beside their names, tips for shortcuts, and
> > so on. Also some of shortcuts don't work properly in various terminals
> > (of course it is bug in terminals not in lS :).
> Oh boy... more to write about... good, good, keep it coming...

New will be only menus in utf-8 :)

> > 3) Write document - insert, change environments (you could shortly
> > explain Environment Wizard - disabled by default in favour of
> > placeholders):
> yes ...actually, i need that explanation myself :)

This is shortly explained in texrc. This is important part od
documentation :)

> > <F5>, <S-F5> - maps
> yes -list as many maps as possible.

Hmm. Only in separate "cheat-sheet". In text flood of mappings would be
confusing. I would rather underscore some "magic" shortcuts like <F5>,
<F9> and explained mnemonics of font and environments shortcuts.

> may i offer a suggestion... you tutor me (online) to exploit all the
> known features of VLS and i'll contribute/maintain the tutorial to
> this proj. fair deal ?

Hmm. I would rather it in the other way. Write exactly what you want to
do and I can explain how to do it. Writing documentation and especially
such tutorials by developers has one drawback - author often has idea
how everything works and tends to keep his own way, not necessarily way
chosen by end-user.

m.

Re: [Vim-latex-devel] Vim LaTeX Suite Tutorial -WIP

[Animesh N N. <an...@gm...>]

Hi Mikolaj,

On Tuesday 20 May 2003 14:00, Mikolaj Machowski wrote:

> New will be only menus in utf-8 :)

ok.

> This is shortly explained in texrc. This is important part od
> documentation :)

ok, in texrc i didn't understand the following:

1) how can i make a custom cp of texrc when the orig texrc itself is stored under "$HOME/.vim/ftplugin/latex-suite/"  ...? where would my custom texrc go ?
2) the entire "SafeLet" section
3) ...Latex-suite shites with a number of... (what is "shites")

everything else is understandable (more or less)

that reminds me, i've been trying to use the LaTeX Folding feature of VLS using the sample code from the VLS manual ...it didn't work :(

my default texrc reads:
TexLet g:Tex_Folding = 1 
TexLet g:Tex_AutoFolding = 1 

(i haven't got down to experimenting with a custom texrc yet and won't doing so for some time)

> > yes -list as many maps as possible.
>
> Hmm. Only in separate "cheat-sheet". In text flood of mappings would be
> confusing. I would rather underscore some "magic" shortcuts like <F5>,
> <F9> and explained mnemonics of font and environments shortcuts.

yes, this was the general plan.

BTW, is it possible to code a script that would give me one more keymap -to display the active custom keymaps set by VLS ? that would be a great help for vim users in leu of the menus that only gvim users have at their disposal?

> Hmm. I would rather it in the other way. Write exactly what you want to
> do and I can explain how to do it. Writing documentation and especially
> such tutorials by developers has one drawback - author often has idea
> how everything works and tends to keep his own way, not necessarily way
> chosen by end-user.

ok, i'll throw questions at the VLS list and y'all can answer them... a request, if you find me slowing down or missing some important feature, plz don't hesitate to drag me into that topic -i'm not yet aware of all the bells and whistles that you've put into VLS :)

ciao
animesh

-- 
:
####[ GNU/Linux One Stanza Tip (LOST) ]#######################

Sub : Typing CTRL characters at shell prompt         LOST #402

To type Ctrl characters at the shell prompt, keep the CTRL key
pressed, then press v, followed by the desired character. e.g.
to have ^M, press  CTRL and then v and m in sequence,  without
releasing the CTRL key.  This, one liner would  remove ^M from
DOS files: "tr -d '^M' < dosfile > newfile" 
 
####[bish (at) nde.vsnl.net.in]###############################
:

Re: [Vim-latex-devel] Vim LaTeX Suite Tutorial -WIP

[Mikolaj M. <mi...@wp...>]

On Tue, May 20, 2003 at 11:54:15PM +0530, Animesh N Nerurkar wrote:
> > This is shortly explained in texrc. This is important part od
> > documentation :)
> ok, in texrc i didn't understand the following:
> 1) how can i make a custom cp of texrc when the orig texrc itself is
> stored under "$HOME/.vim/ftplugin/latex-suite/"  ...? where would my
> custom texrc go ?

This is explained in Installation section of texrc:

"               Make your local copy as:
"                    $HOME/vimfiles/ftplugin/tex/texrc   (WINDOWS)
"               or 
"                    $HOME/.vim/ftplugin/tex/texrc       (UNIX)

> 2) the entire "SafeLet" section

This is technical section only for dealing with texrc. YOu don't have to
understand that :)

> 3) ...Latex-suite shites with a number of... (what is "shites")

Hmm. Mispell obviously but what word should go here?

> everything else is understandable (more or less) that reminds me, i've
> been trying to use the LaTeX Folding feature of VLS using the sample
> code from the VLS manual ...it didn't work :(

Small sample may not work (without \documentclass, \begin{document}
etc.). Try real document.

> > > yes -list as many maps as possible.
> >
> > Hmm. Only in separate "cheat-sheet". In text flood of mappings would be
> > confusing. I would rather underscore some "magic" shortcuts like <F5>,
> > <F9> and explained mnemonics of font and environments shortcuts.
> yes, this was the general plan.  BTW, is it possible to code a script
> that would give me one more keymap -to display the active custom
> keymaps set by VLS ? that would be a great help for vim users in leu
> of the menus that only gvim users have at their disposal?

I will put it into TODO list.

m.

Re: [Vim-latex-devel] Vim LaTeX Suite Tutorial -WIP

[Animesh N N. <an...@gm...>]

Hi Mikolaj,

On Wednesday 21 May 2003 03:11, Mikolaj Machowski wrote:

> > ok, in texrc i didn't understand the following:
> > 1) how can i make a custom cp of texrc when the orig texrc itself is
> > stored under "$HOME/.vim/ftplugin/latex-suite/"  ...? where would my
> > custom texrc go ?
>
> This is explained in Installation section of texrc:
>
> "               Make your local copy as:
> "                    $HOME/vimfiles/ftplugin/tex/texrc   (WINDOWS)
> "               or
> "                    $HOME/.vim/ftplugin/tex/texrc       (UNIX)

Err... mikolaj,  that's where the *default* texrc resides currently ! ...how can my custom cp and the original cp reside in the same same location at the same time ?

VLS is installed under: $HOME/.vim/

the locations you've mentioned above (and also mentioned in texrc) would make sense only if VLS were installed in some non-personal location like say; "/usr/share/vim/vim61/" can this be done ?

> Small sample may not work (without \documentclass, \begin{document}
> etc.). Try real document.

actually, it was added to a real doc for testing... never mind, i figured out how it works... that behaviour i described, happens  when you  first insert the new code. if you open a file that alread has the code, it works as described in the online VLS manuals :-)



ciao
animesh

-- 
:
####[ GNU/Linux One Stanza Tip (LOST) ]###########################

Sub : Get your copy of Linux Gazette                 LOST #059

#!/bin/bash
ISSUE=61   #Note: Issue 61 was Jan 2001 change for month reqd 
wget -v -c "ftp://ftp.ssc.com/pub/lg/lg-base.tar.gz"'
wget -v -c "ftp://ftp.ssc.com/pub/lg/lg-issue'$ISSUE'.tar.gz"'

####<bi...@nd...>###################################
:

Re: [Vim-latex-devel] Vim LaTeX Suite Tutorial -WIP

[Mikolaj M. <mi...@wp...>]

On Wed, May 21, 2003 at 02:10:05PM +0530, Animesh N Nerurkar wrote:
> > This is explained in Installation section of texrc:
> >
> > "               Make your local copy as:
> > "                    $HOME/vimfiles/ftplugin/tex/texrc   (WINDOWS)
> > "               or
> > "                    $HOME/.vim/ftplugin/tex/texrc       (UNIX)
> Err... mikolaj,  that's where the *default* texrc resides currently
> ! ...how can my custom cp and the original cp reside in the same same
> location at the same time ?  VLS is installed under: $HOME/.vim/

No. Default texrc resides in .vim/ftplugin/latex-suite directory

m.

Re: [Vim-latex-devel] Vim LaTeX Suite Tutorial -WIP

[Animesh N N. <an...@gm...>]

Hi Mikolaj,

On Thursday 22 May 2003 16:23, Mikolaj Machowski wrote:

> No. Default texrc resides in .vim/ftplugin/latex-suite directory

righto.

ciao
animesh

-- 
:
####[ GNU/Linux One Stanza Tip (LOST) ]#######################

Sub : mpeg encoder in mplayer                        LOST #435

A little known feature of mplayer (www.mplayerhq.hu) is that 
it contains a movie-file encoder, 'mencoder'. Try divx enco-
ding with 'libavcodec' that comes bundled with it; to shrink 
larger 'mpeg' files to half-sized 'avi' files.

####[tathagatabanerjee (at) gmx.net]##########################
: