[All Adaptavist Apps]

Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin

{blog-rss-feed} Macro

(warning) Under Consruction

Description

The blog-rss-feed macro is

Excerpt

used to generate an rss feed link included in the header of the builder theme.

...

This macro takes exactly the same parameters as the {blog-rss} macro which can be used for prototyping the feeds without needing to cycle through adding the feed to a reader and viewing it.

Usage

Code Block
{blog-rss-feed}

Parameters

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

Property

Required

Default

Notes

Theme Panels Only

Ver

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.3

teams

(error)

n/a

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

 

3.3

author

(error)

n/a

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

 

3.3

sort

(error)

creation

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

 

3.3

reverse

(error)

true

List the blogposts in reverse order (oldest first)

 

3.3

count

(error)

n/a

The number of posts that should be displayed.

 

3.3

start

(error)

0

Offset from the start for listing the posts.

 

3.3

dateFormat

(error)

general config

Format that dates should be displayed in.

 

3.3

feedTitle

(error)

RSS Feed

The title of the rss feed.

 

3.3

feedDesc

(error)

An RSS Feed

The descripion of the rss feed.

 

3.3

none

(error)

n/a

Text to display when no posts have been found

 

3.3

Examples

Basic Use

Wiki Markup
Add the \{blog-rss} macro to a page/panel where you want to display the rss feed icon in compatible browsers
{code}
{blog-rss-feed}
{code}

Which gives: 
{blog-rss-feed}

CSS Customisation

Not Applicable

Hints and Tips

Use the blog-rss macro to simpify the process of prototyping a feed

Frequently Asked Questions

Multiple feeds can be included in a layout/page to offer a variety of information streams to users