Text2skin-skin reference

From VDR Wiki

Info

This documentation is valid for the "1.0" version of the text2skin-plugin.

[edit] Elements

[edit] <skin>

This is the root element of the skins. All further elements go inside this container.

<?xml version="1.0"?>
<skin version="1.0" name="brushed Aluminium" screenBase="relative">
  .
  .
  .
</skin>

[edit] <display>

For each view of the OSD display a separate <display>-section is required. The most important views are "main" and "channelInfo".

<?xml version="1.0"?>
<skin version="1.0" name="brushed Aluminium" screenBase="relative">
  <display id="replayInfo">
   .
   .
   .
  </display>
</skin>

[edit] <window>

Each <display>-container has to start with a definition of drawing areas. Inside it's drawing areas some elements may be drawn.

<?xml version="1.0"?>
<skin version="1.0" name="brushed Aluminium" screenBase="relative">
  <display id="replayInfo">
    <window x1="0" x2="619" y1="-113" y2="-84" bpp="4" />
    <window x1="20" x2="99" y1="-83" y2="-44" bpp="4" />
     .
     .
     .
  </display>
</skin>

[edit] <rectangle>

Draws a filled rectangle.

<rectangle x1="20" x2="99" y1="-83" y2="-44" color="#00000000" />

[edit] <ellipse>

Draws a circle, a pitch circle, or a ellipse.

<ellipse x1="5" y1="7" x2="14" y2="15" color="GraphLight" condition="{IsMenuCurrent}"/>

[edit] <slope>

Draws a curve.

;-(

[edit] <image>

Display an image.

<image x="0" y="-70" path="Aluminium_volumebar.png" />
<image x="585" y="138" condition="{CanScrollUp}" path="symbols/arrowup.xpm" color="#AFFFFF00" />

[edit] <text>

A static or compound text.

<text x1="42" x2="571" y1="-113" y2="-86" color="#FF000000" font="Osd">{ReplayTitle}</text>

[edit] <marquee>

An alternative to <text> for oversized texts. Scrolls text if needed.

<marquee x1="130" x2="480" y1="423" y2="445" color="Text" font="Sml">{ReplayTitle}</marquee>

[edit] <blink>

An alternative to <text> which lets the text blink.

<blink x1="30" x2="80" y1="90" y2="80" color="Text" blinkColor="Green" delay="800" font="Sml" condition="{IsRunning}">
{PresentStartDateTime:%H\:%M}
</blink>;

[edit] <scrolltext>

A multiline text.

<scrolltext x1="24" y1="138" y2="-72" x2="583" font="helmetr.ttf:20" color="#AFFFFF00">
{PresentShortText}
{PresentDescription}
</scrolltext>

[edit] <scrollbar>

A scrollbar.

<scrollbar x1="585" x2="608" y1="162" y2="-110" color="#AFFFFF00" bgColor="#8F2B1B9E" />

[edit] <progress>

A progressbar.

<progress x1="19" x2="556" y1="-17" y2="-7" color="#AF000000" current="{VolumeCurrent}" total="{VolumeTotal}" />
<progress x1="129" x2="478" y1="487" y2="502" color="#FFCE7B00" bgColor="Blue" mark="Black" active="Black" keep="Black" current="{ReplayPositionIndex}"  total="{ReplayDurationIndex}"/>

[edit] <block>

A <block></block> groups several objects together.

<block condition="file('logos/{ChannelName}.mng')"> 
 <rectangle x1="4" x2="67" y1="4" y2="51" color="#AF000000" />
 <image x="0" y="0" path="logos/{ChannelName}.mng" />
</block>

[edit] <list>

Defines a list in the menu.

<list x1="24" y1="62" x2="569" y2="-82">
  <item height="28"/>
  <text x1="25" x2="569" y1="3" y2="27" color="#AF00FFFF" font="Sml">{MenuGroup}</text>
  <text x1="25" x2="569" y1="3" y2="27" color="#AFFFFFFF" font="Sml">{MenuItem}</text>
  <rectangle x1="0" x2="579" y1="0" y2="27" color="#FF2B1B9E" condition="{IsMenuCurrent}" />
  <text x1="22" x2="569" y1="0" y2="27" color="#AFFFFFFF" font="Osd">{MenuCurrent}</text>
  <text x1="0" x2="25" y1="0" y2="27" color="#AFFFFFFF" font="Osd">-></text>
</list>

[edit] <item>

Defines an item for the list.

<list x1="24" y1="62" x2="569" y2="-82">
  <item height="28" />
  <text x1="25" x2="569" y1="3" y2="27" color="#AF00FFFF" font="Sml">{MenuGroup}</text>
  <text x1="25" x2="569" y1="3" y2="27" color="#AFFFFFFF" font="Sml">{MenuItem}</text>
  <rectangle x1="0" x2="579" y1="0" y2="27" color="#FF2B1B9E" condition="{IsMenuCurrent}" />
  <text x1="22" x2="569" y1="0" y2="27" color="#AFFFFFFF" font="Osd">{MenuCurrent}</text>
  <text x1="0" x2="25" y1="0" y2="27" color="#AFFFFFFF" font="Osd">-></text>
</list>

[edit] Token

[edit] Common

[edit] Channel Display

[edit] Volume Display

[edit] Message Display

[edit] Replay Display

[edit] Menu Display

[edit] Audio Tracks Display

[edit] Functions

[edit] not

Negation of the term.

not(equal({PresentStartDateTime},{PresentVPSDateTime}))

[edit] and

True, if all parameter are true.

and({CanScrollUp},{CanScrollDown})

[edit] or

True, if at least one parameter is true.

or({CanScrollUp},{CanScrollDown})

[edit] equal

True, if both parameters are true.

equal('Kanäle', trans('Channels'))

[edit] ne

True, if both parameter are unequal (not equal).

ne({ReplayMode}, 'normal')

[edit] gt

True, if the first parameter is greater than the second.

gt({FreeDiskSpace},5000)

[edit] ge

True, if the first parameter is greater or equal than the second

ge({FreeDiskSpace},5000)

[edit] lt

True, if the first parameter is less than the second.

lt({FreeDiskSpace},5000)

[edit] le

True, if the first parameter is less or equal than the second.

gt({FreeDiskSpace},5000)

[edit] file

Returns the parameter, if the file exists in the skin directory.

file('logos/{ChannelName}.png')

[edit] trans

Returns the translation (i18n) of the parameter or false, if no translation is found.

equal('Kanäle', trans('Channels'))

[edit] Attributes

[edit] arc

[edit] color

also valid for: bgColor, blinkColor, mark, active, keep

Colors are given in RGB format (as in html code) with transparency like this:

color="#AARRGGBB".

Colors might be given as symbolic value which has to be defined in .colors file of the skin, i.e.

color="MenuTextFg"

• A = Alpha value (intensity or transparency)
• R = red value
• G = green value
• B = blue value

some examples:

        AARRGGBB
color="#00000000" = black, fully transparent (translucent)
color="#FF000000" = black, not translucent
color="#7F000000" = black, half translucent
color="#7FFFFFFF" = white, half translucent

for shure you can use every value between.

[edit] font

Three fonts are given by the plugin

• Osd
• Fix
• Sml

For those who have installed the freetype library and activated at compile time every font found at

• /etc/vdr/plugins/text2skin/fonts/

or

• /etc/vdr/plugins/text2skin/SkinName/

is usable.

In the skin file the font name,

font="Osd"

or, for Truetype fonts, the font filename and size (and optional width too)

font="helmetr.ttf:SIZE[,WIDTH]"

is given.