X-Git-Url: https://git.donarmstrong.com/dactyl.git?a=blobdiff_plain;f=common%2Flocale%2Fen-US%2Fmap.xml;h=8921e811dd9f41db269f98b0bb378e2748f45438;hb=70740024f9c028c1fd63e1a1850ab062ff956054;hp=640b321ea42acea58691bf0adf973c518c7d3b99;hpb=718c614c183350706466e22939d0101ca4c87efe;p=dactyl.git diff --git a/common/locale/en-US/map.xml b/common/locale/en-US/map.xml index 640b321..8921e81 100644 --- a/common/locale/en-US/map.xml +++ b/common/locale/en-US/map.xml @@ -1,7 +1,7 @@ - + Key mappings are the most basic means &dactyl.appName; provides for altering the actions of key presses. Each key mapping is - associated with a mode, such as insert, - normal, or - command-line, and only + associated with a mode, such as Insert, + Normal, or + Command Line, and only has effect when that mode is active. Although each mode has a full suite of internal mappings, they may be easily augmented, altered, or removed with the :map command and its @@ -54,17 +54,17 @@
n
Normal mode: When browsing normally
v
Visual mode: When selecting text with the cursor keys
i
Insert mode: When interacting with text fields on a website
-
t
TextEdit mode: When editing text fields in Vim-like NORMAL mode
-
c
Command-line mode: When typing into the &dactyl.appName; command line
+
t
Text Edit mode: When editing text fields in Vim-like Normal mode
+
c
Command Line mode: When typing into the &dactyl.appName; command line

The ordinary :map and :noremap commands - add mappings for normal and visual mode. In order to map key + add mappings for Normal and Visual mode. In order to map key bindings in a different mode, any of the mapping commands may be prefixed with one of the above letters. For instance, - :imap creates a new key mapping in insert mode, while - :cunmap removes a key mapping from command-line mode. + :imap creates a new key mapping in Insert mode, while + :cunmap removes a key mapping from Command Line mode. Other modes can be specified using the -modes option described below.

@@ -75,6 +75,15 @@ saved via the :mk&dactyl.name;rc command. +

+ The following tree represents all of the modes understood by + dactyl. Mappings for a mode also apply to its children and + descendants. So a mapping in the Base mode, for instance, is + also active in Normal and Ex mode. +

+ +&modes.tree; +

Map commands

@@ -106,6 +115,24 @@ +

+ Below is an overview of which modes each map command applies to: +

+ +
+
:map :noremap :unmap
Normal and Visual modes
+
:nmap :nnoremap :nunmap
Normal mode
+
:vmap :vnoremap :vunmap
Visual mode
+
:imap :inoremap :iunmap
Insert mode
+
:tmap :tnoremap :tunmap
Text Edit mode
+
:cmap :cnoremap :cunmap
Command Line mode
+
+ + + The -modes option, described below, provides a more flexible way + to specify the applicable modes. + +

Map options

Any of the map commands may be given the following options: @@ -119,10 +146,10 @@

-count
Accept a count before the requisite key press. Sets the count parameter to the result. (short name -c)
-description
A description of this mapping (short name -d)
-ex
Execute rhs as an Ex command rather than keys (short name -e)
-
-group=group
Add this command to the given group (short name -g)
+
-group=group
Add this command to the given group (short name -g). When listing commands this limits the output to the specified group.
-javascript
Execute rhs as JavaScript rather than keys (short names -js, -j)
-literal=n
Parse the nth argument without specially processing any quote or meta characters. (short name -l)
-
-modes
Create this mapping in the given modes (short names -mode, -m)
+
-modes=modes
Create this mapping in the given modes (short names -mode, -m)
-nopersist
Do not save this mapping to an auto-generated rc file (short name -n)
-silent
Do not echo any generated keys to the command line (short name -s, also <silent> for Vim compatibility)
@@ -130,10 +157,10 @@ :no :noremap :noremap lhs rhs - :nn :nnoremap - :nnoremap lhs rhs - :vn :vnoremap - :vnoremap lhs rhs + :nno :nnoremap + :nnoremap lhs rhs + :vno :vnoremap + :vnoremap lhs rhs :ino :inoremap :inoremap lhs rhs :tno :tnoremap @@ -219,23 +246,6 @@ documentation of those options for more information.

