There are certain constraints imposed on a documentation system which integrates with
Maven, the Maven inputs to the documentation system and the Maven outputs.
Also, we are talking about an integrated documentation system: Maven generated
documentation appears, can be referenced by, might reference, etc. user generated
documentation; the documentation has the same chrome; etc.

What are the current inputs? All of the build generated metrics and reporting
documentation which
are in XML (note: XML).

What are the current outputs? Among other things, integrated (referencing each other)
HTML pages and stylesheets.

So what might a pluggable DocSys look like? It takes a plugin for the input Maven
documentation
code that transforms the documentation into some common format  (if you use
some XML base scheme, then this is simply XML to XML or a no-op). It  has a plugin
that
takes the user generated documentation and transforms it into the common format. There
is a plugin
(the doc-mix-master) that takes the combined documentation, Maven and user,
and  mixes them together.
Lastly there is a plugin that transforms the combined documentation into an output
format,
e.g., HTML.

The output plugin might in fact be a poly-plugin, a plugin which is a container plugin
that has a list of
child plugins where each child plugin transforms the input documentation into a
different
output format).

A lot of plugins but maybe something like this would allow users to extend Maven's
documentation
subsystem if they wish.

Richard


--
To unsubscribe, e-mail:   <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>

Reply via email to