Commit graph

595 commits

Author SHA1 Message Date
Alexis Hildebrandt
b1d73eaa84 Merge pull request #392 from thdox/doc-validation
Changes mainly about validation of @smallexample
2015-02-20 14:34:40 +01:00
Alexis Hildebrandt
c1e409e693 [doc] Add support for additional input files
in test/DocTests.py by allowing file: and with_file: options on examples.
2015-02-20 14:07:57 +01:00
thdox
e197a4137a Add validation for @smallexample.
[ci skip]
2015-02-19 23:59:46 +01:00
thdox
80eaac43bf Improve documentation about Asset Allocation.
[ci skip]
2015-02-19 23:59:35 +01:00
thdox
fd22653f84 Correct an output.
[ci skip]
2015-02-19 23:59:15 +01:00
Alexis Hildebrandt
49080919e1 [doc] Add documentation for command-line options 2015-02-18 21:53:34 +01:00
Alexis Hildebrandt
82cdeff471 [doc] Whitespace edit
to end each sentence with two spaces.
2015-02-18 21:50:34 +01:00
Alexis Hildebrandt
bd427a9d32 [doc] Add documentation for several options 2015-02-18 21:50:34 +01:00
Alexis Hildebrandt
d5e1308d07 [ledger] Remove --cache option
and all boost serialisation related code.
2015-02-18 21:50:34 +01:00
Alexis Hildebrandt
f59abd4c76 [ledger] Remove --full-help option
since it is the same as --help.
2015-02-18 21:50:34 +01:00
Alexis Hildebrandt
ebd2334db3 [doc] Use ASCII single quote instead of apostrophe 2015-02-18 21:50:34 +01:00
Alexis Hildebrandt
bc487be14b [doc] Improve example for environment variable options
[ci skip]
2015-01-29 16:23:48 +01:00
thdox
7c9750edca Remove back-link from option to section "balance assertions".
Add forward-link from section to option.
Add option to @findex
2015-01-28 23:13:05 +01:00
Alexis Hildebrandt
11a01f1b5a [doc] Report undocumented value expression functions
in the manpage and texinfo manual.
2015-01-27 22:02:59 +01:00
Alexis Hildebrandt
19f4f587f0 [doc] Add some expression documentation to manpage
Comment undocumented expressions, so the are reported
by test/CheckManpage.py.
2015-01-27 22:02:59 +01:00
Alexis Hildebrandt
370e44d61e [doc] Change wording in manpage
[ci skip]
2015-01-27 22:02:59 +01:00
Alexis Hildebrandt
690e6b6cbe [doc] Add documentation of some expressions
to manpage.

[ci skip]
2015-01-27 22:02:59 +01:00
Alexis Hildebrandt
8c48ca879b [doc] Change wording in manpage
[ci skip]
2015-01-27 22:02:58 +01:00
Alexis Hildebrandt
eca8ffc016 [doc] Improve examples in manpage
[ci skip]
2015-01-27 22:02:58 +01:00
Alexis Hildebrandt
2664343b15 [doc] Fix typo in manpage
[ci skip]
2015-01-27 22:02:58 +01:00
Alexis Hildebrandt
bc16de720e [doc] Improve documentation for option aliases
in mapnpage.

[ci skip]
2015-01-27 22:02:58 +01:00
Alexis Hildebrandt
141e7787f5 [doc] Minor typographical changes in manpage
[ci skip]
2015-01-27 22:02:58 +01:00
Alexis Hildebrandt
fccb300044 [doc] Comment empty items in manpage
[ci skip]
2015-01-27 22:02:58 +01:00
Alexis Hildebrandt
f9f2440451 [doc] Change wording in manpage
[ci skip]
2015-01-27 22:02:33 +01:00
Alexis Hildebrandt
217193608a [doc] Use specific example to explain environment vars
[ci skip]
2015-01-27 22:02:33 +01:00
Alexis Hildebrandt
6a96a4e68a [doc] Use Tn for HTTP and XML in manpage
[ci skip]
2015-01-27 22:02:33 +01:00
Alexis Hildebrandt
d8bbc40005 [doc] Use .Nm instead of [Ll]edger in manpage
[ci skip]
2015-01-27 22:02:33 +01:00
Alexis Hildebrandt
ce4511a220 [doc] Replace Nm with Sy, Cm, Pa in manpage
[ci skip]
2015-01-27 22:02:33 +01:00
Alexis Hildebrandt
37777c284c [doc] Correct Ar placholders in manpage
[ci skip]
2015-01-27 22:02:33 +01:00
Alexis Hildebrandt
7634086465 [doc] Replace Nm with more appropriate macros
in manpage such as Fl, Ar, Ev, Em, etc.

