xbmc/guilib/GUIRSSControl.dox

   1 /*!
   2
   3 \page RSS_feed_Control RSS ticker
   4 \brief **Used to display scrolling RSS feeds.**
   5
   6 \tableofcontents
   7
   8 Kodi can display an RSS feed on the home screen of the default skin/interface
   9 (Estuary), as well as any other skin that supports RSS feeds. By default,
  10 the RSS news feed is taken from [http://kodi.tv](http://kodi.tv/), but the feed
  11 can be changed to almost any RSS feed.
  12
  13 @note Don't confuse the RSS ticker with RSS media source, which allows access to
  14 video and/or audio RSS streams.
  15
  16
  17 --------------------------------------------------------------------------------
  18 \section RSS_feed_Control_sect1 RSS ticker settings
  19
  20 The RSS ticker can be toggled on or off by going to
  21 <b>`Settings -> Appearance -> Skin -> Show RSS news feed`</b>
  22
  23 Below this setting one can also change the RSS news feed address.
  24
  25
  26 --------------------------------------------------------------------------------
  27 \section RSS_feed_Control_sect2 Technical documentation for skinners
  28
  29   Main page: [Skin development](http://kodi.wiki/view/Skin_development)
  30
  31 \subsection RSS_feed_Control_sect2_1 RSS control
  32 The rss control is used for displaying scrolling RSS feeds from the internet
  33 in Kodi. You can choose the font, size, colour, location and the RSS feed to
  34 be displayed.
  35
  36 __Example:__
  37
  38 ~~~~~~~~~~~~~
  39 <control type="rss" id="1">
  40   <description>My First RSS control</description>
  41   <posx>80</posx>
  42   <posy>60</posy>
  43   <width>500</width>
  44   <visible>true</visible>
  45   <font>font14</font>
  46   <textcolor>FFB2D4F5</textcolor>
  47   <headlinecolor>FFFFFFFF</headlinecolor>
  48   <titlecolor>FF655656</titlecolor>
  49 </control>
  50 ~~~~~~~~~~~~~
  51
  52
  53 \subsection RSS_feed_Control_sect2_2 Available tags and attributes
  54
  55 In addition to the [Default Control Tags](http://kodi.wiki/view/Default_Control_Tags)
  56 the following tags are available. Note that each tag is **lower case** only. This is
  57 important, as `xml` tags are case-sensitive.
  58
  59 | Tag           | Description                                                   |
  60 |--------------:|:--------------------------------------------------------------|
  61 | id            | This refers to the feedset to be displayed. This is the id reference to the <b>`<set>`</b> section in [RssFeeds.xml](http://kodi.wiki/view/RssFeeds.xml) (see below):
  62 | font          | Specifies the font to use from the font.xml file.
  63 | textcolor     | Specified the color the text should be. In hex **AARRGGBB** format, or a name from the [colour theme](http://kodi.wiki/view/Colour_Themes).
  64 | shadowcolor   | Specifies the color of the drop shadow on the text. In **AARRGGBB** format, or a name from the [colour theme](http://kodi.wiki/view/Colour_Themes).
  65 | headlinecolor | Specified the color that any highlighted text should be. In hex **AARRGGBB** format, or a name from the [colour theme](http://kodi.wiki/view/Colour_Themes).
  66 | titlecolor    | Specified the color the titles of the feeds should be. In hex **AARRGGBB** format, or a name from the [colour theme](http://kodi.wiki/view/Colour_Themes).
  67 | scrollspeed   | Scroll speed of text in pixels per second.
  68
  69
  70 \subsection RSS_feed_Control_sect2_3 RssFeeds.xml
  71
  72 - <em>Main page: [RssFeeds.xml](http://kodi.wiki/view/RssFeeds.xml)</em>
  73
  74 The actual content of the RSS feed is defined in the
  75 [RssFeeds.xml](http://kodi.wiki/view/RssFeeds.xml) file stored in the user's
  76 profile. Here is an example :
  77
  78 ~~~~~~~~~~~~~
  79  <rssfeeds>
  80    <set id="1">
  81      <feed updateinterval="30">http://feeds.feedburner.com/XboxScene</feed>
  82      <feed updateinterval="30">http://feeds.wired.com/wired/topheadlines</feed>
  83    </set>
  84    <set id="2">
  85      <feed updateinterval="30">http://www.cnet.co.uk/feeds/public/rss_news_10.htm</feed>
  86    </set>
  87  </rssfeeds>
  88 ~~~~~~~~~~~~~
  89
  90 As can be seen, each feedset has an id attribute – this is what we are
  91 referencing in the <b>`<id>`</b> attribute of the control. There can be more
  92 than one <b>`<set>`</b> defined, and more than one <b>`<feed>`</b> per
  93 set. The <b>`<feed>`</b>'s must be escaped so that they're xml-safe (ie replace &
  94 with & etc.). Each feed in the set runs through in the order they are defined.
  95
  96
  97 --------------------------------------------------------------------------------
  98 \section RSS_feed_Control_sect3 See also
  99
 100 - [RssFeeds.xml](http://kodi.wiki/view/RssFeeds.xml)
 101
 102 #### Development:
 103 - [Add-on development](http://kodi.wiki/view/Add-on_development)
 104 - [Skinning](http://kodi.wiki/view/Skinning)
 105
 106 */