From: Kal A. <ka...@te...> - 2004-09-10 20:30:44
|
Hi all, I've been updating the TopicMapDoclet code a bit to try and get a useful approximation of the standard Javadoc out of it. What I have so far I have integrated into the website build and uploaded. If you go to http://www.tm4j.org/tm4j-engine.html or http://www.tm4j.org/x1k1pbb6tr-0.html (hmmm, that needs to be changed really... :), you will see that the topics for those pages are now associated with topics for the packages that the application provides (listed under the header "Contains" in the right-hand bar). Clicking on one of those takes you into the Javadoc-alike topic map stuff. What makes this quite fun is that there is tight integration with the documentation (see http://www.tm4j.org/dg-N1050D.html - scroll down or use the left-hand menu to see the related resources) thanks to the topic map generated from the Developer's Guide docbook source. Also because the topic maps from the separate projects get merged together, where a method in Panckoucke uses a class from TM4J, the Javadoc-alike pages are actually linked together (unlike when you have the standard javadoc documentation that can only link together all the classes processed in a single run). There is still a bit of work to be done in tidying up and I think that some features of standard Javadoc are still missing, but any thoughts and comments or suggestions for the layout would be appreciated. I also want to get a whole bunch of FAQs together and topic map them to integrate them with the site and class documentation. So any suggestions for questions (and answers) would also be welcome. I'll be checking in the changes and the TM4Web/Velocity templates that made all this happen over the weekend. But right now I need some more coffee ;-) Cheers, Kal -- Kal Ahmed <ka...@te...> techquila |
From: Christoph F. <cf...@fo...> - 2004-09-11 18:59:00
|
Hi kal, this is really promising, especially the integration of the two very different sources, api-docs and prose-documentation. Congratulations. I looked in tm4j-cvs to find resources about how you are creating the topicmap (topicmaps?) that the tm4j-site is built from, but the only thing I found was tm4j/resources/topicmaps/sitemap/ where you seem to store the 'ontologies'. Are your scripts (I assume there are some scripts) that create the topicmaps available anywhere on tm4j-cvs? I'm asking because I would like to add some info concerning tmnav and panckoucke and I'm looking for a good point to start. Bye c Am Fr, den 10.09.2004 schrieb Kal Ahmed um 22:28: > Hi all, > > I've been updating the TopicMapDoclet code a bit to try and get a useful > approximation of the standard Javadoc out of it. What I have so far I > have integrated into the website build and uploaded. If you go to > http://www.tm4j.org/tm4j-engine.html or > http://www.tm4j.org/x1k1pbb6tr-0.html (hmmm, that needs to be changed > really... :), you will see that the topics for those pages are now > associated with topics for the packages that the application provides > (listed under the header "Contains" in the right-hand bar). Clicking on > one of those takes you into the Javadoc-alike topic map stuff. > > What makes this quite fun is that there is tight integration with the > documentation (see http://www.tm4j.org/dg-N1050D.html - scroll down or > use the left-hand menu to see the related resources) thanks to the topic > map generated from the Developer's Guide docbook source. Also because > the topic maps from the separate projects get merged together, where a > method in Panckoucke uses a class from TM4J, the Javadoc-alike pages are > actually linked together (unlike when you have the standard javadoc > documentation that can only link together all the classes processed in a > single run). > > There is still a bit of work to be done in tidying up and I think that > some features of standard Javadoc are still missing, but any thoughts > and comments or suggestions for the layout would be appreciated. > > I also want to get a whole bunch of FAQs together and topic map them to > integrate them with the site and class documentation. So any suggestions > for questions (and answers) would also be welcome. > > I'll be checking in the changes and the TM4Web/Velocity templates that > made all this happen over the weekend. But right now I need some more > coffee ;-) > > Cheers, > > Kal -- Christoph Froehlich <cf...@fo...> |
From: Kal A. <ka...@te...> - 2004-09-12 21:06:14
|
Hi Cristoph On Sat, 2004-09-11 at 19:57, Christoph Froehlich wrote: > Hi kal, > > this is really promising, especially the integration of the two very > different sources, api-docs and prose-documentation. Congratulations. > Thanks! > I looked in tm4j-cvs to find resources about how you are creating the > topicmap (topicmaps?) that the tm4j-site is built from, but the only > thing I found was tm4j/resources/topicmaps/sitemap/ where you seem to > store the 'ontologies'. I still need to check some things into CVS. The docbook source was transformed by an XSLT stylesheet which I *think* is checked in to CVS - look in resources and under the docbook directory there should be an xtm subdirectory - that has the stylesheet in it. The API documentation is, of course, generated with the TopicMapDoclet that is part of TM4J. The other "structural" stuff that describes the main site navigation and the release versions of the different packages are all contained in the CVS module named website. The site is then generated using TM4Web/Velocity - the templates are all part of the website module too. I'll tidy up what I've been using and check stuff into CVS tomorrow or the day after - I'll post another message when I think I have got everything checked in. Cheers, Kal -- Kal Ahmed <ka...@te...> techquila |