]> git.donarmstrong.com Git - dactyl.git/blobdiff - common/locale/en-US/map.xml
Import 1.0 supporting Firefox up to 14.*
[dactyl.git] / common / locale / en-US / map.xml
index 9ff5c88bbd0dff244a4c5de3b983aaad69f55898..d082024a93714d93229decafedea8ff63f944ff1 100644 (file)
 </dl>
 
 <p>
-    The ordinary <ex>:map</ex> and <ex>:noremap</ex> commands
-    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,
+    The ordinary <ex>:map</ex> command adds 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,
     <ex>:imap</ex> creates a new key mapping in Insert mode, while
-    <ex>:cunmap</ex> removes a key mapping from Command Line mode.
-    Other modes can be specified using the <em>-modes</em> option described below.
+    <ex>:cunmap</ex> removes a key mapping from Command Line mode. Other modes
+    can be specified using the <em>-modes</em> option described below.
 </p>
 
 <warning>
 </p>
 
 <dl dt="width: 20em;">
-    <dt>:map   :noremap   :unmap</dt>  <dd>Normal and Visual modes</dd>
-    <dt>:nmap  :nnoremap  :nunmap</dt> <dd>Normal mode</dd>
-    <dt>:vmap  :vnoremap  :vunmap</dt> <dd>Visual mode</dd>
-    <dt>:imap  :inoremap  :iunmap</dt> <dd>Insert mode</dd>
-    <dt>:tmap  :tnoremap  :tunmap</dt> <dd>Text Edit mode</dd>
-    <dt>:cmap  :cnoremap  :cunmap</dt> <dd>Command Line mode</dd>
+    <dt>:map   :unmap</dt>  <dd>Normal and Visual modes</dd>
+    <dt>:nmap  :nunmap</dt> <dd>Normal mode</dd>
+    <dt>:vmap  :vunmap</dt> <dd>Visual mode</dd>
+    <dt>:imap  :iunmap</dt> <dd>Insert mode</dd>
+    <dt>:tmap  :tunmap</dt> <dd>Text Edit mode</dd>
+    <dt>:cmap  :cunmap</dt> <dd>Command Line mode</dd>
 </dl>
 
 <note>
     <tags>:cno :cnoremap</tags>
     <spec>:cno<oa>remap</oa> <a>lhs</a> <a>rhs</a></spec>
     <description>
+        <deprecated>These aliases are deprecated. The <em>-builtin</em> flag
+            should be used in their stead.</deprecated>
         <p>
             Map the <t>key-sequence</t> <a>lhs</a> to <a>rhs</a> for
             the applicable mode(s). The keys in <a>rhs</a> do not
     </description>
 </item>
 
+<item>
+    <tags><![CDATA['mapleader' <Leader>]]></tags>
+    <strut/>
+    <spec><![CDATA[<Leader>]]></spec>
+    <description>
+        <p>
+            An arbitrary and meaningless key that some people seem
+            attached to. The <k>\</k> key will, by default, emit
+            this pseudo-key so that it can be used at the start of
+            other mappings. Note, however, that there is nothing
+            special about it and any key can be mapped to emit any
+            other arbitrary pseudo-key in the same way.
+        </p>
+
+        <code><ex>:map , <k name="Leader"/></ex>
+<ex>:map ; <k name="AwesomestLeaderEver"/></ex>
+
+<ex>:map <k name="Leader"/>k <key>-js</key> doStuff()</ex>
+<ex>:map <k name="AwesomestLeaderEver"/>k <key>-js</key> doOtherReallyNiftyStuff()</ex></code>
+
+        <p>
+            Needless to say this behavior is considered childish and
+            discouraged.
+        </p>
+    </description>
+</item>
+
 <item>
     <tags><![CDATA[<Pass>]]></tags>
     <spec><![CDATA[<Pass>]]></spec>
     </description>
 </item>
 
-<item>
-    <tags><![CDATA[<Leader> \]]></tags>
-    <strut/>
-    <spec><![CDATA[<Leader>]]></spec>
-    <description>
-        <p>
-            A pseudo-key which expands to the value of the <o>mapleader</o>
-            option. For example, by default,
-        </p>
-        <code><ex>:map <k name="Leader"/>h</ex> <ex>:echo <str>Hello</str><k name="CR"/></ex></code>
-        <p>works like</p>
-        <code><ex>:map \h</ex> <ex>:echo <str>Hello</str><k name="CR"/></ex></code>
-        <p>but after</p>
-        <set opt="mapleader"><str>,</str></set>
-        <p>it works like</p>
-        <code><ex>:map ,h</ex> <ex>:echo <str>Hello</str><k name="CR"/></ex></code>
-    </description>
-</item>
-
 <h3 tag="map-examples">Mapping examples</h3>
 
 <p>Make <k name="A-n" link="false"/> do the same as <k name="Down" link="false"/> in input <t>modes</t>:</p>