プラグイン情報

各プラグインは、自分自身ついて基本的な情報を提供する必要があります。プラグインディレクトリにある plugin.info.txt というファイルを介して行います。

ここではそのファイルがどうなっているべきか例を挙げます。

lib/plugins/example/plugin.info.txt

base   example
author My Full Name
email  me@example.com
date   2010-01-17
name   Example Plugin to do Stuff
desc   This is just an Example of how a plugin description looks like
url    https://www.dokuwiki.org/plugin:example

パラメータ	説明
base	プラグインの技術名称。拡張機能管理は、プラグインをこのディレクトリにインストールします。
author	プラグイン作成者のフルネーム
email	このプラグインについて作成者に連絡するためのメールアドレス
date	YYYY-MM-DD 形式のこのプラグインの最終更新日。プラグインを更新する際に、これを更新することを忘れないでください！¹⁾
name	人が読める形式のプラグインの名前
desc	プラグインの機能の説明
url	プラグインについての詳細情報が入手可能な URL

注： DokuWiki 2009-12-25 “Lemming” 以降、plugin.info.txt はプラグインコンポーネント内の古い getInfo() 呼出を置換えます。 getInfo() は基本クラスに実装され、このファイルからすべての情報を読み取ります。自分でサブクラスに実装する必要はありません。

¹⁾

この日付は、リポジトリ内のプラグインのページの “Last updated on” に等しくなければなりません。release Ponder Stibbons で導入された拡張機能管理が使用する自動更新フラグのために必要です。