WeeChat translator guide

WeeChat translator guide

You're a new WeeChat translator ? Welcome in our team, and thank you for your contribution!

You'll find here useful instructions on how to start with WeeChat translations.

For any question, send mail to: flashcode@flashtux.org

Files to translate

You must ALWAYS translate files from GIT repository, NEVER from stable or any other release because they're old compared to GIT repository.

Files to translate are following (xx is your language):

• po/xx.po (gettext)
• doc/xx/weechat_*.xx.txt (asciidoc)

Priority for translations

The files to translate first, from more important to less important:

• WeeChat messages (po/xx.po)
• quick start guide (doc/xx/weechat_quickstart.xx.txt)
• FAQ (doc/xx/weechat_faq.xx.txt)
• user guide (doc/xx/weechat_user.xx.txt)
• scripting guide (doc/xx/weechat_scripting.xx.txt)
• tester's guide (doc/xx/weechat_tester.xx.txt)
• plugin API (doc/xx/weechat_plugin.xx.txt)
• developer's guide (doc/xx/weechat_dev.xx.txt)
• relay protocol (doc/xx/weechat_relay_protocol.xx.txt)

Charset

All files (asciidoc and gettext) are written in UTF-8. Only UTF-8!

Translations status

Lang	Gettext	FAQ	User	API	Scripting	QuickStart	Tester	Relay	Devel	Contributors needed?
en	OK	OK	OK	OK	OK	OK	OK	OK	OK	No
fr	OK	OK	OK	OK	OK	OK	OK	no need	no need	No
it	OK	OK	OK	OK	OK	OK	OK	no need	no need	No
de	OK	OK	OK	no need	OK	OK	OK	no need	no need	No
ja	OK	OK	OK	no need	OK	OK	OK	no need	no need	No
pl	OK	OK	missing	no need	OK	OK	OK	no need	no need	No
es	OK	missing	missing	no need	missing	OK	missing	no need	no need	Yes
ru	partial	missing	missing	no need	missing	OK	missing	no need	no need	Yes
pt_BR	partial	missing	missing	no need	missing	missing	missing	no need	no need	Yes
cs	partial	missing	missing	no need	missing	missing	missing	no need	no need	Yes
hu	partial	missing	missing	no need	missing	missing	missing	no need	no need	Yes

gettext

To build your gettext file (xx.po), use following command, for example for building file for dutch (nl) translations:

git clone git://git.sv.gnu.org/weechat.git
cd weechat/po
msginit -i weechat.pot -l nl_NL -o nl.po

Then you can fill nl.po file with your favorite text or PO editor. Gettext manual: http://www.gnu.org/software/gettext/manual/

Some instructions:

• please translate exactly strings, do not add/remove infos from base string, if there are some problems or errors in strings, please contact WeeChat author.

• you can check your .po file with script msgcheck.py: https://github.com/flashcode/msgcheck

asciidoc

The untranslated parts of file are marked with following line (translate all untranslated lines after this one, and remove it):

// TRANSLATION MISSING

You can translate all text, but not link names:

[[link_name]]
<<link_name>>

You must translate alternate text for link names:

<<link_name,this text must be translated>>

Please do not translate following asciidoc keywords:

[NOTE]
[TIP]
[IMPORTANT]
[WARNING]
[CAUTION]

Please make sure special chars below titles are exactly same length as title (not too short or too long):

• this is WRONG:

This is a example of title
=============

Another title here
^^^^^^^^^^^^^^^^^^^^^^^

• this is CORRECT:

This is a example of title
==========================

Another title here
^^^^^^^^^^^^^^^^^^

You should use english asciidoc files as template (or any existing language that is most familiar for you).

Files in autogen/ directories should NOT be translated, they're built with WeeChat. So they will be ok when xx.po will be ok and files rebuilt with it (for information, you can look at doc/docgen.pl script).