トップページに戻る

JSLocalWiki

　JavaScriptで記述された、ローカルで動作するWikiクローンです。

JSLocalWikiについて

　アプリケーションサーバ（Webサーバ）へのインストールなしで動作するWikiです。個人のメモ用やWiki入門用に使っていただければ幸いです。
　JavaScriptで記述されていますが、データは、ファイルとして保存されます（そのため、後述のようにセキュリティ警告が表示されます）。
　サイドメニュー、全文検索、履歴管理などの機能があります。

スクリーンショット

　サンプルはWeb上に置けませんので、スクリーンショットをご覧ください。

動作環境

　Windows XP SP2、Internet Explorer 6.0およびFirefox 1.5で開発しました。 Firefox 2.0、Firefox 3.0、Internet Explorer 7でも、簡単に動作確認しています。

ライセンス

　Apache License 2.0でお願いします。

導入

　以下のzipを展開してください。

• Version 0.1.2 JSLocalWiki_0_1_2.zip (2007/1/19)

　zipがダウンロードできない「セキュリティ意識の高い」環境の方は、以下のテキストを保存し（IEの場合、右クリックして「対象をファイルに保存」）、拡張子を.htmlに変更してください。

• JSLocalWiki.txt

　ブラウザでJSLocalWiki.htmlを開くと、セキュリティ警告が表示されます。「使用上の注意」をお読みになった上で、了承してください。

Internet Explorerの場合

　HTMLは、PCのローカルディスク上に保存してください。
　HTMLをファイルサーバ上に保存すると、イントラネットゾーンと認識されるため、デフォルトのセキュリティ設定では動作しません（このブラウザでは動作しない旨、表示されます）。

　ファイルサーバ上に保存したHTMLで動作させる場合、以下のいずれかの設定を行なえば動作します。ただし、セキュリティ設定を弱くすることになりますので、お勧めしません。HTML Applicationとしての利用をご検討ください。

• インターネットオプションのセキュリティタブで、イントラネットのレベルを「低」にする。
• インターネットオプションのセキュリティタブで、信頼済みサイトのサイト設定を開き、「file://ホスト名」を追加する（信頼済みサイトのレベルが「低」の場合）。

HTML Applicationとして使う

　Windowsでは、拡張子を.htaに変更すると、HTML Applicationとして動作するようになります。この場合、ファイルサーバ等にファイルを置いても動作します。
　ただし、ウィンドウサイズ等は記録されません。

使用方法

　右上のメニューから、「編集」をクリックすると、そのページの内容が編集できます。
　各ページの記述には、Wiki記法が使用できます。記法は、PukiWikiのサブセットとなっています。最初は、WikiNameを使ってみてください。

• WikiNameやWelcomeVisitorsのような「大文字1文字＋小文字n文字」の繰り返し
• [[単語]]のような、[[と]]で囲んだ文字列。

　がWikiNameになります。WikiNameは、自動的にページへのリンクになります。その他の記述法は、「編集」のテキスト整形ルールをご参照ください。

使用上の注意

• とりあえず動くレベルですが、不具合があると思われます。なにが起きても責任は取れませんので、ご了承ください。
• ロックを行なっているため、複数のユーザーがデータ保存先ディレクトリを共有しても、一応動作します。ただし、より一般的なWikiの設置をお勧めします。
• 「戻る」「進む」は使えませんので、ご注意ください。

データ保存先について

• データの保存先ディレクトリは、デフォルトでは、HTMLを置いたディレクトリ下の"dat"ディレクトリになります。
• 設定で変更が可能です。詳しくはカスタマイズをご覧ください。
• データの保存先は、定期的にバックアップすることを強くお勧めします。
• Firefoxでは、保存先ディレクトリに日本語（マルチバイト文字）を使用できません。設定でディレクトリを変更してください。
• datディレクトリ内のbakディレクトリに、履歴が残されます。長い間運用すると、履歴のサイズが大きくなりますので、適宜削除してください。

ロックされた場合

• スクリプトが誤作動したり、ブラウザを途中で終了したりすると、ロックされたままになります。データ保存先ディレクトリの以下のファイルを削除してください。
  • lock
  • shared（もしあれば）

その他の情報

• Windows以外の環境では、21行目のPathSeparatorを"/"等に書き換えれば、動くかもしれません（動作環境がないため、確認できず申し訳ありません）。
• デフォルトの文字エンコーディングが、Shift_JIS以外の環境での動作は未確認です。
• デフォルトの文字エンコーディングが異なる環境で、データを共有すると、正しく動作しない可能性があります。

カスタマイズなど

サイドメニューの表示

　SideMenuというWikiNameを作ると、ページ左側に表示されます。「#recent」という行を記述すると、最新20件が表示されます。

#recent

初期表示WikiNameの変更

　WikiPreferecesというWikiNameを作り、「DEFAULT_WORD=初期表示WikiName」という行を作成すると、変更できます。

DEFAULT_WORD=FrontPage

データ保存先ディレクトリの変更

　右上のメニューから「設定」「保存先ディレクトリの設定」を選択すると変更できます。

HTMLへのエクスポート

　右上の「設定」から「全体をHTMLへエクスポート」を選択すると、すべてのページのHTMLファイルが、データ保存先ディレクトリの下の、"html"ディレクトリに作成されます。

その他の情報

実装について

更新履歴

• Version 0.1.2 2007/1/19
  • 操作衝突時の再試行で、3回までは「キャンセル」が表示されないよう変更（共同利用すると「キャンセル」を選択するユーザーがいるため）。
  • 全体をHTMLにエクスポートする機能を追加。
  • 改名機能を追加。
• Version 0.1.1 2006/12/20
  • ロックファイル削除時に、ファイルがOSレベルでロックされていた場合に警告するように変更。
  • ロックされていたとき、キャンセルするとIEでエラーになっていたのを修正。

このページの更新履歴

• 2008/6/29 動作確認情報を追加。
• 2007/1/24 スクリーンショットを追加。
• 2007/1/19 Version 0.1.2を公開。
• 2006/12/20 Version 0.1.1を公開。
• 2006/12/13 公開。

トップページに戻る

Copyright (C) Yoshinori KUME 2006-2008. All rights reserved.