summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorlordjaxom <lordjaxom>2005-01-20 21:22:13 +0000
committerlordjaxom <lordjaxom>2005-01-20 21:22:13 +0000
commit2cb731c609405ef995977c2a599e83ebdcf42e2c (patch)
tree0fe4c1b9671094d992b0708a62c309e27a50c043
parentaa68f63b6aa0e5126e56695bebd7b67b69145601 (diff)
downloadvdr-plugin-text2skin-2cb731c609405ef995977c2a599e83ebdcf42e2c.tar.gz
vdr-plugin-text2skin-2cb731c609405ef995977c2a599e83ebdcf42e2c.tar.bz2
- updated reference document
-rw-r--r--Docs/Reference.txt820
1 files changed, 547 insertions, 273 deletions
diff --git a/Docs/Reference.txt b/Docs/Reference.txt
index dbbe9eb..cc2ea2a 100644
--- a/Docs/Reference.txt
+++ b/Docs/Reference.txt
@@ -3,7 +3,7 @@ REFERENCE text2skin-skins
Thomas Wehrspann
17.12.2004
-Last update 02.01.2005
+Last update 20.01.2005
This is a short reference of the XML based skin-format of the
text2skin-plugin.
@@ -33,13 +33,19 @@ Table of Contents
2.4 Message Display
2.5 Replay Display
2.6 Menu Display
+2.7 Audio Tracks Display
3. Functions
3.1 not
3.2 and
3.3 or
3.4 equal
-3.5 file
-3.6 trans
+3.5 ne
+3.6 gt
+3.7 ge
+3.8 lt
+3.9 le
+3.10 file
+3.11 trans
4. Attributes
4.1 arc
4.2 color
@@ -53,14 +59,17 @@ This is the root element of the skins. All further elements go inside this
container.
-----------------------------------------------------------------------------
-| Attribute || Value || Description
+| Attribute | Value | Description
+=============================================================================
+| version | VERSION | Version of the skin-format (this is
+| | | fix value, currently "1.0")
-----------------------------------------------------------------------------
-| version || VERSION || Version of the skin-format (this is
- fix value, currently "1.0")
-| name || NAME || Name to display in the VDR-OSD
-| screenBase || "relative","absolute" || Should the skin be drawn "relative"
- to the VDR setup of "absolute" to
- the coordinates 720x576
+| name | NAME | Name to display in the VDR-OSD
+-----------------------------------------------------------------------------
+| screenBase | "relative","absolute" | Should the skin be drawn "relative"
+| | | (OSD left, top, width, height)
+| | | to the VDR setup or "absolute" to
+| | | an area of 720x576
-----------------------------------------------------------------------------
<?xml version="1.0"?>
@@ -76,15 +85,16 @@ container.
For each type of a OSD display a <display>-section is required.
-----------------------------------------------------------------------------
-| Attribute || Value || Description
------------------------------------------------------------------------------
-| id || * channelInfo || Type of the OSD display
- * channelSmall
- * volume
- * message
- * replayInfo
- * replaySmall
- * menu
+| Attribute | Value | Description
+=============================================================================
+| id | * channelInfo | Type of the OSD display
+| | * channelSmall |
+| | * volume |
+| | * message |
+| | * replayInfo |
+| | * replaySmall |
+| | * menu |
+| | * audioTracks |
-----------------------------------------------------------------------------
<?xml version="1.0"?>
@@ -102,13 +112,18 @@ For each type of a OSD display a <display>-section is required.
Each <display>-container has to start with a definition of drawing areas.
-----------------------------------------------------------------------------
-| Attribute || Value || Description
+| Attribute | Value | Description
+=============================================================================
+| x1 | NUMBER | Position of the left border
+-----------------------------------------------------------------------------
+| y1 | NUMBER | Position of the top border
-----------------------------------------------------------------------------
-| x1 || NUMBER || Position of the left border
-| y1 || NUMBER || Position of the top border
-| x2 || NUMBER || Position of the right border
-| y2 || NUMBER || Position of the bottom border
-| bpp || NUMBER || Color depth of the drawing area
+| x2 | NUMBER | Position of the right border
+-----------------------------------------------------------------------------
+| y2 | NUMBER | Position of the bottom border
+-----------------------------------------------------------------------------
+| bpp | NUMBER | Color depth of the drawing area
+| | | 4 = 16Farben, 8 = 256Farben
-----------------------------------------------------------------------------
<?xml version="1.0"?>
@@ -128,14 +143,19 @@ Each <display>-container has to start with a definition of drawing areas.
Draws a filled rectangle.
-----------------------------------------------------------------------------
-| Attribute || Value || Description
+| Attribute | Value | Description
+=============================================================================
+| x1 | NUMBER | Position of the left border
+-----------------------------------------------------------------------------
+| y1 | NUMBER | Position of the top border
-----------------------------------------------------------------------------
-| x1 || NUMBER || Position of the left border
-| y1 || NUMBER || Position of the top border
-| x2 || NUMBER || Position of the right border
-| y2 || NUMBER || Position of the bottom border
-| condition || FUNCTION/TOKEN || Complex condition
-| color || STRING || Color of the rectangle (see 4.2 color)
+| x2 | NUMBER | Position of the right border
+-----------------------------------------------------------------------------
+| y2 | NUMBER | Position of the bottom border
+-----------------------------------------------------------------------------
+| condition | FUNCTION/TOKEN | Complex condition
+-----------------------------------------------------------------------------
+| color | STRING | Color of the rectangle (see 4.2 color)
-----------------------------------------------------------------------------
<rectangle x1="20" x2="99" y1="-83" y2="-44" color="#00000000" />
@@ -146,15 +166,21 @@ Draws a filled rectangle.
Draws a circle, a pitch circle, or a ellipse.
-----------------------------------------------------------------------------
-| Attribute || Value || Description
+| Attribute | Value | Description
+=============================================================================
+| x1 | NUMBER | Position of the left border
+-----------------------------------------------------------------------------
+| y1 | NUMBER | Position of the top border
+-----------------------------------------------------------------------------
+| y2 | NUMBER | Position of the right border
+-----------------------------------------------------------------------------
+| x2 | NUMBER | Position of the bottom border
-----------------------------------------------------------------------------
-| x1 || NUMBER || Position of the left border
-| y1 || NUMBER || Position of the top border
-| y2 || NUMBER || Position of the right border
-| x2 || NUMBER || Position of the bottom border
-| condition || FUNCTION/TOKEN || Complex condition
-| color || STRING || Color (see 4.2 color)
-| arc || NUMBER || pitch circle (see 4.1 arc)
+| condition | FUNCTION/TOKEN | Complex condition
+-----------------------------------------------------------------------------
+| color | STRING | Color (see 4.2 color)
+-----------------------------------------------------------------------------
+| arc | NUMBER | pitch circle (see 4.1 arc)
-----------------------------------------------------------------------------
<ellipse x1="5" y1="7" x2="14" y2="15" color="GraphLight" condition="{IsMenuCurrent}"/>
@@ -165,15 +191,21 @@ Draws a circle, a pitch circle, or a ellipse.
Draws a curve.
-----------------------------------------------------------------------------
-| Attribute || Value || Description
+| Attribute | Value | Description
+=============================================================================
+| x1 | NUMBER | Position of the left border
+-----------------------------------------------------------------------------
+| y1 | NUMBER | Position of the top border
+-----------------------------------------------------------------------------
+| y2 | NUMBER | Position of the right border
+-----------------------------------------------------------------------------
+| x2 | NUMBER | Position of the bottom border
+-----------------------------------------------------------------------------
+| condition | FUNCTION/TOKEN | Complex condition
-----------------------------------------------------------------------------
-| x1 || NUMBER || Position of the left border
-| y1 || NUMBER || Position of the top border
-| y2 || NUMBER || Position of the right border
-| x2 || NUMBER || Position of the bottom border
-| condition || FUNCTION/TOKEN || Complex condition
-| color || STRING || Color (see 4.2 color)
-| arc || NUMBER || Direction (see 4.1 arc)
+| color | STRING | Color (see 4.2 color)
+-----------------------------------------------------------------------------
+| arc | NUMBER | Direction (see 4.1 arc)
-----------------------------------------------------------------------------
;-(
@@ -184,23 +216,34 @@ Draws a curve.
Display an image.
-----------------------------------------------------------------------------
-| Attribute || Value || Description
+| Attribute | Value | Description
+=============================================================================
+| x | NUMBER | Position of the left border (no scaling)
+-----------------------------------------------------------------------------
+| y | NUMBER | Position of the top border (no scaling)
+-----------------------------------------------------------------------------
+| x1 | NUMBER | Position of the left border (with scaling)
+-----------------------------------------------------------------------------
+| y1 | NUMBER | Position of the top border (with scaling)
+-----------------------------------------------------------------------------
+| x2 | NUMBER | Position of the right border (with scaling)
+-----------------------------------------------------------------------------
+| y2 | NUMBER | Position of the bottom border (with scaling)
-----------------------------------------------------------------------------
-| x || NUMBER || Position of the left border (no scaling)
-| y || NUMBER || Position of the top border (no scaling)
-| x1 || NUMBER || Position of the left border (with scaling)
-| y1 || NUMBER || Position of the top border (with scaling)
-| x2 || NUMBER || Position of the right border (with scaling)
-| y2 || NUMBER || Position of the bottom border (with scaling)
-| condition || FUNCTION/TOKEN || Complex condition
-| alpha || NUMBER || Blended transparency (0-255) (see 4.2 color)
-| colors || NUMBER || Maximum amount of colors in the scaled image
- (if scaling should be applied)
-| color || STRING || replacement color for color 1 of the image
- (see 4.2 color)
-| bgColor || STRING || replacement color for color 0 of the image
- (see 4.2 color)
-| path || STRING/TOKEN || Image file
+| condition | FUNCTION/TOKEN | Complex condition
+-----------------------------------------------------------------------------
+| alpha | NUMBER | Blended transparency (0-255) (see 4.2 color)
+-----------------------------------------------------------------------------
+| colors | NUMBER | Maximum amount of colors in the scaled image
+| | | (if scaling should be applied)
+-----------------------------------------------------------------------------
+| color | STRING | replacement color for color 1 of the image
+| | | (see 4.2 color)
+-----------------------------------------------------------------------------
+| bgColor | STRING | replacement color for color 0 of the image
+| | | (see 4.2 color)
+-----------------------------------------------------------------------------
+| path | STRING/TOKEN | Image file
-----------------------------------------------------------------------------
<image x="0" y="-70" path="Aluminium_volumebar.png" />
@@ -212,18 +255,25 @@ Display an image.
A static or compound text.
-----------------------------------------------------------------------------
-| Attribute || Value || Description
+| Attribute | Value | Description
+=============================================================================
+| x1 | NUMBER | Position of the left border
+-----------------------------------------------------------------------------
+| y1 | NUMBER | Position of the top border
-----------------------------------------------------------------------------
-| x1 || NUMBER || Position of the left border
-| y1 || NUMBER || Position of the top border
-| y2 || NUMBER || Position of the right border
-| x2 || NUMBER || Position of the bottom border
-| condition || FUNCTION/TOKEN || Complex condition
-| color || STRING || Text color (see 4.2 color)
-| align || * center || Alignment of the text
- * right
- * left
-| font || STRING || Font name (see 4.3 font)
+| y2 | NUMBER | Position of the right border
+-----------------------------------------------------------------------------
+| x2 | NUMBER | Position of the bottom border
+-----------------------------------------------------------------------------
+| condition | FUNCTION/TOKEN | Complex condition
+-----------------------------------------------------------------------------
+| color | STRING | Text color (see 4.2 color)
+-----------------------------------------------------------------------------
+| align | * center | Alignment of the text
+| | * right |
+| | * left |
+-----------------------------------------------------------------------------
+| font | STRING | Font name (see 4.3 font)
-----------------------------------------------------------------------------
<text x1="42" x2="571" y1="-113" y2="-86" color="#FF000000" font="Osd">{ReplayTitle}</text>
@@ -234,19 +284,27 @@ A static or compound text.
An alternative to <text> for legth texts
-----------------------------------------------------------------------------
-| Attribute || Value || Description
+| Attribute | Value | Description
+=============================================================================
+| x1 | NUMBER | Position of the left border
+-----------------------------------------------------------------------------
+| y1 | NUMBER | Position of the top border
-----------------------------------------------------------------------------
-| x1 || NUMBER || Position of the left border
-| y1 || NUMBER || Position of the top border
-| y2 || NUMBER || Position of the right border
-| x2 || NUMBER || Position of the bottom border
-| condition || FUNCTION/TOKEN || Complex condition
-| color || STRING || Text color (see 4.2 color)
-| delay || NUMBER || Scroll rate (in ms)
-| align || * center || Alignment of the text
- * right
- * left
-| font || STRING || Font name (see 4.3 font)
+| y2 | NUMBER | Position of the right border
+-----------------------------------------------------------------------------
+| x2 | NUMBER | Position of the bottom border
+-----------------------------------------------------------------------------
+| condition | FUNCTION/TOKEN | Complex condition
+-----------------------------------------------------------------------------
+| color | STRING | Text color (see 4.2 color)
+-----------------------------------------------------------------------------
+| delay | NUMBER | Scroll rate (in ms)
+-----------------------------------------------------------------------------
+| align | * center | Alignment of the text
+| | * right |
+| | * left |
+-----------------------------------------------------------------------------
+| font | STRING | Font name (see 4.3 font)
-----------------------------------------------------------------------------
<marquee x1="130" x2="480" y1="423" y2="445" color="Text" font="Sml">{ReplayTitle}</marquee>;
@@ -256,23 +314,35 @@ An alternative to <text> for legth texts
An alternative to <text> for legth texts
-----------------------------------------------------------------------------
-| Attribute || Value || Description
+| Attribute | Value | Description
+=============================================================================
+| x1 | NUMBER | Position of the left border
+-----------------------------------------------------------------------------
+| y1 | NUMBER | Position of the top border
+-----------------------------------------------------------------------------
+| y2 | NUMBER | Position of the right border
+-----------------------------------------------------------------------------
+| x2 | NUMBER | Position of the bottom border
+-----------------------------------------------------------------------------
+| condition | FUNCTION/TOKEN | Complex condition
+-----------------------------------------------------------------------------
+| color | STRING | Text color (see 4.2 color)
+-----------------------------------------------------------------------------
+| blinkColor | STRING | Highlight color (see 4.2 color)
+| | | (Optional: On/Off otherwise)
-----------------------------------------------------------------------------
-| x1 || NUMBER || Position of the left border
-| y1 || NUMBER || Position of the top border
-| y2 || NUMBER || Position of the right border
-| x2 || NUMBER || Position of the bottom border
-| condition || FUNCTION/TOKEN || Complex condition
-| color || STRING || Text color (see 4.2 color)
-| blinkColor || STRING || Highlight color (see 4.2 color)
-| delay || NUMBER || Delay between switches
-| align || * center || Alignment of the text
- * right
- * left
-| font || STRING || Font name (see 4.3 font)
+| delay | NUMBER | Delay between switches
+-----------------------------------------------------------------------------
+| align | * center | Alignment of the text
+| | * right |
+| | * left |
+-----------------------------------------------------------------------------
+| font | STRING | Font name (see 4.3 font)
-----------------------------------------------------------------------------
- ;-(
+ <blink x1="30" x2="80" y1="90" y2="80" color="Text" blinkColor="Green" delay="800" font="Sml" condition="{IsRunning}">
+ {PresentStartDateTime:%H\:%M}
+ </blink>;
1.11 <scrolltext>
@@ -280,18 +350,25 @@ An alternative to <text> for legth texts
A multiline text.
-----------------------------------------------------------------------------
-| Attribute || Value || Description
+| Attribute | Value | Description
+=============================================================================
+| x1 | NUMBER | Position of the left border
+-----------------------------------------------------------------------------
+| y1 | NUMBER | Position of the top border
+-----------------------------------------------------------------------------
+| y2 | NUMBER | Position of the right border
+-----------------------------------------------------------------------------
+| x2 | NUMBER | Position of the bottom border
-----------------------------------------------------------------------------
-| x1 || NUMBER || Position of the left border
-| y1 || NUMBER || Position of the top border
-| y2 || NUMBER || Position of the right border
-| x2 || NUMBER || Position of the bottom border
-| condition || FUNCTION/TOKEN || Complex condition
-| color || STRING || Text color (see 4.2 color)
-| align || * center || Alignment of the text
- * right
- * left
-| font || STRING || Font name (see 4.3 font)
+| condition | FUNCTION/TOKEN | Complex condition
+-----------------------------------------------------------------------------
+| color | STRING | Text color (see 4.2 color)
+-----------------------------------------------------------------------------
+| align | * center | Alignment of the text
+| | * right |
+| | * left |
+-----------------------------------------------------------------------------
+| font | STRING | Font name (see 4.3 font)
-----------------------------------------------------------------------------
<scrolltext x1="24" y1="138" y2="-72" x2="583" font="helmetr.ttf:20" color="#AFFFFF00">
@@ -305,15 +382,21 @@ A multiline text.
A scrollbar.
-----------------------------------------------------------------------------
-| Attribute || Value || Description
+| Attribute | Value | Description
+=============================================================================
+| x1 | NUMBER | Position of the left border
+-----------------------------------------------------------------------------
+| y1 | NUMBER | Position of the top border
+-----------------------------------------------------------------------------
+| y2 | NUMBER | Position of the right border
+-----------------------------------------------------------------------------
+| x2 | NUMBER | Position of the bottom border
-----------------------------------------------------------------------------
-| x1 || NUMBER || Position of the left border
-| y1 || NUMBER || Position of the top border
-| y2 || NUMBER || Position of the right border
-| x2 || NUMBER || Position of the bottom border
-| condition || FUNCTION/TOKEN || Complex condition
-| color || STRING || Color of the bar (see 4.2 color)
-| bgColor || STRING || Color of the background (see 4.2 color)
+| condition | FUNCTION/TOKEN | Complex condition
+-----------------------------------------------------------------------------
+| color | STRING | Color of the bar (see 4.2 color)
+-----------------------------------------------------------------------------
+| bgColor | STRING | Color of the background (see 4.2 color)
-----------------------------------------------------------------------------
<scrollbar x1="585" x2="608" y1="162" y2="-110" color="#AFFFFF00" bgColor="#8F2B1B9E" />
@@ -324,21 +407,32 @@ A scrollbar.
A progressbar.
-----------------------------------------------------------------------------
-| Attribute || Value || Description
+| Attribute | Value | Description
+=============================================================================
+| x1 | NUMBER | Position of the left border
+-----------------------------------------------------------------------------
+| y1 | NUMBER | Position of the top border
+-----------------------------------------------------------------------------
+| y2 | NUMBER | Position of the right border
+-----------------------------------------------------------------------------
+| x2 | NUMBER | Position of the bottom border
+-----------------------------------------------------------------------------
+| condition | FUNCTION/TOKEN | Complex condition
+-----------------------------------------------------------------------------
+| color | STRING | Color of the bar (see 4.2 color)
+-----------------------------------------------------------------------------
+| bgColor | STRING | Color of the background (see 4.2 color)
+-----------------------------------------------------------------------------
+| mark | STRING | Color of the cutting marks (see 4.2 color)
+-----------------------------------------------------------------------------
+| active | STRING | Color of the active area (see 4.2 color)
+-----------------------------------------------------------------------------
+| keep | STRING | Color of the video area that should be
+| | | kept (see 4.2 color)
+-----------------------------------------------------------------------------
+| current | ZAHL/TOKEN | Current index value
-----------------------------------------------------------------------------
-| x1 || NUMBER || Position of the left border
-| y1 || NUMBER || Position of the top border
-| y2 || NUMBER || Position of the right border
-| x2 || NUMBER || Position of the bottom border
-| condition || FUNCTION/TOKEN || Complex condition
-| color || STRING || Color of the bar (see 4.2 color)
-| bgColor || STRING || Color of the background (see 4.2 color)
-| mark || STRING || Color of the cutting marks (see 4.2 color)
-| active || STRING || Color of the active area (see 4.2 color)
-| keep || STRING || Color of the video area that should be
- kept (see 4.2 color)
-| current || ZAHL/TOKEN || Current index value
-| total || ZAHL/TOKEN || Maximum index value
+| total | ZAHL/TOKEN | Maximum index value
-----------------------------------------------------------------------------
<progress x1="19" x2="556" y1="-17" y2="-7" color="#AF000000" current="{VolumeCurrent}" total="{VolumeTotal}" />
@@ -346,12 +440,12 @@ A progressbar.
1.14 <block>
------------
-A '''<block></block>''' pools several objects together. (No recursion)
+A '''<block></block>''' pools several objects together.
-----------------------------------------------------------------------------
-| Attribute || Value || Description
------------------------------------------------------------------------------
-| condition || FUNCTION || Complex condition
+| Attribute | Value | Description
+=============================================================================
+| condition | FUNCTION | Complex condition
-----------------------------------------------------------------------------
<block condition="file('logos/{ChannelName}.mng')">
@@ -365,14 +459,18 @@ A '''<block></block>''' pools several objects together. (No recursion)
Defines a list in the menu.
-----------------------------------------------------------------------------
-| Attribute || Value || Description
+| Attribute | Value | Description
+=============================================================================
+| x1 | NUMBER | Position of the left border
+-----------------------------------------------------------------------------
+| y1 | NUMBER | Position of the top border
+-----------------------------------------------------------------------------
+| y2 | NUMBER | Position of the right border
-----------------------------------------------------------------------------
-| x1 || NUMBER || Position of the left border
-| y1 || NUMBER || Position of the top border
-| y2 || NUMBER || Position of the right border
-| x2 || NUMBER || Position of the bottom border
-| condition || FUNCTION/TOKEN || Complex condition (possible, but makes
- little sense)
+| x2 | NUMBER | Position of the bottom border
+-----------------------------------------------------------------------------
+| condition | FUNCTION/TOKEN | Complex condition (possible, but makes
+| | | little sense)
-----------------------------------------------------------------------------
<list x1="24" y1="62" x2="569" y2="-82">
@@ -390,11 +488,12 @@ Defines a list in the menu.
Defines an item for the list.
-----------------------------------------------------------------------------
-| Attribute || Value || Description
+| Attribute | Value | Description
+=============================================================================
+| condition | FUNCTION/TOKEN | Complex condition (possible, but makes
+| | | little sense)
-----------------------------------------------------------------------------
-| condition || FUNCTION/TOKEN || Complex condition (possible, but makes
- little sense)
-| height || NUMBER || Height of one list item
+| height | NUMBER | Height of one list item
-----------------------------------------------------------------------------
<list x1="24" y1="62" x2="569" y2="-82">
@@ -412,149 +511,289 @@ Defines an item for the list.
2.1 Common
----------
-----------------------------------------------------------------------------
-| Token || Comment || Description
+| Token | Comment | Description
+=============================================================================
+| DateTime | (s.h. "man strftime") | Current date/time
+-----------------------------------------------------------------------------
+| IsRecording | | True, if VDR is currently recording
+-----------------------------------------------------------------------------
+| CurrentRecording | | delivers every 2 secs all actual recordings
+| | | Attribute: Number to choose n-th current recording
-----------------------------------------------------------------------------
-| DateTime || (s.h. "man strftime") || Current date/time
+| FreeDiskSpace | | Remaining free disk space in MB
+| | | Attribute: return as formatted time.
-----------------------------------------------------------------------------
2.2 Channel Display
-------------------
-----------------------------------------------------------------------------
-| Token || Comment || Description
------------------------------------------------------------------------------
-| ChannelNumber || || Channel number ("channel number-" on ongoing input
-| ChannelName || || Channel- or group name
-| ChannelShortName || || Short name of channel if available
-| ChannelBouquet || || Provider-/bouquet name if available
-| ChannelPortal || || Portal name if available
-| ChannelSource || || Signal source (e.g. "S19.2E")
-| PresentStartDateTime || (also in Menu Display) || Start time of current title
-| PresentVPSDateTime || (also in Menu Display) || VPS start time of current title if available
-| PresentEndDateTime || (also in Menu Display) || End time of current title
-| PresentDuration || (also in Menu Display) || Duration of current title
-| PresentProgress || (also in Menu Display) || Elapsed time of current title
-| PresentRemaining || (also in Menu Display) || Remaining time of current title
-| PresentTitle || (also in Menu Display) || Title/Heading of current title
-| PresentShortText || (also in Menu Display) || Short text/episode of current title
-| PresentDescription || (also in Menu Display) || Description of current title
-| FollowingStartDateTime || || Start time of following title
-| FollowingVPSDateTime || || VPS start time of following title if available
-| FollowingEndDateTime || || End time of following title
-| FollowingDuration || || Duration of following title
-| FollowingTitle || || Title/Heading of following title
-| FollowingShortText || || Short text/episode of following title
-| FollowingDescription || || Description of following title
-| ButtonRed || (also in Menu Display || Caption of red button if available
- and Replay Display)
-| ButtonGreen || (also in Menu Display || Caption of green button if available
- and Replay Display)
-| ButtonYellow || (also in Menu Display || Caption of yellow button if available
- and Replay Display)
-| ButtonBlue || (also in Menu Display || Caption of blue button if available
- and Replay Display)
-| Language || || Language (currently only "Audio 1", "Audio 2" or "Digital Audio")
-| HasTeletext || || True, if video text is available
-| HasMultilang || || True, if if several sound tracks are available
-| HasDolby || || True, if digital multi-channel sound is available
-| IsEncrypted || || True, if the broadcast is encrypted
-| IsRadio || || True, if the broadcast is a radio channel
-| IsRecording || || True, if a recording is running
-| HasVPS || (also in Menu Display) || True, if VPS is available
-| HasTimer || (also in Menu Display) || True, if a timer for the current title is set
-| IsRunning || (also in Menu Display) || True, if the current title has the state "running"
-| CurrentRecording || (in every Display) || Provides every currently running recording in a 2 second cycle
+| Token | Comment | Description
+=============================================================================
+| ChannelNumber | | Channel number ("channel number-" on ongoing input
+-----------------------------------------------------------------------------
+| ChannelName | | Channel- or group name
+-----------------------------------------------------------------------------
+| ChannelShortName | | Short name of channel if available
+-----------------------------------------------------------------------------
+| ChannelBouquet | | Provider-/bouquet name if available
+-----------------------------------------------------------------------------
+| ChannelPortal | | Portal name if available
+-----------------------------------------------------------------------------
+| ChannelSource | | Signal source (e.g. "S19.2E")
+-----------------------------------------------------------------------------
+| PresentStartDateTime | (also in Menu Display) | Start time of current title
+-----------------------------------------------------------------------------
+| PresentVPSDateTime | (also in Menu Display) | VPS start time of current title if available
+-----------------------------------------------------------------------------
+| PresentEndDateTime | (also in Menu Display) | End time of current title
+-----------------------------------------------------------------------------
+| PresentDuration | (also in Menu Display) | Duration of current title
+-----------------------------------------------------------------------------
+| PresentProgress | (also in Menu Display) | Elapsed time of current title
+-----------------------------------------------------------------------------
+| PresentRemaining | (also in Menu Display) | Remaining time of current title
+-----------------------------------------------------------------------------
+| PresentTitle | (also in Menu Display) | Title/Heading of current title
+-----------------------------------------------------------------------------
+| PresentShortText | (also in Menu Display) | Short text/episode of current title
+-----------------------------------------------------------------------------
+| PresentDescription | (also in Menu Display) | Description of current title
+-----------------------------------------------------------------------------
+| PresentHasTimer | (auch in Menu Display) | True, if a timer for the following title is set
+-----------------------------------------------------------------------------
+| PresentIsRunning | (also in Menu Display) | True, if the following title has the state "running"
+-----------------------------------------------------------------------------
+| PresentHasVPS | (also in Menu Display) | True, if VPS for the following title is available
+-----------------------------------------------------------------------------
+| FollowingStartDateTime | | Start time of following title
+-----------------------------------------------------------------------------
+| FollowingVPSDateTime | | VPS start time of following title if available
+-----------------------------------------------------------------------------
+| FollowingEndDateTime | | End time of following title
+-----------------------------------------------------------------------------
+| FollowingDuration | | Duration of following title
+-----------------------------------------------------------------------------
+| FollowingTitle | | Title/Heading of following title
+-----------------------------------------------------------------------------
+| FollowingShortText | | Short text/episode of following title
+-----------------------------------------------------------------------------
+| FollowingDescription | | Description of following title
+-----------------------------------------------------------------------------
+| FollowingHasTimer | | True, if the following title is targeted by a timer
+-----------------------------------------------------------------------------
+| FollowingIsRunning | | True, if the following title has the status "running"
+-----------------------------------------------------------------------------
+| FollowingHasVPS | | True, if the following title has it's own VPS-time
+-----------------------------------------------------------------------------
+| ButtonRed | (also in Menu Display | Caption of red button if available
+| | and Replay Display) |
+-----------------------------------------------------------------------------
+| ButtonGreen | (also in Menu Display | Caption of green button if available
+| | and Replay Display) |
+-----------------------------------------------------------------------------
+| ButtonYellow | (also in Menu Display | Caption of yellow button if available
+| | and Replay Display) |
+-----------------------------------------------------------------------------
+| ButtonBlue | (also in Menu Display | Caption of blue button if available
+| | and Replay Display) |
+-----------------------------------------------------------------------------
+| Language | | Language (currently only "Audio 1", "Audio 2" or "Digital Audio")
+-----------------------------------------------------------------------------
+| ChannelHasTeletext | | True, if video text is available
+| (alt: HasTeletext) | |
+-----------------------------------------------------------------------------
+| ChannelHasMultilang | | True, if if several sound tracks are available
+| (alt: HasMultilang) | |
+-----------------------------------------------------------------------------
+| ChannelHasDolby | | True, if digital multi-channel sound is available
+| (alt: HasDolby) | |
+-----------------------------------------------------------------------------
+| ChannelIsEncrypted | | True, if the channel is encrypted
+| (alt: IsEncrypted) | |
+-----------------------------------------------------------------------------
+| ChannelIsRadio | | True, if the channel is a radio channel
+| (alt: IsRadio) | |
+-----------------------------------------------------------------------------
+| ChannelHasVPS | | True, if the channel can broadcast VPS
+| (alt: HasVPS) | |
-----------------------------------------------------------------------------
2.3 Volume Display
------------------
-----------------------------------------------------------------------------
-| Token || Comment || Description
+| Token | Comment | Description
+=============================================================================
+| VolumeCurrent | | Current volume (0-VolumeTotal) (numeric)
+-----------------------------------------------------------------------------
+| VolumeTotal | | Maximum value for volume
-----------------------------------------------------------------------------
-| VolumeCurrent || || Current volume (0-VolumeTotal) (numeric)
-| VolumeTotal || || Maximum value for volume
-| IsMute || || True, if volume is muted
+| VolumeIsMute | | True, if volume is muted
+| (alt: IsMute) | |
-----------------------------------------------------------------------------
2.4 Message Display
-------------------
-----------------------------------------------------------------------------
-| Token || Comment || Description
+| Token | Comment | Description
+=============================================================================
+| Message | (in every Display) | Text of the current message if available (whatever type)
+-----------------------------------------------------------------------------
+| MessageStatus | (in every Display) | Text of the current message if available (status message)
+-----------------------------------------------------------------------------
+| MessageInfo | (in every Display) | Text of the current message if available (information)
+-----------------------------------------------------------------------------
+| MessageWarning | (in every Display) | Text of the current message if available (warning)
-----------------------------------------------------------------------------
-| Message || (in every Display) || Text of the current message if available (whatever type)
-| MessageStatus || (in every Display) || Text of the current message if available (status message)
-| MessageInfo || (in every Display) || Text of the current message if available (information)
-| MessageWarning || (in every Display) || Text of the current message if available (warning)
-| MessageError || (in every Display) || Text of the current message if available (error)
+| MessageError | (in every Display) | Text of the current message if available (error)
-----------------------------------------------------------------------------
2.5 Replay Display
------------------
-----------------------------------------------------------------------------
-| Token || Comment || Description
------------------------------------------------------------------------------
-| ReplayTitle || || Title of the current replay
-| ReplayPositionIndex || || Position in the current replay (numeric, analog to PresentProgress)
-| ReplayDurationIndex || || Duration of the current replay (numeric, analog to PresentDuration)
-| ReplayRemaining || || Remaining time of the current replay to elapse (numeric, analog to PresentRemaining)
-| ReplayPrompt || || Prompt if available (e.g. "Jump: --:--")
-| IsPlaying || || True, if a replay is runnning
-| IsFastForward || || True, if fast forward
-| IsFastRewind || || True, if fase rewind
-| IsSlowForward || || True, if slow forward
-| IsSlowRewind || || True, if slow rewind
-| IsPausing || || True, if replay is pausing
-| ReplayPosition || || Position in the replay, completely formatted, with frames at cutting marks, otherwise without frames
-| ReplayDuration || || Duration of the replay, completely formatted
-| ReplayMode || || Type of the replay (e.g. "dvd", "vcd", "normal",...)
-| ButtonRed || (also in Menu Display || Caption of red button if available
- and Channel Display)
-| ButtonGreen || (also in Menu Display || Caption of green button if available
- and Channel Display)
-| ButtonYellow || (also in Menu Display || Caption of yellow button if available
- and ReChannel Display)
-| ButtonBlue || (also in Menu Display || Caption of blue button if available
- and Channel Display)
+| Token | Comment | Description
+=============================================================================
+| ReplayTitle | Attribut: clean | Title of the current replay
+-----------------------------------------------------------------------------
+| ReplayPositionIndex | | Position in the current replay
+| | | (numeric, analog to PresentProgress)
+-----------------------------------------------------------------------------
+| ReplayDurationIndex | | Duration of the current replay
+| | | (numeric, analog to PresentDuration)
+-----------------------------------------------------------------------------
+| ReplayRemaining | | Remaining time of the current replay to elapse
+| | | (numeric, analog to PresentRemaining)
+-----------------------------------------------------------------------------
+| ReplayPrompt | | Prompt if available (e.g. "Jump: --:--")
+-----------------------------------------------------------------------------
+| ReplayIsPlaying | Attribut: 0=no Multispeed,| True, if a replay is runnning
+| (alt: IsPlaying) | 1-3 = Multispeed, |
+| | keines = egal |
+-----------------------------------------------------------------------------
+| ReplayIsFastForward | Attribut: 0=no Multispeed,| True, if fast forward
+| (alt: IsFastForward) | 1-3 = Multispeed, |
+| | keines = egal |
+-----------------------------------------------------------------------------
+| ReplayIsFastRewind | Attribut: 0=no Multispeed,| True, if fase rewind
+| (alt: IsFastRewind) | 1-3 = Multispeed, |
+| | keines = egal |
+-----------------------------------------------------------------------------
+| ReplayIsSlowForward | Attribut: 0=no Multispeed,| True, if slow forward
+| (alt: IsSlowForward) | 1-3 = Multispeed, |
+| | keines = egal |
+-----------------------------------------------------------------------------
+| ReplayIsSlowRewind | Attribut: 0=no Multispeed,| True, if slow rewind
+| (alt: IsSlowRewind) | 1-3 = Multispeed, |
+| | keines = egal |
+-----------------------------------------------------------------------------
+| ReplayIsPausing | Attribut: 0=no Multispeed,| True, if replay is pausing
+| (alt: IsPausing) | 1-3 = Multispeed, |
+| | keines = egal |
+-----------------------------------------------------------------------------
+| ReplayPosition | | Position in the replay, completely formatted,
+| | | with frames at cutting marks, otherwise without frames
+-----------------------------------------------------------------------------
+| ReplayDuration | | Duration of the replay, completely formatted
+-----------------------------------------------------------------------------
+| ReplayMode | | Type of the replay (e.g. "dvd", "vcd", "normal",...)
+-----------------------------------------------------------------------------
+| ButtonRed | (also in Menu Display | Caption of red button if available
+| | and Channel Display) |
+-----------------------------------------------------------------------------
+| ButtonGreen | (also in Menu Display | Caption of green button if available
+| | and Channel Display) |
+-----------------------------------------------------------------------------
+| ButtonYellow | (also in Menu Display | Caption of yellow button if available
+| | and ReChannel Display) |
+-----------------------------------------------------------------------------
+| ButtonBlue | (also in Menu Display | Caption of blue button if available
+| | and Channel Display) |
+-----------------------------------------------------------------------------
+| ReplayIsShuffle | | True, if the replay is in shuffle mode (only MP3)
+-----------------------------------------------------------------------------
+| ReplayIsLoop | | True, if the replay is in loop mode (only MP3)
-----------------------------------------------------------------------------
2.6 Menu Display
----------------
-----------------------------------------------------------------------------
-| Token || Comment || Description
------------------------------------------------------------------------------
-| MenuTitle || Attribute: "clean" || Title of the menu page, or filtered title with "clean"
-| MenuGroup || || Text of the current list item if it is a group/delimiter
-| IsMenuGroup || || True, if currently drawn list item is a group/delimiter
-| MenuItem || || Text of the current list item if it is a normal entry
-| IsMenuItem || || True, if currently drawn list item is a normal entry
-| MenuCurrent || Atrribute: "clean" || Text of the current list item if it is the selected entry
-| IsMenuCurrent || || True, if currently drawn list item is a currently selected one
-| MenuText || Attribute: "clean" || Text page to display instead of the list (e.g. display in the command menu)
-| ButtonRed || (also in Channel Display || Caption of red button if available
- and Replay Display)
-| ButtonGreen || (also in Channel Display || Caption of green button if available
- and Replay Display)
-| ButtonYellow || (also in Channel Display || Caption of yellow button if available
- and Replay Display)
-| ButtonBlue || (also in Channel Display || Caption of blue button if available
- and Replay Display)
-| CanScrollUp || || True, if a scroll-text can be scrolled upward
-| CanScrollDown || || True, if a scroll-text can be scrolled downward
-| PresentStartDateTime || (also in Channel Display) ||
-| PresentVPSDateTime || (also in Channel Display) ||
-| PresentEndDateTime || (also in Channel Display) ||
-| PresentDuration || (also in Channel Display) ||
-| PresentProgress || (also in Channel Display) ||
-| PresentTitle || (also in Channel Display) ||
-| PresentShortText || (also in Channel Display) ||
-| PresentDescription || (also in Channel Display) ||
-| HasVPS || (also in Channel Display) ||
-| HasTimer || (also in Channel Display) ||
-| IsRunning || (also in Channel Display) ||
+| Token | Comment | Description
+=============================================================================
+| MenuTitle | Attribute: "clean", "rest"| Title of the menu page, or filtered title with "clean"
+| | | or rest of the filtered title
+-----------------------------------------------------------------------------
+| MenuGroup | | Text of the current list item if it is a group/delimiter
+-----------------------------------------------------------------------------
+| IsMenuGroup | | True, if currently drawn list item is a group/delimiter
+-----------------------------------------------------------------------------
+| MenuItem | | Text of the current list item if it is a normal entry
+-----------------------------------------------------------------------------
+| IsMenuItem | | True, if currently drawn list item is a normal entry
+-----------------------------------------------------------------------------
+| MenuCurrent | Atrribute: "clean" | Text of the current list item if it is the selected entry
+-----------------------------------------------------------------------------
+| IsMenuCurrent | | True, if currently drawn list item is a currently selected one
+-----------------------------------------------------------------------------
+| MenuText | Attribute: "clean" | Text page to display instead of the list (e.g. display in the command menu)
+-----------------------------------------------------------------------------
+| ButtonRed | (also in Channel Display | Caption of red button if available
+| | and Replay Display) |
+-----------------------------------------------------------------------------
+| ButtonGreen | (also in Channel Display | Caption of green button if available
+| | and Replay Display) |
+-----------------------------------------------------------------------------
+| ButtonYellow | (also in Channel Display | Caption of yellow button if available
+| | and Replay Display) |
+-----------------------------------------------------------------------------
+| ButtonBlue | (also in Channel Display | Caption of blue button if available
+| | and Replay Display) |
+-----------------------------------------------------------------------------
+| CanScrollUp | | True, if a scroll-text can be scrolled upward
+-----------------------------------------------------------------------------
+| CanScrollDown | | True, if a scroll-text can be scrolled downward
+-----------------------------------------------------------------------------
+| PresentStartDateTime | (also in Channel Display) |
+-----------------------------------------------------------------------------
+| PresentVPSDateTime | (also in Channel Display) |
+-----------------------------------------------------------------------------
+| PresentEndDateTime | (also in Channel Display) |
+-----------------------------------------------------------------------------
+| PresentDuration | (also in Channel Display) |
+-----------------------------------------------------------------------------
+| PresentProgress | (also in Channel Display) |
+-----------------------------------------------------------------------------
+| PresentTitle | (also in Channel Display) |
+-----------------------------------------------------------------------------
+| PresentShortText | (also in Channel Display) |
+-----------------------------------------------------------------------------
+| PresentDescription | (also in Channel Display) |
+-----------------------------------------------------------------------------
+| PresentHasVPS | (also in Channel Display) |
+-----------------------------------------------------------------------------
+| PresentHasTimer | (also in Channel Display) |
+-----------------------------------------------------------------------------
+| PresentIsRunning | (also in Channel Display) |
+-----------------------------------------------------------------------------
+| ChannelHasVPS | (also in Channel Display) |
+| (alt: HasVPS) | |
+-----------------------------------------------------------------------------
+
+
+2.7 Audio Tracks Display
+----------------
+-----------------------------------------------------------------------------
+| Token | Comment | Description
+=============================================================================
+| MenuTitle | | Title display of the audio-track list
+-----------------------------------------------------------------------------
+| AudioTrack | (also all other displays) | Identifier the current selected audio-track
+-----------------------------------------------------------------------------
+| AudioChannel | (also all other displays) | Identifier of the switched channeld
+| | | ("stereo", "left" or "right")
-----------------------------------------------------------------------------
@@ -584,13 +823,48 @@ True, if both parameters are true.
equal('Kanäle', trans('Channels'))
-3.5 file
+3.5 ne
+---------
+
+True, if both parameter are unequal (not equal).
+
+ ne({ReplayMode}, 'normal')
+
+3.6 gt
+---------
+
+True, if the first parameter is greater than the second.
+
+ gt({FreeDiskSpace},5000)
+
+3.7 ge
+---------
+
+True, if the first parameter is greater or equal than the second
+
+ ge({FreeDiskSpace},5000)
+
+3.8 lt
+---------
+
+True, if the first parameter is less than the second.
+
+ lt({FreeDiskSpace},5000)
+
+3.9 le
+---------
+
+True, if the first parameter is less or equal than the second.
+
+ gt({FreeDiskSpace},5000)
+
+3.10 file
--------
Returns the parameter, if the file exists in the skin directory.
file('logos/{ChannelName}.png')
-3.6 trans
+3.11 trans
---------
Rreturn the translation (i18n) of the parameter, false, if no translation is found.
@@ -602,18 +876,18 @@ Rreturn the translation (i18n) of the parameter, false, if no translation is fou
4.1 arc
-------
-----------------------------------------------------------------------------
-| Attribute || Value || Meaning (ellipse) || Meaning (slope)
------------------------------------------------------------------------------
-| arc || 0 || full ellipse || horizontal, increasing, bottom
- || 1 || first quadrant || horizontal, increasing, top
- || 2 || second quadrant || horizontal, decreasing, bottom
- || 3 || third quadrant || horizontal, decreasing, top
- || 4 || fourth quadrant || vertical, increasing, right
- || 5 || right half || vertical, increasing, left
- || 6 || upper half || vertical, decreasing, right
- || 7 || left half || vertical, decreasing, left
- || 8 || lower half ||
- || -1..-8 || invers of the above ||
+| Attribute | Value | Meaning (ellipse) | Meaning (slope)
+=============================================================================
+| arc | 0 | full ellipse | horizontal, increasing, bottom
+| | 1 | first quadrant | horizontal, increasing, top
+| | 2 | second quadrant | horizontal, decreasing, bottom
+| | 3 | third quadrant | horizontal, decreasing, top
+| | 4 | fourth quadrant | vertical, increasing, right
+| | 5 | right half | vertical, increasing, left
+| | 6 | upper half | vertical, decreasing, right
+| | 7 | left half | vertical, decreasing, left
+| | 8 | lower half |
+| | -1..-8 | invers of the above |
-----------------------------------------------------------------------------
4.2 color