1. ZyX_I
  2. aurum

Commits

ZyX_I  committed 879ea51

doc: Added mappings index
ftplugin/aurumstatus, @aurum: Made some mappings (names or default {lhs}) conform other ones

  • Participants
  • Parent commits 24f22e7
  • Branches default

Comments (0)

Files changed (5)

File README.markdown

View file
  • Ignore whitespace
 This plugin provides a vim <--> VCS (currently mercurial, git and subversion) 
 integration for your projects. Features:
 
-  - Partially committing changes ([:AuRecord](http://vimpluginloader.sourceforge.net/doc/aurum.txt.html#line387-0)).
+  - Partially committing changes ([:AuRecord](http://vimpluginloader.sourceforge.net/doc/aurum.txt.html#line388-0)).
 
-  - Viewing file state at particular revision ([aurum://file](http://vimpluginloader.sourceforge.net/doc/aurum.txt.html#line630-0), [:AuFile](http://vimpluginloader.sourceforge.net/doc/aurum.txt.html#line160-0)).
+  - Viewing file state at particular revision ([aurum://file](http://vimpluginloader.sourceforge.net/doc/aurum.txt.html#line631-0), [:AuFile](http://vimpluginloader.sourceforge.net/doc/aurum.txt.html#line161-0)).
 
   - Viewing uncommited changes in a vimdiff, as well as changes between 
-    specific revisions ([:AuVimDiff](http://vimpluginloader.sourceforge.net/doc/aurum.txt.html#line430-0)). It is also possible to open multiple 
+    specific revisions ([:AuVimDiff](http://vimpluginloader.sourceforge.net/doc/aurum.txt.html#line431-0)). It is also possible to open multiple 
     tabs with all changes to all files viewed as side-by-side diffs.
 
-  - Viewing revisions log ([:AuLog](http://vimpluginloader.sourceforge.net/doc/aurum.txt.html#line245-0)). Output is highly customizable.
+  - Viewing revisions log ([:AuLog](http://vimpluginloader.sourceforge.net/doc/aurum.txt.html#line246-0)). Output is highly customizable.
 
-  - Viewing working directory status ([:AuStatus](http://vimpluginloader.sourceforge.net/doc/aurum.txt.html#line391-0)).
+  - Viewing working directory status ([:AuStatus](http://vimpluginloader.sourceforge.net/doc/aurum.txt.html#line392-0)).
 
-  - Commiting changes ([:AuCommit](http://vimpluginloader.sourceforge.net/doc/aurum.txt.html#line101-0)), commit messages are remembered in case of 
-    rollback ([g:aurum_remembermsg](http://vimpluginloader.sourceforge.net/doc/aurum.txt.html#line936-0)).
+  - Commiting changes ([:AuCommit](http://vimpluginloader.sourceforge.net/doc/aurum.txt.html#line102-0)), commit messages are remembered in case of 
+    rollback ([g:aurum_remembermsg](http://vimpluginloader.sourceforge.net/doc/aurum.txt.html#line985-0)).
 
   - Obtaining various URL’s out of remote repository URL (like URL of the HTML 
     version of the current file with URL fragment pointing to the current line 
-    attached: useful for sharing) ([:AuHyperlink](http://vimpluginloader.sourceforge.net/doc/aurum.txt.html#line195-0)). For mercurial it also 
+    attached: useful for sharing) ([:AuHyperlink](http://vimpluginloader.sourceforge.net/doc/aurum.txt.html#line196-0)). For mercurial it also 
     supports git and subversion revisions (in case you are using hg-git and 
     hgsubversion respectively).
 
-  - [aurum#changeset()](http://vimpluginloader.sourceforge.net/doc/aurum.txt.html#line479-0), [aurum#repository()](http://vimpluginloader.sourceforge.net/doc/aurum.txt.html#line475-0) and [aurum#status()](http://vimpluginloader.sourceforge.net/doc/aurum.txt.html#line483-0) functions 
+  - [aurum#changeset()](http://vimpluginloader.sourceforge.net/doc/aurum.txt.html#line480-0), [aurum#repository()](http://vimpluginloader.sourceforge.net/doc/aurum.txt.html#line476-0) and [aurum#status()](http://vimpluginloader.sourceforge.net/doc/aurum.txt.html#line484-0) functions 
     that are to be used from modeline.
 
   - Frontends for various other VCS commands.
 
-Most commands can be reached with a set of mappings (see [aurum-mappings](http://vimpluginloader.sourceforge.net/doc/aurum.txt.html#line785-0)), 
+Most commands can be reached with a set of mappings (see [aurum-mappings](http://vimpluginloader.sourceforge.net/doc/aurum.txt.html#line786-0)), 
 all mappings are customizable.
 
 

File doc/aurum.txt

View file
  • Ignore whitespace
         2.2. Functions                               |aurum-functions|
         2.3. aurum:// pseudo-protocol                |aurum://|
         2.4. Global mappings                         |aurum-mappings|
+        2.5. Local mappings index                    |aurum-mappings-index|
     4. Options                                       |aurum-options|
     5. Globs                                         |aurum-globs|
     6. Log templates                                 |aurum-logtemplates|
     |:AuStatus|.
     Local mappings (mgid=AuStatus, without leader by default):
                                                         *g:frawormap_AuStatus*
-                 *g:frawormap_AuStatus_Open*   *g:frawormap_AuStatus_ROpen*
+                 *g:frawormap_AuStatus_Open*   *g:frawormap_AuStatus_Enter*
                  *g:frawormap_AuStatus_RFdiff* *g:frawormap_AuStatus_Fdiff*
                  *g:frawormap_AuStatus_FVdiff* *g:frawormap_AuStatus_RFVdiff*
                  *g:frawormap_AuStatus_Diff*   *g:frawormap_AuStatus_vDiff*
                  *g:frawormap_AuStatus_Track*  *g:frawormap_AuStatus_vCommit*
                  *g:frawormap_AuStatus_vTrack* *g:frawormap_AuStatus_Forget*
                  *g:frawormap_AuStatus_vForget*    *aurum-m-AuStatus_vForget*
-                     *aurum-m-AuStatus_Open*       *aurum-m-AuStatus_ROpen*
+                     *aurum-m-AuStatus_Open*       *aurum-m-AuStatus_Enter*
                      *aurum-m-AuStatus_RFdiff*     *aurum-m-AuStatus_Fdiff*
                      *aurum-m-AuStatus_FVdiff*     *aurum-m-AuStatus_RFVdiff*
                      *aurum-m-AuStatus_Diff*       *aurum-m-AuStatus_vDiff*
                      *aurum-m-AuStatus_Track*      *aurum-m-AuStatus_vCommit*
                      *aurum-m-AuStatus_vTrack*     *aurum-m-AuStatus_Forget*
     Mapname  LHS  Description ~
-    Open     <CR> Open file under cursor
-    ROpen     o   Open file under cursor as it was at first revision (working 
+    Enter    <CR> Open file under cursor
+    Open      o   Open file under cursor as it was at first revision (working 
                   directory revision by default)
-    RFdiff   gd   View changes introduced by first revision
-    Fdiff    gc   View diff between two revisions (or working directory state 
+    Fdiff    gd   View diff between two revisions (or working directory state 
                   and first revision)
-    RFVdiff  gD   Like RFdiff, but show them in multiple tabs using |vimdiff|
-    FVdiff   gC   Like Fdiff,  but show them in multiple tabs using |vimdiff|
+    RFdiff   gc   View changes introduced by first revision
+    FVdiff   gD   Like Fdiff,  but show them in multiple tabs using |vimdiff|
+    RFVdiff  gC   Like RFdiff, but show them in multiple tabs using |vimdiff|
     Diff      d   Like RFdiff, but show only current file
     vDiff     d   Like RFdiff, but shows files selected in visual mode
     Rdiff     c   Like Fdiff, but show only current file
 commands. Present mappings:
 
                       *g:frawormap_Aurum_Commit* *g:frawormap_Aurum_CommitAll*
-                      *g:frawormap_Aurum_ROpen*  *g:frawormap_Aurum_Revert*
+                      *g:frawormap_Aurum_Open*   *g:frawormap_Aurum_Revert*
                       *g:frawormap_Aurum_Vdiff*  *g:frawormap_Aurum_Diff*
                       *g:frawormap_Aurum_Fdiff*  *g:frawormap_Aurum_Annotate*
                       *g:frawormap_Aurum_Status* *g:frawormap_Aurum_Record*
                       *g:frawormap_Aurum_Push*   *g:frawormap_Aurum_Pull*
                       *g:frawormap_Aurum_FVdiff*     *aurum-m-Aurum-FVdiff*
                           *aurum-m-Aurum_Commit*     *aurum-m-Aurum_CommitAll*
-                          *aurum-m-Aurum_ROpen*      *aurum-m-Aurum_Revert*
+                          *aurum-m-Aurum_Open*       *aurum-m-Aurum_Revert*
                           *aurum-m-Aurum_Vdiff*      *aurum-m-Aurum_Diff*
                           *aurum-m-Aurum_Fdiff*      *aurum-m-Aurum_Annotate*
                           *aurum-m-Aurum_Status*     *aurum-m-Aurum_Record*
 Mapname    LHS  Command     Description ~
 Commit      i   AuCommit    Commit changes to current file
 CommitAll   I   AuCommit ** Commit changes to all files
-ROpen       o   AuFile      View contents of the current file as it was at the 
+Open        o   AuFile      View contents of the current file as it was at the 
                             the working directory revision
 Revert      O   AuFile . : replace
                             Replace current buffer with contents of the 
                             Pull new commits from remote repository and 
                             perform an update.
 
+------------------------------------------------------------------------------
+2.5. Local mappings index                               *aurum-mappings-index*
+
+Here is an index of mappings defined for various aurum://* buffers, aurum* 
+filetypes or by :Au* commands. All mappings for readonly buffers have no 
+leader, for non-readonly buffers or for global scope (|:AuVimDiff| ones) have 
+“<leader>” as their prefix by default.
+
+               ┌ aurumannotate filetype (aurum://annotate)  ~
+               │┌ aurumcommit filetype (aurum://commit; with leader) ~
+               ││┌ AuDiff command, mappings (aurum://diff) ~
+               │││┌ AuFile command, mappings (aurum://file) ~
+               ││││┌ aurumlog filetype (aurum://log) ~
+               │││││┌ aurumstatus filetype (aurum://status) ~
+               ││││││┌ :AuVimDiff command (with leader) ~
+               │││││││┌ :AuRecord mappings ~
+               ││││││││┌ global mappings (with leader) ~
+               │││││││││ ~
+Name      Key  │││││││││  Description ~
+Enter     <CR> a   ls     Does some default action
+File      gF       l      Shows file history
+User      gu       l      Shows revisions committed by current user
+Date      gM       l      Shows revisions committed in the current month
+Branch    gb       l      Shows revisions that have the same branch
+Rev       gr       l      Shows revisions that are descendants of the current
+FVdiff    gD   a D lS  g  Shows full vimdiff between current revision and WD
+                          (status and diff: between two current revisions)
+RFVdiff   gC   a   ls     Shows changes done in current rev as full vimdiff
+Fdiff     gd   a   lS  g  Shows diff between current revision and working dir
+                          (status: between two current revisions)
+RFdiff    gc   a   ls     Shows changes introduced by current revision
+Diff       d   a  fls  g  Shows diff between rev and WD for current file
+Rdiff      c   a  fls     Shows changes done in current rev to current file
+Prev/Next J/K  a dfl      Go to previous/next revision
+Open       o   a d ls  g  Opens current file as it was at current revision
+Annotate   a   a   ls  g  Annotates current file at current revision
+Update     U   a dfl      Update working directory to current revision
+Commit     i    c   s Rg  Commit changes made to current file
+                          (record: record all selected changes)
+CommitAll  I           g  Commit changes made to all files
+Track      A        s Rg  Make current file tracked by VCS
+                          (record: mark it for committing)
+Forget     R        s Rg  Make VCS forget current file
+                          (record: don’t commit changes to this file)
+Exit       X   acdflsvr   Close current buffer (tabpage, tabpage list)
+
+There are some more uncommon global and AuRecord mappings not mentioned above.
+
 ==============================================================================
 4. Options                                                     *aurum-options*
 

File ftplugin/aurumstatus.vim

View file
  • Ignore whitespace
 "▲2
 call s:_f.mapgroup.add('AuStatus', {
             \    'Exit': {'lhs':  'X',   'rhs': ':<C-u>bwipeout!<CR>'       },
-            \    'Open': {'lhs': '<CR>', 'rhs': s:F.getrhs(          'open')},
-            \   'ROpen': {'lhs':  'o',   'rhs': s:F.getrhs(       'revopen')},
-            \ 'RFVdiff': {'lhs': 'gD',   'rhs': s:F.getrhs('revfullvimdiff')},
-            \  'FVdiff': {'lhs': 'gC',   'rhs': s:F.getrhs(   'fullvimdiff')},
-            \  'RFdiff': {'lhs': 'gd',   'rhs': s:F.getrhs(   'revfulldiff')},
-            \   'Fdiff': {'lhs': 'gc',   'rhs': s:F.getrhs(      'fulldiff')},
+            \   'Enter': {'lhs': '<CR>', 'rhs': s:F.getrhs(          'open')},
+            \    'Open': {'lhs':  'o',   'rhs': s:F.getrhs(       'revopen')},
+            \  'FVdiff': {'lhs': 'gD',   'rhs': s:F.getrhs(   'fullvimdiff')},
+            \ 'RFVdiff': {'lhs': 'gC',   'rhs': s:F.getrhs('revfullvimdiff')},
+            \   'Fdiff': {'lhs': 'gd',   'rhs': s:F.getrhs(      'fulldiff')},
+            \  'RFdiff': {'lhs': 'gc',   'rhs': s:F.getrhs(   'revfulldiff')},
             \    'Diff': {'lhs':  'd',   'rhs': s:F.getrhs(          'diff')},
             \   'vDiff': {'lhs':  'd',   'rhs': s:F.getrhs(          'diff', 1),
             \             'mode': 'x'},

File plugin/aurum.vim

View file
  • Ignore whitespace
     call s:_f.mapgroup.add('Aurum', {
                 \'Commit':    {'lhs':  'i', 'rhs': ':<C-u>AuCommit<CR>'               },
                 \'CommitAll': {'lhs':  'I', 'rhs': ':<C-u>AuCommit **<CR>'            },
-                \'ROpen':     {'lhs':  'o', 'rhs': ':<C-u>AuFile<CR>'                 },
+                \'Open':      {'lhs':  'o', 'rhs': ':<C-u>AuFile<CR>'                 },
                 \'Revert':    {'lhs':  'O', 'rhs': ':<C-u>AuFile . : replace<CR>'     },
                 \'Vdiff':     {'lhs':  'D', 'rhs': ':<C-u>AuVimDiff<CR>'              },
                 \'FVdiff':    {'lhs': 'gD', 'rhs': ':<C-u>AuVimDiff full<CR>'         },

File test/maps-status.ok

View file
  • Ignore whitespace
 {{{1 gC
  1#1: 
  1*2: aurum://status:%ETMPDIR%%-test%-maps-statusrepo:
-*2*1: aurum://file:%ETMPDIR%%-test%-maps-statusrepo:504f74154456dbb0e9441326514e42ce66279e62:nohglinesrev.lst
-*2#2: %TMPDIR%/test/maps-statusrepo/nohglinesrev.lst
+ 2*1: 
+ 2#2: aurum://file:%ETMPDIR%%-test%-maps-statusrepo:504f74154456dbb0e9441326514e42ce66279e62:.hgignore
+*3*1: 
+*3#2: aurum://file:%ETMPDIR%%-test%-maps-statusrepo:504f74154456dbb0e9441326514e42ce66279e62:directory%-file
 {{{1 gc
 *1: aurum://diff:%ETMPDIR%%-test%-maps-statusrepo:504f74154456dbb0e9441326514e42ce66279e62:::
 {{{1 c
 {{{1 gD
  1#1: 
  1*2: aurum://status:%ETMPDIR%%-test%-maps-statusrepo:
- 2*1: 
- 2#2: aurum://file:%ETMPDIR%%-test%-maps-statusrepo:504f74154456dbb0e9441326514e42ce66279e62:.hgignore
-*3*1: 
-*3#2: aurum://file:%ETMPDIR%%-test%-maps-statusrepo:504f74154456dbb0e9441326514e42ce66279e62:directory%-file
+*2*1: aurum://file:%ETMPDIR%%-test%-maps-statusrepo:504f74154456dbb0e9441326514e42ce66279e62:nohglinesrev.lst
+*2#2: %TMPDIR%/test/maps-statusrepo/nohglinesrev.lst
 {{{1 gd
 *1: aurum://diff:%ETMPDIR%%-test%-maps-statusrepo:504f74154456dbb0e9441326514e42ce66279e62:::
 {{{1 d