WikiFormat Plugin
ユーザサイドでWiki記法を整形するJavaScriptをMODxで利用する
初出:2009年02/26 更新:2009年02/27
MODxでは通常、ドキュメントの内容('content')はHTMLで書きますが、 Wiki記法が使えると省力化にもなり、便利です。
*見出し1
-a
--b
---c
**見出し2
+A
+B
***見出し3
<script type="text/javascript">
function searchResource(){
document.resource.op.value="srch";
document.resource.submit();
};
test test test test test test test.. (略)
↓これを整形して
ここでは、ユーザサイドでWiki記法を整形する Kazuho@Cybozu Labs: Wiki.Formatter in JavaScript をMODxで利用する方法を紹介します。
概要
WikiFormat PluginはMODxがドキュメントを読み込もうとするときに発生させるOnParseDocumentを補足し、特定のドキュメントに対してだけWiki記法を有効にするプラグインです。
JavaScript上で文字列をWiki記法とみなしてHTMLに変換するライブラリとして、Kazuho@Cybozu さんによる Wiki.Formatter を利用します。 処理はユーザサイドで行われるため、サーバ側には大して負担がかかりません。 GPLとのことで、wikiformatter.jsをアーカイブに同梱させていただきました。
このプラグインでは、JavaScriptが無効になっていると整形できないため、単に生の文字列を表示します。
ライセンスはMODx, Wiki.Formatterの双方に従ってGPLとします。
ダウンロード
| ファイル | バージョン | 日付 |
|---|---|---|
| WikiFormat-1.0.0.zip | v1.0.0 | 20090227 |
導入方法
- WikiModeというテンプレート変数を作成する。種別はCheck Box、オプション値は
Wiki Mode Enabled
とします。(テンプレート変数名とオプション値は一字一句正確に入力する必要があります)
- プラグインを作成し、wikiformat.phpの内容を貼り付けます。イベントとしてOnParseDocumentにチェックします。
- Wiki記法を有効にしたいドキュメントの編集画面で、テンプレート変数「WikiMode」の「Wiki Mode Enabled」にチェックを入れて保存します。

- ドキュメントを表示させると、整形されています。
