ui: doc: latest keys

hledger-ui/Hledger/UI/UIUtils.hs

@@ -239,12 +239,12 @@ helpDialog =
             ,renderKey ("R", "toggle real filter")
             ,renderKey ("E", "toggle nonzero filter")
             ,renderKey ("/", "set a filter query")
-            ,renderKey ("DEL/BS", "clear filters")
+            ,renderKey ("DEL/BS", "remove filters")
+            ,str " "
             ,str "accounts screen:"
             ,renderKey ("F", "toggle flat mode")
             ,renderKey ("-+=1234567890", "")
-            ,str "  adjust/set depth limit"
+            ,str "  adjust/set/remove depth limit"
-            ,str "  0 means no limit"
             ]
         )
       ]

hledger-ui/doc/hledger-ui.1

@@ -217,19 +217,16 @@ be "TAG:multi:level:account:name".
 .RE
 .SH KEYS
 .PP
-Generally the cursor keys navigate; \f[C]right\f[] (or \f[C]enter\f[])
+\f[C]h\f[] shows a help dialog listing all keys.
-goes deeper, \f[C]left\f[] returns to the previous screen,
+(Some but not all of these also appear in the quick help at the bottom
+of each screen.) Press \f[C]h\f[] again (or \f[C]ESCAPE\f[]) to close
+it.
+.PP
+The cursor keys navigate: \f[C]right\f[] (or \f[C]enter\f[]) goes
+deeper, \f[C]left\f[] returns to the previous screen,
 \f[C]up\f[]/\f[C]down\f[]/\f[C]page\ up\f[]/\f[C]page\ down\f[]/\f[C]home\f[]/\f[C]end\f[]
 move up and down through lists.
 .PP
-\f[C]g\f[] reloads from the data file(s) and updates the current screen
-and any previous screens.
-(With large files, there can be a noticeable pause.)
-.PP
-\f[C]a\f[] runs command\-line hledger\[aq]s add command, and reloads
-hledger\-ui.
-This allows some basic data entry.
-.PP
 \f[C]/\f[] lets you set or change the filter query, which limits the
 data shown on most screens (in addition to the quick filters described
 below).
@@ -239,7 +236,17 @@ cancel.
 .PP
 \f[C]BACKSPACE\f[] or \f[C]DELETE\f[] clears any filters in effect.
 .PP
-\f[C]ESCAPE\f[] clears any filters and jumps to the top screen.
+\f[C]ESCAPE\f[] removes any filters currently in effect, and jumps to
+the top screen.
+Or, it cancels a minibuffer edit or help dialog if one is active.
+.PP
+\f[C]g\f[] reloads from the data file(s) and updates the current screen
+and any previous screens.
+(With large files, there can be a noticeable pause.)
+.PP
+\f[C]a\f[] runs command\-line hledger\[aq]s add command, and reloads the
+updated file.
+This allows some basic data entry.
 .PP
 \f[C]q\f[] quits the application.
 .PP
@@ -264,10 +271,6 @@ Or, adjust the depth limit by pressing \f[C]\-\f[] or \f[C]+\f[]
 (\f[C]=\f[] also works).
 \f[C]0\f[] removes the depth limit.
 .PP
-\f[C]E\f[] toggles nonzero mode, in which only accounts with nonzero
-balances are shown (hledger\-ui shows zero items by default, unlike
-command\-line hledger).
-.PP
 \f[C]C\f[] toggles cleared mode, in which uncleared transactions and
 postings are not shown.
 \f[C]U\f[] toggles uncleared mode, in which only uncleared
@@ -275,6 +278,10 @@ transactions/postings are shown.
 .PP
 \f[C]R\f[] toggles real mode, in which virtual postings are ignored.
 .PP
+\f[C]E\f[] toggles nonzero mode, in which only accounts with nonzero
+balances are shown (hledger\-ui shows zero items by default, unlike
+command\-line hledger).
+.PP
 Press \f[C]right\f[] or \f[C]enter\f[] to view an account\[aq]s
 transactions register.
 .SS Register screen
