Clean up :map help.

2 files changed, 126 insertions, 108 deletions

diff --git a/vimperator/locale/en-US/asciidoc.conf b/vimperator/locale/en-US/asciidoc.conf
index f52b207d..742368b4 100644
--- a/vimperator/locale/en-US/asciidoc.conf
+++ b/vimperator/locale/en-US/asciidoc.conf
@@ -28,10 +28,12 @@ LOGO=<div style="text-align: center;"><span class="vimperator-logo"></span></div
 \[!\]=<span class="argument">&#91;!&#93;</span>
 
 [macros]
-# heading:Page{nbsp}Heading[tag1,tag2]
+# heading:Title[tag1,tag2]
 (?su)(?<!\S)[\\]?\|(?P<attrlist>.+?)\|(?!\+)=heading
-# section:Introduction[tag1,tag2]
+# section:Title[tag1,tag2]
 (?su)(?<!\S)[\\]?\|(?P<attrlist>.+?)\|(?!\+)=section
+# subsection:Title[tag1,tag2]
+(?su)(?<!\S)[\\]?\|(?P<attrlist>.+?)\|(?!\+)=subsection
 # help:helptext[href]
 (?su)(?<!\S)[\\]?\|(?P<attrlist>.+?)\|(?!\+)=help
 
@@ -62,6 +64,18 @@ LOGO=<div style="text-align: center;"><span class="vimperator-logo"></span></div
 </tr>
 </table>
 
+[subsection-inlinemacro]
+<table style="border-bottom: 1px solid silver; width: 100%">
+<tr style="width: 100%">
+<td style="width: 50%"><{outfile@.*all.html:h4:h3}>{target}</{outfile@.*all.html:h4:h3}></td>
+<td style="width: 50%">
+{3? <a id="{3}"/><span class="tag">{3}</span>}
+{2? <a id="{2}"/><span class="tag">{2}</span>}
+{1? <a id="{1}"/><span class="tag">{1}</span>}
+</td>
+</tr>
+</table>
+
 [help-inlinemacro]
 <a href="chrome://liberator/locale/{1}">{target}</a>
 
diff --git a/vimperator/locale/en-US/map.txt b/vimperator/locale/en-US/map.txt
index c84138c0..b548e9a9 100644
--- a/vimperator/locale/en-US/map.txt
+++ b/vimperator/locale/en-US/map.txt
@@ -17,59 +17,20 @@ Please note that, unlike Vim and other applications, mappings containing
 the Shift key are specified with the capital letter, so e.g. [m]<C-n>[m] is
 different from [m]<C-N>[m], the latter being the only way to map Shift-Ctrl-n.
 
-|:map-special-chars| +
-
-|<Nop>| +
-||<Nop>||
-________________________________________________________________________________
-Do nothing. This command is useful for disabling a specific mapping. [c]:map
-<C-n> <Nop>[c] will prevent [m]<C-n>[m] from doing anything.
-________________________________________________________________________________
-
-
-|<CR>| |map_return| +
-||<CR>||
-________________________________________________________________________________
-Expand to a line terminator in a key mapping. An Ex command in the {rhs} of a
-mapping requires a line terminator after it so that it is executed when the
-mapping is expanded. [m]<CR>[m] should be used for this purpose.
-________________________________________________________________________________
-
-
-|<Leader>| |mapleader| +
-||<Leader>||
-________________________________________________________________________________
-Expands to the value of the "mapleader" variable in key mapping. If
-"mapleader" is unset or empty then "\" is used. Example: +
-\{nbsp}[c]:map <Leader>h :echo "Hello"<CR>[c] +
-works like +
-\{nbsp}[c]:map \h :echo "Hello"<CR>[c] +
-but after +
-\{nbsp}[c]let mapleader = ","[c] +
-it works like +
-\{nbsp}[c]:map ,h :echo "Hello"<CR>[c]
-________________________________________________________________________________
-
+subsection:Map{nbsp}commands[:map-commands]
 
 |:map|
 ||:map {lhs} {rhs}|| +
