I've put together a little plugin for generating xdoc documentation from a
simple FAQ XML document. This basically means that you can enter a small
amount of information which then generates a question index with hypertext
links to the question and answers. This saves lots of redundant error-prone
typing maintaining an FAQ document. (Anyone who's ever tried to add to the
Maven FAQ will probably identify with this ;-).
The format is taken from the FAQ document used in Forrest (though without
the need for a DTD). I've attached a sample document to show you the idea
(there's one included in the plugin documentation).. An FAQ can have many
'parts' so that the FAQ gets divided into different sections. e.g. parts
could be 'general', 'installation', 'contributing' etc. The plugin generates
an FAQ page which shows an index of all the parts, the questions in each
part with hypertext links to the full section with the question & answer in
full.
This plugin works by taking a file (which defaults to xdocs/faq.fml) and
generating an xdoc file in target/generated-xdocs which is then styled by
the xdoc goal to be part of the website.
This plugin is optional (like the html2xdoc plugin) and can be enabled by
adding the following to your maven.xml
<preGoal name="xdoc:jelly-transform">
<attainGoal name="faq"/>
</preGoal>
A minor implementation note: I defaulted the file name to 'faq.fml' (fml =
Faq Markup Language) to differentiate the extension from .xml or .html which
might get picked up by other default goals in Maven.
It'd be a good idea to convert the Maven faq.xml to this format when we get
the time, unless there are any objections?
James
-------
http://radio.weblogs.com/0112098/
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
