DokuWiki

編集して保存をクリックしてください。Wikiの構文については syntax を参考にしてください。当然のことですが、この文書の質を向上させる場合のみ編集してください。もし編集方法や構文を練習したいのであれば playground を利用してください。

====== プラグインの開発 ======

DokuWikiのプラグインを書くことはとても簡単です。
自分自身で書く前に、[[ja:plugins|既存のプラグイン]]に似たプラグインがないか探し、[[ja:devel:security|プラグイン開発者のためのセキュリティガイドライン]]を読むことを忘れないで下さい。

DokuWikiには、開発者による機能拡張が可能な柔軟なプラグインAPIがあります。
追加された[[ja:wiki:syntax|整形記法モード]]、カスタム化した[[ja:devel:action_modes|動作モード]]、新しい[[ja:export|エクスポートモード]]、等々が可能です。
プラグインの目的によって、以下のプラグインタイプの１つまたは複数の構成要素からプラグインは成り立っています。

===== プラグインタイプ =====

現在、DokuWiki には 5 種類のプラグインタイプがあります。

* [[ja:devel:syntax_plugins|構文プラグイン ]] は DokuWiki の基本の[[ja:wiki:syntax|整形記法]]を拡張します。
  * [[ja:devel:action_plugins|動作プラグイン]] は wiki ページの保存から新しい[[ja:devel:action modes|動作モード]]の追加まで、DokuWiki の中心となる操作の多くの部分を拡張したり置換えたりします。
  * [[ja:devel:admin_plugins|管理プラグイン]] はDokuWiki の管理機能を提供します。スーパーユーザーと管理者は「管理」ボタンからこれらプラグインを利用できます。
  * [[ja:devel:helper_plugins|ヘルパープラグイン]] は、他の多数のプラグインに対して機能を提供できます。つまり、特定の機能を各プラグインが何度も再実装せずに済みます。
  * [[devel:renderer_plugins|レンダラプラグイン]] は、新しい[[ja:export|エクスポート]]モードを作成し、DokuWiki 標準の XHTML レンダラを置換えできます
  * [[devel:remote_plugins|リモートプラグイン]] allow to add webservices to your plugin.
  * [[devel:auth_plugins|認証プラグイン]] add additional authentication backend to the DokuWiki, which could be activated via configuration manager.

[[plugin:color|color プラグイン]]のような単純なプラグインは、単一ファイル ''syntax.php'' で成り立っています。
より高度なプラグインは、複数のコンポーネントで構成されます。
例えば[[plugin:data|構造化データプラグイン]]には、"data entry" "table view" 部品に分割した構文処理、全データ入力に添付される特別な編集ボタンの動作部品、データベース維持管理のための管理画面があります。

===== 情報源 =====

プラグイン開発には多くの情報源があります：
  * [[ja:devel:plugin_file_structure|プラグインのファイル構造]]は、全プラグインタイプに関連する、命名規則と構造の概要、[[ja:devel:javascript|JavaScript]]と[[ja:devel:css|CSSスタイルシート]]を追加する場所を説明します。
  * 全プラグインタイプで使用可能な[[devel:common_plugin_functions|共通プラグイン機能]]があります。翻訳機能、設定管理機能、interspection を追加します。
  * [[ja:devel:security|セキュリティガイドライン]]は一般的な問題の理解を深め、保護対策を提示します。
  * [[devel:plugin_programming_tips|プラグインプログラミングのヒント]]は利用可能で、優良事例、DokuWiki の素晴らしいツールに対する助言です。

===== プラグイン名 =====

有効なプラグイン名：
  * a-z 0-9 の文字だけであること
  * アンダースコアは認められません：
    * ''<component name>'' から ''<plugin name>'' を区切るのに使用されている。
    * アンダースコアを使用すると [[ja:popularity|利用状況]]の数字が 0 になります。
  * 別のプラグインが同名を使用した場合、
    * 相互に除外し合い、互換性がなくなります。
    * どちらか一方のみしか dokuwiki.org のプラグインホームページを持てません。

===== プラグインウィザード =====

http://pluginwizard.dokuwiki.org/ にDokuWiki プラグイン用の基本的な骨組みを作成するウィザードがあります。
開発を開始時には、このウィザードを使用することを推奨します

プラグインを拡張する必要がある場合、プラグイン内のファイル配置方法について[[ja:devel:plugin_file_structure|プラグインのファイル構造]]を参照して下さい。

===== dokuwiki.org でのプラグイン公開 =====

プラグインを作成したら、コミュニティーと共有して下さい。
plugin 名前空間内に、プラグインにちなんだ名前のページを作成するだけです。
例えば、プラグインフォルダーが ''sample'' という名前の場合、wiki に ''plugin:sample'' という名前のページを作成して下さい。

ページにはインストール方法・使用方法・インストール前に実施すべきことのような必要な文書が全て含まれているべきです。
スクリーンショットを追加するのも良いでしょう(([[plugin:imageshack|imageshack]] プラグインを利用して、ここに画像を追加できます))。
[[devel:plugin_homepages|プラグインホームページのテンプレート]]には、ユーザーに役立つページを作成する方法に関して多くのヒントが含まれています。

プラグインページの上部のいくつかのメタデータフィールドは必須項目です。
各フィールドの説明は、[[plugin:repository|リポジトリプラグイン]]のページにあります。

dokuwiki.org ではファイルアップロードを認めていません。
プラグインファイルは、どこか別の場所で管理する必要があります。
[[ja:devel:git|Git リポジトリ]]のようなリビジョン管理システムを使用してソースを管理することをお勧めします。
その場合、リポジトリのバグトラッカーを提供している [[http://github.com|Github]] のような公開リポジトリホストを利用するのが最も簡単です。

===== プラグイン調査の概要=====

[[devel:plugin survey:start|プラグイン調査]]は、%%www.dokuwiki.org%% の plugin 名前空間にある全[[ja:plugins|プラグイン]]に関する、開発者向けの概況です。
自動化されたスクリプトによって 2010-09-05 に収集したデータと、ダウンロードと採掘に関する追加の手動データを基にしています。
全 697 ページには、672 個のプラグインが含まれ、647 プラグイン（96%）のソースコードがダウンロード、解析されました。

人間の証明として、ボックス内の全ての文字を入力してください。 W O G J᠎ M この項目は空のままにして下さい：

編集の概要

注意：本ページを編集した場合、あなたの編集した内容が次のライセンスに従うことに同意したものとみなします： CC Attribution-Share Alike 4.0 International