参数是让你可以用来控制宏的格式和输出的选项。在 Confluence 存储格式或者 Wiki 标记(wikimarkup)中使用的参数名与在宏浏览器中使用的标签名是不同的,在下面我们将会用括号列出 (example)
。
参数 | 是否是必须 | 默认值 | 说明 |
---|---|---|---|
显示的内容类型(Content Type to Display)(content) | No | titles | 可用的值:titles — 在博客页面中仅显示标题。excerpts — 为美国博客显示短摘要。如果博客有包含摘要宏,那么博客页面宏将会显示博客摘要中的内容。如果博客没有摘要宏,那么博客页面将会显示博客的前几个句子。entire - 为每一个博客显示完整的内容。 |
时间帧(Time Frame)(time) | No | 无限制 | 指定 Confluence 在博客中查找的时间范围。可用的值:m — 分钟h — 小时, 如果你指定为 '12h' 的话,那么将会显示最新 12 个小时添加的博客。d — 天,如果你指定为 '7d' 的话,那么将会显示博客最新七天的博客。w — 周 |
标签限制(Restrict to these Labels)(label) | No | None | 通过标签过来结果。宏将会仅仅显示包含有你指定标签的博客,换句话说就是按照标签过滤。你可以通过逗号分隔符来指定一个或者多个标签。如果你希望扩展标签的的匹配内容,你可以在标签名字前加一个横线(-)。例如:如果你指定一个标签的名字为 -badpage 那么你将会找到所有没有标记为 'badpage' 标签的页面。如果你希望某一个页面必须包含有某一个标签值,你需要在标签值之前加一个加号( )。例如:如果你指定一个标签 superpage, goodpage 你将会找到页面至少包含有 2 个标签,而且这些页面的标签中都包含有字符 'superpage' 和 'goodpage'。 |
作者限制(Restrict to theseAuthors )(author) | No | None | 对返回的结果通过作者过滤。博客页面宏将会仅仅将你指定的作者的博客显示出来。 |
空间限制(Restrict to these Spaces)(spaces) | No | @self 例如,在宏中显示空间包含的页面。 | 这个参数允许你通过空间过滤内容。如果这个参数被使用的话,将会显示你指定空间中的博客页面。你可以通过逗号分隔符来指定一个或者多个空间。如果希望不包含某一个空间,可以在空间名前面加一个横线(-)。例如:如果你不希望包含有一个空间 BADSPACE,那么你可以使用 -BADSPACE 定义。如果希望你的结果必须从某一个空间里面来,那么你可以在空间名字的前面加一个加号( )。例如:如果你指定一个空间名字为 GOODSPACE ,你将会仅仅得到从 GOODSPACE 中来的内容。(请注意:这个功能不是必须的,因为每一个博客必须得属于一个空间。如果这个加号标记在一个空间名字前同时也在其他空间名字前面,那么这个标记将会被忽略)。特殊值:@self — 当前空间@personal — 所有的个人空间@global — 所有的站点空间@favorite — 所有你标记为关注的空间@favourite — 与上面 @favorite 是一样的@all — Confluence 站点的所有空间* — 与上面 @all 是一样的当你指定一个个人空间的时候,请记住在个人空间名字前加一个波浪符(~)例如 ~jblogs 或者 ~jbloggs@example.com 。 |
博客页面的最大数量(Maximum Number of Blog Posts)(max) | No | 15 | 指定可以显示的的最大结果数量。请注意,在结果显示的时候,首先会对结果进行排序,然后在对结果输出的数量进行限制。 |
排序方式(Sort By)(sort) | No | creation | 指定结果如何被排序。如果这个参数没有被指定的话,那么将会按照内容的创建时间采用降序的方式进行排序(最新的在前面)。值:title — 按照标题字母排序creation — 按照内容被添加的时间进行排序modified — 按照内容被最后修改的时间进行排序 |
反向排序(Reverse Sort)(reverse) | No | false | 选择将排序从降序切换到升序(最老的在前面)。与参数 排序方式(Sort By)结合使用,如果你不指定排序方式的话,这个参数将会被忽略。在存储格式和 Wiki 格式中,可以使用边栏 true 来激活排序方式。 |
- titles — 在博客页面中仅显示标题。
- excerpts — 为美国博客显示短摘要。如果博客有包含摘要宏,那么博客页面宏将会显示博客摘要中的内容。如果博客没有摘要宏,那么博客页面将会显示博客的前几个句子。
- entire - 为每一个博客显示完整的内容。
时间帧(Time Frame)
(time
)No无限制指定 Confluence 在博客中查找的时间范围。
可用的值:
m
— 分钟h
— 小时, 如果你指定为 '12h
' 的话,那么将会显示最新 12 个小时添加的博客。d
— 天,如果你指定为 '7d
' 的话,那么将会显示博客最新七天的博客。w
— 周
标签限制(Restrict to these Labels)
(label
)NoNone通过标签过来结果。宏将会仅仅显示包含有你指定标签的博客,换句话说就是按照标签过滤。
你可以通过逗号分隔符来指定一个或者多个标签。
- 如果你希望扩展标签的的匹配内容,你可以在标签名字前加一个横线(-)。例如:如果你指定一个标签的名字为
-badpage
那么你将会找到所有没有标记为 'badpage' 标签的页面。 - 如果你希望某一个页面必须包含有某一个标签值,你需要在标签值之前加一个加号( )。例如:如果你指定一个标签
superpage, goodpage
你将会找到页面至少包含有 2 个标签,而且这些页面的标签中都包含有字符 'superpage' 和 'goodpage'。
作者限制(Restrict to theseAuthors )
(author
)NoNone对返回的结果通过作者过滤。博客页面宏将会仅仅将你指定的作者的博客显示出来。空间限制(Restrict to these Spaces)
(spaces
)No@self 例如,在宏中显示空间包含的页面。这个参数允许你通过空间过滤内容。如果这个参数被使用的话,将会显示你指定空间中的博客页面。
你可以通过逗号分隔符来指定一个或者多个空间。
- 如果希望不包含某一个空间,可以在空间名前面加一个横线(-)。例如:如果你不希望包含有一个空间 BADSPACE,那么你可以使用 -BADSPACE 定义。
- 如果希望你的结果必须从某一个空间里面来,那么你可以在空间名字的前面加一个加号( )。例如:如果你指定一个空间名字为
GOODSPACE
,你将会仅仅得到从 GOODSPACE 中来的内容。(请注意:这个功能不是必须的,因为每一个博客必须得属于一个空间。如果这个加号标记在一个空间名字前同时也在其他空间名字前面,那么这个标记将会被忽略)。
特殊值:
@self
— 当前空间@personal
— 所有的个人空间@global
— 所有的站点空间@favorite
— 所有你标记为关注的空间@favourite
— 与上面 @favorite 是一样的@all
— Confluence 站点的所有空间*
— 与上面 @all 是一样的
当你指定一个个人空间的时候,请记住在个人空间名字前加一个波浪符(~)例如 ~jblogs
或者 ~jbloggs@
example.com 。博客页面的最大数量(Maximum Number of Blog Posts)
(max
)No15指定可以显示的的最大结果数量。请注意,在结果显示的时候,首先会对结果进行排序,然后在对结果输出的数量进行限制。排序方式(Sort By)
(sort)
Nocreation指定结果如何被排序。如果这个参数没有被指定的话,那么将会按照内容的创建时间采用降序的方式进行排序(最新的在前面)。
值:
- title — 按照标题字母排序
- creation — 按照内容被添加的时间进行排序
- modified — 按照内容被最后修改的时间进行排序
反向排序(Reverse Sort)
(reverse
) Nofalse选择将排序从降序切换到升序(最老的在前面)。与参数 排序方式(Sort By)结合使用,如果你不指定排序方式的话,这个参数将会被忽略。
在存储格式和 Wiki 格式中,可以使用边栏 true
来激活排序方式。
Wiki markup example
宏名称: blog-posts
宏内容:None
{blog-posts:content=titles|spaces=@self,ds|author=jsmith|time=4w|reverse=true|sort=creation|max=10|label=chocolate,cookies} |
---|
https://www.cwiki.us/display/CONF6ZH/Blog Posts Macro