Dbt: zu Archiv Development verschoben

2018-05-16T11:07:27Z

zu Archiv Development verschoben

← Nächstältere Version		Version vom 16. Mai 2018, 13:07 Uhr
Zeile 1:		Zeile 1:
	~~[[Category:Archiv]]~~
	[[Kategorie:Register]]		[[Kategorie:Register]]
	[[Kategorie:Software]]		[[Kategorie:Software]]
	[[Kategorie:Enigma2]]		[[Kategorie:Enigma2]]
	[[~~Kategorie~~:Development]]		[[Category:Archiv:Development]]
	[[Kategorie:Dreambox]]		[[Kategorie:Dreambox]]
	__TOC__		__TOC__

Dbt: archiviert

2018-05-04T17:50:11Z

archiviert

← Nächstältere Version		Version vom 4. Mai 2018, 19:50 Uhr
Zeile 1:		Zeile 1:
			[[Category:Archiv]]
	[[Kategorie:Register]]		[[Kategorie:Register]]
	[[Kategorie:Software]]		[[Kategorie:Software]]

Dbt: hat „Enigma2:Plugin-Erstellung“ nach „Dreambox:Enigma2:Plugin-Erstellung“ verschoben

2012-04-09T14:18:55Z

hat „Enigma2:Plugin-Erstellung“ nach „Dreambox:Enigma2:Plugin-Erstellung“ verschoben

← Nächstältere Version	Version vom 9. April 2012, 16:18 Uhr
(kein Unterschied)

Dbt: 1 Versionen

2009-07-04T11:26:36Z

1 Versionen

← Nächstältere Version	Version vom 4. Juli 2009, 13:26 Uhr
(kein Unterschied)

Dbt am 13. Februar 2009 um 15:01 Uhr

2009-02-13T15:01:17Z

Neue Seite

[[Kategorie:Register]]
[[Kategorie:Software]]
[[Kategorie:Enigma2]]
[[Kategorie:Development]]
[[Kategorie:Dreambox]]
__TOC__

=Allgemeines=

Grundsätzlich liegen die Plugins in /usr/lib/enigma2/python/Plugins. Dort dann halt entsprechend den vorhandenen Unterverzeichnissen ein Verzeichnis für das neue Plugin anlegen.

=Voraussetzung und Erstellung=

In dem Verzeichnis müssen sein:
* __init__.py (kann leer sein. wird aber benötigt, da Python das Verzeichnis sonst nicht als Modul erkennt)
* plugin.py (das Hauptskript für jedes Plugin)

plugin.py muss enthalten:
<source lang="python">
from Plugins.Plugin import PluginDescriptor # importiert den PluginDescriptor (s.u.)<br>
# diese Funktion wird aufgerufen und gibt einen einzelnen PluginDescriptor oder eine Liste von PluginDescriptoren zurück
# das **kwargs einfach ignorieren! (näheres dazu in docs/PLUGINS im enigma-baum) ***
def Plugins(**kwargs):
# Beispiel für ein einzelnes Plugin, welches im Plugin-Menü erscheint
return PluginDescriptor(name="File-Manager", description="Let's you view/edit files in your Dreambox", where =
PluginDescriptor.WHERE_PLUGINMENU, fnc=main)

# Beispiel für eine Liste von Plugins, das erste erscheint im Plugin-Menü, das zweite wird beim E2-Start aufgerufen (Autostart)
return [PluginDescriptor(name="Plugin1", description="Example Plugin", where = PluginDescriptor.WHERE_PLUGINMENU, fnc=main),
PluginDescriptor(where = PluginDescriptor.WHERE_AUTOSTART, fnc = autostart) ]
</source>

Der Filemanager ruft dann, wenn man auf den Menüpunkt "File-Manager" im Plugin-Menü geht, die Funktion "main" auf. Die muss so aussehen:
<source lang="python">
def main(session, **kwargs): # **kwargs einfach ignorieren, s.o. ***
</source>

Der session-Parameter enthält dann die Session, welche man z.B. zum Erstellen von Screen braucht.

