Hey,
I just thought about how external plugins could/should install their documentation files[1], if any.
The usual location would be $prefix/share/doc/pluginname but I think with multiple plugins installed, this could clutter up the doc directory a little bit. At least when the plugins are installed in a global default prefix like /usr. Then users end up with something like
/usr/share/doc/externdbg /usr/share/doc/geanylatex /usr/share/doc/geanyvc /usr/share/doc/spellcheck
Especially for plugins which are not prefixed by 'geany' (which is by no means necessary IMO) this could be ugly, especially when plugins are packaged by distributions. (currently the geanylua plugin installs documentation in $prefix/share/doc/geany/ which is even worse, plugins should not install anything into Geany's doc or datadir)
So, my suggestion would be to make a recommendation for plugin authors to install documentation files into $prefix/share/doc/geany-plugins/${pluginname}
example: /usr/share/doc/geany-plugins/externdbg /usr/share/doc/geany-plugins/geanylatex /usr/share/doc/geany-plugins/geanyvc /usr/share/doc/geany-plugins/spellcheck
This way, the global doc dir won't be cluttered so much and plugin documentation files will be installed together in a common directory.
What do you think?
[1] Documentation files mean not only some kind of user documentation but also the usual README, AUTHORS, COPYING, ... files.
Regards, Enrico
On Mon, 26 Jan 2009 21:25:43 +0100 Enrico Tröger enrico.troeger@uvena.de wrote:
What do you think?
As possible option: $prefix/share/doc/geany/plugins/${pluginname}
Am Montag, den 26.01.2009, 23:37 +0200 schrieb Yura Siamashka:
On Mon, 26 Jan 2009 21:25:43 +0100 Enrico Tröger enrico.troeger@uvena.de wrote:
What do you think?
As possible option: $prefix/share/doc/geany/plugins/${pluginname}
I like this idea.
Regards,
On Mon, 26 Jan 2009 23:37:30 +0200 Yura Siamashka yurand2@gmail.com wrote:
On Mon, 26 Jan 2009 21:25:43 +0100 Enrico Tröger enrico.troeger@uvena.de wrote:
What do you think?
As possible option: $prefix/share/doc/geany/plugins/${pluginname}
I agree. Sounds good.
Cheers, Frank
Frank Lanitz wrote:
On Mon, 26 Jan 2009 23:37:30 +0200 Yura Siamashka yurand2@gmail.com wrote:
On Mon, 26 Jan 2009 21:25:43 +0100 Enrico Tröger enrico.troeger@uvena.de wrote:
What do you think?
As possible option: $prefix/share/doc/geany/plugins/${pluginname}
I agree. Sounds good.
Cheers, Frank
+1
Let's do :)
On Mon, 26 Jan 2009 21:25:43 +0100 Enrico Tröger enrico.troeger@uvena.de wrote:
(currently the geanylua plugin installs documentation in $prefix/share/doc/geany/ which is even worse, plugins should not install anything into Geany's doc or datadir)
So, my suggestion would be to make a recommendation for plugin authors to install documentation files into $prefix/share/doc/geany-plugins/${pluginname}
I think this is best for any plugins hosted in the geany-plugins project.
Any plugins outside of it or any plugins that want to be independent should IMO call their plugin geany-some-plugin (unix-name), installing to $prefix/share/doc/geany-some-plugin. Alternatively geanysomeplugin, but the hyphen-separated one seems to fit better with distro package names IME.
Probably the same should be true for any plugin data files (without the doc subdirectory).
Regards, Nick
On Tue, 27 Jan 2009 17:33:19 +0000, Nick Treleaven nick.treleaven@btinternet.com wrote:
On Mon, 26 Jan 2009 21:25:43 +0100 Enrico Tröger enrico.troeger@uvena.de wrote:
(currently the geanylua plugin installs documentation in $prefix/share/doc/geany/ which is even worse, plugins should not install anything into Geany's doc or datadir)
So, my suggestion would be to make a recommendation for plugin authors to install documentation files into $prefix/share/doc/geany-plugins/${pluginname}
I think this is best for any plugins hosted in the geany-plugins project.
Ok, at least one agrees with me :). Yura's suggestion: $prefix/share/doc/geany/plugins/${pluginname}
is somewhat the counterpart to the intention of this discussion as I wanted to get rid of polluting Geany's docdir by external stuff. IMO, nothing should install anything into another package's docdir and instead should use something unique. The problem is that the global docdir is already crowded on most systems, so adding an own docdir for each plugin would probably make things only worse thus my suggestion to use a $prefix/share/doc/geany-plugins/ "container" to collect there the docs of the different plugins (of the geany-plugins project) in a sub directory for each plugin, as shown in my first mail.
Anyway, as the subject says RFC, this is a discussion and if you all still want to put plugin doc files in Geany's docdir, hmm, ok.
Any plugins outside of it or any plugins that want to be independent should IMO call their plugin geany-some-plugin (unix-name), installing to $prefix/share/doc/geany-some-plugin. Alternatively geanysomeplugin, but the hyphen-separated one seems to fit better with distro package names IME.
Yes, exactly.
Probably the same should be true for any plugin data files (without the doc subdirectory).
Yes.
Regards, Enrico
On Tue, 27 Jan 2009 19:57:01 +0100 Enrico Tröger enrico.troeger@uvena.de wrote:
Anyway, as the subject says RFC, this is a discussion and if you all still want to put plugin doc files in Geany's docdir, hmm, ok.
Please consider implementing "Help" button in plugin manager dialog, it will be more easy if documentation is placed in one place.
On Wed, 28 Jan 2009 09:44:43 +0200, Yura Siamashka yurand2@gmail.com wrote:
On Tue, 27 Jan 2009 19:57:01 +0100 Enrico Tröger enrico.troeger@uvena.de wrote:
Anyway, as the subject says RFC, this is a discussion and if you all still want to put plugin doc files in Geany's docdir, hmm, ok.
Please consider implementing "Help" button in plugin manager dialog,
this is a good idea. Not sure whether we will get to it in time before the 0.16 release but I think it's worth adding it.
it will be more easy if documentation is placed in one place.
Though this doesn't change anything on the original topic. I guess beside me and Nick, the others still would prefer the plugins docdir in Geany's docdir?
And of course, this is all optional, nobody is forced to do anything in the way we want, my intention was just to find a recommendation,
Regards, Enrico
Enrico Tröger wrote:
Though this doesn't change anything on the original topic. I guess beside me and Nick, the others still would prefer the plugins docdir in Geany's docdir?
And of course, this is all optional, nobody is forced to do anything in the way we want, my intention was just to find a recommendation,
Regards, Enrico
I'm fine with your very first suggestion too :)
On Wed, 28 Jan 2009 16:28:33 +0100, Enrico Tröger enrico.troeger@uvena.de wrote:
On Wed, 28 Jan 2009 09:44:43 +0200, Yura Siamashka yurand2@gmail.com wrote:
On Tue, 27 Jan 2009 19:57:01 +0100 Enrico Tröger enrico.troeger@uvena.de wrote:
Anyway, as the subject says RFC, this is a discussion and if you all still want to put plugin doc files in Geany's docdir, hmm, ok.
Please consider implementing "Help" button in plugin manager dialog,
this is a good idea. Not sure whether we will get to it in time before the 0.16 release but I think it's worth adding it.
Just did so. There is a new plugin symbol: void plugin_help(); which can be implemented by plugins. If a plugin implements it, the new Help button next to the Configure button in the plugin manager dialog becomes active and on click, plugin_help() is executed.
Regards, Enrico
On Wed, 28 Jan 2009 20:38:01 +0100 Enrico Tröger enrico.troeger@uvena.de wrote:
Just did so. There is a new plugin symbol: void plugin_help(); which can be implemented by plugins. If a plugin implements it, the new Help button next to the Configure button in the plugin manager dialog becomes active and on click, plugin_help() is executed.
Cool, you are really fast.
On Wed, 28 Jan 2009 16:28:33 +0100 Enrico Tröger enrico.troeger@uvena.de wrote:
Though this doesn't change anything on the original topic. I guess beside me and Nick, the others still would prefer the plugins docdir in Geany's docdir?
Actually I am not all for Geany's docdir.
So my suggestion:
$prefix/share/doc/geany/plugins/${pluginname} should be used for plugins shipped with Geany: $prefix/share/doc/geany-plugins/${pluginname} should be used for all external plugins (both geany-plugins project and external ones).
On Wed, 28 Jan 2009 21:51:54 +0200, Yura Siamashka yurand2@gmail.com wrote:
On Wed, 28 Jan 2009 16:28:33 +0100 Enrico Tröger enrico.troeger@uvena.de wrote:
Though this doesn't change anything on the original topic. I guess beside me and Nick, the others still would prefer the plugins docdir in Geany's docdir?
Actually I am not all for Geany's docdir.
So my suggestion:
$prefix/share/doc/geany/plugins/${pluginname} should be used for plugins shipped with Geany: $prefix/share/doc/geany-plugins/${pluginname} should be used for all external plugins (both geany-plugins project and external ones).
Cool, this is exactly what I (tried to) suggested originally :).
Regards, Enrico
Enrico Tröger wrote:
On Wed, 28 Jan 2009 21:51:54 +0200, Yura Siamashka yurand2@gmail.com wrote:
Actually I am not all for Geany's docdir.
So my suggestion:
$prefix/share/doc/geany/plugins/${pluginname} should be used for plugins shipped with Geany: $prefix/share/doc/geany-plugins/${pluginname} should be used for all external plugins (both geany-plugins project and external ones).
Cool, this is exactly what I (tried to) suggested originally :).
Regards, Enrico
+1. Let's do! :D
PS: Sorry for my confusion, I got the very first suggestion of Enrico entirely wrong :/
On Mi, 2009-01-28 at 21:21 +0100, Thomas Martitz wrote:
Enrico Tröger wrote:
On Wed, 28 Jan 2009 21:51:54 +0200, Yura Siamashka yurand2@gmail.com wrote:
Actually I am not all for Geany's docdir.
So my suggestion:
$prefix/share/doc/geany/plugins/${pluginname} should be used for plugins shipped with Geany: $prefix/share/doc/geany-plugins/${pluginname} should be used for all external plugins (both geany-plugins project and external ones).
Cool, this is exactly what I (tried to) suggested originally :).
Regards, Enrico
+1. Let's do! :D
+2 ;)
Regards,
On Mon, 26 Jan 2009 21:25:43 +0100, Enrico Tröger enrico.troeger@uvena.de wrote:
Hey,
I just thought about how external plugins could/should install their documentation files[1], if any.
The usual location would be $prefix/share/doc/pluginname but I think with multiple plugins installed, this could clutter up the doc directory a little bit. At least when the plugins are installed in a global default prefix like /usr. Then users end up with something like
I just added a few notes to the plugin API documentation regarding installation paths:
http://www.geany.org/manual/reference/guidelines.html
Feel free to comment on this and/or send any improvements.
Regards, Enrico