From: Felix Domke <tmbinc@elitedvb.net>
Date: Sun, 5 Mar 2006 22:02:33 +0000 (+0000)
Subject: a bit more about plugin names
X-Git-Tag: 2.6.0~3867
X-Git-Url: https://git.cweiske.de/enigma2.git/commitdiff_plain/4cae1268de8d90637a11732fb4804fd79cb8e6d0?hp=f7c8d3cf16c62a7be9ebb66a726237736bdd0a8e

a bit more about plugin names
---

diff --git a/doc/PLUGINS b/doc/PLUGINS
index c383997e..ed448fa2 100644
--- a/doc/PLUGINS
+++ b/doc/PLUGINS
@@ -26,8 +26,8 @@ def Plugins(**kwargs):
 		fnc=main)"
 
 Basically, you're writing a "python module", which is called
-Plugins.ourSmallTest.plugin. This corresponds to the
-Plugins/ourSmallTest/plugin.py file.
+Plugins.DemoPlugins.OurSmallTest.plugin. This corresponds to the
+Plugins/DemoPlugins/OurSmallTest/plugin.py file.
 
 This module must define a single function called "Plugins". The functions is
 called for every Plugin, and should return (a list of)
@@ -91,6 +91,31 @@ def autostartEntry(raeson, **kwargs):
 	elif reason == 1:
 		print "shutdown"
 
+autostart plugins should always be configurable, and should default to an
+OFF state!
+
+Configuration
+=============
+
+Speaking about configuration, plugins must live in 
+
+config.plugins.<Category>.<PluginName>
+
+and nowhere else!
+
+You are, however, free to change settings which are already existing. If you
+
+Dependencies
+============
+
+Plugin dependencies (one plugin requires another plugin) should generally be
+avoided, but are possible. If there are dependencies, the .ipk file must
+list them.
+
+If possible, make them optional. If your plugin doesn't support one feature
+because another plugin isn't installed, that's fine (but should be noted in
+the docs).
+
 Categories
 ==========
 
@@ -99,3 +124,17 @@ Currently defined categories are:
 * DemoPlugins: Plugins fore pure demonstration purposes
 * Extensions: User interface extensions
 * SystemPlugins: Hardware specific plugins
+
+Plugin Names
+============
+
+A plugin name:
+ - should always start with a Uppercase letter,
+ - must not start with the word "Dream",
+ - nor end with "Plugin",
+ - should be unique even across Categories,
+ - must be understandable by english speaking people,
+   (unless it's a geographically restricted plugin)
+ - is not user changeable (that is, the user is not allowed to rename the
+   plugin directory)
+ - shouldn't be a generic word