[All Adaptavist Apps]

Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

{blog-list} Macro

Description

The blog-list macro is

Excerpt

used to display a list of blog posts and excerpts.

...

Usage

Code Block
{blog-list}

Parameters

The "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/@children) NB: the @all parameter must be used on it's own, other macro parameters may be used in a list.

 

3.2

label

(error)

n/a

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

 

3.3.5

author

(error)

n/a

A comma separated list of usernames/group names/@self/@creator/@owner

 

3.3

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

date

(error)

false

Show the Date of the blogpost.

 

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 or panel where you want to display a list of blog posts

Code Block
{blog-list}

Display blog posts for the whole site (including personal spaces)

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 Block
{blog-list:multispace|space=@all}

Display blog posts for just global spaces (whole site, no personal 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 Block
{blog-list:multispace|space=@global}

Display title, excerpt & date

Code Block
{blog-list:count=3|postedby=date|permalink=}

Only display titles

Code Block
{blog-list:count=3|postedby=false|excerpt=false|permalink=}
Code Block
{blog-list:count=3|permalink=}

Show the date the post was made

Code Block
{blog-list:count=3|date=true}

CSS Customisation

The standard output follows this structure

Code Block
<div class="bloglist default">

    <div class="post">
        <div class="date"><span>Jun 01, 2009 23:30</span></div>
        <div class="permalink"><a href="$bloglisthelper.getTinyURL($post)">Permalink</a></div>
        <div class="title">
            <a href="http://www.mysite.com/x/Goy9Ag">This is the blogpost title</a>
        </div>
        <div class="excerpt"><span>The excerpt of the blogpost will be shown here</span></div>
        <div class="postedby">Posted by Test User on Jun 01, 2009 23:30 </div>
        <div class="commentcount">Comments (5)</div>
    </div>

</div>

Hints and Tips

When excepts are enabled, the macro will output a block of content taken from the top of your blog posts. If you need more control over the excerpts, consider using the excerpt macro.

Frequently Asked Questions

None at present.