[kupfer] doc: Mention some plugins as examples
- From: Ulrik Sverdrup <usverdrup src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [kupfer] doc: Mention some plugins as examples
- Date: Mon, 4 Apr 2011 01:56:21 +0000 (UTC)
commit c7088d84e07f3ad410dd70289c32a58d179af458
Author: Ulrik Sverdrup <ulrik sverdrup gmail com>
Date: Mon Apr 4 03:54:04 2011 +0200
doc: Mention some plugins as examples
Documentation/PluginAPI.rst | 17 ++++++++++++++++-
1 files changed, 16 insertions(+), 1 deletions(-)
---
diff --git a/Documentation/PluginAPI.rst b/Documentation/PluginAPI.rst
index 8af077c..77f484a 100644
--- a/Documentation/PluginAPI.rst
+++ b/Documentation/PluginAPI.rst
@@ -732,7 +732,7 @@ Each category has a specific format of required data that is defined in
``kupfer.plugin_support.register_alternative(caller, category_key, id_, **kwargs)``
to register their implementations of new alternatives. The arguments are:
-.. topic:: ``register_alternative(caller, category_key, id_, **kwargs)``
+.. topic:: ``register_alternative(caller, category_key, id_, ** kwargs)``
:``caller``: the name of the calling plugin, is always ``__name__``
:``category_key``: one of the above categories
@@ -756,6 +756,21 @@ directories. Package modules can also be installed as ``.zip`` files, so
they too can be distributed as single files.
+Example Plugins
+===============
+
+I want to specifically highlight certain files in Kupfer that are good
+to read as examples.
+
++ Custom Leaf and Action: the common case of creating a custom
+ ``Leaf`` type and defining its default ``Open`` action, see
+ ``kupfer/plugin/notes.py``
++ Content decoration: making content for objects, see
+ ``kupfer/plugin/archiveinside.py`` (*Deep Archives* plugin)
++ Asynchronous error reporting: see ``kupfer/plugin/volumes.py``, action
+ *Unmount*
+
+
Reference to the ``kupfer`` Package
===================================
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]