@@ -321,10 +328,6 @@ $\ hledger\-ui\ \-\-register\ checking\ \-\-cleared
 .fi
 .RE
 .PP
-\f[C]E\f[] toggles nonzero mode, in which only transactions posting a
-nonzero change are shown (hledger\-ui shows zero items by default,
-unlike command\-line hledger).
-.PP
 \f[C]C\f[] toggles cleared mode, in which uncleared transactions and
 postings are not shown.
 \f[C]U\f[] toggles uncleared mode, in which only uncleared
@@ -332,11 +335,15 @@ transactions/postings are shown.
 .PP
 \f[C]R\f[] toggles real mode, in which virtual postings are ignored.
 .PP
-Press \f[C]right\f[] or \f[C]enter\f[] to view the selected transaction
+\f[C]E\f[] toggles nonzero mode, in which only transactions posting a
-in full detail.
+nonzero change are shown (hledger\-ui shows zero items by default,
+unlike command\-line hledger).
 .PP
-Note, filter queries which filter by account name do not yet do much
+Press \f[C]right\f[] (or \f[C]enter\f[]) to view the selected
-useful on this screen.
+transaction in full detail.
+.PP
+Note, filter queries which filter by account name are not very useful on
+this screen yet.
 .SS Transaction screen
 .PP
 This screen shows a single transaction, as a general journal entry,
@@ -361,8 +368,9 @@ until the next reload).
 .PP
 This screen will appear if there is a problem, such as a parse error,
 when you press g to reload.
-Once you have fixed the problem described, press g again to reload and
+Once you have fixed the problem, press g again to reload and resume
-restore normal operation.
+normal operation.
+(Or, you can press escape to cancel the reload attempt.)
 .SH ENVIRONMENT
 .PP
 \f[B]COLUMNS\f[] The screen width to use.

hledger-ui/doc/hledger-ui.1.info

@@ -152,17 +152,14 @@ File: hledger-ui.1.info,  Node: KEYS,  Next: SCREENS,  Prev: OPTIONS,  Up: Top
 2 KEYS
 ******
 
-Generally the cursor keys navigate; `right' (or `enter') goes deeper,
+`h' shows a help dialog listing all keys. (Some but not all of these
-`left' returns to the previous screen, `up'/`down'/`page up'/`page
+also appear in the quick help at the bottom of each screen.) Press `h'
+again (or `ESCAPE') to close it.
+
+   The cursor keys navigate: `right' (or `enter') goes deeper, `left'
+returns to the previous screen, `up'/`down'/`page up'/`page
 down'/`home'/`end' move up and down through lists.
 
-   `g' reloads from the data file(s) and updates the current screen and
-any previous screens. (With large files, there can be a noticeable
-pause.)
-
-   `a' runs command-line hledger's add command, and reloads hledger-ui.
-This allows some basic data entry.
-
    `/' lets you set or change the filter query, which limits the data
 shown on most screens (in addition to the quick filters described
 below). While editing the query you can use typical command-line edit
@@ -171,7 +168,16 @@ cancel.
 
    `BACKSPACE' or `DELETE' clears any filters in effect.
 
-   `ESCAPE' clears any filters and jumps to the top screen.
+   `ESCAPE' removes any filters currently in effect, and jumps to the
+top screen. Or, it cancels a minibuffer edit or help dialog if one is
+active.
+
+   `g' reloads from the data file(s) and updates the current screen and
+any previous screens. (With large files, there can be a noticeable
+pause.)
+
+   `a' runs command-line hledger's add command, and reloads the updated
+file. This allows some basic data entry.
 
    `q' quits the application.
 
@@ -210,16 +216,16 @@ depth limit by pressing a number key, `1' to `9'. Or, adjust the depth
 limit by pressing `-' or `+' (`=' also works).  `0' removes the depth
 limit.
 
-   `E' toggles nonzero mode, in which only accounts with nonzero
-balances are shown (hledger-ui shows zero items by default, unlike
-command-line hledger).
-
    `C' toggles cleared mode, in which uncleared transactions and
 postings are not shown. `U' toggles uncleared mode, in which only
 uncleared transactions/postings are shown.
 
    `R' toggles real mode, in which virtual postings are ignored.
 
+   `E' toggles nonzero mode, in which only accounts with nonzero
+balances are shown (hledger-ui shows zero items by default, unlike
+command-line hledger).
+
    Press `right' or `enter' to view an account's transactions register.
 
 
