Confluence 6 用戶宏最佳實踐

時間 2019-11-12

標籤 confluence 用戶最佳實踐简体版

原文原文鏈接

這個頁面爲你在建立用戶宏的最佳實踐中包含了一些小技巧和建議。java

爲你的宏添加一個簡短的描述

咱們鼓勵你爲你的宏在 模板（Template ）添加一個備註的描述，能夠參考下面的顯示的內容：瀏覽器

## Macro title: My macro name
## Macro has a body: Y or N
## Body processing: Selected body processing option
## Output: Selected output option
##
## Developed by: My Name
## Date created: dd/mm/yyyy
## Confluence version: Version it was developed for
## Installed by: My Name

## Short description of what the macro does

在宏瀏覽器中展現你的參數

宏瀏覽器是爲你用戶使用配置你的宏的最簡單的方式。你能夠指定你的宏的分類，圖標的鏈接定義在宏瀏覽器中爲用戶展現的信息的參數等。安全

爲宏參數提供默認值

通常來講你不能保證用戶可以完整的提供用戶的參數，一個讓宏進行校驗是否收到了正確的參數的話，你能夠在你的宏中指定參數並在後面使用。eclipse

請參考下面的示例，在這個宏中有 3 個參數，當用戶不提供參數的時候，這些參數的默認值將會被使用。測試

 
         #set($spacekey= $paramspacekey) 
        
         #set($numthreads= $paramnumthreads) 
        
         #set($numchars= $paramnumchars) 
        
         ## Check  
         for 
         valid space key, otherwise use current 
        
         # 
         if 
         (!$spacekey) 
        
         #set ($spacekey=$space.key) 
        
         #end 
        
         ## Check  
         for 
         valid number of threads, otherwise use  
         default 
         of  
         5 
        
         # 
         if 
         (!$numthreads) 
        
         #set ($numthreads= 
         5 
         ) 
        
         #end 
        
         ## Check  
         for 
         valid excerpt size, otherwise use  
         default 
         of  
         35 
        
         # 
         if 
         (!$numchars) 
        
         #set ($numchars= 
         35 
         ) 
        
         #end