Will man dann in <code> einen Screen aufrufen, macht man das so:
<source lang="python">
session.open(<screen>)
</source>
So ein Screen ist eigentlich immer recht einheitlich aufgebaut, Beispiel Filemanager:
<source lang="python">
class FileManager(Screen):
skin = """
<screen position="100,100" size="550,400" title="Test" >
<widget name="list" position="10,0" size="190,250" scrollbarMode="showOnDemand" />
<widget name="pixmap" position="200,0" size="190,250" alphatest="on" />
</screen>"""
def __init__(self, session, args = None):
Screen.__init__(self, session)<br>
self["list"] = FileList("/", matchingPattern = "^.*\.(png|avi|mp3|mpeg|ts)")
self["pixmap"] = Pixmap()<br>
self["actions"] = NumberActionMap(["WizardActions", "InputActions"],
{
"ok": self.ok,
"back": self.close,
# "left": self.keyLeft,
# "right": self.keyRight,
"1": self.keyNumberGlobal,
"2": self.keyNumberGlobal,
"3": self.keyNumberGlobal,
"4": self.keyNumberGlobal,
"5": self.keyNumberGlobal,
"6": self.keyNumberGlobal,
"7": self.keyNumberGlobal,
"8": self.keyNumberGlobal,
"9": self.keyNumberGlobal,
"0": self.keyNumberGlobal
}, -1)
</source>
skin = ... definiert einen lokalen Skin in diesem Plugin. Die Syntax entspricht der in skin.xml, bis auf den Screen-Namen, der wird hier nicht benötigt. Dann haben wir die Konstruktor-Methode __init__, welche dann den Screen-Konstruktor mit gleichen Parametern aufruft, da FileManager von Skin abgeleitet ist. Die Widgets, die wir im Skin definiert haben, sind noch leer. Diese werden dann in den nächsten Zeilen mit Funktion gefüllt:
<source lang="python">
self["pixmap"] = Pixmap() <-- das erstellt zum Beispiel ein Bild
self["list"] = FileList("/", matchingPattern = "^.*\.(png|avi|mp3|mpeg|ts)") <-- das eine in der gleichen Datei definierte
FileListe.
</source>
Als nächstes wird noch angegeben, was bei Tastendrücken passieren soll. Dafür sind die Actionmaps da.
<source lang="python">
self["actions"] = NumberActionMap(["WizardActions", "InputActions"] <-- wir benutzen aus der keymap.xml-Datei die Abschnitte
"WizardActions" und "InputAction"
</source>
Für die in der keymap.xml definierten Tastendrücke wird dann im folgenden angegeben, welche Methode der Klasse bei welchem Tastendruck aufgerufen werden soll. Also z.B. "ok": self.ok ruft die Methode 'ok' auf, wenn man auf die Taste, die in der Keymap.xml als Action "ok" hat, gedrückt wird.

=Unterstützung von Lokalisierungen in einem Plugin=

Um ein Plugin in alle möglichen Sprachen übersetzbar zu machen müssen als alle Strings von der Funktion _() umgeben werden.
Um also z.B. den Titel des o.g. Filebrowsers übersetzbar zu machenm müsste man den code wie folgt gestalten:
<source lang="python">
skin = """
<screen position="100,100" size="550,400" title="%s" >
<widget name="list" position="10,0" size="190,250" scrollbarMode="showOnDemand" />
<widget name="pixmap" position="200,0" size="190,250" alphatest="on" />
</screen>""" %(_("test"))
</source>
Da die Funktion _() in Plugins jedoch leider nicht umittelbar zur Verfügung steht müssen wir die __init__.py unseres Plugins wie folgt ergänzen
<source lang="python">
from Components.Language import language
from Tools.Directories import resolveFilename, SCOPE_PLUGINS
import os,gettext

PluginLanguageDomain = "FileBrowser"
PluginLanguagePath = "Extensions/FileBrowser/locale"

def localeInit():
lang = language.getLanguage()[:2] # getLanguage returns e.g. "fi_FI" for "language_country"
os.environ["LANGUAGE"] = lang # Enigma doesn't set this (or LC_ALL, LC_MESSAGES, LANG). gettext needs it!
print "[WebInterface] set language to ", lang
gettext.bindtextdomain(PluginLanguageDomain, resolveFilename(SCOPE_PLUGINS, PluginLanguagePath))

def _(txt):
t = gettext.dgettext(PluginLanguageDomain, txt)
if t == txt:
print "[%s] fallback to default translation for %s" %(PluginLanguageDomain, txt)
t = gettext.gettext(txt)
return t

localeInit()
language.addCallback(localeInit)
</source>
Alles noch fehlt ist folgender Import in allen Dateien die Übersetzungen unterstützen sollen:
<source lang="python">
from __init__ import _
</source>

Vorrausetzung für die Funktio der neu definierten _() Funktion ist dass die kompilierten gettext Sprachdateien sich in dem in der Variablen "PluginLanguagePath" angegebenen Pfad befinden.

Die notwendigen .po und die .pot - also das Template für neue Übersetzungen - Dateien kommen am besten in ein eigenes verzeichnis namens "po". Erstellen kann man die enstprechenden Files z.B. mit PoEdit.

Sollen die Sprachdateien mithilfe der [[Openembedded]] Toolchain kompiliert werden so ist noch ein entsprechendes Makefile notwendig.
Dieses kann wie folgt aufgebaut werden:
<source lang="make">
#
# to use this for the localisation of other plugins,
# just change the DOMAIN to the name of the Plugin.
# It is assumed, that the domain ist the same as
# the directory name of the plugin.
#

DOMAIN=FileBrowser
installdir = /usr/lib/enigma2/python/Plugins/Extensions/$(DOMAIN)
#GETTEXT=./pygettext.py
GETTEXT=xgettext

#MSGFMT = ./msgfmt.py
MSGFMT = msgfmt

LANGS := de tr nl fy es
LANGPO := $(foreach LANG, $(LANGS),$(LANG).po)
LANGMO := $(foreach LANG, $(LANGS),$(LANG).mo)

default: $(DOMAIN).pot $(LANGPO) merge $(LANGMO)
for lang in $(LANGS); do \
mkdir -p $$lang/LC_MESSAGES; \
cp $$lang.mo $$lang/LC_MESSAGES/$(DOMAIN).mo; \
done

merge:
for lang in $(LANGS); do \
msgmerge --no-location -s -N -U $$lang.po $(DOMAIN).pot; \
done

# the TRANSLATORS: allows putting translation comments before the to-be-translated line.
$(DOMAIN).pot:
$(GETTEXT) -L python --add-comments="TRANSLATORS:" -d $(DOMAIN) -s -o $(DOMAIN).pot ../src/*.py
msguniq -o $(DOMAIN)uniq.pot $(DOMAIN).pot
$(RM) $(DOMAIN).pot
mv $(DOMAIN)uniq.pot $(DOMAIN).pot

.PHONY: $(DOMAIN).pot

%.mo: %.po
$(MSGFMT) -o $@ $<

%.po:
msginit -l $@ -o $@ -i $(DOMAIN).pot --no-translator

CLEANFILES = $(foreach LANG, $(LANGS),$(LANG).mo)

clean-local:
$(RM) -r $(LANGS)

install-data-am: default
for lang in $(LANGS); do \
mkdir -p $(DESTDIR)$(installdir)/locale/$$lang/LC_MESSAGES; \
cp $$lang.mo $(DESTDIR)$(installdir)/locale/$$lang/LC_MESSAGES/$(DOMAIN).mo; \
done
</source>

{{body}}

Dreambox:Enigma2:Plugin-Erstellung - Versionsgeschichte

Dbt: zu Archiv Development verschoben

Dbt: archiviert

Dbt: hat „Enigma2:Plugin-Erstellung“ nach „Dreambox:Enigma2:Plugin-Erstellung“ verschoben

Dbt: 1 Versionen

Dbt am 13. Februar 2009 um 15:01 Uhr