Skip to end of banner
Go to start of banner

News Ticker Macro - Server

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Use the News Ticker macro to grab your latest breaking news from blogposts and pages and display them in a simple ticker.

Parameters

Parameter

Default

Description

News Selectors

Content Types

contentTypes

blogposts

Choose whether you want to display news from pages or blogposts or from both. Valid values are:

  • Pages - Display news from pages.

  • Blogposts - Display news from blogposts.

  • Pages and Blogposts - Display news from pages and blogposts.

Labels

labels

None

Comma separated list of labels to search news by. Prefix labels with a + sign to indicate must-have labels or use a - sign to exclude news having a certain label. Examples:

  • confluence,jira - Returns all news labeled with confluence OR jira.

  • +confluence,+jira,-bitbucket - Returns all news having labels confluence AND jira, excluding news labeled with bitbucket.

Spaces

spaces

None - news from all spaces will be displayed

Comma separated list of space keys to restrict searching of news. Use @self for current space. Leave blank for all spaces.

Search Query

searchQuery

None

Search query to further refine your search for news. See Confluence Search Syntaxfor more information. Examples:

  • confluence OR jira returns all news containing either 'confluence' or 'jira'

  • "atlassian jira" returns all news containing the phrase 'atlassian jira'

Time Frame

time

None - no time limit for news

Specify how far back in time Confluence should look for news to be displayed. Example: Use 12h to display all news created or updated in the last 12 hours. Leave blank for no time limit. Available units are:

  • m - Minutes

  • h - Hours

  • d - Days

  • w - Weeks

Sort Order

sort

creationDate

Choose the order the news should be sorted by. Valid values are:

  • Title - Sort by the title of page or blogpost.

  • Title desc: Sort by the title description of page or blogpost.

  • First Created: Sort by the first creation date of the page or blogpost.

  • Last Created: Sort by the last creation date of the page or blogpost.

  • First Modified: Sort by the first modification date of the page or blogpost.

  • Last Modified: Sort by the last modification date of the page or blogpost.

  • modifiedDate - Sort by the last modification date of the page or blogpost.

Filter News By Date Range

Datefilter

false

This option allows you to sort the news by a specific date range.
Enable this option, a calendar is displayed, then select the start and end date.

Based on the sort order you have chosen, the sort is applied.

Max Results

maxResults

5

Maximum number of news to be displayed.

Show Error If No News

showErrorIfNone

true

Enable to show error message when no news were found.

News Cards Configuration

News Text

excerptType

title

Choose which part of the page or blogpost you want to display as news text:

  • Title - Title of page or blogpost.

  • Excerpt - Content from inside excerpt macro.

Prefix Text

prefix

None

Optionally choose whether you want to display the space, author, creation date or last modification date before the news text. Valid values are:

  • space - Space of page or blogpost.

  • author - Author of page or blogpost.

  • creationDate - Creation date of page or blogpost.

  • modifiedDate - Last modification date of page or blogpost.

Enable Links

enableLinks

true

Enable to link news entries to their corresponding page or blogpost.

Open Links in new Window

openLinksInNewWindow

false

Enable to open links in a new browser window, if links are enabled.

Ticker Configuration

Title

title

false

The title of the ticker to display.

Width

width

None - responsive width will be used

Width of the ticker in pixels. Leave blank for responsive width.

Color

color

None - topbar color of current space will be used

Color of the ticker. Use hexadecimal notation or HTML color name. Leave blank to automatically use the topbar color of the current space.

Display Time

delay

4sec

Slide through the slider to choose the duration (sec) you want to display each of the news entries. The duration ranges from 1 sec to 120 secs.

Deprecated

Reverse Order

reverseSort

false

Enable for reverse sort order.

 

  • No labels