-||:map {lhs}|| +
-||:map||
-________________________________________________________________________________
-Map the key sequence {lhs} to {rhs}. The {rhs} is remapped, allowing for
-nested and recursive mappings.
-
-Warning: Mappings are NOT saved between sessions, make sure you put them in your
-vimperatorrc file!
-________________________________________________________________________________
-
-
+|:nm| |:nmap|
+||:nm[ap] {lhs} {rhs}|| +
+|:vm| |:vmap|
+||:vm[ap] {lhs} {rhs}|| +
+|:im| |:imap|
+||:im[ap] {lhs} {rhs}|| +
 |:cm| |:cmap|
-||:cmap {lhs} {rhs}|| +
-||:cmap {lhs}|| +
-||:cmap||
+||:cm[ap] {lhs} {rhs}|| +
 ________________________________________________________________________________
-Map the key sequence {lhs} to {rhs} (in Command-line mode). The {rhs} is
+Map the key sequence {lhs} to {rhs} for the applicable mode(s). The {rhs} is
 remapped, allowing for nested and recursive mappings.
 
 Warning: Mappings are NOT saved between sessions, make sure you put them in your
@@ -77,99 +38,142 @@ vimperatorrc file!
 ________________________________________________________________________________
 
 
-|:im| |:imap|
-||:imap {lhs} {rhs}|| +
-||:imap {lhs}|| +
-||:imap||
+|:no| |:noremap|
+||:no[remap] {lhs} {rhs}|| +
+|:nn| |:nnoremap|
+||:nn[oremap] {lhs} {rhs}|| +
+|:vn| |:vnoremap|
+||:vn[oremap] {lhs} {rhs}|| +
+|:ino| |:inoremap|
+||:ino[remap] {lhs} {rhs}|| +
+|:cno| |:cnoremap|
+||:cno[remap] {lhs} {rhs}|| +
 ________________________________________________________________________________
-Map the key sequence {lhs} to {rhs} (in Insert mode). The {rhs} is remapped,
-allowing for nested and recursive mappings.
-
-Warning: Mappings are NOT saved between sessions, make sure you put them in your
-vimperatorrc file!
+Map the key sequence {lhs} to {rhs} for the applicable mode(s). No remapping of
+the {rhs} is performed.
 ________________________________________________________________________________
 
 
-|:mapc| |:mapclear| +
-||:mapc[lear]||
+|:unm| |:unmap|
+||:map {lhs} {rhs}|| +
+|:nun| |:nunmap|
+||:nun[map] {lhs} {rhs}|| +
+|:vun| |:vunmap|
+||:vun[map] {lhs} {rhs}|| +
+|:iu| |:iunmap|
+||:iu[nmap] {lhs} {rhs}|| +
+|:cu| |:cunmap|
+||:cu[nmap] {lhs} {rhs}|| +
 ________________________________________________________________________________
-Remove all mappings. All user-defined mappings which were set by [c]:map[c] or
-[c]:noremap[c] are cleared.
+Remove the mapping of {lhs} for the applicable mode(s).
 ________________________________________________________________________________
 
 
-|:cmapc| |:cmapclear| +
-||:cmapc[lear]||
+|:mapc| |:mapclear|
+||:mapc[lear]|| +
+|:nmapc| |:nmapclear|
+||:nmapc[lear]|| +
+|:vmapc| |:vmapclear|
+||:vmapc[lear]|| +
+|:imapc| |:imapclear|
+||:imapc[lear]|| +
+|:cmapc| |:cmapclear|
+||:cmapc[lear]|| +
 ________________________________________________________________________________
-Remove all mappings (in Command-line mode). All user-defined mappings which
-were set by [c]:cmap[c] or [c]:cnoremap[c] are cleared.
+Remove all mappings for the applicable mode(s). All user-defined mappings are
+cleared.
 ________________________________________________________________________________
 
-
-|:imapc| |:imapclear| +
-||:imapc[lear]||
+|:map|
+||:map|| +
+|:nm| |:nmap|
+||:nm[ap]|| +
+|:vm| |:vmap|
+||:vm[ap]|| +
+|:im| |:imap|
+||:im[ap]|| +
+|:cm| |:cmap|
+||:cm[ap]|| +
 ________________________________________________________________________________
-Remove all mappings (in Insert mode). All user-defined mappings which were set
-by [c]:imap[c] or [c]:inoremap[c] are cleared.
+List all mappings for the applicable mode(s).
 ________________________________________________________________________________
 
 
