share/vim/vim73/doc/hebrew.txt

   1 *hebrew.txt*    For Vim version 7.3.  Last change: 2007 Jun 14
   2
   3
   4            VIM REFERENCE MANUAL    by Ron Aaron (and Avner Lottem)
   5
   6
   7 Hebrew Language support (options & mapping) for Vim             *hebrew*
   8
   9 The supporting 'rightleft' functionality was originally created by Avner
  10 Lottem. <alottem at gmail dot com>  Ron Aaron <ron at ronware dot org> is
  11 currently helping support these features.
  12
  13 {Vi does not have any of these commands}
  14
  15 All this is only available when the |+rightleft| feature was enabled at
  16 compile time.
  17
  18
  19 Introduction
  20 ------------
  21 Hebrew-specific options are 'hkmap', 'hkmapp' 'keymap'=hebrew and 'aleph'.
  22 Hebrew-useful options are 'delcombine', 'allowrevins', 'revins', 'rightleft'
  23 and 'rightleftcmd'.
  24
  25 The 'rightleft' mode reverses the display order, so characters are displayed
  26 from right to left instead of the usual left to right.  This is useful
  27 primarily when editing Hebrew or other Middle-Eastern languages.
  28 See |rileft.txt| for further details.
  29
  30 Details
  31 --------------
  32 +  Options:
  33    +  'rightleft' ('rl') sets window orientation to right-to-left.  This means
  34       that the logical text 'ABC' will be displayed as 'CBA', and will start
  35       drawing at the right edge of the window, not the left edge.
  36    +  'hkmap' ('hk') sets keyboard mapping to Hebrew, in insert/replace modes.
  37    +  'aleph' ('al'), numeric, holds the decimal code of Aleph, for keyboard
  38       mapping.
  39    +  'hkmapp' ('hkp') sets keyboard mapping to 'phonetic hebrew'
  40
  41    NOTE: these three ('hkmap', 'hkmapp' and 'aleph') are obsolete.  You should
  42          use ":set keymap=hebrewp" instead.
  43
  44    +  'delcombine' ('deco'), boolean, if editing UTF-8 encoded Hebrew, allows
  45       one to remove the niqud or te`amim by pressing 'x' on a character (with
  46       associated niqud).
  47
  48    +  'rightleftcmd' ('rlc') makes the command-prompt for searches show up on
  49       the right side.  It only takes effect if the window is 'rightleft'.
  50
  51 +  Encoding:
  52    +  Under Unix, ISO 8859-8 encoding (Hebrew letters codes: 224-250).
  53    +  Under MS DOS, PC encoding (Hebrew letters codes: 128-154).
  54       These are defaults, that can be overridden using the 'aleph' option.
  55    +  You should prefer using UTF8, as it supports the combining-characters
  56       ('deco' does nothing if UTF8 encoding is not active).
  57
  58 +  Vim arguments:
  59    +  'vim -H file' starts editing a Hebrew file, i.e. 'rightleft' and 'hkmap'
  60       are set.
  61
  62 +  Keyboard:
  63    +  The 'allowrevins' option enables the CTRL-_ command in Insert mode and
  64       in Command-line mode.
  65
  66    +  CTRL-_ in insert/replace modes toggles 'revins' and 'hkmap' as follows:
  67
  68       When in rightleft window, 'revins' and 'nohkmap' are toggled, since
  69       English will likely be inserted in this case.
  70
  71       When in norightleft window, 'revins' 'hkmap' are toggled, since Hebrew
  72       will likely be inserted in this case.
  73
  74       CTRL-_ moves the cursor to the end of the typed text.
  75
  76    +  CTRL-_ in command mode only toggles keyboard mapping (see Bugs below).
  77       This setting is independent of 'hkmap' option, which only applies to
  78       insert/replace mode.
  79
  80       Note: On some keyboards, CTRL-_ is mapped to CTRL-?.
  81
  82    +  Keyboard mapping while 'hkmap' is set (standard Israeli keyboard):
  83
  84         q w e r t y u i o p
  85         / ' ק ר א ט ו ן ם פ
  86
  87          a s d f g h j k l ; '
  88          ש ד ג כ ע י ח ל ך ף ,
  89
  90           z x c v b n m , . /
  91           ז ס ב ה נ מ צ ת ץ .
  92
  93       This is also the keymap when 'keymap=hebrew' is set.  The advantage of
  94       'keymap' is that it works properly when using UTF8, e.g. it inserts the
  95       correct characters; 'hkmap' does not.  The 'keymap' keyboard can also
  96       insert niqud and te`amim.  To see what those mappings are,look at the
  97       keymap file 'hebrew.vim' etc.
  98
  99
 100 Typing backwards
 101
 102 If the 'revins' (reverse insert) option is set, inserting happens backwards.
 103 This can be used to type Hebrew.  When inserting characters the cursor is not
 104 moved and the text moves rightwards.  A <BS> deletes the character under the
 105 cursor.  CTRL-W and CTRL-U also work in the opposite direction.  <BS>, CTRL-W
 106 and CTRL-U do not stop at the start of insert or end of line, no matter how
 107 the 'backspace' option is set.
 108
 109 There is no reverse replace mode (yet).
 110
 111 If the 'showmode' option is set, "-- REVERSE INSERT --" will be shown in the
 112 status line when reverse Insert mode is active.
 113
 114 When the 'allowrevins' option is set, reverse Insert mode can be also entered
 115 via CTRL-_, which has some extra functionality: First, keyboard mapping is
 116 changed according to the window orientation -- if in a left-to-right window,
 117 'revins' is used to enter Hebrew text, so the keyboard changes to Hebrew
 118 ('hkmap' is set); if in a right-to-left window, 'revins' is used to enter
 119 English text, so the keyboard changes to English ('hkmap' is reset).  Second,
 120 when exiting 'revins' via CTRL-_, the cursor moves to the end of the typed
 121 text (if possible).
 122
 123
 124 Pasting when in a rightleft window
 125 ----------------------------------
 126 When cutting text with the mouse and pasting it in a rightleft window
 127 the text will be reversed, because the characters come from the cut buffer
 128 from the left to the right, while inserted in the file from the right to
 129 the left.   In order to avoid it, toggle 'revins' (by typing CTRL-? or CTRL-_)
 130 before pasting.
 131
 132
 133 Hebrew characters and the 'isprint' variable
 134 --------------------------------------------
 135 Sometimes Hebrew character codes are in the non-printable range defined by
 136 the 'isprint' variable.  For example in the Linux console, the Hebrew font
 137 encoding starts from 128, while the default 'isprint' variable is @,161-255.
 138 The result is that all Hebrew characters are displayed as ~x.  To solve this
 139 problem, set isprint=@,128-255.
 140
 141
 142  vim:tw=78:ts=8:ft=help:norl: