Confluence 6 用户宏最佳实践

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

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

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

考虑安全提示

我们建议你为你定义的宏进行一些权限方面的测试。例如，限制页面和空间权限来避免没有权限的用户可能的不经意间的显示。请查看 Writing User Macros 页面中的内容。

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

原文地址：http://blog.51cto.com/ossez/2107894

时间： 2024-10-07 14:10:15

Confluence 6 用户宏最佳实践的相关文章

Confluence 6 用户宏示例 - Hello World

下面示例显示了如何创建一个用户宏,在这个用户宏中显示文本 'Hello World!' 和任何用户在宏内容中输入的内容. Macro name helloworld Visibility Visible to all users in the Macro Browser Macro Title Hello World Description Displays "Hello World" and the macro body. Categories Confluence Content

Confluence 6 用户宏示例 - NoPrint

这个示例演示了如何创建一个用户宏,这个宏包括了在查看页面中显示的内容,但是不被打印. Macro name noprint Visibility Visible to all users in the Macro Browser Macro Title No Print Description Hides text from printed output. Categories Confluence Content Icon URL You can leave this field blank

Confluence 6 用户宏示例 - Formatted Panel

下面的用演示了如果还写一个用户宏,并在这个宏中创建一个格式化的面板,并且指定颜色.将会创建下面的面板: (Title) 注意:这个面板的标题为空,如果你没有给这个面板标题参数的话. Macro name formpanel Visibility Visible to all users in the Macro Browser Macro Title Formatted Panel Description Creates a panel preformatted with specific co

配置 Confluence 6 安全的最佳实践

让一个系统能够变得更加坚固的最好办法是将系统独立出来.请参考你公司的安全管理策略和相关人员来找到你公司应该采用何种安全策略.这里有很多事情需要我们考虑,例如考虑如何安装我们的操作系统,应用服务器,数据库服务器,网络,防火墙,路由等. 这里我们有可能对这些配置进行一些基本的描述. 这个页面中的安全配置是基于我们已知情况下的最好配置了. 配置 Web 服务器 请参考有关系统管理员中的下面有关的信息: 配置 Apache 服务器来限制相关页面只有需要管理员权限的用户才能进行访问:Using Apach

Confluence 6 用户宏示例 - Color and Size

这个示例定义了如何向你宏中传递参数.我们将会创建一个字体样式宏,在这个宏中有 2 个参数,允许用户在这 2 个参数中指定宏中包含的字体的颜色大小. Macro name stylish Visibility Visible to all users in the Macro Browser Macro Title Stylish Description Applies colour and size to text. Categories Confluence Content Icon URL

虚拟化--网络最佳实践

正确的网络配置是VMware vSphere架构的基础.为实现VMware网络,IT管理员需要了解vSphere宿主机的物理接口和虚拟交换机.学习如何规划vSphere的虚拟网络. VMware vSphere网络从正确安装vSphere网络的ESXi宿主机开始,包括对分布式.标准.虚拟或物理交换机的选择.最后还有后配置和部署.对虚拟网络的流量监控. 配置虚拟网络的第一步是把vSphere的部署集成到现有架构.您需要确实了解现有架构的状态.例如,如果网络采用了iSCSI(Internet sma

Confluence 6 数据中心的 SAML 单点登录最佳实践和故障排除

最佳实践 SAML 授权仅仅在有限的时间进行校验.你需要确定运行你的应用的计算机时间与 IdP 的时间是同步的. 如果你应用中的用户和用户组是通过用户目录进行配置的,你通常希望用户来源目录和你的 IdP 和 Atlassian 应用使用相同的 LDAP 目录.用户需要在用户目录支中存在才可以使用 SSO 进行登录. 故障排除 如果你错误的配置了 SAML 收取,或者不能登录到你的 IdP.你可以通过删除请求来让你的登录授权恢复(在你用户目录中为一个管理员用户配置使用一个用户名和密码). curl

Azure虚拟机管理最佳实践之用户凭据

还记的之前老猫关于通过Powershell远程管理Azure中虚拟机的博文的脚本中,每个虚拟机访问都需要通过get-credential交互方式取得用于访问的用户凭据,但是这这种方式每次都要进行用户交互,如果反复运行的脚本显然不是个好方式,如何加密保留用户的凭据以便反复使用就是个最佳实践的内容.当然现在国际版Azure中提供的自动化服务功能包含的Asset可以安全保留凭据用于自动化脚本调用,由于目前国内的Azure服务还没有这项功能,因此暂时只能按下不表了,当然如果只能这样本文也就结束了,这里介

Confluence 6 创建一个用户宏

如果你想创建自定义的宏的话,用户宏能够帮你完成这个任务.这个可以在你系统中应用特定的操作,比如说应用自定义格式等. 用户用是在 Confluence 创建和和管理的,你需要有一定的编码基础才可以. 你需要具有系统管理员权限来创建和应用用户自定义宏. 希望创建一个新的用户宏: 进入  > 基本配置(General Configuration) > 用户宏(User Macros) 选择 创建一个用户宏(Create a User Macro) 输入宏的一些详细信息(请查看下面列表) 单击 添加(