DokuWiki.biz

オープンソースのウィキソフトウェア「DokuWiki」の設定、テンプレートカスタマイズ、プラグイン開発などのメモ書き。

ユーザ用ツール

サイト用ツール


plugin:point

DokuWikiのプラグイン開発のポイント

このページでは、DokuWikiのプラグインを開発するにあたって、押さえておきたいポイントについて説明する。

DokuWikiのプラグインはシンプルなものから複雑なものまで様々あるが、まずはシンプル構文を追加するプラグインのソースコードを参考にして作ってみるのが、一番いいと思う。

プラグインディレクトリ

DokuWikiのプラグイン格納ディレクトリはlib/pluginsである。

基本的には、その配下にプラグイン名でディレクトリが分けられ、その中にソースコードが含まれるということになっている。

プラグインの種類

DokuWikiのプラグインは、7種類に分類される。1つのプラグインが複数のタイプの機能を持つ場合もある。

タイプ 概要 ファイル名
構文プラグイン Wiki構文の拡張 syntax.php
動作プラグイン イベント処理による動作の変更 action.php
管理プラグイン 管理機能の追加 admin.php
ヘルパープラグイン 他のプラグインから利用される機能の追加 helper.php
レンダラプラグイン エクスポートモード(Wiki出力)の追加 renderer.php
リモートプラグイン WebサービスのリモートAPI機能の追加 remote.php
認証プラグイン 認証バックエンドの追加 auth.php

多く開発されているプラグインは、構文プラグイン動作プラグインだと思われる。

DokuWikiのプラグインで特徴的なものは、ヘルパープラグインである。よく使われる機能をヘルパープラグインとして作成しておけば、再度その機能を開発する必要はなくなる。Pagelistプラグインなどが有名である。

プラグインの新規開発

プラグインの新規開発時は、開発したいプラグインと似たような機能・動作をするプラグインや同じ種類のプラグインを参考にするのがよい。

また、プラグインのひな形を作成できるプラグインウィザードを使用するのもおすすめである。

参考ページ

plugin/point.txt · 最終更新: 2018/08/31 14:18:07 by admin