Text2skin-Skin Referenz

Aktuelle Version vom 29. August 2013, 21:22 Uhr

Dies ist eine Kurzreferenz des auf XML-basierenden Skin-Formates des text2skin Plugins.

[Bearbeiten] Elemente

[Bearbeiten] <skin>

Dies ist das Wurzelelement des Skins. Alle weiteren Elemente liegen verschachtelt in diesem.

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

[Bearbeiten] <display>

Das OSD von VDR hat mehrere "Darstellungen". Die wichtigsten wären das Hauptmenu und die Kanalinfo-Anzeige. Für jeden Bereich, der mit dem Skin gestaltet werden soll muss ein <display> Container erstellt werden.

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

[Bearbeiten] <window>

Jeder Display-Container beginnt mit der Vorgabe von Zeichenflächen, auf denen dann die Elemente platziert werden können.

<?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>

[Bearbeiten] <rectangle>

Zeichnet ein gefülltes Rechteck.

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

[Bearbeiten] <ellipse>

Zeichnet einen gefüllten Kreis, eine Ellipse oder Teile davon.

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

[Bearbeiten] <slope>

Eine Kurve.

 <slope x1="10" x2="100" y1="10" y2="100" arc="1" color="#CC000066" />

[Bearbeiten] <image>

Anzeige eines Bildes

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

[Bearbeiten] <text>

Ein statischer oder zusammengesetzter Text.

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

[Bearbeiten] <marquee>

Alternative zu <text>. Scrollt überlange Texte hin und her.

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

[Bearbeiten] <blink>

Alternative zu <text>. Stellt Text blinkend dar.

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

[Bearbeiten] <scrolltext>

Ein mehrzeiliger Text.

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

[Bearbeiten] <scrollbar>

Eine Scrollleiste.

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

[Bearbeiten] <progress>

Eine Fortschrittsanzeige

<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}"/>

[Bearbeiten] <block>

Ein <block></block> fasst mehrere Objekte zusammen

<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>

[Bearbeiten] <list>

Definiert die Liste im Menü.

<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>

[Bearbeiten] <item>

Definiert ein Item der Liste.

<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>

[Bearbeiten] Token

[Bearbeiten] Allgemein

[Bearbeiten] Channel Display

[Bearbeiten] Volume Display

[Bearbeiten] Message Display

[Bearbeiten] Replay Display

[Bearbeiten] Menu Display

[Bearbeiten] Audio Tracks Display

[Bearbeiten] Funktionen

[Bearbeiten] not

Negierung einer Funktion.

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

[Bearbeiten] and

Wahr, wenn alle Parameter wahr sind.

and({CanScrollUp},{CanScrollDown})

[Bearbeiten] or

Wahr, wenn mindestens ein Parameter wahr ist.

or({CanScrollUp},{CanScrollDown})

[Bearbeiten] equal

Wahr, wenn beide Parameter gleich sind.

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

[Bearbeiten] ne

Wahr, wenn beide Parameter ungleich (not equal) sind.

ne({ReplayMode}, 'normal')

[Bearbeiten] gt

Wahr, wenn der erste Parameter größer als (greater than) der zweite ist.

 gt({FreeDiskSpace},5000)

[Bearbeiten] ge

Wahr, wenn der erste Parameter größer oder gleich (greater/equal) dem zweiten ist.

 ge({FreeDiskSpace},5000)

[Bearbeiten] lt

Wahr, wenn der erste Parameter kleiner als (less than) der zweite ist.

 lt({FreeDiskSpace},5000)

[Bearbeiten] le

Wahr, wenn der erste Parameter kleiner oder gleich (less/equal) dem zweiten ist.

 le({FreeDiskSpace},5000)

[Bearbeiten] file

Liefert den Parameter zurück, wenn die dort angegebene Datei existiert.

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

[Bearbeiten] trans

Liefert die Übersetzung (nach i18n) des Parameters; falsch, wenn keine Übersetzung gefunden wurde.

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

[Bearbeiten] Attribute

[Bearbeiten] x/y Koordinaten

Die Koordinaten x1, y1, x2, y2, x, y beziehen sich im 'absolute' Mode auf die gesamte darstellbare Bildfläche von 720x576 Pixeln. Im 'relative' Mode beziehen sich alle Angaben stattdessen auf die OSD-Fläche, welche je nach Einstellungen im VDR-Setup (OSD Links, Rechts, Höhe, Breite, 4:3, 16:9) in Größe und Position variiert. Positive Werte (inklusive Null) für x{n} und y{n} sind als Offset zur linken oberen Ecke zu verstehen, negative Werte als Offset zur rechten unteren Ecke. x-Werte sind horizontale Angaben, y-Werte vertikale.

Hinweis

Wenn möglich sollten Skins im 'relative' Mode mit x1, y1, x, y als positiven Werten angegeben werden und x2, y2 als negativen Werten. So wird gewährleistet, dass das erstellte Skin immer vollständig dargestellt werden kann.

[Bearbeiten] arc

Abbildungen der Formen von Ellipse und Slope siehe Thumbnails.

[Bearbeiten] color

Betrifft auch: bgColor, blinkColor, mark, active, keep

Farben werden im RGB-Format mit Transparenz angegeben. Also etwa

color="#AARRGGBB"

Farben können auch als symbolischer Wert angegeben werden, welcher in der .colors-Datei des Skins aufgelöst wird. Z.B.

color="MenuTextFg"

• A = Alphawert (eigentlich Deckkraft, oft auch Transparenz)
• R = Rotwert
• G = Grünwert
• B = Blauwert

Ein paar Beispiele

        AARRGGBB
color="#00000000" = Schwarz, voll transparent (durchsichtig)
color="#FF000000" = Schwarz, volle Deckkraft
color="#7F000000" = Schwarz, halb durchscheinend
color="#7FFFFFFF" = Weiß, halb durchscheinend

und natürlich alle möglichen Zwischentöne und Transparenzen.

[Bearbeiten] font

Es gibt drei vorgegebene Fonts

• Osd
• Fix
• Sml

Wenn man die Freetype-Bibliothek installiert hat und beim compilieren aktiviert hat, lässt sich zusätzlich jeder TrueType-Font verwenden, der unter

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

oder

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

installiert ist.

In der Skindatei gibt man den Fontnamen,

font="Osd"

oder, bei Truetype-Fonts, den Font-Dateinamen und die gewünschte Größe und Breite (optional)

font="helmetr.ttf:Größe[,Breite]"

an.