@@ -261,21 +267,21 @@ individual postings), in hledger-ui's register:
      $ hledger-ui --register checking --cleared
 
 
-   `E' toggles nonzero mode, in which only transactions posting a
-nonzero change are shown (hledger-ui shows zero items by default, unlike
-command-line hledger).
-
    `C' toggles cleared mode, in which uncleared transactions and
 postings are not shown. `U' toggles uncleared mode, in which only
 uncleared transactions/postings are shown.
 
    `R' toggles real mode, in which virtual postings are ignored.
 
-   Press `right' or `enter' to view the selected transaction in full
+   `E' toggles nonzero mode, in which only transactions posting a
+nonzero change are shown (hledger-ui shows zero items by default, unlike
+command-line hledger).
+
+   Press `right' (or `enter') to view the selected transaction in full
 detail.
 
-   Note, filter queries which filter by account name do not yet do much
+   Note, filter queries which filter by account name are not very
-useful on this screen.
+useful on this screen yet.
 
 
 File: hledger-ui.1.info,  Node: Transaction screen,  Next: Error screen,  Prev: Register screen,  Up: SCREENS
@@ -308,8 +314,9 @@ File: hledger-ui.1.info,  Node: Error screen,  Prev: Transaction screen,  Up: SC
 ================
 
 This screen will appear if there is a problem, such as a parse error,
-when you press g to reload. Once you have fixed the problem described,
+when you press g to reload. Once you have fixed the problem, press g
-press g again to reload and restore normal operation.
+again to reload and resume normal operation. (Or, you can press escape
+to cancel the reload attempt.)
 
 
 
@@ -319,15 +326,15 @@ Node: OPTIONS825
 Ref: #options924
 Node: KEYS3800
 Ref: #keys3897
-Node: SCREENS4837
+Node: SCREENS5098
-Ref: #screens4924
+Ref: #screens5185
-Node: Accounts screen5014
+Node: Accounts screen5275
-Ref: #accounts-screen5144
+Ref: #accounts-screen5405
-Node: Register screen6248
+Node: Register screen6509
-Ref: #register-screen6405
+Ref: #register-screen6666
-Node: Transaction screen8158
+Node: Transaction screen8419
-Ref: #transaction-screen8318
+Ref: #transaction-screen8579
-Node: Error screen9185
+Node: Error screen9446
-Ref: #error-screen9309
+Ref: #error-screen9570
 
 End Tag Table

hledger-ui/doc/hledger-ui.1.m4.md

@@ -75,15 +75,15 @@ _reportingoptions_
 
 # KEYS
 
-Generally the cursor keys navigate; `right` (or `enter`) goes deeper, `left` returns to the previous screen,
+`h` shows a help dialog listing all keys. 
+(Some but not all of these also appear in the quick help at the bottom of each screen.) 
+Press `h` again (or `ESCAPE`) to close it.
+
+The cursor keys navigate: 
+`right` (or `enter`) goes deeper, 
+`left` returns to the previous screen,
 `up`/`down`/`page up`/`page down`/`home`/`end` move up and down through lists.
 