-|:no| |:noremap| +
-||:no[remap] {lhs} {rhs}|| +
-||:no[remap] {lhs}|| +
-||:no[remap]||
+|:map|
+||:map {lhs}|| +
+|:nm| |:nmap|
+||:nm[ap] {lhs}|| +
+|:vm| |:vmap|
+||:vm[ap] {lhs}|| +
+|:im| |:imap|
+||:im[ap] {lhs}|| +
+|:cm| |:cmap|
+||:cm[ap] {lhs}|| +
 ________________________________________________________________________________
-Map the key sequence {lhs} to {rhs}. No remapping of the {rhs} is performed.
+List all mappings starting with {lhs} for the applicable mode(s).
 ________________________________________________________________________________
 
 
-|:cno| |:cnoremap| +
-||:cno[remap] {lhs} {rhs}|| +
-||:cno[remap] {lhs}|| +
-||:cno[remap]||
-________________________________________________________________________________
-Map the key sequence {lhs} to {rhs} (in Command-line mode). No remapping of
-the {rhs} is performed.
-________________________________________________________________________________
+subsection:Special{nbsp}arguments{nbsp}[:map-arguments]
 
+|:map-<silent>| +
 
-|:ino| |:inoremap| +
-||:ino[remap] {lhs} {rhs}|| +
-||:ino[remap] {lhs}|| +
-||:ino[remap]||
-________________________________________________________________________________
-Map the key sequence {lhs} to {rhs} (in Insert mode). No remapping of the
-{rhs} is performed.
-________________________________________________________________________________
+When the first argument to one of the mapping commands is [c]<silent>[c], {rhs}
+is not echoed to the command line, nor, for that matter, anything else until
+the command has completed.
 
+subsection:Mapping{nbsp}and{nbsp}modes[:map-modes]
 
-|:map-<silent>| +
-________________________________________________________________________________
-When the first argument to one of the mapping commands is <silent>,
-{rhs} is not echoed to the command line, nor, for that matter, anything
-else until the command has completed.
-________________________________________________________________________________
+Keys can be mapped in four distinct modes:
+
+  * Normal mode
+  * Visual mode
+  * Insert mode
+  * Command-line mode
 
+|map-overview| |map-modes| +
 
+Below is an overview of which modes each map command applies to:
 
-|:unm| |:unmap| +
-||:unm[ap] {lhs}||
+// TODO: table format
+
+: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
+:cmap  :cnoremap  :cunmap  :cmapclear - Command-line mode
+
+subsection:Special{nbsp}characters[:map-special-chars]
+
+|<Nop>| +
+||<Nop>||
 ________________________________________________________________________________
-Remove the mapping of {lhs}.
+Do nothing. This command is useful for disabling a specific mapping. [c]:map
+<C-n> <Nop>[c] will prevent [m]<C-n>[m] from doing anything.
 ________________________________________________________________________________
 
 
-|:cunm| |:cunmap| +
-||:cunm[ap] {lhs}||
+|<CR>| |map_return| +
+||<CR>||
 ________________________________________________________________________________
-Remove the mapping of {lhs} (in Command-line mode).
+Expand to a line terminator in a key mapping. An Ex command in the {rhs} of a
+mapping requires a line terminator after it so that it is executed when the
+mapping is expanded. [m]<CR>[m] should be used for this purpose.
 ________________________________________________________________________________
 
 
-|:iunm| |:iunmap| +
-||:iunm[ap] {lhs}||
+|<Leader>| |mapleader| +
+||<Leader>||
 ________________________________________________________________________________
-Remove the mapping of {lhs} (in Insert mode).
+Expands to the value of the "mapleader" variable in key mapping. If
+"mapleader" is unset or empty then "\" is used. Example: +
+\{nbsp}[c]:map <Leader>h :echo "Hello"<CR>[c] +
+works like +
+\{nbsp}[c]:map \h :echo "Hello"<CR>[c] +
+but after +
+\{nbsp}[c]let mapleader = ","[c] +
+it works like +
+\{nbsp}[c]:map ,h :echo "Hello"<CR>[c]
 ________________________________________________________________________________
 
 section:Abbreviations[abbreviations]