annotate src/po/README.txt @ 33223:def9fc5c92d1 v9.0.1886

patch 9.0.1886: Various Typos Commit: https://github.com/vim/vim/commit/ee17b6f70d382ec6c5d8d27b56c4e84106ac8c55 Author: Christian Brabandt <cb@256bit.org> Date: Sat Sep 9 11:23:50 2023 +0200 patch 9.0.1886: Various Typos Problem: Various Typos Solution: Fix Typos This is a collection of typo related commits. closes: #12753 closes: #13016 Co-authored-by: Adri Verhoef <a3@a3.xs4all.nl> Co-authored-by: zeertzjq <zeertzjq@outlook.com> Co-authored-by: Viktor Sz?pe <viktor@szepe.net> Co-authored-by: nuid64 <lvkuzvesov@proton.me> Co-authored-by: Meng Xiangzhuo <aumo@foxmail.com> Co-authored-by: Dominique Pell? <dominique.pelle@gmail.com> Signed-off-by: Christian Brabandt <cb@256bit.org>
author Christian Brabandt <cb@256bit.org>
date Sat, 09 Sep 2023 11:45:04 +0200
parents 4027cefc2aab
children 45c0a5330758
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1 TRANSLATING VIM MESSAGES
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3 In this directory you will find xx.po files, where "xx" is a language code.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4 Each file contains the translation of English Vim messages for one language.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5 The files are in "po" format, used by the gettext package. Please refer to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6 the gettext documentation for more information.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8 The GNU gettext library, starting with version 0.10.37, supports converting
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9 messages from one encoding to another. This requires that it was compiled
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10 with HAVE_ICONV. The result is that the messages may be in any encoding
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11 supported by iconv and will be automatically converted to the currently used
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12 encoding.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
13
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
14 The GNU gettext library, starting with version 0.10.36, uses a new format for
1125
96cd8222a819 updated for version 7.1a
vimboss
parents: 449
diff changeset
15 some encodings. This follows the C99 standard for strings. It means that
96cd8222a819 updated for version 7.1a
vimboss
parents: 449
diff changeset
16 when a multi-byte character includes the 0x5c byte, this is not recognized as
96cd8222a819 updated for version 7.1a
vimboss
parents: 449
diff changeset
17 a backslash. Since this format is incompatible with Solaris, Vim uses the old
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
18 format. This is done by setting the OLD_PO_FILE_OUTPUT and OLD_PO_FILE_INPUT
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
19 environment variables. When you use the Makefile in this directory that will
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
20 be done for you. This does NOT work with gettext 0.10.36. Don't use it, get
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
21 0.10.37.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
22
29285
729a7c00fabc Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 22071
diff changeset
23 Have a look at these helper scripts, they may be useful for you:
729a7c00fabc Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 22071
diff changeset
24 https://github.com/adaext/vim-menutrans-helper
729a7c00fabc Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 22071
diff changeset
25
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
26
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
27 ON MS-WINDOWS
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
28
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
29 The distributed files are generated on Unix, but this should also be possible
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
30 on MS-Windows. Download the gettext packages, for example from:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
31
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
32 http://sourceforge.net/projects/gettext
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
33
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
34 You might have to do the commands manually. Example:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
35
16023
dc766e1b0c95 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14123
diff changeset
36 cd c:\vim\vim81
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
37 mkdir runtime\lang\ja\LC_MESSAGES
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
38 msgfmt -o runtime\lang\ja\LC_MESSAGES\vim.mo src\po\ja.po
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
39
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
40
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
41 WHEN THERE IS A MISTAKE
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
42
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
43 If you find there is a mistake in one of the translations, please report this
33223
def9fc5c92d1 patch 9.0.1886: Various Typos
Christian Brabandt <cb@256bit.org>
parents: 32770
diff changeset
44 to the maintainer of the translation. His/her e-mail address is in the
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
45 comments at the start of the file. You can also see this with the ":messages"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
46 command in Vim when the translation is being used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
47
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
48
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
49 CREATING A NEW PO FILE
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
50
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
51 We will use "xx.po" as an example here, replace "xx" with the name of your
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
52 language.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
53
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
54 - Edit Makefile to add xx to LANGUAGES and xx.mo to MOFILES.
14123
583bf95b6c84 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11914
diff changeset
55 - If you haven't done so already, run ./configure in the top vim directory
583bf95b6c84 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11914
diff changeset
56 (i.e. go up two directories) and then come back here afterwards.
583bf95b6c84 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11914
diff changeset
57 - Execute these commands:
583bf95b6c84 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11914
diff changeset
58 % make vim.pot
583bf95b6c84 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11914
diff changeset
59 % msginit -l xx
583bf95b6c84 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11914
diff changeset
60 % rm vim.pot
583bf95b6c84 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11914
diff changeset
61 The first command will generate a vim.pot file which is used by msginit to
583bf95b6c84 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11914
diff changeset
62 generate a correct xx.po file. After that vim.pot is not needed.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
63 - The remaining work is like updating, see the next section.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
64
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
65
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
66 UPDATING A PO FILE
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
67
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
68 If you are the maintainer of a .po file, this is how you update the file. We
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
69 will use "xx.po" as an example here, replace "xx" with the name of your
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
70 language.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
71
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
72 (1) Add new and changed messages from the Vim sources:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
73
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
74 make xx
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
75
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
76 This will extract all the strings from Vim and merge them in with the
4992
ceb5f21cda79 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 4502
diff changeset
77 existing translations. Requires the GNU gettext utilities.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
78 Your original xx.po file will be copied to xx.po.orig
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
79
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
80 -- After you do this, you MUST do the next three steps! --
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
81
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
82 (2) Translate
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
83 See the gettext documentation on how to do this. You can also find
21989
52e970719f4b patch 8.2.1544: cannot translate messages in a Vim script
Bram Moolenaar <Bram@vim.org>
parents: 16023
diff changeset
84 examples in the other po files. You can use "gF" on the file name to see
52e970719f4b patch 8.2.1544: cannot translate messages in a Vim script
Bram Moolenaar <Bram@vim.org>
parents: 16023
diff changeset
85 the context of the message.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
86 Search the po file for items that require translation:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
87
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
88 /fuzzy\|^msgstr ""\(\n"\)\@!
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
89
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
90 Remove the "#, fuzzy" line after adding the translation.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
91
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
92 There is one special message:
32770
4027cefc2aab Farewell to Bram and dedicate upcoming Vim 9.1 to him (#12749)
Christian Brabandt <cb@256bit.org>
parents: 29285
diff changeset
93 msgid "Messages maintainer: The Vim Project"
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
94 You should include your name and E-mail address instead, for example:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
95 msgstr "Berichten übersetzt bei: John Doe <john@doe.org>"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
96
11900
39e46ae74c69 patch 8.0.0830: translating messages is not ideal
Christian Brabandt <cb@256bit.org>
parents: 11659
diff changeset
97 (3) Remove unused messages (optional)
22071
aa91480771fe patch 8.2.1585: messages in globals.h not translated
Bram Moolenaar <Bram@vim.org>
parents: 21989
diff changeset
98 Remove messages that have been marked as obsolete.
11900
39e46ae74c69 patch 8.0.0830: translating messages is not ideal
Christian Brabandt <cb@256bit.org>
parents: 11659
diff changeset
99 Such messages start with "#~".
39e46ae74c69 patch 8.0.0830: translating messages is not ideal
Christian Brabandt <cb@256bit.org>
parents: 11659
diff changeset
100
39e46ae74c69 patch 8.0.0830: translating messages is not ideal
Christian Brabandt <cb@256bit.org>
parents: 11659
diff changeset
101 The cleanup script will also do that (see next step).
39e46ae74c69 patch 8.0.0830: translating messages is not ideal
Christian Brabandt <cb@256bit.org>
parents: 11659
diff changeset
102
39e46ae74c69 patch 8.0.0830: translating messages is not ideal
Christian Brabandt <cb@256bit.org>
parents: 11659
diff changeset
103 (4) Clean up
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
104 This is very important to make sure the translation works on all systems.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
105 Comment-out all non-translated strings. There are two types:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
106 - items marked with "#, fuzzy"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
107 - items with an empty msgstr
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
108 You can do this with the cleanup.vim script:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
109
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
110 :source cleanup.vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
111
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
112 Background: on Solaris an empty msgstr results in an empty message; GNU
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
113 gettext ignores empty strings and items marked with "#, fuzzy".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
114
449
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 440
diff changeset
115 This also removes the line numbers from the file, so that patches are not
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 440
diff changeset
116 messed up by changes in line numbers and show the actual changes in the
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 440
diff changeset
117 text.
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 440
diff changeset
118
11914
4f7081eb1e26 Updated runtime files
Christian Brabandt <cb@256bit.org>
parents: 11900
diff changeset
119 (5) Check:
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
120
11659
49c12c93abf3 Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents: 4992
diff changeset
121 While editing the .po file:
49c12c93abf3 Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents: 4992
diff changeset
122 :source check.vim
49c12c93abf3 Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents: 4992
diff changeset
123
49c12c93abf3 Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents: 4992
diff changeset
124 From the command line:
440
eb531146be0e updated for version 7.0114
vimboss
parents: 7
diff changeset
125 vim -S check.vim xx.po
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
126 make xx.mo
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
127
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
128 Look out for syntax errors and fix them.
4502
605c9ce57ec3 Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents: 1125
diff changeset
129
21989
52e970719f4b patch 8.2.1544: cannot translate messages in a Vim script
Bram Moolenaar <Bram@vim.org>
parents: 16023
diff changeset
130 (6) Local tryout:
52e970719f4b patch 8.2.1544: cannot translate messages in a Vim script
Bram Moolenaar <Bram@vim.org>
parents: 16023
diff changeset
131 Vim normally picks up the .mo files from:
52e970719f4b patch 8.2.1544: cannot translate messages in a Vim script
Bram Moolenaar <Bram@vim.org>
parents: 16023
diff changeset
132 $VIMRUNTIME/lang/{lang}/LC_MESSAGES/vim.mo
52e970719f4b patch 8.2.1544: cannot translate messages in a Vim script
Bram Moolenaar <Bram@vim.org>
parents: 16023
diff changeset
133 To try out the messages with Vim use:
22071
aa91480771fe patch 8.2.1585: messages in globals.h not translated
Bram Moolenaar <Bram@vim.org>
parents: 21989
diff changeset
134 make tryoutinstall
21989
52e970719f4b patch 8.2.1544: cannot translate messages in a Vim script
Bram Moolenaar <Bram@vim.org>
parents: 16023
diff changeset
135 And run Vim with $VIMRUNTIME set to ../runtime
52e970719f4b patch 8.2.1544: cannot translate messages in a Vim script
Bram Moolenaar <Bram@vim.org>
parents: 16023
diff changeset
136
4502
605c9ce57ec3 Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents: 1125
diff changeset
137
605c9ce57ec3 Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents: 1125
diff changeset
138 USING GETTEXT WITHOUT ICONV
605c9ce57ec3 Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents: 1125
diff changeset
139
605c9ce57ec3 Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents: 1125
diff changeset
140 When using gettext which doesn't support iconv, the encoding of the .mo file
605c9ce57ec3 Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents: 1125
diff changeset
141 must match your active encoding. For that you must convert and change
605c9ce57ec3 Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents: 1125
diff changeset
142 encoding of *.po file in advance of generating the *.mo file. For example, to
605c9ce57ec3 Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents: 1125
diff changeset
143 convert ja.po to EUC-JP (supposed as your system encoding):
605c9ce57ec3 Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents: 1125
diff changeset
144
605c9ce57ec3 Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents: 1125
diff changeset
145 (1) Convert the file encoding:
605c9ce57ec3 Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents: 1125
diff changeset
146
605c9ce57ec3 Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents: 1125
diff changeset
147 mv ja.po ja.po.orig
605c9ce57ec3 Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents: 1125
diff changeset
148 iconv -f utf-8 -t euc-jp ja.po.orig > ja.po
605c9ce57ec3 Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents: 1125
diff changeset
149
605c9ce57ec3 Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents: 1125
diff changeset
150 (2) Rewrite charset declaration in the file:
605c9ce57ec3 Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents: 1125
diff changeset
151
605c9ce57ec3 Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents: 1125
diff changeset
152 Open ja.po find this line:
605c9ce57ec3 Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents: 1125
diff changeset
153 "Content-Type: text/plain; charset=utf-8\n"
605c9ce57ec3 Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents: 1125
diff changeset
154 You should change "charset" like this:
605c9ce57ec3 Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents: 1125
diff changeset
155 "Content-Type: text/plain; charset=euc-jp\n"
605c9ce57ec3 Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents: 1125
diff changeset
156
605c9ce57ec3 Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents: 1125
diff changeset
157 There are examples in the Makefile for the conversions already supported.