-`g` reloads from the data file(s) and updates the current screen and any
-previous screens. (With large files, there can be a noticeable pause.)
-
-`a` runs command-line hledger's add command, and reloads hledger-ui.
-This allows some basic data entry. 
-
 `/` lets you set or change the [filter query](/hledger.html#queries),
 which limits the data shown on most screens (in addition to the quick
 filters described below). While editing the query you can use typical
@@ -92,7 +92,14 @@ or press escape to cancel.
 
 `BACKSPACE` or `DELETE` clears any filters in effect.
 
-`ESCAPE` clears any filters and jumps to the top screen.
+`ESCAPE` removes any filters currently in effect, and jumps to the top screen.
+Or, it cancels a minibuffer edit or help dialog if one is active.
+
+`g` reloads from the data file(s) and updates the current screen and any
+previous screens. (With large files, there can be a noticeable pause.)
+
+`a` runs command-line hledger's add command, and reloads the updated file.
+This allows some basic data entry. 
 
 `q` quits the application.
 
@@ -114,10 +121,6 @@ To see less detail, set a depth limit by pressing a number key, `1` to `9`.
 Or, adjust the depth limit by pressing `-` or `+` (`=` also works).
 `0` removes the depth limit.
 
-`E` toggles nonzero mode, in which only accounts with nonzero balances
-are shown (hledger-ui shows zero items by default, unlike command-line
-hledger).
-
 `C` toggles cleared mode, in which
 [uncleared transactions and postings](/journal.html#transactions) are
 not shown. `U` toggles uncleared mode, in which only uncleared
@@ -125,6 +128,10 @@ transactions/postings are shown.
 
 `R` toggles real mode, in which [virtual postings](/journal.html#virtual-postings) are ignored.
 
+`E` toggles nonzero mode, in which only accounts with nonzero balances
+are shown (hledger-ui shows zero items by default, unlike command-line
+hledger).
+
 Press `right` or `enter` to view an account's transactions register.
 
 ## Register screen
@@ -162,10 +169,6 @@ lists individual postings), in hledger-ui's register:
     $ hledger-ui --register checking --cleared
     ```
 
-`E` toggles nonzero mode, in which only transactions posting a nonzero
-change are shown (hledger-ui shows zero items by default,
-unlike command-line hledger).
-
 `C` toggles cleared mode, in which
 [uncleared transactions and postings](/journal.html#transactions) are
 not shown. `U` toggles uncleared mode, in which only uncleared
@@ -173,11 +176,15 @@ transactions/postings are shown.
 
 `R` toggles real mode, in which [virtual postings](/journal.html#virtual-postings) are ignored.
 
-Press `right` or `enter` to view the selected transaction in full
+`E` toggles nonzero mode, in which only transactions posting a nonzero
+change are shown (hledger-ui shows zero items by default,
+unlike command-line hledger).
+
+Press `right` (or `enter`) to view the selected transaction in full
 detail.
 
-Note, filter queries which filter by account name do not yet do much
+Note, filter queries which filter by account name are not very useful 
-useful on this screen.
+on this screen yet.
 
 ## Transaction screen
 
@@ -201,11 +208,11 @@ reload).
 ## Error screen
 
 This screen will appear if there is a problem, such as a parse error,
-when you press g to reload. Once you have fixed the problem described,
+when you press g to reload. Once you have fixed the problem,
-press g again to reload and restore normal operation.
+press g again to reload and resume normal operation.
+(Or, you can press escape to cancel the reload attempt.)
 
 _man_({{
-
 # ENVIRONMENT
 
 **COLUMNS**
@@ -233,5 +240,4 @@ visual indication that this is in progress.
 The register screen's switching between historic balance and running
 total based on query arguments may be confusing, and there is no
 column heading to indicate which is being displayed.
-
 }})

hledger-ui/doc/hledger-ui.1.txt

@@ -141,15 +141,13 @@ OOPPTTIIOONNSS
        name will be "TAG:multi:level:account:name".
 
 KKEEYYSS
-       Generally  the cursor keys navigate; right (or enter) goes deeper, left
+       h  shows  a  help  dialog listing all keys.  (Some but not all of these
-       returns to the previous screen, up/down/page up/page down/home/end move
+       also appear in the quick help at the bottom of each  screen.)  Press  h
-       up and down through lists.
+       again (or ESCAPE) to close it.
 
-       g  reloads from the data file(s) and updates the current screen and any
+       The cursor keys navigate: right (or enter) goes deeper, left returns to
-       previous screens.  (With large files, there can be a noticeable pause.)
+       the previous screen,  up/down/page up/page down/home/end  move  up  and
-
+       down through lists.
-       a  runs  command-line  hledger's  add  command, and reloads hledger-ui.
-       This allows some basic data entry.
 
        /  lets you set or change the filter query, which limits the data shown
        on most screens (in addition to the  quick  filters  described  below).
@@ -159,7 +157,15 @@ KKEEYYSS
 
        BACKSPACE or DELETE clears any filters in effect.
 
-       ESCAPE clears any filters and jumps to the top screen.
+       ESCAPE  removes  any  filters currently in effect, and jumps to the top
+       screen.  Or, it cancels a minibuffer edit or  help  dialog  if  one  is
+       active.
+
+       g  reloads from the data file(s) and updates the current screen and any
+       previous screens.  (With large files, there can be a noticeable pause.)
+
+       a  runs  command-line  hledger's  add  command, and reloads the updated
+       file.  This allows some basic data entry.
 
        q quits the application.
 
@@ -180,16 +186,16 @@ SSCCRREEEENNSS
        depth limit by pressing a number key, 1 to 9.   Or,  adjust  the  depth
        limit by pressing - or + (= also works).  0 removes the depth limit.
 
-       E  toggles  nonzero  mode, in which only accounts with nonzero balances
-       are shown (hledger-ui shows zero items by default, unlike  command-line
-       hledger).
-
        C  toggles  cleared  mode, in which uncleared transactions and postings
        are not shown.  U toggles  uncleared  mode,  in  which  only  uncleared
        transactions/postings are shown.
 
        R toggles real mode, in which virtual postings are ignored.
 
+       E  toggles  nonzero  mode, in which only accounts with nonzero balances
+       are shown (hledger-ui shows zero items by default, unlike  command-line
+       hledger).
+
        Press right or enter to view an account's transactions register.
 
    RReeggiisstteerr ssccrreeeenn
@@ -223,20 +229,20 @@ SSCCRREEEENNSS
                 $ hledger-ui --begin 'this month' desc:market
                 $ hledger-ui --register checking --cleared
 
-       E  toggles  nonzero  mode, in which only transactions posting a nonzero
-       change are shown (hledger-ui shows zero items by default,  unlike  com-
-       mand-line hledger).
-
        C  toggles  cleared  mode, in which uncleared transactions and postings
        are not shown.  U toggles  uncleared  mode,  in  which  only  uncleared
        transactions/postings are shown.
 
        R toggles real mode, in which virtual postings are ignored.
 
-       Press right or enter to view the selected transaction in full detail.
+       E  toggles  nonzero  mode, in which only transactions posting a nonzero
+       change are shown (hledger-ui shows zero items by default,  unlike  com-
+       mand-line hledger).
 
-       Note,  filter  queries  which filter by account name do not yet do much
+       Press right (or enter) to view the selected transaction in full detail.
-       useful on this screen.
+
+       Note, filter queries which filter by account name are not  very  useful
+       on this screen yet.
 
    TTrraannssaaccttiioonn ssccrreeeenn
        This  screen  shows  a  single transaction, as a general journal entry,
@@ -258,8 +264,9 @@ SSCCRREEEENNSS
 
    EErrrroorr ssccrreeeenn
        This screen will appear if there is a problem, such as a  parse  error,
-       when you press g to reload.  Once you have fixed the problem described,
+       when  you  press g to reload.  Once you have fixed the problem, press g
-       press g again to reload and restore normal operation.
+       again to reload and resume normal operation.  (Or, you can press escape
+       to cancel the reload attempt.)
 
 EENNVVIIRROONNMMEENNTT
        CCOOLLUUMMNNSS The screen width to use.  Default: the full terminal width.