Merge branch 'docs'

Misc. updates.
2014-12-02 11:58:02 -08:00 · 2014-12-02 11:58:02 -08:00 · 0c8b9dc0b9
commit 0c8b9dc0b9
parent 1708f0b441 d5b329a8ad
6 changed files with 53 additions and 65 deletions
--- a/18
+++ b/18
@ -668,10 +668,10 @@ cleandocs: site-clean

 # build some additional static bits of the hledger.org website
 # Requires hakyll-std, a generic hakyll site builder
-site-build site: olddocs
+site-build site: #olddocs
 	-cd doc/site; hakyll build

-site-clean: cleanolddocs
+site-clean: #cleanolddocs
 	-cd doc/site; hakyll clean
 #	rm -rf doc/site/_site/*

@ -686,19 +686,19 @@ site-view: site

 # ensure some old doc versions are in place:

-olddocs: doc/0.22 doc/0.21
+#olddocs: doc/0.22 doc/0.21

 #doc/0.23:
 #	(cd doc; git archive --prefix doc/0.23/ tags/0.23 'doc/MANUAL.md') | tar xf -

-doc/0.22:
-	git archive --prefix doc/0.22/ tags/0.22 'MANUAL.md' | tar xf -
+# doc/0.22:
+# 	git archive --prefix doc/0.22/ tags/0.22 'MANUAL.md' | tar xf -

-doc/0.21:
-	git archive --prefix doc/0.21/ tags/0.21.3 'MANUAL.md' | tar xf -
+# doc/0.21:
+# 	git archive --prefix doc/0.21/ tags/0.21.3 'MANUAL.md' | tar xf -

-cleanolddocs:
-	cd doc; rm -rf 0.22 0.21
+# cleanolddocs:
+# 	cd doc; rm -rf 0.22 0.21


 pdf: codepdf #docspdf
