;doc:manuals: fix some code block language types
This commit is contained in:
parent
ee0c36dfde
commit
b605b5bfd5
@ -341,9 +341,11 @@ This is very useful when reconciling. A good workflow is to have
|
|||||||
your bank's online register open in a browser window, for reference;
|
your bank's online register open in a browser window, for reference;
|
||||||
the journal file open in an editor window;
|
the journal file open in an editor window;
|
||||||
and hledger-ui in watch mode in a terminal window, eg:
|
and hledger-ui in watch mode in a terminal window, eg:
|
||||||
|
|
||||||
```cli
|
```cli
|
||||||
$ hledger-ui --watch --register checking -C
|
$ hledger-ui --watch --register checking -C
|
||||||
```
|
```
|
||||||
|
|
||||||
As you mark things cleared in the editor,
|
As you mark things cleared in the editor,
|
||||||
you can see the effect immediately without having to context switch.
|
you can see the effect immediately without having to context switch.
|
||||||
This leaves more mental bandwidth for your accounting.
|
This leaves more mental bandwidth for your accounting.
|
||||||
|
|||||||
@ -33,9 +33,9 @@ Features:
|
|||||||
- If you make a mistake, enter `<` at any prompt to go one step backward.
|
- If you make a mistake, enter `<` at any prompt to go one step backward.
|
||||||
- Input prompts are displayed in a different colour when the terminal supports it.
|
- Input prompts are displayed in a different colour when the terminal supports it.
|
||||||
|
|
||||||
Example (see https://hledger.org/add.html for a detailed tutorial):
|
Example (see <https://hledger.org/add.html> for a detailed tutorial):
|
||||||
|
|
||||||
``` shell
|
```cli
|
||||||
$ hledger add
|
$ hledger add
|
||||||
Adding transactions to journal file /src/hledger/examples/sample.journal
|
Adding transactions to journal file /src/hledger/examples/sample.journal
|
||||||
Any command line arguments will be used as defaults.
|
Any command line arguments will be used as defaults.
|
||||||
|
|||||||
@ -72,7 +72,7 @@ contributions and which is due to the return on investment.
|
|||||||
assets, or otherwise converting between your investment commodity and
|
assets, or otherwise converting between your investment commodity and
|
||||||
any other commodity. Example:
|
any other commodity. Example:
|
||||||
|
|
||||||
```
|
```journal
|
||||||
2019-01-01 Investing in Snake Oil
|
2019-01-01 Investing in Snake Oil
|
||||||
assets:cash -$100
|
assets:cash -$100
|
||||||
investment:snake oil
|
investment:snake oil
|
||||||
@ -84,7 +84,7 @@ any other commodity. Example:
|
|||||||
|
|
||||||
- "Profit and loss" is change in the value of your investment:
|
- "Profit and loss" is change in the value of your investment:
|
||||||
|
|
||||||
```
|
```journal
|
||||||
2019-06-01 Snake Oil falls in value
|
2019-06-01 Snake Oil falls in value
|
||||||
investment:snake oil = $57
|
investment:snake oil = $57
|
||||||
equity:unrealized profit or loss
|
equity:unrealized profit or loss
|
||||||
@ -98,7 +98,7 @@ investment return.
|
|||||||
Example: if you use `--inv snake --pnl equity:unrealized`, then
|
Example: if you use `--inv snake --pnl equity:unrealized`, then
|
||||||
postings in the example below would be classifed as:
|
postings in the example below would be classifed as:
|
||||||
|
|
||||||
```
|
```journal
|
||||||
2019-01-01 Snake Oil #1
|
2019-01-01 Snake Oil #1
|
||||||
assets:cash -$100 ; cash flow posting
|
assets:cash -$100 ; cash flow posting
|
||||||
investment:snake oil ; investment posting
|
investment:snake oil ; investment posting
|
||||||
|
|||||||
@ -67,12 +67,14 @@ are some good choices (see <https://hledger.org/editors.html>).
|
|||||||
|
|
||||||
To get started, run `hledger add` and follow the prompts,
|
To get started, run `hledger add` and follow the prompts,
|
||||||
or save some entries like the above in `$HOME/.hledger.journal`,
|
or save some entries like the above in `$HOME/.hledger.journal`,
|
||||||
then try commands like:\
|
then try commands like:
|
||||||
`hledger print -x`\
|
```cli
|
||||||
`hledger aregister assets`\
|
$ hledger print -x
|
||||||
`hledger balance`\
|
$ hledger aregister assets
|
||||||
`hledger balancesheet`\
|
$ hledger balance
|
||||||
`hledger incomestatement`.\
|
$ hledger balancesheet
|
||||||
|
$ hledger incomestatement
|
||||||
|
```
|
||||||
Run `hledger` to list the commands.
|
Run `hledger` to list the commands.
|
||||||
See also the "Starting a journal file" and "Setting opening balances" sections
|
See also the "Starting a journal file" and "Setting opening balances" sections
|
||||||
in [PART 5: COMMON TASKS](#part-5-common-tasks).
|
in [PART 5: COMMON TASKS](#part-5-common-tasks).
|
||||||
@ -1884,7 +1886,7 @@ Here are some tips for working with account types.
|
|||||||
5. Otherwise, it will have no type.
|
5. Otherwise, it will have no type.
|
||||||
|
|
||||||
- For troubleshooting, you can list accounts and their types with:
|
- For troubleshooting, you can list accounts and their types with:
|
||||||
```
|
```cli
|
||||||
$ hledger accounts --types [ACCTPAT] [-DEPTH] [type:TYPECODES]
|
$ hledger accounts --types [ACCTPAT] [-DEPTH] [type:TYPECODES]
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -3177,14 +3179,14 @@ Note the two kinds of field names mentioned here, and used only in hledger CSV r
|
|||||||
you can optionally name the CSV columns for easy reference
|
you can optionally name the CSV columns for easy reference
|
||||||
(since hledger doesn't yet automatically recognise column headings in a CSV file),
|
(since hledger doesn't yet automatically recognise column headings in a CSV file),
|
||||||
by writing arbitrary names in a `fields` list, eg:
|
by writing arbitrary names in a `fields` list, eg:
|
||||||
```csv
|
```rules
|
||||||
fields When, What, Some_Id, Net, Total, Foo, Bar
|
fields When, What, Some_Id, Net, Total, Foo, Bar
|
||||||
```
|
```
|
||||||
|
|
||||||
2. Special **hledger field names** (`HLEDGERFIELD` in these docs):
|
2. Special **hledger field names** (`HLEDGERFIELD` in these docs):
|
||||||
you must set at least some of these to generate the hledger transaction from a CSV record,
|
you must set at least some of these to generate the hledger transaction from a CSV record,
|
||||||
by writing them as the left hand side of a [field assignment](#field-assignment), eg:
|
by writing them as the left hand side of a [field assignment](#field-assignment), eg:
|
||||||
```csv
|
```rules
|
||||||
date %When
|
date %When
|
||||||
code %Some_Id
|
code %Some_Id
|
||||||
description %What
|
description %What
|
||||||
@ -3192,7 +3194,7 @@ Note the two kinds of field names mentioned here, and used only in hledger CSV r
|
|||||||
amount1 $ %Total
|
amount1 $ %Total
|
||||||
```
|
```
|
||||||
or directly in a [`fields` list](#fields-list):
|
or directly in a [`fields` list](#fields-list):
|
||||||
```csv
|
```rules
|
||||||
fields date, description, code, , amount1, Foo, Bar
|
fields date, description, code, , amount1, Foo, Bar
|
||||||
currency $
|
currency $
|
||||||
comment %Foo %Bar
|
comment %Foo %Bar
|
||||||
@ -4207,7 +4209,7 @@ some number of hours to an account. Or if the session spans more than
|
|||||||
one day, it is split into several transactions, one for each day. For
|
one day, it is split into several transactions, one for each day. For
|
||||||
the above time log, `hledger print` generates these journal entries:
|
the above time log, `hledger print` generates these journal entries:
|
||||||
|
|
||||||
``` shell
|
```cli
|
||||||
$ hledger -f t.timeclock print
|
$ hledger -f t.timeclock print
|
||||||
2015-03-30 * optional description after 2 spaces ; optional comment, tags:
|
2015-03-30 * optional description after 2 spaces ; optional comment, tags:
|
||||||
(some account) 0.33h
|
(some account) 0.33h
|
||||||
@ -5216,7 +5218,7 @@ Here there are no ordinary transactions, so the forecasted transactions begin on
|
|||||||
|
|
||||||
Forecast transactions affect all reports, as you would expect. Eg:
|
Forecast transactions affect all reports, as you would expect. Eg:
|
||||||
|
|
||||||
```terminal
|
```cli
|
||||||
$ hledger areg rent --forecast --today=2023/4/21
|
$ hledger areg rent --forecast --today=2023/4/21
|
||||||
Transactions in expenses:rent and subaccounts:
|
Transactions in expenses:rent and subaccounts:
|
||||||
2023-05-20 rent as:ba:checking $1000 $1000
|
2023-05-20 rent as:ba:checking $1000 $1000
|
||||||
@ -5226,7 +5228,7 @@ Transactions in expenses:rent and subaccounts:
|
|||||||
2023-09-20 rent as:ba:checking $1000 $5000
|
2023-09-20 rent as:ba:checking $1000 $5000
|
||||||
```
|
```
|
||||||
|
|
||||||
```terminal
|
```cli
|
||||||
$ hledger bal -M expenses --forecast --today=2023/4/21
|
$ hledger bal -M expenses --forecast --today=2023/4/21
|
||||||
Balance changes in 2023-05-01..2023-09-30:
|
Balance changes in 2023-05-01..2023-09-30:
|
||||||
|
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user