Javasrc, JXR and documentation
Clay, Do you have time for some documentation investigations? Some time ago, a project called Javasrc was in the process of migrating from SourceForge to Apache. Nicola Ken Barozzi [EMAIL PROTECTED] was the one who initiated the discussions with the Javasrc developers. The code was originally to go into Alexandria, a project on which development has now ceased. I recall some discussion about the use of Javasrc outside the context of Alexandria. There is an alternative, in the JXR plugin for Maven. Joerg may be of help here, as he seems to be a fan of Maven. My primary interest in this question is in generating cross-referenced source in html format, into which I can point from the web-site documentation. At the moment I have some html source that I generated using Xemacs, but that is extremely tedious. If you have time, could you ask a few questions about the best way of having such cross-referenced html sources generated as part of the process of web site creation? Peter -- Peter B. West http://www.powerup.com.au/~pbwest/resume.html
Re: Javasrc, JXR and documentation
I'm unsure if this is related to your question, but I think it would be nice for us to switch to Docbook. Apparently at least one Apache project, Tapestry, is already using it with Forrest [1][2]. We switched at work from RoboHelp HTML to Docbook and it has been great for us. Glen [1] http://wiki.docbook.org/topic/WhoUsesDocBook [2] http://jakarta.apache.org/tapestry/doc.html --- Peter B. West [EMAIL PROTECTED] wrote: Clay, Do you have time for some documentation investigations? Some time ago, a project called Javasrc was in the process of migrating from SourceForge to Apache. Nicola Ken Barozzi [EMAIL PROTECTED] was the one who initiated the discussions with the Javasrc developers. The code was originally to go into Alexandria, a project on which development has now ceased. I recall some discussion about the use of Javasrc outside the context of Alexandria. There is an alternative, in the JXR plugin for Maven. Joerg may be of help here, as he seems to be a fan of Maven. My primary interest in this question is in generating cross-referenced source in html format, into which I can point from the web-site documentation. At the moment I have some html source that I generated using Xemacs, but that is extremely tedious. If you have time, could you ask a few questions about the best way of having such cross-referenced html sources generated as part of the process of web site creation? Peter -- Peter B. West http://www.powerup.com.au/~pbwest/resume.html
Re: Javasrc, JXR and documentation
Peter, On Jun 8, 2004, at 7:15 AM, Peter B. West wrote: Clay, Do you have time for some documentation investigations? Some time ago, a project called Javasrc was in the process of migrating from SourceForge to Apache. Nicola Ken Barozzi [EMAIL PROTECTED] was the one who initiated the discussions with the Javasrc developers. The code was originally to go into Alexandria, a project on which development has now ceased. I recall some discussion about the use of Javasrc outside the context of Alexandria. There is an alternative, in the JXR plugin for Maven. Joerg may be of help here, as he seems to be a fan of Maven. My primary interest in this question is in generating cross-referenced source in html format, into which I can point from the web-site documentation. At the moment I have some html source that I generated using Xemacs, but that is extremely tedious. If you have time, could you ask a few questions about the best way of having such cross-referenced html sources generated as part of the process of web site creation? Peter -- Peter B. West http://www.powerup.com.au/~pbwest/resume.html I'd be happy to do some research on this subject. I'll look into this and see what i can dig up. Before I spend time on this, it might make more sense to look into Docbook, as Glen mentioned. In addition, it would be good to spend some time checking out what other Apache projects are using for ideas. I would suspect that the most-used documentation system(s) would bear the most fruit for us. If for no other reason, than the sheer numbers of people banging on them. I assume we already have a system (I think it's Javadocs). I think it would also be good to determine if any of our colleagues have made the switch from our system to another. Finally, assuming we've already got a system, what are the reasons we're moving away from our current system? Complexity? Dead-end product? Etc. Web Maestro Clay
