Hi to all,
I recently discovered that m2 includes a standard document format
"Almost Plain Text" that alleviates some of the burden of writing xdoc
documents. I am also a user of emacs and muse, the latter being a
hypermedia document publishing system developped by John Wiegley (more
on this at http://www.mwolson.org/static/doc/muse/).
muse uses a wiki-like syntax with advanced linking and publishing
functions. For a project I am working on, I developed a small style for
emacs-muse that transform muse format into xdoc format. This allows me
to write my doc in emacs, with syntax highlighting, hypermedia linking,
automatic footnotes, ... and produce xdoc document.
AFAIK, the apt format is close to muse in spirit, but differes greatly
in details and I was wondering if there is any possibility to modify the
format APT uses. I investigated slightly the idea based on Radeox wiki
engine : you could write your doc in any text-based format provided the
wiki engine has publishing rules corresponding to your format, then it
would publish xdoc or whatever during site buildup.
The added value of this scheme is that you could use some custom linking
functions to refer to other elements constructed by maven through
hyperlinks. For example, given the following fragment in my apt
... user can see [org.apache.maven.aptdoc.Plugin] for info ....
I would have the following rendered on the site :
... user can see <a
href="apidocs/org/apache/maven/aptdoc/Plugin.html> class Plugin</a> (<a
href="xref/org/apache/maven/aptdoc/Plugin.html>source</a>) for info ...
This is valid for PDF. The idea is to allow easy reference in
documentation to generated reports and data.
Is there anybody on this list working on something close to this or
interested in working on it ?
--
Arnaud Bailly - Ingénieur de Recherche
NORSYS
1, rue de la Cense des Raines
ZAC du Moulin
59710 ENNEVELIN
Tel : (33) 3 28 76 56 76
Fax : (33) 3 28 76 57 00
Web : http://www.norsys.fr
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
