sfos/ledger
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

added clarification about commenting characters

Browse source
This commit is contained in:
Craig Earls 2011-11-22 10:38:10 -07:00 • committed by John Wiegley
parent a08f00a248
commit c093eaac15
1 changed files with 49 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

60
doc/ledger3.texi
View file

@ -45,7 +45,7 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
@titlepage @titlepage
@title Ledger: Command-Line Accounting @title Ledger: Command-Line Accounting
@subtitle For Version 3.0 of Ledger @subtitle For Version 3.0 of Ledger
@subtitle Draft Manual Time-stamp: <2011-11-21 15:26 (cpearls)> @subtitle Draft Manual Time-stamp: <2011-11-22 09:00 (cpearls)>
@author John Wiegley @author John Wiegley
@end titlepage @end titlepage
@ -1467,6 +1467,7 @@ posting.
@menu @menu
* Most Basic Entry:: * Most Basic Entry::
* Commenting on your journal::
* Starting up:: * Starting up::
* Currency and Commodities:: * Currency and Commodities::
* Structuring Your Accounts:: * Structuring Your Accounts::
@ -1476,7 +1477,7 @@ posting.
* Using emacs:: * Using emacs::
@end menu @end menu
@node Most Basic Entry, Starting up, Keeping a Journal, Keeping a Journal @node Most Basic Entry, Commenting on your journal, Keeping a Journal, Keeping a Journal
@section The Most Basic Entry @section The Most Basic Entry
Here is the Pacific Bell example from above, given as a Ledger Here is the Pacific Bell example from above, given as a Ledger
@ -1521,12 +1522,20 @@ amount and the account. If you do not have adequate separation between
the amount and the account Ledger will give an error and stop the amount and the account Ledger will give an error and stop
calculating} calculating}
@menu @menu
* Checking Balances and Reconciliations:: * Comments::
* Effective Dates::
@end menu @end menu
@node Starting up, Currency and Commodities, Most Basic Entry, Keeping a Journal @node Commenting on your journal, Starting up, Most Basic Entry, Keeping a Journal
@section Commenting on your Journal
@cindex comment characters
Comments are generally started using a ';'. However, in order to
increase compatibility with other text manipulation programs and methods
three additional comment characters are valid if used at the beginning
of a line: @code{#}, @code{|}, and @code{*}.
@node Starting up, Currency and Commodities, Commenting on your journal, Keeping a Journal
@section Starting up @section Starting up
@cindex initial equity @cindex initial equity
@ -5143,18 +5152,46 @@ amount of the first posting is typically positive. Consider:
Assets:Checking Assets:Checking
@end smallexample @end smallexample
@emph{Note:} It is important to note that there must be at least two spaces between @menu
the end of the post and the beginning of the amount (including and * Comments and metadata::
commodity designator). * Specifying Amounts::
@end menu
@section Specifying amounts @node Comments and metadata, Specifying Amounts, Journal File Format, Journal File Format
@section Comments and metadata
@menu
* Comments::
* Metadata::
@end menu
@node Comments, Metadata, Comments and metadata, Comments and metadata
@subsection Comments
Comments are generally started using a ';'. However, in order to
increase compatibility with other text manipulation programs and methods
three additional comment characters are valid if used at the beginning
of a line: @code{#}, @code{|}, and @code{*}.
@node Metadata, , Comments, Comments and metadata
@subsection Metadat
@node Specifying Amounts, , Comments and metadata, Journal File Format
@section Specifying Amounts
@cindex amounts @cindex amounts
The heart of a journal is the amounts it records, and this fact is The heart of a journal is the amounts it records, and this fact is
reflected in the diversity of amount expressions allowed. All of them reflected in the diversity of amount expressions allowed. All of them
are covered here, though it must be said that sometimes, there are are covered here, though it must be said that sometimes, there are
multiple ways to achieve a desired result. multiple ways to achieve a desired result.
@subsection Integer amounts @emph{Note:} It is important to note that there must be at least two spaces between
the end of the post and the beginning of the amount (including and
commodity designator).
@menu
* Integer Amounts::
* Commoditized Amounts::
@end menu
@node Integer Amounts, Commoditized Amounts, Specifying Amounts, Specifying Amounts
@subsection Integer Amounts
In the simplest form, bare decimal numbers are accepted: In the simplest form, bare decimal numbers are accepted:
@ -5207,7 +5244,8 @@ called @dfn{full precision}, as opposed to commoditized amounts, which
always look to their commodity to know what precision they should always look to their commodity to know what precision they should
round to, and so use @dfn{commodity precision}. round to, and so use @dfn{commodity precision}.
@subsection Commoditized amounts @node Commoditized Amounts, , Integer Amounts, Specifying Amounts
@subsection Commoditized Amounts
A @dfn{commoditized amount} is an integer amount which has an A @dfn{commoditized amount} is an integer amount which has an
associated commodity. This commodity can appear before or after the associated commodity. This commodity can appear before or after the