Recent changes to ORML

WikiPage ORML modified by kavulix

kavulix — Mon, 12 Nov 2012 01:12:36 -0000

--- v12
+++ v13
@@ -19,10 +19,10 @@
 ***
 
 OpenRokn Feeds
-There are two types of ORML feeds supported by OpenRokn, primary and secondary feeds.  All ORML feeds MUST begin with an orml element containing a version and namespace attribute.
+There are two types of ORML feeds supported by OpenRokn.  All ORML feeds MUST begin with an orml element containing a version and namespace attribute.  The second element can be either a "channel" or "feed" element.  It is the second element that determines whether it will be a primary or secondary feed.
 
 Primary feeds
-Your Roku channel will typically only contain a single primary feed.  The one exception is the [search item](https://sourceforge.net/p/openrokn/home/search_item/).  The primary feed contains the main layout for your channel and determines which content is displayed when the channel first loads.  All primary feeds MUST contain a channel element as the first child node of the orml element.
+Your Roku channel will typically only contain a single primary feed.  The one exception is the [search item](https://sourceforge.net/p/openrokn/home/search_item/) which requires that search results be returned as a primary feed.  All primary feeds MUST contain a channel element as the first child node of the orml element.
 
 ***
     
@@ -31,7 +31,9 @@
     
 ***
 
-Primary feeds are used when you need the initial screen to be either a poster or grid screen (e.g., when a channel first loads).  The channel element tells the software to expect either a poster or grid as the first item.  If neither a poster or grid item is detected then the channel will exit.  The first item in a primary feed is slightly different from other items in that you only need to provide a style and title attribute.  Since the item isn't displayed as a poster you won't need to provide the sdposterurl or hdposterurl attributes.
+Primary feeds are used when you need the initial screen to be either a poster or grid screen (e.g., when a channel first loads).  The channel element tells the software to expect either a poster or grid as the first item.  If neither a poster or grid item is detected then the channel will exit or in the case of search items it will alert the user that no results were found.
+
+The first poster or grid item in a primary feed is slightly different from other poster/grid items in that you only need to provide a style and title attribute.  Since the first item is never displayed on a poster screen you won't need to provide the sdposterurl, hdposterurl or shortdesc attributes.  The title that you choose will be the first breadcrumb text displayed in the top right corner of the screen.
 
 ***
     
@@ -43,14 +45,16 @@
 ***
 
 Secondary feeds
-A secondary feed is a feed that is used to populate a poster screen or a row on a grid screen and is used in combination with the feedurl attribute.  All secondary feeds MUST contain a feed element as the first child node of the orml element.  The first item element can be any of the supported types.  It does not have to be a poster or grid item.  Secondary feeds are described in more detail on the [poster](https://sourceforge.net/p/openrokn/home/poster_item/) and [grid](https://sourceforge.net/p/openrokn/home/grid_item/) pages. Below is a secondary feed example.
+A secondary feed is a feed that is used to populate a poster screen or a row on a grid screen and is used in combination with the feedurl attribute.  All secondary feeds MUST contain a feed element as the first child node of the orml element.  The first item element can be any of the supported types.  It does not have to be a poster or grid item.  Secondary feeds are described in more detail on the [poster](http://sourceforge.net/p/openrokn/home/poster_item/) and [grid](http://sourceforge.net/p/openrokn/home/grid_item/) pages. Below is a secondary feed example.
 
 ***
     
       
         
+           This is a document
         
         
+           This is a video

WikiPage ORML modified by kavulix

kavulix — Sat, 10 Nov 2012 15:24:57 -0000

--- v11
+++ v12
@@ -22,7 +22,7 @@
 There are two types of ORML feeds supported by OpenRokn, primary and secondary feeds.  All ORML feeds MUST begin with an orml element containing a version and namespace attribute.
 
 Primary feeds
-Your Roku channel will typically only contain a single primary feed.  The one exception is the [search_item](https://sourceforge.net/p/openrokn/home/search_item/).  The primary feed contains the main layout for your channel and determines which content is displayed when the channel first loads.  All primary feeds MUST contain a channel element as the first child node of the orml element.
+Your Roku channel will typically only contain a single primary feed.  The one exception is the [search item](https://sourceforge.net/p/openrokn/home/search_item/).  The primary feed contains the main layout for your channel and determines which content is displayed when the channel first loads.  All primary feeds MUST contain a channel element as the first child node of the orml element.
 
 ***
     
@@ -43,7 +43,7 @@
 ***
 
 Secondary feeds
-A secondary feed is a feed that is used to populate a poster screen or a row on a grid screen and is used in combination with the feedurl attribute.  All secondary feeds MUST contain a feed element as the first child node of the orml element.  The first item element can be any of the supported types.  It does not have to be a poster or grid item.  Secondary feeds are described in more detail on the [poster_item](https://sourceforge.net/p/openrokn/home/poster_item/) and [grid_item](https://sourceforge.net/p/openrokn/home/grid_item/) pages. Below is a secondary feed example.
+A secondary feed is a feed that is used to populate a poster screen or a row on a grid screen and is used in combination with the feedurl attribute.  All secondary feeds MUST contain a feed element as the first child node of the orml element.  The first item element can be any of the supported types.  It does not have to be a poster or grid item.  Secondary feeds are described in more detail on the [poster](https://sourceforge.net/p/openrokn/home/poster_item/) and [grid](https://sourceforge.net/p/openrokn/home/grid_item/) pages. Below is a secondary feed example.
 
 ***

WikiPage ORML modified by kavulix

kavulix — Fri, 09 Nov 2012 00:10:53 -0000

--- v10
+++ v11
@@ -8,10 +8,10 @@
 [FEED](https://sourceforge.net/p/openrokn/home/feed_element/)
 [ITEM](https://sourceforge.net/p/openrokn/home/item_element/)
 [ROW](https://sourceforge.net/p/openrokn/home/row_element/)
-[STREAM](https://sourceforge.net/p/openrokn/home/stream_element/)
 [DESCRIPTION](https://sourceforge.net/p/openrokn/home/description_element/)
 [BODY](https://sourceforge.net/p/openrokn/home/body_element/)
 [POLICY](https://sourceforge.net/p/openrokn/home/policy_element/)
+[STREAM](https://sourceforge.net/p/openrokn/home/stream_element/)
 [IMAGE](https://sourceforge.net/p/openrokn/home/image_element/)
 [SCRAPER](https://sourceforge.net/p/openrokn/home/scraper_element/)
 [EXTENSION](https://sourceforge.net/p/openrokn/home/extension_element/)

WikiPage ORML modified by kavulix

kavulix — Thu, 08 Nov 2012 22:52:39 -0000

--- v9
+++ v10
@@ -8,6 +8,7 @@
 [FEED](https://sourceforge.net/p/openrokn/home/feed_element/)
 [ITEM](https://sourceforge.net/p/openrokn/home/item_element/)
 [ROW](https://sourceforge.net/p/openrokn/home/row_element/)
+[STREAM](https://sourceforge.net/p/openrokn/home/stream_element/)
 [DESCRIPTION](https://sourceforge.net/p/openrokn/home/description_element/)
 [BODY](https://sourceforge.net/p/openrokn/home/body_element/)
 [POLICY](https://sourceforge.net/p/openrokn/home/policy_element/)

WikiPage ORML modified by kavulix

kavulix — Thu, 08 Nov 2012 20:47:29 -0000

--- v8
+++ v9
@@ -18,7 +18,7 @@
 ***
 
 OpenRokn Feeds
-There are two types of xml feeds supported by OpenRokn, primary and secondary feeds.  All ORML feeds MUST begin with an orml element containing a version and namespace attribute.
+There are two types of ORML feeds supported by OpenRokn, primary and secondary feeds.  All ORML feeds MUST begin with an orml element containing a version and namespace attribute.
 
 Primary feeds
 Your Roku channel will typically only contain a single primary feed.  The one exception is the [search_item](https://sourceforge.net/p/openrokn/home/search_item/).  The primary feed contains the main layout for your channel and determines which content is displayed when the channel first loads.  All primary feeds MUST contain a channel element as the first child node of the orml element.

WikiPage ORML modified by kavulix

kavulix — Thu, 08 Nov 2012 20:46:13 -0000

--- v7
+++ v8
@@ -1,35 +1,39 @@
-ORML Version 1.1
+ORML Version 1.2
 
 ***
 
-There are a total of 8 item types/screens supported by OpenRokn.  All Roku screens supported by OpenRokn are considered items. Each screen is represented by an item element in orml feeds. When you want to add a new screen or new media object to your feed you simply add a new item tag. The screen type is then specified with the type attribute. 
-
-Item types: [poster](https://sourceforge.net/p/openrokn/home/poster/), [grid](https://sourceforge.net/p/openrokn/home/grid/), 
-[audio](https://sourceforge.net/p/openrokn/home/audio/), 
-[video](https://sourceforge.net/p/openrokn/home/video/), 
-[slideshow](https://sourceforge.net/p/openrokn/home/slideshow/), 
-[document](https://sourceforge.net/p/openrokn/home/document/), 
-[settings](https://sourceforge.net/p/openrokn/home/settings/), 
-[search](https://sourceforge.net/p/openrokn/home/searchitem/)
+Supported Elements
+[ORML](https://sourceforge.net/p/openrokn/home/orml_element/)
+[CHANNEL](https://sourceforge.net/p/openrokn/home/channel_element/)
+[FEED](https://sourceforge.net/p/openrokn/home/feed_element/)
+[ITEM](https://sourceforge.net/p/openrokn/home/item_element/)
+[ROW](https://sourceforge.net/p/openrokn/home/row_element/)
+[DESCRIPTION](https://sourceforge.net/p/openrokn/home/description_element/)
+[BODY](https://sourceforge.net/p/openrokn/home/body_element/)
+[POLICY](https://sourceforge.net/p/openrokn/home/policy_element/)
+[IMAGE](https://sourceforge.net/p/openrokn/home/image_element/)
+[SCRAPER](https://sourceforge.net/p/openrokn/home/scraper_element/)
+[EXTENSION](https://sourceforge.net/p/openrokn/home/extension_element/)
 
 ***
 
-All ORML feeds MUST begin with an orml element containing a version and namespace attribute.
+OpenRokn Feeds
+There are two types of xml feeds supported by OpenRokn, primary and secondary feeds.  All ORML feeds MUST begin with an orml element containing a version and namespace attribute.
 
 Primary feeds
-Your Roku channel will typically contain only a single primary feed.  The one exception is the [search screen](https://sourceforge.net/p/openrokn/home/search/).  The primary feed contains the main layout for your channel and its url should be embedded within the settings.brs file.  All primary feeds MUST contain a channel element as the first child node of the orml element.
+Your Roku channel will typically only contain a single primary feed.  The one exception is the [search_item](https://sourceforge.net/p/openrokn/home/search_item/).  The primary feed contains the main layout for your channel and determines which content is displayed when the channel first loads.  All primary feeds MUST contain a channel element as the first child node of the orml element.
 
 ***
-    
+    
        
        
     
 ***
 
-Primary feeds are used when you need the initial screen to be either a poster or grid screen (e.g., when a channel first loads).  The channel element notifies the software to expect either a poster or grid as the first item.  If neither a poster or grid item is detected then the channel will exit.  Therefore it is important that the type attribute of the first item in your primary feed contains the poster or grid value. The first item in a primary feed is slightly different from other items in that you only need to provide a style and title attribute.
+Primary feeds are used when you need the initial screen to be either a poster or grid screen (e.g., when a channel first loads).  The channel element tells the software to expect either a poster or grid as the first item.  If neither a poster or grid item is detected then the channel will exit.  The first item in a primary feed is slightly different from other items in that you only need to provide a style and title attribute.  Since the item isn't displayed as a poster you won't need to provide the sdposterurl or hdposterurl attributes.
 
 ***
-    
+    
        
           
           
@@ -38,10 +42,10 @@
 ***
 
 Secondary feeds
-A secondary feed is a feed that is used to populate a poster screen or a row on a grid screen and is typically used in combination with the feedurl attribute.  All secondary feeds MUST contain a feed element as the first child node of the orml element.  The first item element can be any of the supported types.  It does not have to be a poster or grid screen.  Secondary feeds are described in more detail on the [poster](https://sourceforge.net/p/openrokn/home/poster/) and [grid](https://sourceforge.net/p/openrokn/home/grid/) pages. Below is a secondary feed example.
+A secondary feed is a feed that is used to populate a poster screen or a row on a grid screen and is used in combination with the feedurl attribute.  All secondary feeds MUST contain a feed element as the first child node of the orml element.  The first item element can be any of the supported types.  It does not have to be a poster or grid item.  Secondary feeds are described in more detail on the [poster_item](https://sourceforge.net/p/openrokn/home/poster_item/) and [grid_item](https://sourceforge.net/p/openrokn/home/grid_item/) pages. Below is a secondary feed example.
 
 ***
-    
+

WikiPage ORML modified by kavulix

kavulix — Thu, 29 Mar 2012 07:37:43 -0000

--- v6 
+++ v7 
@@ -19,28 +19,33 @@
 Primary feeds
 Your Roku channel will typically contain only a single primary feed.  The one exception is the [search screen](https://sourceforge.net/p/openrokn/home/search/).  The primary feed contains the main layout for your channel and its url should be embedded within the settings.brs file.  All primary feeds MUST contain a channel element as the first child node of the orml element.
 
-<orml version="1.1" xmlns="http://sourceforge.net/p/openrokn/home/ORML">

-   <channel>

-   </channel>

-</orml>

-
+***
+    
+       
+       
+    
+***
+
 Primary feeds are used when you need the initial screen to be either a poster or grid screen (e.g., when a channel first loads).  The channel element notifies the software to expect either a poster or grid as the first item.  If neither a poster or grid item is detected then the channel will exit.  Therefore it is important that the type attribute of the first item in your primary feed contains the poster or grid value. The first item in a primary feed is slightly different from other items in that you only need to provide a style and title attribute.
 
-<orml version="1.1" xmlns="http://sourceforge.net/p/openrokn/home/ORML">

-  <channel>

-    <item type="poster" style="flat-category" title="Home">

-    </item>

-  </channel>

-</orml>

+***
+    
+       
+          
+          
+       
+    
+***
 
 Secondary feeds
 A secondary feed is a feed that is used to populate a poster screen or a row on a grid screen and is typically used in combination with the feedurl attribute.  All secondary feeds MUST contain a feed element as the first child node of the orml element.  The first item element can be any of the supported types.  It does not have to be a poster or grid screen.  Secondary feeds are described in more detail on the [poster](https://sourceforge.net/p/openrokn/home/poster/) and [grid](https://sourceforge.net/p/openrokn/home/grid/) pages. Below is a secondary feed example.
 
-<orml version="1.1" xmlns="http://sourceforge.net/p/openrokn/home/ORML">

-  <feed>

-    <item type="document">

-    </item>

-    <item type="video">

-    </item>

-  </feed>

-</orml>

+***
+    
+      
+        
+        
+        
+        
+      
+

WikiPage ORML modified by kavulix

kavulix — Thu, 29 Mar 2012 06:36:37 -0000

--- v5 
+++ v6 
@@ -1,16 +1,16 @@
-Version 1.1
-
+ORML Version 1.1
+
 ***
 
 There are a total of 8 item types/screens supported by OpenRokn.  All Roku screens supported by OpenRokn are considered items. Each screen is represented by an item element in orml feeds. When you want to add a new screen or new media object to your feed you simply add a new item tag. The screen type is then specified with the type attribute. 
 
 Item types: [poster](https://sourceforge.net/p/openrokn/home/poster/), [grid](https://sourceforge.net/p/openrokn/home/grid/), 
 [audio](https://sourceforge.net/p/openrokn/home/audio/), 
 [video](https://sourceforge.net/p/openrokn/home/video/), 
 [slideshow](https://sourceforge.net/p/openrokn/home/slideshow/), 
 [document](https://sourceforge.net/p/openrokn/home/document/), 
 [settings](https://sourceforge.net/p/openrokn/home/settings/), 
-[search](https://sourceforge.net/p/openrokn/home/search/)
+[search](https://sourceforge.net/p/openrokn/home/searchitem/)
 
 ***

WikiPage ORML modified by kavulix

kavulix — Thu, 29 Mar 2012 06:27:42 -0000

--- v4 
+++ v5 
@@ -1,44 +1,46 @@
-UNDER CONSTRUCTION
-
-Synonymous terms
-There are some terms used throughout this guide that are synonymous with each other so to avoid any confusion they will be defined at the top of each page.
-
-Creating your main feed
-All ORML feeds begin with an orml element containing a version and namespace attribute and a child node named channel.
-
-<orml version="1.0" xmlns="http://sourceforge.net/p/openrokn/home/ORML">

+Version 1.1
+
+***
+
+There are a total of 8 item types/screens supported by OpenRokn.  All Roku screens supported by OpenRokn are considered items. Each screen is represented by an item element in orml feeds. When you want to add a new screen or new media object to your feed you simply add a new item tag. The screen type is then specified with the type attribute. 
+
+Item types: [poster](https://sourceforge.net/p/openrokn/home/poster/), [grid](https://sourceforge.net/p/openrokn/home/grid/), 
+[audio](https://sourceforge.net/p/openrokn/home/audio/), 
+[video](https://sourceforge.net/p/openrokn/home/video/), 
+[slideshow](https://sourceforge.net/p/openrokn/home/slideshow/), 
+[document](https://sourceforge.net/p/openrokn/home/document/), 
+[settings](https://sourceforge.net/p/openrokn/home/settings/), 
+[search](https://sourceforge.net/p/openrokn/home/search/)
+
+***
+
+All ORML feeds MUST begin with an orml element containing a version and namespace attribute.
+
+Primary feeds
+Your Roku channel will typically contain only a single primary feed.  The one exception is the [search screen](https://sourceforge.net/p/openrokn/home/search/).  The primary feed contains the main layout for your channel and its url should be embedded within the settings.brs file.  All primary feeds MUST contain a channel element as the first child node of the orml element.
+
+<orml version="1.1" xmlns="http://sourceforge.net/p/openrokn/home/ORML">

    <channel>

    </channel>

 </orml>

 
-All Roku screens supported by OpenRokn are considered items. Each screen is represented by an item element in orml feeds. When you want to add a new screen or new media object to your feed you simply add a new item tag. The screen type is then specified with the type attribute. The initial screen displayed by OpenRokn is a category screen (roPosterScreen). Therefore it is necessary to begin your main channel feed with an <item type="category"> element. This category item is slightly different from other categories in that you only need to provide a style and title attribute.
-
-<orml version="1.0" xmlns="http://sourceforge.net/p/openrokn/home/ORML">

+Primary feeds are used when you need the initial screen to be either a poster or grid screen (e.g., when a channel first loads).  The channel element notifies the software to expect either a poster or grid as the first item.  If neither a poster or grid item is detected then the channel will exit.  Therefore it is important that the type attribute of the first item in your primary feed contains the poster or grid value. The first item in a primary feed is slightly different from other items in that you only need to provide a style and title attribute.
+
+<orml version="1.1" xmlns="http://sourceforge.net/p/openrokn/home/ORML">

   <channel>

-    <item type="category" style="flat-category" title="Home">

+    <item type="poster" style="flat-category" title="Home">

     </item>

   </channel>

 </orml>

 
-Secondary feeds, which are described in more detail on [this page](https://sourceforge.net/p/openrokn/home/category/), do not have to begin with a category screen. They can contain any type of item. The above requirement only applies to your main channel feed. Below is a secondary feed example.
-
-<orml version="1.0" xmlns="http://sourceforge.net/p/openrokn/home/ORML">

+Secondary feeds
+A secondary feed is a feed that is used to populate a poster screen or a row on a grid screen and is typically used in combination with the feedurl attribute.  All secondary feeds MUST contain a feed element as the first child node of the orml element.  The first item element can be any of the supported types.  It does not have to be a poster or grid screen.  Secondary feeds are described in more detail on the [poster](https://sourceforge.net/p/openrokn/home/poster/) and [grid](https://sourceforge.net/p/openrokn/home/grid/) pages. Below is a secondary feed example.
+
+<orml version="1.1" xmlns="http://sourceforge.net/p/openrokn/home/ORML">

   <feed>

     <item type="document">

     </item>

     <item type="video">

     </item>

   </feed>

 </orml>

-
-***
-
-There are a total of 7 item types/screens supported by OpenRokn.
-
-Item types: [category](https://sourceforge.net/p/openrokn/home/category/), 
-[document](https://sourceforge.net/p/openrokn/home/document/), 
-[settings](https://sourceforge.net/p/openrokn/home/settings/), 
-[video](https://sourceforge.net/p/openrokn/home/video/), 
-[audio](https://sourceforge.net/p/openrokn/home/audio/), 
-[slideshow](https://sourceforge.net/p/openrokn/home/slideshow/), 
-[search](https://sourceforge.net/p/openrokn/home/search/)

WikiPage ORML modified by kavulix

kavulix — Fri, 11 Nov 2011 21:45:09 -0000

--- v3 
+++ v4 
@@ -1,5 +1,7 @@
+UNDER CONSTRUCTION
+
 Synonymous terms
-There are some terms used throughout this guide that are synonymous with each other so to avoid any confusion they will be defined at the top of each page. This guide may at times refer to an element, tag or node which are all synonyms for the tag used in the source code of an xml feed.
+There are some terms used throughout this guide that are synonymous with each other so to avoid any confusion they will be defined at the top of each page.
 
 Creating your main feed
 All ORML feeds begin with an orml element containing a version and namespace attribute and a child node named channel.