Translating GeoServer¶
We would like GeoServer available in as many languages as possible, so we want your help to add localizations / translations, specifically the GeoServer UI and documentation.
Translating the UI¶
The GeoServer UI stores text strings inside properties files. The default (English) files are named GeoServerApplication.properties and are located in the following directories:
/src/web/core/src/main/resources/
/src/web/demo/src/main/resources/
/src/web/gwc/src/main/resources/
/src/web/security/src/main/resources/
/src/web/wcs/src/main/resources/
/src/web/wfs/src/main/resources/
/src/web/wms/src/main/resources/
To translate the GeoServer UI to another language, copy and rename each of these files to be GeoServerApplication_[LANG].properties where [LANG] is the language code as defined in RFC 3066 For example, the language code for German is de and for Brazilian Portuguese is pt-BR.
Once created, each line in the files represents a string that will need to be translated. When finished, you will need to commit these files or submit a JIRA issue with attached patch. See the section on Source Code for more information on how to commit.
Warning
property files must always be encoded in ISO-8859 (or something equivalent like us-ascii or latin1). If you need a whole unicode file, the extension of the file must be utf8.properties.
Translating in Transifex¶
A GeoServer project is maintained on the Transifex website to allow people to participate to the translation of the UI without going into the source code of GeoServer. Transifex requires an account to log in but GitHub accounts can be used.
The project is available here : https://www.transifex.com/GeoServer/geoserver-github-integration/dashboard/.
The administrators of the project update the Transifex resources on a regular basis and synchronize the translations in GeoServer at the same time.
Editing in Eclipse¶
If you are using Eclipse, you can install the Eclipse ResourceBundle Editor. Once installed, you can edit the src/main/resources/GeoServerApplication.properties files in all web-* projects (web-core, web-demo, etc.) with the ResourceBundle editor.
Translating documentation¶
The GeoServer User Manual contains a wealth of information from the novice to the experienced GeoServer user. It is written using the Sphinx Documentation Generator. The stable branch version of the User Manual exists as the following URL:
Built from the following source files:
/doc/en/user/
To create a User Manual in a different language, first create a directory called /doc/[LANG]/, where [LANG] is the language code as defined in RFC 3066. The you can copy the contents of /doc/en/user/ to /doc/[LANG]/user and edit accordingly, or generate a new Sphinx project in /doc/[LANG]/user. (See the Sphinx Quickstart <http://sphinx.pocoo.org/tutorial.html> for more information about creating a new project.)
The GeoServer Sphinx theme exists at /doc/en/user/themes, so that can be copied (and modified if desired) to /doc/[LANG]/user/themes.
When finished, you will need to commit the content (if you have commit rights) or submit a JIRA issue with attached patch. See the section on Source Code for more information on how to commit. Setting up the documentation to be hosted on docs.geoserver.org will require a project administrator; please send an email to the mailing list for more details.
Tips¶
See the GeoServer Documentation Manual for more information about writing documentation.
The Developer Manual exists at
/doc/en/developer. The same procedures for editing the User Manual apply to the Developer Manual.