RSS ticker: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
No edit summary
(10 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{mininav|[[General topics]]|[[Basic controls]]}}
{{mininav|[[General topics]]|[[Basic controls]]}}
<section begin="intro" />XBMC can display an [[w:RSS|RSS]] feed on the home screen of the default skin/interface (Confluence), as well as any other skin that supports RSS feeds. By default, the RSS news feed is taken from http://xbmc.org, but the feed can be changed to almost any RSS feed.<section end="intro" />
<section begin="intro" />Kodi can display an [[w:RSS|RSS]] feed on the home screen of the default skin/interface, as well as any other skin that supports RSS feeds. By default, the RSS news feed is taken from http://kodi.tv, but the feed can be changed to almost any RSS feed.<section end="intro" />


{{Note|Don't confuse the [[RSS ticker]] with '''[[RSS media source]]''', which allows access to video and/or audio RSS streams.}}
{{Note|Don't confuse the [[RSS ticker]] with '''[[RSS media source]]''', which allows access to video and/or audio RSS streams.}}


== RSS ticker settings ==
The RSS ticker can be toggled on or off  by going to {{highlight|bordered=yes|'''[[Settings/Appearance#Skin|Settings -> Appearance -> Skin -> Show RSS news feed]]''' }}


Below this setting one can also change the RSS news feed address.


== Technical documentation for skinners ==
= RSS ticker settings =
{{main|Skin development}}
The RSS ticker can be toggled on or off  by going to {{highlight|bordered=yes|'''[[Settings/Interface/Skin#Show_RSS_news_feeds|Settings -> Interface -> Skin -> Show RSS news feeds]]''' }}
 
Below this setting one can also change the RSS news feed address. This will be done via the RSS Editor add-on, which you will prompted to download before the first usage.
 
 
 
= Technical documentation for skinners =
{{main|Skinning}}
<section begin="main content" />
<section begin="main content" />
=== RSS control ===


The rss control is used for displaying scrolling RSS feeds from the internet in XBMC. You can choose the font, size, colour, location and the RSS feed to be displayed.
 
 
== RSS control ==
The rss control is used for displaying scrolling RSS feeds from the internet in Kodi. You can choose the font, size, colour, location and the RSS feed to be displayed.


;Example
;Example
<syntaxhighlight lang="xml" enclose="div">
<syntaxhighlight lang=xml enclose="div">
<control type="rss" id="1">
<control type="rss" id="123">
   <description>My First RSS control</description>
   <description>My First RSS control</description>
   <posx>80</posx>
   <left>80</left>
   <posy>60</posy>
   <top>60</top>
   <width>500</width>
   <width>500</width>
   <visible>true</visible>
   <visible>true</visible>
   <font>font14</font>
   <font>font14</font>
   <textcolor>FFB2D4F5</textcolor>
   <textcolor>FFB2D4F5</textcolor>
  <urlset>1</urlset>
   <headlinecolor>FFFFFFFF</headlinecolor>
   <headlinecolor>FFFFFFFF</headlinecolor>
   <titlecolor>FF655656</titlecolor>
   <titlecolor>FF655656</titlecolor>
Line 31: Line 38:
</syntaxhighlight>
</syntaxhighlight>


=== Available tags and attributes ===
 
In addition to the [[Default Control Tags|default control tags]], the following tags are available. Note that each tag is '''lower case only.''' This is important, as xml tags are case-sensitive.
 
== Available tags and attributes ==
In addition to the [[Default_control_tags|default control tags]], the following tags are available. Note that each tag is '''lower case only.''' This is important, as xml tags are case-sensitive.
{| class="prettytable"
{| class="prettytable"
! Tag !! Description
! Tag !! Description
|-  
|-  
|  '''id'''
|  '''urlset'''
|  This refers to the feedset to be displayed. This is the id reference to the <set> section in [[RssFeeds.xml]] (see below):
|  This refers to the feedset to be displayed. This is the id reference to the <set> section in [[RssFeeds.xml]] (see below):
|-  
|-  
Line 43: Line 52:
|-  
|-  
|  '''textcolor'''
|  '''textcolor'''
|  Specified the color the text should be. In hex AARRGGBB format, or a name from the [[Colour Themes|colour theme.]]
|  Specified the color the text should be. In hex AARRGGBB format, or a name from the [[Colour_themes|colour theme.]]
|-  
|-  
|  '''shadowcolor'''
|  '''shadowcolor'''
|  Specifies the color of the drop shadow on the text. In AARRGGBB format, or a name from the [[Colour Themes|colour theme.]]
|  Specifies the color of the drop shadow on the text. In AARRGGBB format, or a name from the [[Colour_themes|colour theme.]]
|-  
|-  
|  '''headlinecolor'''
|  '''headlinecolor'''
|  Specified the color that any highlighted text should be. In hex AARRGGBB format, or a name from the [[Colour Themes|colour theme.]]
|  Specified the color that any highlighted text should be. In hex AARRGGBB format, or a name from the [[Colour_themes|colour theme.]]
|-  
|-  
|  '''titlecolor'''
|  '''titlecolor'''
|  Specified the color the titles of the feeds should be. In hex AARRGGBB format, or a name from the [[Colour Themes|colour theme.]]
|  Specified the color the titles of the feeds should be. In hex AARRGGBB format, or a name from the [[Colour_themes|colour theme.]]
|-  
|-  
|-  
|-  
Line 59: Line 68:
|}
|}


=== RssFeeds.xml ===
 
 
== RssFeeds.xml ==
{{Main|RssFeeds.xml}}
{{Main|RssFeeds.xml}}
The actual content of the RSS feed is defined in the [[RssFeeds.xml]] file stored in the user's profile. Here is an example :
The actual content of the RSS feed is defined in the [[RssFeeds.xml]] file stored in the user's profile. Here is an example :


<syntaxhighlight lang="xml" enclose="div">
<syntaxhighlight lang=xml enclose="div">
  <rssfeeds>
  <rssfeeds>
   <set id="1">
   <set id="1">
Line 78: Line 89:
<section end="main content" />
<section end="main content" />


== See also ==
* [[RssFeeds.xml]]


'''Development:'''
* [[Add-on development]]
* [[Skinning]]


[[Category:XBMC Manual]]
{{top}}
[[Category:Skin Development]]
 
{{frodo updated}}
 
{{updated|18}}
[[Category:Manual]]
[[Category:Skin development]]

Revision as of 10:57, 12 January 2019

Home icon grey.png   ▶ General topics ▶ Basic controls ▶ RSS ticker

Kodi can display an RSS feed on the home screen of the default skin/interface, as well as any other skin that supports RSS feeds. By default, the RSS news feed is taken from http://kodi.tv, but the feed can be changed to almost any RSS feed.

Note: Don't confuse the RSS ticker with RSS media source, which allows access to video and/or audio RSS streams.


RSS ticker settings

The RSS ticker can be toggled on or off by going to Settings -> Interface -> Skin -> Show RSS news feeds

Below this setting one can also change the RSS news feed address. This will be done via the RSS Editor add-on, which you will prompted to download before the first usage.


Technical documentation for skinners



RSS control

The rss control is used for displaying scrolling RSS feeds from the internet in Kodi. You can choose the font, size, colour, location and the RSS feed to be displayed.

Example
<control type="rss" id="123">
  <description>My First RSS control</description>
  <left>80</left>
  <top>60</top>
  <width>500</width>
  <visible>true</visible>
  <font>font14</font>
  <textcolor>FFB2D4F5</textcolor>
  <urlset>1</urlset>
  <headlinecolor>FFFFFFFF</headlinecolor>
  <titlecolor>FF655656</titlecolor>
</control>


Available tags and attributes

In addition to the default control tags, the following tags are available. Note that each tag is lower case only. This is important, as xml tags are case-sensitive.

Tag Description
urlset This refers to the feedset to be displayed. This is the id reference to the <set> section in RssFeeds.xml (see below):
font Specifies the font to use from the font.xml file.
textcolor Specified the color the text should be. In hex AARRGGBB format, or a name from the colour theme.
shadowcolor Specifies the color of the drop shadow on the text. In AARRGGBB format, or a name from the colour theme.
headlinecolor Specified the color that any highlighted text should be. In hex AARRGGBB format, or a name from the colour theme.
titlecolor Specified the color the titles of the feeds should be. In hex AARRGGBB format, or a name from the colour theme.
scrollspeed Scroll speed of text in pixels per second.


RssFeeds.xml

The actual content of the RSS feed is defined in the RssFeeds.xml file stored in the user's profile. Here is an example :

 <rssfeeds>
   <set id="1">
     <feed updateinterval="30">http://feeds.feedburner.com/XboxScene</feed>
     <feed updateinterval="30">http://feeds.wired.com/wired/topheadlines</feed>
   </set>
   <set id="2">
     <feed updateinterval="30">http://www.cnet.co.uk/feeds/public/rss_news_10.htm</feed>
   </set>
 </rssfeeds>

As can be seen, each feedset has an id attribute – this is what we are referencing in the <id> attribute of the control. There can be more than one <set> defined, and more than one <feed> per set. The <feed>'s must be escaped so that they're xml-safe (ie replace & with & etc.). Each feed in the set runs through in the order they are defined.



Return to top