runtime/doc/rileft.txt

   1 *rileft.txt*    For Vim version 7.1.  Last change: 2006 Apr 24
   2
   3
   4                   VIM REFERENCE MANUAL    by Avner Lottem
   5                                           updated by Nadim Shaikli
   6
   7
   8 Right to Left display mode for Vim                              *rileft*
   9
  10
  11 These functions were originally created by Avner Lottem:
  12    E-mail: alottem@iil.intel.com
  13    Phone:  +972-4-8307322
  14
  15 {Vi does not have any of these commands}
  16
  17                                                                 *E26*
  18 This feature is only available when the |+rightleft| feature was enabled
  19 at compile time.
  20
  21
  22 Introduction
  23 ------------
  24 Some languages such as Arabic, Farsi, Hebrew (among others) require the
  25 ability to display their text from right-to-left.  Files in those languages
  26 are stored conventionally and the right-to-left requirement is only a
  27 function of the display engine (per the Unicode specification).  In
  28 right-to-left oriented files the characters appear on the screen from
  29 right to left.
  30
  31 Bidirectionality (or bidi for short) is what Unicode offers as a full
  32 solution to these languages.  Bidi offers the user the ability to view
  33 both right-to-left as well as left-to-right text properly at the same time
  34 within the same window.  Vim currently, due to simplicity, does not offer
  35 bidi and is merely opting to present a functional means to display/enter/use
  36 right-to-left languages.  An older hybrid solution in which direction is
  37 encoded for every character (or group of characters) are not supported either
  38 as this kind of support is out of the scope of a simple addition to an
  39 existing editor (and it's not sanctioned by Unicode either).
  40
  41
  42 Highlights
  43 ----------
  44 o  Editing left-to-right files as in the original Vim, no change.
  45
  46 o  Viewing and editing files in right-to-left windows.  File orientation
  47    is per window, so it is possible to view the same file in right-to-left
  48    and left-to-right modes, simultaneously.  (Useful for editing mixed files
  49    in which both right-to-left and left-to-right text exist).
  50
  51 o  Compatibility to the original Vim.  Almost all features work in
  52    right-to-left mode (see Bugs below).
  53
  54 o  Backing from reverse insert mode to the correct place in the file
  55    (if possible).
  56
  57 o  No special terminal with right-to-left capabilities is required.  The
  58    right-to-left changes are completely hardware independent.
  59
  60 o  Many languages use and require right-to-left support.  These languages
  61    can quite easily be supported given the inclusion of their required
  62    keyboard mappings and some possible minor code change.  Some of the
  63    current supported languages include - |arabic.txt|, |farsi.txt| and
  64    |hebrew.txt|.
  65
  66
  67 Of Interest...
  68 --------------
  69
  70 o  Invocations
  71    -----------
  72    + 'rightleft' ('rl') sets window orientation to right-to-left.
  73    + 'delcombine' ('deco'), boolean, if editing UTF-8 encoded languages,
  74      allows one to remove a composing character which gets superimposed
  75      on those that proceeded them (some languages require this).
  76    + 'rightleftcmd' ('rlc') sets the command-line within certain modes
  77      (such as search) to be utilized in right-to-left orientation as well.
  78
  79 o  Typing backwards                                     *ins-reverse*
  80    ----------------
  81    In lieu of using full-fledged the 'rightleft' option, one can opt for
  82    reverse insertion.  When the 'revins' (reverse insert) option is set,
  83    inserting happens backwards.  This can be used to type right-to-left
  84    text.  When inserting characters the cursor is not moved and the text
  85    moves rightwards.  A <BS> deletes the character under the cursor.
  86    CTRL-W and CTRL-U also work in the opposite direction.  <BS>, CTRL-W
  87    and CTRL-U do not stop at the start of insert or end of line, no matter
  88    how the 'backspace' option is set.
  89
  90    There is no reverse replace mode (yet).
  91
  92    If the 'showmode' option is set, "-- REVERSE INSERT --" will be shown
  93    in the status line when reverse Insert mode is active.
  94
  95 o  Pasting when in a rightleft window
  96    ----------------------------------
  97    When cutting text with the mouse and pasting it in a rightleft window
  98    the text will be reversed, because the characters come from the cut buffer
  99    from the left to the right, while inserted in the file from the right to
 100    the left.   In order to avoid it, toggle 'revins' before pasting.
 101
 102
 103 Bugs
 104 ----
 105 o  Does not handle CTRL-A and CTRL-X commands (add and subtract) correctly
 106    when in rightleft window.
 107
 108 o  Does not support reverse insert and rightleft modes on the command-line.
 109    However, functionality of the editor is not reduced, because it is
 110    possible to enter mappings, abbreviations and searches typed from the
 111    left to the right on the command-line.
 112
 113 o  Somewhat slower in right-to-left mode, because right-to-left motion is
 114    emulated inside Vim, not by the controlling terminal.
 115
 116 o  When the Athena GUI is used, the bottom scrollbar works in the wrong
 117    direction.  This is difficult to fix.
 118
 119 o  When both 'rightleft' and 'revins' are on: 'textwidth' does not work.
 120    Lines do not wrap at all; you just get a single, long line.
 121
 122 o  There is no full bidirectionality (bidi) support.
 123
 124
 125  vim:tw=78:ts=8:ft=help:norl: