This page last changed on Jun 17, 2007 by rosie@atlassian.com.

You need to edit in 'Wiki Markup' mode to include macros in your page.

The Contentbylabel macro lists content associated with specific labels.

Contentbylabel Macro

What you need to type What you will get
{contentbylabel:documentation, my:stuff}
1. System Requirements (Crowd 1.1) Labels: overview, api, guide, crowd, documentation
1. System Requirements (Crowd 1.2) Labels: documentation, crowd, guide, api, overview
1.1 Concepts (Crowd 1.1) Labels: crowd, documentation, guide, overview, framework, architecture, middleware, api, integration, directory, application, authentication, authorisation, single-sign-on, identity, concepts, security, sso, login, provisioning
1.1 Concepts (Crowd 1.2) Labels: provisioning, login, sso, security, concepts, identity, single-sign-on, authorisation, authentication, application, directory, integration, api, middleware, architecture, framework, overview, guide, documentation, crowd
1.1 Setting JAVA_HOME (Crowd 1.1) Labels: documentation, crowd, guide, api, overview


By default, Confluence lists all the labels for each result displayed. See optional parameters below to disable this.

Recommended Default Usage

To display all pages with the label needs-fixing, use:

{contentbylabel:needs-fixing|showLabels=false|maxResults=99|showSpace=false}




Optional Parameters

No  parameter Default Description
 1 key all Filter by space
(Note: Keywords @all and @self are available with Confluence 2.2.2 and higher.)
 2 type false Filter by content type
 3 showLabels true Show or hide labels for results
 4 showSpace true Show or hide spaces for results
 5 excerpt false Show or hide excerpts for results
 6 maxResults 5 Specify maximum results to display
 7 sort=creation
sort=title
sort=modified
recent The 'sort' attribute is an optional attribute that allows you to configure how the children are sorted. Use the 'reverse' attribute to optionally reverse the sorting.
 8 operator OR (Confluence 2.5 and higher.) The operator to apply to the supplied lists of labels. By default, a page with any of the labels will be listed. By using operator=AND, only pages with all of the supplied labels will be listed.

1. Filter by space

{contentbylabel:dogs,cats|key=PETS}




2. Show only results in current space (Confluence 2.2.2 and higher)

{contentbylabel:dogs,cats|key=@self}




3. Show results from all spaces (Confluence 2.2.2 and higher)

{contentbylabel:dogs,cats|key=@all}




4. Filter by content type: pages or blog posts

{contentbylabel:dogs,cats|type=page,blogpost}




5. Hide labels for results

{contentbylabel:dogs,cats|showLabels=false}




6. Hide spaces for results

{contentbylabel:dogs,cats|showSpace=false}




7. Display excerpts for results

{contentbylabel:dogs,cats|excerpt=true}




8. Specify the maximum number of results to display

{contentbylabel:dogs,cats|maxResults=99}




9. Sort by creation date, modification date or title

{children|sort=creation|reverse=true}



RELATED TOPICS

Related Labels Macro
Navmap Macro
Recently Used Labels Macro
Working with Labels Overview
Working with Macros

Take me back to Confluence User Guide

Document generated by Confluence on Dec 20, 2007 19:03