1. 程式人生 > >Confluence 6 在你使用者巨集中使用引數

Confluence 6 在你使用者巨集中使用引數

你可以為你的使用者巨集指定引數。這樣的話,使用者可以使用引數來決定 Confluence 頁面的顯示情況。

如何在 Confluence 頁面中使用你的巨集引數

當新增一個巨集到 Confluence 頁面中的時候,巨集瀏覽器將會為每一個選擇的巨集顯示輸入欄位,這個輸入欄位就是你需要指定的引數。

定義引數

在模板中的引數定義為:

  • @param
  • 引數的名稱
  • 一系列屬性(可行)。

格式:

## @param MYNAME:title=MY TITLE|type=MY TYPE|desc=MY DESCRIPTION|required=true|multiple=true|default=MY DEFAULT VALUE

其他說明:

  • 在模板中引數的排序決定了引數在巨集瀏覽器中顯示的順序。
  • 我們推薦你在模板的頂部定義你的所有引數。
  • 有可能有一些附加的屬性,這個基於你的引數型別。

下面的表格說明了描述了每一個屬性的詳細資訊。

(an unnamed, first attribute) 引數的獨一無二的名稱。這個引數名稱在所有引數屬性列表中的第一位。這個名字屬性本身是沒有名字的。請單擊 name 檢視詳細資訊。 必須(Required)
title 在巨集瀏覽器中顯示的引數標題。如果你沒有指定一個標題的話,Confluence 將會使用引數名稱 推薦(Recommended)
type 引數的型別欄位。請單擊  type 獲得允許的型別 推薦(Recommended)
desc 在巨集瀏覽器中顯示的引數描述 可選(Optional)
required 指定使用者是否必須為這個引數輸入值(預設:否) 可選(Optional)
multiple 指定引數是否接受多變數值(預設:否) 可選(Optional)
default 引數的預設變數值 可選(Optional)

引數名稱(Parameter name)

引數的獨一無二的名稱。這個引數名稱在所有引數屬性列表中的第一位。這個名字屬性本身是沒有名字的。

示例:下面的程式碼定義了 2 個引數,名字為 'foo' 和 'bar':

## @param foo
## @param bar

引數型別(Parameter type)

這個欄位定義了引數的型別。如果你沒有指定一個型別,那麼預設的型別為  string

boolean 顯示選擇框(checkbox )允許使用者進行選擇和取消選擇。這個將會向巨集傳遞 'true' 或 'false'。請注意巨集接受到的是字串。
enum

通常列出可以供選擇的列表。你可以指定顯示的一系列值,然後將會在巨集瀏覽器中通過下拉選擇進行選擇。例如,你指定了下面的列舉型別變數:

## @param colour:title=Colour|type=enum|enumValues=Grey,Red,Yellow,Green

注意 i18n:Confluence 並不支援國際化的列舉變數型別。使用者可以看到的變數就是實際傳遞過去的變數,同時變數將首字母大寫。在這裡,使用者將會看到 'Grey', 'Red', 等。

string

文字字元型別。這是預設的型別。例如一個需要的欄位:

## @param status:title=Status|type=string|required=true|desc=Status to display
confluence-content

為使用者提供一個控制器允許使用者在頁面和部落格頁面中進行查詢。例如:

## @param page:title=Page|type=confluence-content|required=true|desc=Select a page do use
username

查詢使用者

## @param user:title=Username|type=username|desc=Select username to display
spacekey

提供空間選擇的列表。請輸入空間的 Key 到使用者巨集。例如:

## @param space:title=Space|type=spacekey
date

Confluence 能夠接受這個引數型別,但是這個引數將會按照字串進行處理。例如:

## @param fromDate:title=From Date|type=date|desc=Date to start from. Format: dd/mm/YYYY 

日期型別說明:使用者可以輸入任何格式的日期型別,你應該在你使用者巨集中校驗日期格式。

int

Confluence 能夠接受這個引數型別,但是這個引數將會按照字串進行處理。例如下面一個預設的變數:

## @param numPosts:title=Number of Posts|type=int|default=15|desc=Number of posts to display
percentage

Confluence 能夠接受這個引數型別,但是這個引數將會按照字串進行處理。例如:

## @param pcent:title=Percentage|type=percentage|desc=Number of posts to display 

在你的巨集程式碼中使用引數

引數在你的模板中可以使用 $paramfoo$parambar 進行呼叫  "foo" 和 "bar" 引數名。

通常情況下,一個引數像 $paramfoo 如果丟失,或者沒有定義的話,那麼頁面將會輸出顯示為 '$paramfoo' 。如果你不希望輸出成這樣,而是希望完全不輸出,你可以使用感嘆號標記,如下所示 $!paramfoo

使用無引數

如果你的巨集不接受引數,那麼你應該在你的模板中使用 @noparams

如果使用者巨集包含無引數,同時也沒有指定 @noparams,那麼巨集瀏覽器將會顯示一個無格式的文字輸入框,允許使用者輸入沒有定義的引數。這個可能會與巨集不接受引數相混淆。

例如:新增下面的行到你的模板中:

## @noparams

相關推薦

Confluence 6使用者巨集使用引數

你可以為你的使用者巨集指定引數。這樣的話,使用者可以使用引數來決定 Confluence 頁面的顯示情況。 如何在 Confluence 頁面中使用你的巨集引數 當新增一個巨集到 Confluence 頁面中的時候,巨集瀏覽器將會為每一個選擇的巨集顯示輸入欄位,這個輸入欄位就是你需要指定的引數。 定義引

Confluence 6 模板可用的物件

包含巨集正文和引數,下面的 Confluence 物件在巨集中可用: $body 巨集的正文(如果巨集有正文的話) String $paramfoo, $parambar, ...$param<name> 傳遞到你巨集中被命名的引數("foo", "bar")

Confluence 6 在編輯器控制引數的顯示

你可以決定巨集引數在 Confluence 編輯器中如何進行顯示的。 在預設的情況下,在巨集佔位符下儘可能顯示能顯示的所有引數: 你可以控制這裡顯示的引數數量,通過這種控制你可能儘量的為編輯者提供有效的資訊。 例如,在 Confluence 的經過巨集中有 2 個引數,title 和 icon。我們

Confluence 6.15 附件巨集引數

引數 引數名稱 預設值 描述 File

Confluence 6 從外部目錄同步數據支持的目錄類型

Confluence針對一些特定的用戶目錄類型,Confluence 在系統的數據庫中保存了目錄的緩存信息(用戶和用戶組),這樣能夠讓系統更快速的訪問用戶和用戶組數據。一個數據同步的進程將會間歇性的在系統中運行來將遠程的 LDAP 數據信息同步到本地。數據緩存和同步可以支持下面的用戶目錄類型:LDAP(Mic

Confluence 6 從外部目錄同步數據如何工作

Confluence下面是有關緩存功能的一些摘要信息:用戶和用戶組的緩存信息保存在應用程序的數據庫中。當你連接一個新的外部目錄到系統中的時候,一個同步任務將會啟動被,並且在後臺運行拷貝所有需要的用戶和用戶組信息,以及用戶組的成員信息到本地的應用數據庫中。這個進程可能會花費一些時間,所花費的時間基於你拷貝的 L

Confluence 6 在編輯器控制參數的顯示

Confluence你可以決定宏參數在 Confluence 編輯器中如何進行顯示的。在默認的情況下,在宏占位符下盡可能顯示能顯示的所有參數:你可以控制這裏顯示的參數數量,通過這種控制你可能盡量的為編輯者提供有效的信息。例如,在 Confluence 的經過宏中有 2 個參數,title 和 icon。我們考

Confluence 6 從其他備份恢復數據

https acl spl 進行 TE wiki http clas other 一般來說,Confluence 數據庫可以從 Administration Console 或者 Confluence Setup Wizard 中進行恢復。如果你在恢復壓縮的 XML 備份的

Confluence 6 從一個備份獲得文件附件

www. dmi 自動 頁面 允許 ini www 自動備份 config 頁面中的文件附件可以從備份中獲得而不需要將備份文件導入到 Confluence 中。這個在用戶刪掉了附件,但是你還是想恢復這個附件的時候就變得非常有用了。自動備份和手動備份都允許你進行這個操作,但是

Confluence 6 從一個模板建立一個空間

Confluence 已經儲存了一系列的模板,這些模板被稱為 空間藍圖(space blueprints),這模板具有一些自定義的主頁,邊欄或者可能有藍圖頁面或一些示例內容來幫助你開始使用 Confluence。 這個頁面是有關空間的藍圖的。你可以檢視 Blueprints 

Confluence 6 內容在空間是如何組織的

你可以將空間考慮為一個容器,在這個容器中保持了有關你專案中所有重要的東西,包括小組,專案或者專案相關的工作。這些東西有很高的自主性,這表示的是每個空間都有自己的的頁面,檔案,評論以及 RSS 新聞源。 每一個空間可以自主的建立一個主頁—— 使用者導航到你空間中看到的第一個頁面。你可以對你的空間主頁和邊欄進行

Confluence 6 從其他備份恢復資料

如果你在恢復壓縮的 XML 備份的時候遇到了問題,你還是可以對整個站點進行恢復的,如果你能提供下面 2 個備份的話: 一個有關 home 目錄的所有備份。 一個有關你資料庫的備份(如果你使用的是外部資料庫的話)。 有關恢復備份的方法基於你使用的是內部資料庫還是外部資料庫會有些不同。外部資料庫

Confluence 6 從一個備份獲得檔案附件

頁面中的檔案附件可以從備份中獲得而不需要將備份檔案匯入到 Confluence 中。這個在使用者刪掉了附件,但是你還是想恢復這個附件的時候就變得非常有用了。 自動備份和手動備份都允許你進行這個操作,但是需要 包含附件(Include attachments)選項需要被設定。如果你希望恢復頁面,空間,或者

Confluence 6 從生產環境恢復一個測試例項

很多 Confluence 的管理員將會使用生產例項執行完整資料和服務的 Confluence 伺服器,同時還會設定一個測試例項來測試升級等。在這種情況下,你的 Confluence 可以回執行 2 個不同的版本,而且也是非常常見的。這個文件將會知道你如何拷貝生產環境中的資料到一個測試例項

Confluence 6 使用 Velocity 巨集

當編輯自定義 Decorator 模板檔案的時候,有一些巨集可被用來定義頁面中複雜或者多變的內容,例如選單,連結等。你可以插入這些巨集到你的模板中。更多的資訊,請參考Working With Decorator Macros 頁面中的內容。 (adsbygoogle = wi

Confluence 6 從外部目錄同步資料配置同步間隔

你可以在目錄配置介面中設定 同步間隔(Synchronisation Interval)。同步間隔時間指的是 2 個從目錄伺服器上查詢請求的間隔時間。 為你的系統設定同步間隔時間基於下面的一些考慮: 你可以容許I系統資料不同步的長度。 你目錄伺服器和你本地應用的中同步的資料量。 你使用者的數量。

Confluence 6 使用 Decorator 巨集

Decorator 巨集(Macros)是 Velocity  巨集。這個巨集可以被用來在頁面編輯 Custom decorators 中建立複雜或者可變的部分,例如選單,頁面其他部分等。Decorator 巨集可以在你的模板中的任何位置插入。 這個巨集可以用下面的方法插入到模板頁面中: #macroNam

Confluence 6 在資料來源連線啟用校驗查詢

確定 Confluence 在資料庫連線池中校驗資料庫連線: 停止 Confluence。 編輯 <installation-directory>/conf/server.xml 檔案(或者基於在那裡你配置你的資料來源)。 針對你的額資料來源找到 Resource 元素,然後新增 "va

Confluence 6的 LDAP 目錄優化用戶和用戶組數量

Confluence連接 LDAP 服務器能為你的用戶管理提供靈活高效的解決方案。為了達到優化的性能,後臺同步程序將會從 LDAP 上查找和下載數據同步到你本地的 Confluence 服務器數據庫上同時還會定時的更新數據以保持 Confluence 的數據與 LDAP 上的數據是一致的。在對用戶進行同步,拷

基於 Confluence 6 數據中心在的 Atlassian 應用配置 SAML 授權

基本配置 sin content value 二級 png ice 發出 exist 希望在 Confluence 中配置SAML: Go to > 基本配置(General Configuration) > SAMl 授權(SAML Authen