This documentation relates to an earlier version of Confluence.
View this page in the current documentation or visit the current documentation home.

Skip to end of metadata
Go to start of metadata

The Blog Posts Macro allows you to display blog posts on a wiki page. Clicking on a title takes you to the blog post. The blog posts macro will generate output like the screenshot below:

Screenshot: The Blog Posts Macro in Confluence

On this page:

Usage with the Macro Browser

To insert the blog posts macro into a page using the Macro Browser,

  1. Open the Confluence page or blog post that you want to edit, then click the 'Edit' button.
  2. Click the Macro Browser icon on the toolbar. The macro browser window will open.
  3. Scroll through the list of macros to find the one you want. Alternatively, start typing the macro name into the search box at the top right of the macro browser. Macros with a matching name will appear in the main pane.
  4. Click the desired macro.
  5. Set the macro parameters to your requirements. If desired, you can preview these changes by clicking 'Refresh'.
  6. Click 'Insert' to add the macro onto the page.

(tick) You can also insert macros via autocomplete. For more information, see Using Autocomplete in the Rich Text Editor.

Once you've found the blog posts macro, click 'insert' to add it to your page.

Usage with the Wiki Markup Editor

Simply type the following into the Wiki Markup editor:

In the example below, we show the blog posts from a user's personal space on this Confluence site. (The person's username is ~mryall.)

What you need to type

What you will get

{blog-posts:space=~mryall}
Testing news

This is a test post.

Parameters

Parameters are options that you can include in Confluence macros to control the content or format of the macro output. The table below lists relevant parameters for this macro.

Parameter names are different in the macro browser and in wiki markup. Below we show the macro browser parameter names in bold text, and the equivalent wiki markup parameters in (bracketed) text. If we do not show any parameter name for the wiki markup, then you should leave out the parameter name and simply include the parameter value as the first parameter, immediately after the colon (:).

Parameter

Default

Description

(author)

None

Filter the results by author. The macro will display only the blog posts which are written by the author(s) you specify here.

You can specify one or more authors, separated by a comma.

Content Type to Display
(content)

entire

Available values:

  • content=excerpts — Display short excerpts from each blog posts. After each excerpt, the words 'Read more...' will offer a link allowing the user to click through to the full blog post, if the content is over 500 characters long.
  • content=titles — Display a list of blog posts, showing titles only.

Restrict to these Labels
(label)

None

Filter the results by label. The macro will display only the blog posts which are tagged with the label(s) you specify here.

You can specify one or more label values, separated by a comma or a space.

  • To exclude content which matches a given label, put a minus sign (-) immediately in front of that label value. For example: If you specify a label value of -badpage you will get only content which is not labelled with 'badpage'.
  • To indicate that the results must match a given label value, put a plus sign (+) immediately in front of that label value. For example: If you specify a label value of +superpage,+goodpage you will get only content which has at least two labels, being 'superpage' and 'goodpage'.

Restrict to these Labels
(labels)

None

Exactly the same as label above.

Maximum Number of Blog Posts
(max)

15

Specify the maximum number of results to be displayed. Note that the results are sorted first, and then the maximum parameter is applied.

Maximum Number of Blog Posts
(maxResults)

15

Exactly the same as max above.

Reverse Sort
(reverse)

false

Use this parameter in conjunction with the sort parameter described below. Set reverse=true to change the sort from ascending to descending order.

(info) this parameter is ignored if the sort parameter is not specified.

Sort By
(sort)

creation

Specify how the results should be sorted. To change the sort order from ascending to descending, use the reverse parameter described above.

(info) If this parameter is not specified, the sort order defaults to descending order based on the creation (publish) date.

Values:

  • creation — Sort by the date on which the content was added.
  • title — Sort alphabetically by title.
  • modified — Sort by the date on which the content was last updated.

Restrict to these spaces
(space)

@self, i.e. the space which contains the page on which the macro is coded

This parameter allows you to filter content by space. The macro will display only the pages which belong to the space(s) you specify here.

You can specify one or more space keys, separated by a comma or a space.

  • To exclude content in a specific space, put a minus sign (-) immediately in front of that space key. For example: If you specify a space key of -BADSPACE you will get only content which is not in the BADSPACE.
  • To indicate that the results must come from a specific space, put a plus sign (+) immediately in front of that space key. For example: If you specify a space key of +GOODSPACE you will get only content in GOODSPACE. (Note that this is not particularly useful, because each content item belongs to one space only. If you put a plus sign next to one space key and list other space keys too, the other space keys will be ignored.)

Special values:

  • @self — The current space.
  • @personal — All personal spaces.
  • @global — All global spaces.
  • @favorite — The spaces you have marked as favourite.
  • @favourite — The same as @favorite above.
  • @all — All spaces in your Confluence site.
  • * — The same as @all above.

(info) When specifying a personal space, remember to use the tilde (~) sign in front of the username, such as ~jbloggs or ~jbloggs@example.com.

Restrict to these spaces
(spaces)

 

Exactly the same as space above.

Time Frame
(time)

no limit

Specify how far back in time Confluence should look for the blog posts to be displayed.

Available values:

  • m — Minutes
  • h — Hours
  • d — Days
  • w — Weeks

    For example, time=12h would display those blog posts created in the last twelve hours, and time=7d would show blog posts created in the last seven days.

Examples

1. Specify the number of blog posts you want displayed

The following code will display a maximum of five blog posts:

2. Display short excerpts from each blog post in the list

3. Display only the titles of the blog post

4. Choose how far back in time Confluence should look for the blog posts

The following code will display all blog posts posted in the last twelve hours.

The following code will display all blog posts posted in the last 2 weeks.

5. Filter items using labels

The following code will display blog posts that contain the labels 'atlassian' or the label 'confluence' (or both):

The following code will display blog posts that contain the labels 'atlassian' and 'confluence' — each blog post must be tagged with both labels:

6. Filter items using spaces

The following code will display items from the 'Marketing' space (space key is MKTG) and Joe Smith's personal space (space key is ~jsmith):

7. Combine parameters to filter the blog posts

The following code will display the latest 10 items in the 'Marketing' space (space key is MKT) with the label 'logo'. The items will be displayed as a list of titles only:

8. Sort the results

Use the code below to sort the list of items by date last modified, with the most recent at the top:

RELATED TOPICS

Working with Macros
Working with Blog Posts

Take me back to the Confluence User's Guide.

  • No labels