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 .PP
Status marks are optional, but can be helpful eg for reconciling with Status marks are optional, but can be helpful eg for reconciling with
real\-world accounts. real\-world accounts.
Some editor modes provide highlighting and shortcuts working with Some editor modes provide highlighting and shortcuts for working with
status. status.
Eg in Emacs ledger\-mode, you can toggle transaction status with C\-c Eg in Emacs ledger\-mode, you can toggle transaction status with C\-c
C\-e, or posting status with C\-c C\-c. C\-e, or posting status with C\-c C\-c.
@ -266,7 +266,7 @@ Here\[aq]s one suggestion:
.PP .PP
.TS .TS
tab(@); tab(@);
lw(10.7n) lw(8.8n). lw(10.5n) lw(59.5n).
T{ T{
status status
T}@T{ T}@T{
@ -276,24 +276,23 @@ _
T{ T{
uncleared uncleared
T}@T{ T}@T{
recorded but not yet reconciled; needs checking recorded but not yet reconciled; needs review
T} T}
T{ T{
pending pending
T}@T{ T}@T{
tentatively reconciled, during reconciliation (if needed); "I think I tentatively reconciled (if needed, eg during a big reconciliation)
have matched this one"
T} T}
T{ T{
cleared cleared
T}@T{ T}@T{
complete, reconciled/checked as far as possible, and considered correct. complete, reconciled as far as possible, and considered correct
T} T}
.TE .TE
.PP .PP
With this scheme, you would use \f[C]\-PC\f[] to see the current balance 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 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. up\-to\-date state of your finances.
.SS Account names .SS Account names
.PP .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 Status marks are optional, but can be helpful eg for reconciling with
real-world accounts. Some editor modes provide highlighting and real-world accounts. Some editor modes provide highlighting and
shortcuts working with status. Eg in Emacs ledger-mode, you can toggle shortcuts for working with status. Eg in Emacs ledger-mode, you can
transaction status with C-c C-e, or posting status with C-c C-c. 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 What "uncleared", "pending", and "cleared" actually mean is up to
you. Here's one suggestion: you. Here's one suggestion:
status meaning status meaning
---------------------- --------------------------------------------------------------------------
uncleared recorded uncleared recorded but not yet reconciled; needs review
but not pending tentatively reconciled (if needed, eg during a big
yet reconciliation)
reconciled; cleared complete, reconciled as far as possible, and considered
needs correct
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.
With this scheme, you would use '-PC' to see the current balance at 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 your bank, '-U' to see things which will probably hit your bank soon
uncashed checks), and no flags to see the most up-to-date state of your (like uncashed checks), and no flags to see the most up-to-date state of
finances. your finances.
 
File: hledger_journal.5.info, Node: Account names, Next: Amounts, Prev: Status, Up: FILE FORMAT 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 Ref: #posting-dates6963
Node: Status8337 Node: Status8337
Ref: #status8461 Ref: #status8461
Node: Account names10360 Node: Account names10129
Ref: #account-names10500 Ref: #account-names10269
Node: Amounts10987 Node: Amounts10756
Ref: #amounts11125 Ref: #amounts10894
Node: Virtual Postings13226 Node: Virtual Postings12995
Ref: #virtual-postings13387 Ref: #virtual-postings13156
Node: Balance Assertions14607 Node: Balance Assertions14376
Ref: #balance-assertions14784 Ref: #balance-assertions14553
Node: Assertions and ordering15680 Node: Assertions and ordering15449
Ref: #assertions-and-ordering15868 Ref: #assertions-and-ordering15637
Node: Assertions and included files16568 Node: Assertions and included files16337
Ref: #assertions-and-included-files16811 Ref: #assertions-and-included-files16580
Node: Assertions and multiple -f options17144 Node: Assertions and multiple -f options16913
Ref: #assertions-and-multiple--f-options17400 Ref: #assertions-and-multiple--f-options17169
Node: Assertions and commodities17532 Node: Assertions and commodities17301
Ref: #assertions-and-commodities17769 Ref: #assertions-and-commodities17538
Node: Assertions and subaccounts18465 Node: Assertions and subaccounts18234
Ref: #assertions-and-subaccounts18699 Ref: #assertions-and-subaccounts18468
Node: Assertions and virtual postings19220 Node: Assertions and virtual postings18989
Ref: #assertions-and-virtual-postings19429 Ref: #assertions-and-virtual-postings19198
Node: Balance Assignments19571 Node: Balance Assignments19340
Ref: #balance-assignments19740 Ref: #balance-assignments19509
Node: Prices20859 Node: Prices20628
Ref: #prices20994 Ref: #prices20763
Node: Transaction prices21045 Node: Transaction prices20814
Ref: #transaction-prices21192 Ref: #transaction-prices20961
Node: Market prices23348 Node: Market prices23117
Ref: #market-prices23485 Ref: #market-prices23254
Node: Comments24445 Node: Comments24214
Ref: #comments24569 Ref: #comments24338
Node: Tags25682 Node: Tags25451
Ref: #tags25802 Ref: #tags25571
Node: Implicit tags27231 Node: Implicit tags27000
Ref: #implicit-tags27339 Ref: #implicit-tags27108
Node: Directives27856 Node: Directives27625
Ref: #directives27971 Ref: #directives27740
Node: Account aliases28164 Node: Account aliases27933
Ref: #account-aliases28310 Ref: #account-aliases28079
Node: Basic aliases28914 Node: Basic aliases28683
Ref: #basic-aliases29059 Ref: #basic-aliases28828
Node: Regex aliases29749 Node: Regex aliases29518
Ref: #regex-aliases29919 Ref: #regex-aliases29688
Node: Multiple aliases30634 Node: Multiple aliases30403
Ref: #multiple-aliases30808 Ref: #multiple-aliases30577
Node: end aliases31306 Node: end aliases31075
Ref: #end-aliases31448 Ref: #end-aliases31217
Node: account directive31549 Node: account directive31318
Ref: #account-directive31731 Ref: #account-directive31500
Node: apply account directive32027 Node: apply account directive31796
Ref: #apply-account-directive32225 Ref: #apply-account-directive31994
Node: Multi-line comments32884 Node: Multi-line comments32653
Ref: #multi-line-comments33076 Ref: #multi-line-comments32845
Node: commodity directive33204 Node: commodity directive32973
Ref: #commodity-directive33390 Ref: #commodity-directive33159
Node: Default commodity34262 Node: Default commodity34031
Ref: #default-commodity34437 Ref: #default-commodity34206
Node: Default year34974 Node: Default year34743
Ref: #default-year35141 Ref: #default-year34910
Node: Including other files35564 Node: Including other files35333
Ref: #including-other-files35723 Ref: #including-other-files35492
Node: EDITOR SUPPORT36120 Node: EDITOR SUPPORT35889
Ref: #editor-support36240 Ref: #editor-support36009
 
End Tag Table 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: separated from it by a space, indicating one of three statuses:
mark   | status mark   | status
:-----------|:---------- :-----------|:-------------------
  | uncleared (no mark)   | uncleared (no mark)
`!` | pending `!` | pending
`*` | cleared `*` | 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. 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. 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. 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. What "uncleared", "pending", and "cleared" actually mean is up to you.
Here's one suggestion: Here's one suggestion:
status | meaning status | meaning
----------|-------- :---------|:------------------------------------------------------------
uncleared | recorded but not yet reconciled; needs checking uncleared | recorded but not yet reconciled; needs review
pending | tentatively reconciled, during reconciliation (if needed); "I think I have matched this one" pending | tentatively reconciled (if needed, eg during a big reconciliation)
cleared | complete, reconciled/checked as far as possible, and considered correct. cleared | complete, reconciled as far as possible, and considered correct
With this scheme, you would use With this scheme, you would use
`-PC` to see the current balance at your bank, `-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. and no flags to see the most up-to-date state of your finances.
## Account names ## Account names

View File

@ -191,7 +191,7 @@ FILE FORMAT
Status marks are optional, but can be helpful eg for reconciling with Status marks are optional, but can be helpful eg for reconciling with
real-world accounts. Some editor modes provide highlighting and short- 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. 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. What "uncleared", "pending", and "cleared" actually mean is up to you.
@ -199,38 +199,16 @@ FILE FORMAT
status meaning status meaning
---------------------------- --------------------------------------------------------------------------
uncleared recorded uncleared recorded but not yet reconciled; needs review
but not pending tentatively reconciled (if needed, eg during a big recon-
yet rec- ciliation)
onciled; cleared complete, reconciled as far as possible, and considered
needs correct
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.
With this scheme, you would use -PC to see the current balance at your 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 uncashed checks), and no flags to see the most up-to-date state of your
finances. finances.
@ -827,6 +805,7 @@ EDITOR SUPPORT
lime-Text lime-Text
Textmate https://github.com/ledger/ledger/wiki/Using-Text- Textmate https://github.com/ledger/ledger/wiki/Using-Text-
Mate-2 Mate-2
Text Wrangler https://github.com/ledger/ledger/wiki/Edit- Text Wrangler https://github.com/ledger/ledger/wiki/Edit-
ing-Ledger-files-with-TextWrangler ing-Ledger-files-with-TextWrangler