> -----Original Message----- > From: [EMAIL PROTECTED] > [mailto:[EMAIL PROTECTED]]On Behalf Of > Bill Burton > Sent: 10. desember 2002 21:05 > To: [EMAIL PROTECTED] > Subject: Re: [OS-webwork] Documentation > > > Hello, > > Aslak Hellesoy wrote: > > Why don't you write documentation in xdoc format? This is > basically XHTML, > > augmented with 3-4 special tags. Then you can use Maven to > generate HTML, > > PDF, RTF, whatever. > > Yes, I was thinking the same thing. It's practically like writing HTML > but with simple tags for indicating headings, etc. By xdoc, I assume > you're referring to what's used for the http://jakarta.apache.org and > http://httpd.apache.org docs. Those docs are generated by Anakia, a > Velocity based tool run from Ant. The next generation of this tool is > DVSL which is much more like XSLT (supporting XPath, etc.) but easier to > use. >
That's exactly what I meant, but I'd use Maven instead of Anakia. Maven understands the same xdoc syntax as Anakia, and is able to produce nicer-looking HTML docs than Anakia. -With a neat navigation pane to the left. Sample page: http://boss.bekk.no/boss/middlegen/ant/table.html Source: http://tinyurl.com/3epq Maven vs Anakia: http://jakarta.apache.org/turbine/maven/start/anakia.html The navigation is maintained in a separate file called navigation.xml, and Maven weaves everything together into a nice web page. -And you can tell Maven to generate PDF from the same xdoc files. It's already built into maven. Just type "maven pdf". I can really recommend Maven. -Not only for the doc generation, but for the awesome build system it provides. > You can read about DVSL at > http://jakarta.apache.org/velocity/dvsl/index.html. > > The main thing is that the doc source should be in some simple XML > format that's easy to edit without special tools. The HTML and PDF can > then be generated with whatever tools are suitable. > > The best argument I can think of to illustrate why keeping the doc > source in XML is important is the same one for using WebWork over > writing Java in JSP's--keeping the logic and data separate from the > presentation. > Killing point :-) Cheers, Aslak > -Bill > > > > > Aslak > > > > > >>-----Original Message----- > >>From: [EMAIL PROTECTED] > >>[mailto:[EMAIL PROTECTED]]On Behalf Of > >>Simon Stewart > >>Sent: 10. desember 2002 19:00 > >>To: [EMAIL PROTECTED] > >>Subject: Re: [OS-webwork] Documentation > >> > >> > >>On Tuesday, Dec 10, 2002, at 16:32 Europe/London, Ken Egervari > >>[eXtremePHP] wrote: > >> > >>>XSLT will also help us out if the website presentation layer changes > >>>or when > >>>we decide to compile the manual into a PDF document (which I really > >>>hope we > >>>do since PDF is a fantastic format for printing and offline viewing). > >>>XML > >>>will critical to achieve this. > >> > >>Maybe I'm just a little bit confused, but won't both the XML and the > >>HTML crowd be happy with XHTML? Seems like a Really Obvious Solution. > >>Fine, you can't use the Docbook tools that come with lots of linux > >>distros, but that's just a minor implementation detail --- I bet that > >>there are loads of people champing at the bit for a tool to convert > >>their websites to PDF :) > >> > >>Regards, > >> > >>Simon > > > > ------------------------------------------------------- > This sf.net email is sponsored by: > With Great Power, Comes Great Responsibility > Learn to use your power at OSDN's High Performance Computing Channel > http://hpc.devchannel.org/ > _______________________________________________ > Opensymphony-webwork mailing list > [EMAIL PROTECTED] > https://lists.sourceforge.net/lists/listinfo/opensymphony-webwork ------------------------------------------------------- This sf.net email is sponsored by: With Great Power, Comes Great Responsibility Learn to use your power at OSDN's High Performance Computing Channel http://hpc.devchannel.org/ _______________________________________________ Opensymphony-webwork mailing list [EMAIL PROTECTED] https://lists.sourceforge.net/lists/listinfo/opensymphony-webwork
