[izpack-devel] Documentation migration plan
miraodb at hotmail.com
Sun May 20 02:18:31 CEST 2007
Hi Julien, Very nice.
I can work on point number 1, 2 (HTML part to start with).
I could also work on 3 and of course 4 since i haven't really applied a few changes to the doc for a while.
I'll put this into my todo list and will try to update as soon and as accurate as i can so that you can follow the evolution of it.
> Date: Sat, 19 May 2007 15:14:59 +0200> From: julien.ponge at gmail.com> To: izpack-devel at lists.berlios.de> Subject: [izpack-devel] Documentation migration plan> > Hi everyone,> > I have started the transition of the documentation to reStructured> text. You will find in src/doc-reST the first chapters that have been> extracted.> > The migration phases will be the following ones.> > 1. Extract the text from the old documentation and put into> reStructured document files, one per chapter. There should be no> modification, the goal here is not to have a perfect extraction but> have a decent base to get started.> > 2. Create 2 'main' reStructured text documents: one which is tailored> for HTML ouput and one which is tailored for LaTeX/PDF output. The> reason here is that HTML is better read when split through several> files rather than when put into a single document. By contrast,> generating the LaTeX/PDF version needs the output to be done in a> single file.> > 3. Provide the automated scripted build support. Provide an anchor in> the Ant build to call the documentation building chain.> > 4. Enhance the markup, fix typos, rewrite unclear paragraphs,> > I won't have time to work on this for a few days, so volunteers are> welcome for performing the extraction of the other chapters. I will> handle the rest of the 2, 3 and 4 phases of course :-)> > If you need help on reStructured Text, then please go to:> * http://docutils.sourceforge.net/docs/user/rst/quickref.html> * http://docutils.sourceforge.net/docs/ref/rst/directives.html> > Cheers> _______________________________________________> izpack-devel mailing list> izpack-devel at lists.berlios.de> https://lists.berlios.de/mailman/listinfo/izpack-devel
Explore the seven wonders of the world
-------------- next part --------------
An HTML attachment was scrubbed...
More information about the izpack-devel