rdlikewikistyle -- VikiWiki 記述スタイルスクリプトパッケージ
はじめに
これは、mopia さんが作成された Wiki Engine である VikiWiki において、 ruby の標準テキストフォーマットである RD 風のスタイルの記述が出来るようにするためのスクリプトパッケージです。
このパッケージには、以下のような機能が拡張された VikiWiki スタイルも含まれています。
- 整形済みテキストで、強調などのマークアップを解釈して出力する機能 (soft verbatim)。
- 任意の span 要素を記述する機能。
インストール
ここでは、記述スタイルスクリプトのインストール方法について述べます。
まず、このパッケージの tarball を展開すると、以下のファイルが取得できます。
rdlikevikiwikistyles/ ... tarball の展開先
style/ ... 記述スタイルスクリプト
extendedvikiwikistyle.rb
rdlikewikistyle.rb
text/ ... 記述スタイルのヘルプファイル
ExtendedVikiWikiStyleHelpPage.ExtendedVikiWikiStyle.txt
RDLikeWikiStyleHelpPage.RDLikeWikiStyle.txt
次に、記述スタイルのヘルプファイル text/*WikiStyle.*WikiStyle.txt の文字コードを、現在使用中の VikiWiki の文字コードに合わせて変更します。文字コード変換には、 nkf 等を利用してください。
そして、 style/*wikistyle.rb を $VIKIWIKIDIR/style 以下に、text/*WikiStyle.*WikiStyle.txt を @conf["BASEDIR"]/text 以下に、それぞれコピーして下さい。
(ここで、 $VIKIWIKIDIR は VikiWiki のインストール先のディレクトリで、 @conf["BASEDIR"] は VikiWiki の設定値 "BASEDIR" で示されたディレクトリです。いずれも vikiwiki.cgi に書かれています。)
そして、以下のようにして、 VikiWiki の設定値 "WIKISTYLES" に "RDLikeWikiStyle" と、"ExtendedVikiWikiStyle" を追加します。設定値 "WIKISTYLES" の変更については、 vikiwiki.cgi の編集により行なって下さい。
"WIKISTYLES" => ["ExtendedVikiWikiStyle", "RDLikeWikiStyle", ...]
なお、 rdlikewikistyle.rb を動作させるには、extendedvikiwikistyle.rb が必要となりますのでどうかご注意下さい。
使用法
上記の記述スタイルについての簡単な書式例は、各記述スタイルのヘルプファイルを参照して下さい。
なお、これらは VikiWiki から [[ExtendedVikiWikiStyleHelpPage]], [[RDLikeWikiStyleHelpPage]] というページとして見ることが出来ます。
謝辞
このドキュメントの最後に、VikiWiki を開発された mopia さん に心より感謝致します。
配布条件
以下にこのパッケージの配布条件を示します。
-
このパッケージは Z80-OOLONG (NAKATSUKA, Yukitaka) が著作権を有します。
and licensed under the Creative Commons - Attribution / Share Alike license.
Please see this note for further details, and contact me about this webpage.