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

;site: manuals: fix many links that went to a prerelease manual

Browse Source 
[ci skip]
This commit is contained in:
Simon Michael 2019-09-09 06:24:08 -07:00
parent 499e20c0b2
commit 3b35e0afca
7 changed files with 42 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
hledger-lib/hledger_csv.m4.md
View File

@ -224,19 +224,19 @@ but when all CSV records have the same date it will assume they are oldest first
## CSV ordering ## CSV ordering
The generated [journal entries](/journal.html#transactions) will be sorted by date. The generated [journal entries](journal.html#transactions) will be sorted by date.
The order of same-day entries will be preserved The order of same-day entries will be preserved
(except in the special case where you might need [`newest-first`](#newest-first), see above). (except in the special case where you might need [`newest-first`](#newest-first), see above).
## CSV accounts ## CSV accounts
Each journal entry will have two [postings](/journal.html#postings), to `account1` and `account2` respectively. Each journal entry will have two [postings](journal.html#postings), to `account1` and `account2` respectively.
It's not yet possible to generate entries with more than two postings. It's not yet possible to generate entries with more than two postings.
It's conventional and recommended to use `account1` for the account whose CSV we are reading. It's conventional and recommended to use `account1` for the account whose CSV we are reading.
## CSV amounts ## CSV amounts
A transaction [amount](/journal.html#amounts) must be set, in one of these ways: A transaction [amount](journal.html#amounts) must be set, in one of these ways:
- with an `amount` field assignment, which sets the first posting's amount - with an `amount` field assignment, which sets the first posting's amount
@ -245,7 +245,7 @@ A transaction [amount](/journal.html#amounts) must be set, in one of these ways:
fields (both of them). Whichever one has a value will be used, with fields (both of them). Whichever one has a value will be used, with
appropriate sign. If both contain a value, it might not work so well. appropriate sign. If both contain a value, it might not work so well.
- or implicitly by means of a [balance assignment](/journal.html#balance-assignments) (see below). - or implicitly by means of a [balance assignment](journal.html#balance-assignments) (see below).
There is some special handling for sign in amounts: There is some special handling for sign in amounts:
@ -266,8 +266,8 @@ amount %amount %currency
If the CSV includes a running balance, you can assign that to one of the pseudo fields If the CSV includes a running balance, you can assign that to one of the pseudo fields
`balance` (or `balance1`) or `balance2`. `balance` (or `balance1`) or `balance2`.
This will generate a [balance assertion](/journal.html#balance-assertions) This will generate a [balance assertion](journal.html#balance-assertions)
(or if the amount is left empty, a [balance assignment](/journal.html#balance-assignments)), (or if the amount is left empty, a [balance assignment](journal.html#balance-assignments)),
on the first or second posting, on the first or second posting,
whenever the running balance field is non-empty. whenever the running balance field is non-empty.
(TODO: [#1000](https://github.com/simonmichael/hledger/issues/1000)) (TODO: [#1000](https://github.com/simonmichael/hledger/issues/1000))

34
hledger-lib/hledger_journal.m4.md
View File

@ -203,7 +203,7 @@ mark   | status
When reporting, you can filter by status with When reporting, you can filter by status with
the `-U/--unmarked`, `-P/--pending`, and `-C/--cleared` flags; the `-U/--unmarked`, `-P/--pending`, and `-C/--cleared` flags;
or the `status:`, `status:!`, and `status:*` [queries](/manual.html#queries); or the `status:`, `status:!`, and `status:*` [queries](hledger.html#queries);
or the U, P, C keys in hledger-ui. or the U, P, C keys in hledger-ui.
Note, in Ledger and in older versions of hledger, the "unmarked" state is called Note, in Ledger and in older versions of hledger, the "unmarked" state is called
@ -240,7 +240,7 @@ or left blank. Transaction descriptions can be queried, unlike [comments](#comme
You can optionally include a `|` (pipe) character in descriptions to subdivide the description You can optionally include a `|` (pipe) character in descriptions to subdivide the description
into separate fields for payee/payer name on the left (up to the first `|`) and an additional note into separate fields for payee/payer name on the left (up to the first `|`) and an additional note
field on the right (after the first `|`). This may be worthwhile if you need to do more precise field on the right (after the first `|`). This may be worthwhile if you need to do more precise
[querying](/hledger.html#queries) and [pivoting](/hledger.html#pivoting) by payee or by note. [querying](hledger.html#queries) and [pivoting](hledger.html#pivoting) by payee or by note.
## Account names ## Account names
@ -384,7 +384,7 @@ in the right file.
### Assertions and multiple -f options ### Assertions and multiple -f options
Balance assertions don't work well across files specified Balance assertions don't work well across files specified
with multiple -f options. Use include or [concatenate the files](/hledger.html#input-files) with multiple -f options. Use include or [concatenate the files](hledger.html#input-files)
instead. instead.
### Assertions and commodities ### Assertions and commodities
@ -445,9 +445,9 @@ and should normally be written without one:
(a) $1 @ €1 = $1 (a) $1 @ €1 = $1
``` ```
We do allow prices to be written there, however, and [print](/manual.html#print) shows them, We do allow prices to be written there, however, and [print](hledger.html#print) shows them,
even though they don't affect whether the assertion passes or fails. even though they don't affect whether the assertion passes or fails.
This is for backward compatibility (hledger's [close](/manual.html#close) command used to generate balance assertions with prices), This is for backward compatibility (hledger's [close](hledger.html#close) command used to generate balance assertions with prices),
and because [balance *assignments*](#balance-assignments) do use them (see below). and because [balance *assignments*](#balance-assignments) do use them (see below).
### Assertions and subaccounts ### Assertions and subaccounts
@ -633,7 +633,7 @@ You can also comment larger regions of a file using [`comment` and `end comment`
## Tags ## Tags
Tags are a way to add extra labels or labelled data to postings and transactions, Tags are a way to add extra labels or labelled data to postings and transactions,
which you can then [search](/hledger.html#queries) or [pivot](/hledger.html#pivoting) on. which you can then [search](hledger.html#queries) or [pivot](hledger.html#pivoting) on.
A simple tag is a word (which may contain hyphens) followed by a full colon, A simple tag is a word (which may contain hyphens) followed by a full colon,
written inside a transaction or posting [comment](#comments) line: written inside a transaction or posting [comment](#comments) line:
@ -877,7 +877,7 @@ P 2009/1/1 € $1.35
P 2010/1/1 € $1.40 P 2010/1/1 € $1.40
``` ```
The [`-V/--value`](manual.html#market-value) flag can be used to convert reported amounts The [`-V/--value`](hledger.html#market-value) flag can be used to convert reported amounts
to another commodity using these prices. to another commodity using these prices.
### Declaring accounts ### Declaring accounts
@ -894,7 +894,7 @@ Though not required, they can provide several benefits:
- They help with account name completion - They help with account name completion
in the add command, hledger-iadd, hledger-web, ledger-mode etc. in the add command, hledger-iadd, hledger-web, ledger-mode etc.
The simplest form is just the word `account` followed by a hledger-style [account name](manual.html#account-names), eg: The simplest form is just the word `account` followed by a hledger-style [account name](journal.html#account-names), eg:
```journal ```journal
account assets:bank:checking account assets:bank:checking
``` ```
@ -933,9 +933,9 @@ account ACCTNAME [ACCTTYPE] [;COMMENT]
hledger recognises five types (or classes) of account: Asset, Liability, Equity, Revenue, Expense. hledger recognises five types (or classes) of account: Asset, Liability, Equity, Revenue, Expense.
This is used by a few accounting-aware reports such as [balancesheet][], [incomestatement][] and [cashflow][]. This is used by a few accounting-aware reports such as [balancesheet][], [incomestatement][] and [cashflow][].
[balancesheet]: manual.html#balancesheet [balancesheet]: hledger.html#balancesheet
[cashflow]: manual.html#cashflow [cashflow]: hledger.html#cashflow
[incomestatement]: manual.html#incomestatement [incomestatement]: hledger.html#incomestatement
##### Auto-detected account types ##### Auto-detected account types
@ -1164,7 +1164,7 @@ without having to write them out explicitly in the journal (with `--forecast`).
Secondly, they also can be used to define budget goals (with `--budget`). Secondly, they also can be used to define budget goals (with `--budget`).
A periodic transaction rule looks like a normal journal entry, A periodic transaction rule looks like a normal journal entry,
with the date replaced by a tilde (`~`) followed by a [period expression](manual.html#period-expressions) with the date replaced by a tilde (`~`) followed by a [period expression](hledger.html#period-expressions)
(mnemonic: `~` looks like a recurring sine wave.): (mnemonic: `~` looks like a recurring sine wave.):
```journal ```journal
~ monthly ~ monthly
@ -1200,7 +1200,7 @@ can not accidentally alter their meaning, as in this example:
With the `--forecast` flag, each periodic transaction rule generates With the `--forecast` flag, each periodic transaction rule generates
future transactions recurring at the specified interval. future transactions recurring at the specified interval.
These are not saved in the journal, but appear in all reports. These are not saved in the journal, but appear in all reports.
They will look like normal transactions, but with an extra [tag](manual.html#tags-1): They will look like normal transactions, but with an extra [tag](journal.html#tags):
- `generated-transaction:~ PERIODICEXPR` - shows that this was generated by a periodic transaction rule, and the period - `generated-transaction:~ PERIODICEXPR` - shows that this was generated by a periodic transaction rule, and the period
@ -1245,12 +1245,12 @@ With the `--budget` flag, currently supported by the balance command,
each periodic transaction rule declares recurring budget goals for the specified accounts. each periodic transaction rule declares recurring budget goals for the specified accounts.
Eg the first example above declares a goal of spending $2000 on rent Eg the first example above declares a goal of spending $2000 on rent
(and also, a goal of depositing $2000 into checking) every month. (and also, a goal of depositing $2000 into checking) every month.
Goals and actual performance can then be compared in [budget reports](/manual.html#budget-report). Goals and actual performance can then be compared in [budget reports](hledger.html#budget-report).
For more details, see: For more details, see:
[balance: Budget report](manual.html#budget-report) [balance: Budget report](hledger.html#budget-report)
and and
[Cookbook: Budgeting and Forecasting](https://github.com/simonmichael/hledger/wiki/Budgeting-and-forecasting). [Budgeting and Forecasting](budgeting-and-forecasting.html).
<a name="automated-postings"></a> <a name="automated-postings"></a>
@ -1263,7 +1263,7 @@ Currently just one kind of change is possible - adding extra postings, which we
These rules become active when you use the `--auto` flag. These rules become active when you use the `--auto` flag.
A transaction modifier rule looks much like a normal transaction A transaction modifier rule looks much like a normal transaction
except the first line is an equals sign followed by a [query](manual.html#queries) that matches certain postings except the first line is an equals sign followed by a [query](hledger.html#queries) that matches certain postings
(mnemonic: `=` suggests matching). (mnemonic: `=` suggests matching).
And each "posting" is actually a posting-generating rule: And each "posting" is actually a posting-generating rule:

4
hledger-lib/hledger_timedot.m4.md
View File

@ -28,7 +28,7 @@ In the docs below we'll assume it's time.
A timedot file contains a series of day entries. A timedot file contains a series of day entries.
A day entry begins with a date, and is followed by category/quantity pairs, one per line. A day entry begins with a date, and is followed by category/quantity pairs, one per line.
Dates are hledger-style [simple dates](/journal.html#simple-dates) (see hledger_journal(5)). Dates are hledger-style [simple dates](journal.html#simple-dates) (see hledger_journal(5)).
Categories are hledger-style account names, optionally indented. Categories are hledger-style account names, optionally indented.
As in a hledger journal, there must be at least two spaces between the category (account name) and the quantity. As in a hledger journal, there must be at least two spaces between the category (account name) and the quantity.
@ -100,7 +100,7 @@ Balance changes in 2016/02/01-2016/02/03:
``` ```
I prefer to use period for separating account components. I prefer to use period for separating account components.
We can make this work with an [account alias](/journal.html#rewriting-accounts): We can make this work with an [account alias](journal.html#rewriting-accounts):
```timedot ```timedot
2016/2/4 2016/2/4

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

@ -123,7 +123,7 @@ the period will move automatically to track the current date.
To set a non-standard period, you can use `/` and a `date:` query. To set a non-standard period, you can use `/` and a `date:` query.
`/` lets you set a general filter query limiting the data shown, `/` lets you set a general filter query limiting the data shown,
using the same [query terms](/hledger.html#queries) as in hledger and hledger-web. using the same [query terms](hledger.html#queries) as in hledger and hledger-web.
While editing the query, you can use [CTRL-a/e/d/k, BS, cursor keys](http://hackage.haskell.org/package/brick-0.7/docs/Brick-Widgets-Edit.html#t:Editor); While editing the query, you can use [CTRL-a/e/d/k, BS, cursor keys](http://hackage.haskell.org/package/brick-0.7/docs/Brick-Widgets-Edit.html#t:Editor);
press `ENTER` to set it, or `ESCAPE`to cancel. 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).
@ -189,7 +189,7 @@ balances are what you would see on a bank statement for that account (unless dis
a filter query). Period balances ignore transactions before the report start date, so they a filter query). Period balances ignore transactions before the report start date, so they
show the change in balance during the report period. They are more useful eg when viewing a time log. show the change in balance during the report period. They are more useful eg when viewing a time log.
`U` toggles filtering by [unmarked status](/journal.html#status), `U` toggles filtering by [unmarked status](journal.html#status),
including or excluding unmarked postings in the balances. including or excluding unmarked postings in the balances.
Similarly, `P` toggles pending postings, Similarly, `P` toggles pending postings,
and `C` toggles cleared postings. and `C` toggles cleared postings.
@ -197,7 +197,7 @@ and `C` toggles cleared postings.
if you activate one or two status filters, only those postings are included; if you activate one or two status filters, only those postings are included;
and if you activate all three, the filter is removed.) and if you activate all three, the filter is removed.)
`R` toggles real mode, in which [virtual postings](/journal.html#virtual-postings) are ignored. `R` toggles real mode, in which [virtual postings](journal.html#virtual-postings) are ignored.
`Z` toggles nonzero mode, in which only accounts with nonzero balances `Z` toggles nonzero mode, in which only accounts with nonzero balances
are shown (hledger-ui shows zero items by default, unlike command-line are shown (hledger-ui shows zero items by default, unlike command-line
@ -230,13 +230,13 @@ or if it's in flat mode but this account has subaccounts which are not shown due
In other words, the register always shows the transactions contributing to the balance shown on the accounts screen. In other words, the register always shows the transactions contributing to the balance shown on the accounts screen.
Tree mode/flat mode can be toggled with `T` here also. Tree mode/flat mode can be toggled with `T` here also.
`U` toggles filtering by [unmarked status](/journal.html#status), showing or hiding unmarked transactions. `U` toggles filtering by [unmarked status](journal.html#status), showing or hiding unmarked transactions.
Similarly, `P` toggles pending transactions, and `C` toggles cleared transactions. Similarly, `P` toggles pending transactions, and `C` toggles cleared transactions.
(By default, transactions with all statuses are shown; (By default, transactions with all statuses are shown;
if you activate one or two status filters, only those transactions are shown; if you activate one or two status filters, only those transactions are shown;
and if you activate all three, the filter is removed.) and if you activate all three, the filter is removed.)
`R` toggles real mode, in which [virtual postings](/journal.html#virtual-postings) are ignored. `R` toggles real mode, in which [virtual postings](journal.html#virtual-postings) are ignored.
`Z` toggles nonzero mode, in which only transactions posting a nonzero `Z` toggles nonzero mode, in which only transactions posting a nonzero
change are shown (hledger-ui shows zero items by default, change are shown (hledger-ui shows zero items by default,

5
hledger/hledger_addons.m4.md
View File

@ -47,7 +47,7 @@ shows differences in an account's transactions between one journal file and anot
### iadd ### iadd
[hledger-iadd](http://hackage.haskell.org/package/hledger-iadd) [hledger-iadd](http://hackage.haskell.org/package/hledger-iadd)
is a curses-style, more interactive replacement for the [add command](/hledger.html#add). is a curses-style, more interactive replacement for the [add command](hledger.html#add).
### interest ### interest
@ -61,8 +61,7 @@ but it's superseded now by the built-in [roi](#roi) command.
## Experimental add-ons ## Experimental add-ons
These are available in source form in the hledger repo's bin/ directory; These are available in source form in the hledger repo's bin/ directory.
installing them is [pretty easy](/download.html#d).
They may be less mature and documented than built-in commands. They may be less mature and documented than built-in commands.
Reading and tweaking these is a good way to start making your own! Reading and tweaking these is a good way to start making your own!

10
hledger/hledger_options.m4.md
View File

@ -187,9 +187,9 @@ You can also specify multiple `-f` options, to read multiple files as one big jo
There are some limitations with this: There are some limitations with this:
- directives in one file will not affect the other files - directives in one file will not affect the other files
- [balance assertions](/journal.html#balance-assertions) will not see any account balances from previous files - [balance assertions](journal.html#balance-assertions) will not see any account balances from previous files
If you need those, either use the [include directive](/journal.html#including-other-files), If you need those, either use the [include directive](journal.html#including-other-files),
or concatenate the files, eg: `cat a.journal b.journal | hledger -f- CMD`. or concatenate the files, eg: `cat a.journal b.journal | hledger -f- CMD`.
## Smart dates ## Smart dates
@ -407,7 +407,7 @@ Normally hledger sums amounts, and organizes them in a hierarchy, based on accou
The `--pivot FIELD` option causes it to sum and organize hierarchy based on the value of some other field instead. The `--pivot FIELD` option causes it to sum and organize hierarchy based on the value of some other field instead.
FIELD can be: FIELD can be:
`code`, `description`, `payee`, `note`, `code`, `description`, `payee`, `note`,
or the full name (case insensitive) of any [tag](/journal.html#tags). or the full name (case insensitive) of any [tag](journal.html#tags).
As with account names, values containing `colon:separated:parts` will be displayed hierarchically in reports. As with account names, values containing `colon:separated:parts` will be displayed hierarchically in reports.
`--pivot` is a general option affecting all reports; you can think of hledger transforming `--pivot` is a general option affecting all reports; you can think of hledger transforming
@ -458,7 +458,7 @@ $ hledger balance --pivot member acct:.
### -B: Cost ### -B: Cost
The `-B/--cost` flag converts amounts to their cost (or selling price) at transaction time, The `-B/--cost` flag converts amounts to their cost (or selling price) at transaction time,
if they have a [transaction price](/journal.html#transaction-prices) specified. if they have a [transaction price](journal.html#transaction-prices) specified.
This flag is equivalent to `--value=cost`, described below. This flag is equivalent to `--value=cost`, described below.
### -V: Market value ### -V: Market value
@ -474,7 +474,7 @@ If most of your P declarations lead to a single home currency, this will usually
(To specify the commodity, see -X below.) (To specify the commodity, see -X below.)
Note that in hledger, market prices are always declared explicitly with P directives; Note that in hledger, market prices are always declared explicitly with P directives;
we do not infer them from [transaction prices](/manual.html#transaction-prices) as Ledger does. we do not infer them from [transaction prices](journal.html#transaction-prices) as Ledger does.
Here's a quick example of -V: Here's a quick example of -V:

10
hledger/hledger_queries.m4.md
View File

@ -17,7 +17,7 @@ instead most commands show transactions/postings/accounts which match (or negati
- any of the status terms AND - any of the status terms AND
- all the other terms. - all the other terms.
The [print](/manual.html#print) command instead shows transactions which: The [print](hledger.html#print) command instead shows transactions which:
- match any of the description terms AND - match any of the description terms AND
- have any postings matching any of the positive account terms AND - have any postings matching any of the positive account terms AND
@ -57,9 +57,9 @@ or `hledger print cur:\\$`.
**`date:PERIODEXPR`** **`date:PERIODEXPR`**
: match dates within the specified period. : match dates within the specified period.
PERIODEXPR is a [period expression](#period-expressions) (with no report interval). PERIODEXPR is a [period expression](hledger.html#period-expressions) (with no report interval).
Examples: `date:2016`, `date:thismonth`, `date:2000/2/1-2/15`, `date:lastweek-`. Examples: `date:2016`, `date:thismonth`, `date:2000/2/1-2/15`, `date:lastweek-`.
If the `--date2` command line flag is present, this matches [secondary dates](manual.html#secondary-dates) instead. If the `--date2` command line flag is present, this matches [secondary dates](journal.html#secondary-dates) instead.
**`date2:PERIODEXPR`** **`date2:PERIODEXPR`**
: match secondary dates within the specified period. : match secondary dates within the specified period.
@ -68,11 +68,11 @@ If the `--date2` command line flag is present, this matches [secondary dates](ma
: match (or display, depending on command) accounts at or above this depth : match (or display, depending on command) accounts at or above this depth
**`note:REGEX`** **`note:REGEX`**
: match transaction [notes](/manual.html#payee-and-note) : match transaction [notes](journal.html#payee-and-note)
(part of description right of `|`, or whole description when there's no `|`) (part of description right of `|`, or whole description when there's no `|`)
**`payee:REGEX`** **`payee:REGEX`**
: match transaction [payee/payer names](/manual.html#payee-and-note) : match transaction [payee/payer names](journal.html#payee-and-note)
(part of description left of `|`, or whole description when there's no `|`) (part of description left of `|`, or whole description when there's no `|`)
**`real:, real:0`** **`real:, real:0`**