Commit graph

590 commits

Author SHA1 Message Date
Craig Earls
a3ba670458 Merge pull request #264 from merriam/master
Added Glossary

Nice.  Would it be worth it to add this to the documentation?
2014-03-28 11:58:43 -07:00
Charles Merriam
1f05abb52a Added Glossary
Wrote a first pass at a glossary, adding only accounting terms to
start.
2014-03-28 11:21:39 -07:00
Craig Earls
c2f52c1d52 Merge pull request #262 from merriam/master
A pair of small documentation changes...
2014-03-27 18:22:50 -07:00
Charles Merriam
5e51b98f8b Remove doc/README
Remove obsolete and incorrect README file.  Correct information in
README.md, one directory up.
2014-03-27 17:50:15 -07:00
Charles Merriam
737d776b40 Update README to reference README.md
This older doc/README file is pure text and provides incomplete information compared to the root's README.md markdown file.  I copied over some introductory verbiage and added cross references to that file.
2014-03-26 22:36:17 -07:00
Jamie Nguyen
8088502eef Fix man page typo 2014-03-23 23:29:39 +00:00
Peter Feigl
4239c284f1 finished first proof-reading of ledger manual 2014-03-14 11:24:12 +01:00
Peter Feigl
fca30d93f1 proof-reading the manual 2014-03-14 09:58:40 +01:00
Peter Feigl
c445a0ffc4 fixing typos and smaller errors in the ledger manual 2014-03-10 13:31:02 +01:00
Peter Feigl
5d7a9b0504 Fixing typos in documentation 2014-03-05 14:49:00 +01:00
Peter Feigl
a7034b68a1 Merge commit '4966c7f' into update-docs 2014-03-04 15:02:11 +01:00
Peter Feigl
4966c7f100 Fixing typos, adding @c input:validate to code examples 2014-03-04 15:01:23 +01:00
Peter Feigl
3e29a992e5 removing two new test cases that fail on travis. cannot reproduce failure 2014-03-04 11:12:31 +01:00
Peter Feigl
831c064c38 Added support for validation tests to DocTest.py (input:validate and
command:validate)

It is now possible to use @smallexample @c input:validate (and
command:validate) to specify that an example should just be read by
ledger (and checked for errors) or that a ledger command should be
executed (with default input -f sample.dat, if none is specified).

These annotations have been added into ledger3.texi where appropriate.

Running the ledger3.texi test now takes a second or two, but a lot of
the @smallexamples are now automatically tested.
2014-03-04 10:05:09 +01:00
Craig Earls
08f0735e1c Merge pull request #251 from ecraven/update-docs
first changes in adding more testable examples to ledger3.texi

These look good.  Could you put a brief explanation somewhere (not necessarily in ledger3.texi) on how to generate new tests? I should probably know where the command and input id numbers come from, but I don't.
2014-03-03 14:53:47 -07:00
Peter Feigl
479cdf4fe2 first changes in adding more testable examples to ledger3.texi 2014-03-03 22:36:06 +01:00
Peter Feigl
977af3d27c Adding documentation of options to man-page from manual. Fixing a few minor typos and mistakes. 2014-02-27 10:24:38 +01:00
Peter Feigl
ecd5097d51 Adding option --no-aliases to completely disable alias expansion 2014-02-26 23:50:50 +01:00
Peter Feigl
75b0a5d8ff Adding option --recursive-aliases, adding documentation to man-page and manual 2014-02-26 09:29:31 +01:00
Peter Feigl
c80b495546 Adding support for recursive aliases.
Alias expansion is now a loop. If you define

alias A=B:A
alias B=C:B

then A will expand to C:B:A.

Also added a short section to the manual about this.
2014-02-25 22:50:20 +01:00
Luke Williams
dacb5f9823 Fixing typo: test sweet -> test suite 2014-02-23 00:02:22 +10:00
Alexis Hildebrandt
3d9faef448 DocTests: Allow inline input to be used with different example commands 2014-02-19 06:52:43 +01:00
Alexis Hildebrandt
90988feebc DocTests: Allow multiple example inputs
to be used as single ledger data for an example command
2014-02-19 06:52:43 +01:00
Matijs van Zuijlen
59fde5e777 Implicit logical and is really a logical or 2014-02-17 07:25:07 +01:00
Craig Earls
c59aadaace Merge pull request #241 from afh/pull/spelling
Correct minor spelling mistakes and improve spellcheck.sh

