News Ticker Macro - Cloud

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

contentType

Blog Posts

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

  • Pages - Display news from pages.

  • Blog Posts - Display news from blogposts.

  • Pages And Blog Posts - Display news from pages and blog posts.

Labels

labels

 

Comma-separated list of labels to search news by.

Spaces

spacesSelected

 

Select one or more spaces to restrict searching for news. Leave blank for all spaces.

CQL Query

cql

 

CQL Search query to further refine your search for news. Click here to open the full CQL Documentation

Examples:

  • creator = "admin" returns news created by admin

  • created = "2019/01/01" returns news created at 2019/01/01

Time Frame

timeFrame

 

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

  • M - Months

  • y - Years

Sort Order

sortOrder

Last Modified

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

  • Title/Title Desc- Sort by title of page or blogpost

  • First Created/ Last Created- Sort by creation date of page or blogpost.

  • First Modified/ Last Modified- Sort by last modification date of page or blogpost.

Max Results

maxResults

5

Maximum number of news to be displayed in the slider.

Show Error If No News Found

showError

Enabled

Enable to show error message when no news were found.

Ticker Configuration

Title

title

News

The title of the ticker to display.

Width

width

100%

Width of the ticker in pixels or percents.

Color

color

#3873ae

Color of the ticker. Use hexadecimal notation or HTML color name.

Display Time

displayTime

4 seconds

How long each news entry will be displayed in seconds, 0 turns auto slide off.

News Cards Configuration

News Text

newsText

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

prefixText

 

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.

  • Creation Date - Creation date of page or blogpost.

  • Modified Date - Last modification date of page or blogpost.

Enable Links

link

Enabled

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

Open in Same Tab

sameTab

Disabled

Enable to open the link in the current tab.

Creating News Ticker macro

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

  1. Create a new page or go to Edit the page where you want to create the news or blog post.

  2. Type ‘/' or click the '+’ icon and search for the News Ticker macro.

  3. Select News Ticker macro. The Insert ‘News Ticker’ Macro window is displayed.

  4. Choose the Content Type from the drop-down.

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

  6. You can customize parameters according to your requirements. For more information, see Parameters.

  7. Click Insert.