---

#tidy -- tidy プラグインパッケージ

---

はじめに

これは、 mopia さんが作成された Wiki Engine である VikiWiki の静的 HTML ページを Tidy で整形するためのプラグインのパッケージです。

なお、このプラグインを使用するには、あらかじめ VikiWiki を起動しているサーバに tidy をインストールしておくことが必要です。

tidy のインストールに関する詳細は Tidy の Web Page を参照してください。

インストール

ここでは、 tidy プラグインのインストール方法について述べます。

最初に、このパッケージの tarball を展開すると、以下のファイルが取得できます。

tidy/  ... tarball の展開先

  plugin/ ... プラグインスクリプト
    tidy.rb
    ja/
      tidy.rb

  text/  ... tidy 実行ページ
    TidyPage.VikiWikiStyle.txt

まず、 tidy 実行ページ text/TidyPage.VikiWikiStyle.txt の文字コードを、現在使用中の VikiWiki の文字コードに合わせて変更します。文字コード変換には、 nkf 等を利用してください。

次に、 plugin/tidy.rb の以下の行を、 tidy コマンドが存在する path に合わせて編集します。

  ...
  TIDY_PATH = "/usr/bin/tidy" # ← tidy コマンドが存在する path を
                                # 絶対 path で指定する
  #TIDY_PATH = "/home/itc/nakatuka/bin/tidy"
  ...

また、 text/TidyPage.VikiWikiStyle.txt の以下の行を修正することにより、 tidy コマンドに与えるオプションを変更することができます。

  ...
  #tidy "--indent auto -raw --wrap 80"
  // ↑ プラグイン #tidy の引数に tidy コマンドのオプションを指定する
  //#tidy "--doctype strict --vertical-space no --indent auto -raw --wrap -1"
  ...

そして、 plugin/tidy.rb, plugin/ja/tidy.rb を、 $VIKIWIKIDIR/plugin, $VIKIWIKIDIR/plugin/ja 以下に、text/TidyPage.VikiWikiStyle.txt を @conf["BASEDIR"]/text 以下に、それぞれコピーして下さい。

(ここで、 $VIKIWIKIDIR は VikiWiki のインストール先のディレクトリで、 @conf["BASEDIR"] は VikiWiki の設定値 "BASEDIR" で示されたディレクトリです。いずれも vikiwiki.cgi に書かれています。)

使用法

まず、 [[TidyPage]] を開いてください。

VikiWiki の 静的 HTML ページのリストが表示されますので、 Tidy で整形したいページの左にある checkbox に check を入れます。その後、一番下の "Tidy を実行する" のボタンを押します。

指定したページへの tidy による整形がすべて終了すると、画面に実行結果が表示されます。

謝辞

このドキュメントの最後に、VikiWiki を開発された mopia さん に心より感謝致します。

配布条件

以下にこのパッケージの配布条件を示します。

• このパッケージは Z80-OOLONG (NAKATSUKA, Yukitaka) が著作権を有します。

• このパッケージは、 VikiWiki の配布条件に準じ、 GPL に従って配布されるものとします。

---

---

---

---