KeiSpade

Wikiの設定

2012-04-28T03:32:28+09:00

細かな設定を行う場合は、dat/kspade.confを作成、編集してください。

#はコメントになります。

Wikiの全体の設定

Wikiのタイトル

SiteName [site name]

Wikiタイトルです。大きく上に表示される他、HTMLのタイトルにもなります。

Wikiの説明

SiteDescription [site description]

Wikiの解説文です。

ex. SiteDescription 私のWikiです

Wikiスクリプトのファイル名

ScriptName [script filename]

index.plのファイル名を変更したときは、この設定項目を追加してください。

ex. ScriptName index.cgi

Wikiスクリプトのある絶対URL

ScriptAbsolutePath [script uri without scriptname]

スクリプトのファイル名を除いたURLを書きます。具体的には、

http://www.example.com/wiki/index.pl

がスクリプトのURLだとすると、

http://www.example.com/wiki/

を記入します。

多くの場合、設定しなくても動作しますが、SSLを標準の443番以外で使用していたりするとこの設定が必要になる場合があります。

ex. ScriptAbsolutePath http://www.example.com/wiki/

アップローダ

アップローダのファイル名

Addons::upl::UploaderName [uploader script filename]

標準アドオンであるupl.cgiのファイル名を変更したときは、この設定項目を追加してください。

ex. Addons::upl::UploaderName uploader.cgi

サイドバーの設定

サイドバーのページ一覧数

SidebarPagesListLimit [number]

サイドバーに表示されるページ一覧の数を設定します。

ex. SidebarPagesListLimit 10

スキン

css/ ディレクトリや html/ ディレクトリ内のファイルを変更することで、お好みのデザインやレイアウトに変更することができます。

その他

読み取り専用モード

ReadOnly 1

リードオンリーになり、Wikiが読み取り専用で書き込めなくなります。

レンダーキャッシュ

RenderCache 1

ある環境では、この設定により、表示が0.172 秒から 0.03 秒へ高速化（TopPageの例）しました。

新規ページの保存時、または編集完了時にパース結果がcacheディレクトリに格納され、表示時にそれを表示します。

ただし、最初に設定を有効にした後、途中で設定を無効にして編集し、再度有効にすると、最初にパースされたページがキャッシュから読み込まれてしまうため、一度有効にした設定を無効にした場合で、再度有効化する場合はcacheディレクトリ以下のファイルを全消去してください。この場合は、再編集するまでキャッシュはされません。

インストール方法（レンタルサーバ）

2012-04-28T03:32:18+09:00

レンタルサーバでは、シェルを操作できる権限がないことが多々あります。しかし、一部のレンタルサーバを除いては、簡単な方法で設置することができます。

Sakura VPSや、ServersMan VPSなどは、インストール方法をご覧ください。

動作を確認したレンタルサーバ

