Document 'timeout' and 'timeoutlen'.

--HG--
branch : key-processing

common/content/events.js

@@ -1409,12 +1409,12 @@ var Events = Module("events", {
             "Prevent scripts from focusing input elements without user intervention",
             "boolean", true);
 
-        options.add(["timeout", "to"],
+        options.add(["timeout", "tmo"],
             "Whether to execute a shorter key command after a timeout when a longer command exists",
             "boolean", true);
 
-        options.add(["timeoutlen", "tm"],
-            "Maximum time to wait for a longer key command when a shorter command exists",
+        options.add(["timeoutlen", "tmol"],
+            "Maximum time (milliseconds) to wait for a longer key command when a shorter one exists",
             "number", 1000);
     },
     sanitizer: function () {

common/locale/en-US/map.xml

@@ -217,6 +217,14 @@
     </description>
 </item>
 
+<h3 tag=":map-timeout map-timeout">Mapping timeout</h3>
+<p>
+    When &dactyl.appName; receives a key event that has a separate binding and
+    at the same time is part of a key chain, values of the <o>timeout</o> and
+    <o>timeoutlen</o> options are used to decide what to do. See the
+    documentation of those options for more information.
+</p>
+
 <h3 tag=":map-arguments">Special arguments</h3>
 
 <tags>:map-&lt;silent></tags>

common/locale/en-US/options.xml

@@ -1391,6 +1391,34 @@
     </description>
 </item>
 
+<item>
+    <tags>'tmo' 'timeout'</tags>
+    <spec>'timeout' 'tmo'</spec>
+    <type>boolean</type>
+    <default>true</default>
+    <description>
+        <p>
+            When this option is set and a key sequence interpretable both as a
+            complete command and as a start of a longer command is typed,
+            execute the shorter command after <o>timeoutlen</o> milliseconds.
+        </p>
+    </description>
+</item>
+
+<item>
+    <tags>'tmol' 'timeoutlen'</tags>
+    <spec>'timeoutlen' 'tmol'</spec>
+    <type>number</type>
+    <default>1000</default>
+    <description>
+        <p>
+            Maximum number of milliseconds to wait for a longer key command
+            when a shorter one exists. Only effective when <o>timeout</o> is
+            set.
+        </p>
+    </description>
+</item>
+
 <item>
     <tags>'titlestring'</tags>
     <spec>'titlestring'</spec>

pentadactyl/NEWS

@@ -62,6 +62,7 @@
         Hint, Multi-line Output, and Menu. [b4]
       - Added site-specific mapping groups and related command
         changes. [b6]
+      - Added 'timeout' and 'timeoutlen' options. [b6]
       - Added <A-m>l and <A-m>s to aid in the construction of
         macros. [b6]
       - Removed the implicit page load delays during macro playback. [b6]