--- a/doc/developer-guide.md
+++ b/doc/developer-guide.md
@ -19,13 +19,13 @@ tr {
 | Twitter                 | [#ledgercli](https://twitter.com/search?q=%23ledgercli&src=typd&f=realtime), <a href="https://twitter.com/ledgertips">@LedgerTips</a> |
 | hledger-web demo&nbsp;&nbsp;        | [demo.hledger.org](http://demo.hledger.org) |
 | Trello                  | [planning board](http://hledger.org/trello) |
-| Github                  | [code.hledger.org](http://github.com/simonmichael/hledger) <br> [commits](http://github.com/simonmichael/hledger/commits), [COMMITS](http://starlogs.net/#simonmichael/hledger) (turn up your volume), [unreleased commits](https://github.com/simonmichael/hledger/compare/0.23...master), [release branch commits](https://github.com/simonmichael/hledger/compare/master...0.23) <br> [build status (hydra)](http://hydra.cryp.to/jobset/hledger/master#tabs-jobs) <br> [open bugs](https://github.com/simonmichael/hledger/issues?direction=desc&labels=BUG&page=1&sort=created&state=open), [all bugs](https://github.com/simonmichael/hledger/issues?direction=desc&labels=BUG&page=1&sort=created), [open issues](https://github.com/simonmichael/hledger/issues?direction=desc&labels=&page=1&sort=created&state=open), [all issues](https://github.com/simonmichael/hledger/issues?direction=desc&labels=&page=1&sort=created) |
+| Github                  | [code.hledger.org](http://github.com/simonmichael/hledger) <br> [commits](http://github.com/simonmichael/hledger/commits), [COMMITS](http://starlogs.net/#simonmichael/hledger) (turn up your volume), [unreleased commits](https://github.com/simonmichael/hledger/compare/0.23...master), [release branch commits](https://github.com/simonmichael/hledger/compare/master...0.23) <br> [build status (hydra)](http://hydra.cryp.to/jobset/hledger/master#tabs-jobs) <br> [open bugs](https://github.com/simonmichael/hledger/issues?direction=desc&labels=BUG&page=1&sort=created&state=open), [all bugs](https://github.com/simonmichael/hledger/issues?direction=desc&labels=BUG&page=1&sort=created), [open issues](https://github.com/simonmichael/hledger/issues?direction=desc&labels=&page=1&sort=created&state=open), [all issues](https://github.com/simonmichael/hledger/issues?direction=desc&labels=&page=1&sort=created), <a href="https://github.com/simonmichael/hledger/issues?q=label%3Abounty+">issues with bounties</a>, <a href="https://www.bountysource.com/trackers/536505-simonmichael-hledger">issue bounties @ bountysource.com</a> |
 | Hackage                 | [hledger-lib](http://hackage.haskell.org/package/hledger-lib), [hledger](http://hackage.haskell.org/package/hledger), [hledger-web](http://hackage.haskell.org/package/hledger-web), [hledger-interest](http://hackage.haskell.org/package/hledger-interest), [hledger-irr](http://hackage.haskell.org/package/hledger-irr), [hledger-vty](http://hackage.haskell.org/package/hledger-vty), [hledger-chart](http://hackage.haskell.org/package/hledger-chart), [\*hledger\*](http://hackage.haskell.org/packages/search?terms=hledger) <br> reverse dependencies: [hledger-lib](http://packdeps.haskellers.com/reverse/hledger-lib), [hledger](http://packdeps.haskellers.com/reverse/hledger), [outdated dependencies](http://packdeps.haskellers.com/feed/?needle=hledger) <br> [download stats](http://best-haskell.herokuapp.com/#/category/Finance) |
 | Stackage                | [hledger entry](https://github.com/fpco/stackage/blob/master/Stackage/Config.hs#L449-450), [issues](https://github.com/fpco/stackage/search?q=hledger&ref=cmdform&type=Issues) <br> [build status (jenkins)](http://jenkins.stackage.org/job/Stackage/), last build output: [7.4](http://jenkins.stackage.org/job/Stackage/ghcversion=7.4.2/lastBuild/console), [7.6](http://jenkins.stackage.org/job/Stackage/ghcversion=7.6.3/lastBuild/console), [7.8](http://jenkins.stackage.org/job/Stackage/ghcversion=7.8.2/lastBuild/console) |
 | Debian                  | source packages <br> [haskell-hledger-lib](http://packages.qa.debian.org/h/haskell-hledger-lib.html), [bugs](https://bugs.debian.org/cgi-bin/pkgreport.cgi?package=haskell-hledger-lib), [haskell-hledger](http://packages.qa.debian.org/h/haskell-hledger.html), [bugs](https://bugs.debian.org/cgi-bin/pkgreport.cgi?package=haskell-hledger), [haskell-hledger-web](http://packages.qa.debian.org/h/haskell-hledger-web.html), [bugs](https://bugs.debian.org/cgi-bin/pkgreport.cgi?package=haskell-hledger-web) <br> binary packages <br> testing: [hledger](https://packages.debian.org/testing/hledger), [bugs](https://bugs.debian.org/cgi-bin/pkgreport.cgi?package=hledger;dist=testing), [hledger-web](https://packages.debian.org/testing/hledger-web), [bugs](https://bugs.debian.org/cgi-bin/pkgreport.cgi?package=hledger-web;dist=testing) <br> unstable: [hledger](https://packages.debian.org/unstable/hledger), [bugs](https://bugs.debian.org/cgi-bin/pkgreport.cgi?package=hledger;dist=unstable), [hledger-web](https://packages.debian.org/unstable/hledger-web), [bugs](https://bugs.debian.org/cgi-bin/pkgreport.cgi?package=hledger-web;dist=unstable) <br> all: [\*hledger\*](https://packages.debian.org/search?searchon=names&keywords=hledger) <br> popularity stats: [hledger](https://qa.debian.org/popcon.php?package=haskell-hledger), [hledger-web](https://qa.debian.org/popcon.php?package=haskell-hledger-web) <br> [PTS help](https://www.debian.org/doc/manuals/developers-reference/resources.html#pkg-tracking-system) |
 | Ubuntu                  | source packages <br> [haskell-hledger-lib](https://launchpad.net/ubuntu/+source/haskell-hledger-lib), [bugs](https://bugs.launchpad.net/ubuntu/+source/haskell-hledger-lib), [haskell-hledger](https://launchpad.net/ubuntu/+source/haskell-hledger), [bugs](https://bugs.launchpad.net/ubuntu/+source/haskell-hledger), [haskell-hledger-web](https://launchpad.net/ubuntu/+source/haskell-hledger-web), [bugs](https://bugs.launchpad.net/ubuntu/+source/haskell-hledger-web) <br> binary packages <br> [\*hledger\*](http://packages.ubuntu.com/search?suite=all&searchon=names&keywords=hledger) |
 | Gentoo                  | [hledger](http://gpo.zugaina.org/dev-haskell/hledger), [hledger-web](http://gpo.zugaina.org/dev-haskell/hledger-web), [\*hledger\*](http://gpo.zugaina.org/Search?search=hledger) |
-| Fedora                  | [hledger](https://apps.fedoraproject.org/packages/hledger), [\*hledger\*](https://apps.fedoraproject.org/packages/s/hledger) |
+| Fedora                  | [hledger](https://apps.fedoraproject.org/packages/hledger), [\*hledger\*](https://apps.fedoraproject.org/packages/s/hledger), [Haskell SIG](http://fedoraproject.org/wiki/Haskell_SIG) |

 <!-- list the debian packages for clarity:
 3 source:
--- a/doc/manual.md
+++ b/doc/manual.md
@ -313,7 +313,7 @@ account does not contain some unexpected commodity. (We'll add support
 for this kind of total balance assertion if there's demand.)


-#### Prices
+##### Prices

 <!-- ##### Transaction prices -->

@ -349,26 +349,29 @@ examples we get:
        assets:foreign currency       $135.00
        assets:cash                  $-135.00

-##### Fixed Lot Prices
+###### Prices are fixed

-ledger has another syntax for
-[fixed lot prices](http://ledger-cli.org/3.0/doc/ledger3.html#Fixing-Lot-Prices).
-(`{=PRICE}`). In ledger, this is equivalent to `@ PRICE`, except you
-can provide both and then ledger generates an automatic Capital Losses
-posting covering the difference.
+In hledger, the price used in a given posting is fixed.
+This is what you want for eg recording purchases made while travelling abroad,
+but you can't (yet) track the value of stocks whose price fluctuates.

-hledger will parse this syntax, but ignore it.
+This is different from Ledger, where prices fluctuate by default.
+Ledger has a different syntax for specifying
+[fixed prices](http://ledger-cli.org/3.0/doc/ledger3.html#Fixing-Lot-Prices): `{=PRICE}`.
+hledger parses that syntax, and (currently) ignores it.
+<!-- hledger treats this as an alternate spelling of `@ PRICE`, for greater compatibility with Ledger files. -->

-##### Historical prices
+###### Historical prices

-hledger will parse and ignore ledger-style historical price directives:
+hledger also parses, and currently ignores, ledger-style historical price directives:
 <!-- (A time and numeric time zone are allowed but ignored, like ledger.) -->
-
-        ; Historical price directives look like: P DATE COMMODITYSYMBOL UNITPRICE
-        ; These say the euro's exchange rate is $1.35 during 2009 and
-        ; $1.40 from 2010/1/1 on.
-        P 2009/1/1 € $1.35
-        P 2010/1/1 € $1.40
+```
+; Historical price directives look like: P DATE COMMODITYSYMBOL UNITPRICE
+; These say the euro's exchange rate is $1.35 during 2009 and
+; $1.40 from 2010/1/1 on.
+P 2009/1/1 € $1.35
+P 2010/1/1 € $1.40
+```

 #### Comments

@ -556,7 +559,7 @@ skip 1
 **`date-format` *DATEFMT***\
 When your CSV date fields are not formatted like `YYYY/MM/DD` (or `YYYY-MM-DD` or `YYYY.MM.DD`),
 you'll need to specify the format.
-DATEFMT is a [strptime-style date parsing pattern](http://hackage.haskell.org/packages/archive/time/latest/doc/html/Data-Time-Format.html#v:formatTime),
+DATEFMT is a [strptime-like date parsing pattern](http://hackage.haskell.org/packages/archive/time/latest/doc/html/Data-Time-Format.html#v:formatTime),
 which must parse the date field values completely. Examples:
 ```
 # parses "6/11/2013":
@ -636,7 +639,8 @@ banking thru software
 ```

 **`include` *RULESFILE***\
-Include another rules file at this point. Eg:
+Include another rules file at this point. `RULESFILE` is either an absolute file path or
+a path relative to the current file's directory. Eg:
 ```
 # rules reused with several CSV files
 include common.rules
@ -654,6 +658,10 @@ If the CSV has the currency in a separate field, assign that to the `currency` p

 If an amount value is parenthesised, it will be de-parenthesised and sign-flipped automatically.

+The generated journal entries will be sorted by date (after reversing
+them if the first's date is later than the last's, to preserve the
+order of same-day entries).
+
 ### Timelog

 hledger can also read time log files. These are (a subset of) timeclock.el's
@ -937,37 +945,7 @@ Additional convenience features:

 - Input prompts are displayed in a different colour when the terminal supports it.

-Here's [an example](step-by-step#record-a-transaction-with-hledger-add).
-<!--
-    $ hledger add
-    (...)
-    Starting a new transaction.
-    date ? [2013/04/09]: 
-    description ? : starbucks
-
-    Using this existing transaction for defaults:
-    2012/04/19 * starbucks
-        expenses:personal:food:snacks         $3.70
-        assets:cash:wallet                   $-3.70
-
-    account 1 ? [expenses:personal:food:snacks]: 
-    amount  1 ? [$3.7]: 
-    account 2 ? [assets:cash:wallet]: 
-    amount  2 ? [$-3.7]: 
-    account 3 (or . to complete this transaction) ? : .
-
-    Transaction entered:
-    2013/04/09 starbucks
-        expenses:personal:food:snacks          $7.7
-        assets:cash:wallet                    $-7.7
-
-    Accept this transaction ? [y]: 
-    Added to the journal.
-
-    Starting a new transaction.
-    date ? [2013/04/09]: <CTRL-D>
-    $
-->
+Here's [an example](step-by-step.html#record-a-transaction-with-hledger-add).

 ### Reports

--- a/doc/site/download.md
+++ b/doc/site/download.md
@ -54,9 +54,11 @@ Use cabal
 <tr>
 <td colspan="2" style="padding-left:1em;padding-right:2em;">

- <div style="margin-left:1em; float:right;">
- **[Gittip](https://www.gittip.com/simonmichael/)**,
- <a href="https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=5J33NLXYXCYAY"><img border=0 src="https://www.paypal.com/en_US/i/btn/x-click-but04.gif" alt="paypal"></a>
+ <div style="margin-left:1em; margin-right:1em; float:right;">
+<a href="https://flattr.com/submit/auto?user_id=simonmichael&url=http%3A%2F%2Fhledger.org" target="_blank"><img src="//api.flattr.com/button/flattr-badge-large.png" alt="Flattr this" title="Flattr this" border="0"></a> <br>
+<a href="https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=5J33NLXYXCYAY"><img border=0 src="https://www.paypal.com/en_US/i/btn/x-click-but04.gif" alt="paypal"></a> <br>
+**[Gittip](https://www.gittip.com/simonmichael/)** <br>
+<script data-gratipay-username="simonmichael" data-gratipay-widget="button" src="//grtp.co/v1.js"></script> <br>
 </div>
 Building and supporting Windows and Mac binaries is costly, so
 it's demand-driven - you can indicate demand by making a project
--- a/doc/site/index.md
+++ b/doc/site/index.md
@ -119,7 +119,10 @@ or the **[mail list](http://hledger.org/list)**.
 <div style="margin-top:2em; text-align:right; float:right;">
 <!-- Has hledger saved you or your employer money, time or peace of mind ? -->
 <!-- Donations: -->
-**[Gittip](https://www.gittip.com/simonmichael/)**,
-<a href="https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=5J33NLXYXCYAY"><img border=0 src="https://www.paypal.com/en_US/i/btn/x-click-but04.gif" alt="paypal"></a>
+<script data-gratipay-username="simonmichael" data-gratipay-widget="button" src="//grtp.co/v1.js"></script> &nbsp;
+<a href="https://www.bountysource.com/trackers/536505-simonmichael-hledger"><img border=0 src="https://www.bountysource.com/badge/tracker?tracker_id=536505" alt="bountysource"></a> &nbsp;
+<a href="https://flattr.com/submit/auto?user_id=simonmichael&url=http%3A%2F%2Fhledger.org" target="_blank"><img src="//api.flattr.com/button/flattr-badge-large.png" alt="Flattr this" title="Flattr this" border="0"></a> &nbsp;
+**[Gittip](https://www.gittip.com/simonmichael/)** &nbsp;
+<a href="https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=5J33NLXYXCYAY"><img border=0 src="https://www.paypal.com/en_US/i/btn/x-click-but04.gif" alt="paypal"></a> &nbsp;
 <!-- Also testimonials, examples, blogging, packaging, and patches. -->
 </div>
--- a/hledger/CHANGES
+++ b/hledger/CHANGES
@ -1,3 +1,8 @@
+0.24 (unreleased)
+
+- register: faster with large output
+- register: postings with multi-commodity amounts are now top-aligned, like Ledger
+
 0.23.3 (2014/9/12)

 - allow text 1.2+ (fixes #207)