Writing Confluence Plugins


ConfluenceプラグインはConfluenceを拡張することで標準的なメカニズムを提供する。
Confluenceにプラグインを加えることで、あなたはサイトの見た目や感じ方をカスタマイズしたり、新しいマクロやイベントリスナ、周期的なタスクを加えたり、また、新しい特徴を導入することすらできる。

プラグインとは何なのかというoverviewのために、あなたはConfluence Plugin Guideを読むことができる。
このドキュメントは自分自身のプラグインを書きたいと思っている開発者にConfluence pluginsを提供する。

Anatomy of a Plugin

プラグインとは、Confluence内にアップロードできるであろう単一のjarファイルである。
次の構成を持つ。
  • plugin descripter
  • (Optional)Java Classes
  • (Optional)Resources
プラグインは一連のmoduleからできており、それらの各々はConfluenceとプラグインが接続するポイントを定義している。

Creating your Plugin Descriptor

プラグインdescriptorはatlassian-plugin.xmlと呼ばれる単一のXMLファイルである。
それはそれの内に含まれていたプラグインとmoduleすべてに関してのアプリケーションを伝える。
Creating your Plugin Descriptorを見てください。

Creating a Basic Macro Plugin Skeleton

最も基本的なプラグインさえかなり多数のディレクトリおよびコンフィグ・ファイルを含んでいるが、プラグインskeletonの作成はかなり容易で簡単である。
我々はあなたのために仕事のほとんど全てをするMoven 2 templeteを作った。
あなたの開発環境のセットアップおよびもっとも基礎的なConfluenceマクロプラグインの作成の指示に関しては、Atlassian Developer Network内のドキュメンテーションを参照すると良い。

Confluence Plugin Module Types

Confluenceには多くのプラグインのタイプがある。
あなたがConfluence中のプラグイン開発に不慣れであるならば、私たちは出発点として単純なマクロのプラグインを書くことを強く提案する。
マクロは書くのが簡単で、すぐ視覚的なフィードバックを貴方に与える。
Maven 2 templatesで作成された初期のプラグインもまたマクロなので、あなたは直ちに始めることができる。
一度Confluence APIについての方法を知ることができれば、他のものへプラグインを発展させるか、あるいはもちろん新しいプラグインを作成してすることができ、ゼロから出発することができる。
次の各々のプラグインの型記述は、あなたが上記のパラグラフの中で言及された基礎的なプラグインskeletonを作成することができたと仮定する。
Confluence Plugin Module Typesを見なさい。

Java Classes and Accessing Confluence Components

あなたがConflue3nceないにプラグインのJAR fileをアップロードしたとき、JAR内に含まれている全てのJavaクラスは、あなたのためにアクセスを可能にする。
貴方はすきなだけクラスを含むことができ、互いに通じさせることができる。
Confluenceとプラグインがあなたのプラグインを使うためにコンポーネントをexportすることができるので、貴方のプラグインのクラスがConfluenceクラス、あるいはほかのプラグインと矛盾しないことを保証するためにJavaパッケージの命名規則に従うことは重要である。

(以下、続く。)

タグ:

+ タグ編集
  • タグ:
最終更新:2012年07月11日 14:27