Entwicklung - Hinweise für Plugin Entwickler
Inhaltsverzeichnis |
Beschreibung
Plugins packen
Sinngemäß entsprechend ../VDR/PLUGINS.html:
Erstellen eines Plugin-Pakets
Wenn man als Entwickler sein Plugin anderen VDR-Nutzern verfügbar machen möchte, muss man ein Quellcode-Paket erstellen. Das Makefile welches beim Aufruf von newplugin erstellt wurde verfügt über das make Ziel dist, welches diese Funktion übernimmt.
In das Plugin Verzeichnis wechseln und make dist ausführen, hier am Beispiel von hello:
cd VDR/PLUGINS/src/hello make dist
Anschließend sollte ein neu erstelltes Quellcode-Tarball
vdr-hello-0.0.1.tgz
im Quellcodeverzeichnis erstellt worden sein, wobei hello durch den eigenen Plugin-Namen ersetzt wird und 0.0.1 durch die Versionsnummer des Plugins.
Übersetzungen / Internationalisieren
- Französisch
Wünschenswert
Wie in der Struktur zu sehen ist, wird das $VDRCONFIG/plugins Verzeichnis mit der Anzahl der Plugins unübersichtlich.
Wäre schön, wenn wie bei einigen Plugins schon geschehen, der Ort für Konfigurationsdateien mit einem neuen Verzeichnis eine Ebene tiefer gesetzt wird.
- VDRCONFIG/plugins + VDRCONFIG/plugins/<PLUGIN>
Oder zwecks Abwärtskompatibilität, eine entsprechende Option bereit zu stellen. (siehe image-plugin / loadepg-plugin)
-c <PATH> --config=<PATH>
PATH ist relativ zum VDR Plugin Konfigurationsverzeichnis, Bsp.
-c test
Entspricht.
$VDRCONFIG/plugins/test
So wäre in Zukunft sicher gestellt, dass Konfigurations-Dateien nicht miteinander kollidieren.
Zum anderen dient es sicher der Übersichtlichkeit.
Intelligenz einiger Plugins
Warum steigen einige Plugins aus, mit der message "configfile not found...", könnte man nicht ein wenig Intelligenz von einem Plugin erwarten?
Z.B., wenn eine Konfigurations-Datei nicht vorhanden ist, das diese dann vom Plugin am passenden Ort erstellt wird?
Im eggtimer-plugin und systeminfo-plugin ist solch eine Routine zu sehen.
Debugging
Viele nutzen.
DEBUG = 1
In den Makefiles, Problem.
make DEBUG=1 all plugins
Und alles würde mit Debug übersetzt, obwohl man explizit nur ein Plugin in diesen Modus haben möchte.
Das femon-plugin macht es richtig. (<NAME DES PLUGINS>_DEBUG)
FEMON_DEBUG = 1
Wäre nicht schlecht, wenn das die anderen Plugins ebenso halten könnten.
Makefile Option(s)
Bsp.:
# uncomment this, if you have ImageMagick ... HAVE_IMAGEMAGICK = 1
Sowas lässt sich besser (und vor allem automatisch) lösen:
# uncomment this, if you have ImageMagick ...
ifeq (exists, $(shell pkg-config ImageMagick{,++} && echo exists))
HAVE_IMAGEMAGICK = 1
endif
Plugins
Es lässt sich auch Abfragen, ob andere Plugins vorhanden sind.
Bsp.:
USE_MAILBOX_PLUGIN = 1
Besser:
ifeq (exists, $(shell test -e ../mailbox && echo exists)) USE_MAILBOX_PLUGIN = 1 endif
