View source for Documentation:Modules/rss

{{Module|name=marq|type=Video subfilter|first_version=0.8.4|description=Overlays RSS and Atom feeds on the video}}

== Options ==

{{Option
|name=rss-urls
|value=string
|default=""
|description=Pipe <nowiki>'|'</nowiki> seperated list of RSS and/or Atom feed URLs
}}

{{Option
|name=rss-x
|value=integer
|default=0 (0.8.6d and prior: -1)
|description=X offset from upper left corner. (0.8.6d and prior: This is only if both rss-x and rss-y are positive)
}}
{{Option
|name=rss-y
|value=integer
|default=0
|description=Y offset from upper left corner. (0.8.6d and prior: This is only if both rss-x and rss-y are positive)
}}
{{Option
|name=rss-position
|value=integer
|default=5
|description=Feed position: 0=center, 1=left, 2=right, 4=top, 8=bottom, you can also use combinations of these values, eg 6 = top-right. (0.8.6d and prior: This is only used if rss-x or rss-y are negative)
}}

{{Option
|name=rss-opacity
|value=integer
|default=255
|description=Feed opacity. 0 is transparent, 255 is fully opaque
}}
{{Option
|name=rss-color
|value=integer
|default=16777215 (0xFFFFFF, white)
|description=Feed text color. Use the decimal value of the HTML color code
}}
{{Option
|name=rss-size
|value=integer
|default=-1
|description=Font size in pixels. -1 uses the default font size
}}

{{Option
|name=rss-speed
|value=integer
|default=100000
|description=Speed in characters by µs
}}
{{Option
|name=rss-length
|value=integer
|default=60
|description=Maximum number of characters to display
}}
{{Option
|name=rss-ttl
|value=integer
|default=1800
|description=Time in seconds between each feed refresh
}}
{{Option
|name=rss-images
|default=enabled
|description=Display the feed's image if available
}}
{{Option
|name=rss-title
|value=integer
|default=-1
|description=-1 for default, 0 to hide the feed's title, 1 to always show it and 2 to make it scroll
}}

== See also ==
* [[Documentation:Modules/marq]]

{{Stub}}

{{Documentation}}