Looking for the best way to announce or share news and urgent announcements with your Confluence users? The News Teaser add-on for Confluence provides multiple, flexible macros to easily display news from blog posts, pages, or ad-hoc content in a beautiful way.

>>> Macro Demo Page <<<

Macros Included

  • News Slider macro
    Use the News Slider macro to display news from blogposts and pages with thumbnails and excerpt in a simple and beautiful slider.

  • News Teaser macro
    Use the News Teaser macro to display news entries with thumbnails and excerpt in a Pinterest-like cards layout or as a simple list.

  • News Ticker macro
    Use the News Ticker macro to show off your latest breaking news from blog posts and pages in a simple news ticker.

  • News Ticker From List macro
    Use the News Ticker From List macro to grab news from a bullet list specified in the macro body and display them in a simple ticker.

Feature Highlights

  • Automatically display from blog posts or other pages  Easily collect news entries from Confluence blog posts or pages and optionally filter them by spaces or labels.

  • Option to display full or partial content  Choose whether you want to display a summary, a short excerpt or the complete content as news text.

  • Select the image to use as a thumbnail  Specify which image is attached to the corresponding page or blog post you want to display a thumbnail.

  • Track and display contents and likes  Easily display social stats like the number of comments and like to see which news are the most engaging.

  • Link to content sources  Link news entries to corresponding pages or blog posts to allow users to read the entire news.

  • Customize output  Fully customizable macros to adapt the output to your needs.

  • Responsive layout  All macros are fully responsive and mobile compatible.

  • Use with Dashboard plugin  Works best in combination with the Custom Dashboards plugin to display newly published posts stunningly on your custom dashboard, such that it draws the attention of all your users.

News Slider Macro 

Use the News Slider macro to display news from blogposts and pages with thumbnails and excerpt in a simple and beautiful slider.

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.

CQL Query

searchQuery

None

Search query to further refine your search for news. 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 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

Unchecked

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.

Reverse Order

reverseSort

false

Enable for reverse sort order.

Max Results

maxResults

5

Maximum number of news to be displayed in the slider.

Show Error If No News

showErrorIfNone

true

Enable to show error message when no news is found.

Slider Configuration

Width

width

None - responsive width will be used

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

Height

height

None - the height of the tallest slide will be used

Height of the slider in pixels. Leave blank to automatically use the height of the tallest slide.

Auto Slide 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.

Buttons Color

color

None - topbar color of current space will be used

Color of prev/next navigation. Use hexadecimal notation or HTML color name. Leave blank to automatically use the topbar color of the current space.

Background Color

backgroundColor

#f5f5f5

Background color of news entries. Use hexadecimal notation or HTML color name.

Show Navigation

showNavigation

true

Enable to show prev/next navigation.

Show Bullets

showBullets

true

Enable to show navigation bullets.

News Cards Configuration

News Image Label

imageFilenameOrLabel

None - use the first image (in alphabetical order) the slider can find attached to the page or blogpost

The file name or label of the image you want to display as news image in the slider. The image needs to be attached to the corresponding page or blogpost. Leave blank to use the first image (in alphabetical order) the slider can find attached to the page or blogpost. If no image attachment with the given file name or label exists or the page or blogpost has no image attachments at all, no news image will be displayed. Example: thumbnail.png

News Text

excerptType

summary

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

  • Text Summary - First 255 characters of text from page or blogpost content.

  • Full Text - Entire text from page or blogpost content.
    NOTE The Text option displays the data from page from a basic page with only text.

  • Excerpt Summary- First 255 characters of text from inside excerpt macro.

  • Full Excerpt - Entire rendered content from inside excerpt macro.
    NOTE The Excerpt option displays the data from the multiexcerpt macro.

  • Full Content - Entire rendered page or blogpost content.

  • Content Summary- First 255 characters of text from page or blogpost content.
    NOTE The Content option displays the data from page containing text as well as multiexcerpt macro.

Deprecated

  • shortExcerpt - First 255 characters of text from inside excerpt macro.

  • longExcerpt - First 500 characters of text from inside excerpt macro.

Display Space

showSpace

false

Enable to display the name of the space in news entries.

Display Author

showAuthor

false

Enable to display the author's name in news entries.

