上一章節我們介紹了測試模塊的配置文件,這一章節我們介紹插件本身的配置文件,這個是我們部署插件真正用到的. 文件的位置位于項目主目錄中的/src/main/resources目錄中.

插件配置文件介紹

插件描述文件的根元素

<atlassian-plugin?key="${project.groupId}.${project.artifactId}"?name="${project.name}"?plugins-version="2">
atlassian-plugin>
屬性名稱描述

key	用來標識插件模塊.此屬性是必須的,并且在插件中必須是唯一的,相當于插件的身份證號碼.默認使用構建插件時填寫的groupId和artifactId組成.
name	插件的名稱.用于在應用程序的菜單中顯示.默認通過引用pom.xml文件的name來加載.(不應該在該值中使用單詞 “plugin” 或 “add-on” )

接下來是plugin-info元素

包含插件信息,父元素是,支持多個嵌套元素.

<plugin-info>
????????<description>${project.description}description>
????????<version>${project.version}version>
????????<vendor?name="${project.organization.name}"?url="${project.organization.url}"?/>
????????<param?name="plugin-icon">images/pluginIcon.pngparam>
????????<param?name="plugin-logo">images/pluginLogo.pngparam>
plugin-info>
嵌套元素描述

description	插件說明
version	插件版本
vendor	提供插件開發人員的信息
param	插件參數(示例中的兩個參數分別提供了插件圖標的位置和插件logo的位置)

vendor元素

插件供應商.在插件管理中提供鏈接地址.父元素是.

屬性名稱描述

name	提供開發人員的姓名或公司的名稱
url	提供一個網站地址

---

文件其余部分是組成插件的所有模塊,首先來看下插件本身的.里面有resource元素和web-resource元素.

國際化資源配置

location填寫的名稱,代表必須有一個叫hello-world.properties的配置文件

<resource?type="i18n"?name="i18n"?location="hello-world"/>

Web資源插件模塊

該模塊允許插件定義可下載的資源.如果插件中需要引用JavaScript或CSS文件,則需要依賴該模塊,將Web資源添加到頁面頂部.另外,也可以將指定的Web資源包含在應用程序的特定上下文中.

web資源模塊的根元素web-resource

<web-resource?key="hello-world-resources"?name="hello-world?Web?Resources">
web-resource>
屬性名稱描述

key	模塊的唯一標識符,可以通過它使用模塊中包含的資源
name	模塊的名稱

依賴項

示例中的這個依賴項可以理解為增強版的jQuery,Atlassia在jQuery之上提供了一些其他功能

<dependency>com.atlassian.auiplugin:ajsdependency>

資源

代表該模塊包含的靜態資源

<resource?type="download"?name="hello-world.css"?location="/css/hello-world.css"/>
<resource?type="download"?name="hello-world.js"?location="/js/hello-world.js"/>
<resource?type="download"?name="images/"?location="/images"/>
屬性名稱描述

type	download代表可下載的資源類型,它使資源可以從特定的URL下載
name	資源的名稱,如果location參數指定的不是單個資源(例如圖片存放目錄),應該在名稱后面加上“/”,對于CSS/ Javascript 資源,他們的名稱必須具有適當的文件擴展名
location	資源的位置,告訴插件在哪個位置可以找到資源

如果要在CSS中引用圖片,使用基于圖片定義的資源名稱的相對路徑,如該插件的imageshello-world.css

.my-class?{
???background-image:?url(images/mypicture.gif);
}

要引用Confluence中已經可用的圖片,需要指定三個父級目錄,如下所示

.my-class?{
???background-image:?url(../../../images/icons/confluence-logo.gif);
}

Web資源上下文

可以在Confluence中特定類型的頁面上自動包含Web資源.默認是artifactId的名稱,屬于自定義上下文,相對應的還有一些Confluence自帶的上下文

自定義上下文

<context>hello-worldcontext>

Confluence自帶上下文

上下文描述

atl.general	除了管理頁面之外的任意頁面
main	除了管理頁面之外的任意頁面
atl.admin	管理頁面,請謹慎使用,因為格式不正確的CSS或JavaScript可能會阻止訪問該Confluence
admin	管理頁面,請謹慎使用,因為格式不正確的CSS或JavaScript可能會阻止訪問該Confluence
atl.userprofile	用戶個人資料頁面
atl.popup	彈出窗口
dashboard	儀表板
editor	出現編輯的頁面
editor-context	頁面編輯器內
macro-browser	宏瀏覽器,在editor之后
page	任何與頁面相關的頁面，例如查看，編輯，附件，信息；但不包括博客文章，空間或全局頁面
preview	在宏瀏覽器的預覽窗格中
blogpost	任何與博客相關的頁面，例如查看，編輯，附件，信息；而不是頁面，空間或全局頁面
space	任何與空間相關的頁面

如果要將Web資源配置在空間和頁面的上下文中可以如下配置

<web-resource?key="hello-world-resources"?name="hello-world?Web?Resources">
????????<dependency>com.atlassian.auiplugin:ajsdependency>
????????<resource?type="download"?name="hello-world.css"?location="/css/hello-world.css"/>
????????<resource?type="download"?name="hello-world.js"?location="/js/hello-world.js"/>
????????<resource?type="download"?name="images/"?location="/images"/>
????????<context>spacecontext>?
????????<context>pagecontext>
web-resource>

引用Web資源

要將自定義Web資源包含在使用插件的頁面中，請使用#requireResource Velocity宏

#requireResource("com.jenseny.atlassian.tutorial.hello-world:hello-world-resources")

內容格式為${atlassian.plugin.key}:${web-resource-key}

如果Confluence中添加了許多頁面,這些頁面都依賴一個Web資源,我們可以新建一個Web資源上下文,然后在Velocity中引入新的上下文,引入方法如下

#webResourceManager.requireResourcesForContext("hello-worlds")
以上就是關于插件配置文件的介紹,下一章節我們正式開始開發自定義插件,先以自定義Confluence主題為例.

總結

以上是生活随笔為你收集整理的confluence添加用户_玩转Confluence插件开发插件模块配置文件介绍(04)的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。