Geekly Articles each Day

Atlassian Confluenceでのブループリントプラグイン開発

Confluence 5がリリースされたばかりのようで、ユーザーに多くの新機能をもたらしました：新しい視覚的なプレゼンテーション、wikiから直接アプリケーションを切り替える機能、コメントが追加されたことやページのコンテンツが誰かによって変更されたという通知。 それでも、バージョン5.1 Atlassian Confluenceの息吹はすでに感じられています。これは、ブループリントテクノロジーの助けを借りてページを作成するプロセスを簡素化することを目的としています。 ブループリントは、ユーザーが作成したいコンテンツの種類を理解し、Wikiページを表示する準備が整うまで文字通りユーザーを手でドラッグすることにより、その方法を示します。

この記事では、Blueprintsプラグインの開発プロセスを最初のアイデアから最終結果まで見ていきます。 これを行うために、Atlassian Confluence用の小さなプラグインが開発されます。これにより、ブループリントテクノロジーを使用して、ページビューで古き良きwikiマークアップからページを作成できます。

ステップ1-プロジェクト構造の作成

プロジェクト構造を作成するには、 Atlassian SDKのatlas-create-confluence-pluginコマンドを使用して、必要なデータを入力できます。

手順2-POMファイルへのメタデータの追加

これで、お気に入りのIDEでプロジェクトを開き、POMファイルのメタデータを編集できます（Confluenceのプラグインの開発はMavenの参加により行われます）。 この例では、最初のマイルストーンConfluence 5.1を使用します（ 5.1-rc3はすでに利用可能です ）。
 <dependencies> <dependency> <groupId>com.atlassian.confluence</groupId> <artifactId>confluence</artifactId> <version>${confluence.version}</version> <scope>provided</scope> </dependency> <dependency> <groupId>com.atlassian.confluence.plugins</groupId> <artifactId>confluence-create-content-plugin</artifactId> <version>${create-content.version}</version> <scope>provided</scope> </dependency> </dependencies> <properties> <confluence.version>5.1-m1</confluence.version> <create-content.version>1.3.8</create-content.version> <confluence.data.version>5.1-m1</confluence.data.version> <amps.version>4.1.5</amps.version> </properties>

ステップ3-プラグイン記述子へのモジュールの追加

このステップでは、 Blueprintsを操作するためのモジュールをプラグイン記述子atlassian-plugin.xmlに追加します。
 <web-item key="wiki-markup-blueprint-item" i18n-name-key="wiki.markup.blueprint.name" section="system.create.dialog/content"> <description key="wiki.markup.blueprint.description"/> <resource name="icon" type="download" location="images/stiltsoft.png"/> <param name="blueprintKey" value="wiki-markup-blueprint"/> </web-item>

web-itemモジュールは、[ Create DialogのCreate Dialog ]ウィンドウにWiki Markupメニュー項目を追加し、次のパラメーターがあります。


次に、 blueprintモジュールを定義します。
 <blueprint key="wiki-markup-blueprint" create-result="view" content-template-key="wiki-markup-blueprint-page" index-key="wiki-markup-blueprint-index"> <dialog-wizard key="blueprint-wizard"> <dialog-page id="insertMarkupForm" template-key="WikiMarkup.Blueprint.form" title-key="wiki.markup.blueprint.dialog.title" last="true"/> </dialog-wizard> </blueprint>

blueprintモジュールblueprint 、開発者にコアバリューをblueprintします。 次のパラメーターで構成されます。

blueprintモジュールのdialog-wizardパラメーターは、 Blueprintプラグインを使用してコンテンツを作成するときにユーザーに表示されるものの動的な動作を決定します。 このパラメーターには次の属性があります。

使用する大豆テンプレートは 、後でweb-resourceモジュールで定義されます。 以下は、 templates.soyファイルの内容です。
 {namespace WikiMarkup.Blueprint} /** * Wiki Markup form */ {template .form} <form id="wiki-markup-form" action="#" method="post" class="aui"> <div> {getText('wiki.markup.blueprint.dialog.form.label.page.title')} </div> <input id="page-title" type="text" name="title"> <div> {getText('wiki.markup.blueprint.dialog.form.label.markup')} </div> <textarea id="wiki-markup" name="wikiMarkup"></textarea> </form> {/template}

