页面树结构
Skip to end of metadata
Go to start of metadata

内容标签显示宏将会按照指定的特定标签显示被标记的页面,博客页面和附件。

使用内容标签宏

如果希望将页面标签显示宏添加到页面:


  1. 打开你希望编辑 Confluence 页面,然后单击 编辑(Edit)按钮。页面的编辑模式将会被打开。
  2. 下一步,在编辑工具栏中单击宏浏览器图标。这时候宏浏览器将会在屏幕的中间打开。
  3. 在宏浏览器中,在窗口的右上角的对话框中输入你希望插入的宏的名称。当找到与你输入的宏名称接近的宏后将会在中间的面板上显示。单击需要的宏然后来查看可用进行配置的宏选项,在这里你可以对需要插入的宏设置相关参数,然后单击 插入(insert来将需要的宏插入到页面中。


参数

宏参数的定义为,你可以使用这些参数在宏输出的内容和格式上进行定义。

Confluence 使用的存储格式或者 wikimarkup 格式中使用的参数和在宏浏览器中使用的标签是不同的,这些将会在下面在括号内容中列出(example)。


参数

默认值

说明

标签名称
(labels

None

按照标签过滤。这个宏仅仅显示指定了的标签内容。请参考下面 操作符(Operator )参数的说明。

这个参数是必须的,你需要指定一个或者多个标签。标签可以使用逗号或者单一空格进行分隔。

  • 如果你希望扩展标签的的匹配内容,你可以在标签名字前加一个横线(-)。例如:如果你指定一个标签的名字为 -badpage 那么你将会找到所有没有标记为 'badpage' 标签的页面。
  • 如果你希望某一个页面必须包含有某一个标签值,你需要在标签值之前加一个加号(+)。例如:如果你指定一个标签 +superpage,+goodpage 你将会找到页面至少包含有 2 个标签,而且这些页面的标签中都包含有字符 'superpage' 和 'goodpage'。

作者
(author

None

按照作者进行过滤。如果你指定了作者,那么这个宏将会仅仅显示有你指定作者的页面。

指定一个或者多个作者,请使用逗号分隔符。

例如: jsmith,jbrown

如果希望包含一个作者,然后剔除其他作者,请使用下面的格式: jsmith,!jbrown 

仅包含这个内容类型(Include this Content Type Only)
(type

all

按照内容类型进行过滤。如果你指定了内容类型,那么这个宏将会仅仅显示你指定的内容类型。

指定一个或者多个内容类型,请使用逗号或者空格分隔符。

如果不包含特定的内容类型,在内容类型钱添加一个减号(-)。例如,如果你指定了内容类型  -blogpost ,你将会得到除了博客页面的页面和所有其他内容。

可用的值:

  • page – 页面。
  • blogpost 或者 news – 博客页面 和已知的新主题。
  • attachment – 附件。

为美国页面显示标签(Show Labels for Each Page)
(showLabels

true

在结果中显示或者隐藏标签。

为页面显示空间名(Show Space Name for Each Page)
(showSpace

true

在结果中显示或者隐藏空间。

标题列表(List Title)
(title

None

在结果中显示或者隐藏标题。

页面最大数量(Maximum Number of Pages)
(max

15

限制结果中显示的数量。注意,在结果处理的时候先对结果进行排序,然后在对显示结果的数量进行控制。parameter is applied.

显示摘要(Display Excerpts)
(excerpt

false

为显示的页面列表显示摘要。注意你必须为你的页面定义摘要,你需要通过 包含摘要宏 为页面定义只要。

只有摘要的第一行被显示。

限制到空间(Restrict to these Spaces)
(spaces

@all

按照空间进行过滤。宏将会显示指定中间中的内容,换句话说将会在指定的空间中进行内容查找。

指定一个或者多个空间的 Key,使用逗号或者空格进行分隔。

  • 如果希望不包含某一个空间,可以在空间名前面加一个横线(-)。例如:如果你不希望包含有一个空间 BADSPACE,那么你可以使用 -BADSPACE 定义。
  • 如果希望你的结果必须从某一个空间里面来,那么你可以在空间名字的前面加一个加号(+)。例如:如果你指定一个空间名字为 +GOODSPACE ,你将会仅仅得到从 GOODSPACE 中来的内容。(请注意:这个功能不是必须的,因为每一个博客必须得属于一个空间。如果这个加号标记在一个空间名字前同时也在其他空间名字前面,那么这个标记将会被忽略)。

值:

  • @self — 当前空间
  • @personal — 所有的个人空间
  • @global — 所有的站点空间
  • @favorite — 所有你标记为关注的空间
  • @favourite — 与上面 @favorite 是一样的
  • @all — Confluence 站点的所有空间
  • * — 与上面 @all 是一样的

当你指定一个个人空间的时候,请记住在个人空间名字前加一个波浪符(~)例如 ~jblogs 或者 ~jbloggs@example.com 。

操作符(Operator)
(operator

OR

当空间内容标签进行定义的时候,这个参数将会被使用:

  • OR – 任何包含有指定标签的页面。
  • AND  – 显示所有内容,必须包含有所有指定的标签。

    (信息) 注意这个参数值对标签的值有效,如果标签值签名有加号 (+) 或者减号 (-) 的话,这 2 个符号将会被忽略。

排序方式(Sort By)
(sort

modified

指定返回的结果如何进行排序。

值:

  • title — 按照标题字母排序
  • creation — 按照内容被添加的时间进行排序
  • modified — 按照内容被最后修改的时间进行排序

注意:如果这个参数没有被指定的话,那么排序默认采用的是记忆最后的修改时间降序排序。

如果希望不使用增序或者降序的排序,使用 逆向排序(Reverse Sort) 参数。

逆向排序(Reverse Sort)
(reverse

false

选择 逆向排序(Reverse Sort)来修改排序方式从增序到降序。使用这个参数需要结合 排序方式(Sort By)参数一同使用。如果你没有指定 排序方式(Sort By)这个参数的话,逆向排序的这个参数就会被忽略。

代码示例

下面的代码是提供给希望进一步编辑 Confluence 页面的高级用户使用的。

宏名称: contentbylabel

宏内容: None

存储格式示例

<ac:structured-macro ac:name="contentbylabel">
  <ac:parameter ac:name="spaces"/>
  <ac:parameter ac:name="author">admin,smaddox</ac:parameter>
  <ac:parameter ac:name="title">My labelled pages</ac:parameter>
  <ac:parameter ac:name="showLabels">false</ac:parameter>
  <ac:parameter ac:name="reverse">true</ac:parameter>
  <ac:parameter ac:name="sort">creation</ac:parameter>
  <ac:parameter ac:name="max">10</ac:parameter>
  <ac:parameter ac:name="excerpt">true</ac:parameter>
  <ac:parameter ac:name="labels">chocolate,cake</ac:parameter>
  <ac:parameter ac:name="showSpace">false</ac:parameter>
  <ac:parameter ac:name="type">page</ac:parameter>
  <ac:parameter ac:name="operator">AND</ac:parameter>
</ac:structured-macro>

Wiki 标记示例

{contentbylabel:spaces=@personal,@self|author=admin,smaddox|title=My labelled pages|showLabels=false|reverse=true|sort=creation|max=10|excerpt=true|labels=chocolate,cake|showSpace=false|type=page|operator=AND}


  • 无标签