Mercurial > vim
annotate runtime/doc/mlang.txt @ 7659:07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Author: Bram Moolenaar <Bram@vim.org>
Date: Sun Jan 17 22:26:33 2016 +0100
Update help files.
| author | Christian Brabandt <cb@256bit.org> |
|---|---|
| date | Sun, 17 Jan 2016 22:30:06 +0100 |
| parents | 359743c1f59a |
| children | 9f48eab77d62 |
| rev | line source |
|---|---|
|
7659
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
5294
diff
changeset
|
1 *mlang.txt* For Vim version 7.4. Last change: 2016 Jan 16 |
| 7 | 2 |
| 3 | |
| 4 VIM REFERENCE MANUAL by Bram Moolenaar | |
| 5 | |
| 6 | |
| 7 Multi-language features *multilang* *multi-lang* | |
| 8 | |
| 9 This is about using messages and menus in various languages. For editing | |
| 10 multi-byte text see |multibyte|. | |
| 11 | |
| 12 The basics are explained in the user manual: |usr_45.txt|. | |
| 13 | |
| 14 1. Messages |multilang-messages| | |
| 15 2. Menus |multilang-menus| | |
| 16 3. Scripts |multilang-scripts| | |
| 17 | |
| 18 Also see |help-translated| for multi-language help. | |
| 19 | |
| 20 {Vi does not have any of these features} | |
| 21 {not available when compiled without the |+multi_lang| feature} | |
| 22 | |
| 23 ============================================================================== | |
| 24 1. Messages *multilang-messages* | |
| 25 | |
| 26 Vim picks up the locale from the environment. In most cases this means Vim | |
| 27 will use the language that you prefer, unless it's not available. | |
| 28 | |
| 29 To see a list of supported locale names on your system, look in one of these | |
| 30 directories (for Unix): | |
| 31 /usr/lib/locale ~ | |
| 32 /usr/share/locale ~ | |
| 33 Unfortunately, upper/lowercase differences matter. Also watch out for the | |
| 34 use of "-" and "_". | |
| 35 | |
| 36 *:lan* *:lang* *:language* *E197* | |
| 37 :lan[guage] | |
| 38 :lan[guage] mes[sages] | |
| 39 :lan[guage] cty[pe] | |
| 40 :lan[guage] tim[e] | |
| 41 Print the current language (aka locale). | |
| 42 With the "messages" argument the language used for | |
| 43 messages is printed. Technical: LC_MESSAGES. | |
| 44 With the "ctype" argument the language used for | |
| 45 character encoding is printed. Technical: LC_CTYPE. | |
| 46 With the "time" argument the language used for | |
| 47 strftime() is printed. Technical: LC_TIME. | |
| 48 Without argument all parts of the locale are printed | |
| 49 (this is system dependent). | |
| 50 The current language can also be obtained with the | |
| 51 |v:lang|, |v:ctype| and |v:lc_time| variables. | |
| 52 | |
| 53 :lan[guage] {name} | |
| 54 :lan[guage] mes[sages] {name} | |
| 55 :lan[guage] cty[pe] {name} | |
| 56 :lan[guage] tim[e] {name} | |
| 57 Set the current language (aka locale) to {name}. | |
| 58 The locale {name} must be a valid locale on your | |
| 59 system. Some systems accept aliases like "en" or | |
| 60 "en_US", but some only accept the full specification | |
|
2348
8878a9f8db87
Rename w_p_conceal to w_p_conc for consistency.
Bram Moolenaar <bram@vim.org>
parents:
2345
diff
changeset
|
61 like "en_US.ISO_8859-1". On Unix systems you can use |
| 3281 | 62 this command to see what locales are supported: > |
|
2348
8878a9f8db87
Rename w_p_conceal to w_p_conc for consistency.
Bram Moolenaar <bram@vim.org>
parents:
2345
diff
changeset
|
63 :!locale -a |
|
8878a9f8db87
Rename w_p_conceal to w_p_conc for consistency.
Bram Moolenaar <bram@vim.org>
parents:
2345
diff
changeset
|
64 < With the "messages" argument the language used for |
| 7 | 65 messages is set. This can be different when you want, |
| 66 for example, English messages while editing Japanese | |
| 67 text. This sets $LC_MESSAGES. | |
| 68 With the "ctype" argument the language used for | |
| 69 character encoding is set. This affects the libraries | |
| 70 that Vim was linked with. It's unusual to set this to | |
| 2681 | 71 a different value from 'encoding' or "C". This sets |
| 7 | 72 $LC_CTYPE. |
| 73 With the "time" argument the language used for time | |
| 74 and date messages is set. This affects strftime(). | |
| 75 This sets $LC_TIME. | |
| 76 Without an argument both are set, and additionally | |
| 77 $LANG is set. | |
| 1619 | 78 When compiled with the |+float| feature the LC_NUMERIC |
| 79 value will always be set to "C", so that floating | |
| 80 point numbers use '.' as the decimal point. | |
| 7 | 81 This will make a difference for items that depend on |
| 82 the language (some messages, time and date format). | |
| 83 Not fully supported on all systems | |
| 84 If this fails there will be an error message. If it | |
| 85 succeeds there is no message. Example: > | |
| 86 :language | |
| 87 Current language: C | |
| 88 :language de_DE.ISO_8859-1 | |
| 89 :language mes | |
| 90 Current messages language: de_DE.ISO_8859-1 | |
| 91 :lang mes en | |
| 92 < | |
| 93 | |
| 94 MS-WINDOWS MESSAGE TRANSLATIONS *win32-gettext* | |
| 95 | |
| 96 If you used the self-installing .exe file, message translations should work | |
| 97 already. Otherwise get the libintl.dll file if you don't have it yet: | |
| 98 | |
| 99 http://sourceforge.net/projects/gettext | |
|
7659
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
5294
diff
changeset
|
100 Or: |
|
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
5294
diff
changeset
|
101 https://mlocati.github.io/gettext-iconv-windows/ |
| 7 | 102 |
| 103 This also contains tools xgettext, msgformat and others. | |
| 104 | |
| 105 libintl.dll should be placed in same directory with (g)vim.exe, or some | |
|
7659
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
5294
diff
changeset
|
106 place where PATH environment value describe. Vim also finds libintl-8.dll. |
|
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
5294
diff
changeset
|
107 Message files (vim.mo) have to be placed in "$VIMRUNTIME/lang/xx/LC_MESSAGES", |
|
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
5294
diff
changeset
|
108 where "xx" is the abbreviation of the language (mostly two letters). |
| 7 | 109 |
| 110 If you write your own translations you need to generate the .po file and | |
| 111 convert it to a .mo file. You need to get the source distribution and read | |
| 112 the file "src/po/README.txt". | |
| 113 | |
| 114 To overrule the automatic choice of the language, set the $LANG variable to | |
| 115 the language of your choice. use "en" to disable translations. > | |
| 116 | |
| 117 :let $LANG = 'ja' | |
| 118 | |
| 119 (text for Windows by Muraoka Taro) | |
| 120 | |
| 121 ============================================================================== | |
| 122 2. Menus *multilang-menus* | |
| 123 | |
| 1121 | 124 See |45.2| for the basics, esp. using 'langmenu'. |
| 7 | 125 |
| 126 Note that if changes have been made to the menus after the translation was | |
| 127 done, some of the menus may be shown in English. Please try contacting the | |
| 128 maintainer of the translation and ask him to update it. You can find the | |
| 129 name and e-mail address of the translator in | |
| 130 "$VIMRUNTIME/lang/menu_<lang>.vim". | |
| 131 | |
| 132 To set the font (or fontset) to use for the menus, use the |:highlight| | |
| 133 command. Example: > | |
| 134 | |
| 135 :highlight Menu font=k12,r12 | |
| 136 | |
| 137 | |
| 138 ALIAS LOCALE NAMES | |
| 139 | |
| 140 Unfortunately, the locale names are different on various systems, even though | |
| 141 they are for the same language and encoding. If you do not get the menu | |
| 142 translations you expected, check the output of this command: > | |
| 143 | |
| 144 echo v:lang | |
| 145 | |
| 146 Now check the "$VIMRUNTIME/lang" directory for menu translation files that use | |
| 147 a similar language. A difference in a "-" being a "_" already causes a file | |
| 148 not to be found! Another common difference to watch out for is "iso8859-1" | |
| 149 versus "iso_8859-1". Fortunately Vim makes all names lowercase, thus you | |
| 150 don't have to worry about case differences. Spaces are changed to | |
| 151 underscores, to avoid having to escape them. | |
| 152 | |
| 153 If you find a menu translation file for your language with a different name, | |
| 154 create a file in your own runtime directory to load that one. The name of | |
| 155 that file could be: > | |
| 156 | |
| 157 ~/.vim/lang/menu_<v:lang>.vim | |
| 158 | |
| 159 Check the 'runtimepath' option for directories which are searched. In that | |
| 160 file put a command to load the menu file with the other name: > | |
| 161 | |
| 162 runtime lang/menu_<other_lang>.vim | |
| 163 | |
| 164 | |
| 165 TRANSLATING MENUS | |
| 166 | |
| 167 If you want to do your own translations, you can use the |:menutrans| command, | |
| 168 explained below. It is recommended to put the translations for one language | |
| 169 in a Vim script. For a language that has no translation yet, please consider | |
| 170 becoming the maintainer and make your translations available to all Vim users. | |
| 171 Send an e-mail to the Vim maintainer <maintainer@vim.org>. | |
| 172 | |
| 173 *:menut* *:menutrans* *:menutranslate* | |
| 174 :menut[ranslate] clear | |
| 175 Clear all menu translations. | |
| 176 | |
| 177 :menut[ranslate] {english} {mylang} | |
| 178 Translate menu name {english} to {mylang}. All | |
| 179 special characters like "&" and "<Tab>" need to be | |
| 180 included. Spaces and dots need to be escaped with a | |
| 181 backslash, just like in other |:menu| commands. | |
| 182 | |
| 183 See the $VIMRUNTIME/lang directory for examples. | |
| 184 | |
| 185 To try out your translations you first have to remove all menus. This is how | |
| 186 you can do it without restarting Vim: > | |
| 187 :source $VIMRUNTIME/delmenu.vim | |
| 188 :source <your-new-menu-file> | |
| 189 :source $VIMRUNTIME/menu.vim | |
| 190 | |
| 191 Each part of a menu path is translated separately. The result is that when | |
| 192 "Help" is translated to "Hilfe" and "Overview" to "Überblick" then | |
| 193 "Help.Overview" will be translated to "Hilfe.Überblick". | |
| 194 | |
| 195 ============================================================================== | |
| 196 3. Scripts *multilang-scripts* | |
| 197 | |
| 198 In Vim scripts you can use the |v:lang| variable to get the current language | |
| 199 (locale). The default value is "C" or comes from the $LANG environment | |
| 200 variable. | |
| 201 | |
| 202 The following example shows how this variable is used in a simple way, to make | |
| 203 a message adapt to language preferences of the user, > | |
| 204 | |
| 205 :if v:lang =~ "de_DE" | |
| 206 : echo "Guten Morgen" | |
| 207 :else | |
| 208 : echo "Good morning" | |
| 209 :endif | |
| 210 < | |
| 211 | |
| 212 vim:tw=78:sw=4:ts=8:ft=help:norl: |