Confluence 6 在編輯器中控制參數的顯示
阿新 • • 發佈:2018-04-27
Confluence你可以決定宏參數在 Confluence 編輯器中如何進行顯示的。
在默認的情況下,在宏占位符下盡可能顯示能顯示的所有參數:
你可以控制這裏顯示的參數數量,通過這種控制你可能盡量的為編輯者提供有效的信息。
例如,在 Confluence 的經過宏中有 2 個參數,title 和 icon。我們考慮到 title 是最有意義的參數,因此我們配置了經過宏顯示了 title 參數的具體值。
讓我們假設一個編輯用戶添加了一個警告宏到編輯頁面中。然後給了標題名稱為 'The title of the warning'。在編輯器中的宏占位符將會顯示下面的內容:
為一個用戶宏配置宏占位符,你需要添加參數屬性 @param 到整個模板中。
例如,如果我們的經過宏是一個用戶宏,那麽配置的 title 參數如下所示:
## @param title:type=string|option-showNameInPlaceholder=false|option-showValueInPlaceholder=true
屬性 showNameInPlaceholder
指定了 title 下面顯示的參數的名字。
屬性 showValueInPlaceholder
指定了 title 參數的 value 值應該在下面顯示。
如果在宏中沒有上面的的 2 個參數沒有包含有任何值,那麽默認的配置將會在占位符中顯示:完整的名字和值。
如果一個或多個參數屬性被設置了,那麽是所有不包含有屬性的參數將會默認顯示為 false(例如這裏將不會顯示)。
https://www.cwiki.us/display/CONFLUENCEWIKI/User+Macro+Template+Syntax
Confluence 6 在編輯器中控制參數的顯示