Difference between revisions of "Translating Proxmox VE"

From Proxmox VE
Jump to navigation Jump to search
 
(2 intermediate revisions by the same user not shown)
Line 4: Line 4:
 
[[Category:Reference Documentation]]
 
[[Category:Reference Documentation]]
 
<pvehide>
 
<pvehide>
The Proxmox VE user interface is in English by default. Thanks to contributions by
+
The Proxmox VE user interface is in English by default. However, thanks to the
the community, translations to other languages are available. We welcome help to
+
contributions of the community, translations to other languages are also available.
add new languages, translate the newest features, and improve incomplete or
+
We welcome any support in adding new languages, translating the latest features, and
inconsistent translations.
+
improving incomplete or inconsistent translations.
 +
We use gettext for the management of the
 +
translation files. Tools like Poedit offer a nice user
 +
interface to edit the translation files, but you can use whatever editor you&#8217;re
 +
comfortable with. No programming knowledge is required for translating.
 +
Translating with git
 
The language files are available as a
 
The language files are available as a
 
git repository. If you are familiar
 
git repository. If you are familiar
 
with git, please contribute according to our
 
with git, please contribute according to our
 
Developer Documentation.
 
Developer Documentation.
Even if you are not familiar with git, you can help with translating Proxmox VE.
+
You can create a new translation by doing the following (replace &lt;LANG&gt; with the
Download the language files
+
language ID):
here. Then choose the
+
# git clone git://git.proxmox.com/git/proxmox-i18n.git
language you want to improve. Right click on the "raw" link of this language
+
# cd proxmox-i18n
file, and select Save Link As&#8230;. Make your changes to the file, and then
+
# make init-&lt;LANG&gt;.po
send your final translation directly to office(at)proxmox.com together with a
+
Or you can edit an existing translation, using the editor of your choice:
 +
# poedit &lt;LANG&gt;.po
 +
Translating without git
 +
Even if you are not familiar with git, you can help translate Proxmox VE.
 +
To start, you can download the language files
 +
here. Find the
 +
language you want to improve, then right click on the "raw" link of this language
 +
file and select Save Link As&#8230;. Make your changes to the file, and then
 +
send your final translation directly to office(at)proxmox.com, together with a
 
signed
 
signed
 
contributor license agreement.
 
contributor license agreement.
We use gettext for the management of the
+
Testing the Translation
translation files. Tools like Poedit offer a nice user
+
In order for the translation to be used in Proxmox VE, you must first translate
interface to edit the translation files.
+
the .po file into a .js file. You can do this by invoking the following script,
 +
which is located in the same repository:
 +
# ./po2js.pl -t pve xx.po &gt;pve-lang-xx.js
 +
The resulting file pve-lang-xx.js can then be copied to the directory
 +
/usr/share/pve-i18n, on your proxmox server, in order to test it out.
 +
Alternatively, you can build a deb package by running the following command from
 +
the root of the repository:
 +
# make deb
 +
For either of these methods to work, you need to have the following
 +
perl packages installed on your system. For Debian/Ubuntu:
 +
# apt-get install perl liblocale-po-perl libjson-perl
 +
Sending the Translation
 +
You can send the finished translation (.po file) to the Proxmox team at the address
 +
office(at)proxmox.com, along with a signed contributor license agreement.
 +
Alternatively, if you have some developer experience, you can send it as a
 +
patch to the Proxmox VE development mailing list. See
 +
Developer Documentation.
 
</pvehide>
 
</pvehide>
 
<!--PVE_IMPORT_END_MARKER-->
 
<!--PVE_IMPORT_END_MARKER-->

Latest revision as of 17:08, 7 May 2021

The Proxmox VE user interface is in English by default. However, thanks to the contributions of the community, translations to other languages are also available. We welcome any support in adding new languages, translating the latest features, and improving incomplete or inconsistent translations.

We use gettext for the management of the translation files. Tools like Poedit offer a nice user interface to edit the translation files, but you can use whatever editor you’re comfortable with. No programming knowledge is required for translating.

Translating with git

The language files are available as a git repository. If you are familiar with git, please contribute according to our Developer Documentation.

You can create a new translation by doing the following (replace <LANG> with the language ID):

# git clone git://git.proxmox.com/git/proxmox-i18n.git
# cd proxmox-i18n
# make init-<LANG>.po

Or you can edit an existing translation, using the editor of your choice:

# poedit <LANG>.po

Translating without git

Even if you are not familiar with git, you can help translate Proxmox VE. To start, you can download the language files here. Find the language you want to improve, then right click on the "raw" link of this language file and select Save Link As…. Make your changes to the file, and then send your final translation directly to office(at)proxmox.com, together with a signed contributor license agreement.

Testing the Translation

In order for the translation to be used in Proxmox VE, you must first translate the .po file into a .js file. You can do this by invoking the following script, which is located in the same repository:

# ./po2js.pl -t pve xx.po >pve-lang-xx.js

The resulting file pve-lang-xx.js can then be copied to the directory /usr/share/pve-i18n, on your proxmox server, in order to test it out.

Alternatively, you can build a deb package by running the following command from the root of the repository:

# make deb
Important For either of these methods to work, you need to have the following perl packages installed on your system. For Debian/Ubuntu:
# apt-get install perl liblocale-po-perl libjson-perl

Sending the Translation

You can send the finished translation (.po file) to the Proxmox team at the address office(at)proxmox.com, along with a signed contributor license agreement. Alternatively, if you have some developer experience, you can send it as a patch to the Proxmox VE development mailing list. See Developer Documentation.