Whizzy4Vim (WhizzyTeX for Vim)

1. Overview

Whizzy4vim is a script to call the script part of WhizzyTeX from Vim. WhizzyTeX is made by Didier Remy in INRIA France.

This software uses Vim's autocmd (au) command to call the WhizzyTeX automatically when you save the editing .tex file.

If you find some bugs of this software, you don't tell these information to the original WhizzyTeX creator, Didier Remy.

2. Requirements

You need to setup the following software.

Vim
GNU Bash
WhizzyTeX
Active-DVI (The previewer software used by WhizzyTeX)

3. License

Whizzy4Vim (WhizzyTeX for Vim) is a free software. It can be used, modified and redistributed under the term of GNU General Public License (Version 2 or later).

There is NO warranty for the program. To learn more, please see GNU General Public License.

4. Download

The latest version is 0.0.3 (May 29, 2007).

whizzy4vim-0.0.3.tar.gz (4,929 Bytes, Source file)
whizzy4vim-0.0.2.tar.gz (4,891 Bytes, Source file)

5. Installation

Unpacking the archive file and you get following files:

whizzy4vim.vim
whizzy4vim
whizzy4vim_fakelatex

Please place the whizzy4vim.vim to ~/.vim/plugin. Please place the remaining 2 files place to the PATHed directory. Then installation is complete.

6. How to use

6.1. Easy usage

Installing the WhizzyTeX and Active-DVI.
Open the .tex file on ViM.
And when save it, the WhizzyTeX is invoked automatically to preview it (Notice: There is no action with the only cursor moving).

6.2. Advanced usage

If you write the line such as follows on the beginning of the .tex file, you can change the previewer application.
```
%; whizzy -initex iniptex -latex platex -format platex -ps gv
```
And you can also write the line such as follows. These line are used only by Whizzy4Vim.
```
% whizzy4vim: (Name)=(Value) (Name)=(Value) ...
```
You can use following items as (Name).
- TEXINPUTS - The TEXINPUTS environment variable set to (Value).
- ROOT - If the .tex file you are editing (for example: sectionA.tex) is included by other .tex file (for example: main.tex), You can specify "ROOT=main" to get preview with main.tex when you save the sectionA.tex.
The examples are follows.
```
% whizzy4vim: TEXINPUTS=.:$HOME/.texmf//: ROOT=foobar
```
The Whizzy4Vim has tentative functionality for the \input command (nested \input is unsupported).

For example, there are following 3 .tex files (doc.tex, section.tex and appendix.tex).
```
(doc.tex) 
		\documentclass{article}
		\begin{document}

		\input{section.tex}
		\input{appendix.tex}

		\end{document}
```
```
(section.tex)
		% whizzy4vim: ROOT=doc

		\section{Test document}
		This is a test document.
```
```
(appendix.tex)
		% whizzy4vim: ROOT=doc

		\appendix
		\section{Test appendix}
		This is a test appendix.
```
There are "ROOT=doc" line in the section.tex, appendix.tex which are included by doc.tex using \input command. For the ROOT=doc line, if you edited the included file and get preview properly. But, I repeat, nested \input is unsupported. (For this case, if there are \input command in section.tex and appendix.tex, you cannot get proper preview).

7. TODO

Comparing with original WhizzyTeX, the Whizzy4Vim has many loss of functionality.

Whizzy4Vim (WhizzyTeX for Vim)

Contents