Project

General

Profile

ExtensionListInfo » History » Version 5

Mischa The Evil, 2009-08-15 00:48
Added a space.

1 1 Mischa The Evil
h1. Extension list information
2
3
h2. Redmine plugin list legend
4
5 2 Mischa The Evil
h3. Plugin list sample entry
6 1 Mischa The Evil
7
A sample of a complete pluginlist entry in Redmine syntax (where @<<@ and @>>@ are used as a replacement for the square brackets to prevent parsing by Redmine) looks like this:
8
9
<pre><code>h3. Budget plugin
10
11
* <<PluginBudget|Budget>> is a plugin to manage a set of deliverables for each project, automatically calculating key performance indicators.
12
** Author: "_Eric Davis_":http://www.redmine.org/account/show/5
13
** Latest release: _<code>0.2.0</code>, 2009-04-27_
14
** Compatible with: _Redmine 0.8.x & Redmine Trunk_
15
** Public SCM: _http://github.com/edavis10/redmine-budget-plugin/tree_
16
** Public ITS: _https://projects.littlestreamsoftware.com/projects/redmine-budget/issues_</code></pre>
17
18 2 Mischa The Evil
h3. Plugin list legend
19 1 Mischa The Evil
20
* Every plugin-entry starts with an heading @h3@
21
* This previous heading is followed by a bulleted list item containing a short description of the plugin starting with the name of the plugin which links to an annouchement on the Redmine.org forums or a dedicated wiki-page on Redmine.org
22 3 Mischa The Evil
* After the previous list item we now have several bulleted sub-list items containing:
23 1 Mischa The Evil
** the author of the plugin with a link to the Redmine.org profile page if the user is registered at Redmine.org
24 3 Mischa The Evil
** an optional field containing the active maintainer of the plugin, with a link to the Redmine.org profile page if the user is registered at Redmine.org, if the plugin is _mostly_ maintained by another person than the (initial) _author_
25 1 Mischa The Evil
** the latest release of the plugin plus it's release-date, where the release-date is the date of the latest commit if the plugin author does not provide packages or git-tags of releases ánd does not update the plugin-version after every commit
26
** the Redmine releases which the plugin is compatible with (currently the only two values filled-in are @0.8.x@ and @Trunk@, this could be insufficient for plugins which require a specific point-release of the @0.8.x@-branch (let's say @0.8.3@ (which brought several mailer-fixes IIRC)))
27 5 Mischa The Evil
** an optional field containing a list of conflicting plugins including a version-number in which the conflict occur (these fields should be added mutually)
28 1 Mischa The Evil
** a link to the public SCM(as in "Source Code Management") system for the plugin (if it exists, otherwise @n/a@)
29
** a link to the (dedicated, so no links to forum-threads on Redmine.org) public ITS(as in "Issue Tracking System") for the plugin (if it exists, otherwise @n/a@)
30
31
h2. Redmine theme list legend
32
33 2 Mischa The Evil
h3. Theme list sample entry
34 1 Mischa The Evil
35
A sample of a complete themelist entry in Redmine syntax (where @<<@ and @>>@ are used as a replacement for the square brackets to prevent parsing by Redmine) looks like this:
36
37
<pre><code>h3. Default theme
38
39
* <<ThemeDefault|Default>> the default Redmine theme (included).
40
** Author: "_Jean-Philippe Lang_":http://www.redmine.org/account/show/1
41
** Latest release: _<code>n/a</code>, 2009-07-10
42
** Compatible with: _Redmine 0.8.x & Redmine Trunk_
43
** Public SCM: _http://www.redmine.org/projects/redmine/repository/browse/trunk/public/stylesheets_
44
** Public ITS: _http://www.redmine.org/projects/redmine/issues_</code></pre>
45
46 2 Mischa The Evil
h3. Theme list legend
47 1 Mischa The Evil
48
* Every theme-entry starts with an heading @h3@
49
* This previous heading is followed by a bulleted list item containing a short description of the theme starting with the name of the theme which links to an annouchement on the Redmine.org forums or a dedicated wiki-page on Redmine.org
50 3 Mischa The Evil
* After the previous list item we now have several bulleted sub-list items containing:
51 1 Mischa The Evil
** the author of the theme with a link to the Redmine.org profile page if the user is registered at Redmine.org
52 3 Mischa The Evil
** an optional field containing the active maintainer of the theme, with a link to the Redmine.org profile page if the user is registered at Redmine.org, if the theme is _mostly_ maintained by another person than the (initial) _author_
53 1 Mischa The Evil
** the latest release of the theme plus it's release-date, where the release-date is the date of the latest commit if the theme author does not provide packages or git-tags of releases ánd does not update the theme-version after every commit
54
** the Redmine releases which the theme is compatible with (currently the only two values filled-in are @0.8.x@ and @Trunk@)
55
** a link to the public SCM(as in "Source Code Management") system for the theme (if it exists, otherwise @n/a@)
56
** a link to the (dedicated, so no links to forum-threads on Redmine.org) public ITS(as in "Issue Tracking System") for the theme (if it exists, otherwise @n/a@)