Difference between revisions of "Netvision-ui.xml"

From MythTV Official Wiki
Jump to: navigation, search
(Finish MNV theming docs.)
Line 39: Line 39:
 
=== Generic Attributes Used in most windows ===
 
=== Generic Attributes Used in most windows ===
  
:The MythNetvision Browser, Gallery, and List views are unique as they share many/most attributes, most of which are entirely optionalThis allows the themer to show whichever information he or she likes across four different viewsThis is a list of attributes you can theme across all of the aforementioned windows.
+
</center>
 
+
{{Note box|
 +
The following widgets can be used in any of the MythNetvision views.  In addition, all textual elements can be combined however the themer likes using the <template> elementTo combine the title, year, and description into a single textarea, the theme author might use a template like:
 +
<pre><template>%TITLE% (%YEAR%) - %DESCRIPTION%</template></pre>
 +
}}
 +
<center>
 
{| cellpadding="4" border="1"
 
{| cellpadding="4" border="1"
 
| align="center"  |<b>Widget Name</b>  
 
| align="center"  |<b>Widget Name</b>  

Revision as of 03:42, 15 May 2010

The netvision-ui.xml file governs the layout and behavior of the MythNetvision plugin. It consists of the following windows and named attributes:

MythNetvision Plugin Windows

Window Name Type Description
netsearch Window The MythNetvision Internet Video Search screen.
rsseditpopup Window The Add/Edit RSS subscription window.
tree Window The List/Tree view site browse view.
gallery Window The Gallery site browse view.
browser Window The Browse site browse view.
treeeditor Window The Add/Edit RSS subscription window.
rsseditor Window The RSS subscription management window.

Generic Attributes Used in most windows

Important.png Note: The following widgets can be used in any of the MythNetvision views. In addition, all textual elements can be combined however the themer likes using the <template> element. To combine the title, year, and description into a single textarea, the theme author might use a template like:

<template>%TITLE% (%YEAR%) - %DESCRIPTION%</template>
Widget Name Widget Type Description Required?
title textarea The title of the selected item. N
description textarea The description/plot of the selected item. N
url textarea The URL to the <link> attribute of the selected item. N
thumbnail textarea The URL to the selected item's thumbnail. N
mediaurl textarea The URL to the <media:content> attribute of the selected item (usually the download link). N
author textarea The author of the selected item. N
date textarea The date of the selected item (format set by user's frontend preferences). N
time textarea The duration of the item in seconds. N
filesize textarea The filesize in bytes of the selected item. N
filesize_str textarea The "plain english" filesize of the selected item, in megabytes. N
rating textarea The user rating of the selected item. N
nosites textarea A textarea to appear when there are no sites/scripts present or set up. N
width textarea The pixel width of the selected item. N
height textarea The pixel height of the selected item. N
resolution textarea The resolution of the selected item (ie 640x480). N
countries textarea The countries in which the item is playable. N
season textarea The season number of the selected item. N
episode textarea The episode number of the selected item. N
s##e## textarea The season and episode number of the selected item in s00e00 format. N
##x## textarea The season and episode number of the selected item in 00x00 format. N


The "netsearch" window

Widget Name Widget Type Description Required?
sites buttontlist The buttonlist for all the configured search scripts. Features special textarea count for number of search results. Yes
results buttonlist A list of search results for the current search. Most of the above attributes such as title, author, etc. can be used in this buttonlist. Yes
search textedit A textedit to enter the search term. Yes
preview imagetype A preview image/thumbnail for the selected item. No
page textarea The page presently displayed in the search (ie, "Page 2/4"). No
downloadable statetype Whether or not the selected item is downloadable (Yes/No). State names are "yes" and "no". No

The "tree" window

Widget Name Widget Type Description Required?
videos buttontree A buttontree for all the browseable videos. Yes


The "gallery" window

Widget Name Widget Type Description Required?
videos buttonlist A buttonlist for all the browseable videos. Yes


The "browser" window

Widget Name Widget Type Description Required?
videos buttonlist A buttonlist for all the browseable videos. Yes


The "rsseditpopup" window

Widget Name Widget Type Description Required?
url textedit The text edit to change the site's URL. Yes
title textedit The text edit to change the site's title. Yes
description textedit The text edit to change the site's URL. Yes
author textedit The text edit to change the site's author. Yes
download checkbox The checkbox to enable automatic download of the site's content. Yes
ok button The OK button. Yes
cancel button The Cancel button. Yes
preview_browse button The button to browse the drive for preview images. Yes
preview imagetype A preview of the selected RSS image preview. Yes


The "rsseditor" window

Widget Name Widget Type Description Required?
sites buttonlist The currently subscribed RSS feeds. Yes
new button The New button. Yes
delete button The Delete button. Yes
edit button The Edit button. Yes
title textarea The title of the selected item. No
description textarea The description of the selected item. No
url textarea The URL of the selected item. No
author textarea The author of the selected item. No
preview imagetype A preview of the selected RSS image preview. No


The "treeeditor" window

Widget Name Widget Type Description Required?
grabbers buttonlist The grabbers detected and properly configured in the system. Yes