PHPベースのオープンソースのウィキソフトウェア DokuWikiのおすすめプラグインと開発方法について解説します。
DokuWikiには様々なプラグインがあり、インストールするだけで簡単に機能を拡張できます。
種類別によく使用するおすすめのプラグインを挙げてみました。
また、プラグインを開発する場合は、まずはシンプルに構文を追加するプラグインを参考にして作ってみるのがいいと思います。
なお、今回のバージョンは以下の通りです。
- DokuWiki 2018-04-22a “Greebo”
種類別おすすめプラグイン一覧
よく使用するおすすめのプラグインを種類別に挙げていきます。
ダウンロード時に同梱できるプラグイン
DokuWikiをダウンロードする際に同梱できるプラグインはこちらです。
| プラグイン | 概要 |
|---|---|
| CAPTCHA | CAPTCHAによるスパム対策を行う |
| Upgrade | DokuWikiアップグレードプラグイン |
| Wrap | 様々なボックスや段組みを設置する |
| Translation | 多言語Wikiサイト用プラグイン |
| Video Share | 動画をページ内に埋め込む |
| Gallery | 画像ギャラリーをページ内に埋め込む |
どれもよく使うので、ダウンロード時には全てチェックして同梱すればOKです。
DokuWiki本体へ機能を追加するプラグイン
拡張機能のように、DokuWiki本体へ機能を追加するプラグインはこちらです。
| プラグイン | 概要 |
|---|---|
| Discussion | コメント欄を設置する 掲示板のようなスレッドを作成する |
| Move | リンクを維持したまま、ページやメディアファイルを移動する |
| Redirect | 別ページや外部サイトへのリダイレクトを設定する |
| TemplatePageName | ページテンプレート（雛形）のファイル名を変更する |
ページ一覧を取得・出力するプラグイン
DokuWikiには、ページ一覧系のプラグインが多数あります。
ページ一覧を取得・出力するプラグインはこちらです。
| プラグイン | 概要 |
|---|---|
| Pagelist | ページ一覧を出力・取得するヘルパープラグイン |
| Changes | 変更のあったページやメディアファイルの一覧を出力する |
| IndexMenu | ページの目次や名前空間のページ一覧を出力する |
| OrphansWanted | リンクされていない孤立したページを見つける |
| numberof | ページとメディアファイルの数をカウントする |
入力・編集を補助するプラグイン
ページ編集時に入力を補助するプラグインはこちらです。
| プラグイン | 概要 |
|---|---|
| EditTable | テーブル編集を簡単にする |
目次を調整するプラグイン
目次の位置や形式を調整するプラグインはこちらです。
| プラグイン | 概要 |
|---|---|
| TocTweak | 目次の位置を微調整する |
フォームを設置するプラグイン
ページ内にフォームを設置するプラグインはこちらです。
| プラグイン | 概要 |
|---|---|
| Add New Page | 新規ページを作成するフォームを設置する |
| Bureaucracy | メール送信やページ作成するフォームを設置する |
HTMLタグを追加するプラグイン
ページ内やHTMLヘッダーにHTMLタグを追加するプラグインはこちらです。
| プラグイン | 概要 |
|---|---|
| SocialCards | TwitterカードやOGPのmetaタグを設定する |
| HtmlMetaTags | HTMLヘッダーにmetaタグを追加する |
| iframe | iframeタグで外部ページをページ内に埋め込む |
便利な構文や機能を追加するプラグイン
ページ内で使用できる便利な構文やページ内に機能を追加するプラグインはこちらです。
| プラグイン | 概要 |
|---|---|
| Tag | ページにタグを設定する |
プラグインの種類
DokuWikiのプラグインは、7種類に分類されます。
7種類の一覧は以下の通りで、1つのプラグインが複数のタイプの機能を持つ場合もあります。
数多く開発されているプラグインは、構文プラグインと動作プラグインです。
DokuWikiのプラグインで特徴的なものは、ヘルパープラグインです。
よく使われる機能をヘルパープラグインとして作成しておけば、他のプラグインから利用できるので、再度その機能を開発する必要はなくなります。
ヘルパープラグインの中では、Pagelistプラグインなどが有名ですね。
プラグインディレクトリ
DokuWikiのプラグイン格納ディレクトリは、
lib/plugins
です。
基本的にその配下にプラグイン名でディレクトリが分けられ、その中にソースコードが含まれます。
プラグインの新規開発
プラグインの新規開発時は、開発したいプラグインと似たような機能・動作をするプラグインや同じ種類のプラグインを参考にするとよいでしょう。
また、プラグインのひな形を作成できるプラグインウィザードを使用する方法もあります。
最後に
今回は、DokuWikiのおすすめプラグインと開発方法について解説しました。
DokuWikiには様々なプラグインがあり、インストールするだけで簡単に機能を拡張できます。
新規開発する場合は、既存の同じ種類のプラグインを参考にするとよいでしょう。
構文プラグインなら割と簡単にできますよ。
DokuWikiの使い方については、こちらの記事にまとめています。
コメント