DokuWikiのおすすめプラグインと開発方法について解説

DokuWikiDokuWiki
この記事は約5分で読めます。

PHPベースのオープンソースのウィキソフトウェア DokuWikiのおすすめプラグインと開発方法について解説します。

DokuWikiには様々なプラグインがあり、インストールするだけで簡単に機能を拡張できます。
種類別によく使用するおすすめのプラグインを挙げてみました。

また、プラグインを開発する場合は、まずはシンプルに構文を追加するプラグインを参考にして作ってみるのがいいと思います。

なお、今回のバージョンは以下の通りです。

  • DokuWiki 2018-04-22a “Greebo”

種類別おすすめプラグイン一覧

よく使用するおすすめのプラグインを種類別に挙げていきます。

ダウンロード時に同梱できるプラグイン

DokuWikiをダウンロードする際に同梱できるプラグインはこちらです。

プラグイン概要
CAPTCHACAPTCHAによるスパム対策を行う
UpgradeDokuWikiアップグレードプラグイン
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タグを追加するプラグインはこちらです。

プラグイン概要
SocialCardsTwitterカードやOGPのmetaタグを設定する
HtmlMetaTagsHTMLヘッダーにmetaタグを追加する
iframeiframeタグで外部ページをページ内に埋め込む

便利な構文や機能を追加するプラグイン

ページ内で使用できる便利な構文やページ内に機能を追加するプラグインはこちらです。

プラグイン概要
Tagページにタグを設定する

プラグインの種類

DokuWikiのプラグインは、7種類に分類されます。

7種類の一覧は以下の通りで、1つのプラグインが複数のタイプの機能を持つ場合もあります。

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

数多く開発されているプラグインは、構文プラグイン動作プラグインです。

DokuWikiのプラグインで特徴的なものは、ヘルパープラグインです。

よく使われる機能をヘルパープラグインとして作成しておけば、他のプラグインから利用できるので、再度その機能を開発する必要はなくなります。

ヘルパープラグインの中では、Pagelistプラグインなどが有名ですね。

プラグインディレクトリ

DokuWikiのプラグイン格納ディレクトリは、

lib/plugins

です。

基本的にその配下にプラグイン名でディレクトリが分けられ、その中にソースコードが含まれます。

プラグインの新規開発

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

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

最後に

今回は、DokuWikiのおすすめプラグインと開発方法について解説しました。

DokuWikiには様々なプラグインがあり、インストールするだけで簡単に機能を拡張できます。
新規開発する場合は、既存の同じ種類のプラグインを参考にするとよいでしょう。
構文プラグインなら割と簡単にできますよ。

DokuWikiの使い方については、こちらの記事にまとめています。

DokuWiki
\よかったらシェアしてね/
えふめん

大阪在住、30代。
業務系SE・社内SEの仕事を通じて学んだこと、PCトラブルで困って調べたこと、手作業を効率化して改善したこと、WordPressのブログ運営などの記事を書いています。

えふめんをフォローする
この記事が気に入ったら
いいね!しよう
最新情報をお届けします。
俺の開発研究所

コメント

タイトルとURLをコピーしました