{blog-list} Macro

(warning) Under Consruction

Description

The blog-list macro is

used to display a list of blog posts and excerpts.

...

Usage

{blog-list}

Parameters

he "Ver" column shows which version of Theme Builder the parameter became available in.

Property

Required

Default

Notes

Theme Panels Only

Ver

default

(error)

singlespace

Display mode. (singlespace/multispace)

 

3.2

space

(error)

@current

The space (or list of spaces) whose posts should be listed (SPACEKEY/@all/@current/@favourite/@global/@personal) NB: the @all parameter must be used on it's own, other macro parameters may be used in a list.

 

3.0

teams

(error)

n/a

A list of team labels that can be used to filter the list of spaces

 

3.2

sort

(error)

creation

The order that the posts should be listed in (creation/modified/recent)

 

3.2

reverse

(error)

false

List the blogposts in reverse order

 

3.2

count

(error)

9

The number of posts that should be displayed.

 

3.2

start

(error)

0

Offset from the start for listing the posts.

 

3.2

dateFormat

(error)

defined by confluence settings

Format that dates should be displayed in

 

3.2

title

(error)

true

Show the Title of the blogpost.

 

3.2

linktitle

(error)

true

Link the title to the blogpost

 

3.2

excerpt

(error)

true

Display the excerpt of the blogpost (true/false/full)

 

3.2

postedby

(error)

true

Display the date that the post was created (true/false/date).

 

3.2

permalink

(error)

n/a

Text to use for posted by

 

3.2

postedByCaption

(error)

n/a

Text to use for posted by.

 

3.2

none

(error)

n/a

Text to display when no posts have been found

 

3.2

Examples

Basic Use

Add the \{blog-list} macro to a page where you want to display a list of blog posts

{code}
{blog-list}
{code}

Which gives: 
{blog-list}

Display blog posts for the whole site

To display blogs for all spaces set the display mode to multispace (so that the space the blog originated in is displayed), and set the spaces parameter to @all

{code}
{blog-list:multipsace|space=@all}
{code}

Which gives:
{blog-list:multipsace|space=@all}

Display blog posts for the global spaces

To display blogs for global spaces set the display mode to multispace (so that the space the blog originated in is displayed), and set the spaces parameter to @global

{code}
{blog-list:multipsace|space=@global}
{code}

Which gives:
{blog-list:multipsace|space=@global}

CSS Customisation

To follow

Hints and Tips

None at present.

Frequently Asked Questions

None at present.