docs: remove remaining mentions of hkmap (#28038)

This commit is contained in:
zeertzjq 2024-03-26 18:30:17 +08:00 committed by GitHub
parent a142670360
commit 3f3c7299a1
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
9 changed files with 26 additions and 67 deletions

View File

@ -274,14 +274,6 @@ CTRL-P command-line completion (see |cmdline-completion|)
CTRL-A command-line completion (see |cmdline-completion|)
CTRL-L command-line completion (see |cmdline-completion|)
*c_CTRL-_*
CTRL-_ Switch between Hebrew and English keyboard mode, which is
private to the command-line and not related to hkmap.
This is useful when Hebrew text entry is required in the
command-line, searches, abbreviations, etc. Applies only if
the 'allowrevins' option is set.
See |rileft.txt|.
*c_CTRL-^*
CTRL-^ Toggle the use of language |:lmap| mappings and/or Input
Method.

View File

@ -14,7 +14,7 @@ currently helping support these features.
------------------------------------------------------------------------------
Introduction
Hebrew-specific options are 'hkmap', 'hkmapp' 'keymap'=hebrew and 'aleph'.
Hebrew-specific 'keymap' values are "hebrew" and "hebrewp".
Hebrew-useful options are 'delcombine', 'allowrevins', 'revins', 'rightleft'
and 'rightleftcmd'.
@ -30,7 +30,7 @@ Details
+ 'rightleft' ('rl') sets window orientation to right-to-left. This means
that the logical text 'ABC' will be displayed as 'CBA', and will start
drawing at the right edge of the window, not the left edge.
+ 'keymap' ('kmp') sets keyboard mapping. use values "hebrew" or "heprewp"
+ 'keymap' ('kmp') sets keyboard mapping. use values "hebrew" or "hebrewp"
(the latter option enables phonetic mapping)
+ 'delcombine' ('deco'), boolean, allows one to remove the niqud or
te`amim by pressing 'x' on a character (with associated niqud).
@ -41,35 +41,23 @@ Details
+ Encoding:
+ Under Unix, ISO 8859-8 encoding (Hebrew letters codes: 224-250).
+ Under MS DOS, PC encoding (Hebrew letters codes: 128-154).
These are defaults, that can be overridden using the 'aleph' option.
+ You should prefer using UTF8, as it supports the combining-characters
('deco' does nothing if UTF8 encoding is not active).
+ Vim arguments:
+ `vim -H file` starts editing a Hebrew file, i.e. 'rightleft' and 'hkmap'
are set.
+ `vim -H file` starts editing a Hebrew file, i.e. 'rightleft' is set and
'keymap' is set to "hebrew".
+ Keyboard:
+ The 'allowrevins' option enables the CTRL-_ command in Insert mode and
in Command-line mode.
+ The 'allowrevins' option enables the CTRL-_ command in Insert mode.
+ CTRL-_ in insert/replace modes toggles 'revins' and 'hkmap' as follows:
When in rightleft window, 'revins' is toggled, since
English will likely be inserted in this case.
When in norightleft window, 'revins' is toggled, since Hebrew
will likely be inserted in this case.
+ CTRL-_ in Insert mode toggles 'revins'.
CTRL-_ moves the cursor to the end of the typed text.
+ CTRL-_ in command mode only toggles keyboard mapping (see Bugs below).
This setting is independent of 'hkmap' option, which only applies to
insert/replace mode.
Note: On some keyboards, CTRL-_ is mapped to CTRL-?.
+ Keyboard mapping while 'hkmap' is set (standard Israeli keyboard):
+ Keyboard mapping while 'keymap' is "hebrew" (standard Israeli keyboard):
q w e r t y u i o p
/ ' ק ר א ט ו ן ם פ
@ -80,11 +68,8 @@ Details
z x c v b n m , . /
ז ס ב ה נ מ צ ת ץ .
This is also the keymap when 'keymap=hebrew' is set. The advantage of
'keymap' is that it works properly when using UTF8, e.g. it inserts the
correct characters; 'hkmap' does not. The 'keymap' keyboard can also
insert niqud and te`amim. To see what those mappings are, look at the
keymap file 'hebrew.vim' etc.
The 'keymap' keyboard can also insert niqud and te`amim. To see what
those mappings are, look at the keymap file hebrew.vim etc.
Typing backwards
@ -102,13 +87,7 @@ If the 'showmode' option is set, "-- REVERSE INSERT --" will be shown in the
status line when reverse Insert mode is active.
When the 'allowrevins' option is set, reverse Insert mode can be also entered
via CTRL-_, which has some extra functionality: First, keyboard mapping is
changed according to the window orientation -- if in a left-to-right window,
'revins' is used to enter Hebrew text, so the keyboard changes to Hebrew
('hkmap' is set); if in a right-to-left window, 'revins' is used to enter
English text, so the keyboard changes to English ('hkmap' is reset). Second,
when exiting 'revins' via CTRL-_, the cursor moves to the end of the typed
text (if possible).
and exited via CTRL-_.
------------------------------------------------------------------------------

View File

@ -92,8 +92,7 @@ tag char action in Insert mode ~
CTRL-\ others not used
|i_CTRL-]| CTRL-] trigger abbreviation
|i_CTRL-^| CTRL-^ toggle use of |:lmap| mappings
|i_CTRL-_| CTRL-_ When 'allowrevins' set: change language
(Hebrew)
|i_CTRL-_| CTRL-_ When 'allowrevins' set: toggle 'revins'
<Space> to '~' not used, except '0' and '^' followed by
CTRL-D
@ -1072,8 +1071,6 @@ tag command action in Command-line editing mode ~
CTRL-\ others not used
|c_CTRL-]| CTRL-] trigger abbreviation
|c_CTRL-^| CTRL-^ toggle use of |:lmap| mappings
|c_CTRL-_| CTRL-_ when 'allowrevins' set: change language
(Hebrew)
|c_<Del>| <Del> delete the character under the cursor
|c_<Left>| <Left> cursor left

View File

@ -225,11 +225,7 @@ CTRL-Y Insert the character which is above the cursor.
able to copy characters from a long line.
*i_CTRL-_*
CTRL-_ Switch between insert direction, by toggling 'revins', as follows:
- When in a rightleft window, 'revins' is toggled,
since English will likely be inserted in this case.
- When in a norightleft window, 'revins' is toggled,
since a rightleft language will likely be inserted in this case.
CTRL-_ Switch between insert direction, by toggling 'revins'.
CTRL-_ moves the cursor to the end of the typed text.

View File

@ -639,10 +639,9 @@ A jump table for the options with a short description can be found at |Q_op|.
*'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
'allowrevins' 'ari' boolean (default off)
global
Allow CTRL-_ in Insert and Command-line mode. This is default off, to
avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
into reverse Insert mode, and don't know how to get out. See
'revins'.
Allow CTRL-_ in Insert mode. This is default off, to avoid that users
that accidentally type CTRL-_ instead of SHIFT-_ get into reverse
Insert mode, and don't know how to get out. See 'revins'.
*'ambiwidth'* *'ambw'*
'ambiwidth' 'ambw' string (default "single")

View File

@ -620,8 +620,7 @@ In Insert or Command-line mode:
the help
Short explanation of each option: *option-list*
'aleph' 'al' ASCII code of the letter Aleph (Hebrew)
'allowrevins' 'ari' allow CTRL-_ in Insert and Command-line mode
'allowrevins' 'ari' allow CTRL-_ in Insert mode
'ambiwidth' 'ambw' what to do with Unicode chars of ambiguous width
'arabic' 'arab' for Arabic as a default second language
'arabicshape' 'arshape' do shaping for Arabic characters
@ -739,8 +738,6 @@ Short explanation of each option: *option-list*
'helplang' 'hlg' preferred help languages
'hidden' 'hid' don't unload buffer when it is |abandon|ed
'history' 'hi' number of command-lines that are remembered
'hkmap' 'hk' Hebrew keyboard mapping
'hkmapp' 'hkp' phonetic Hebrew keyboard mapping
'hlsearch' 'hls' highlight matches with last search pattern
'icon' let Vim set the text of the window icon
'iconstring' string to use for the Vim icon text
@ -1141,7 +1138,7 @@ Context-sensitive completion on the command-line:
|-b| -b binary mode
|-l| -l lisp mode
|-A| -A Arabic mode ('arabic' is set)
|-H| -H Hebrew mode ('hkmap' and 'rightleft' are set)
|-H| -H Hebrew mode (Hebrew keymap & 'rightleft' are set)
|-V| -V Verbose, give informative messages
|-r| -r give list of swap files
|-r| -r {file} .. recover aborted edit session

View File

@ -260,7 +260,8 @@ argument.
-A Arabic mode. Sets the 'arabic' option on.
*-H*
-H Hebrew mode. Sets the 'rightleft' option on and 'keymap' to "hebrew"
-H Hebrew mode. Sets the 'rightleft' option on and the 'keymap'
option to "hebrew".
*-V* *verbose*
-V[N] Verbose. Sets the 'verbose' option to [N] (default: 10).

View File

@ -11,10 +11,9 @@ vim.bo = vim.bo
---@field [integer] vim.wo
vim.wo = vim.wo
--- Allow CTRL-_ in Insert and Command-line mode. This is default off, to
--- avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
--- into reverse Insert mode, and don't know how to get out. See
--- 'revins'.
--- Allow CTRL-_ in Insert mode. This is default off, to avoid that users
--- that accidentally type CTRL-_ instead of SHIFT-_ get into reverse
--- Insert mode, and don't know how to get out. See 'revins'.
---
--- @type boolean
vim.o.allowrevins = false

View File

@ -99,14 +99,13 @@ return {
abbreviation = 'ari',
defaults = { if_true = false },
desc = [=[
Allow CTRL-_ in Insert and Command-line mode. This is default off, to
avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
into reverse Insert mode, and don't know how to get out. See
'revins'.
Allow CTRL-_ in Insert mode. This is default off, to avoid that users
that accidentally type CTRL-_ instead of SHIFT-_ get into reverse
Insert mode, and don't know how to get out. See 'revins'.
]=],
full_name = 'allowrevins',
scope = { 'global' },
short_desc = N_('allow CTRL-_ in Insert and Command-line mode'),
short_desc = N_('allow CTRL-_ in Insert mode'),
type = 'boolean',
varname = 'p_ari',
},