ユーザ用ツール

サイト用ツール


wiki:プラグイン

**以前のリビジョンの文書です**

プラグインのインストール方法

プラグインの一覧からインストールしたいプラグインを探し、プラグインの説明文を注意深く読んでください。 その後、そのプラグインをインストールするため、以下に示す詳細を参照してください。

自動インストール

ほとんどのプラグインは、拡張機能管理(Ponder Stibbons 以降)かプラグイン管理(Ponder Stibbons 以前)を使用して自動的にインストールできます。 それぞれのツール自体が独立したプラグインです。 拡張機能管理を使用すると、「インストール」ボタンをクリックしてプラグインをインストールできます。 これは、プラグインをインストールする方法の中でも圧倒的に素早く、最もエラーが起こりにくい方法となります。 リモート URL からのプラグインのインストールを参照してください。

以下のような状況では、プラグインをインストールするためにプラグイン管理や拡張機能管理を使用できません:

  • アクセス制御リスト (ACL) が有効化されていない場合。プラグイン管理や拡張機能管理には管理画面からアクセスしますが、管理画面が利用可能となるのは ACL が有効化されている Wiki のみです。たとえ完全にオープンな Wiki であっても、プラグイン管理のような DokuWiki の管理機能にアクセスできるようにするために ACL を有効化することは価値のあることでしょう。
  • プラグインのパッケージファイルが無い場合。プラグイン管理や拡張機能管理は、特別に準備された、プラグインのファイルを含む圧縮ファイルを必要とします。
  • Web サーバが DokuWiki の lib/plugins ディレクトリへの書き込み権限を持っていない場合。プラグイン管理や拡張機能管理はこのディレクトリに新しいプラグインを追加できる必要があります。
  • 独自のプラグインをゼロから開発している開発者の場合。開発者はプラグインのファイル構造を読むべきです。

これらの状況においては、プラグインの手動インストールを行う必要があります。

手動インストール

以下の説明では、あなたがサーバのコンソールにアクセスできず、ファイルをアップロードするには FTP やサーバのコントロールパネルにあるファイルマネージャなどを使用する必要があるものと仮定しています。

プラグインのパッケージファイルを使用して

  • プラグインのパッケージファイルが用意されている場合は、そのファイルをあなたのコンピュータにダウンロードしてください。プラグインが異なる形式で提供されている場合は、あなたにとって最適な形式を選択してください (Windows 利用者は Zip を好むことでしょう)。
  • パッケージファイルを展開 (すなわち unzip) してください (いくつかのヘルプとユーティリティに関しては解凍を参照してください)。プラグインにちなんだ名前を持つディレクトリが作成されるはずです。このディレクトリの中には、プラグインのタイプに応じた名前を持つファイルもしくはディレクトリ (例: syntax.php もしくは /syntax/) があることでしょう。
    • 注意:いくつかの解凍用ソフトウェアでは、解凍したすべてのファイルを、元となるアーカイブファイルにちなんだ名前を持つディレクトリの中に展開してしまうことがあります。この場合は、プラグインの名前を持つディレクトリを見つけるため、ディレクトリを 1 つ上に移動する必要があります。パッケージファイルが実はプラグインと同じ名前を持っている場合は、混乱を招いてしまう可能性があります!
    • 注意:多くのプラグインの作成者は、github に自分のプラグインをホストし、最新のチェックインから自動的に ZIP ファイルを作成しています。これらの自動作成されたアーカイブは、通常間違ったフォルダ名が含まれており、正しい名前にフォルダ名を変更する必要があります。
      例:Gallery プラグインを解凍すると splitbrain-dokuwiki-plugin-gallery-169c0bb のようなフォルダー名になり、gallery というフォルダー名に変更する必要があります。
      プラグイン開発者用のヒント:この問題を回避するために plugin.info.txt を使用します。
  • ファイルのアップローダ (例: FTP もしくはサーバのコントロールパネルのファイルマネージャ) を使用して、サーバ上で DokuWiki の lib/plugins ディレクトリまで移動し、そこに 1 つ前の項目で (コンピュータ上に) 作成したプラグインディレクトリ一式をアップロードしてください。結果として、プラグイン用のファイルとディレクトリを含む lib/plugins/<新規プラグイン名> というディレクトリがサーバ上に新規に作成されることになります。

これでプラグインのインストールが完了となります。

プラグインのパッケージファイル無しで

パッケージファイル無しでプラグインをインストールすることも全く簡単であり、何個かのファイルだけから構成されるシンプルなプラグインの場合は特に簡単です。 しかし、いくつかの重要な情報がプラグインのドキュメントから読み取れない場合は、より多くの不平や言いわけ、そして DokuWiki と PHP に精通していることが必要となるかもしれません。 実際のところ、プラグインパッケージを作成することは非常に簡単です。このため、もしあなたが PHP に全く慣れていない場合は、プラグインの作者に対して、プラグインパッケージを電子メールで送付してもらえないか、もしくはせめてプラグインで使用する正確な名前を明らかにしてもらえないか、と電子メールで丁寧に尋ねてみることは価値のあることかもしれません。

PHP に慣れている方であれば、開発者セクションのプラグインのページ、特にプラグインのファイル構造をよく調べてください。

以下の説明文では、プラグインで必要となるコードを作者が Web ページに貼り付けており、各ファイル用のコードはそのファイル名とともにはっきりと識別できるものと仮定しています。

  • あなたのコンピュータ上にディレクトリを作成し、それにプラグインにちなんだ名前を付けてください。この名前は重要であり、プラグインファイルの中で使用される「クラス (class)」名の一部に合致しなければなりません。
  • プラグインから使用される各ファイルについて、テキストエディタ (例: ノートパッド) でファイルを新規作成し、ファイルの先頭や末尾に余計な空行が入らないよう (これは .php ファイルではとても重要です) に気をつけながら Web ページからコードの内容をコピー & ペーストしてから、適切な名前を付けてプラグインのディレクトリ内に保存してください。もし作者がサブディレクトリに保存する必要があると指示しているファイルであれば、ファイルを保存する前にサブディレクトリを作成してください。
  • すべてのファイルが作成された後、ファイルのアップローダ (例: FTP もしくはサーバのコントロールパネルのファイルマネージャ) を使用して、サーバ上で DokuWiki の lib/plugins ディレクトリまで移動し、そこに 1 つ前の項目で (コンピュータ上に) 作成したプラグインディレクトリ一式をアップロードしてください。結果として、プラグイン用のファイルとディレクトリを含む lib/plugins/<新規プラグイン名> というディレクトリがサーバ上に新規に作成されることになります。

これでプラグインのインストールが完了となります。

参考

トラブルシューティング

プラグインが動作していないように見える場合は、プラグインの問題に関するよくある質問を確認してください。

wiki/プラグイン.1524899261.txt · 最終更新: 2018/04/28 by N_Miya