Ross Gardler wrote:
> Plugin docs should be versioned.
I agree for all the reasons you have mentioned.
> Different plugin releases may work in different versions of Forrest. For
> example, Daisy 0.1 works in 0.7, but 0.2 will not work in 0.7 Forrest
> because it relies on the locationmap.
Yet I don't think that they should be part of Forrests versioned
info for several reasons:
- Forrest and Plug-ins each have their own release cylces and we may well
have a number of new plug-in versions during one Forrest release.
So even though there is a relation between plug-in and Forrest
version, it is of the kind
Plugin X.Y.Z works with Forrest A.B.C
and neither direct nor permanent.
- Because of this, there will be frequent updated of plug-in
information while we will have very little of non changes at all to
the docs about past releases.
> There are maor changes in the way
> it is used and so the docs need to be kept separate.
No problem there. I'd just solve it differently and have a general
access point through the PlugIn-Tab and deal with different versions
either by
- having versioned sub tabs (in the Plug-In Tab) that lead to the version
specific list of
plug-ins and detailed info below that or
- have a non versioned top level menu of all plug-ins and versioned
submenus with the details below that.
Ideal would be a combination of these for different access to the info
like
Tab: PlugIns
Subtabs: [All] [Forrest 0.7] [Forrest 0.8] ...
Menus: Showing all or just that versions plug-ins depending on which
subtab is selected.
> Besides, these documents are auto published so just moving them in SVN
> will not help, next time the plugin is deployed the updated documets
> will go into the vesioned location again.
A far as I understand the sitemap the list of plug-ins is generated
dynamically here
<map:match pattern="docs/plugins/index.xml">
<map:aggregate element="pluginList">
<map:part src="{forrest:plugins-src}/plugins.xml"/>
<map:part
src="{forrest:whiteboard-plugins-src}/whiteboard-plugins.xml"/>
</map:aggregate>
<map:transform src="{forrest:stylesheets}/plugins2xdoc.xsl"/>
<map:serialize type="xml"/>
</map:match>
and works fine as long as the virtual index.html is in that
docs-directory. So everything works fine right now.
If there is new stuff I haven't had time to look at, lets talk about
how we can fix that.
Ferdinand
--
Ferdinand Soethe
