Doc Freeduc

Concept

The documentation is written with LaTeX/HyperLaTeX. This system allow us to produce both paper version to be distributed along a CD-ROM as a booklet or book and on-line HTML version to be included into the CD-ROM.

Sources

The sources of the documentation is located into the freeduc/Documents module within the OFSET CVS at http://sf.net/projects/ofset
To fetch anonymously the whole module you can do as follow:

---

cvs -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/ofset login
cvs -z3 -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/ofset co freeduc/Documents

---

To be able to commit modifications you need to have an account at SourceForge and someone have to add you in the developers list within OFSET.

Organization of the source documentation

There are two master documents: book.tex and booklet.tex:

• book.tex is used to produce a complete documentation in the form of a paper book or as an online html form;
• booklet.tex is used to produce the CD-ROM booklet. It needs the cd-cover.cls LaTeX class (it is included within the freeduc/Documents module)

The presentation.tex document is a common document to the book and booklet documents.

The figures folder contains the various pictures, graphics. All come in the form of PNG images. To convert these graphics in EPS format -- to produced printed documents -- just do make within this folder.

The applications folder contains several .tex documents. These documents are not complete and cannot be compiled directly. Instead they are automaticly inclued at compile time in the book.tex master document. Therefore it is quite easy to rearange this master document.

In a few words, the documents to translate are booklet.tex, book.tex and presentation.tex. The documents in the applications folder are quite big and may or may not be translated.

Where

• Include a PDF documentation a the root of the CD-ROM

Work to do

1. Organize a way to handle translations in various languages. We could use the same mecanism used with the drgenius manual. For more information on that see: http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/*checkout*/ofset/drgenius-man/README?rev=1.8 Also new ideas/knowledges used to translate documentation is very welcome.
2. Produce more documentation as the ones found in the applications folder. Most of these documents are converted from the HTML documents at http://logiciels-libres-cndp.ac-versailles.fr. It is very easy to convert from this format to .tex, we have defined several macro-commands to help in this task, you can look at one of the .tex document in applications as an example.