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
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
Alan Berndt
b23616abc0
Fix reference to old pattern negation syntax
2013-09-24 12:54:32 -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
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
thdox
8f127291e5
Add documentation for Payee metadata tag
2013-05-20 23:23:44 +02:00
thdox
11befb67aa
Mainly moving @code to @samp when relevant (when valued example)
2013-05-20 23:23:44 +02:00
thdox
43fed282a0
The programs (like ledger, gnuplot, report, head, getquote) have been
...
surrounded by @file{}.
2013-05-20 23:23:44 +02:00
thdox
9c2820214b
Rename section "Reporting Commands" to "Basic Reporting Commands" as chapter "Reporting Commands" already exists.
...
Rename to "Report filtering", "Output customization", "Commodity reporting". Second word is lowercase as exact same subsection exists with uppercase. Not a proper fix, but the quickest I found.
Rename from "Example Journal File: drewr.dat" to "Example Journal File" as makeinfo does not like ':' in titles.
Fix some old naming of cross references.
2013-05-20 23:23:44 +02:00
thdox
71e98ef622
Texinfo: Update every node with C-c C-u C-e
2013-05-20 23:23:44 +02:00
thdox
26ff6539cf
Rename @code{--option} to @option{--option}
...
Rename @code{-Q} to @option{--download (-Q)}. The reasoning is that the reader of the manual is a newcomer, and as a newcomer --download is more self-explicit compared to a cryptic single letter. But information is kept for advanced user who can still exercise their mastery with cryptic things.
Fix short option -Z (and not -L) for --price-exp
Fix "@section Balance format" (as @option in title is causing issues with makeinfo).
Fix consistency of @option{--option @var{VAR}} by adding systematically @var{VAR}.
Add period at end of sentences.
2013-05-20 23:23:44 +02:00
thdox
52428eedd4
Add some @cindex for commands. Fix @command{transaction} to @command{xact}.
2013-05-20 23:23:44 +02:00
thdox
ff90cb38db
Move Ledger CLI command to @command. Also, fix commas in section title (makeinfo does not like that).
2013-05-20 23:23:44 +02:00
thdox
78538acc48
Fix warning from makeinfo compilation.
2013-05-20 23:23:44 +02:00
thdox
a206a9c797
Move @code to @samp when relevant for section Date and Time Format Codes
2013-05-20 23:23:44 +02:00
thdox
1fbdddb9dc
Minor modifications, to fix bad display in TeX output
2013-05-20 23:23:43 +02:00
thdox
9c5bc8f92d
Review of Babel section. Move to Babel name according to new naming.
2013-05-20 23:23:43 +02:00
thdox
bd4c264f49
Add some "@c TODO" things to do later
2013-05-20 23:23:43 +02:00
thdox
2b669a791e
add missing @smallexample
2013-05-20 23:23:43 +02:00
thdox
1e1275d25b
Insert some spacing
2013-05-20 23:23:43 +02:00
thdox
3e95bdd43f
Some minor reformatting
2013-05-20 23:23:43 +02:00
thdox
e19693e7e9
M-x delete-trailing-whitespace
2013-05-01 18:58:18 +02:00
thdox
0509bb136a
Add @var{FORMAT_STRING} where missing
2013-05-01 16:29:00 +02:00
thdox
8171165a6c
For consistency, do not put on same @item two options that are
...
different (even if very close in purpose).
2013-05-01 16:28:11 +02:00
thdox
ae69ae5c64
Consistency on regex spelling
2013-05-01 15:25:32 +02:00
thdox
0c011b94e5
Fix "copying" section to use best practises like in LaTeX, GDB or Texinfo manuals
2013-05-01 12:03:06 +02:00
thdox
b2e63df0e6
Add description for /dev/stdin as input file
2013-04-30 00:38:08 +02:00
thdox
f5ece775af
Add description for --unrealized-gains and --unrealized-losses
2013-04-30 00:37:34 +02:00
thdox
1668c74036
Add description for --time-colon
2013-04-30 00:13:16 +02:00
thdox
1cca1c1ef0
Moved to "FIX THIS ENTRY" for consistency
2013-04-29 22:25:35 +02:00
thdox
600a9c5d3b
Change from -report to -format as -report can not be found in source code
2013-04-29 22:25:35 +02:00
thdox
68dde8cda6
Some cleanup on pre-commands
2013-04-29 22:25:34 +02:00
thdox
6ca9c4ef56
Check that options in global.cc::lookup_option,
...
report.cc::lookup_option, session.cc::lookup_option, are listed in
documentation.
Add consistency about the @var{} variables passed to --options.
M-x texinfo-all-menus-update
2013-04-29 22:25:16 +02:00
thdox
1438ab783c
Add documentation about pre-commands
2013-04-29 22:23:41 +02:00
thdox
04973bd109
Use @samp{} for single characters
2013-04-29 22:23:14 +02:00
thdox
b7437fe609
no space before and after '---'
2013-04-28 14:44:58 +02:00
thdox
d1156f7a32
Use @samp for single characters as recommended in Texinfo manual (i.e.
...
use @samp{$} instead of '$')
2013-04-28 14:28:09 +02:00