annotate src/po/README_mvc.txt @ 30128:6d0056cc21a0 v9.0.0400

patch 9.0.0400: GUI test sometimes hangs on CI Commit: https://github.com/vim/vim/commit/e68f1348f25766c669e27e1f7da2453c46e4c981 Author: K.Takata <kentkt@csc.jp> Date: Wed Sep 7 13:01:11 2022 +0100 patch 9.0.0400: GUI test sometimes hangs on CI Problem: GUI test sometimes hangs on CI. Solution: Delete a test file explicitly. (Ken Takata, closes https://github.com/vim/vim/issues/11072)
author Bram Moolenaar <Bram@vim.org>
date Wed, 07 Sep 2022 14:15:06 +0200
parents 7e367104f6b6
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
2472
3567e0d56891 Updated version of gettext for use with MVC. (Mike Williams)
Bram Moolenaar <bram@vim.org>
parents: 1121
diff changeset
3 This file explains how to create and maintain po files using a number of
3567e0d56891 Updated version of gettext for use with MVC. (Mike Williams)
Bram Moolenaar <bram@vim.org>
parents: 1121
diff changeset
4 GnuWin packages. You will need gettext, libiconv and libexpat. As of
3567e0d56891 Updated version of gettext for use with MVC. (Mike Williams)
Bram Moolenaar <bram@vim.org>
parents: 1121
diff changeset
5 August 2010 the versions known to work are gettext 0.14.4, libiconv 1.9.2-1
3567e0d56891 Updated version of gettext for use with MVC. (Mike Williams)
Bram Moolenaar <bram@vim.org>
parents: 1121
diff changeset
6 and expat 2.0.1. gettext and libiconv can be found at:
3567e0d56891 Updated version of gettext for use with MVC. (Mike Williams)
Bram Moolenaar <bram@vim.org>
parents: 1121
diff changeset
7
3567e0d56891 Updated version of gettext for use with MVC. (Mike Williams)
Bram Moolenaar <bram@vim.org>
parents: 1121
diff changeset
8 http://gnuwin32.sourceforge.net/
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9
2472
3567e0d56891 Updated version of gettext for use with MVC. (Mike Williams)
Bram Moolenaar <bram@vim.org>
parents: 1121
diff changeset
10 expat can be found at:
3567e0d56891 Updated version of gettext for use with MVC. (Mike Williams)
Bram Moolenaar <bram@vim.org>
parents: 1121
diff changeset
11
3567e0d56891 Updated version of gettext for use with MVC. (Mike Williams)
Bram Moolenaar <bram@vim.org>
parents: 1121
diff changeset
12 http://sourceforge.net/projects/expat/
3567e0d56891 Updated version of gettext for use with MVC. (Mike Williams)
Bram Moolenaar <bram@vim.org>
parents: 1121
diff changeset
13
3567e0d56891 Updated version of gettext for use with MVC. (Mike Williams)
Bram Moolenaar <bram@vim.org>
parents: 1121
diff changeset
14 expat will install into its own directory. You should copy libexpat.dll into
3567e0d56891 Updated version of gettext for use with MVC. (Mike Williams)
Bram Moolenaar <bram@vim.org>
parents: 1121
diff changeset
15 the bin directory created from the gettext/libiconv packages.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
16
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
17 First read the README.txt file in this directory for general remarks on
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
18 translating Vim messages.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
19
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
20
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
21 SETUP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
22
1121
e63691e7c504 updated for version 7.1a
vimboss
parents: 7
diff changeset
23 Set the environment variable LANGUAGE to the language code for the language
e63691e7c504 updated for version 7.1a
vimboss
parents: 7
diff changeset
24 you are translating Vim messages to. Language codes are typically two
e63691e7c504 updated for version 7.1a
vimboss
parents: 7
diff changeset
25 characters and you can find a list of them at:
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
26
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
27 http://www.geocities.com/click2speak/languages.html
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
28
1121
e63691e7c504 updated for version 7.1a
vimboss
parents: 7
diff changeset
29 Another possibility is to use the gnuwin32 port of gettext. This is
e63691e7c504 updated for version 7.1a
vimboss
parents: 7
diff changeset
30 recommended especially if you use already gnuwin32 tools to gunzip, bunzip,
e63691e7c504 updated for version 7.1a
vimboss
parents: 7
diff changeset
31 patch etc. these files. You find the gnuwin32 version of gettext here:
e63691e7c504 updated for version 7.1a
vimboss
parents: 7
diff changeset
32
e63691e7c504 updated for version 7.1a
vimboss
parents: 7
diff changeset
33 http://gnuwin32.sourceforge.net/packages/gettext.htm
e63691e7c504 updated for version 7.1a
vimboss
parents: 7
diff changeset
34
e63691e7c504 updated for version 7.1a
vimboss
parents: 7
diff changeset
35 Yet another very strait forward way is to get the sources of gettext from
e63691e7c504 updated for version 7.1a
vimboss
parents: 7
diff changeset
36
e63691e7c504 updated for version 7.1a
vimboss
parents: 7
diff changeset
37 http://www.gnu.org/software/gettext/gettext.html
e63691e7c504 updated for version 7.1a
vimboss
parents: 7
diff changeset
38
e63691e7c504 updated for version 7.1a
vimboss
parents: 7
diff changeset
39 and build your own version of these tools. The documentation states that this
e63691e7c504 updated for version 7.1a
vimboss
parents: 7
diff changeset
40 should be possible with MSVC4.0, MSVC5.0, MSVC6.0 or MSVC7.0, but you can
e63691e7c504 updated for version 7.1a
vimboss
parents: 7
diff changeset
41 build it even successfully with MSVC8.0.
e63691e7c504 updated for version 7.1a
vimboss
parents: 7
diff changeset
42
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
43 The LANGUAGE environment variable can be set from the command line, by adding
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
44 a line to your autoexec.bat file, or by defining a user variable from the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
45 Advanced tab in the System control panel.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
46
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
47 Next, edit Make_mvc.mak so that GETTEXT_PATH points the binary directory of
1121
e63691e7c504 updated for version 7.1a
vimboss
parents: 7
diff changeset
48 the installation.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
49
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
50
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
51 CREATING A NEW TRANSLATION
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
52
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
53 When creating a new translation you must add your language code to the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
54 Make_mvc.mak file in the lines defining LANGUAGES and MOFILES. To create the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
55 initial .po file for your language you must use the command:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
56
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
57 make -f make_mvc.mak first_time
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
58
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
59 Note: You need to be in the po directory when using this makefile.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
60
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
61 Once you have your new .po file load it into Vim and source cleanup.vim, this
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
62 will convert untranslated messages to comments. If you have syntax
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
63 highlighting turned on then untranslated messages will stand out more easily.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
64
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
65 You will also need to edit the file names in the comments in the .po file.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
66 You need to remove the absolute directory specification (which has the form
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
67 c:\vim61\src\). You can do this in Vim with the following command with the
1121
e63691e7c504 updated for version 7.1a
vimboss
parents: 7
diff changeset
68 appropriate directory specification for where you have installed the Vim
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
69 source:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
70
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
71 %s/c:\\vim61\\src\\//g
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
72
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
73
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
74 UPDATING A TRANSLATION
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
75
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
76 If there are new or changed messages in Vim that need translating, then the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
77 first thing to do is merge them into the existing translations. This is done
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
78 with the following command:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
79
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
80 nmake -f Make_mvc.mak xx.po
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
81
1121
e63691e7c504 updated for version 7.1a
vimboss
parents: 7
diff changeset
82 where xx is the language code for the language needing translations. The
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
83 original .po file is copied to xx.po.orig.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
84
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
85
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
86 DOING THE TRANSLATION
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
87
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
88 Now that you have a .po file you can do the translations for all messages that
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
89 need it. See README.txt for specific instructions.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
90
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
91 Once you have finished translating the messages you should make sure all
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
92 non-translated strings are commented out. This can be done by sourcing
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
93 cleanup.vim once again.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
94
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
95
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
96 CHECKING THE TRANSLATION
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
97
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
98 Check the translation with the following command:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
99
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
100 nmake -f make_mvc.mak xx.mo
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
101
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
102 Correct any syntax errors reported. When there are no more errors, the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
103 translation is ready to be installed.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
104
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
105
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
106 INSTALLING THE TRANSLATION
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
107
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
108 Install your translation with the following command:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
109
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
110 nmake -f make_mvc.mak install
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
111
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
112 This will create the xx\LC_MESSAGES directory in runtime\lang if it does not
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
113 already exist.
7374
7e367104f6b6 commit https://github.com/vim/vim/commit/013806229a1e15480592f6bc8453130685ec750b
Christian Brabandt <cb@256bit.org>
parents: 2472
diff changeset
114 You can also use the following command to install all languages:
7e367104f6b6 commit https://github.com/vim/vim/commit/013806229a1e15480592f6bc8453130685ec750b
Christian Brabandt <cb@256bit.org>
parents: 2472
diff changeset
115
7e367104f6b6 commit https://github.com/vim/vim/commit/013806229a1e15480592f6bc8453130685ec750b
Christian Brabandt <cb@256bit.org>
parents: 2472
diff changeset
116 nmake -f make_mvc.mak install-all
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
117
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
118
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
119 vim:tw=78: