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

你能夠決定宏參數在 Confluence 編輯器中如何進行顯示的。api

在默認的狀況下,在宏佔位符下儘量顯示能顯示的全部參數:app

你能夠控制這裏顯示的參數數量,經過這種控制你可能儘可能的爲編輯者提供有效的信息。編輯器

例如,在 Confluence 的通過宏中有 2 個參數,titleicon。咱們考慮到 title 是最有意義的參數,所以咱們配置了通過宏顯示了 title 參數的具體值。url

讓咱們假設一個編輯用戶添加了一個警告宏到編輯頁面中。而後給了標題名稱爲 'The title of the warning'。在編輯器中的宏佔位符將會顯示下面的內容:spa

爲一個用戶宏配置宏佔位符,你須要添加參數屬性 @param 到整個模板中。code

例如,若是咱們的通過宏是一個用戶宏,那麼配置的 title 參數以下所示:orm

## @param title:type=string|option-showNameInPlaceholder=false|option-showValueInPlaceholder=true

屬性 showNameInPlaceholder 指定了 title 下面顯示的參數的名字。get

屬性 showValueInPlaceholder 指定了 title 參數的 value 值應該在下面顯示。string

若是在宏中沒有上面的的 2 個參數沒有包含有任何值,那麼默認的配置將會在佔位符中顯示:完整的名字和值。it

若是一個或多個參數屬性被設置了,那麼是全部不包含有屬性的參數將會默認顯示爲 false(例如這裏將不會顯示)。

 

https://www.cwiki.us/display/CONFLUENCEWIKI/User+Macro+Template+Syntax

相關文章
相關標籤/搜索