News Teaser Macro - Cloud

Use the News Teaser macro to show off news entries with thumbnails and excerpts in a Pinterest-like card layout or as a simple list.

Parameters

Parameters

Default

Description

Parameters

Default

Description

News Selectors

Content Types

contentType

Blog Posts

Choose whether you want to display news from pages or 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 news search. 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. Valid values are:

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

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

  • First Modified/ Last Modified- Sort by the last modification date of the page or blog post.

Max Results

maxResults

10

The maximum number of news to be displayed in the slider.

Show Error If No News Found

showError

Enabled

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.

Columns

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

 

Label which indicates whether a piece of 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

imageLabels

 

The file label of the image you want to display is a news image in the slider. The image needs to be attached to the corresponding page or blog post. Leave blank to use the first image the slider 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.

NB. To add an image label: Go to the page where images are attached > in the top right corner of the page click on the three dots > select Attachments > a list of images appears where you can add and edit labels!

Background Color

color

white

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

News Text

newsText

Text 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 the page or blog post content

  • Full Text - entire text from page or blog post content

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

  • Full Excerpt - entire rendered content from inside excerpt macro

  • Full Content - entire rendered page or blog post content

Display Space

showSpace

Enabled

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

Display Author

showAuthor

Enabled

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

Display Publication Date

showDate

Enabled

Enable to display the publication date in news entries.

Display Social Stats

showStats

Enabled

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

Enable Links

link

Enabled

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

Open in Same Tab

sameTab

Disabled

Enable to open the link in the current tab.

Creating News Teaser Macro

To create a News Teaser 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 Teaser macro.

  3. Select News Teaser macro. The Insert ‘News Teaser’ 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.