[Padre-dev] localizing plugin documentation
Jerome Quelin
jquelin at gmail.com
Tue Apr 28 10:02:51 PDT 2009
hi,
now that we can localize plugins, i definitely think that plugin manager
should display a localized documentation on the right pane, instead of
just the plugin pod.
especially if we decide to translate the plugin name and the plugin menu
entry.
to achieve this, i can imagine that we extend the plugin api with
plugin_documentation()
which would return a hash:
author => 'A. U. Thor <foo at example.com>',
description => Wx::gettext(...),
how_to_use => Wx::gettext(...),
copyright => 'Copyright (c) ...',
license => Wx::gettext('You can redistribute this plugin ...'),
etc.
(or whatever fields, i don't really care)
and plugin manager would then display this.
if no plugin_documentation() method is found, then the html-ized pod
would be displayed instead, just as is done currently.
note that it might be a good idea to allow html in the hash values, to
allow plugin author to pimp up its doc. but in this case, i don't know
how translators will cope with this.
==> wdyt?
jérôme
--
jquelin at gmail.com
More information about the Padre-dev
mailing list