XServer (http://www.xserver.ne.jp/)
- index.plをindex.cgiに，upload.plをupload.cgiに変更すると動作します
AXXISS land.to (http://land.to/)
- index.plをindex.cgiに，upload.plをupload.cgiに変更すると動作します
CORESERVER (http://www.coreserver.jp/)
- 特別な設定は必要ありません

設置方法

データベースの準備

レンタルサーバ管理者に指定された、CGIの動作するディレクトリに、KeiSpade CMSをディレクトリごとコピーし、

KeiSpade-CMS/にdatというディレクトリを作ってください。

このdatというディレクトリは、Webサービスデーモンのユーザーが読み書きしますので、適切なパーミッションに設定してください。

いくつかのサーバは、"index.pl"を実行することはできません。その場合、"index.cgi"に変更します。スクリプトのファイル名を変更した場合は、設定を変更することをお勧めします。Wikiの設定も参照してください

データベース・テーブルの作成

設置が終わったら、

http://servername/（設置したディレクトリ）/KeiSpade-CMS/index.pl

にアクセスしてみてください。（servernameはKeiSpadeを設置したサーバのホスト名）

動作を確認したら、お好みに合わせて Wikiの設定を行ってください。

もし上手くいかないときは

datディレクトリのパーミッションを777に設定してください。ただしこれはあまり推奨されません。

index.pl や upload.pl のファイル名ではなく、index.cgi や upload.cgi に変更しないと動作しないことがあります。 Wikiの設定をご覧のうえ、ファイル名を適宜変更してください。

更新履歴

2012-04-28T03:45:11+09:00

2012-04-28 (0.4.3)

レンダーキャッシュの実装
- パース結果をキャッシュする設定を有効にすることにより、表示までの時間を140ミリ秒ほど短縮（TopPageの例）
- テキストが少ないページにおいても、最低でも表示速度が3倍程度速くなる
リードオンリーモードの実装
コンフリクトでエラーが起こるバグの修正
エラーログの鎮静化
CSRF対策
DBスキーマの若干の変更

2011-05-06 (0.4.2)

ページ編集後のリダイレクトに関する問題を修正 (thanks to @haruka_yj)

2011-02-04 (0.4.1)

プレビュー機能を追加
ページ名の変更の際にInternal Server Errorになる問題を修正
ページ表示処理の高速化（表示までの時間を0.1秒ほど短縮）

2011-01-31 (0.4.0)

大規模なアップデート。Atomフィード、アドオン、コメントに対応し、その他機能強化とバグ修正が行われている。

0.3.1の仕様変更（リダイレクト）に伴うコンフリクトのバグを修正
HTMLファイルを集約
videoに関する機能を強化
InterWiki Linkを強化
パーサ系のバグを修正（スーパーpre記法で<>が含まれるとおかしくなる）
コメント機能を追加
外部リンクに対してrel=nofollowを追加
アップロード完了時のメッセージを表示
大幅なコードのリファクタリング
- MVCモデルを参考
処理の高速化
Atomフィードを出力する機能を追加
アドオンへの対応

2010-11-10 (0.3.1)

正しいHTTPステータスコードを返すようにした
ページを作成・編集した後にリダイレクトするようにした
InterWiki Linkが利用できるようになった

2010-10-03 (0.3.0)

細かいアップデートだがユーザビリティに大きく影響する。

準メジャーアップデート。

ライブラリのアップデート
細かいバグフィックス
- ページ名の最後にスペースがあると正常に動作しないバグの修正
挙動の改善
- ページ削除後の挙動
- セキュリティの強化

2010-09-20 (0.2.0)

必要と思われる部分をOOP化して、インストールが楽になった。

準メジャーアップデート。

コードのリファクタリング
SQLの処理を最適化
インストールの簡便化
- install.shを同梱
- index.pl?init=yes をしなくてもテーブルを作成するようにした

2010-09-03 (0.1.0)

新規ポスト後の挙動を改善
init後の作成日表示のバグを修正

2010-08-07

ファイル名が空の場合の処理を追加

2010-08-05

編集で衝突が起きた際にdiffを表示するようにした

2010-07-13

実行ファイル名を変更できるように

2010-07-01

footnote追加
デザインを変更

2010-06-23

nofollow属性を追加

2010-06-19

はてな記法を拡張
日付のバグを修正
設定ファイルによる設定ができるように

2010-06-13

アップローダのSHAハッシュ計算で、システム付属のSHAが使える場合はPure Perlを使用しないようにし、アップロード時のパフォーマンスを向上

2010-06-12

添付ファイルを削除する際に、同じファイルを使っている別のページがないか確認するように

2010-06-10

アップロードを非同期化

2010-05-30

サブルーチンを動的に呼び出すようにし、拡張性をあげた

2010-05-07

HTMLファイルを外部化し、拡張性をあげた

2010-05-06

リファクタリング

2010-05-03

Pagesリストを更新順に並び替えるように

2010-02-13

実装はじめました

TopPage

2012-04-28T04:24:37+09:00

KeiSpade (English)

このページのKeiSpade WikiシステムはHTML5を利用しているため、Internet Explorer(*1)で見ることができません。

What is KeiSpade CMS?

KeiSpade CMSは新世代のHTML5に対応した軽量なCMSです。

KeiSpade CMSでのHTML5のサンプルを見る

データ管理にはSQLiteを使用し、Wikiの記述には強力な表現力を持つはてな記法を採用。安全と高信頼性と手軽さを兼ね備えたアプリケーションです。

HTML5準拠により、オーディオ、ビデオなど、あらゆるメディアを効率的に集積・発信できます。

Feature

CMSとして必須の複数カテゴリ分け機能
RDBMSを活かした高速な検索機能
- SQLiteという強力なデータベースエンジンを採用しており、高速な検索ができます
同じ内容のファイルが重複しないアップローダ
- SHAによるファイル名管理で、同じ内容のファイルが重複しないようになっています
HTML5によるダイナミックで軽量なページの作成
Pure Perlでのコーディングによるあらゆるアーキテクチャでの動作
- たとえば、アップローダのSHA計算はOS付属のsha256sumなどを利用しますが、OSによって付属していない場合は自動でPerlベースの計算が実行され、あらゆるプラットフォームで動作します
はてな記法をベースとした強力なWiki記法
- 強力な表現力でありながら書きやすいはてな記法によってWikiを記述できるため、手軽にノートを取るために利用するのはもちろんのこと、高度なページを作成する用途にも利用できます

Download

Stable Version

安定して動作するバージョンです。

Version 0.4.3

Latest Repository Build; Unstable

GitHubで開発されている最新版のスナップショットです。

tarball (latest)
zip (latest)

ユーザー会／メーリングリスト

KeiSpadeのユーザー会ができました

https://groups.google.com/group/keispade/about?hl=ja

Valid CSS/Atom

KeiSpadeは正しいマークアップで書かれています

*1: バージョン8以下

開発者向けの情報

2012-04-28T03:32:23+09:00

アドオンの作り方

KeiSpadeはPerlによるアドオンを使って，機能を拡張することができます．このセクションではその方法を解説します．

概要

addons内に<アドオン名>.cgiというファイルを設置すると，ブラウザからindex.pl?adon=<アドオン名>としてアドオンを呼び出すことができます．

プリインストールされているアドオンとしてupl.cgiというアップローダがありますが，そのファイルはこのようになっています．

#!/usr/bin/perl

package KSpade::Addon::upl;

use strict;
use warnings;
use lib '../lib';
use KSpade;

sub new {
        $main::vars{'Addons::upl::UploaderName'} = 'addons/upl/upload.cgi';
}

sub upload { #...
#例：呼び出されるサブルーチン
#中略
}

1;

解説

まず，package KSpade::Addon::upl についてですが，これはKSpade::Addon::<アドオン名>としてください．

必ずnewとDESTROYサブルーチンを作る

index.pl?adon=<アドオン名> として呼び出すと，必ず new が呼び出されるようになっています．初期化のためのスクリプトをこのサブルーチン内に書くと良いでしょう．

また，アドオンの終了時に必ず DESTROY というサブルーチンが呼ばれます．

newとDESTROYというサブルーチンは必ず記述してください．処理が不要の場合は，空のサブルーチンにしてください．

サブルーチンの呼び出し方

また，

index.pl?adon=<アドオン名>&acmd=<呼び出すサブルーチン名>

をブラウザから呼び出すと，<呼び出すサブルーチン名>に対応したサブルーチンを呼び出すことができます．

例

この二つを押さえたうえで，例を見てみましょう．

この場合，

index.pl?adon=upl&acmd=upload

とすると，上記の　#例：呼び出されるサブルーチン　の部分が呼び出されることになります．

仕様

変数

%main::vars というハッシュ（連想配列）にさまざまな情報が入っています．これには設定ファイルの内容，リクエストされたページ名などが入っています．読み書き可能です．
%query というハッシュには，ブラウザからのクエリが入っています．書き換えないでください．

アドオンが新しくハッシュにキーバリューを追加する場合，

$main::vars{'Addons::<アドオン名>::HogeKey'} = 'fugaValue';

などと，衝突しないようなキーにしてください．

ファイルの入出力

アドオンが読み書きするデータ系のファイルは，ルートディレクトリにあるfiles/ディレクトリを利用してください．

アドオンのライブラリ，画像，オブジェクトなどのシステム系ファイルは，addons/<アドオン名>/以下に置いてください．基本的にこのディレクトリに書き込むことはしないでください．

テーマの作り方

KeiSpadeはhtmlディレクトリのファイルを書き換えることによってデザインを変更できます．このセクションではその方法を解説します．

概要

htmlディレクトリ内のファイルにはシンボルが書かれています．それは

<TMPL_VAR NAME="HtmlBody">

のように，<TMPL_VAR NAME="<キー>"> という形式です．

KeiSpadeは前述の%varsにさまざまなデータを格納しており，このハッシュの任意のキーを指定すれば，シンボルがそのキーに対するバリューに置換されます．

上記のようにHtmlBodyを指定した場合，KeiSpadeがパースした後の本文に置き換わります．