diff options
author | Alexis Hildebrandt <afh@surryhill.net> | 2023-02-06 22:36:44 +0100 |
---|---|---|
committer | Martin Michlmayr <tbm@cyrius.com> | 2023-02-08 14:56:11 +0800 |
commit | 2d8ee58201cd9d717583dab5fb17f0cf9a3998ce (patch) | |
tree | 40509fc3719889da0699c838897ee32419d165bf /doc | |
parent | 51c1488ef60e095034b2f8cd57b69f58f59d7145 (diff) | |
download | fork-ledger-2d8ee58201cd9d717583dab5fb17f0cf9a3998ce.tar.gz fork-ledger-2d8ee58201cd9d717583dab5fb17f0cf9a3998ce.tar.bz2 fork-ledger-2d8ee58201cd9d717583dab5fb17f0cf9a3998ce.zip |
docs: move section "Payee metadata tag"
Closes #2151
Diffstat (limited to 'doc')
-rw-r--r-- | doc/ledger3.texi | 99 |
1 files changed, 50 insertions, 49 deletions
diff --git a/doc/ledger3.texi b/doc/ledger3.texi index 98e4d2ad..f272c992 100644 --- a/doc/ledger3.texi +++ b/doc/ledger3.texi @@ -3058,13 +3058,59 @@ You can gang up multiple tags by sharing colons: ; :TAG1:TAG2:TAG3: @end smallexample +@node Metadata values, Typed metadata, Metadata tags, Metadata +@subsection Metadata values + +To associate a value with a tag, use the syntax ``Key: Value'', where +the value can be any string of characters. Whitespace is needed after +the colon, and cannot appear in the Key: + +@smallexample @c input:validate +2012-03-10 * KFC + Expenses:Food $20.00 + Assets:Cash + ; MyTag: This is just a bogus value for MyTag +@end smallexample + +@node Typed metadata, , Metadata values, Metadata +@subsection Typed metadata + +If a metadata tag ends in ::, its value will be parsed as a value +expression and stored internally as a value rather than as a string. +For example, although I can specify a date textually like so: + +@smallexample @c input:validate +2012-03-10 * KFC + Expenses:Food $20.00 + Assets:Cash + ; AuxDate: 2012/02/30 +@end smallexample + +@noindent +This date is just a string, and won't be parsed as a date unless its +value is used in a date-context (at which time the string is parsed +into a date automatically every time it is needed as a date). If on +the other hand I write this: + +@smallexample +2012-03-10 * KFC + Expenses:Food $20.00 + Assets:Cash + ; AuxDate:: [2012/02/30] +@end smallexample + +@noindent +Then it is parsed as a date only once, and during parsing of the +journal file, which would let me know right away that it is an invalid +date. + @menu -* Payee metadata tag:: +* Payee metadata:: @end menu -@node Payee metadata tag, , Metadata tags, Metadata tags -@subsubsection Payee metadata tag -@cindex Payee metadata tag +@node Payee metadata, , Metadata payee, Metadata +@subsection Payee metadata +@cindex Payee metadata @findex register @findex payees @findex --by-payee @@ -3110,51 +3156,6 @@ date is not repeated), but they have different payees now. If using the @option{--strict} or @option{--pedantic} options, you must declare this tag to avoid warnings and errors. -@node Metadata values, Typed metadata, Metadata tags, Metadata -@subsection Metadata values - -To associate a value with a tag, use the syntax ``Key: Value'', where -the value can be any string of characters. Whitespace is needed after -the colon, and cannot appear in the Key: - -@smallexample @c input:validate -2012-03-10 * KFC - Expenses:Food $20.00 - Assets:Cash - ; MyTag: This is just a bogus value for MyTag -@end smallexample - -@node Typed metadata, , Metadata values, Metadata -@subsection Typed metadata - -If a metadata tag ends in ::, its value will be parsed as a value -expression and stored internally as a value rather than as a string. -For example, although I can specify a date textually like so: - -@smallexample @c input:validate -2012-03-10 * KFC - Expenses:Food $20.00 - Assets:Cash - ; AuxDate: 2012/02/30 -@end smallexample - -@noindent -This date is just a string, and won't be parsed as a date unless its -value is used in a date-context (at which time the string is parsed -into a date automatically every time it is needed as a date). If on -the other hand I write this: - -@smallexample -2012-03-10 * KFC - Expenses:Food $20.00 - Assets:Cash - ; AuxDate:: [2012/02/30] -@end smallexample - -@noindent -Then it is parsed as a date only once, and during parsing of the -journal file, which would let me know right away that it is an invalid -date. @node Virtual postings, Expression amounts, Metadata, Transactions @section Virtual postings |