simonmichael/hledger
1
1
Fork 0
mirror of https://github.com/simonmichael/hledger.git synced 2024-11-08 07:09:28 +03:00
Code Issues Projects Releases Wiki Activity

convert some characters from ledger manual to ascii for haddock

Browse Source
This commit is contained in:
Simon Michael 2008-10-01 00:40:51 +00:00
parent efcbd29dc8
commit 0ba4c8d0f7
1 changed files with 16 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
Parse.hs
View File

@ -3,7 +3,7 @@ standard ledger file parser
Here's the ledger grammar from the ledger 2.5 manual: Here's the ledger grammar from the ledger 2.5 manual:
The ledger file format is quite simple, but also very flexible. It supports The ledger file format is quite simple, but also very flexible. It supports
many options, though typically the user can ignore most of them. They are many options, though typically the user can ignore most of them. They are
summarized below. The initial character of each line determines what the summarized below. The initial character of each line determines what the
line means, and how it should be interpreted. Allowable initial characters line means, and how it should be interpreted. Allowable initial characters
@ -11,7 +11,7 @@ are:
NUMBER A line beginning with a number denotes an entry. It may be followed by any NUMBER A line beginning with a number denotes an entry. It may be followed by any
number of lines, each beginning with whitespace, to denote the entry’s account number of lines, each beginning with whitespace, to denote the entry’s account
transactions. The format of the first line is: transactions. The format of the first line is:
DATE[=EDATE] [*|!] [(CODE)] DESC DATE[=EDATE] [*|!] [(CODE)] DESC
@ -36,7 +36,7 @@ NUMBER A line beginning with a number denotes an entry. It may be followed
= An automated entry. A value expression must appear after the equal sign. = An automated entry. A value expression must appear after the equal sign.
After this initial line there should be a set of one or more transactions, just as After this initial line there should be a set of one or more transactions, just as
if it were normal entry. If the amounts of the transactions have no commodity, if it were normal entry. If the amounts of the transactions have no commodity,
they will be applied as modifiers to whichever real transaction is matched by they will be applied as modifiers to whichever real transaction is matched by
the value expression. the value expression.
~ A period entry. A period expression must appear after the tilde. ~ A period entry. A period expression must appear after the tilde.
@ -48,7 +48,7 @@ NUMBER A line beginning with a number denotes an entry. It may be followed
are: are:
‘!include’ ‘!include’
Include the stated ledger file. Include the stated ledger file.
‘!account’ ‘!account’
The account name is given is taken to be the parent of all transac- The account name is given is taken to be the parent of all transac-
tions that follow, until ‘!end’ is seen. tions that follow, until ‘!end’ is seen.
@ -58,44 +58,44 @@ NUMBER A line beginning with a number denotes an entry. It may be followed
Y If a line begins with a capital Y, it denotes the year used for all subsequent Y If a line begins with a capital Y, it denotes the year used for all subsequent
entries that give a date without a year. The year should appear immediately entries that give a date without a year. The year should appear immediately
after the Y, for example: ‘Y2004’. This is useful at the beginning of a file, to after the Y, for example: ‘Y2004’. This is useful at the beginning of a file, to
specify the year for that file. If all entries specify a year, however, this command specify the year for that file. If all entries specify a year, however, this command
has no effect. has no effect.
P Specifies a historical price for a commodity. These are usually found in a pricing P Specifies a historical price for a commodity. These are usually found in a pricing
history file (see the ‘-Q’ option). The syntax is: history file (see the ‘-Q’ option). The syntax is:
P DATE SYMBOL PRICE P DATE SYMBOL PRICE
N SYMBOL Indicates that pricing information is to be ignored for a given symbol, nor will N SYMBOL Indicates that pricing information is to be ignored for a given symbol, nor will
quotes ever be downloaded for that symbol. Useful with a home currency, such quotes ever be downloaded for that symbol. Useful with a home currency, such
as the dollar ($). It is recommended that these pricing options be set in the price as the dollar ($). It is recommended that these pricing options be set in the price
database file, which defaults to ‘~/.pricedb’. The syntax for this command is: database file, which defaults to ‘~/.pricedb’. The syntax for this command is:
N SYMBOL N SYMBOL
D AMOUNT Specifies the default commodity to use, by specifying an amount in the expected D AMOUNT Specifies the default commodity to use, by specifying an amount in the expected
format. The entry command will use this commodity as the default when none format. The entry command will use this commodity as the default when none
other can be determined. This command may be used multiple times, to set other can be determined. This command may be used multiple times, to set
the default flags for different commodities; whichever is seen last is used as the the default flags for different commodities; whichever is seen last is used as the
default commodity. For example, to set US dollars as the default commodity, default commodity. For example, to set US dollars as the default commodity,
while also setting the thousands flag and decimal flag for that commodity, use: while also setting the thousands flag and decimal flag for that commodity, use:
D $1,000.00 D $1,000.00
C AMOUNT1 = AMOUNT2 C AMOUNT1 = AMOUNT2
Specifies a commodity conversion, where the first amount is given to be equiv- Specifies a commodity conversion, where the first amount is given to be equiv-
alent to the second amount. The first amount should use the decimal precision alent to the second amount. The first amount should use the decimal precision
desired during reporting: desired during reporting:
C 1.00 Kb = 1024 bytes C 1.00 Kb = 1024 bytes
i, o, b, h i, o, b, h
These four relate to timeclock support, which permits ledger to read timelog These four relate to timeclock support, which permits ledger to read timelog
files. See the timeclock’s documentation for more info on the syntax of its files. See the timeclock’s documentation for more info on the syntax of its
timelog files. timelog files.
parsec example: http://pandoc.googlecode.com/svn/trunk/src/Text/Pandoc/Readers/RST.hs parsec example: http://pandoc.googlecode.com/svn/trunk/src/Text/Pandoc/Readers/RST.hs