Freeduc-doc
From OFSET Wiki
Contents |
[edit] Introduction
This is the Freeduc-doc collaborative portal. This is the place for collaboration in writing documentation granules for the Freeduc-doc project. The documentation is proposed under the FDL license. For more information regarding the overall organisation of the project, please visit its home page at http://www.ofset.org/freeduc-doc
The Freeduc-doc project is composed of a set of documentation granules. Each granule is in fact a .tex file introducing one software or one set of features within freeduc-cd. Next the granules are assembled to compose the Freeduc-cd documentation, in HTML and PDF forms. The LaTeX granules are saved in the Freeduc-doc CVS repository at Gna! http://gna.org/projects/freeduc-cd.
The granules are written in French and an effort to translate them in other languages is necessary. The overall organisation of the freeduc-doc project allows easy translation. Also some granules need to be updated, other ones need to be created.
[edit] The documentation
- With the release of Freeduc-cd 1.5 special primary school, the granules were assembled as The book of Freeduc-cd 1.5 in HTML and PDF forms.
- The whole granules sources are located in the Gna! Freeduc-doc project CVS repository, you can browse on-line this repository http://cvs.gna.org/viewcvs/freeduc-doc/freeduc-doc.
- To help contributors (writers, reviewers, translators) we also maintain the Freeduc-doc translation table at http://linux5.cc.ntu.edu.tw/~freeduc-dev/translation.html
[edit] How to help?
[edit] Review granules
It is an easy way to participate, just open one html granule from the translation table then review it. When you are done, send your report to the <freeduc-dev AT ofset.org> mailing list.
[edit] Translate granules
Thanks to the thin granularity of the documentation and the nice syntax of LaTeX documents, translating is very easy and comfortable. Go to the translation table, pick the source granule you want to translate, then with a simple text editor just start translating. When you are done, send your translated .tex source file to <freeduc-dev AT ofset.org>. If you are considering translating a lot of granules, you can join the mailing list to be more deeply involved.
[edit] Write new granules
With new and updated software, we need authors to write and update granules.
To write new documentation, you have two options:
- First option is using this wiki. You will write the granule as a wiki document, you will also be able to upload pictures (PNG format only) coming with the document. Later a redactor will convert your document as a LaTeX one, then upload it in the Freeduc-doc CVS (collaborating tool to share document).
- Second option is to directly write document with the original LaTeX syntax. In the following links in this page, you will find information regarding the used syntax.
Before you proceed on writing a new granule, you should look at the Supports section and the Freeduc-doc todo documentation task page.
[edit] Supports
[edit] Mailing lists
Freeduc-cd and Freeduc-doc efforts are coordinated throught the <freeduc-dev AT ofset.org> mailing list. The <freeduc AT ofset.org> is more dedicated to users.
[edit] How to write with wiki?
You found that using LaTeX to write documentation is too complicated. Never mind, you can just use this wiki to write the document and to upload attached pictures. There are some hints we want to share with you if you decide to use this solution:
- Use the wiki syntax to give the appropriate structure to your document. This will help a lot the redactor to convert it later to the final LaTeX version. You will find more about the wiki syntax from the Help link at the left of this page.
- With the Upload link at the left of this page, you can upload image file to your document.
- Uploaded pictures must be exclusively in the PNG format. Try to keep the size of the pictures small. The width of the pictures can not exceed 780 pixels.
- Start writing your documentation from the documentation granule page
- Visit the example of a documentation granule page.
- You need to create a login to edit in this wiki.
[edit] How to write with LaTeX?
If you can directly edit the document as a LaTeX file, it is far better. In this case, beside LaTeX, you may also need to configure your SSH access to use the CVS tool to upload your contribution. Some more information can be found in the Gna! FAQ page where the Freeduc-doc source file are hosted. Alternatively, if you don't want to mess with SSH & CVS you can just send an archive of you work at <freeduc-dev AT ofset.org>.
Bellow follow some information in respect to edit granule documentation as LaTeX file:
- The LaTeX syntax used with Freeduc-doc granule
- You may need to register yourself to the Freeduc-doc project page at http://gna.org/projects/freeduc-doc. Contact us at <freeduc-dev AT ofset.org> to help you in this area.
[edit] How to write with OpenOffice?
Now (since April 2007), you can input documents written or converted with OpenOffice. Many reasons make this possibility important:
- First of all, OpenOffice is a free software.
- Secondly, the OpenDocument format has been certified by ISO, so the pages you write now in this format will remain valid in the future (or at least much longer than any previous releases of past word processors).
- Then, consider that OpenOffice has powerful features of importation (directly from the closed .doc format, or less directly by drag-and-drop or clipboard pasting): so you have few limits.
- Finally, many people are used to these modern word processing programs, aren't you?
HOW TO INPUT ODT DOCUMENTS
First of all, you must validate the documents, here is the address of a validator: http://gk.homelinux.org/docs/odt2hlx/
Just upload your document and browse the resulting fake Freeduc-Book. If it is convenient, then you will need a ssh access (developer access) to gna.org, in order to submit your work. Then it is time to contact the developers' team of the project Freeduc-doc at gna.org:
