Archives - blosxom starter kit

Index

blosxom starter kitとは？

シンプルでかつ拡張性の高いCGIスクリプトであるblosxomを「blogっぽく」というコンセプトで簡単に導入できるようにしたアーカイブです。具体的にどのようなものが出来るかは、動作サンプルを参照してください。

あくまでも簡単導入セットであり、恒久的に使うことは想定していません。できることならこれを利用し、blosxomの挙動を知った上で、一からblosxomを構築することをお薦めします。その方がオモシロイと思います。

オリジナルのblosxomとの違いは、

などです。

何か質問がある方は、メールやメーリング・リストなどでどうぞ。

ファイル一覧

"["と"]"でくくられているのはディレクトリです。

プラグイン一覧

back_and_forth
エントリ個別のページに、前後のエントリを辿るリンクを表示するプラグインです。
archives
年ごと及び月ごとのページへのリンク・メニューを表示するプラグインです。
bookmarklet
Bookmarkletでwikieditishプラグインを呼ぶ機能を提供するプラグインです。
categories
カテゴリごとのページへのリンク・メニューを表示するプラグインです。
css
外部CSSファイルのパスを指定するプラグインです。
date_title
年ごと及び月ごと、日ごとのページのタイトルに、年月日を追加して表示するプラグインです。
entries_index
エントリの日付けを作成日時で固定するプラグインです。
entry_title
エントリ個別のページのタイトルに、そのエントリのタイトルを追加して表示するプラグインです。
google
Googleを利用してサイト内検索を行うCGIを呼び出すためのパラメータを指定するプラグインです。
rss10
RSS 1.0を配信する機能を提供するプラグインです。
wikieditish
ブラウザ上でエントリの編集及び作成する機能を提供するプラグインです。
writeback
コメントを投稿する機能とTrackBackを受信する機能を提供するプラグインです。

システム要件

基本的にはblosxomのシステム要件と同じです。しかしながら、いくつかの機能は以下のPerlモジュールが利用できる環境であることが必要です。

HTTP::Request::Common
wikieditishプラグインで、TrackBackを送信する機能を有効にする場合
Jcode
writebackプラグインで、受信したTrackBackの文字コードを変換する場合
LWP::Simple
bookmarkletプラグインで、TrackBack ping URLを探す機能を有効にする場合
LWP::UserAgent
wikieditishプラグインで、TrackBackを送信する機能を有効にする場合

インストール

通常のCGIスクリプトの設置とあまり変わりません。具体的には以下のような手順になります。

  1. ディレクトリ構造を維持したままZIPファイルを展開
  2. サーバーに専用のディレクトリを作成し(推奨)、FTPで全てアップロード(*1)
  3. CGIやディレクトリにそれぞれ適切なパーミッションを割り当て(*2)
  4. ブラウザでchkfullpath.cgiを開き、フルパスを確認
  5. config.cgiの内容を環境及び好みに合わせて編集

これでインストールは完了です。ブラウザでblosxom.cgiにアクセスすれば同梱のサンプル・エントリが表示されるでしょう。同梱のサンプル・エントリ(entries/first_post.txt)は、確認した後削除して構いません(そのままでも問題はないです)。

アンインストール

専用のディレクトリを作成した場合は、アップロードしたフォルダごと削除するだけです。

使い方

基本的にはオリジナルのblosxomの使い方と変わりません。オリジナルのblosxomの使い方については説明する気はないです。公式サイトで公開されているプラグインも、オリジナルで使うときと同様に利用できます。フレーバーについても書き方は同じです。

blosxom starter kit特有の使い方というものは特にありませんが、わかりにくいところは多々あると思います。しかし、僕にはそれを全て網羅する気力はありません。とは言うものの放置ではまずいと思うので、良くある質問というセクションで質問を受けたことを随時(余裕がある時に)追加していきます。

良くある質問

