Clone wiki

news-ticker-confluence / Home

Welcome

News Ticker

Thank you for using News Ticker Plugin for Confluence. We hope that this product will serve all of your requirements and meet all of your expectations.

This guide explains everything that there is to know about working with and customizing the ticker.

Features

News Ticker is a modern, powerful, flexible, fast, easy to use and customize news ticker plugin for Atlassian Confluence. It offers a varied number of features while still being lightweight and very easy to work with:

  • It has 4 different effects.
  • It offers options to control the effects as well as the autoplay settings.
  • Data can be loaded from macro body.
  • Data can be loaded from a RSS or Atom feed.
  • Data can be loaded from Twitter.

Macro Body

Only applicable when type is set to body. If type set to rss or twitter, the macro body will be neglected.

<li><a href="link" target="_blank">news title</a><li>
<li><a href="link" target="_blank">news title</a><li>
<li><a href="link" target="_blank">news title</a><li>

Note

  • Please remain <li> and <a> tag for each news.
  • Please replace news title and target link with your own.
  • If there is no link for a news, please replace link with #

Parameters

title : The title of this news ticker. Default value: News

type : The data source type. You can select one from the following options. Default value: body

  • body - data will be loaded from macro body.
  • rss - date will be loaded from a RSS feed.
  • twitter - data will be loaded from Twitter.

effect : The animation effect of the ticker out of the 4 available effects. Default value: scroll

  • scroll
  • fade
  • type
  • slide

scrollInterval : The interval at which a scroll movement occurs (in ms), basically the speed of the scroll. Applicable only for the scroll effect. Default value: 20

typeInterval : The interval between displaying each letter (in ms). Applicable only for the type effect. Default value: 10

slideDistance : The distance that the message is sliding when appearing (in px). Applicable only for the slide effect. Default value: 100

displayTime : The time that a message is displayed, when autoplay is running (in ms). Applicable only for the fade, type and slide effects. Default value: 4000

transitionTime : The animation time of showing the next and previous messages when the next/prev buttons are pressed (in ms). Default value: 300

autoPlay : Whether or not the ticker should start playing automatically. Default value: true

  • true
  • false

feedUrl : The url from which the RSS or Atom file to be loaded. Applicable only for the rss type. Default value: http://www.engadget.com/rss.xml

twitter : The name of the Twitter account from which the feed to be loaded, or a twitter topic (Start with #). Applicable only for the twitter type. Default value: atlassian

  • Topic Example: #JIRA
  • User Example: jira

feedCount : The number of feed items to be displayed. Applicable only for the rss and twitter type. Default value: 5

Updated