Whizzy4Vim (WhizzyTeX for Vim)

1. 概要

フランス INRIA の Didier Remy 氏が作成した WhizzyTeX のシェルスクリプト部分を Vim から呼び出すためのラッパーシェルスクリプトです．

Vim の autocmd (au) 機能を使って，ファイルの保存時に WhizzyTeX を呼び出すしくみになっています．

WhizzyTeX for Vim は私が勝手に作って公開しているソフトウェアです．本ソフトウェアに関する不具合を WhizzyTeX の作者である Didier Remy 氏に連絡しないようにしてください．

2. 必要なソフトウェア

以下のソフトウェアおよびそれらが動作する環境が必要です．

Vim
GNU Bash (let 文を使用しているだけなので，expr に置き換えれば sh で動作するはずです)
WhizzyTeX
WhizzyTeX で使用するプレビューア (例えば Active-DVI)．

3. ライセンス

Whizzy4Vim (WhizzyTeX for Vim) は，フリーソフトウェア財団によって発行された GNU 一般公衆利用許諾契約書(バージョン 2 か、希望によってはそれ以降のバージョンのうちどれか)の定める条件の下で再頒布または改変することが可能なフリーソフトウェアです．

このプログラムは全くの無保証です．詳しくはアーカイブファイル中の GNU 一般公衆利用許諾契約書をご覧ください．

4. ダウンロード

最新のバージョンは 0.0.3 です（2007年5月29日現在）．

whizzy4vim-0.0.3.tar.gz (4,929 バイト, ソースファイル)
whizzy4vim-0.0.2.tar.gz (4,891 バイト, ソースファイル)

5. インストール

アーカイブファイルを展開すると以下のファイルが得られます．

whizzy4vim.vim
whizzy4vim
whizzy4vim_fakelatex

whizzy4vim.vim は ~/.vim/plugin に入れてください．残りの 2 つのファイルはパスの通ったディレクトリに入れてください．これでインストールは完了します．

6. 使用方法

6.1. 基本的な使用方法

拡張子が .tex のファイルを開き，保存すると自動的に WhizzyTeX を起動してプレビューします．カーソル移動では何も起こりません．

6.2. 高度な使用方法

ファイルのどこかに以下のような 1 行を書いておくことで使用するプレビューアが変更できます．ここは WhizzyTeX と同じです．whizzy.sh による変更も可能です．
```
%; whizzy -initex iniptex -latex platex -format platex -ps gv
```
また，ファイルのどこかに以下のような 1 行を書くこともできます．こちらは WhizzyTeX for Vim だけが読み込んで使用します．
```
% whizzy4vim: (Name)=(Value) (Name)=(Value) ...
```
現在 (Name) に使用可能な文字列は以下の通りです．
- TEXINPUTS - 右辺を環境変数 TEXINPUTS に設定します．
- ROOT - 編集中のファイルを \input で取り込んでいるファイルを指定します．
この行の設定例を以下に示します．
```
% whizzy4vim: TEXINPUTS=.:$HOME/.texmf//: ROOT=hoge
```
また，WhizzyTeX for Vim は暫定的に \input に対応しています (\input のネストには対応していません)．

例えば，以下のような 3 個の LaTeX ソースファイル(doc.tex, section.tex, appendix.tex)があったとします．
```
(doc.tex) 
\documentclass{jarticle}
\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.
```
doc.tex の \input コマンドで取り込まれる 2 個のファイルに ROOT=doc という指定をしています．これによって，取り込まれる側のファイルを編集した場合でも正しくプレビューができるようになっています．ただし，繰り返しますが，現在のバージョンでは \input の入れ子(この場合，section.tex や appendix.tex でさらに別のファイルを \input している場合)には対応していません．

7. TODO

本家 WhizzyTeX と比べて大多数の機能が未実装です．

Whizzy4Vim (WhizzyTeX for Vim)

目次