Confluence 6 用户宏最佳实践

最新推荐文章于 2025-08-16 10:17:25 发布

转载最新推荐文章于 2025-08-16 10:17:25 发布 · 83 阅读

0 ·

CC 4.0 BY-SA版权

原文链接：https://yq.aliyun.com/articles/648775

本文提供了创建用户宏的小技巧和建议，包括添加描述、展示参数、设置默认值等内容，并强调了安全性的重要性。

这个页面为你在创建用户宏的最佳实践中包含了一些小技巧和建议。

为你的宏添加一个简短的描述

我们鼓励你为你的宏在 模板（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

在宏浏览器中展示你的参数

宏浏览器是为你用户使用配置你的宏的最简单的方式。你可以指定你的宏的分类，图标的连接定义在宏浏览器中为用户展示的信息的参数等。

为宏参数提供默认值

一般来说你不能保证用户能够完整的提供用户的参数，一个让宏进行校验是否收到了正确的参数的话，你可以在你的宏中指定参数并在后面使用。

请参考下面的示例，在这个宏中有 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