Danny Angus wrote:
Hes,
I have a template that transforms this to xdoc format as expected. ItSounds great.
works quite well already!
Thanks! I'll work on it a little bit before I post a proposal.
It's a bit tedious to copy the original xdocs file back to the xdoclet
template, but it may be worth the trouble.
I think it would be worth it.
OK, if we can make a shared effort it can probably be done quite quickly.
I haven't got any experience of xdoclet, apart from watching it in action, but I think this is the way to go.
My plan for docs is that
1/ we have the website as a seperate "component" managed independantly
2/ the release manager is responsible for also building docs for the
release version (no need for this to involve more than an extra commit of
the generated docs)
3/ docs will be published under version label directories so that we can
have multiple doc sets live at once, say "stable" and "head"
4/ historic docs would still be available in downloads or split downloads
into src, bin , & doc
Good plan!
It's important that the web site points you to the documentation of the current release.
Do I understand correctly that the proposed James release process will make sure that this happens?
Also, if you have version label directories, the documentation of all versions can be browsed online, right?
This means that xdoclet would be a great way of documenting mailets &I guess it's always there are always difficult cases to decide what is exactly 'web site' and what is 'product documentation'.
matchers, but also means that we would separate website from product docs
so that we could move towards a "manual" style rather than a web-site
style, for the product docs. I think Ant is a good example of what I'm
thinking.
So if I understand it correctly, you are saying that you have a web site, apart from the product, that points to (various versions of) the product documentation online. The product documentation is also included in the download. The product documentation is maintained in SVN along with the code, while the web site is maintained somewhere else.
I am all for it. Maintaining code & documentation in the same file is a Good Thing!We might even find it worthwhile using xdoclet for documenting more components which implement public interfaces, such as processor, mail repository, and protocol handler.
WDYT?
We can use xdoclet for that.
Cheers,
Hes.
d.
(p.s. it might be better to move this discussion to [EMAIL PROTECTED])
Ehm, let me know... currently I am on user and developer only.
--------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
