Merge remote branch 'origin/bug_135_dvdburn_ts_only'

[enigma2.git] / doc / PLUGINS

diff --git a/doc/PLUGINS b/doc/PLUGINS
index ed448fa298735cd18ff6f7a556cb47247bc037f0..c397e09c83dc3f02a85b8d1cbadba5a49c847cf1 100644 (file)
--- a/doc/PLUGINS
+++ b/doc/PLUGINS
@@ -76,6 +76,27 @@ stands for "keyword arguments") collects all addition keyword arguments
 parameter, and probably more in the future. You must ignore all additional
 keywords which you don't need!
 
+skins
+=====
+
+Generally, you can include the skin in your Screens by having a static (or
+non-static, if you really want) variable "skin", for example:
+
+class OurSmallTestScreen(Screen):
+       skin = "<skin>...</skin>"
+       def __init__(self, session):
+               Screen.__init__(self, session)
+               ...
+
+However, users can override the skin from their skin.xml. Note that the
+Screen's name (unless you override this, which is possible) is used for
+determining which skin is used. Thus, if you're choosing generic skin names
+like "TheScreen", it's likely to cause namespace clashes.
+
+Thus, please use skin names (i.e. Screen-names, unless you're overriding the
+skin name) which are unique enough to not clash. In doubt, prepend the
+pluginname like in our example.
+
 autostarting plugins
 ====================
 
@@ -99,7 +120,7 @@ Configuration
 
 Speaking about configuration, plugins must live in 
 
-config.plugins.<Category>.<PluginName>
+config.plugins.<PluginName>
 
 and nowhere else!