[Geany-devel] Usage of plugin_help()

Frank Lanitz frank at xxxxx
Tue Mar 6 08:19:54 UTC 2012

Hi folks,

I want to discuss shortly the expected behavior of
plugin_help()-function implemented by plugins. Inside API-documentation
its written:

> Called whenever the plugin should show its documentation (if any).
> This may open a dialog, a browser with a website or a local installed
> HTML help file(see utils_start_browser()) or something else. Can be
> omitted when not needed.

Well... which means its not really defined what the user will expect
once he push the button. Therefore we do have at least 2.5 major behaviors:
- Geany is calling a browser and opening a webpage with info (spellcheck
- Its opening a message window with
	* a short info about plugin (e.g. geanyLaTeX)
	* a long help text about plugin (e.g. geanymacro)
Question is, what do we really want to have behind that function?


-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 900 bytes
Desc: OpenPGP digital signature
URL: <http://lists.geany.org/pipermail/devel/attachments/20120306/45d034c9/attachment.pgp>

More information about the Devel mailing list