annotate src/po/README.txt @ 7:3fc0f57ecb91 v7.0001

updated for version 7.0001
author vimboss
date Sun, 13 Jun 2004 20:20:40 +0000
parents
children eb531146be0e
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
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
15 some encodings. This folows the C99 standard for strings. It means that when
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
16 a multi-byte character includes the 0x5c byte, this is not recognized as a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
17 backslash. Since this format is incompatible with Solaris, Vim uses the old
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
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
23
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
24 ON MS-WINDOWS
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
25
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
26 The distributed files are generated on Unix, but this should also be possible
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
27 on MS-Windows. Download the gettext packages, for example from:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
28
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
29 http://sourceforge.net/projects/gettext
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
30
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
31 You might have to do the commands manually. Example:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
32
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
33 cd c:\vim\vim60
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
34 mkdir runtime\lang\ja\LC_MESSAGES
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
35 msgfmt -o runtime\lang\ja\LC_MESSAGES\vim.mo src\po\ja.po
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
36
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
37
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
38 WHEN THERE IS A MISTAKE
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
39
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
40 If you find there is a mistake in one of the translations, please report this
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
41 to the maintainer of the translation. His/her E-mail address is in the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
42 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
43 command in Vim when the translation is being used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
44
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
45
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
46 CREATING A NEW PO FILE
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
47
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
48 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
49 language.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
50
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
51 - Edit Makefile to add xx to LANGUAGES and xx.mo to MOFILES.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
52 - Copy the header of an existing file, e.g., de.po, to xx.po. Do not copy any
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
53 of the translated messages, delete everything after the "msgstr".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
54 - The remaining work is like updating, see the next section.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
55
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
56
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
57 UPDATING A PO FILE
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
58
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
59 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
60 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
61 language.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
62
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
63 (1) Add new and changed messages from the Vim sources:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
64
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
65 make xx
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
66
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
67 This will extract all the strings from Vim and merge them in with the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
68 existing translations. Requires the GNU gettext utilities. Also requires
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
69 unpacking the extra archive.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
70 Your original xx.po file will be copied to xx.po.orig
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
71
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
72 -- After you do this, you MUST do the next three steps! --
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
73
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
74 (2) Translate
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
75 See the gettext documentation on how to do this. You can also find
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
76 examples in the other po files.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
77 Search the po file for items that require translation:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
78
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
79 /fuzzy\|^msgstr ""\(\n"\)\@!
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
80
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
81 Remove the "#, fuzzy" line after adding the translation.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
82
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
83 There is one special message:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
84 msgid "Messages maintainer: Bram Moolenaar <Bram@vim.org>"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
85 You should include your name and E-mail address instead, for example:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
86 msgstr "Berichten übersetzt bei: John Doe <john@doe.org>"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
87
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
88 (3) Clean up
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
89 This is very important to make sure the translation works on all systems.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
90 Comment-out all non-translated strings. There are two types:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
91 - items marked with "#, fuzzy"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
92 - items with an empty msgstr
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
93 You can do this with the cleanup.vim script:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
94
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
95 :source cleanup.vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
96
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
97 Background: on Solaris an empty msgstr results in an empty message; GNU
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
98 gettext ignores empty strings and items marked with "#, fuzzy".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
99
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
100 (4) Check:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
101
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
102 make xx.mo
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
103
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
104 Look out for syntax errors and fix them.