Simon Michael
68a1a8687a
doc: generate really plain text manuals
...
Drop the nice ansi highlighting that won't work everywhere,
the unpredictable unicode hyphens, etc.
2016-06-11 21:34:20 -07:00
Simon Michael
f2cdceb28e
doc: cli: rewrite options description
2016-06-11 21:33:56 -07:00
Simon Michael
e6769b26fc
doc: more macros, less redundancy, cleanups
2016-06-09 18:07:08 -07:00
Simon Michael
8986a8d3a0
doc: fix pivot option formatting, whitespace
2016-06-03 09:50:01 -07:00
Simon Michael
f21e9d1c25
doc: more deduplication of options help
...
Help for reporting options is now also defined once in lib.m4
(in addition to CliOptions.hs). Also fixed some duplication of general
options in docs. hledger-* manuals now include the full list of general
and reporting options; we assume that any inapplicable options get
harmlessly ignored and that this will not surprise users.
2016-06-03 09:38:06 -07:00
Simon Michael
6acd57da53
describe -E/--empty more accurately as "nonzero"
2016-06-03 09:00:43 -07:00
Simon Michael
f0baa30db0
doc: another help flag consistency fix
2016-05-28 23:51:14 -07:00
Simon Michael
656734ccd3
doc: define general options once
...
Well, twice: in lib.m4 and in CliOptions.hs. But no longer in every man page.
2016-05-28 23:50:37 -07:00
Simon Michael
df07ad0109
doc: parameterise and bump docs version to 0.28
2016-05-28 23:31:44 -07:00
Simon Michael
54237a61d6
refine help commands/flags' help & docs
2016-05-28 23:29:58 -07:00
Simon Michael
bd3212654c
doc: bring embedded help files up to date
2016-05-28 12:58:30 -07:00
Simon Michael
71b4a16fea
doc: hide pandoc comment in html previewer
2016-05-28 12:12:52 -07:00
Simon Michael
a8f601833e
doc: one less include file
2016-05-28 12:12:27 -07:00
Simon Michael
20bfceff2e
lib: allow multiple files of different format ( #320 )
...
When multiple files are specified with multiple -f options, we now
parse each one individually, rather than just concatenating them, so
they can have different formats.
Directives (like default year or account aliases) no longer carry over
from one file to the next. Limitation or feature ?
2016-05-18 16:41:52 -07:00
Simon Michael
59c2d73d14
doc: symlink other package docs into hledger ( #343 )
...
The hledger package tarball now contains a copy of the generated docs
from all the other packages, so that it can build without being in a
source tree.
2016-05-17 10:04:54 -07:00
Simon Michael
89b1cd1e5b
doc: readme for doc directories
2016-05-17 10:03:57 -07:00
Malte Brandy
913b8e4c19
Add --pivot option with tests and docs ( #323 )
2016-05-06 18:27:35 -07:00
Simon Michael
e2ce7c4802
doc, tests: clarify what --date2 does
2016-05-06 16:57:24 -07:00
Simon Michael
8dec8b2630
doc: drop commented table
2016-05-06 16:44:29 -07:00
Simon Michael
80948d1db7
doc: also commit info files, should fix travis
2016-04-20 12:47:17 -07:00
Simon Michael
a77f0a3835
doc: cli: link to hledger-rewrite add-on
2016-04-20 07:24:51 -07:00
Simon Michael
42c12fe631
cli, ui, web, api: --info, --man, info & man cmds
2016-04-19 19:21:29 -07:00
Simon Michael
3d129f6d31
shake: also generate info manuals
2016-04-18 17:54:55 -07:00
Simon Michael
25e2534794
doc: update all docs mentioning -h and --help
2016-04-18 17:00:54 -07:00
Simon Michael
6a3a5c60c5
doc: manual cleanups
...
use simpler markup
use pre blocks more consistently
pandoc table experiments
no more right-floating examples, use columns if needed
doc edits
style tweaks
2016-04-17 19:28:16 -07:00
Simon Michael
82f35dddd0
doc: m4 macro for web table of contents
2016-04-16 11:00:39 -07:00
Simon Michael
4c291dc54e
doc: use macros not divs to select web/man content
...
Use slightly clearer m4 macros instead of special divs to mark content
as web only/man only. The temporary doc/*.md files are no longer needed,
slightly more redundant work is done.
2016-04-16 10:09:51 -07:00
Simon Michael
130d259cb1
site: show version links on manuals
2016-04-16 04:44:33 -07:00
Simon Michael
6a97a246dd
doc: use m4 for all manuals, shake cleanup
2016-04-16 03:50:30 -07:00
Simon Michael
990294f53e
doc: fixes for the help command's docs
2016-04-14 19:22:21 -07:00
Simon Michael
bace208e98
doc: document the help command
2016-04-14 18:38:36 -07:00
Simon Michael
2931bd6085
doc: update some docs mentioning --help
2016-04-13 22:47:02 -07:00
Simon Michael
bfa5e14373
doc: generate (and commit) text-rendred man pages
...
Intended for embedding in executables. Quick implementation,
hopefully these are fixed-width and compatible with all terminals.
2016-04-13 22:29:16 -07:00
Simon Michael
588f36d662
rename timelog format to timeclock
2016-04-12 21:13:19 -07:00
Simon Michael
8ee0c7fa76
doc: update man pages
2016-04-12 20:31:17 -07:00
Simon Michael
aecbcf9461
doc: merge last bits of old manual into new one
2016-04-12 20:22:40 -07:00
Simon Michael
b69b149d39
doc: hledger: add more content from old manual
2016-04-10 12:13:38 -07:00
Simon Michael
5754f2bb4a
doc: updates, merge some more from old manual
2016-04-09 14:23:55 -07:00
Simon Michael
e4aaa302ce
doc: use m4 just to assemble main hledger man page
...
I was about to drop the m4 experiment, but.. not yet. I want to split up
the big man pages into chunks that are easier to deal with, so now using
m4 for that (only. Pandoc is taking care of selective content stripping
and other rendering adjustments.)
I've switched the suffix of m4-enabled files from .md.m4 to .m4.md -
less correct but activates more useful editor highlighting.
2016-04-09 13:30:21 -07:00
Simon Michael
5d9d155ca0
doc: misc cleanups
2016-04-07 21:59:30 -07:00
Simon Michael
69542160bb
doc: remove colons from man page headings
2016-04-07 08:55:53 -07:00
Simon Michael
443b870481
site: fix man page TOCs, add combined man page
2016-04-07 08:55:21 -07:00
Simon Michael
bba7909165
doc: m4-based man pages pt 2, missing files
2016-04-06 09:03:01 -07:00
Simon Michael
f3fb1a89f2
doc: exclude web content from nroffs
2016-04-06 08:20:27 -07:00
Simon Michael
24c2e7d471
doc: move man page source and nroff to PKG/doc/
2016-04-06 08:16:38 -07:00
