From mboxrd@z Thu Jan 1 00:00:00 1970
Return-Path: <d.whyte@proxmox.com>
Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68])
(using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)
key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256)
(No client certificate requested)
by lists.proxmox.com (Postfix) with ESMTPS id F09EB69591
for <pve-devel@pve.proxmox.com>; Mon, 31 Aug 2020 10:06:06 +0200 (CEST)
Received: from firstgate.proxmox.com (localhost [127.0.0.1])
by firstgate.proxmox.com (Proxmox) with ESMTP id D7A0B11808
for <pve-devel@pve.proxmox.com>; Mon, 31 Aug 2020 10:05:36 +0200 (CEST)
Received: from proxmox-new.maurer-it.com (proxmox-new.maurer-it.com
[212.186.127.180])
(using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)
key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256)
(No client certificate requested)
by firstgate.proxmox.com (Proxmox) with ESMTPS id D0365117FC
for <pve-devel@pve.proxmox.com>; Mon, 31 Aug 2020 10:05:34 +0200 (CEST)
Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1])
by proxmox-new.maurer-it.com (Proxmox) with ESMTP id 75CF844960
for <pve-devel@pve.proxmox.com>; Mon, 31 Aug 2020 10:05:34 +0200 (CEST)
From: Dylan Whyte <d.whyte@proxmox.com>
To: pve-devel@pve.proxmox.com
Date: Mon, 31 Aug 2020 10:05:20 +0200
Message-Id: <20200831080520.30423-1-d.whyte@proxmox.com>
X-Mailer: git-send-email 2.20.1
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
X-SPAM-LEVEL: Spam detection results: 0
AWL -0.400 Adjusted score from AWL reputation of From: address
KAM_ASCII_DIVIDERS 0.8 Spam that uses ascii formatting tricks
KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment
KAM_SHORT 0.001 Use of a URL Shortener for very short URL
RCVD_IN_DNSWL_MED -2.3 Sender listed at https://www.dnswl.org/,
medium trust
SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record
SPF_PASS -0.001 SPF: sender matches SPF record
URIBL_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to URIBL was blocked. See
http://wiki.apache.org/spamassassin/DnsBlocklists#dnsbl-block for more
information. [gnu.org, po2js.pl, poedit.net, proxmox.com]
Subject: [pve-devel] [PATCH V2 pve-docs] translation: combine old and
current wikis
X-BeenThere: pve-devel@lists.proxmox.com
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: Proxmox VE development discussion <pve-devel.lists.proxmox.com>
List-Unsubscribe: <https://lists.proxmox.com/cgi-bin/mailman/options/pve-devel>,
<mailto:pve-devel-request@lists.proxmox.com?subject=unsubscribe>
List-Archive: <http://lists.proxmox.com/pipermail/pve-devel/>
List-Post: <mailto:pve-devel@lists.proxmox.com>
List-Help: <mailto:pve-devel-request@lists.proxmox.com?subject=help>
List-Subscribe: <https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel>,
<mailto:pve-devel-request@lists.proxmox.com?subject=subscribe>
X-List-Received-Date: Mon, 31 Aug 2020 08:06:07 -0000
This takes all of the relevant information from
an old wiki site (https://pve.proxmox.com/wiki/Translations)
and merges it into the document that is used in generating the
admin guide and current wiki
(https://pve.proxmox.com/wiki/Translating_Proxmox_VE) entry.
Also contains some rewording for better readability.
V2: - Broke up into multiple sections for further clarity
- Separate sections for translating with and without git.
- Separate section for various methods of testing the
translation
- Separate section for various methods of submitting the
translation
- Incorporate suggested changes from previous version
Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
---
translation.adoc | 77 ++++++++++++++++++++++++++++++++++++++++--------
1 file changed, 64 insertions(+), 13 deletions(-)
diff --git a/translation.adoc b/translation.adoc
index 2dc156b..93342df 100644
--- a/translation.adoc
+++ b/translation.adoc
@@ -6,25 +6,76 @@ ifdef::wiki[]
endif::wiki[]
-The {pve} user interface is in English by default. Thanks to contributions by
-the community, translations to other languages are available. We welcome help to
-add new languages, translate the newest features, and improve incomplete or
-inconsistent translations.
+
+The {pve} 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 https://www.gnu.org/software/gettext/[gettext] for the management of the
+translation files. Tools like https://poedit.net/[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
https://git.proxmox.com/?p=proxmox-i18n.git[git repository]. If you are familiar
with git, please contribute according to our
{webwiki-url}Developer_Documentation[Developer Documentation].
-Even if you are not familiar with git, you can help with translating {pve}.
-Download the language files
-https://git.proxmox.com/?p=proxmox-i18n.git;a=tree[here]. Then choose the
-language you want to improve. 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
+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 {pve}.
+To start, you can download the language files
+https://git.proxmox.com/?p=proxmox-i18n.git;a=tree[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
{webwiki-url}Developer_Documentation#Software_License_and_Copyright[contributor license agreement].
-We use https://www.gnu.org/software/gettext/[gettext] for the management of the
-translation files. Tools like https://poedit.net/[Poedit] offer a nice user
-interface to edit the translation files.
+
+Testing the Translation
+~~~~~~~~~~~~~~~~~~~~~~~
+
+In order for the translation to be used in {pve}, 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 licence agreement.
+Alternatively, if you have some developer experience, you can send it as a
+patch to the {pve} development mailing list. See [[Developer Documentation]]
--
2.20.1