SWEEP - WEB Based NNTP front end

【はじめに】

これはJava Servlet APIを利用して作成されたWikiクローンです。

Wikiは参加者が自由にページを追加・削除・編集できるWebページ群を作るWebアプリケーションです。
Webで動作する掲示板とちょっと似ていますが、掲示板が単にメッセージを追加するだけなのに対して、
Wikiは、Webページ全体を自由に変更することができます。

このWikiは PukiWikiは1.3.3をベースにJavaにポーティングしたものです。
扱う文法も（実装にミスがなければ）同じで、特殊なプラグインを利用していなければ
データディレクトリ構成を変えるだけで過去のデータをすぐに取り込むことができます。

【特徴】

このWikiには次の特徴があります。

-PukiWiki1.3に準拠するテキスト変換規則を採用しています。
-Javaで実装されています。J2EE1.3に準拠したアプリケーションサーバーで利用できます。
-Javaで扱える文字を利用できます。日本語も利用できます。
-すべてのデータはテキストファイルに保存されます。
-InterWikiをサポートしています。

【動作条件】

次のJava環境に依存しています。

J2SE1.3
J2EE1.3
Servlet 2.3
JSP 1.1

次の外部パッケージに依存しています。

log4j 1.2.x
Jakarta ORO 2.0.6
Jakarta commons-beanutils
Jakarta commons-fileupload-1.0
Jakarta commons-jrcs
com.oreilly.servlet

依存する外部パッケージは配布パッケージにあらかじめ含めてあります。

作者の手元では次のJAVAアプリケーションサーバーで動作確認しました。

JBoss3.0.7 with Jetty
JBoss3.2.5 with Tomcat
WebLogic8.1JSP2

【入手方法】

最新版は SourceForge.jp より入手できます。

http://sourceforge.jp/projects/sweep/

Javaアプリケーションサーバで稼動するWARとして配布されています。
sweepの機能の一部として実装されています。
sweep-wiki パッケージのwiki.warを取得してください。

【インストール】

一般的なWARのデプロイ手順に従ってインストールできます。
デプロイ後、Webブラウザからコンテキストに対応する
URLにアクセスすると利用できます。

作者の手元ではJBoss3.0.xで動作確認しています。
JBossの場合はホットデプロイを採用しているのでデフォルトの設定だと
$JBOSS_HOME/server/default/deploy フォルダに“wiki.war”をコピーするだけです。
http://localhost:8080/wiki をブラウザでアクセスすると
（速やかにリダイレクトされます）Wikiを利用できます。

WEBブラウザはWindows Server 2003の
Microsoft Internet Explore 6.0で動作確認しています。

《JBoss3.0.8の場合》

ここで説明している内容はWikiを利用するための基本的な操作だけです。
本格運用するには他の資料（書籍等）も参考にしてください。

JBossは事前にJ2SE1.3.1 あるいはそれ以降のJava VMを必要とします。
SunのJVMを利用するなら http://java.sun.com の Downloadsのリンク先より入手できます。
JVMのインストール方法はここでは説明しません。（サイトの説明を参考にしてください。）
SunからはJ2EEパッケージを入手する必要はありません。
JBossそれ自体がオープンソースなJ2EE実装のひとつだからです。
J2SEをインストールしているディレクトリを環境変数 JAVA_HOMEに設定します。

例：
> set JAVA_HOME=c:\j2sdk1.4.2_04

Windowsではコントロールパネルの「システムのプロパティ」の「詳細設定」「環境変数」で
ユーザー環境変数として登録しておくがよいでしょう。

JBossは http://jboss.org より入手できます。Downloads のリンクをたどって入手します。
ここでは2004年8月現在最新の jboss-3.0.8.zip を取得したものとして説明します。
jboss-3.0.8.zip は WEBコンテナとしてJettyが内蔵されています。

jboss-3.0.8.zip をインストールしたいディレクトリに展開します。
なるべくルートに近いほうがよいでしょう。
私はWindowsではシステムドライブ直下に展開しています。(c:\jboss-3.0.8 のように)
JAVAの標準コマンドの一つのjarコマンドでもzipファイルを展開できます。
例：
> jar xf jboss-3.0.8.zip

JBossは展開するだけでインストールが完了します。
展開したディレクトリを以下の説明では$JBOSS_HOMEと表記します。
（実際に環境変数を定義する必要はありません）

$JBOSS_HOME/binにrun.bat (Windows向け) や run.sh（UNIX向け）が含まれます。
$JBOSS_HOME/bin ディレクトリに移動してこのスクリプトを動かします。
Windowsではエクスプローラーから run.bat を実行する（ダブルクリック）でも構いません。

コンソールに JBoss XXXXXX Started in 0m:7s:265ms のような記述が現れれば
JBossの起動に成功しています。
http://localhost:8080/　にアクセスすると、何らかの反応があるはずです。

JBossを停止するには、このコンソールを閉じます。
正確には J2SE1.3のVMからサポートされた機能の、
UNIXでいうシグナルSIGINTを受けて後始末処理が走ります。

Windowsでは「×」ボタンで閉じると「プログラムの終了」ダイアログが
出てきたりしますが、選択しないで待っておいてください。
「すぐに終了」を選択すると、終了プロセスが中断されることになります。

Wikiを動かすにはJBossが動作している状態で、
$JBOSS_HOME/server/default/deploy フォルダに“wiki.war”をコピーします。

コンソールに Deployed package: XXXX/wiki.war と表示されれば、
デプロイに成功しています。
WEBブラウザで　http://localhost:8080/wiki　にアクセスすると、
（速やかにリダイレクトされます）Wikiを利用できます。

