[geany/geany-plugins] 8786fe: docs: update docs for the proxy plugin changes

Thomas Martitz git-noreply at xxxxx
Sun Mar 6 12:33:54 UTC 2016


Branch:      refs/heads/master
Author:      Thomas Martitz <kugel at rockbox.org>
Committer:   Thomas Martitz <kugel at rockbox.org>
Date:        Sun, 06 Mar 2016 12:33:54 UTC
Commit:      8786fee0797b1e1d3864a460bf4067f2e2a1aea0
             https://github.com/geany/geany-plugins/commit/8786fee0797b1e1d3864a460bf4067f2e2a1aea0

Log Message:
-----------
docs: update docs for the proxy plugin changes

Most importantly is the changed plugin directory.


Modified Paths:
--------------
    geanypy/README
    geanypy/doc/source/starting.rst
    geanypy/geany/plugin.py

Modified: geanypy/README
11 lines changed, 5 insertions(+), 6 deletions(-)
===================================================================
@@ -33,14 +33,13 @@ module more "Pythonic".
 To write a plugin, inherit from the ``geany.Plugin`` class and implmenent the
 required members (see ``geany/plugin.py`` documentation comments).  Then put the
 plugin in a searched plugin path.  Currently two locations are search for
-plugins.  The first is ``PREFIX/share/geany/geanypy/plugins`` and the recommended
+plugins.  The first is ``PREFIX/lib/geany`` and the recommended
 location is under your personal Geany directory (usually
-``~/.config/geany/plugins/geanypy/plugins``).  To load or unload plugins, click
-the Python Plugin Manager item under the Tools menu which will appear when you
-activate GeanyPy through Geany's regular plugin manager.
+``~/.config/geany/plugins``). To load or unload plugins, use Geany's regular Plugin
++Manager. Python plugins appear there once GeanyPy is activated.
 
-When the GeanyPy plugin is loaded, it has an option to add a new tab to 
-the notebook in the message window area that contains an interactive 
+When the Python Console plugin is enabled, it will add a new tab to the notebook in
+the message window area that contains an interactive Python shell with the `geany`
 Python shell with the ``geany`` module pre-imported.  You can tinker 
 around with API with this console, for example::
 


Modified: geanypy/doc/source/starting.rst
40 lines changed, 18 insertions(+), 22 deletions(-)
===================================================================
@@ -7,34 +7,30 @@ GeanyPy, it's important to note how it works and some features it provides.
 What the heck is GeanyPy, really?
 =================================
 
-GeanyPy is "just another Geany plugin", really.  Geany sees GeanyPy as any
-other `plugin <http://www.geany.org/manual/current/index.html#plugins>`_, so
-to activate GeanyPy, use Geany's
+GeanyPy is a proxy plugin. Geany initially sees GeanyPy as any other
+`plugin <http://www.geany.org/manual/current/index.html#plugins>`_, but
+GeanyPy registers some additional stuff that enables Geany to load python plugins
+through GeanyPy. So to activate, use Geany's
 `Plugin Manager <http://www.geany.org/manual/current/index.html#plugin-manager>`_
 under the Tools menu as you would for any other plugin.
 
-Once the GeanyPy plugin has been activated, a few elements are added to Geany's
-user interface as described below.
+Once the GeanyPy plugin has been activated, Geany should rescan the plugin
+directories and pick those up that are supported through GeanyPy. It'll integrate
+the python plugins into the Plugin Manager in an additional hierarchy level below
+GeanyPy.
 
-Python Plugin Manager
-=====================
+* [ ] Geany plugin 1
+* [x] GeanyPy
+ * [ ] Python plugin 1
+ * [x] Python plugin 2
+ * [ ] Python plugin 3
+* [ ] Geany plugin 3
 
-Under the Tools menu, you will find the Python Plugin Manager, which is meant
-to be similar to Geany's own Plugin Manager.  This is where you will activate
-any plugins written in Python.
+Remember that Geany looks in three places for plugins:
 
-The Python Plugin Manager looks in exactly two places for plugins:
-
-1. For system-wide plugins, it will search in PREFIX/share/geany/geanypy/plugins.
-2. In Geany's config directory under your home directory, typically ~/.config/geany/plugins/geanypy/plugins.
-
-Where `PREFIX` is the prefix used at configure time with Geany/GeanyPy (see
-the previous section, Installation).  Both of these paths may vary depending on
-your platform, but for most \*nix systems, the above paths should hold true.
-
-Any plugins which follow the proper interface found in either of those two
-directories will be listed in the Python Plugin Manager and you will be able
-to activate and deactivate them there.
+1. For system-wide plugins, it will search in (usually) /usr/share/geany or /usr/local/share/geany.
+2. In Geany's config directory under your home directory, typically ~/.config/geany/plugins.
+3. A user-configurable plugin directory (useful during plugin development).
 
 Python Console
 ==============


Modified: geanypy/geany/plugin.py
7 lines changed, 3 insertions(+), 4 deletions(-)
===================================================================
@@ -30,10 +30,9 @@ def cleanup(self):
 The guts of the API are exposed to plugins through the `geany` package and
 its modules.
 
-Plugins should be placed in either the system plugin directory (something
-like /usr/local/share/geany/geanypy/plugins) or in their personal plugin
-directory (something like ~/.config/geany/plugins/geanypy/plugins).  Only
-files with a `.py` extension will be loaded.
+Plugins should be placed in either the system plugin directory (something like
+/usr/local/lib/geany) or in the user plugin directory (something like
+~/.config/geany/plugins).  Only files with a `.py` extension will be loaded.
 """
 
 import keybindings



--------------
This E-Mail was brought to you by github_commit_mail.py (Source: https://github.com/geany/infrastructure).


More information about the Plugins-Commits mailing list