[ci skip]
2015-01-27 22:01:57 +01:00
Alexis Hildebrandt
0f04246e43 [doc] Improve quoting in manpage
[ci skip]
2015-01-27 22:01:57 +01:00
Alexis Hildebrandt
91862091c0 [doc] Replace .Nm with .Ic where appropriate
According to mdoc (7) "The `.Nm' macro is used for the document title or
subject name.  It has the peculiarity of remembering the first argument
it was called with, which should always be the subject name of the page."

Therefore it should only be used the print `ledger` in the manpage

For the Ledger commands register, balance, etc The .Ic (internal
command) is much better suited.
[ci skip]
2015-01-27 22:01:57 +01:00
Alexis Hildebrandt
2d33ddf12f [doc] Use ASCII single quote as apostrophe
[ci skip]
2015-01-27 22:01:57 +01:00
Alexis Hildebrandt
18e5fa969f [doc] Change FILES section into a Pathname list
[ci skip]
2015-01-27 22:01:57 +01:00
Alexis Hildebrandt
185656e191 [doc] Add tests to value and format expressions
and change formatting for value expressions using @defun, @defvar.
2015-01-27 22:01:57 +01:00
Alexis Hildebrandt
3b74b20edd [doc] Add texinfo reference for permissive option
to related balance assertions section.

[ci skip]
2015-01-27 21:58:41 +01:00
Alexis Hildebrandt
c637bdded0 Merge pull request #382 from thdox/add-to-doc
Add documentation for --no-pager option.
2015-01-27 21:53:01 +01:00
thdox
97a6761ca7 Add documentation for option --permissive. 2015-01-22 01:35:14 +01:00
thdox
6b5ff2aebf Add documentation for --no-pager option.
Minor updates to --pager documentation.
[ci skip]
2015-01-22 00:57:20 +01:00
thdox
12c563614c Add documentation for bugzilla #1105, and align documentation between
ledger-reconcile.el and ledger-mode.texi.
2015-01-21 10:50:24 +01:00
thdox
37f10ab75c Minor documentation fixes 2015-01-21 10:50:22 +01:00
Alexis Hildebrandt
ba46240921 [tests] Improve option parsing in CheckTexinfo.py
* Replace @ftable @code argument with @option of @command depending
  on the documented items

* Remove @c option comment from @items documenting options
2015-01-21 08:03:53 +01:00
Alexis Hildebrandt
213f0341c1 [doc] Comment undocumented options in manpage
so that they are reported properly by test/CheckTests.py
2015-01-21 08:03:35 +01:00
Alexis Hildebrandt
4ec3c93829 [doc] Remove unsupported value expressions
The following value expressions result in an error: A, B, g, G, I, v, V

Tested using:
% for o in A B g G I v V; do
  ledger -f test/input/sample.dat -F "%(${o}(amount))\n" reg
done
While handling posting from "test/input/sample.dat", line 17:
>     Assets:Bank:Checking                           $1,000.00
Error: The A value expression variable is no longer supported
...

[ci skip]
2015-01-20 17:20:14 +01:00
Alexis Hildebrandt
197fb6d9b6 [doc] Add more tests 2015-01-20 17:18:29 +01:00
Alexis Hildebrandt
9032f49bef [doc] Document some value expressions in manpage
[ci skip]
2015-01-20 17:18:13 +01:00
Alexis Hildebrandt
d7f4d94c88 [doc] Improve spelling and wording
[ci skip]
2015-01-20 17:17:56 +01:00
Alexis Hildebrandt
a36a7873f7 Merge pull request #378 from kain88-de/manual-install-instructions
Manual install instructions

[ci skip]
2015-01-20 16:27:09 +01:00
Max Linke
5f9d4f5bf1 Refer to INSTALL.md rather then README.md
[ci skip]
2015-01-20 15:16:59 +01:00
Alexis Hildebrandt
7dd834f843 Merge pull request #376 from thdox/add-to-index4
Add single letter directive to index

[ci skip]
2015-01-20 15:09:00 +01:00