runtime/doc/hebrew.txt

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