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
- Usage with the Wiki Markup Editor
- Parameters
- Examples
- 1. Specify the number of blog posts you want displayed
- 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
- 5. Filter items using labels
- 6. Filter items using spaces
- 7. Combine parameters to filter the blog posts
- 8. Sort the results
Usage with the Macro Browser
To insert the blog posts macro into a page using the Macro Browser,
- Open the Confluence page or blog post that you want to edit, then click the 'Edit' button.
- Click the Macro Browser icon
on the toolbar. The macro browser window will open. - 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.
- Click the desired macro.
- Set the macro parameters to your requirements. If desired, you can preview these changes by clicking 'Refresh'.
- Click 'Insert' to add the macro onto the page.
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:
{blog-posts}
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 |
|---|---|
| Unknown macro: {nomarkup} blog-posts: '~mryall' is not an existing space's key |
blog-posts: '~mryall' is not an existing space's key |
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 |
|---|---|---|
( |
None |
Filter the results by author. The macro will display only the blog posts which are written by the author(s) you specify here.
|
Content Type to Display |
entire |
Available values:
|
Restrict to these Labels |
None |
Filter the results by label. The macro will display only the blog posts which are tagged with the label(s) you specify here.
|
Restrict to these Labels |
None |
Exactly the same as |
Maximum Number of Blog Posts |
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 |
15 |
Exactly the same as |
Reverse Sort |
false |
Use this parameter in conjunction with the |
Sort By |
creation |
Specify how the results should be sorted. To change the sort order from ascending to descending, use the |
Restrict to these spaces |
@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.
Special values: |
Restrict to these spaces |
|
Exactly the same as |
Time Frame |
no limit |
Specify how far back in time Confluence should look for the blog posts to be displayed.
|
this parameter is ignored if the Examples
1. Specify the number of blog posts you want displayed
The following code will display a maximum of five blog posts:
{blog-posts:max=5}
2. Display short excerpts from each blog post in the list
{blog-posts:content=excerpts}
3. Display only the titles of the blog post
{blog-posts:content=titles}
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.
{blog-posts:time=12h}
The following code will display all blog posts posted in the last 2 weeks.
{blog-posts:time=2w}
5. Filter items using labels
The following code will display blog posts that contain the labels 'atlassian' or the label 'confluence' (or both):
{blog-posts:labels=atlassian,confluence}
The following code will display blog posts that contain the labels 'atlassian' and 'confluence' — each blog post must be tagged with both labels:
{blog-posts:labels=+atlassian,+confluence}
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):
{blog-posts:spaces=MKTG,~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:
{blog-posts:max=10|labels=logo|spaces=MKT|content=titles}
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:
{blog-posts:sort=modified|reverse=true}
RELATED TOPICS
[Working with Macros]
[Working with Blog Posts]
Take me back to the Wikis Help Guide.