InuBBS version 0.5
                                README
                   Copyright (C) 2002-2009 Dai Sato
                            satodai@w3m.jp


InuBBS とは：
InuBBS は、シンプルな WebBBS です。
かつて黒木さんが作った簡易掲示板システム 
http://www.math.tohoku.ac.jp/~kuroki/pub/kurokibbs/
を改造しつつ使っているうちに、大幅に書き直したい部分が増えて来たので、
いっそ最初から書いてしまえ。…というのがきっかけでした。
最新版は次の URL からどうぞ。
http://dog.w3m.jp/software/inubbs/


作者：
佐藤 大'
satodai@w3m.jp


このパッケージについて：
次のファイルが同梱されています。

・README（このファイル）
・inubbs.cgi（設定ファイル兼みかけの本体）
・inubbs.pl（実質的な本体）
・jcode.pl
・cgi-lib.pl

このうち jcode.pl は Kazumasa Utashiro <utashiro@iij.ad.jp> さんの作で、
version 2.13 を使っています。最新版は
http://www.srekcah.org/jcode/
から入手できます。

また cgi-lib.pl は Steven E. Brenner さんの作で、version 2.18 を使って
います。最新版は
http://cgi-lib.berkeley.edu/
から入手できます。

投稿をメール通知するには、生田昇さん作の mime_pls に入っている mimew.pl 
が必要です。これは以下の URL から入手できます。Ver. 2.02 で動作確認済。
http://www.cc.rim.or.jp/~ikuta/mime_pls/

この他に Peter Jipsen さん作の ASCIIMathML.js を使って、数式を簡単に
扱えるようになります。ASCIIMathML.js の最新版は
http://www1.chapman.edu/~jipsen/mathml/asciimath.html
から入手できます。動作確認は version 2.0.1 で行いました。


配付などについて： 
InuBBS はフリーウエアです。このパッケージは基本的に自由に使用・配付・
改変する事ができます。ただし配付の際には、上記の全てのファイルが揃った
状態で配付して下さい。改変の場合には，後学のためにその内容を知らせていた
だけると助かります。 


特徴：
InuBBS には次のような特徴があります。

・ASCIIMathML.js を利用して、数式を簡便に表示できる。
・新規投稿を指定したメールアドレスに通知できる（要 mimew.pl）。
・各掲示は不変の URL を持ち、Message-ID がそのリンクになっている。
・書き込むとき以外は cgi を使わない。
・掲示板に書き込む前に、必ず preview させる。
・書き込み中の半角カナは、勝手に全角に修正する。
・subject と本文が ASCII だけで書かれた投稿を拒否できる。
・jweblint があれば、文法的に問題がある HTML の投稿を拒否する事が出来る。
・掲示板のヘッダ部分に、任意のリンク、任意の文章を容易に表示できる。
・月ごと、または指定したサイズごとに自動で log を回す。


機能追加：
今後こんな機能を追加したいと思ってます。

・掲示を出すときに分野を指定でき、分野ごとの log もできる。
・分野わけに対応した検索機能の追加。
・post_log の扱いが中途半端なので、これをなんとか…


インストール：
まず、ライブラリ群（inubbs.pl, cgi-lib.pl, jcode.pl）を同じ directory に
置きます。ここを inubbs.cgi で $LIB_DIR に指定します。この directory は 
web から見える必要はありません。これでインストールは終了です。
新着掲示をメール通知したい場合は、mimew.pl も $LIB_DIR に置いて下さい。
数式を扱いたい場合は、ASCIIMathML.js をダウンロードして web アクセスが
可能な directory に置き、document_root からの path を $USE_FORMULA に
set して下さい。


掲示板を作る：
http でアクセスできるところに 掲示板用の directory を作り、そこに inubbs.cgi
を置きます。ここが $TOP_DIR になります。さらに $SPOOL（default では spool）
の名前の directory を作り、chmod 777 します。
次に inubbs.cgi を編集し、いくつかの変数（"Variables" の部分）に適切な値を 
set します。設定が必要な行には "YOUR" という文字列が含まれているので、これ
を検索しながら作業すると良いでしょう。 
その他に、$USE_COPY, $SIZE, $WEBLINT はシステム環境や好みに合わせて設定
してください。$USE_COPY は symbolic link が使えない場合に設定します。$SIZE
は log まわしのタイミングを月毎ではなく file size で決めたい場合、$WEBLINT
は post された掲示の HTML 文法を確認したい場合に設定します。
また、"Variables for BBS header" の部分は掲示板の見栄えに影響する部分なの
で、お好みに応じて変更してください。
複数の掲示板を作る場合も、この「掲示板を作る」の作業を繰り返せば ok です。


掲示を出す：
インストールしてから始めて掲示を出すときは、inubbs.cgi に直接アクセスして
ください。掲示を書き込み画面が表示されます。書き込み方法は見たままだと思う
ので細かい説明は省きますが、preview すると post ボタンが現れます。修正が
必要なければ post ボタンをクリックして書き込みを実行します。すると、$SPOOL
以下に次の file が作成されます（file name は default の場合）。

bbslock
　lock file なので、サイズはゼロ。
logYYYYMM.html
　新しい順の掲示。
log.html
　最新の logYYYYMM.html への symbolic link。
untilYYYYMM.html
　時間順の掲示。
log_rev.html
　最新の untilYYYYMM.html への symbolic link。
old.html
　今までの log の一覧。当然ながら、最初は当月分のみ。
post_log
　掲示書き込みの log。
.month
　最新の掲示が出た月数。logYYYYMM.html の YYYYMM の部分をメモってある。
.seq
　最新の掲示が出た log の通し番号。file size で log をまわす場合に、.seq の
　代わりにできます。


