Recent changes to document_item

WikiPage document_item modified by kavulix

kavulix — Sun, 11 Nov 2012 02:24:24 -0000

--- v15
+++ v16
@@ -83,8 +83,8 @@
 Supported values
 true|false
 Notes
-This attribute accepts any valid regular expression. It should support nearly every regex option that the perl language supports. Do not use parentheses in this expression. It is intended to filter out unwanted content rather than matching a specific sequence of characters. For example, if you have linked to a html document and you know that the content you want to display is located in a div element with an id of "news_article" then you could use the example below to filter out everything before and after the div element. You will need to encode any xml entities (e.g., [&<>"]) and if your regex statement includes quotes I would recommend using \x22 for each quote instead of "
-Example: "^.+?<div id=\x22news_article\x22>|</div>.+$"
+This attribute accepts any valid regular expression. It should support nearly every regex option that the perl language supports. Do not use parentheses in this expression. It is intended to filter out unwanted content rather than matching a specific sequence of characters. For example, if you have linked to a html document and you know that the content you want to display is located in a div element with an id of "news_article" then you could use the example below to filter out everything before and after the div element. You will need to encode any xml entities (e.g., [&<>"]) and if your regex statement includes quotes I would recommend using \x22 for each quote instead of the `"` entity.
+Example: `"^.+?<div id=\x22news_article\x22>|</div>.+$"`
 
 ***

WikiPage document_item modified by kavulix

kavulix — Sun, 11 Nov 2012 02:17:57 -0000

--- v14
+++ v15
@@ -21,26 +21,70 @@
 
 Supported Attributes
 
-title
-sdposterurl
-hdposterurl
+Name: title
+Type: string
+Supported values
+any string of text
 
-shortdesc
+Name: sdposterurl
+Type: string
+Supported values
+any url pointing to a jpg, png or gif image
+
+Name: hdposterurl
+Type: string
+Supported values
+any url pointing to a jpg, png or gif image
+
+Name: shortdesc
+Type: string
+Supported values
+any string of text
 Notes
-The short description value will be displayed beneath the title and under the poster on poster screens. This attribute is only used if BOTH the author and date attributes are omitted.
+The short description value will be displayed beneath the title and under the poster on poster screens. This attribute is only used for documents if BOTH the author and date attributes are omitted.
 
-author
+Name: author
+Type: string
+Supported values
+the author's name
 Notes
-If you know the name of author who wrote the document then include the author's name in this attribute. The author's name will be displayed beneath the poster on poster screens and will be added to the beginning of the body of text on document screens. If you include an author or date attribute then they will be used instead of the shortdesc attribute. If the author AND date attributes are omitted then the shortdesc value will be displayed beneath the poster instead.
+If you know the name of the author who wrote the document then include the author's name in this attribute. The name will be displayed beneath the poster on poster screens and will be added to the beginning of the body of text on document screens. If either an author OR date attribute is specified then they will be used instead of the shortdesc attribute. If the author AND date attributes are omitted then the shortdesc value will be displayed instead.
 
-date
+Name: date
+Type: string
+Supported values
+any string of text
 Notes
-If you know the original publication date of the document then include the date in this attribute. The date will be displayed beneath the poster on poster screens and will be added to the beginning of the body of text on document screens. If you include an author or date attribute then they will be used instead of the shortdesc attribute. If the author AND date attributes are omitted then the shortdesc value will be displayed beneath the poster instead.
+If you know the original publication date of the document then include the date in this attribute. The date will be displayed beneath the poster on poster screens and will be added to the beginning of the body of text on document screens. There is no specific format required for the date string. If either an author OR date attribute is specified then they will be used instead of the shortdesc attribute. If the author AND date attributes are omitted then the shortdesc value will be displayed instead.
 
-url
-striphtml
-stripews
-regexfilter
+Name: url
+Type: string
+Supported values
+any url pointing to a text document
+Notes
+There are two ways to provide the content for document screens. The first option is to embed the text directly into the orml feed using the body element. The second option is to link to a remote text document. When the document item is selected the remote document will be downloaded and formatted according to the attributes below prior to being displayed.
+
+Name: striphtml
+Type: boolean
+Supported values
+true|false
+Notes
+If enabled all html tags will be removed from the text.
+
+Name: stripews
+Type: boolean
+Supported values
+true|false
+Notes
+If enabled all extra whitespace will be removed from the text. That includes spaces at the beginning or end of the file, more than one space back to back, or more than 2 new lines back to back.
+
+Name: regexfilter
+Type: string
+Supported values
+true|false
+Notes
+This attribute accepts any valid regular expression. It should support nearly every regex option that the perl language supports. Do not use parentheses in this expression. It is intended to filter out unwanted content rather than matching a specific sequence of characters. For example, if you have linked to a html document and you know that the content you want to display is located in a div element with an id of "news_article" then you could use the example below to filter out everything before and after the div element. You will need to encode any xml entities (e.g., [&<>"]) and if your regex statement includes quotes I would recommend using \x22 for each quote instead of "
+Example: "^.+?<div id=\x22news_article\x22>|</div>.+$"
 
 ***

WikiPage document_item modified by kavulix

kavulix — Fri, 09 Nov 2012 19:11:08 -0000

--- v13
+++ v14
@@ -1,9 +1,9 @@
-Item type: document
-Roku component: roParagraphScreen + roImageCanvas
+Item type: document
+Roku component: roParagraphScreen + roImageCanvas
 
 ***
 
-Example:
+Example
 
     Supported Attributes
+Supported Attributes
 
 title
 sdposterurl
 hdposterurl
 
 shortdesc
-Notes:
+Notes
 The short description value will be displayed beneath the title and under the poster on poster screens. This attribute is only used if BOTH the author and date attributes are omitted.
 
 author
-Notes:
+Notes
 If you know the name of author who wrote the document then include the author's name in this attribute. The author's name will be displayed beneath the poster on poster screens and will be added to the beginning of the body of text on document screens. If you include an author or date attribute then they will be used instead of the shortdesc attribute. If the author AND date attributes are omitted then the shortdesc value will be displayed beneath the poster instead.
 
 date
-Notes:
+Notes
 If you know the original publication date of the document then include the date in this attribute. The date will be displayed beneath the poster on poster screens and will be added to the beginning of the body of text on document screens. If you include an author or date attribute then they will be used instead of the shortdesc attribute. If the author AND date attributes are omitted then the shortdesc value will be displayed beneath the poster instead.
 
 url
@@ -44,7 +44,7 @@
 
 ***
 
-Supported Child Nodes
+Supported Child Nodes
 
 [description](https://sourceforge.net/p/openrokn/home/description_element/)

WikiPage document_item modified by kavulix

kavulix — Fri, 09 Nov 2012 06:42:11 -0000

WikiPage document_item modified by kavulix

kavulix — Fri, 09 Nov 2012 06:41:56 -0000

--- v11
+++ v12
@@ -1,76 +1,51 @@
-UNDER CONSTRUCTION
-
-[Home](https://sourceforge.net/p/openrokn/home/ORML/)

-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/)
+Item type: document
+Roku component: roParagraphScreen + roImageCanvas
 
 ***
 
-Item type: document
-Roku Component: roParagraphScreen
-Synonymous terms:
-document, document item, document screen, paragraph screen, roParagraphScreen
+Example:
 
-Below is a list of supported attributes for document items.
-
-Attribute: title
-Supported values:
-any string of text
-Description:
-The title will be displayed in the upper-right portion of the screen (the breadcrumb text) when the item is selected and as a bold header on document screens. Prior to being selected the title will be displayed beneath the poster on category screens.
-
-Attribute: author
-Supported values:
-any string of text representing the author's name
-Description:
-If you know the name of author who wrote the document then include the author's name in this attribute. The author's name will be displayed beneath the poster in category screens and will be added to the beginning of the body of text on document screens. If you include an author or date attribute then they will be used instead of the shortdesc attribute. If the author AND date attributes are omitted then the shortdesc value will be displayed beneath the poster instead.
-
-Attribute: date
-Supported values:
-any string of text representing the publication date
-Description:
-If you know the original publication date of the document then include the date in this attribute. The date will be displayed beneath the poster in category screens and will be added to the beginning of the body of text on document screens. If you include an author or date attribute then they will be used instead of the shortdesc attribute. If the author AND date attributes are omitted then the shortdesc value will be displayed beneath the poster instead.
-
-Attribute: shortdesc
-Supported values:
-any string of text
-Description:
-The short description value will be displayed beneath the title under the poster on category screens. This attribute is only used if BOTH the author and date attributes are omitted.
-
-Attribute: sdposterurl
-Supported values:
-a local or remote url pointing to an image of type gif, jpg or png
-Remote example: http://openrokn.sourceforge.net/images/sddocuments.png
-Local example: pkg:/images/sddocuments.png
-Description:
-The image that this url points to will be displayed as the poster art for this document on standard definition category screens.
-
-Attribute: hdposterurl
-Supported values:
-a local or remote url pointing to an image of type gif, jpg or png
-Remote example: http://openrokn.sourceforge.net/images/hddocuments.png
-Local example: pkg:/images/hddocuments.png
-Description:
-The image that this url points to will be displayed as the poster art for this document on high definition category screens.
+    
+       
+    This is the first line.
+    This is the second line.
+       
+    
 
 ***
 
-The <body> element
-The text contents of the document must be embedded in a body element that is a child node of the <item type="document"> element.
+Supported Attributes
 
-<item type="document">
- <body>
-This is line one.
-This is line two.
-This is line three.
- </body>
-</item>
+title
+sdposterurl
+hdposterurl
 
-All new lines are preserved in the text embedded within the body tag. When the text is displayed on the document screen it will be displayed with the same line breaks that exist in your xml feed.
+shortdesc
+Notes:
+The short description value will be displayed beneath the title and under the poster on poster screens. This attribute is only used if BOTH the author and date attributes are omitted.
 
-If you are using episodic category screens and display a document item on an episodic screen then a few lines of text will be extracted from the document body and used for the full description. The full description will appear beneath the title and author/date/shortdesc values on episodic category screens.
+author
+Notes:
+If you know the name of author who wrote the document then include the author's name in this attribute. The author's name will be displayed beneath the poster on poster screens and will be added to the beginning of the body of text on document screens. If you include an author or date attribute then they will be used instead of the shortdesc attribute. If the author AND date attributes are omitted then the shortdesc value will be displayed beneath the poster instead.
+
+date
+Notes:
+If you know the original publication date of the document then include the date in this attribute. The date will be displayed beneath the poster on poster screens and will be added to the beginning of the body of text on document screens. If you include an author or date attribute then they will be used instead of the shortdesc attribute. If the author AND date attributes are omitted then the shortdesc value will be displayed beneath the poster instead.
+
+url
+striphtml
+stripews
+regexfilter
+
+***
+
+Supported Child Nodes
+
+[description](https://sourceforge.net/p/openrokn/home/description_element/)
+
+[body](https://sourceforge.net/p/openrokn/home/body_element/)

WikiPage document_item modified by kavulix

kavulix — Thu, 08 Nov 2012 20:52:09 -0000

WikiPage document modified by kavulix

kavulix — Fri, 30 Mar 2012 23:43:31 -0000

--- v9 
+++ v10 
@@ -1,3 +1,5 @@
+UNDER CONSTRUCTION
+
 [Home](https://sourceforge.net/p/openrokn/home/ORML/)

 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/),

WikiPage document modified by kavulix

kavulix — Thu, 29 Mar 2012 06:34:45 -0000

--- v8 
+++ v9 
@@ -5,7 +5,7 @@
 [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 document modified by kavulix

kavulix — Thu, 29 Mar 2012 06:31:30 -0000

--- v7 
+++ v8 
@@ -1,10 +1,10 @@
 [Home](https://sourceforge.net/p/openrokn/home/ORML/)

-Item types: [category](https://sourceforge.net/p/openrokn/home/category/), 
+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/), 
-[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 document modified by kavulix

kavulix — Fri, 14 Oct 2011 04:44:49 -0000

--- v6 
+++ v7 
@@ -56,6 +56,8 @@
 Description:
 The image that this url points to will be displayed as the poster art for this document on high definition category screens.
 
+***
+
 The <body> element
 The text contents of the document must be embedded in a body element that is a child node of the <item type="document"> element.