Ugo,
I don't know if this would fit your near term goal, but I *really* like
DocBook for this sort of task; combined with the standard XSLT
distribution, it can generate top-notch output in multiple formats. The
Velocity project has a DocBook based sub-project based around a custom
ant task, which lets you generate customizable output, using the DocBook
project's own XSLT distribution. I haven't looked deep enough into it
to see whether one could integrate the DBF (as they call it) directly
into the project, but it doesn't seem to me like that's outside the
realm of possibility.
The only real hitch with DocBook, besides learning the schema, is
authoring. I believe this is not much of a problem for whoever would be
generating the documentation for Abdera =)
Velocity DocBook Framework: http://velocity.apache.org/docbook/
XXE: [ Free-beer-for-OSS-projects DocBook editor]
http://www.xmlmind.com/xmleditor/persoedition.html
cheers,
AC
Ugo Cei wrote:
Suppose one wanted to write some documentation for Abdera, how would one
proceed?
To be more specific, I see we have a website in site/trunk, but that's
just a bunch of HTML files that follow a common template by duplicating
headers, menus and footers. Keeping those updated by hand is not really
a maintainable option.
How do you suggest that we approach the issue of maintaining docs? This
is not a hypothetical question: as I'll be on vacation for a couple
weeks, starting tomorrow, I was thinking of doing some badly needed
documentation work.
Ugo
