Trace:
Differences ¶
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revision | Last revisionBoth sides next revision | ||
en:documentation:translate [2009/11/16 10:18] – laurent | en:documentation:translate [2012/04/14 19:01] – laurent | ||
---|---|---|---|
Line 1: | Line 1: | ||
====== Translating the manual ====== | ====== Translating the manual ====== | ||
- | The manual is stored in a wiki system | + | The manual is stored in Github repository |
- | Create | + | To create a manual in an other language, create a new repository somewhere (github is a good idea). And create some files following same hierarchy as the original manual, and with translated contents and following |
+ | However, there are few things to know, in order to produce a good manual and to respect conventions. | ||
===== The main page of the manual ===== | ===== The main page of the manual ===== | ||
- | First, there is an important page of the manual : [[en:manual-1.1|the summary]]. The goal of this page is to list all wiki pages which are parts of the manual, the hierarchy and the order of these pages. For that, we use a specific | + | First, there is an important page of the manual: [[https:// |
- | Why this plugin ? It saved the list of these pages in a database, and it then allows : | + | Why this plugin? It saved the list of these pages in a file, and it then allows: |
* to generate automatically a navigation bar for the manual, on each wiki page of the manual | * to generate automatically a navigation bar for the manual, on each wiki page of the manual | ||
* to generate a PDF version each night. On our server, we have a script which look at this list, read all wiki pages, and include all of their contents in a PDF file. Later, we will have other scripts to generate static HTML pages etc.. | * to generate a PDF version each night. On our server, we have a script which look at this list, read all wiki pages, and include all of their contents in a PDF file. Later, we will have other scripts to generate static HTML pages etc.. | ||
- | In this main page of the manual, you have others | + | In this main page of the manual, you have others |
< | < | ||
Line 29: | Line 30: | ||
* you can translate the name of the page (the part after " | * you can translate the name of the page (the part after " | ||
* you can translate other part of this page, the content inside the tags < | * you can translate other part of this page, the content inside the tags < | ||
- | |||
- | ===== Translating other pages ===== | ||
- | |||
- | * in the main page, check if the title of the page is ok, and if the url of the page is ok. Modify the main page to change them. | ||
- | * in the main page, click on the link. You will have a message like "the page doesn' | ||
- | * copy into it the wiki content of the corresponding english page | ||
- | * translate the content and save. | ||
- | * of course, you can save at any time, and you can modify or continue to translate the page when you want. | ||
- | |||
- | ===== Generating the PDF version ===== | ||
- | |||
- | When you begin to translate the manual, when you have created the main page, tell it in the forum, so an administrator will update the script on the server which is responsible to generate the PDF files from the wiki content. Then, the next night, and each nights, a PDF version will be generated and users could download it. | ||
- | |||