SF.net SVN: geany-plugins:[2184] trunk/geany-plugins/devhelp

Tue Aug 30 01:11:28 UTC 2011

Revision: 2184
          http://geany-plugins.svn.sourceforge.net/geany-plugins/?rev=2184&view=rev
Author:   codebrainz
Date:     2011-08-30 01:11:28 +0000 (Tue, 30 Aug 2011)
Log Message:
-----------
Devhelp: Review and update plugin documentation files.

Modified Paths:
--------------
    trunk/geany-plugins/devhelp/AUTHORS
    trunk/geany-plugins/devhelp/NEWS
    trunk/geany-plugins/devhelp/README

Modified: trunk/geany-plugins/devhelp/AUTHORS
===================================================================

--- trunk/geany-plugins/devhelp/AUTHORS	2011-08-28 20:12:29 UTC (rev 2183)
+++ trunk/geany-plugins/devhelp/AUTHORS	2011-08-30 01:11:28 UTC (rev 2184)
@@ -1 +1 @@
-Matthew Brush <mbrush at leftclick.ca>
+Matthew Brush <mbrush at codebrainz.ca>

Modified: trunk/geany-plugins/devhelp/NEWS
===================================================================
--- trunk/geany-plugins/devhelp/NEWS	2011-08-28 20:12:29 UTC (rev 2183)
+++ trunk/geany-plugins/devhelp/NEWS	2011-08-30 01:11:28 UTC (rev 2184)
@@ -0,0 +1,16 @@
+Version 0.21
+------------
+
+	- Add support for searching Manual pages (if `man` program is available).
+	- Add support for search Google Code and loading the results into the
+	  embedded WebKit browser.
+	- Code cleanups, bug fixes and refactoring.
+
+
+
+Initial Release - Post 0.20
+---------------------------
+
+	- Add the Devhelp plugin which integrates Devhelp user-interface directly
+	  into Geany's user-interface, allowing to jump directly to relevant
+	  GTK-DOC documentation from a selected symbol.

Modified: trunk/geany-plugins/devhelp/README
===================================================================
--- trunk/geany-plugins/devhelp/README	2011-08-28 20:12:29 UTC (rev 2183)
+++ trunk/geany-plugins/devhelp/README	2011-08-30 01:11:28 UTC (rev 2184)
@@ -7,12 +7,12 @@
 About
 =====
 
-This plugin uses libdevhelp to integrate Devhelp UI components and 
-functionality directly into Geany's user interface.  In case you didn't know,
-Devhelp is an API documentation browser mainly aimed at GNOME-related libraries,
-although there are Devhelp books for a wide range of library APIs.  Check your
-package manager and/or Google and you should have no trouble finding books that
-can be viewed with Devhelp.
+This plugin embeds an API documentation browser and search functionality
+directly into Geany's user interface.  In case you didn't know, Devhelp is an
+API documentation browser mainly aimed at GNOME-related libraries, although
+there are Devhelp books for a wide range of library APIs.  Check your package
+manager and/or Google and you should have no trouble finding books that can
+be viewed with Devhelp.
 
 Usage
 =====
@@ -23,37 +23,71 @@
 When you load the plugin, two things are added to Geany's UI.  The first is a
 new tab labeled 'Devhelp' in the Sidebar notebook.  Inside this notebook page
 are two sub-tabs; Contents and Search.  Contents lets you browse all of the
-books at once and see their table of contents in a tree view.  Search, not 
+books at once and see their table of contents in a tree view.  Search, not
 surprisingly lets you search all of the books for a search term.  The second
-UI element that gets added to Geany is the 'Documentation' tab.  Depending on
-your preference choice, this new tab is either found in the main area, where
-it will be next to a new tab called 'Code' which now holds the existing
-documents tabs.  If you choose to, you can also have the 'Documentation' tab
-appear in the bottom message area, allowing you to see the documentation and
-your code at the same time.  There is also a preference for whether you want
-to move the main Sidebar tabs to the bottom position or leave them at your 
-previously selected location.
+UI element that gets added to Geany is the 'Documentation' tab.  This new tab
+is added in the main area, where it will be next to a new tab called 'Code'
+which now holds the existing documents tabs.
 
 Keybindings
 -----------
 
-There are three keybindings that can be set using the Geany Preferences dialog.
-The first keybinding is called 'Toggle Devhelp (Contents Tab)' and it will
-activate the Devhelp tab in the Sidebar and it's Contents sub-tab.  The second
-keybinding is called 'Toggle Devhelp (Search Tab)' and does the same thing
-but with the Search tab.  The third keybinding is called 'Search for Current 
-Symbol/Tag' and when activate it will take the word/symbol where the cursor is
-in the current document and search for it, activating both the Devhelp Sidebar
-tab and the Documentation tab for you.
+There are several keybindings available when the Devhelp plugin is loaded to
+make it faster to access documentation.  The following keybindings are
+available:
 
