Sensible and common plugin metadata format
problem
Plugin metadata files can be more sensible and common to other plugin metadata files from other projects and to desktop files.
analysis
Current format: manifest.ini
[info]
name: GUI For Me
short_name: gui_for_me
version: 0.2
description: Gui for the '/me' command.
authors: BomberMan
copper
Denis Fomin \<fominde@...>
homepage: http://trac-plugins.gajim.org/wiki/GUIForMePlugin
max_gajim_version: 0.16.9
enhancement recommendation
Proposed format: gui_for_me.plugin
[Plugin]
Name=GUI For Me
ShortName=gui_for_me
IAge=0.2
Description=Gui for the '/me' command
Authors=BomberMan;copper;Denis Fomin \<fominde@@...>;
Copyright=Copyright © 2013 Denis Fomin \<fominde@...>
Website=http://trac-plugins.gajim.org/wiki/GUIForMePlugin
Bugs=https://trac-plugins.gajim.org/newticket?component=GUIForMePlugin&owner=dicson
MaxVersion=0.16.9
To explain the specified fields:
~~`Loader`: which loader gedit needs to use; for Python plugins this is python~~
~~`Module`: the file in which your plugin is located (leaving out the extension .py). You can also specify a directory here. As with normal Python applications you need to put a __init__.py in that directory~~
`IAge`: the plugin version, this is always 3
`Name`: the name of the plugin. This will show up in the plugins list in the preference dialog
`Description`: a short description of the plugin. This will show up in the plugins list in the preference dialog
`Authors`: a list of people who wrote the plugin. This will show up in the about dialog of the plugin (plugins list in the preference dialog)
`Copyright`: the plugins copyright. This will show up in the about dialog of the plugin (plugins list in the preference dialog)
`Website`: optionally, the plugins website
`ShortName`: ''(please complete)''
`Bugs`: optionally, the plugins bug reporting system
`MaxVersion`: ''(please complete)''