Difference between revisions of "News-ui.xml"
From MythTV Official Wiki
Iamlindoro (talk | contribs) |
m (Update required/optional items) |
||
(12 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
The news-ui.xml file governs the layout and behavior of the MythNews Plugin. It consists of the following windows and named attributes: | The news-ui.xml file governs the layout and behavior of the MythNews Plugin. It consists of the following windows and named attributes: | ||
− | = | + | = MythNews Windows = |
− | + | <center> | |
− | {| cellpadding="4" | + | {| cellpadding="4" border="1" |
− | | <b>Window Name</b> | + | | align="center" |<b>Window Name</b> |
− | | <b>Type</b> | + | | align="center" |<b>Type</b> |
− | | <b>Description</b> | + | | align="center" |<b>Description</b> |
|- | |- | ||
| style="background:silver" | news | | style="background:silver" | news | ||
Line 20: | Line 20: | ||
| style="background:silver" | The configuration screen. | | style="background:silver" | The configuration screen. | ||
|} | |} | ||
+ | |||
=== The "news" window === | === The "news" window === | ||
− | {| cellpadding="4" | + | {| cellpadding="4" border="1" |
− | | <b>Widget Name</b> | + | | align="center" |<b>Widget Name</b> |
− | | <b>Widget Type</b> | + | | align="center" |<b>Widget Type</b> |
− | | <b>Description</b> | + | | align="center" |<b>Description</b> |
− | | <b>Required?</b> | + | | align="center" |<b>Required?</b> |
|- | |- | ||
| style="background:darkturquoise" | siteslist | | style="background:darkturquoise" | siteslist | ||
Line 41: | Line 42: | ||
| style="background:darkturquoise" | nosites | | style="background:darkturquoise" | nosites | ||
| style="background:darkturquoise" align="center" | textarea | | style="background:darkturquoise" align="center" | textarea | ||
− | | style="background:darkturquoise" | The text area to appear | + | | style="background:darkturquoise" | The text area to appear when no sites are configured. |
− | | style="background:darkturquoise" align="center" | | + | | style="background:darkturquoise" align="center" | No |
|- | |- | ||
| title | | title | ||
| align="center" | textarea | | align="center" | textarea | ||
| The Title of the selected article. | | The Title of the selected article. | ||
− | | align="center" | | + | | align="center" | <b>Yes</b> |
|- | |- | ||
| style="background:darkturquoise" | description | | style="background:darkturquoise" | description | ||
| style="background:darkturquoise" align="center" | textarea | | style="background:darkturquoise" align="center" | textarea | ||
| style="background:darkturquoise" | The description of the selected article. | | style="background:darkturquoise" | The description of the selected article. | ||
− | | style="background:darkturquoise" align="center" | | + | | style="background:darkturquoise" align="center" | <b>Yes</b> |
|- | |- | ||
| updated | | updated | ||
| align="center" | textarea | | align="center" | textarea | ||
| The text area to appear if the feed has been updated. | | The text area to appear if the feed has been updated. | ||
− | | align="center" | | + | | align="center" | No |
|- | |- | ||
| style="background:darkturquoise" | thumbnail | | style="background:darkturquoise" | thumbnail | ||
| style="background:darkturquoise" align="center" | imagetype | | style="background:darkturquoise" align="center" | imagetype | ||
| style="background:darkturquoise" | The thumbnail image associated with an article. | | style="background:darkturquoise" | The thumbnail image associated with an article. | ||
− | | style="background:darkturquoise" align="center" | | + | | style="background:darkturquoise" align="center" | No |
|- | |- | ||
| enclosures | | enclosures | ||
| align="center" | imagetype | | align="center" | imagetype | ||
| Icon to indicate enclosures are present in the article. | | Icon to indicate enclosures are present in the article. | ||
− | | align="center" | | + | | align="center" | No |
|- | |- | ||
| style="background:darkturquoise" | download | | style="background:darkturquoise" | download | ||
| style="background:darkturquoise" align="center" | imagetype | | style="background:darkturquoise" align="center" | imagetype | ||
| style="background:darkturquoise" | Icon indicating the article requires a download. | | style="background:darkturquoise" | Icon indicating the article requires a download. | ||
− | | style="background:darkturquoise" align="center" | | + | | style="background:darkturquoise" align="center" | No |
|- | |- | ||
| ispodcast | | ispodcast | ||
| align="center" | imagetype | | align="center" | imagetype | ||
| Icon indicating the article is a podcast. | | Icon indicating the article is a podcast. | ||
− | | align="center" | | + | | align="center" | No |
|} | |} | ||
=== The "editor" window === | === The "editor" window === | ||
− | {| cellpadding="4" | + | {| cellpadding="4" border="1" |
− | | <b>Widget Name</b> | + | | align="center" |<b>Widget Name</b> |
− | | <b>Widget Type</b> | + | | align="center" |<b>Widget Type</b> |
− | | <b>Description</b> | + | | align="center" |<b>Description</b> |
− | | <b>Required?</b> | + | | align="center" |<b>Required?</b> |
+ | |- | ||
+ | | style="background:darkturquoise" | title | ||
+ | | style="background:darkturquoise" align="center" | textarea | ||
+ | | style="background:darkturquoise" | The title of the configuration page | ||
+ | | style="background:darkturquoise" align="center" | <b>Yes</b> | ||
+ | |- | ||
+ | | namelabel | ||
+ | | align="center" | textarea | ||
+ | | The "Name:" label. | ||
+ | | align="center" | <b>Yes</b> | ||
|- | |- | ||
| style="background:darkturquoise" | name | | style="background:darkturquoise" | name | ||
Line 93: | Line 104: | ||
| style="background:darkturquoise" align="center" | <b>Yes</b> | | style="background:darkturquoise" align="center" | <b>Yes</b> | ||
|- | |- | ||
− | | url | + | | urllabel |
− | | align="center" | + | | align="center" | textarea |
− | | The url of the item being edited. | + | | The "URL:" label. |
+ | | align="center" | <b>Yes</b> | ||
+ | |- | ||
+ | | style="background:darkturquoise" | url | ||
+ | | style="background:darkturquoise" align="center" | textedit | ||
+ | | style="background:darkturquoise" | The url of the item being edited. | ||
+ | | style="background:darkturquoise" align="center" | <b>Yes</b> | ||
+ | |- | ||
+ | | iconlabel | ||
+ | | align="center" | textarea | ||
+ | | The "Icon:" label. | ||
| align="center" | <b>Yes</b> | | align="center" | <b>Yes</b> | ||
|- | |- | ||
| style="background:darkturquoise" | icon | | style="background:darkturquoise" | icon | ||
| style="background:darkturquoise" align="center" | textedit | | style="background:darkturquoise" align="center" | textedit | ||
− | | style="background:darkturquoise" | The path and filename of the item | + | | style="background:darkturquoise" | The path and filename for the icon of the selected item. |
| style="background:darkturquoise" align="center" | <b>Yes</b> | | style="background:darkturquoise" align="center" | <b>Yes</b> | ||
|- | |- | ||
− | | | + | | podcastlabel |
− | | align="center" | | + | | align="center" | textarea |
− | | | + | | The "Is Podcast?" label. |
| align="center" | <b>Yes</b> | | align="center" | <b>Yes</b> | ||
|- | |- | ||
− | | style="background:darkturquoise" | | + | | style="background:darkturquoise" | podcast_check |
− | | style="background:darkturquoise" align="center" | | + | | style="background:darkturquoise" align="center" | checkbox |
− | | style="background:darkturquoise" | The | + | | style="background:darkturquoise" | The checkbox for whether the selected item is a podcast. |
| style="background:darkturquoise" align="center" | <b>Yes</b> | | style="background:darkturquoise" align="center" | <b>Yes</b> | ||
|- | |- | ||
− | | | + | | ok |
| align="center" | button | | align="center" | button | ||
− | | The "Cancel" button. | + | | The "OK" button. |
− | | align="center" | + | | align="center" | <b>Yes</b> |
+ | |- | ||
+ | | style="background:darkturquoise" | cancel | ||
+ | | style="background:darkturquoise" align="center" | button | ||
+ | | style="background:darkturquoise" | The "Cancel" button. | ||
+ | | style="background:darkturquoise" align="center" | <b>Yes</b> | ||
|} | |} | ||
Line 122: | Line 148: | ||
=== The "config" window === | === The "config" window === | ||
− | {| cellpadding="4" | + | {| cellpadding="4" border="1" |
− | | <b>Widget Name</b> | + | | align="center" |<b>Widget Name</b> |
− | | <b>Widget Type</b> | + | | align="center" |<b>Widget Type</b> |
− | | <b>Description</b> | + | | align="center" |<b>Description</b> |
− | | <b>Required?</b> | + | | align="center" |<b>Required?</b> |
|- | |- | ||
| style="background:darkturquoise" | category | | style="background:darkturquoise" | category | ||
Line 138: | Line 164: | ||
| align="center" | <b>Yes</b> | | align="center" | <b>Yes</b> | ||
|- | |- | ||
− | | style="background:darkturquoise" | | + | | style="background:darkturquoise" | help |
| style="background:darkturquoise" align="center" | textarea | | style="background:darkturquoise" align="center" | textarea | ||
− | | style="background:darkturquoise" | | + | | style="background:darkturquoise" | Help text for the category and sites items. |
| style="background:darkturquoise" align="center" | <b>Yes</b> | | style="background:darkturquoise" align="center" | <b>Yes</b> | ||
− | |||
− | |||
− | |||
− | |||
− | |||
|} | |} | ||
+ | |||
+ | [[Category:Developer_Documentation]] |
Latest revision as of 19:37, 11 February 2010
The news-ui.xml file governs the layout and behavior of the MythNews Plugin. It consists of the following windows and named attributes:
MythNews Windows
Window Name | Type | Description |
news | Window | The main MythNews screen. |
editor | Settings Screen | The "Edit Feed" Screen. |
config | Window | The configuration screen. |
The "news" window
Widget Name | Widget Type | Description | Required? |
siteslist | buttonlist | The button list of subscribed RSS feeds | Yes |
articleslist | buttonlist | The button list of articles from a given feed. | Yes |
nosites | textarea | The text area to appear when no sites are configured. | No |
title | textarea | The Title of the selected article. | Yes |
description | textarea | The description of the selected article. | Yes |
updated | textarea | The text area to appear if the feed has been updated. | No |
thumbnail | imagetype | The thumbnail image associated with an article. | No |
enclosures | imagetype | Icon to indicate enclosures are present in the article. | No |
download | imagetype | Icon indicating the article requires a download. | No |
ispodcast | imagetype | Icon indicating the article is a podcast. | No |
The "editor" window
Widget Name | Widget Type | Description | Required? |
title | textarea | The title of the configuration page | Yes |
namelabel | textarea | The "Name:" label. | Yes |
name | textedit | The name of the item being edited. | Yes |
urllabel | textarea | The "URL:" label. | Yes |
url | textedit | The url of the item being edited. | Yes |
iconlabel | textarea | The "Icon:" label. | Yes |
icon | textedit | The path and filename for the icon of the selected item. | Yes |
podcastlabel | textarea | The "Is Podcast?" label. | Yes |
podcast_check | checkbox | The checkbox for whether the selected item is a podcast. | Yes |
ok | button | The "OK" button. | Yes |
cancel | button | The "Cancel" button. | Yes |
The "config" window
Widget Name | Widget Type | Description | Required? |
category | buttonlist | The category of the feed. | Yes |
sites | buttonlist | The list of subscribed feeds. | Yes |
help | textarea | Help text for the category and sites items. | Yes |