Dirk Reiners wrote: > Hi Allen, > >On Thu, 2006-09-07 at 21:08 -0500, Allen Bierbaum wrote: > > >>A couple of questions: >> >>- Where should we get to work (1.8 or 2.0): >> >>See: >>http://opensg.vrsource.org/trac/wiki/FutureOfOpenSg#Question:ShouldthisbedoneonOpenSG2.0orOpenSG1.8 >> >>I propose that we do pursue all the new documentation, examples, >>organization, etc with the 2.0 development. What does everyone else think? >> >> > >My opinion: 2.0. I'm not happy about all the work being done on 1.8, but >people need it for projects, so there's not much I can about it. > > > >>- What are we doing to do for user/developer guide documentation? Will >>it be wiki or dox files? Should we base it on the current guides? >> >> > >I would stay with dox. Links from dox into wiki and back are complicated >(if possible at all), and the existing doxs are a good start. > > And I was going to suggest that we just use the wiki for dev guide and tutorial and move them out of the dox. The advantages I see for this are:
- It makes the documentation "live" on the web so everyone can comment, edit, change it. - There is no generation step - It is more direct because people don't have to edit a .dox file, test generate it, submit a patch, etc. As far as cross linking: - Linking from wiki to doxygen: It looks like the doxygen plugin for trac will help out here. We may also be able to create a simple macro that will create a link given the class name we want to link to. But, this won't be an automatic process so it will be more work then we current go through. - Linking from doxygen to wiki: I wonder if we can configure a doxygen alias that would help with this so that all we had to do in the doxygen comments was to call the alias and list the name of the ref guide page to link to. A define may also work. I haven't tried either of these options though so I don't know if they will work. -Allen > > >>See: http://opensg.vrsource.org/trac/wiki/FutureOfOpenSg#Issue:Documentation >> >>I ask because starting tomorrow I am going to be spending the next month >>using some of the new features of OpenSG 2.0. If we can decided on the >>form for the documentation and get the old docs ported over, I am >>willing and interested in putting some time into documenting the new >>capabilities. >> >> > >Sounds good to me. :) > >Yours > > Dirk > > > >------------------------------------------------------------------------- >Using Tomcat but need to do more? Need to support web services, security? >Get stuff done quickly with pre-integrated technology to make your job easier >Download IBM WebSphere Application Server v.1.0.1 based on Apache Geronimo >http://sel.as-us.falkag.net/sel?cmd=lnk&kid=120709&bid=263057&dat=121642 >_______________________________________________ >Opensg-users mailing list >[email protected] >https://lists.sourceforge.net/lists/listinfo/opensg-users > > > ------------------------------------------------------------------------- Using Tomcat but need to do more? Need to support web services, security? Get stuff done quickly with pre-integrated technology to make your job easier Download IBM WebSphere Application Server v.1.0.1 based on Apache Geronimo http://sel.as-us.falkag.net/sel?cmd=lnk&kid=120709&bid=263057&dat=121642 _______________________________________________ Opensg-users mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/opensg-users