Display Publication Date

showDate

false

Enable to display the publication date in news entries.

Display Creator

dispalycreator

false

Enable this option to display the name of the creator in the news entries.

Display Created Date

dispalycreationdate

false

Enable this option to display the creation date of the news or blog posts in the news entries.

Display Social Stats

showStats

false

Enable to display the number of comments and likes in news entries.

Enable Links

enableLinks

true

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

Deprecated

Open Links in new Window

openLinksInNewWindow

false

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

Auto Slide

autoSlide

true

Enable to automatically slide through news.

News Teaser Macro 

Use the News Teaser macro to show off news entries with thumbnail and excerpt in a Pinterest like cards layout or as simple list.

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.

CQL Query

searchQuery

None

Search query to further refine your search for news. 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 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.

Teaser Configuration

Layout

layout

cards

Choose whether you want to display news in a Pinterest like cards layout or as list. Valid values are:

  • Cards - Display news in a Pinterest like cards layout.

  • List - Display news as simple list.

Columns

columns

responsive

Choose the number of columns to be displayed when using the cards layout. Use responsive to let the macro dynamically choose the number of columns for the best fit. Valid values are:

  • responsive - The number of columns is dynamically detected for the best fit.

  • 1 - Display news in a single column.

  • 2 - Display news in two columns.

  • 3 - Display news in three columns.

  • 4 - Display news in four columns.

  • 5 - Display news in five columns.

Promoted Label

promotedLabel

None

Label which indicates whether a news should be displayed as promoted news with a ribbon containing the label name. Leave blank for no promoted news.

News Cards Configuration

News Image Label

imageFilenameOrLabel

None - use the first image (in alphabetical order) the macro can find attached to the page or blogpost

The file name or label of the image you want to display as news image. The image needs to be attached to the corresponding page or blogpost. Leave blank to use the first image (in alphabetical order) the macro can find attached to the page or blogpost. If no image attachment with the given file name or label exists or the page or blogpost has no image attachments at all, no news image will be displayed. Example: thumbnail.png

Background Color

backgroundColor

white

Background color of news entries. Use hexadecimal notation or HTML color name.

News Text

excerptType

summary

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

  • Text Summary - First 255 characters of text from page or blogpost content.

  • Full Text - Entire text from page or blogpost content.
    NOTE The Text option displays the data from page from a basic page with only text.

  • Excerpt Summary- First 255 characters of text from inside excerpt macro.

  • Full Excerpt - Entire rendered content from inside excerpt macro.
    NOTE The Excerpt option displays the data from the multiexcerpt macro.

  • Full Content - Entire rendered page or blogpost content.

  • Content Summary- First 255 characters of text from page or blogpost content.
    NOTE The Content option displays the data from page containing text as well as multiexcerpt macro.

Deprecated

  • shortExcerpt - First 255 characters of text from inside excerpt macro.

  • longExcerpt - First 500 characters of text from inside excerpt macro.

Display Space

showSpace

true

Enable to display the name of the space in news entries.

Display Author

showAuthor

true

Enable to display the author's name in news entries.

Display Publication Date

showDate

true

Enable to display the publication date in news entries.

Display Creator

dispalycreator

false

Enable this option to display the name of the creator in the news entries.

Display Created Date

dispalycreationdate

false

Enable this option to display the creation date of the news or blog posts in the news entries.

Display Social Stats

showStats

true

Enable to display the number of comments and likes in news entries.

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.

Deprecated

Promoted News First

promotedToTop

false

Enable to display promoted news before regular news.

Show Engagement Buttons

showButtons

true

Enable to display engagement buttons (like, favorite, comment and share) when hovering over news entries.

Reverse Order

reverseSort

false

Enable for reverse sort order.

Load More

loadMore

true

Enable to show button at the bottom to load more news entries.

Promoted Color

promotedColor

None - topbar color of current space will be used

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

News Ticker Macro 

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.

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.

Open Links in new Window

openLinksInNewWindow

false

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

News Ticker From List Macro 

Use the News Ticker From List macro to grab news from a bullet list specified in the macro body and display them in a simple ticker.

News Ticker From List

Parameters

Parameter

Default

Description

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.

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.

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.