slaesvuo/hledger
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

ui: doc: update manuals

Browse Source
This commit is contained in:
Simon Michael 2018-10-17 13:14:52 -07:00
parent b5df5fb5f0
commit b1582b29b1
4 changed files with 223 additions and 163 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

67
hledger-ui/hledger-ui.1
View File

@ -26,6 +26,13 @@ limited data entry capability.
It is easier than hledger's command\-line interface, and sometimes It is easier than hledger's command\-line interface, and sometimes
quicker and more convenient than the web interface. quicker and more convenient than the web interface.
.PP .PP
Note hledger\-ui has some different defaults: \- it generates
rule\-based transactions and postings by default (\[en]forecast and
\[en]auto are always on).
\- it hides transactions dated in the future by default (change this
with \[en]future or the F key).
Experimental.
.PP
Like hledger, it reads data from one or more files in hledger journal, Like hledger, it reads data from one or more files in hledger journal,
timeclock, timedot, or CSV format specified with \f[C]\-f\f[], or timeclock, timedot, or CSV format specified with \f[C]\-f\f[], or
\f[C]$LEDGER_FILE\f[], or \f[C]$HOME/.hledger.journal\f[] (on windows, \f[C]$LEDGER_FILE\f[], or \f[C]$HOME/.hledger.journal\f[] (on windows,
@ -59,8 +66,18 @@ show period balances (changes) at startup instead of historical balances
.RS .RS
.RE .RE
.TP .TP
.B \f[C]\-\-flat\f[] .B \f[C]\-F\ \-\-flat\f[]
show full account names, unindented show accounts as a list (default)
.RS
.RE
.TP
.B \f[C]\-T\ \-\-tree\f[]
show accounts as a tree
.RS
.RE
.TP
.B \f[C]\-\-future\f[]
show transactions dated later than today (normally hidden)
.RS .RS
.RE .RE
.PP .PP
@ -270,6 +287,14 @@ account depth and transaction status (see below).
\f[C]BACKSPACE\f[] or \f[C]DELETE\f[] removes all filters, showing all \f[C]BACKSPACE\f[] or \f[C]DELETE\f[] removes all filters, showing all
transactions. transactions.
.PP .PP
As mentioned above, hledger\-ui shows auto\-generated periodic
transactions, and hides future transactions (auto\-generated or not) by
default.
\f[C]F\f[] toggles showing and hiding these future transactions.
This is similar to using a query like \f[C]date:\-tomorrow\f[], but more
convenient.
(experimental)
.PP
\f[C]ESCAPE\f[] removes all filters and jumps back to the top screen. \f[C]ESCAPE\f[] removes all filters and jumps back to the top screen.
Or, it cancels a minibuffer edit or help dialog in progress. Or, it cancels a minibuffer edit or help dialog in progress.
.PP .PP
@ -314,21 +339,21 @@ By default, it shows all accounts and their latest ending balances
if you specify a query on the command line, it shows just the matched if you specify a query on the command line, it shows just the matched
accounts and the balances from matched transactions. accounts and the balances from matched transactions.
.PP .PP
Account names are normally indented to show the hierarchy (tree mode). Account names are shown as a flat list by default.
To see less detail, set a depth limit by pressing a number key, Press \f[C]T\f[] to toggle tree mode.
\f[C]1\f[] to \f[C]9\f[]. In flat mode, account balances are exclusive of subaccounts, except
where subaccounts are hidden by a depth limit (see below).
In tree mode, all account balances are inclusive of subaccounts.
.PP
To see less detail, press a number key, \f[C]1\f[] to \f[C]9\f[], to set
a depth limit.
Or use \f[C]\-\f[] to decrease and \f[C]+\f[]/\f[C]=\f[] to increase the
depth limit.
\f[C]0\f[] shows even less detail, collapsing all accounts to a single \f[C]0\f[] shows even less detail, collapsing all accounts to a single
total. total.
\f[C]\-\f[] and \f[C]+\f[] (or \f[C]=\f[]) decrease and increase the
depth limit.
To remove the depth limit, set it higher than the maximum account depth, To remove the depth limit, set it higher than the maximum account depth,
or press \f[C]ESCAPE\f[]. or press \f[C]ESCAPE\f[].
.PP .PP
\f[C]F\f[] toggles flat mode, in which accounts are shown as a flat
list, with their full names.
In this mode, account balances exclude subaccounts, except for accounts
at the depth limit (as with hledger's balance command).
.PP
\f[C]H\f[] toggles between showing historical balances or period \f[C]H\f[] toggles between showing historical balances or period
balances. balances.
Historical balances (the default) are ending balances at the end of the Historical balances (the default) are ending balances at the end of the
@ -380,14 +405,16 @@ If the historical total is not disturbed by a filter query, it will be
the running historical balance you would see on a bank register for the the running historical balance you would see on a bank register for the
current account. current account.
.PP .PP
If the accounts screen was in tree mode, the register screen will Transactions affecting this account's subaccounts will be included in
include transactions from both the current account and its subaccounts. the register if the accounts screen is in tree mode, or if it's in flat
If the accounts screen was in flat mode, and a non\-depth\-clipped mode but this account has subaccounts which are not shown due to a depth
account was selected, the register screen will exclude transactions from limit.
subaccounts. In other words, the register always shows the transactions contributing
In other words, the register always shows the transactions responsible to the balance shown on the accounts screen.
for the period balance shown on the accounts screen. .PD 0
As on the accounts screen, this can be toggled with \f[C]F\f[]. .P
.PD
Tree mode/flat mode can be toggled with \f[C]T\f[] here also.
.PP .PP
\f[C]U\f[] toggles filtering by unmarked status, showing or hiding \f[C]U\f[] toggles filtering by unmarked status, showing or hiding
unmarked transactions. unmarked transactions.

82
hledger-ui/hledger-ui.info
View File

@ -12,6 +12,11 @@ limited data entry capability. It is easier than hledger's command-line
interface, and sometimes quicker and more convenient than the web interface, and sometimes quicker and more convenient than the web
interface. interface.
Note hledger-ui has some different defaults: - it generates
rule-based transactions and postings by default (-forecast and -auto are
always on). - it hides transactions dated in the future by default
(change this with -future or the F key). Experimental.
Like hledger, it reads data from one or more files in hledger Like hledger, it reads data from one or more files in hledger
journal, timeclock, timedot, or CSV format specified with '-f', or journal, timeclock, timedot, or CSV format specified with '-f', or
'$LEDGER_FILE', or '$HOME/.hledger.journal' (on windows, perhaps '$LEDGER_FILE', or '$HOME/.hledger.journal' (on windows, perhaps
@ -48,9 +53,15 @@ the data.
show period balances (changes) at startup instead of historical show period balances (changes) at startup instead of historical
balances balances
'--flat' '-F --flat'
show full account names, unindented show accounts as a list (default)
'-T --tree'
show accounts as a tree
'--future'
show transactions dated later than today (normally hidden)
hledger input options: hledger input options:
@ -201,6 +212,12 @@ some common filters like account depth and transaction status (see
below). 'BACKSPACE' or 'DELETE' removes all filters, showing all below). 'BACKSPACE' or 'DELETE' removes all filters, showing all
transactions. transactions.
As mentioned above, hledger-ui shows auto-generated periodic
transactions, and hides future transactions (auto-generated or not) by
default. 'F' toggles showing and hiding these future transactions.
This is similar to using a query like 'date:-tomorrow', but more
convenient. (experimental)
'ESCAPE' removes all filters and jumps back to the top screen. Or, 'ESCAPE' removes all filters and jumps back to the top screen. Or,
it cancels a minibuffer edit or help dialog in progress. it cancels a minibuffer edit or help dialog in progress.
@ -257,17 +274,17 @@ all accounts and their latest ending balances (including the balances of
subaccounts). if you specify a query on the command line, it shows just subaccounts). if you specify a query on the command line, it shows just
the matched accounts and the balances from matched transactions. the matched accounts and the balances from matched transactions.
Account names are normally indented to show the hierarchy (tree Account names are shown as a flat list by default. Press 'T' to
mode). To see less detail, set a depth limit by pressing a number key, toggle tree mode. In flat mode, account balances are exclusive of
'1' to '9'. '0' shows even less detail, collapsing all accounts to a subaccounts, except where subaccounts are hidden by a depth limit (see
single total. '-' and '+' (or '=') decrease and increase the depth below). In tree mode, all account balances are inclusive of
limit. To remove the depth limit, set it higher than the maximum subaccounts.
account depth, or press 'ESCAPE'.
'F' toggles flat mode, in which accounts are shown as a flat list, To see less detail, press a number key, '1' to '9', to set a depth
with their full names. In this mode, account balances exclude limit. Or use '-' to decrease and '+'/'=' to increase the depth limit.
subaccounts, except for accounts at the depth limit (as with hledger's '0' shows even less detail, collapsing all accounts to a single total.
balance command). To remove the depth limit, set it higher than the maximum account depth,
or press 'ESCAPE'.
'H' toggles between showing historical balances or period balances. 'H' toggles between showing historical balances or period balances.
Historical balances (the default) are ending balances at the end of the Historical balances (the default) are ending balances at the end of the
@ -318,13 +335,12 @@ a check register. Each line represents one transaction and shows:
not disturbed by a filter query, it will be the running historical not disturbed by a filter query, it will be the running historical
balance you would see on a bank register for the current account. balance you would see on a bank register for the current account.
If the accounts screen was in tree mode, the register screen will Transactions affecting this account's subaccounts will be included in
include transactions from both the current account and its subaccounts. the register if the accounts screen is in tree mode, or if it's in flat
If the accounts screen was in flat mode, and a non-depth-clipped account mode but this account has subaccounts which are not shown due to a depth
was selected, the register screen will exclude transactions from limit. In other words, the register always shows the transactions
subaccounts. In other words, the register always shows the transactions contributing to the balance shown on the accounts screen.
responsible for the period balance shown on the accounts screen. As on Tree mode/flat mode can be toggled with 'T' here also.
the accounts screen, this can be toggled with 'F'.
'U' toggles filtering by unmarked status, showing or hiding unmarked 'U' toggles filtering by unmarked status, showing or hiding unmarked
transactions. Similarly, 'P' toggles pending transactions, and 'C' transactions. Similarly, 'P' toggles pending transactions, and 'C'
@ -380,19 +396,19 @@ to cancel the reload attempt.)
 
Tag Table: Tag Table:
Node: Top71 Node: Top71
Node: OPTIONS829 Node: OPTIONS1090
Ref: #options926 Ref: #options1187
Node: KEYS4226 Node: KEYS4606
Ref: #keys4321 Ref: #keys4701
Node: SCREENS7280 Node: SCREENS7957
Ref: #screens7365 Ref: #screens8042
Node: Accounts screen7455 Node: Accounts screen8132
Ref: #accounts-screen7583 Ref: #accounts-screen8260
Node: Register screen9813 Node: Register screen10476
Ref: #register-screen9968 Ref: #register-screen10631
Node: Transaction screen12042 Node: Transaction screen12628
Ref: #transaction-screen12200 Ref: #transaction-screen12786
Node: Error screen13070 Node: Error screen13656
Ref: #error-screen13192 Ref: #error-screen13778
 
End Tag Table End Tag Table

4
hledger-ui/hledger-ui.m4.md
View File

@ -130,12 +130,12 @@ press `ENTER` to set it, or `ESCAPE`to cancel.
There are also keys for quickly adjusting some common filters like account depth and transaction status (see below). There are also keys for quickly adjusting some common filters like account depth and transaction status (see below).
`BACKSPACE` or `DELETE` removes all filters, showing all transactions. `BACKSPACE` or `DELETE` removes all filters, showing all transactions.
As mentioned above, hledger-ui hides transactions in the future by default. As mentioned above, hledger-ui shows auto-generated periodic transactions,
and hides future transactions (auto-generated or not) by default.
`F` toggles showing and hiding these future transactions. `F` toggles showing and hiding these future transactions.
This is similar to using a query like `date:-tomorrow`, but more convenient. This is similar to using a query like `date:-tomorrow`, but more convenient.
(experimental) (experimental)
`ESCAPE` removes all filters and jumps back to the top screen. `ESCAPE` removes all filters and jumps back to the top screen.
Or, it cancels a minibuffer edit or help dialog in progress. Or, it cancels a minibuffer edit or help dialog in progress.

51
hledger-ui/hledger-ui.txt
View File

@ -22,6 +22,11 @@ DESCRIPTION
mand-line interface, and sometimes quicker and more convenient than the mand-line interface, and sometimes quicker and more convenient than the
web interface. web interface.
Note hledger-ui has some different defaults: - it generates rule-based
transactions and postings by default (-forecast and -auto are always
on). - it hides transactions dated in the future by default (change
this with -future or the F key). Experimental.
Like hledger, it reads data from one or more files in hledger journal, Like hledger, it reads data from one or more files in hledger journal,
timeclock, timedot, or CSV format specified with -f, or $LEDGER_FILE, timeclock, timedot, or CSV format specified with -f, or $LEDGER_FILE,
or $HOME/.hledger.journal (on windows, perhaps or $HOME/.hledger.journal (on windows, perhaps
@ -48,7 +53,14 @@ OPTIONS
show period balances (changes) at startup instead of historical show period balances (changes) at startup instead of historical
balances balances
--flat show full account names, unindented -F --flat
show accounts as a list (default)
-T --tree
show accounts as a tree
--future
show transactions dated later than today (normally hidden)
hledger input options: hledger input options:
@ -188,6 +200,12 @@ KEYS
common filters like account depth and transaction status (see below). common filters like account depth and transaction status (see below).
BACKSPACE or DELETE removes all filters, showing all transactions. BACKSPACE or DELETE removes all filters, showing all transactions.
As mentioned above, hledger-ui shows auto-generated periodic transac-
tions, and hides future transactions (auto-generated or not) by
default. F toggles showing and hiding these future transactions. This
is similar to using a query like date:-tomorrow, but more convenient.
(experimental)
ESCAPE removes all filters and jumps back to the top screen. Or, it ESCAPE removes all filters and jumps back to the top screen. Or, it
cancels a minibuffer edit or help dialog in progress. cancels a minibuffer edit or help dialog in progress.
@ -227,18 +245,18 @@ SCREENS
of subaccounts). if you specify a query on the command line, it shows of subaccounts). if you specify a query on the command line, it shows
just the matched accounts and the balances from matched transactions. just the matched accounts and the balances from matched transactions.
Account names are normally indented to show the hierarchy (tree mode). Account names are shown as a flat list by default. Press T to toggle
To see less detail, set a depth limit by pressing a number key, 1 to 9. tree mode. In flat mode, account balances are exclusive of subac-
0 shows even less detail, collapsing all accounts to a single total. - counts, except where subaccounts are hidden by a depth limit (see
and + (or =) decrease and increase the depth limit. To remove the below). In tree mode, all account balances are inclusive of subac-
counts.
To see less detail, press a number key, 1 to 9, to set a depth limit.
Or use - to decrease and +/= to increase the depth limit. 0 shows even
less detail, collapsing all accounts to a single total. To remove the
depth limit, set it higher than the maximum account depth, or press depth limit, set it higher than the maximum account depth, or press
ESCAPE. ESCAPE.
F toggles flat mode, in which accounts are shown as a flat list, with
their full names. In this mode, account balances exclude subaccounts,
except for accounts at the depth limit (as with hledger's balance com-
mand).
H toggles between showing historical balances or period balances. His- H toggles between showing historical balances or period balances. His-
torical balances (the default) are ending balances at the end of the torical balances (the default) are ending balances at the end of the
report period, taking into account all transactions before that date report period, taking into account all transactions before that date
@ -282,13 +300,12 @@ SCREENS
a filter query, it will be the running historical balance you would a filter query, it will be the running historical balance you would
see on a bank register for the current account. see on a bank register for the current account.
If the accounts screen was in tree mode, the register screen will Transactions affecting this account's subaccounts will be included in
include transactions from both the current account and its subaccounts. the register if the accounts screen is in tree mode, or if it's in flat
If the accounts screen was in flat mode, and a non-depth-clipped mode but this account has subaccounts which are not shown due to a
account was selected, the register screen will exclude transactions depth limit. In other words, the register always shows the transac-
from subaccounts. In other words, the register always shows the trans- tions contributing to the balance shown on the accounts screen.
actions responsible for the period balance shown on the accounts Tree mode/flat mode can be toggled with T here also.
screen. As on the accounts screen, this can be toggled with F.
U toggles filtering by unmarked status, showing or hiding unmarked U toggles filtering by unmarked status, showing or hiding unmarked
transactions. Similarly, P toggles pending transactions, and C toggles transactions. Similarly, P toggles pending transactions, and C toggles