RSS ticker: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
>Dankula
 
(Kodi RSS addresses)
(48 intermediate revisions by 17 users not shown)
Line 1: Line 1:
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.
{{mininav|[[General topics]]|[[Basic controls]]}}
===Example===
<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" />
<xml>
 
<control>
{{Note|Don't confuse the [[RSS ticker]] with '''[[RSS media source]]''', which allows access to video and/or audio RSS streams.}}
      <description>My First RSS control</description>
 
      <type>rss</type>
 
      <id>1</id>
 
      <posx>80</posx>
= RSS ticker settings =
      <posy>60</posy>
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]]''' }}
      <width>500</width>
 
      <visible>true</visible>
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.
      <font>font14</font>
 
      <textcolor>FFB2D4F5</textcolor>
 
      <headlinecolor>FFFFFFFF</headlinecolor>
= Kodi RSS Feeds =
      <titlecolor>FF655656</titlecolor>
The following addresses are the default RSS Feeds for Kodi.
      <urlset>1</urlset>
 
    http://feeds.kodi.tv/xbmc</feed>
    http://feeds.kodi.tv/latest_xbmc_addons</feed>
    http://feeds.kodi.tv/updated_xbmc_addons</feed>
 
 
 
= Technical documentation for skinners =
{{main|Skinning}}
<section begin="main content" />
 
 
 
== 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
<syntaxhighlight lang=xml enclose="div">
<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>
</control>
</xml>
</syntaxhighlight>
===Available Tags===
 
Note that each tag is '''lower case only.''' This is important, as xml tags are case-sensitive.
 
{| class="dtable"
 
|- class="userrow"
== Available tags and attributes ==
| class="usercell" | '''description'''
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="usercell" | Only used to make things clear for the skinner. Not read by XBMC at all.
{| class="prettytable"
|- class="userrow"
! Tag !! Description
| class="usercell" | '''type'''
|-  
| class="usercell" | Specifies the control type
| '''urlset'''
|- class="userrow"
| This refers to the feedset to be displayed. This is the id reference to the <set> section in [[RssFeeds.xml]] (see below):
| class="usercell" | '''id'''
|-  
| class="usercell" | Specifies the control's id. The value this takes depends on the control type, and the window that you are using the control on. There are special control id's that must be present in each window. '''RSS feeds may take any id they like, as long as it's not one of the special control id's that the window needs.'''
| '''font'''
|- class="userrow"
| Specifies the font to use from the font.xml file.
| class="usercell" | '''posx'''
|-  
| class="usercell" | Specifies where the left of the feed should be drawn. This is offset from the window's coordinates (normally the left edge of the screen, or 0).
| '''textcolor'''
|- class="userrow"
| Specified the color the text should be. In hex AARRGGBB format, or a name from the [[Colour_themes|colour theme.]]
| class="usercell" | '''posy'''
|-  
| class="usercell" | Specifies where the top edge of the feed should be drawn. This is offset from the window's coordinates (normally the top edge of the screen, or 0).
| '''shadowcolor'''
|- class="userrow"
| Specifies the color of the drop shadow on the text. In AARRGGBB format, or a name from the [[Colour_themes|colour theme.]]
| class="usercell" | '''width'''
|-  
| class="usercell" | Specifies the width that should be used to draw the rss feed. The text scrolls within this width.
| '''headlinecolor'''
|- class="userrow"
| Specified the color that any highlighted text should be. In hex AARRGGBB format, or a name from the [[Colour_themes|colour theme.]]
| class="usercell" | '''visible'''
|-  
| class="usercell" |
| '''titlecolor'''
Specifies a condition as to when this control will be visible. Can be true, false, or a condition. [[Conditional Visibility|See here for more information.]] Defaults to true.
| Specified the color the titles of the feeds should be. In hex AARRGGBB format, or a name from the [[Colour_themes|colour theme.]]
|- class="userrow"
|-  
| class="usercell" | '''animation'''
|-
| class="usercell" |
| '''scrollspeed'''
Specifies the animation to be run when the control enters a particular state. [[Animating Your Skin|See here for more information.]]
| Scroll speed of text in pixels per second.
|- class="userrow"
| class="usercell" | '''font'''
| class="usercell" | Specifies the font to use from the font.xml file.
|- class="userrow"
| class="usercell" | '''textcolor'''
| class="usercell" | Specified the color the text should be, in hex AARRGGBB format.
|- class="userrow"
| class="usercell" | '''shadowcolor'''
| class="usercell" | Specifies the color of the drop shadow on the text, in AARRGGBB format.
|- class="userrow"
| class="usercell" | '''highlightcolor'''
| class="usercell" | Specified the color that any highlighted text should be, in hex AARRGGBB format.
|- class="userrow"
| class="usercell" | '''titlecolor'''
| class="usercell" | Specified the color the titles of the feeds should be, in hex AARRGGBB format.
|- class="userrow"
| class="usercell" | '''urlset'''
| class="usercell" | The actual RSS feedset to use. This is an id reference to the <rss> section in [[RssFeeds.xml]]:
|}
|}
<xml>
 
<rssfeeds>
 
  <set id="1">
 
    <feed updateinterval="30">http://feeds.feedburner.com/XboxScene</feed>
== RssFeeds.xml ==
    <feed updateinterval="30">http://feeds.wired.com/wired/topheadlines</feed>
{{Main|RssFeeds.xml}}
  </set>
The actual content of the RSS feed is defined in the [[RssFeeds.xml]] file stored in the user's profile. Here is an example :
  <set id="2">
 
    <feed updateinterval="30">http://www.cnet.co.uk/feeds/public/rss_news_10.htm</feed>
<syntaxhighlight lang=xml enclose="div">
  </set>
<rssfeeds>
</rssfeeds>
  <set id="1">
</xml>
    <feed updateinterval="30">http://feeds.feedburner.com/XboxScene</feed>
Each feedset has an id attribute – this is what we are referencing in the <urlset> parameter. As can be seen, 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 <nowiki>(ie replace & with &amp; etc.)</nowiki>. Each feed in the set runs through in the order they are defined. [[HOW-TO: Change RSS feeds and more info on RSS feeds|More information about RSS feeds can be found here.]]
    <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>
</syntaxhighlight>
 
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 <nowiki>(ie replace & with &amp; etc.)</nowiki>. Each feed in the set runs through in the order they are defined.
<section end="main content" />
 
 
 
{{top}}
 
 
{{updated|18}}
[[Category:Manual]]
[[Category:Skin development]]

Revision as of 07:43, 21 October 2021

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.


Kodi RSS Feeds

The following addresses are the default RSS Feeds for Kodi.

   http://feeds.kodi.tv/xbmc</feed>
   http://feeds.kodi.tv/latest_xbmc_addons</feed>
   http://feeds.kodi.tv/updated_xbmc_addons</feed>


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