ほとんどのファイル文字化けして読めないんですが、あなたはこれ読めるんですが？
全てのファイルの文字コードはUTF-8で、改行コードはLFになっています。UTF-8を読むことのできるエディタで開いてください。文字化けしているのは僕も読めません。
空のファイルがいくつかありますが、この邪魔臭いのは何？
オリジナルのblosxomの存在しないフレーバーを参照した場合、デフォルトに設定してあるフレーバーが読み込まれるという仕様を回避するためのダミー・ファイルです。削除してはいけません。
UTF-8とかウザイので、Shift_JIS(またはEUC-JP)で使わせてくれよ
基本的にはUTF-8で扱うことを前提にしています。しかしながらShift_JIS(またはEUC-JP)で運用することも可能です。その場合は、全てのファイルの文字コードをShift_JIS(またはEUC-JP)に変換した上、UTF-8と書かれている部分を全てShift_JIS(またはEUC-JP)に書き換えてください。
パーミッションが・・・グハッ・・・
サーバーの環境に依存するので、とてもreadme.txt以上のことは言えません。トライ・アンド・エラーでがんばるしかないかもしれません。
月ごとのページに飛ぶリンクが和名なんですが、僕は古文が3(10点満点で)だったので、和名の月とかわかんねーよ
僕もわかりません。単に日本語も使っても大丈夫！ということを教えたかっただけですので、@archives_monthnameを英語とか数字とかわかりやすいものに好みで設定してください。英語もよくわからなくなるけど。
$urlが自動設定されるとかもしかして嘘？
サーバーの環境に依存します。場合によってはうまくいきますが、多くの場合はうまくいかないようです。設置した環境に合わせて、http://で始まるURLを指定してください。
新規エントリってどう投稿するのさ
blosxomでもそうですが、$datadir(デフォルトでは/entires)に$file_extension(デフォルトではtxt)で指定した拡張子のファイルを作るだけです。そのファイルの構造はアーカイブに含まれている/entries/first_post.txtを参照してください。
wikieditishで新規エントリってどうやるのさ
wikieditishで存在しないエントリのパス・ファイル名をを指定した場合は、新規投稿になります。ブラウザのアドレスバーから適当に怪しげなパスとファイル名を指定して試してみてください。
Jcodeモジュールなどを導入する方法を教えてエライ人
個別に導入する方法はあることはあるのですが、トラブルの元になりますので、説明しません。基本的にはサーバーの管理者にインストールを頼んでください。
クッキーを割り当てるドメインとかクッキーっておいしいの？
writebackプラグインでクッキーを利用して、コメント投稿者の名前とURLまたはメール・アドレスを記憶する機能に必要な設定です。CGIモジュールの仕様に従った設定になります。詳しくはCGIモジュールのHTTPクッキーを参照してください。
静的生成を行うとうまく動いてないようなんですが？
静的生成に関してはチェックしていません。静的生成する場合には素のblosxomでどうにでもなると考えていることと考慮すべき点が多すぎてとても手が回らないことが主な理由です。

ダウンロード

最新バージョン
blosxom starter kit 1.1.3
以前のバージョン

更新履歴

2005/02/23 1.1.3
  • writebackで生成されるa要素のrel属性の値に"nofollow"を指定するようにした
  • wikieditishが正常に設定を読み込んでいない不具合を修正した
2004/08/13 1.1.2
  • foot.wikieditishのマークアップのミスを修正した
  • JavaScriptによるwikieditishでのプレビュー機能を追加した
  • writebackのコードを一部変更した
2004/08/13 1.1.1
  • wikieditishのTrackBack送信機能のバグを修正した
2004/08/12 1.1
  • wikieditishのメッセージを多少わかりやすくした
  • wikieditishのTrackBack送信機能で、タイトルにHTMLタグが含まれている場合に削除する処理を追加した
  • writebackにコメント・スパムへの対策を追加した
  • writebackのデータファイルにリモート・ホストとリモート・アドレスを記録するようにした
  • wikieditishのTrackBack送信機能で、パラメータとして送信する文字コードの設定を追加した
  • writebackのスパム対策の有効・無効を切り替える設定を追加した
2004/08/07 1.0.3
  • 任意のJavaScriptコードを実行される脆弱性に対処をした
2004/08/07 1.0.2
2004/07/01 1.0.1a
  • modifiedのつづりが間違ってたので修正した
2004/06/23 1.0.1
  • flavour(foot.html, foot.htm, foot.wikieditish)にblosxom starter kitを利用していることを示すリンクを入れた(削除可能)
  • writebackで改行をbr要素に変換するようにした
2004/04/17 1.0
  • Initial release

参考資料

脚注

*1 アップロード
readme.txtとabout_config.txtは必要ありません(アップロードしても問題はないです)。
*2 パーミッション
サーバーによって適切なパーミッションが変わってくるので一概には言えません。一般的な割り当てについては、同梱のreadme.txtを参照してください。