1. 程式人生 > >Confluence 6 創建一個用戶宏

Confluence 6 創建一個用戶宏

Confluence

如果你想創建自定義的宏的話,用戶宏能夠幫你完成這個任務。這個可以在你系統中應用特定的操作,比如說應用自定義格式等。

用戶用是在 Confluence 創建和和管理的,你需要有一定的編碼基礎才可以。

你需要具有系統管理員權限來創建和應用用戶自定義宏。

希望創建一個新的用戶宏:

  1. 進入 技術分享圖片 > 基本配置(General Configuration) > 用戶宏(User Macros)

  2. 選擇 創建一個用戶宏(Create a User Macro)

  3. 輸入宏的一些詳細信息(請查看下面列表)

  4. 單擊 添加(Add)

宏名稱(Macro name)宏的名字,將會出現在代碼中。

可見(Visibility

這個選項控制誰可以在宏瀏覽器中查看這個宏或者自動完成功能。選項有:

  • 所有用戶可見(Visible to all users)

  • 僅系統管理員可見(Visible only to system administrators)

請註意,如果你選擇僅系統管理員可見的話,用戶任然可以看到用在頁面中輸出的結果,宏的占位符也還是在編輯頁面中出現的,這個僅僅在宏瀏覽器和自動完成的時候隱藏了。

所有宏的信息都是可以找到的,包括宏的標題,描述,參數名稱和其他元數據。盡管宏只能被系統管理員查看到,也請不要在用戶宏中定義任何敏感信和保密信息。

宏標題(Macro Title)在宏瀏覽器和自動完成功能中出現的宏標題。
描述(Description)這個描述信息將會出現在宏瀏覽器中。宏瀏覽器的查找將會對查找字段在宏標題和描述中的文字進行匹配。
分類(Categories)為你的宏在宏瀏覽器中選擇一個或多個分類。
圖標 URL(Icon URL如果你希望宏瀏覽器為你的宏顯示圖標的話,輸入絕對地址(例如 http://mysite.com/mypath/status.png)或相對於 Confluence base URL 的相對地址(例如:/images/icons/macrobrowser/status.png) 。
文檔 URL(Documentation URL)如果你的宏有文檔的話,請在這裏輸入文檔的 URL。
宏內容處理(Macro Body Processing)

指定 Confluence 應該如何處理你的宏的內容。

宏的內容中包含了在 Confluence 頁面中如何處理的信息。如果你的宏有一個內容,所有宏的內容將會在 $body

變量字段中可用。

處理宏內容字段選項包括有:

  • No macro body
    選擇這個選項,如果你的宏沒有任何內容的話。

  • Escaped
    Confluence 將會添加在 HTML 標記中添加轉義字符。如果你希望顯示 HTML 標記在生產的頁面中的時候,你可以使用轉義字符。例如:如果內容為 <b>Hello World</b> 那麽將會在生成頁面中顯示 <b>Hello World</b>。

  • Unrendered
    內容中的 HTML 將會在模板輸出之前進行處理。請確定模板中的 HTML 是非再生的。

  • Rendered
    Confluence 將會對 HTML 宏內容的部分進行讓瀏覽器進行解析。例如宏內容為 <b>Hello World</b> 這個內容將會顯示 Hello World。

模板(Template

這裏是你寫的代碼去確定宏應該是什麽樣子的。

  • 在宏模板中使用 HTML 和 Confluence 自定義 XML 元素。

  • 你可以使用 Velocity 模板語言。這裏是有關 Velocity project 項目的相關信息。

  • 如果你的宏有 body 內容,你的宏可以將 body 的文本引用為 '$body'。

  • 每個參數變量必須有一個與之對應的元數據定義。在你的宏參數中使用 @param 來定義元數據。

  • 當使用參數傳遞信息,請參考 $paramXXX 在 'XXX' 的參數,是你定義 @param 元數據後來引用的參數。

  • 如果你的宏不能接受參數,請使用 @noparams

請查看 Writing User Macros 要麽獲得更多的信息和示例。

希望使用插件完成編輯?

如果你希望將你的自定義宏按照插件進行分發的話,請參考 User Macro plugin module 頁面中的內容。如果你希望使用更加復雜,更加程序化的宏的話,你需要寫成 Macro plugin 宏。

https://www.cwiki.us/display/CONFLUENCEWIKI/Writing+User+Macros


Confluence 6 創建一個用戶宏