Starting Guide for Wiki translators
Languages: |
[[::Starting Guide for Wiki translators|English]]
ContentsTemplateThis sub-template doesn't display properly when not included. Please see Template:Languages for the complete version. UsageThis template is designed to simplify Template:Languages, by allowing a simpler syntax for adding new languages. Each language is included by calling this template with the following parameters:
This template should not be used anywhere except in the Languages template. </noinclude> | Translate this article... |
Important: This guide is intended for translators willing to help translating our wiki to other languages. For translating Openbravo ERP or Openbravo POS see: |
Important articles and Main Page
This list gives you a quick reference to what we think is the most important documentation in Openbravo ERP and POS.
- ERP/2.50/Openbravo ERP Installation
- Virtual appliances
- User Manual 2.40
- Openbravo environment installation
- OpenbravoPOS Installation
- Functional Documentation
Every language can have their own main page. Instead of just translating the English main page, we recommend to create your own page (see the Spanish as example) that contain information relevant (e.g. documents translated) to the target language.
Help
Translating documentation
In the Openbravo project most of the documentation is at the project's Wiki. This allows people to modify and enhance the documentation, but also allows every one to translate the documentation into their language.
Mediawiki supports different multilingual strategies. At Openbravo's Wiki we use the ISO-639-1 language code.
Naming documents
For naming documents we use the format document_name/iso_639_code. For example, the name of this help page in English is:
http://wiki.openbravo.com/wiki/Help
In French is:
http://wiki.openbravo.com/wiki/Help/fr
Where fr the ISO-639-1 code for French.
For German is:
http://wiki.openbravo.com/wiki/Help/de
Where de is the ISO-639-1 code for German language.
Adding the following template to your Wiki page:
{{Language | Page name}}
will create the necessary links to access the same pages in other languages.
Naming images
For naming images the same guidelines are followed. Just add an underscore plus with the language code plus an additional underscore plus the country code.
For example, installer.jpg becomes installer_de.jpg for the German version.
Naming categories
For naming categories the same guidelines are followed. Just add underscore plus the language code.
For example, the category UserManual_10 becomes UserManual_10_fr for the French version.
Important recommendations
Please, when translating Wiki documents remember:
- Create new pages, images and categories by adding the language code to its original English name. Using the same name overwrites the original English version.
- Do not translate the name of new pages, images and categories. They should remain in English.
- When translating documents it is strongly recommended to translate from English to your language. Almost all the Openbravo ERP documentation is written originally in English and translating from an already translated version usually produces poor results.
- When translating the user manual or any other user documentation check if Openbravo has been translated into your language. It is very important to use the same translations as the ones used in the application. If not, you may be referring to the same options using different names.
- Watch the page of the original document, so you can track changes on it and keep your translation updated.
See also
For guidelines and general help on editing in our wiki see the Help article.