+Toggle sidebar contents tab
++++++++++++++++++++++++++++
+
+Activates the "Contents" tab under the Devhelp sidebar tab.  The previous tab
+will be saved so that when this keybinding is fired again, the previous tab
+selection will be activated.
+
+Toggle sidebar search tab
++++++++++++++++++++++++++
+
+Just like the previous keybinding but with the "Search" tab.
+
+Toggle documentation tab
+++++++++++++++++++++++++
+
+Flips between the main documentation viewer and your current code.
+
+Search for current tag in Devhelp
++++++++++++++++++++++++++++++++++
+
+While coding in the editor, the current tag, that is, the word that is
+nearest to the cursor that looks like a programming symbol, or the current
+selection, can be search for quickly by activating this keybinding.  Once
+activated, the Devhelp books repository on your system will be searched for
+the current tag and if an exact match is found, it will be loaded into the
+documentation view and the view will be made active.
+
+Search for current tag in Manual pages
+++++++++++++++++++++++++++++++++++++++
+
+Like the previous keybinding, but rather than searching Devhelp books, the
+systems manual pages will be searched, assuming a `man` program is available.
+The manual page sections will be searched in the order most likely to yield
+manual pages relevant to programming.  For example, a search for `mkdir` should
+locate the `mkdir()` function from section 2 before it finds the `mkdir` shell
+utility in section 1.
+
+Search for current tag in Google Code Search
+++++++++++++++++++++++++++++++++++++++++++++
+Like the previous two keybindings, except that a search will be performed
+online using Google's Code Search service.  The search results page will be
+displayed in the documentation view.
+
 Context Menu
 ------------
 
-There's one more way to invoke a search for the current symbol.  If you right
-click on the current document, on a tag/symbol you want help on, the context
-menu that appears will have an item called 'Search Devhelp for "foo"...",
-which, when activated, will do the same thing as the 'Search for Current
-Symbol/Tag' keybinding explained above.
+There's also another way to invoke a search for the current symbol for our
+mouse loving friends out there.  If you right click on the current document,
+on a tag/symbol you want help on, the context menu that appears will have an
+menu called `Search for "Foo" documentation in`.  Under this menu are 3 items
+for the searches discussed under the `Keybindings` section which, when
+activated, will perform the same searches as described above.
 
 Downloads
 =========
@@ -65,7 +99,7 @@
 Development Code
 ================
 
-Get the code from:
+You can checkout the latest development code from SVN using:
 
     svn checkout http://geany-plugins.svn.sourceforge.net/svnroot/geany-plugins/trunk/geany-plugins
 
@@ -73,13 +107,56 @@
 Dependencies
 ============
 
-The Devhelp plugin depends on 'libdevhelp-1.0' and 'webkit-1.0', on top of the
-regular Geany depenedencies (ie glib-2.0, gtk+-2.0, etc).
+The Devhelp plugin depends on a few critical libraries, including:
 
+Geany and GTK+/GLib
+-------------------
+
+Of course these go without saying as you won't be able to run the plugin
+without Geany and you won't be able to run Geany without GTK+/GLib.  The plugin
+should work with any modern version of GTK+/GLib greater than 2.16, as long
+as it's supported by Geany (ie. not GTK+ 3 yet).
+
+Devhelp Library
+---------------
+
+The Devhelp library is a bit of a moving target as far as versions go.  Just
+like most GNOME projects, little effort is put into maintaing previous versions
+of the library once a new version is released.  The Geany Devhelp plugin
+supports the 1.0 or 2.0 series of libdevhelp, as long as their versions are
+greater than or equal to 2.30.1 or 2.32.0, respectively.  Unless you're using
+a GTK+ 3.0 version of Devhelp (the latest), pretty much any recent version
+should be supported.
+
+Hint:  If you're on a Debian-based distro (and probably others), the package
+needed will be called `libdevhelp-<version>-dev`.
+
+WebKit
+------
+
+The Devhelp plugin uses the awesome WebKit GTK+ widget to display documentation
+in.  You will need at least version 1.1.18 of the 1.0 series of WebKit to
+build the Devhelp plugin.  If you can compile the `Webhelper` plugin, which
+is also a part of the combined Geany plugins package, you should have
+everything needed to satisfy this dependency.
+
+Hint: If you're on a Debian-based distro (and probably others), the package
+needed will be called `libwebkitgtk-<version>-dev`.
+
+See Also
+========
+
+If you'd rather have your documentation opened in a separate window, not
+integrated into Geany's user-interface, make sure to check out the `GeanyDoc`
+plugin, which is also a part of the combined Geany plugins package.  This
+plugin will let you execute external commands with the current word (or
+interactively) to view documentation.  See the plugin's documentation for more
+information.
+
 License
 =======
 
-The Devhelp plugin is distributed under the terms of the GNU General Public 
+The Devhelp plugin is distributed under the terms of the GNU General Public
 License as published by the Free Software Foundation, either version 3 of the
 License, or (at your option) any later version. You should have received a copy
 of the GNU General Public License along with the Devhelp plugin, in the COPYING

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.


