Confluence 6 在你用户宏中使用参数

你可以为你的用户宏指定参数。这样的话,用户可以使用参数来决定 Confluence 页面的显示情况。
如何在 Confluence 页面中使用你的宏参数当添加一个宏到 Confluence 页面中的时候,宏浏览器将会为每一个选择的宏显示输入字段,这个输入字段就是你需要指定的参数。
定义参数在模板中的参数定义为:

  • @param
  • 参数的名称
  • 一系列属性(可行)。

格式:

@param MYNAME:title=MY TITLE type=MY TYPE desc=MY DESCRIPTION required=true multiple=true default=MY DEFAULT VALUE

其他说明:

  • 在模板中参数的排序决定了参数在宏浏览器中显示的顺序。
  • 我们推荐你在模板的顶部定义你的所有参数。
  • 有可能有一些附加的属性,这个基于你的参数类型。

下面的表格说明了描述了每一个属性的详细信息。

参数名称(Parameter name) 参数的独一无二的名称。这个参数名称在所有参数属性列表中的第一位。这个名字属性本身是没有名字的。
示例: 下面的代码定义了 2 个参数,名字为 ‘foo’ 和 ‘bar’:

@param foo## @param bar

参数类型(Parameter type) 这个字段定义了参数的类型。如果你没有指定一个类型,那么默认的类型为 string。

在你的宏代码中使用参数 参数在你的模板中可以使用 $paramfoo, $parambar 进行调用 “foo” 和 “bar” 参数名。

通常情况下,一个参数像 $paramfoo 如果丢失,或者没有定义的话,那么页面将会输出显示为 ‘$paramfoo’ 。如果你不希望输出成这样,而是希望完全不输出,你可以使用感叹号标记,如下所示 $!paramfoo

使用无参数 如果你的宏不接受参数,那么你应该在你的模板中使用 @noparams
如果用户宏包含无参数,同时也没有指定 @noparams,那么宏浏览器将会显示一个无格式的文本输入框,允许用户输入没有定义的参数。这个可能会与宏不接受参数相混淆。

例如: 添加下面的行到你的模板中:

@noparams