《JBoss3.2.5の場合》

取得するアーカイブが jboss-3.2.5.zip に変わるくらいで、
JBoss3.0.8と場合と手順はほぼ同じです。

こちらはWEBコンテナがTomcat5になっています。

《WebLogic8.1JSP2の場合》

wiki.warのDDを若干修正する必要があります。

“WikiServlet”の初期パラメータの“opt.needEncodingChange”の項を削除してください。
名前を“xopt.needEncodingChange”のように適当に変えるのでも十分です。

その後、WebLogicコンソールから wiki.war をデプロイします。
デフォルトの設定なら http://localhost:7001/wiki にアクセスすれば
（速やかにリダイレクトされます）Wikiを利用できます。

【Wikiのデータフォルダ】

デフォルトではアプリケーションサーバーのワークディレクトリ
(JBossでは$JBOSS_HOME/bin)に“wiki”フォルダを生成して
それ以下に、コンテンツを生成します。

しかし、サーバー起動ユーザのホームディレクトリ（JAVAのシステムプロパティ
${java.home}に格納されているディレクトリ）に
同名のディレクトリ(wiki)があればそちらが優先して利用されます。

バックアップはそれ以下をアーカイブすればよいでしょう。

“.wiki”ファイルがあれば、WikiServletはそれをWikiのデータフォルダとして認識します。
WARをデプロイする前にコマンドラインで次の操作をしておくとよいでしょう。(UNIX向け)

$ mkdir $HOME/wiki
$ touch $HOME/wiki/.wiki

あるいはwiki.warをデプロイ後に“wiki”データーフォルダを移動するのでもよいです。

$ mv $JBOSS_HOME/bin/wiki $HOME

データフォルダ名はDD(web.xml)のサーブレットの初期パラメータ“dataFolder”で調整できます。
“wiki”を別の名前に調整したら、それに置き換えて考えてください。

デプロイした直後は、コンテンツは何もありません。
がんばって作成してください。

【テキスト整形のルール】

通常は入力した文字がそのまま出力されますが、
以下のルールに従ってテキスト整形を行うことができます。

空行は段落の区切りとなります。

HTMLのタグは書けません。

文字列の装飾
''ボールド'' のようにシングルクォート二つではさむと、ボールドになります。
'''イタリック''' のようにシングルクォート三つではさむと、イタリックになります。
%%打ち消し%% のようにパーセント二つではさむと、打ち消し線がつきます。
((注釈)) のように括弧二つではさむと、注釈が作成されます。
COLOR(rrggbb): と書くと文字色が指定できます。(rrggbb へは6桁の16進数値か、色名を指定)
SIZE(n): と書くと文字の大きさが指定できます。(n へは文字の大きさをピクセル数値で)
CENTER: と書くと文字列を中寄せにできます。
LEFT: と書くと文字列を左寄せにできます。
RIGHT: と書くと文字列を右寄せにできます。

見出し
* を行頭に書くと見出しになります。* ** *** の3レベルまであります。
#contents を行頭に書くと、大見出しと小見出しの目次が作成されます。

: を行頭に書くと用語と解説文が作れます。
:用語1:いろいろ書いた解説文1
:用語2:いろいろ書いた解説文2
:用語3:いろいろ書いた解説文3

行頭と行末に | を書くと表組みができます。
この場合、それぞれのカラムの始まりが行頭として解釈されるので、
各種整形ルールを記述する場合は注意が必要です。| と | の間で一行として考える必要があります。
|''Category:A''|''Category:B''|''Category:C''|
|Objective|for AI|Other|
|Java|LISP|Assembla|

リンク
WikiNameのように大文字小文字を混ぜた英文字列を書くと、WikiNameのページ名になります。

　[[sng]]のように二重の大かっこ[[ ]]でくくった文字列を書くと、
　Wikiのページ名になります。大かっこの中にはスペースを含めてはいけません。
　日本語も使えます。この表記はブラケットネーム(BracketName)と呼ばれます。

　[[sng:FrontPage]] のように書くとInterWikiNameになります。
　[[factage:http://factage.com/]] のように書くと「factage」の文字に対して
　http://factage.com/ へのリンクを貼ることができます。

　http://factage.com/ や foo@factage.com のようなURL・メールアドレスは自動的にリンクになります。

日付・時刻の挿入
　date? を書くと、更新時の日付に置換されます。
　time? を書くと、更新時の時間に置換されます。
　now? を書くと、更新時の日付と時間に置換されます。

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

行頭がスペースで始まっていると、その段落は整形済み扱われます。
一切の他の整形ルールの影響を受けません。プログラムを書き込むときに使うと便利です。

// を行頭に書くとその行をHTMLタグでコメントアウトします。

> を行頭に書くと、引用文が書けます。>の数が多いとインデントが深くなります
> >> >>> の3レベルまであります。このとき、行末にチルダ ~ があると改行します。

#で始まるキーワードはプラグインとして実装されています。
プラグインの利用方法はこの記述とは別にドキュメント化します。

【謝辞】

PukiWiki Develpers Team の皆さんに感謝します。
JavaとJBossパッケージに含まれる様々なパッケージの開発者の皆さんに感謝します。
Apacheプロジェクトにかかわる皆さんに感謝します。
配布の場所を提供してくれている SourceForge.jp 運営にかかわる皆さんに感謝します。

【関連リンク】

PukiWikiホームページ http://pukiwiki.org/
sweep wiki ページ http://sweep.sourceforge.jp/wiki
JBoss一次配布元　http://jboss.org
本家のWikiWikiの作者(Cunningham & Cunningham, Inc.) http://c2.com/