News Ticker Macro - Server/DC

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

Parameter

Default

Description

News Selectors

Content Types

contentTypes

blogposts

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

  • Pages - Display news from pages.

  • Blogposts - Display news from blogposts.

  • Pages and Blogposts - Display news from pages and blog posts.

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 labelled with confluence OR jira.

  • +confluence,+jira,-bitbucket - Returns all news having labels confluence AND jira, excluding news labelled 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 news search. See Confluence Search Syntax for 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. Valid values are:

  • Title - Sort by the title of the page or blog post.

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

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

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

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

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

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

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

The maximum number of news to be displayed.

Show Error If No News

showErrorIfNone

true

Enable to show an error message when no news was found.

News Cards Configuration

News Text

excerptType

title

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

  • Title - Title of page or blog post.

  • 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 blog post.

  • author - Author of page or blog post.

  • creationDate - Creation date of page or blog post.

  • modifiedDate - Last modification date of page or blog post.

Enable Links

enableLinks

true

Enable to link news entries to their corresponding page or blog post.

Open Links in the 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 the 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 sec.

Deprecated

Reverse Order

reverseSort

false

Enable for reverse sort order.

 

Creating News Ticker macro

To create a News Ticker macro, perform the following steps:

  1. Go to the page where you want to display the slides and click edit.

  2. Click the + icon and search for the News Ticker macro.
    (or) you can type { News, the list with news macro suggestions is displayed.

  3. Select News Ticker macro. The News Ticker macro is displayed.

  4. Type the name of the space from where you pull the news and to help you the results are auto-populated. You can specify multiple space names.

  5. Customize parameters according to your requirements. For more information, see Parameters.

  6. Click Apply.

  7. Publish the page.