aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/beancount.txt71
1 files changed, 59 insertions, 12 deletions
diff --git a/doc/beancount.txt b/doc/beancount.txt
index 03f4c17..2c7a20e 100644
--- a/doc/beancount.txt
+++ b/doc/beancount.txt
@@ -11,6 +11,7 @@ Filetype plugin and functions for working with beancount files.
Contents:
Commands.............|beancount-commands|
+ Options...............|beancount-options|
Completion.........|beancount-completion|
Syntax.................|beancount-syntax|
Compiler.............|beancount-compiler|
@@ -23,7 +24,7 @@ COMMANDS *beancount-commands*
*beancount-:AlignCommodity*
:AlignCommodity Adds spaces between an account and commodity so that the
decimal points of the commodities all occur in the column
- given by `g:decimal_separator_col`. If an amount has no
+ given by |g:beancount_separator_col|. If an amount has no
decimal point, the imaginary decimal point to the right
of the least significant digit will align.
@@ -33,15 +34,14 @@ COMMANDS *beancount-commands*
will be pushed to the right the appropriate amount, so
that it remains on the same character.
- The alignment character can be set using
- `g:beancount_decimal_separator`. The script assumes the
- use of spaces for alignment. It does not understand tabs.
+ The script assumes the use of spaces for alignment. It
+ does not understand tabs.
You can use the following insert-mode remap to
automatically align commodities every time you type a
decimal point: >
- inoremap . .<C-O>:AlignCommodity<CR>
+ inoremap . .<C-\><C-O>:AlignCommodity<CR>
<
You may also want to set other mappings for this. For
example, I use >
@@ -50,14 +50,54 @@ COMMANDS *beancount-commands*
vnoremap <buffer> <leader>= :AlignCommodity<CR>
<
+ *beancount-:GetContext*
+:GetContext Uses bean-doctor context to display the context of the
+ current line.
+
+ You can use the following normal mode remap to open the
+ context of the line you're currently on: >
+
+ nnoremap <buffer> <LocalLeader>c :GetContext<CR>
+<
+
+OPTIONS *beancount-options*
+
+*g:beancount_account_completion*
+ See |beancount-completion|. Can be either 'default' or 'chunks'.
+
+ Default value: 'default'
+
+*g:beancount_detailed_first*
+ If non-zero, accounts higher down the hierarchy will be listed first as
+ completions.
+
+ Default value: 0
+
+*g:beancount_separator_col*
+ The column that the decimal separator is aligned to.
+
+ Default value: 50
+
+*b:beancount_root*
+ Set the root Beancount file. This is used to gather values for the
+ completion. If not set, the current file will be used.
+
+ Default value: not set
COMPLETION *beancount-completion*
-You can complete account names using CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
-Accounts must have their `open` directive in the current file. Completion is
-always case sensitive and exact. If the base string includes colons, each
-colon-separated piece can separately match a piece of the account.
+The plugin sets 'omnifunc' to provide omni completion for account names, tags,
+links, and payees. Omni completion is accessible with |i_CTRL-X_CTRL-O|.
+
+Completion works for values defined |b:beancount_root| and included files.
+
+Account Completion~
+ *beancount-complete-accounts*
+
+Completion is always case sensitive and exact. If the base string includes
+colons, each colon-separated piece can separately match a piece of the
+account.
For example, `Ex:Other` would complete to `Expenses:Donations:Other` or
`Liabilities:AmericanExpress:InterestOther`.
@@ -67,15 +107,22 @@ has to match at the beginning of that level of the account hierarchy, e.g.
`Ex:Oth` would match `Expenses:Other` but not `Expenses:Other:Something`
nor one of the two examples given above.
`Ex:Oth:` would, however, list all direct sub-accounts of `Expenses:Other`.
-To enable this mode use
+To enable this mode use >
let g:beancount_account_completion = 'chunks'
-
+<
Optionally, the list of candidates can be sorted by the number of levels
in the account hierarchy (e.g. return 'Expenses:Other' before 'Expenses').
-This behavior can be enabled using
+This behavior can be enabled using >
let g:beancount_detailed_first = 1
+<
+Deoplete~
+ *beancount-complete-deoplete*
+
+The plugin ships with a source for the deoplete.nvim, which provides
+asynchronous autocompletion. This should just work if deoplete is enabled. The
+options for the account completion do not work for the deoplete source.
SYNTAX *beancount-syntax*