この場合、ユーザーには以下が表示されます。

content-templateモジュールは、ページの作成に使用されるページテンプレートを定義します。
 <content-template key="wiki-markup-blueprint-page" i18n-name-key="wiki.markup.blueprint.page.name"> <resource name="template" type="download" location="xml/content-template.xml"/> <context-provider class="com.stiltsoft.confluence.plugins.blueprint.markup.WikiMarkupProvider"/> </content-template>

content-templateモジュールには次のパラメーターがあります。

xmlファイルのページテンプレートには、コンテキストから取得された動的変数が含まれている可能性があることに注意してください。 開発中のプラグインでは、テンプレートは次のとおりです。
 <at:var at:name="wikiInXhtml" at:rawXhtml='true'/>

テンプレートで使用できる変数は、ユーザーが入力したフォームから取得することも、 context-provider直接「寝る」こともできcontext-provider 。 この例では、 context-providerを使用しcontext-provider 。これは、ユーザーが入力フォームに入力したwikiマークアップをConfluenceで使用されるxhtmlマークアップに変換します。 context-providerのコードを以下に示します。
 package com.stiltsoft.confluence.plugins.blueprint.markup; import com.atlassian.confluence.content.render.xhtml.DefaultConversionContext; import com.atlassian.confluence.content.render.xhtml.XhtmlException; import com.atlassian.confluence.renderer.PageContext; import com.atlassian.confluence.xhtml.api.EditorFormatService; import com.atlassian.plugin.PluginParseException; import com.atlassian.plugin.web.ContextProvider; import java.util.Map; public class WikiMarkupProvider implements ContextProvider { private EditorFormatService editorFormatService; public WikiMarkupProvider(EditorFormatService editorFormatService) { this.editorFormatService = editorFormatService; } @Override public void init(Map<String, String> params) throws PluginParseException { } @Override public Map<String, Object> getContextMap(Map<String, Object> ctx) { try { String wikiMarkup = (String) ctx.get("wikiMarkup"); String xhtml = editorFormatService.convertWikiToEdit(wikiMarkup, new DefaultConversionContext(new PageContext())); ctx.put("wikiInXhtml", xhtml); } catch (XhtmlException ignored) { } return ctx; } }

最後に、 atlassian-plugin.xmlでweb-resourceモジュールを定義します。
 <web-resource key="blueprint-resources" name="Blueprint Resources"> <transformation extension="js"> <transformer key="jsI18n"/> </transformation> <transformation extension="soy"> <transformer key="soyTransformer"> <functions>com.atlassian.confluence.plugins.soy:soy-core-functions</functions> </transformer> </transformation> <resource type="download" name="wiki-markup.css" location="css/wiki-markup.css"/> <resource type="download" name="templates-soy.js" location="soy/templates.soy"/> <resource type="download" name="wiki-markup.js" location="js/wiki-markup.js"/> <dependency>com.atlassian.confluence.plugins.confluence-create-content-plugin:resources</dependency> <context>atl.general</context> <context>atl.admin</context> </web-resource>

web-resourceモジュールで使用されているパラメーター値をドキュメントでよく理解できます。

com.atlassian.confluence.plugins.confluence-create-content-plugin:resources依存関係com.atlassian.confluence.plugins.confluence-create-content-plugin:resources付加する必要があることに注意してください。 さらに、 wiki-markup.js 、次のようにBlueprintプラグインを登録する必要があります。
 (function ($) { Confluence.Blueprint.setWizard('com.stiltsoft.confluence.plugins.wiki-markup-blueprint-plugin:wiki-markup-blueprint-item', function() { }); })(AJS.$);

ステップ4-プラグインを使用して、Wikiレイアウトからページを作成します

信じられませんが、wikiマークアップからページを作成するためのBlueprintプラグインを作成するプロセスはBlueprint終了します。 すべてを正しければ、プラグインをインストールして、実際に試してみることができます。

さらに、プラグインのソースコードを確認したり、すべての手順を繰り返して作成したりすることもできます。


Source: https://habr.com/ru/post/J173797/

More articles:


All Articles