======  general ======


===== about xml  =====
<code>

The Extensible Markup Language (XML) is a general-purpose markup language.
It is classified as an extensible language because it allows its users to
define their own tags.
Its primary purpose is to facilitate the sharing of structured data across
different information systems, particularly via the Internet.

</code>
taken from [[http://en.wikipedia.org/wiki/Xml|wikipedia.com]]

parsing XML-feeds is the most popular way for information interchange between web -based or -related applications. the common [[http://en.wikipedia.org/wiki/RSS|RSS]] format might be one of the most popular examples. so it is not very surprising that current web-affinity video players do parse XML feeds also to get their playlist data. unfortunately most (especially flash-) developers give a shit on web-standards. furthermore XML is... yes... extensible by definition as e.g. the new adobe media player shows. as a respectful tribute to this, feedbeat implements custom formated XML feeds to give you any flexibility you need to use any player you want.







===== basic structure  =====

<code>

<meta * >                                          <--- feedbeat calls this "root tag" -- the * indicates where the "root attributes" are placed in
   <channel>                                       <--- feedbeat calls this "channel tag"
       <channel blabla> </channel blabla>          <--- this is included via feedbeat´s "root template"
       <channel content>
         <item 1>                                  <--- "item" is feedbeat´s "item tag"
             <item title>blabla</item title>       <--- this stuff is included by that what feedbeat calls "item template"
             <item source>http:...</item source>
         </item 1>                 
         <item 2></item 2>
         <item 3></item 3>
         <item 4></item 4>
       </channel content>
   </channel>
</meta>



</code>


<note important>
in case a specific information-tag you need is missing, please do not hesitate to send a [[http://help.feedbeat.org|helpdesk-ticket]]
</note>


=====  channel template tags =====

the following tags are available within the //channel tag// section of your xml template






==== general info ====
^ tag ^ usage ^
|#{title} |channel´s name / title |
|#{self_reference} |full qualified URL of THIS xml-file |
|#{description} |channel´s description (plain, no BBcode, no HTML-tags) |
|#{link} |link to this xml file |
|#{generator} |feedbeat version info |
|#{pubdate} |RFC 2822  compliant publication / creation date of this feed |
|#{owner} |your feedbeat user-/account- name |
|#{channel_ID} |numeric ID of this channel |
|#{channel_logo} |fully qualified URL to this channel´s logo |
|#{channel_url} |link to this channel´s channel browser / open search page (hosted by feedbeat)  |
|#{channel_tv_url} |link to this channel´s webTV player (hosted by feedbeat)  |
|#{channel_custom_url} |link to this channel´s custom home URL (as specified in channel properties - if empty equal to //channel_url//  |
|#{docu_path} |link to wiki-page containing detailed consumer documentation how to manipulate feedcontent by URL parameters |
|#{feed_mode} |string containing "dramaturgic" or "regular" depending on [[io:feeds|mode]] setting. "regular" is default. |

==== example ====

**template:**

  <language>en-us</language>
  <copyright>MIT</copyright>
  <title>#{title}</title>
  <description>#{description}</description>
  <link>#{link}</link>


**result:**

  <language>en-us</language>
  <copyright>MIT</copyright>
  <title>feedbeat demo tv 3000</title>
  <description>all you video are belong to us</description>
  <link>http://demo.feedbeat.com/feedbeat-demo-tv-3000/feeda/</link>




===== item template tags =====

the following tags are available for the //item tag//s of your xml templates:
//videos will be referenced as "items" below//


==== general helper tags ====

^ tag ^ usage ^
|#{cdata_open} |returns "<![CDATA[" - if you need this string, use this tag. the xml-parser will fail elsewise. |
|#{cdata_close} |returns "]]>" |


==== general info ====
 
^ tag ^ usage ^
|#{title} |item title as shown in your playlist-editor |
|#{description} |item&Atilde;‚&Acirc;&acute;s description as shown in the advanced item-editor |
|#{pubdate} |RFC 2822  compliant publication / creation date of specific item |
|#{tags} |item tags  as shown in the advanced item-editor |
|#{owner} |your feedbeat user-/account- name |
|#{owner_id} |your numeric user-ID |
|#{guid} |unique item ID-hash |
|#{thumbnail} |item´s fully qualified thumnail-URL |
|#{html_thumb} |html-entity encoded IMG-tag of item´s thumbnail (prefereable used in descriptions} |
|#{permalink} |item´s fully qualified permalink-URL (pointing to webTV player hostedt by feedbeat) |

==== bucket info ====
^ tag  ^ usage ^ 
|#{folder_title} |bucket´s name / title each item belongs to |
|#{folder_ID} |numeric bucket ID each item belongs to |





==== media info  ====

^ tag ^ usage ^
|#{identifier}  |feebdeat source-identifier (e.g. youtube, google, blip or 'direct') |
|#{source}  |source URL where the video has been bookmarked from (or direct download URL in case of directly linked item) |
|#{resolution}  |item resolution in x pixels |
|#{frames}  |items´s amount of frames per second |
|#{duration}  |item´s  duration in seconds |
|#{filesize}  |item´s  physical filesize in kb |
|#{codec}  |item´s codec (e.g. "H264") |
|#{type}  |item´s container type (e.g. "mp4")|
|#{media_url}  |item´s media-delivery URL (non static) |

==== channel info  ====

^ tag ^ usage ^
|#{channel_title}  |channel´s title (each item belongs to |
|#{channel_description}  |channel´s description |
|#{channel_id}  |a numeric channel ID |
|#{channel_logo}  |full qualified path to channel´s logo |
|#{channel_link}  |full qualified URL to //THIS feed// |

==== misc info  ====

^ tag ^ usage ^
|#{files_url}  |full qualified path to your feedbeat file-folder (e.g. your logos etc) |
|#{generator}  |feedbeat version information |