[kupfer] doc: Document required fields for alternatives



commit 97bd9feef2f254833ac0435bc8bfe6e39f2cf4ac
Author: Ulrik Sverdrup <ulrik sverdrup gmail com>
Date:   Thu Apr 7 05:48:02 2011 +0200

    doc: Document required fields for alternatives

 Documentation/PluginAPI.rst |   15 +++++++++++++++
 1 files changed, 15 insertions(+), 0 deletions(-)
---
diff --git a/Documentation/PluginAPI.rst b/Documentation/PluginAPI.rst
index 77f484a..32f4146 100644
--- a/Documentation/PluginAPI.rst
+++ b/Documentation/PluginAPI.rst
@@ -742,6 +742,21 @@ to register their implementations of new alternatives. The arguments are:
     ``register_alternative`` is normally called in the plugin's
     ``initialize_plugin(..)`` function.
 
+.. topic:: Fields requried for the category ``terminal``
+
+    :``name``:              unicode visible name
+    :``argv``:              argument list: list of byte strings
+    :``exearg``:            the execute-flag as a byte string (``""`` when N/A)
+    :``desktopid``:         the likely application id as a byte string
+    :``startup_notify``:    whether to use startup notification as boolean
+
+.. topic:: Fields required for the category ``icon_renderer``
+
+    :``name``:              unicode visible name
+    :``renderer``:          an object with an interface just like
+                            ``kupfer.icons.IconRenderer``
+
+
 Plugin Packages, Resources and Distribution
 :::::::::::::::::::::::::::::::::::::::::::
 



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]