Confluence 6 在编辑器中控制参数的显示

你可以决定宏参数在 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(例如这里将不会显示)。