epgsearchmenu.conf(5)

NAME
epgsearchmenu.conf – Konfiguration der EPG-Menüs

BESCHREIBUNG
Die Darstellung ausgewählter Menüs von EPGSearch kann an eigene Wünsche angepasst werden. Die Konfiguration erfolgt mit Hilfe dieser Datei.

Die Datei epgsearchmenu.conf wird nicht bei jedem Aufruf des Plugins neu geladen, da dies nur zum Testen der Konfigurationsdatei selbst sinnvoll ist. Um ein permanentes Neuladen der Datei zum Testen einer Konfigurationsänderung zu aktivieren, ist im Startskript des VDR (bspw. runvdr) der Startparameter '−r' oder '−−reloadmenuconf' zu ergänzen.

FORMAT
Jede Zeile legt das Erscheinungsbild eines bestimmten Menüs fest. Die einzelnen Einträge bestimmen, wie die folgenden Menüs gestaltet sein sollen:

MenuWhatsOnNow
    Vorlage für das Menü 'Jetzt'.

MenuWhatsOnNext
    Vorlage für das Menü 'Nächste'.

MenuWhatsOnElse
    Vorlage für das Menü einer benutzerdefinierten Zeit.

MenuSchedule
    Vorlage für das Menü 'Programm'.

MenuSearchResults
    Vorlage für das Menü 'Suchergebnisse'.

MenuFavorites
    Vorlage für das Menü 'Favoriten'.

Ohne einen entsprechenden Eintrag verwendet EPGSearch das Standardlayout des entsprechenden Menüs.

Der Eintrag 'MenuSearchResults' weist eine Besonderheit auf: Werden je nach Suche unterschiedliche Layouts für die Suchergebnisse gewünscht, können weitere Vorlagen erstellt werden. Hierzu ergänzt man für jede Vorlage einen Eintrag, bei dem der Name der Vorlage unmittelbar an 'MenuSearchResults' angefügt wird, beispielsweise 'MenuSearchResultsTagestipp'. Liegt mehr als ein mit 'MenuSearchResults' beginnender Eintrag vor, erscheint im Menü 'Suche editieren' ein zusätzlicher Menüpunkt 'Layout des Ergebnis-Menüs', der für die Anzeige der Suchergebnisse die Auswahl zwischen der Standardvorlage und eigenen Vorlagen erlaubt.

VARIABLEN
Folgende Variablen stehen zur Verfügung (Groß- und Kleinschreibung wird ignoriert):

%Time%
    Der Beginn einer Sendung im Format 'HH:MM'.

%TimeEnd%
    Das Ende einer Sendung im Format 'HH:MM'.

%Time_D%
    Das Datum des Beginns einer Sendung im Format 'TT'.

%Time_W%
    Der Name des Wochentages, an dem eine Sendung beginnt.

%Time_Lng%
    Datum und Startzeit einer Sendung in Epoch-Notation (Sekunden seit dem 01.01.1970, 00:00 UTC).

%TimeSpan%
    Die Zeit bis zum Beginn einer Sendung (bspw. 'in 15m') oder die bereits verstrichene Zeit (bspw. '10m').

%Date%
    Das Datum des Beginns einer Sendung im Format 'TT.MM.JJ'.

%DateSh%
    Das Datum des Beginns einer Sendung im Format 'TT.MM'.

%Date_ISO%
    Das Datum des Beginns einer Sendung im Format 'JJJJ-MM-TT'.

%Day%
    Der Tag des Beginns einer Sendung (1..31).

%Week%
    Die Kalenderwoche, in der eine Sendung beginnt (01..53).

    Gemäß ISO-Standard 8601 ist Montag der erste Tag einer Woche. Kalenderwoche 1 ist die erste Woche eines Jahres, die mindestens vier Tage des Jahres umfasst, also einen Donnerstag bzw. den 4. Januar enthält.

%Month%
    Der Monat des Beginns einer Sendung (1..12).

%Year%
    Das Jahr des Beginns einer Sendung (1970..2038, gegebenenfalls auch später).

%EventID%
    Die numerische Kennung einer Sendung.

%LiveEventID%
    Die Kennung einer Sendung, wie sie vom Frontend live verwendet wird.

%Title%
    Der Titel einer Sendung.

%Subtitle%
    Der Untertitel einer Sendung.

%Summary%
    Die Beschreibung einer Sendung.

%Aux%
    Die Zusatzinfo (z.B. epg2vdr) einer Sendung.

