「TiddlyWiki」はjavascriptをベースにしたWiki形式のパーソナルメモツールです。
よくあるサーバアプリケーション型のWikiツールに比べると、動作が軽快で(文書数が多くなると検索が遅くなりますが。)使いやすいため、メモ帳のようにして使っていました。
サーバアプリケーションとして実装するためのクローンやプラグインも公開されていますが、CouchDBをバックエンドにするアダプターを作ったので公開します。
CouchDBは以前の記事で書きましたが、Erlangで書かれた分散データベースです。 RESTfulなAPIを持つため、クライアントサイドのjavascriptから直接データベースへのCRUDができます。
jQueryとCouchDB用のAdaptertとなる、jqCouchを使っています。
- twcouch: TiddlyWiki + CouchDB
(右リックして保存してください。)
使い方
1. CouchDBの設定
CouchDBのインストールと設定はCouchDBのWikiページを参考にしてください。
CouchDBにデータベースを作成します。データベースのURLは http://yourserver/dbname となるようにWebサーバを設定してください。
2. TiddlyWikiの設定
WebサーバのドキュメントルートにTiddlyWikiをおきます。
http://servername/tiddlywiki.html でアクセス可能なように、htmlファイルの名前を変更しておきましょう。
(ファイル名は好きな名前にしてください。)
3. ライブラリのダウンロード
twcouch.jsで必要なライブラリは次の2つです。
どちらもjQueryのページからダウンロードできます。4. twcouch.jsの設定
ダウンロードしたtwcouch.jsの設定を変更します。
[twcouch.js]
config.macros.couchdb = {
servertype: 'couchdb',
hostname: 'servername', <= サーバ名に変更
dbname: 'database' <= データベース名に変更
}
5. twcouch.jsのロード
これまでの設定で、ファイルは次のようにおいてあります。
DocumentRoot +-- tiddlywiki.html +-- twcouch.js +-- jquery.js +-- jqcouch.js
twcouchjsが正しくロードされるようにTiddlyWikiを書き換えます。
POST-SCRIPT の設定に追加します。
[tiddlywiki.html] <!--POST-SCRIPT-START--> <script type="text/javascript" src=jquery.js"></script> <= 追加 <script type="text/javascript" src=jqcouch.js"></script> <= 追加 <script type="text/javascript" src=twcouch.js"></script> <= 追加 <!--POST-SCRIPT-END-->
6. 確認
http://servername/tiddlywiki.html でTiddlyWikiが使えることを確認します。