doc: fixes for builtin manuals

This commit is contained in:
Simon Michael 2017-06-10 14:12:21 -07:00
parent d0771a8526
commit 794647780d
4 changed files with 96 additions and 139 deletions

View File

@ -256,7 +256,7 @@ pending, combine \-U and \-P.
.PP
Status marks are optional, but can be helpful eg for reconciling with
real\-world accounts.
Some editor modes provide highlighting and shortcuts working with
Some editor modes provide highlighting and shortcuts for working with
status.
Eg in Emacs ledger\-mode, you can toggle transaction status with C\-c
C\-e, or posting status with C\-c C\-c.
@ -266,7 +266,7 @@ Here\[aq]s one suggestion:
.PP
.TS
tab(@);
lw(10.7n) lw(8.8n).
lw(10.5n) lw(59.5n).
T{
status
T}@T{
@ -276,24 +276,23 @@ _
T{
uncleared
T}@T{
recorded but not yet reconciled; needs checking
recorded but not yet reconciled; needs review
T}
T{
pending
T}@T{
tentatively reconciled, during reconciliation (if needed); "I think I
have matched this one"
tentatively reconciled (if needed, eg during a big reconciliation)
T}
T{
cleared
T}@T{
complete, reconciled/checked as far as possible, and considered correct.
complete, reconciled as far as possible, and considered correct
T}
.TE
.PP
With this scheme, you would use \f[C]\-PC\f[] to see the current balance
at your bank, \f[C]\-U\f[] to see things which will probably hit your
bank soon (eg uncashed checks), and no flags to see the most
bank soon (like uncashed checks), and no flags to see the most
up\-to\-date state of your finances.
.SS Account names
.PP

View File

@ -254,45 +254,24 @@ of also matching pending, combine -U and -P.
Status marks are optional, but can be helpful eg for reconciling with
real-world accounts. Some editor modes provide highlighting and
shortcuts working with status. Eg in Emacs ledger-mode, you can toggle
transaction status with C-c C-e, or posting status with C-c C-c.
shortcuts for working with status. Eg in Emacs ledger-mode, you can
toggle transaction status with C-c C-e, or posting status with C-c C-c.
What "uncleared", "pending", and "cleared" actually mean is up to
you. Here's one suggestion:
status meaning
----------------------
uncleared recorded
but not
yet
reconciled;
needs
checking
pending tentatively
reconciled,
during
reconciliation
(if
needed);
"I
think I
have
matched
this
one"
cleared complete,
reconciled/checked
as far
as
possible,
and
considered
correct.
--------------------------------------------------------------------------
uncleared recorded but not yet reconciled; needs review
pending tentatively reconciled (if needed, eg during a big
reconciliation)
cleared complete, reconciled as far as possible, and considered
correct
With this scheme, you would use '-PC' to see the current balance at
your bank, '-U' to see things which will probably hit your bank soon (eg
uncashed checks), and no flags to see the most up-to-date state of your
finances.
your bank, '-U' to see things which will probably hit your bank soon
(like uncashed checks), and no flags to see the most up-to-date state of
your finances.

File: hledger_journal.5.info, Node: Account names, Next: Amounts, Prev: Status, Up: FILE FORMAT
@ -1081,67 +1060,67 @@ Node: Posting dates6832
Ref: #posting-dates6963
Node: Status8337
Ref: #status8461
Node: Account names10360
Ref: #account-names10500
Node: Amounts10987
Ref: #amounts11125
Node: Virtual Postings13226
Ref: #virtual-postings13387
Node: Balance Assertions14607
Ref: #balance-assertions14784
Node: Assertions and ordering15680
Ref: #assertions-and-ordering15868
Node: Assertions and included files16568
Ref: #assertions-and-included-files16811
Node: Assertions and multiple -f options17144
Ref: #assertions-and-multiple--f-options17400
Node: Assertions and commodities17532
Ref: #assertions-and-commodities17769
Node: Assertions and subaccounts18465
Ref: #assertions-and-subaccounts18699
Node: Assertions and virtual postings19220
Ref: #assertions-and-virtual-postings19429
Node: Balance Assignments19571
Ref: #balance-assignments19740
Node: Prices20859
Ref: #prices20994
Node: Transaction prices21045
Ref: #transaction-prices21192
Node: Market prices23348
Ref: #market-prices23485
Node: Comments24445
Ref: #comments24569
Node: Tags25682
Ref: #tags25802
Node: Implicit tags27231
Ref: #implicit-tags27339
Node: Directives27856
Ref: #directives27971
Node: Account aliases28164
Ref: #account-aliases28310
Node: Basic aliases28914
Ref: #basic-aliases29059
Node: Regex aliases29749
Ref: #regex-aliases29919
Node: Multiple aliases30634
Ref: #multiple-aliases30808
Node: end aliases31306
Ref: #end-aliases31448
Node: account directive31549
Ref: #account-directive31731
Node: apply account directive32027
Ref: #apply-account-directive32225
Node: Multi-line comments32884
Ref: #multi-line-comments33076
Node: commodity directive33204
Ref: #commodity-directive33390
Node: Default commodity34262
Ref: #default-commodity34437
Node: Default year34974
Ref: #default-year35141
Node: Including other files35564
Ref: #including-other-files35723
Node: EDITOR SUPPORT36120
Ref: #editor-support36240
Node: Account names10129
Ref: #account-names10269
Node: Amounts10756
Ref: #amounts10894
Node: Virtual Postings12995
Ref: #virtual-postings13156
Node: Balance Assertions14376
Ref: #balance-assertions14553
Node: Assertions and ordering15449
Ref: #assertions-and-ordering15637
Node: Assertions and included files16337
Ref: #assertions-and-included-files16580
Node: Assertions and multiple -f options16913
Ref: #assertions-and-multiple--f-options17169
Node: Assertions and commodities17301
Ref: #assertions-and-commodities17538
Node: Assertions and subaccounts18234
Ref: #assertions-and-subaccounts18468
Node: Assertions and virtual postings18989
Ref: #assertions-and-virtual-postings19198
Node: Balance Assignments19340
Ref: #balance-assignments19509
Node: Prices20628
Ref: #prices20763
Node: Transaction prices20814
Ref: #transaction-prices20961
Node: Market prices23117
Ref: #market-prices23254
Node: Comments24214
Ref: #comments24338
Node: Tags25451
Ref: #tags25571
Node: Implicit tags27000
Ref: #implicit-tags27108
Node: Directives27625
Ref: #directives27740
Node: Account aliases27933
Ref: #account-aliases28079
Node: Basic aliases28683
Ref: #basic-aliases28828
Node: Regex aliases29518
Ref: #regex-aliases29688
Node: Multiple aliases30403
Ref: #multiple-aliases30577
Node: end aliases31075
Ref: #end-aliases31217
Node: account directive31318
Ref: #account-directive31500
Node: apply account directive31796
Ref: #apply-account-directive31994
Node: Multi-line comments32653
Ref: #multi-line-comments32845
Node: commodity directive32973
Ref: #commodity-directive33159
Node: Default commodity34031
Ref: #default-commodity34206
Node: Default year34743
Ref: #default-year34910
Node: Including other files35333
Ref: #including-other-files35492
Node: EDITOR SUPPORT35889
Ref: #editor-support36009

End Tag Table

View File

@ -191,7 +191,7 @@ the transaction description or posting account name,
separated from it by a space, indicating one of three statuses:
mark   | status
:-----------|:----------
:-----------|:-------------------
  | uncleared (no mark)
`!` | pending
`*` | cleared
@ -206,21 +206,21 @@ Note from hledger 1.3 onwards, -U/--uncleared matches the uncleared (unmarked) s
To replicate Ledger and old hledger's behaviour of also matching pending, combine -U and -P.
Status marks are optional, but can be helpful eg for reconciling with real-world accounts.
Some editor modes provide highlighting and shortcuts working with status.
Some editor modes provide highlighting and shortcuts for working with status.
Eg in Emacs ledger-mode, you can toggle transaction status with C-c C-e, or posting status with C-c C-c.
What "uncleared", "pending", and "cleared" actually mean is up to you.
Here's one suggestion:
status | meaning
----------|--------
uncleared | recorded but not yet reconciled; needs checking
pending | tentatively reconciled, during reconciliation (if needed); "I think I have matched this one"
cleared | complete, reconciled/checked as far as possible, and considered correct.
:---------|:------------------------------------------------------------
uncleared | recorded but not yet reconciled; needs review
pending | tentatively reconciled (if needed, eg during a big reconciliation)
cleared | complete, reconciled as far as possible, and considered correct
With this scheme, you would use
`-PC` to see the current balance at your bank,
`-U` to see things which will probably hit your bank soon (eg uncashed checks),
`-U` to see things which will probably hit your bank soon (like uncashed checks),
and no flags to see the most up-to-date state of your finances.
## Account names

View File

@ -191,7 +191,7 @@ FILE FORMAT
Status marks are optional, but can be helpful eg for reconciling with
real-world accounts. Some editor modes provide highlighting and short-
cuts working with status. Eg in Emacs ledger-mode, you can toggle
cuts for working with status. Eg in Emacs ledger-mode, you can toggle
transaction status with C-c C-e, or posting status with C-c C-c.
What "uncleared", "pending", and "cleared" actually mean is up to you.
@ -199,38 +199,16 @@ FILE FORMAT
status meaning
----------------------------
uncleared recorded
but not
yet rec-
onciled;
needs
checking
pending tenta-
tively
recon-
ciled,
during
reconcil-
iation
(if
needed);
"I think
I have
matched
this one"
cleared complete,
recon-
ciled/checked
as far as
possible,
and con-
sidered
correct.
status meaning
--------------------------------------------------------------------------
uncleared recorded but not yet reconciled; needs review
pending tentatively reconciled (if needed, eg during a big recon-
ciliation)
cleared complete, reconciled as far as possible, and considered
correct
With this scheme, you would use -PC to see the current balance at your
bank, -U to see things which will probably hit your bank soon (eg
bank, -U to see things which will probably hit your bank soon (like
uncashed checks), and no flags to see the most up-to-date state of your
finances.
@ -827,6 +805,7 @@ EDITOR SUPPORT
lime-Text
Textmate https://github.com/ledger/ledger/wiki/Using-Text-
Mate-2
Text Wrangler https://github.com/ledger/ledger/wiki/Edit-
ing-Ledger-files-with-TextWrangler