Awesome.
2014-02-09 11:32:44 -07:00
Alexis Hildebrandt
a2f86c85df Add explanation on how to validate documentation examples
by specially marking @smallexample, which will be used by DocTests.py
2014-02-09 07:54:27 +01:00
Alexis Hildebrandt
a1cc8ca15a Add support to check documentation examples with inline data 2014-02-07 18:39:35 +01:00
Alexis Hildebrandt
c73ba9d075 Correct spelling mistakes 2014-02-07 00:23:22 +01:00
Alexis Hildebrandt
fbbb379fe0 Check examples in documentation when running tests
The DocTests.py script will parse a given texinfo file for specially
marked examples, run the ledger command from the example, and check
the result against the example output from the documentation.
2014-02-07 00:21:38 +01:00
Alexis Hildebrandt
df9771f7a9 Bump copyright notice to 2014 in the documentation 2014-02-04 21:58:03 +01:00
Craig Earls
af84005a52 Backed out recent changes that broke the complete cycling behavior. 2014-01-07 13:25:07 -07:00
Steve Purcell
d7742cd654 Commodity column in default CSV format should match the displayed amount
If one uses --exchange to force CSV display amounts into a particular
currency, then the commodity output column should match that currency.

Without this patch, the commodity column contains the original
commodity, not the commodity for the exported amount.
2014-01-06 17:37:04 +00:00
4ourbit
316b1b7cfe Plugging ledger pcomplete into completion-at-point.
Added documentation on how to use pcomplete transparently via completion-at-point.
2014-01-01 22:00:26 +01:00
Rémi Vanicat
665279896d Correction of docs on Scheduling Transactions 2013-11-26 13:15:12 +01:00
Craig Earls
1db0b0892c Merge branch 'master' into ledger-mode-automatic-transactions 2013-11-06 08:48:54 -07:00
Johann Klähn
de5cc27914 install texinfo files 2013-10-23 22:14:25 +02:00
Craig Earls
52228e7cc1 Merge branch 'master' into ledger-mode-automatic-transactions 2013-10-02 07:43:54 -07:00
Alan Berndt
b23616abc0 Fix reference to old pattern negation syntax 2013-09-24 12:54:32 -07:00
John Wiegley
36ea8a4fba Merge pull request #211 from mneilsen/master
Update ledger-mode's "Quick Installation" docs
2013-09-23 03:50:52 -07:00
Simon Michael
2b0aa798f1 delete obsolete ledger.texi. Down with cruft! 2013-09-21 12:02:47 -07:00
Mike Neilsen
5bd97a9dbd Update ledger-mode's "Quick Installation" docs
* Change quote character to '
* Fix indentation
* Load "ledger-mode" rather than "ldg-new"
2013-09-21 09:54:49 -05:00
Craig Earls
bee6605e08 Merge branch 'master' into ledger-mode-automatic-transactions 2013-09-20 07:26:44 -07:00
Wes Cravens
2bf852be94 Remove reference to depricated ! operator in Chapt 4 2013-09-08 04:16:47 -05:00
Craig Earls
9a142ca656 Corrected discrepancies between documentation and drewr3.dat regarding apply and bucket 2013-09-07 10:17:46 -07:00
Craig Earls
1356a1f2c0 Schedule documentation update 2013-07-02 14:25:58 -07:00
Rémi Vanicat
affb373c0a @itemx shoud be after an @item 2013-06-26 16:17:54 +02:00
thdox
cc3353d5b8 Copy information from doc/NEWS to doc/ledger3.texi.
Correct the documentation about '-s' that has no effect on bal command.
2013-06-03 22:38:07 +02:00
thdox
d56f9c4032 Improve documentation about differences between ledger 2.6 and ledger 3.0.
GnuCash support removed, environment variables deprecated.
2013-06-01 18:01:19 +02:00
thdox
079ed363dd Fix bug #855 2013-06-01 14:01:06 +02:00
thdox
9098ae76c9 Add "ledger convert file.csv" and "hledger -f file.csv print".
Add url for "csv2ledger" tools
2013-05-20 23:23:44 +02:00