diff options
| author | Noam Postavsky | 2016-08-06 09:05:05 -0400 |
|---|---|---|
| committer | Noam Postavsky | 2016-08-06 15:46:18 -0400 |
| commit | 3c9cb57c6fae57d3798298faecccd0402b4ddd9a (patch) | |
| tree | 2947c7808521acb3f5744a5e6fe1c8da7cd5017b | |
| parent | d841a03c5ee3e9a59a133474601f9bda190ee8fa (diff) | |
| download | emacs-3c9cb57c6fae57d3798298faecccd0402b4ddd9a.tar.gz emacs-3c9cb57c6fae57d3798298faecccd0402b4ddd9a.zip | |
Document use of vectors in keymaps
* doc/lispref/keymaps.texi (Format of Keymaps): Mention vector
format (Bug #14797).
| -rw-r--r-- | doc/lispref/keymaps.texi | 17 |
1 files changed, 13 insertions, 4 deletions
diff --git a/doc/lispref/keymaps.texi b/doc/lispref/keymaps.texi index f5d3811faed..2641ad0b6aa 100644 --- a/doc/lispref/keymaps.texi +++ b/doc/lispref/keymaps.texi | |||
| @@ -194,10 +194,19 @@ explicitly bound to @code{nil} (see below). | |||
| 194 | @item @var{char-table} | 194 | @item @var{char-table} |
| 195 | If an element of a keymap is a char-table, it counts as holding | 195 | If an element of a keymap is a char-table, it counts as holding |
| 196 | bindings for all character events with no modifier bits | 196 | bindings for all character events with no modifier bits |
| 197 | (@pxref{modifier bits}): element @var{n} is the binding for the | 197 | (@pxref{modifier bits}): the element whose index is @var{c} is the |
| 198 | character with code @var{n}. This is a compact way to record lots of | 198 | binding for the character @var{c}. This is a compact way to record |
| 199 | bindings. A keymap with such a char-table is called a @dfn{full | 199 | lots of bindings. A keymap with such a char-table is called a |
| 200 | keymap}. Other keymaps are called @dfn{sparse keymaps}. | 200 | @dfn{full keymap}. Other keymaps are called @dfn{sparse keymaps}. |
| 201 | |||
| 202 | @item @var{vector} | ||
| 203 | This kind of element is similar to a char-table: the element whose | ||
| 204 | index is @var{c} is the binding for the character @var{c}. Since the | ||
| 205 | range of characters that can be bound this way is limited by the | ||
| 206 | vector size, and vector creation allocates space for all character | ||
| 207 | codes from 0 up, this format should not be used except for creating | ||
| 208 | menu keymaps (@pxref{Menu Keymaps}), where the bindings themselves | ||
| 209 | don't matter. | ||
| 201 | 210 | ||
| 202 | @item @var{string} | 211 | @item @var{string} |
| 203 | @cindex keymap prompt string | 212 | @cindex keymap prompt string |