On 2010-07-17 16.56, Niclas Hedhman wrote:
Hi,
Would it make sense to add some documentation via the source
repository instead of direct editing of SiteVision site? I am thinking
specifically of the Libraries and Extensions, and not so much of Core.
For instance; we could have a src/docs in each module, and if present
SiteVision will pick up and run an XSLT transformation against it and
place it on the component's SiteVision page. Or use some other format,
more easily editable then XML... Ideas?
It is possible to have docs in sourcecontrol, generate HTML on deploy,
and then point SiteVision to it using the Proxy Portlet (the portlet I
wrote in SiteVision which portletbridge.org is based on). The portlet
will "webclip" whatever you have in the docs into the SiteVision site,
with links and images.
So in general it would work. The problem is more towards what format and
generator you'll use. I've looked at XML/DocBook based generation
before, and decided against it. It's too clunky. I know Apache has a
simpler wiki-ish variant which might be a better choice.
I would be for doing something like that as well, since the current
setup isn't working (=noone does docs).
/Rickard
ps. References:
http://maven.apache.org/guides/mini/guide-site.html
http://maven.apache.org/doxia/references/apt-format.html
_______________________________________________
qi4j-dev mailing list
[email protected]
http://lists.ops4j.org/mailman/listinfo/qi4j-dev
