Commits

ZyX_I committed 9f914e6

Rename “record mode” to “record tab” in documentation

Comments (0)

Files changed (1)

     5. Globs                                         |aurum-globs|
     6. Log templates                                 |aurum-logtemplates|
         6.1. Built-in template styles                |aurum-logstyles|
-    7. Record mode                                   |aurum-record|
+    7. Special tabs
+        7.1. Record tab                              |aurum-record|
     8. Internal objects                              |aurum-objects|
         8.1. Repository                              |aurum-repository|
         8.2. Changeset                               |aurum-changeset|
     incoming  View what will be pulled if you replace “incoming” with “pull”
 
 AuRecord {opts} [glob1 [...]]                                      *:AuRecord*
-    Start record mode (|aurum-record|). Possible options are just the same as 
+    Start record tab (|aurum-record|). Possible options are just the same as 
     |:AuCommit| has (except for “type” option that is absent).
     Note: `AuRecord amend` preserves changes from previous commit.
 
 Annotate    a   AuAnnotate  Annotate current buffer
 Status      s   AuStatus | wincmd p
                             Open status window and switch back
-Record      r   AuRecord    Switch to record mode
+Record      r   AuRecord    Open record tab
 Log         L   AuLog       View the revision history
 LogFile     l   AuLog : files :
                             View revisions where current file was changed
 
 recheight                                                  *g:aurum_recheight*
     VimL |expression| that evaluates to unsigned integer or unsigned integer. 
-    Determines height of status window shown in record mode (|aurum-record|).
+    Determines height of status window shown in record tab (|aurum-record|).
     Default: winheight/5 (in empty tab |winheight()| will return roughly the 
              same value as 'lines').
 
 recautowrite                                            *g:aurum_recautowrite*
     Boolean. Determines whether files opened for editing should be 
-    automatically written on |BufWinLeave| and |BufLeave| events.
+    automatically written on |BufWinLeave| and |BufLeave| events in record tab 
+    (|aurum-record|) (only files in top left window are supported; others are 
+    not modifiable anyway).
     See |aurum-m-AuRecord_Edit|.
     Default: 1.
 
       1 Bob 2011-01-01 {tip} Guess bar is better name for baz
 
 ==============================================================================
-7. Record mode                                                  *aurum-record*
+7. Special tabs
 
-Record mode is used to interactively select changes that should be committed. 
+------------------------------------------------------------------------------
+7.1. Record tab                                                 *aurum-record*
+
+Record tab is used to interactively select changes that should be committed. 
 |:AuRecord| command opens a new tab page and splits it into three windows: 
 recorded, original and status:
   +------------------+------------------+ `
   |                status               | `
   |                                     | `
   +-------------------------------------+ `
-After entering record mode status window becomes focused. It contains output 
+After entering record tab status window becomes focused. It contains output 
 similar to the output of |:AuStatus| command, but with one additional column 
 added at the beginning of the line. This column may contain one of four status 
 characters:
 Character  Meaning ~
     -      Changes done to this file won’t be committed (default)
     +      All changes done to this file will be committed
-    *      You have made changes to this file in record mode. These changes 
+    *      You have made changes to this file in record tab. These changes 
            will be commited
-    ^      You have made changes to this file in record mode, but then chose 
+    ^      You have made changes to this file in record tab, but then chose 
            not to commit them. They will reappear again when you use 
            |aurum-m-AuRecord_Edit| mapping
 In status window there are additional mappings available (mgid=AuRecord, 
               window there will be version of file that will be committed 
               (initially unmodified compared to version stored in repository). 
               If file is edited for the second time in recorded window there 
-              will be version of file modified in record mode and in original 
+              will be version of file modified in record tab and in original 
               window there will be backup of the file (or version from 
               repository if file in question was removed or deleted).
 Undo      u   Undo adds/removes of the file (|u|). Won’t undo changes made to 
 Note: undoing/redoing changes using other ways is not supported unless 
       |g:aurum_fullundo| is set.
 
-:AuRecord also makes some AuStatus mappings change their meaning:
+|:AuRecord| also makes some AuStatus mappings change their meaning:
 Mapping                 New meaning ~
 |aurum-m-AuStatus_Track|  select changes made to file(s) for committing
-|aurum-m-AuStatus_Commit| finish record mode and commit selected changes
+|aurum-m-AuStatus_Commit| close record tab and commit selected changes
 |aurum-m-AuStatus_Forget| unselect changes made to file(s), don’t commit them
 
-Note that if you close status window you will also exit record mode discarding 
+Note that if you close status window you will also close record tab discarding 
      all changes you have made.
 
-:AuRecord defines the following mappings in recorded window 
+|:AuRecord| defines the following mappings in recorded window 
 (mgid=AuRecordLeft, default leader: "<Leader>"):    *g:frawormap_AuRecordLeft*
           *g:frawormap_AuRecordLeft_Discard* *g:frawormap_AuRecordLeft_Exit*
           *g:frawormap_AuRecordLeft_Commit*  *g:frawormap_AuRecordLeft_Remove*
 Mapping  LHS  Description ~
 Discard   x   Discard all changes made to edited file. If file is opened for 
               the second time only unsaved changes will be discarded.
-Exit      X   Exit record mode, discarding all changes made to all files and 
+Exit      X   Close record tab, discarding all changes made to all files and 
               not committing anything.
-Commit    i   Commit selected changes and exit record mode.
+Commit    i   Commit selected changes and close record tab.
 Remove    R   Like Discard, but also unselect it (makes difference if file is 
               edited for the second time).
 Finish    A   Write changes and switch to status buffer.