-

Special arguments

- -

- Below is an overview of which modes each map command applies to: -

- - - - -:map :noremap :unmap :mapclear – both Normal and Visual modes -:nmap :nnoremap :nunmap :nmapclear – Normal mode -:vmap :vnoremap :vunmap :vmapclear – Visual mode -:imap :inoremap :iunmap :imapclear – Insert mode -:tmap :tnoremap :tunmap :tmapclear – Text Edit mode -:cmap :cnoremap :cunmap :cmapclear – Command-line mode - -

Key sequences

@@ -293,6 +303,7 @@

  • : The control or ctrl key.
  • : The alt key.
  • : The meta key, windows key, or command key.
    • +
  • : Same as .
  • : The shift key.
    • @@ -311,31 +322,31 @@
    xc
    -
    Type the ‘X’ key followed by the ‘C’ key.
    +
    Press the ‘X’ key followed by the ‘C’ key.
    c
    - Type the ‘X’ key while holding the ‘Control’ key, followed + Press the ‘X’ key while holding the ‘Control’ key, followed by the ‘C’ key.
    -
    Type the ‘2’ while holding the ‘Control’ key.
    +
    Type ‘2’ while holding the ‘Control’ key.
    -
    Type the ‘@’ key while holding the ‘Control’ key.
    +
    Press the ‘@’ key while holding the ‘Control’ key.
    Press the space bar while holding the ‘Shift’ key.
    -
    Type the ‘J’ key while while holding both the ‘Control’ and ‘Alt’ keys.
    +
    Press the ‘J’ key while holding both the ‘Control’ and ‘Alt’ keys.
    Exactly the same as above.
    -
    Type the ‘J’ key while while holding both the ‘Control’, ‘Alt’, and ‘Shift’ keys.
    +
    Press the ‘J’ key while holding all of ‘Control’, ‘Alt’, and ‘Shift’ keys.

    Special characters

    @@ -424,7 +435,7 @@ :ab :abbreviate - :abbreviate -group=group lhs rhs + :abbreviate -group=group -js lhs rhs :abbreviate -group=group lhs :abbreviate -group=group @@ -460,9 +471,9 @@ :cabbreviate

    - Abbreviate a key sequence for Command-line mode. Same as - :abbreviate, but for - command-line mode only. + Abbreviate a key sequence for Command Line mode. Same as + :abbreviate, but for &mode.command-line; mode + only.

    @@ -475,7 +486,7 @@

    Abbreviate a key sequence for Insert mode. Same as - :abbreviate, but for insert mode only. + :abbreviate, but for Insert mode only.

    @@ -495,9 +506,9 @@ :cunabbreviate!

    - Remove abbreviation(s) for Command-line mode. Same as - :unabbreviate, but for - command-line mode only. + Remove abbreviation(s) for Command Line mode. Same as + :unabbreviate, but for &mode.command-line; mode + only.

    @@ -581,7 +592,8 @@

    The -group flag (short name: -g) can be used to - assign this command to a specific group. + assign this command to a specific group. When listing + commands this limits the output to the specified group.

    Argument handling

    @@ -629,7 +641,7 @@

    completions is a two-dimensional array of the form: - [[arg1, description1], [arg2, description2], …] + [[val1, description1], [val2, description2], …]

    @@ -640,11 +652,11 @@

    Example: :command foo -nargs=? -complete custom, - \ function (context) context.completions = [["arg1", "description1"], ["arg2", "description2"]] + \ function (context) context.completions = [["val1", "description1"], ["val2", "description2"]] \ :echo Useless + <q-args> :command foo -nargs=? - \ -complete custom,[["arg1", "description1"], ["arg2, "description2"]] + \ -complete custom,[["val1", "description1"], ["val2", "description2"]] \ :echo Same as above but simpler + <q-args>