%HtmlSummary%
    Die Beschreibung einer Sendung, in der alle Zeilenumbrüche durch '<br />' ersetzt sind.

    Achtung: Die in HTML reservierten Zeichen '<&">' werden nicht durch ihre Substitute '&lt;', '&amp;', '&quot;' und '&gt;' ersetzt.

%<EPG-Kategorie>%
    Der für eine Sendung zutreffende Wert der entsprechenden EPG-Kategorie aus epgsearchcats.conf, etwa '%Genre%' oder '%Category%'.

%Length%
    Die Länge einer Sendung in Sekunden.

%Status%
    Der Status einer Sendung (entspricht '%T_Status%%V_Status%%R_Status%').

%T_Status%
    Der Status eines Timers ('T', 't' oder 'R'), andernfalls ein Leerzeichen.

%V_Status%
    Der VPS-Status einer Sendung ('V'), andernfalls ein Leerzeichen.

%R_Status%
    Der Status, ob eine Sendung läuft ('*'), andernfalls ein Leerzeichen.

Für die Menüs benutzerdefinierter Zeiten sowie das Menu 'Suchergebnisse' stehen ergänzend noch folgende Variablen zur Verfügung:

%ChNr%
    Die Kanalnummer einer Sendung.

%ChSh%
    Die Kurzbezeichnung des Kanals einer Sendung.

%ChLng%
    Der ausführliche Name des Kanals einer Sendung.

%ChData%
    Die interne Kanalkennung des VDR (bspw. 'S19.2E-1-1101-28106').

%Progr%
    Eine grafische Fortschrittsanzeige; nicht verfügbar für das Menü 'Suchergebnisse'.

    Hinweis: Zur Anzeige der Grafik muss die Schriftart VDRSymbols installiert sein.

%ProgrT2S%
    Eine Fortschrittsanzeige im Stil von text2skin; nicht verfügbar für das Menü 'Suchergebnisse'.

Abschließend noch einige allgemeine Variablen:

%TimeNow%
    Die aktuelle Zeit im Format 'HH:MM'.

%DateNow%
    Das aktuelle Datum im Format 'TT.MM.JJ'.

%DateShNow%
    Das aktuelle Datum im Format 'TT.MM'.

%Date_ISO_Now%
    Das aktuelle Datum im Format 'JJJJ-MM-TT'.

%VideoDir%
    Das Video-Verzeichnis des VDR (bspw. /video).

%PlugConfDir%
    Das Konfigurationsverzeichnis des VDR für die Plugins (bspw. /etc/vdr/plugins).

%EPGSearchDir%
    Das Konfigurationsverzeichnis von EPGSearch (bspw. /etc/vdr/plugins/epgsearch)

%Colon%
    Ein Doppelpunkt.

Des Weiteren können auch Variablen für erweiterte EPG-Kategorien, die in epgsearchcats.conf definiert sind, oder benutzerdefinierte Variablen aus epgsearchuservars.conf verwendet werden. Bei Variablennamen wird nicht zwischen Groß- und Kleinschreibung unterschieden.

Ein Eintrag besteht aus bis zu sechs Tabellenspalten, die durch '|' getrennt sind. Der letzte Eintrag einer jeden Tabellenzeile sollte, durch ':' abgetrennt, die Tabellenbreite in Zeichen angeben.

Wenn Elemente durch Zeichen wie '~', '−' oder '#' getrennt werden (bspw. '%Title% ~ %Subtitle%') und am Ende stehende Elemente leer sind, entfernt EPGSearch nach Möglichkeit verwaiste Leerräume und Trennzeichen.

Um Symbole der Schriftart VDRSymbols zu aktivieren, muss die folgende Zeile in die Datei eingefügt werden:

    WarEagleIcons=1

Die Schriftart VDRSymbols kann von <http://andreas.vdr-developer.org/fonts/download.html> heruntergeladen werden.

Hinweis: Wenn eine Datei epgsearchmenu.conf mit einem Eintrag für ein bestimmtes Menü vorhanden ist, werden die Standardeinstellungen zur Darstellung dieses Menüs ignoriert.

BEISPIEL
Ein Beispiel für epgsearchmenu.conf befindet sich im Unterverzeichnis conf von EPGSearch. Zum schnellen Ausprobieren kann die Datei in das Konfigurationsverzeichnis von EPGSearch (bspw. /etc/vdr/plugins/epgsearch) kopiert werden.

    MenuWhatsOnNow=%chnr%:3|%progrt2s%:5| %time% %t_status%:8|%category%:6| %title% ~ %subtitle%:35
    MenuWhatsOnNext=%chnr%:3|%time% %t_status%:8|%category%:8| %title% ~ %subtitle%:35
    MenuWhatsOnElse=%chnr%:3|%time% %t_status%:8|%category%:8| %title% ~ %subtitle%:35
    MenuSchedule=%time% %t_status%:8|%genre%:14| %title% ~ %subtitle%:35
    MenuFavorites=%chnr%:3|%datesh% %time% %t_status%:14|%genre%:8| %title%%colon%%subtitle%:35
    MenuSearchResults=%chnr%:3|%datesh% %time% %t_status%:14|%genre%:8| %title%%colon% %subtitle%:35

Der Eintrag 'MenuWhatsOnNow' legt fest, wie eine Zeile für das Menü 'Jetzt' beschaffen sein soll. Die Menüzeile beginnt mit der Kanalnummer, gefolgt von einem Fortschrittsbalken im Stil von text2skin, einem Leerzeichen, dem Sendungsbeginn, dem Timer-Status, der EPG-Kategorie (bspw. "Film") und schließlich dem Titel und Untertitel der Sendung.

Nehmen wir außerdem an, dass noch folgender Eintrag hinzugefügt wird:

    MenuSearchResultsTagestipp=%chnr%:3|%time_w%:4|%t_status%:3|%genre%:10|%title%%colon% %subtitle%:35

Dies bewirkt, dass im Menü 'Suche editieren' ein zusätzlicher Menüpunkt 'Layout des Ergebnis-Menüs' erscheint, der für die Anzeige der Suchergebnisse die Auswahl zwischen der Standardvorlage und eigenen Vorlagen ermöglicht. Im obigen Beispiel würde 'Tagestipp' als zusätzliche Option aufgeführt, da EPGSearch für den Vorlagennamen lediglich das Präfix 'MenuSearchResults' entfernt. Zur Anzeige der Suchergebnisse wird das gewählte Layout anstelle des Standardlayouts verwendet.

Die Werte für die Spaltenbreiten sollten den eigenen Bedürfnissen anpasst werden, da das Erscheinungsbild oft von der gewählten Oberfläche abhängt.

AUTOREN (Man-Pages)
Ursprünglich erstellt von Mike Constabel <epgsearch (at) constabel (dot) net>.

Überarbeitet und an die aktuellen Features von EPGSearch adaptiert durch die derzeitigen Maintainer.

PROJEKTSEITE
Das Plugin wird als Projekt auf GitHub geführt:

<https://github.com/vdr-projects/vdr-plugin-epgsearch/>

FEHLER MELDEN
Fehlerberichte sowie Feature-Anfragen können über den Bugtracker des Projekts eingespeist werden:

<https://github.com/vdr-projects/vdr-plugin-epgsearch/issues/>

COPYRIGHT und LIZENZ
Copyright © 2004-2010 Christian Wieninger

Copyright © 2011-2025 TomJoad (VDR-Portal) et al.

Dieses Programm ist freie Software. Sie können es unter den Bedingungen der GNU General Public License, wie von der Free Software Foundation veröffentlicht, weitergeben und/oder modifizieren, entweder gemäß Version 2 der Lizenz oder (nach Ihrer Option) jeder späteren Version.

Die Veröffentlichung dieses Programms erfolgt in der Hoffnung, dass es Ihnen von Nutzen sein wird, aber OHNE IRGENDEINE GARANTIE, sogar ohne die implizite Garantie der MARKTREIFE oder der VERWENDBARKEIT FÜR EINEN BESTIMMTEN ZWECK. Details finden Sie in der GNU General Public License.

Sie sollten ein Exemplar der GNU General Public License zusammen mit diesem Programm erhalten haben. Falls nicht, schreiben Sie an die Free Software Foundation, Inc. 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA. Oder rufen Sie in Ihrem Browser <https://www.gnu.org/licenses/old-licenses/gpl-2.0.html> auf.

Der ursprüngliche Autor kann über cwieninger@gmx.de erreicht werden.

Die aktuellen Maintainer können über die Projektseite auf GitHub (siehe oben) erreicht werden.

Der MD5-Code ist abgeleitet aus dem Message-Digest-Algorithmus MD5 von RSA Data Security, Inc.

SIEHE AUCH
epgsearch(1), epgsearchcats.conf(5), epgsearchuservars.conf(5)