The IzPack documentation is moving to reStructured Text format
Saturday, May 19th, 2007I have started the transition of the documentation to reStructured text. You will find in src/doc-reST from the SVN trunk the first chapters that have been extracted.
The migration phases will be the following ones.
- 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.
- 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.
- Provide the automated scripted build support. Provide an anchor in the Ant build to call the documentation building chain.
- Enhance the markup, fix typos, rewrite unclear paragraphs, and so on.
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
If you are outside of the project and would like to volunteer, then please contact me either by email, on the izpack-devel mailing-list, or by a comment here. Thanks!