機能を追加するファイル：
option として次の file を $TOPDIR に置いておくと便利です（多分）。

howto.html
　この file に、書き込み方の説明などを HTML（の断片）で書いておきます。
　書き込み画面に表示されます。
message.html
　掲示板のヘッダ部分表示する、管理者からのメッセージを HTML（の断片）で
　書いておきます。
rule.html
　この掲示板のルールなどを書いておく、独立した HTML file です。ヘッダ部分
　から自動的にリンクが張られます。
links.html
　掲示板附属のリンク集として使う、独立した HTML file です。ヘッダ部分から
　自動的にリンクが張られます。


digest 機能：
digest 機能は、http://.../inubbs.cgi?digest などという URL で最新 log file
の掲示のリストを表示する機能です。私は w3m -dump と一緒に使って ML に最新
掲示リストを送りつけるのに使っています。また、
http://.../inubbs.cgi?digest=200203 などとすると 2002 年 3 月の掲示のリスト
が表示されます。


数式の扱い：
数式を扱うように（$USE_FORMULA に ASCIIMathML.js の path を）設定した場合、
投稿する掲示の中のバックスラッシュで囲んだ部分を対象に、数式として表示する
ボタンが現れます。また数式がいくつも登場する場合の利便性のために、その掲示
全体を数式として表示するボタンも現れます。
数式の表現方法については、ASCIIMath のサイトを参照して下さい。
http://www1.chapman.edu/~jipsen/mathml/asciimath.html


InuBBS の歴史：

2009/05/02
version 0.5 公開。
デザイン制御を <STYLE> または CSS file に分離。
投稿があったことをメール通知する機能を追加。
ascii だけで書かれた投稿を拒否する機能を追加。
ASCIIMath で書かれた数式を表示する機能を追加。

2003/04/03
version 0.4 公開。
$GOTOLAST の文字コード変換忘れを修正。

2003/03/14
生 URL 入りの掲示を preview するたびに <a>...</a> が増殖する bug を fix。

2003/03/12
HTML 4.01 Transitional に対応。

2003/02/18
検索機能を追加。

2003/02/03
post log を log.html と同時に回すようにした。
tab 区切りだった post log を space 区切りに format 変更。
中途半端ながら digest 機能を追加。

2002/11/04
reverse log file の作成を on/off するスイッチを追加。
とりあえず version 0.4a として公開。

2002/11/03
inubbs.cgi をライブラリ化し inubbs.pl に、common.ph を inubbs.cgi にした。
この変更により、複数の掲示板の作成が非常に楽になった（はず）。

2002/11/01
log まわしの bug（$reallog に値を格納するタイミング）を修正。
log.head を使わないよう変更。関連の README の記述も削除。
LogHead() 関連のもろもろを整理。

2002/10/16
version 0.3 公開。

2002/10/15
file size が一定以上になったら log をまわす機能を追加。変えたくなった時に
common.ph の $SIZE を設定すれば ok。
先月分への自動リンク機能は symlink() を使わない場合にも対応した。
ただし、log まわしを月毎からサイズ（もしくはその逆）に変更した時にはリンク
はつきません。

2002/09/25
$READNEW の link を元に戻した。
月が変わって log が回ったときに、先月分に自動でリンクを張る機能を追加。
ただし symlink() を使っていない場合は未実装。
ごく簡単な index file ($SPOOL/$INDEX_HTML) を生成する機能を追加。

2002/08/28
symlink() が不都合な場合、common.ph の設定変更で copy() を使えるよう変更。
二重投稿の check を実装。
$READNEW の link を log.html?yyyymmddhhmmss という形式に変更。

2002/08/12
version 0.2 公開。
sub ConvCommonMsgVarsTo を変数の追加と修正。（やぎさん Thanks）
その他、$KANJI_CODE = 'jis' で使うための変更。
ちょっとした修正もろもろ。

2002/08/08
message が空の場合、preview で error 表示、post で fatal error とした。

2002/08/06
log.html などの名前を common.ph で設定できるように変更。
投稿終了画面の最新掲示へのリンクを $LOG.html?yyyymmddhhmmss に変更。

2002/08/02
version 0.1 公開。

2002/07/24
動作確認 BBS 公開。

2002/07/19
書き始め。


===== おまけ =====

黒木掲示板からの移行：
まず、chmod 666 old.html しつつ、心の準備をします。
何はともあれ、BBS のある directory で symbolic link が使えるかどうかを確認
してください。symbolic link が使えない場合は、common.ph の $USE_COPY の行
を忘れずにアンコメントしてください。こうすると、symbolic link を張る代わり
に file の実体を複製するようになります。
以上について問題がなく、さらにちょうど月が変わったところで、今月分の掲示は
まだ出ていないという場合、ひじょーにラッキーです。この場合には、log.html を
logYYYYMM.html（YYYY は西暦年数、MM は先月の月数。200207 とか）という名前に
変えてください。あとは新しい掲示を出すだけで ok です。
すでに今月分の掲示があるという場合は、log.html を logYYYYMM.html（今度は
今月の月数で）という名前に変えて、log.html はこの file への symbolic link に
します（$USE_COPY をアンコメントしたなら logYYYYMM.html のコピーを log.html
という名前で作る）。それから logYYYYMM.html を untilYYYYMM.html という名前
に複製しておきます。これは時間順のファイルになるので、今のうちに掲示の順番
を入れ換えておくとバッチリです。そして、untilYYYYMM.html への symbolic link
（または複製）として log_rev.html を作ります。
これで新しい掲示を出せば良いはずですが、念のために backup を取っておくのが
良いでしょう。