News Teaser Macro - Server/DC

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.

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

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.

Teaser Configuration

Layout

layout

cards

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

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

• List - Display news as a simple list.

Content Types

columns

responsive

Choose the number of columns to be displayed when using the card 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 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

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

Background Color

backgroundColor

white

The background color of news entries. Use hexadecimal notation or HTML color name.

News Text

excerptType

summary

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

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

• Full Text - Entire text from page or blog post content.
  NOTE The Text option displays the data from the 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 blog post content.

• Content Summary- First 255 characters of text from page or blog post content.
  NOTE The Content option displays the data from the page containing text as well as a multiexcerpt 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 blog post.

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