---------------------------------------------------------------------------
  RvtlWiki ver.1.05u for rvtl64

  2010/07/03  Jun Mizutani & Toshio Moritake
---------------------------------------------------------------------------


■RvtlWiki
-----------------

RvtlWikiは結城 浩 氏が公開されている YukiWiki (http://www.hyuki.com)
の機能と文法を参考に rvtl (http://www.mztn.org/) という
TinyBasic系の言語で作成した Wiki Engineの一種です。

● RvtlWiki 1.05 からの変更点
- rvtl64用の修正 (64bit版のrvtl専用です)
- 文字コードを utf-8 に変更

● RvtlWiki 1.03 からの変更点 (1.04は欠番)

- RSS機能を追加
- ページのデザインを少し修正
- 出力タグを XHTML1.0対応に修正

● RvtlWiki 1.02 からの変更点

- プレビューの編集エリアが「[EFAULT] Bad address 」となる点を修正

● RvtlWiki 1.01 からの変更点

- 空行が段落として認識されないのを修正
- 行頭が空白の場合に段落にならない部分を修正

● RvtlWiki 1.00 からの変更点

- 追記機能により、どのページにも簡単に追記が可能。
- コメントフォーム(YukiWikiとは異なり位置は先頭に固定)からページ最上部または
  最下部に追加が可能。
- 定義形式リストのタイトル部分をボールドに変更。
- 水平線がハイフン5つであったのを4つに修正。
- 編集を保存すると直接ページが表示されるように変更。
- pages ディレクトリの内容を変更する必要はありません。

●YukiWikiとの違い

- ページタイトルの変更ができます。
- ページをグループに分類することができます。
- 強制改行「<br>」が 「--.」で挿入できます。
- テーブルの rowspan が可能です。
- 文字飾りは2種類ですが、スタイルシートで形式を変更できます。
- 見出しは4段階あります。
- 整形済みのフォーマット指定は4種類あります。
- 画像挿入の指定方法が異なります。
- 行頭はスペースでも整形済み(<pre>)になりません。
- > による引用文はありません。
- Wikiのページ名へのリンクは[[ページ名]]ではかけません。
- 大文字小文字を混ぜた英文字列はWikiのページ名としてリンクになりません。
- テーブル中にコンマ(,)を書くことはできません。
- コメントフォームは設置できません。
- ページ差分をとることはできません。
- 検索機能がありません。

■バージョンアップ手順
-----------------

このバージョンの RvtlWiki は文字コードを utf-8 にしているため、
RvtlWiki 1.00-1.05 からバージョンアップしてデータを移行するには
data ディレクトリと pages ディレクトリ のファイルをutf-8に変換する
必要があります。

■インストール手順
-----------------

このバージョンの RvtlWiki を動作させるためには rvtl64 (http://www.mztn.org/)
が必要です。 rvtl64 を /usr/bin/ にコピーしてください。

また rvtl64 を rvtlw というファイル名で /usr/bin/ 以下にシンボリックリンク
を作成するか、

  cd /usr/bin
  ln -s rvtl64 rvtlw

または rvtl64 を rvtlw というファイル名でコピーしてください。

  cd /usr/bin
  cp rvtl64 rvtlw

RvtlWikiは複数のファイルで構成されています。rvtlwiki.cgiには実行可能
属性(755)、その他は読みだし可能(644)である必要があります。
また、pages ディレクトリは CGI が読み書き(755)します。

httpサーバが nobody 等のユーザとして動作していて、suEXEC の設定に
なっていない場合は、pages ディレクトリの権限は 777(読み書き検索可)、
その下にある pages.txt、groups.txt の権限は 666(読み書き可) として
ください。

  cd rvtlwiki
  chmod 755 data
  chmod 777 pages
  chmod 777 pages/*.txt

  --+-- rvtlwiki.cgi   RvtlWiki の本体CGI
    |
    +-- render.cgi     テキストからHTMLへのレンダリングCGI
    |
    +-- .htaccess      Apache用の設定ファイル
    |
    +-- readme.txt     このファイル。実行には不要です。
    |
    +-- data -+-- rvtlwiki.png   RvtlWiki のロゴ
    |         |
    |         +-- rvtlwiki.dat   Wikiの使用法の表示データ
    |         |
    |         +-- rvtlwiki.css   RvtlWiki のスタイルシート
    |         |
    |         +-- frontpage.dat  表紙の表示データ
    |
    +--pages -+-- pages.txt  ページ管理用ファイル
              |
              +-- groups.txt グループ管理用ファイル
              :
              +-- 各Wikiページのファイル
              :

(1) 必要ならrvtlwiki.cgiのはじめの方にある、U['W']、U['H']などの値を修正する

    10100 :-------------------------------------------------------------
    10110 : ユーザ設定
    10120 :-------------------------------------------------------------
    10130    u=U                : 変更不可
    10140    u*="./data/"       : dataディレクトリのパス名 U[0]
    10150    u=U+64             : 変更不可
    10160    u*="./pages/"      : pagesディレクトリのパス名 U[16]
    10170    u=U+128            : 変更不可
    10180    u*="http://www.example.com/rvtlwiki/" : URL U[32]
    10190    u=U+768            : 変更不可
    10200    u*="RvtlWiki"      : フロントページのタイトル
    10210    u=U+512            : 変更不可
    10220    u*="RvtlWiki New"  : RSSタイトル
    10230    u=U+640            : 変更不可
    10240    u*="RvtlWiki RSS"  : RSS description
    10250    U['N']=96*1024     : 最大ページサイズ
    10260    U['W']=80          : 編集領域の桁数
    10270    U['H']=30          : 編集領域の行数
    10280    U['R']=40          : 更新履歴表示件数

    また、最大ページサイズを変更した場合は render.cgi の以下の部分も変更する。

    10070 :------------------------------------------------------------
    10080    M=96               : 最大ページサイズ(KB)


(2) dataディレクトリ中のfrontpage.datはhtml形式のファイルです。
    必要に応じて書き換えてください。本文部分(<body></body>の内側)のみ
    を書きます。

(3) ファイル一覧にあるファイルをサーバに転送する。転送モードやパーミッション
    を環境にあわせ適切に設定する。

(4) ブラウザでサーバ上のrvtlwiki.cgiのURLにアクセスする。

(5) メニューの「新規ページ分類」からページ分類名を設定する。

(6) メニューの「新規ページ」から新しいページを作成します。


■テキスト整形の基本ルール
-----------------

基本的に入力した文字はそのまま出力されます。
- 連続した複数行は連結され、改行されません。
- 空行は段落の区切りとなります。
- HTMLのタグは単なる文字列(そのまま表示)となります。

以下のルールでテキストを入力すると色々な形式で表示することができます。

●見出し

- 行頭に * (アスタリスク)を書くと、続く文字列は大見出しになります。
- 行頭に ** を書くと、続く文字列は中見出しになります。
- 行頭に *** を書くと、続く文字列は小見出しになります。
- 行頭に **** を書くと、続く文字列は最小見出しになります。
- 見出しがあると自動的に目次が作られます。

●文字飾り

- シングルクォート2個ではさんだ部分は、''ボールド''になります。
- シングルクォート3個ではさんだ部分は、'''赤ボールド'''になります。
- スタイルシートで表示形式を変更できます。

●箇条書き、水平線、引用文

- マイナス(-)を行頭に書くと、箇条書きになります。- -- --- の3レベルがあります。
- マイナス4個(----)を行頭に書くと、水平線になります。

●強制改行

- 行頭を --. にすると改行 (<br>)が挿入されます。

●ハイパーリンク
- http://www.mztn.org/ のようなURLは自動的にリンクになります。
  URLの終わりが空白か行末であることが必要です。

[[テキスト|URL]] の形式も可能です。

●画像挿入
以下の形式で画像ファイルを指定します。

[[[テキスト|URL]]]


●テーブル
- ピリオド(.)を行頭に書くと、テーブル(表)のタイトル行になります。
- コンマ(,)を行頭に書くと、テーブル(表)が作成できます。
- セルの中に等号を２つ(==)入れると、左隣のセルに連結(colspan)します。
- 列方向の連結(rowspan)は || のように文頭に「|」の数で連結数を指定します。
- セルの左右に空白を入れると左右、中央揃えができます。

.タイトル行,左揃え,右揃え,中央揃え,||縦連結
,セル,1, 2, 3
,セル,1, 2, 3 ,|| 4
,横連結,1,==,==

●整形済み領域
- --( と --) で囲まれた行は書いたまま表示されますが、リンクや文字飾りは有効です。
- ---( と ---) で囲まれた行はリンクや文字飾りも書いたまま表示されます。
- ----( と ----) で囲まれた行はリンクや文字飾りも書いたまま表示されます。
- -----( と -----) で囲まれた行はリンクや文字飾りも書いたまま表示されます。
- スタイルシートで表示形式を変更できます。

--(
''黒ボールド''
'''赤ボールド'''
http://www.mztn.org/
[[Jun's Homepage|http://www.mztn.org/]]
[[[logo|./rvtlwiki.png]]]
--)

●定義形式リスト

- コロン(:)を行頭に書くと、用語とその説明文のリストの形式となります。

:見出し:行を * で始めます。
:リスト:行を - で始めます。
:整形済みテキスト:段落を ---( ---) などで囲みます。
:表:行を 「.」または「,」で始めます。セルの区切りは「,」です。

●コメントフォーム

- 行頭に「?T」を書くとそのページの先頭に入力フォームが表示され、
  入力内容がページの先頭部分に書き込み時間とともに書き込まれます。
- 行頭に「?B」を書くとそのページの先頭に入力フォームが表示され、
  入力内容がページの最後部に書き込み時間とともに書き込まれます。
- 入力したテキストは整形ルールにしたがって変換されます。

■最新情報
-----------------

この文書以外の情報やサンプルプログラム、rvtlの最新情報は
http://www.mztn.org/ を参照して下さい。

rvtl を使ってプログラムを作成された方は mizutani.jun@nifty.ne.jp まで
お知らせください。http://www.mztn.org/ で紹介させて頂きます。


■ライセンス
-----------------

このソフトはフリーソフトウェアです. GNU General Pulic Licenceにしたがって
自由に使用，配布，改変して頂いてかまいません。

著作権は 水谷 純<mizutani.jun@nifty.ne.jp> と森竹 俊夫
<moritake.toshio@mail.dokodemo.dynalias.net>が保有しています。
本ソフトウェアによって生じた損害について著作者は責任を負いません。
また、著作者はバージョンアップの義務を負いません。

