From ccf10e20604a9fc074c1f7f1f98905be59a0e0b4 Mon Sep 17 00:00:00 2001 From: "Bradley M. Kuhn" Date: Fri, 14 Sep 2012 16:35:46 -0400 Subject: Created Fixated prices node. There was a Fixated prices section, but no Fixated prices node. This of course required an update of nodes and menus throughout chapter. --- doc/ledger3.texi | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) (limited to 'doc/ledger3.texi') diff --git a/doc/ledger3.texi b/doc/ledger3.texi index 16bf0564..6dc1787d 100644 --- a/doc/ledger3.texi +++ b/doc/ledger3.texi @@ -2486,6 +2486,7 @@ kill the report buffer * Virtual posting costs:: * Commodity prices:: * Prices vs. costs:: +* Fixated prices:: * Lot dates:: * Lot notes:: * Lot value expressions:: @@ -3131,7 +3132,7 @@ Plus, it comes with dangers. This works fine: And in cases where the amounts do not divide into whole figure and must be rounded, the capital gains figure could be off by a cent. Use with caution. -@node Prices vs. costs, Lot dates, Commodity prices, Transactions +@node Prices vs. costs, Fixated prices, Commodity prices, Transactions @section Prices vs. costs Because lot pricing provides enough information to infer the cost, the @@ -3151,6 +3152,7 @@ However, note that what you see in some reports may differ, for example in the print report. Functionally, however, there is no difference, and neither the register nor the balance report are sensitive to this difference. +@node Fixated prices, Lot dates, Prices vs. costs, Transactions @section Fixated prices If you buy a stock last year, and ask for its value today, Ledger will consult @@ -3174,7 +3176,7 @@ below) to fix the value of a commodity lot. * Fixated costs:: @end menu -@node Fixated costs, , Prices vs. costs, Prices vs. costs +@node Fixated costs, , Fixated prices, Fixated prices @subsection Fixated costs Since price annotations are costs are largely interchangeable and a matter of @@ -3190,7 +3192,7 @@ of the cost: This is the same as the previous transaction, with the same caveats found in the section ``Prices vs. costs''. -@node Lot dates, Lot notes, Prices vs. costs, Transactions +@node Lot dates, Lot notes, Fixated prices, Transactions @section Lot dates In addition to lot prices, you can specify lot dates and reveal them with -- cgit v1.2.3 From 438806ac71a9a56645d824d2dbebb2bd565155ce Mon Sep 17 00:00:00 2001 From: "Bradley M. Kuhn" Date: Fri, 14 Sep 2012 16:39:41 -0400 Subject: Documentation for the fixed directive. Based on conversation with johnw on IRC, I believe this text properly documents the intended feature of the fixed directive. --- doc/ledger3.texi | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) (limited to 'doc/ledger3.texi') diff --git a/doc/ledger3.texi b/doc/ledger3.texi index 6dc1787d..d4c89951 100644 --- a/doc/ledger3.texi +++ b/doc/ledger3.texi @@ -2047,6 +2047,37 @@ Closes block commands like @code{tag} or @code{comment}. @item fixed @c instance_t::fixed_directive in textual.cc +A fixed block is used to set fixated prices (@pxref{Fixated prices}) for a series of +transactions. It's purely a typing saver, for use when entering many +transactions with fixated prices. + +Thus, the following: +@smallexample +fixed CAD $0.90 + 2012-04-10 Lunch in Canada + Assets:Wallet -15.50 CAD + Expenses:Food 15.50 CAD + + 2012-04-11 Second day Dinner in Canada + Assets:Wallet -25.75 CAD + Expenses:Food 25.75 CAD +endfixed +@end smallexample +is equivalent to this: +@smallexample + 2012-04-10 Lunch in Canada + Assets:Wallet -15.50 CAD @{=$0.90@} + Expenses:Food 15.50 CAD @{=$0.90@} + + 2012-04-11 Second day Dinner in Canada + Assets:Wallet -25.75 CAD @{=$0.90@} + Expenses:Food 25.75 CAD @{=$0.90@} +@end smallexample + +Note that ending a @samp{fixed} is done differently than other +directives, as @samp{fixed} is closed with an @samp{endfixed} (i.e., +there is @strong{no space} between @samp{end} and @samp{fixed}). + @item include @c instance_t::include_directive in textual.cc Include the stated file as if it were part of the current file. -- cgit v1.2.3 From 06356ebf90bb051b2cfef09dbed646fd4c31a759 Mon Sep 17 00:00:00 2001 From: "Bradley M. Kuhn" Date: Fri, 14 Sep 2012 16:54:12 -0400 Subject: Make reference and link to Bug Report #789 in fixed directive documentation. Due to weirdness that's currently true with the existing next branch of ledger, I believe it's important to tell users in the documentation that there are some discrepancies in the 'fixed' directive behavior. The documentation from my previous commit is written to explain what 'fixed' *should* do; adding the bug report link here is a placeholder to tell users that it may not do what they think it does. Obviously, if someone closes #789, they should remove this paragraph added herein. But, if the bug report is closed, but the documentation lags behind, the worst that happens is some users have to click through to see the bug is closed. --- doc/ledger3.texi | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'doc/ledger3.texi') diff --git a/doc/ledger3.texi b/doc/ledger3.texi index d4c89951..9a91d79e 100644 --- a/doc/ledger3.texi +++ b/doc/ledger3.texi @@ -2078,6 +2078,10 @@ Note that ending a @samp{fixed} is done differently than other directives, as @samp{fixed} is closed with an @samp{endfixed} (i.e., there is @strong{no space} between @samp{end} and @samp{fixed}). +For the moment, users may wish to study +@uref{http://bugs.ledger-cli.org/show_bug.cgi?id=789, Bug Report 789} +before using the @samp{fixed} directive in production. + @item include @c instance_t::include_directive in textual.cc Include the stated file as if it were part of the current file. -- cgit v1.2.3