Simon Michael
efebedb71f
doc: 1.1 announcement
2017-01-04 17:31:48 -08:00
Simon Michael
52653ad1b5
set current doc version to dev
2017-01-04 17:29:58 -08:00
Simon Michael
99f52f719a
site: new system for generating versioned docs
2017-01-04 17:02:22 -08:00
Simon Michael
dd86596d30
doc: rename _versions_ macro
2017-01-04 10:50:16 -08:00
Simon Michael
20bef095aa
doc: changelogs, release notes
2016-12-31 11:24:12 -08:00
Simon Michael
14c8e4d8f7
bump version to 1.1
2016-12-31 07:54:47 -08:00
Simon Michael
701fb5496f
doc, cli: improvements for -B, -V, prices docs #403
2016-12-30 14:36:27 -08:00
Simon Michael
6edb86e33e
doc: changelog tweaks
2016-12-20 09:30:32 -08:00
Simon Michael
282e85c602
doc: update release notes
2016-12-10 08:40:29 -08:00
Simon Michael
8566dedc57
doc: changelog updates
2016-11-24 20:27:15 -08:00
Simon Michael
015b9570d4
doc: draft release notes
2016-11-23 18:13:33 -08:00
Simon Michael
56a4d84b59
doc, site: final announcement text, announcement link
...
[ci skip]
2016-10-30 10:29:50 -07:00
Simon Michael
27f9b0b000
doc, site: announcement, download page updates
...
The latest install instructions, 2016/10 edition.
[ci skip]
2016-10-30 06:38:33 -07:00
Simon Michael
407a76102c
doc: delete release notes org outline
...
Too many copies, better to use this temporarily as-needed.
2016-10-29 12:11:45 -07:00
Simon Michael
0aad803583
doc: simplify problematic old manual patch
...
These two hunks attempting to fix doc version links on the 0.27 manual
make OSX patch (2.5.x) fail with a confusing error, and anyway
they were fragile and changing the wrong place.
2016-10-29 09:38:26 -07:00
Simon Michael
00aedabdc5
site: fixes for 1.0/0.27 doc links
2016-10-28 11:56:58 -07:00
Simon Michael
8b538e8095
site: fix 0.27 manual links
...
[skip ci]
2016-10-28 11:34:45 -07:00
Simon Michael
1482f79d2e
doc: 1.0 announcement
2016-10-27 18:01:34 -07:00
Simon Michael
fbad390bfb
doc: HCAR report
2016-10-27 16:50:03 -07:00
Simon Michael
ccf44bd48d
doc: hledger-ui-1.0.2 change notes
2016-10-27 14:34:04 -07:00
Simon Michael
2e10f21f26
doc: update changelogs and relnotes outline (but not relnotes page) for 1.0.1
2016-10-27 08:10:24 -07:00
Simon Michael
d0e9b70e4f
doc: release note/changelog fixes
2016-10-27 07:43:44 -07:00
Simon Michael
08f97dd9c8
doc: project/package change logs, web release notes
2016-10-26 13:34:28 -07:00
Simon Michael
315db5621a
doc: bump version to 1.0, update manuals & cabal files
2016-10-26 13:34:27 -07:00
Brian Scott
8fdea5d11a
Anon feature ( #412 )
...
* Add anon flag to cli
* Implement anonymisation for accounts
* document the --anon option
2016-10-26 10:39:13 -07:00
Simon Michael
aec7d2fa3c
doc: release notes cleanup
2016-10-25 12:00:54 -07:00
Simon Michael
647e559db6
doc: catch release notes up with latest commits
2016-10-21 17:50:47 -07:00
Simon Michael
38ad1e9309
doc: 0.27 manual version indicator fixes #385
2016-08-07 08:55:43 -07:00
Simon Michael
e0f11e7341
doc: display latest doc version as 0.28dev in doc version indicator
...
The package versions, displayed in man page footer eg, are still (wrongly) 0.28.
2016-08-07 08:47:15 -07:00
Simon Michael
1a29d9cc02
doc: better doc version indicator, on 0.27 manual too #385 , #387
2016-08-07 08:44:06 -07:00
Simon Michael
ef7621d30f
doc: start managing release notes in org, 0.28 WIP
2016-07-13 09:21:42 -07:00
Simon Michael
d5799d0ac5
doc: README
2016-07-13 09:21:14 -07:00
Simon Michael
1953748972
cli: clarify --debug flag's help
2016-07-06 15:11:10 -07:00
Simon Michael
0b465f61e7
cli: make -I short for --ignore-assertions
...
Differs from Ledger, but will be useful for hledger-ui.
2016-07-06 14:56:29 -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
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
0c74dcde67
doc: macro cleanups
2016-04-17 15:27:56 -07:00
Simon Michael
82f35dddd0
doc: m4 macro for web table of contents
2016-04-16 11:00:39 -07:00
Simon Michael
6529daf20c
site: ensure 0.27 manual is in place for links
...
Stripping hledger- from the link fragment with patsubst isn't working.
2016-04-16 05:55:16 -07:00
Simon Michael
130d259cb1
site: show version links on manuals
2016-04-16 04:44:33 -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
3c7e1a7399
doc: some convenient m4 macros for docs
2016-04-10 12:09:39 -07:00
Simon Michael
4b9d30dac3
doc: man page template tweaks
2016-04-09 14:02:37 -07:00
Simon Michael
33e2ca927f
doc: improve new combined manual, cleanups
2016-04-07 21:58:42 -07:00
Simon Michael
0982aca223
tools: missing file, git ignore
2016-04-07 09:05:16 -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
eab6b110bc
tools: simplify doc filtering class names
2016-04-05 16:17:08 -07:00
Simon Michael
9b492325da
tools: rename pandoc filters
2016-04-05 16:17:08 -07:00
Simon Michael
5acb82e627
notes
2016-02-21 02:37:03 -08:00
Simon Michael
e1c9e51775
tools: new build system for man/web docs
...
Goal:
Generate man pages and web docs from one source.
Current plan:
The master docs for each package are now the pandoc-style
manpage-markdown files in the package directories -
hledger/hledger.1.md, hledger-lib/hledger_journal.5.md, etc.
Parts of these will be marked as web-only, and parts as man-only, using
divs recognisable by custom pandoc filters.
When generating man pages we strip the web-only parts, and all html
blocks, inline html and hyperlinks.
When generating web docs we strip the man-only parts and apply any other
tweaks needed for easy presentation, perhaps combining them into a
single web page similar to the old user manual.
Shake:
This was hard to do with GNU Make, and so I've introduced Shake, which
is working very well. Both coexist for now but it's probably time to
switch.
2016-02-21 02:21:41 -08:00
Simon Michael
2b4cb6b970
cli: shorter help mockup updates
2016-02-19 22:48:59 -08:00
Simon Michael
ea6636d967
hcar entry updates
2015-11-16 15:14:49 -08:00
Simon Michael
293146269f
doc: shorter command-line help mockups
2015-11-08 17:42:55 -08:00
Simon Michael
1f05d1c9bf
doc: add a project-level changelog
2015-11-05 20:19:49 -08:00
Simon Michael
18f3e723ec
site: move manual, devguide here; move out of doc/
2015-11-05 19:32:17 -08:00
Simon Michael
dea1bc5ab3
doc: manual: clarify accounts command
2015-11-05 19:05:36 -08:00
Simon Michael
6d84a19aa2
site: home: add hledger-ui, cleanups
2015-11-04 17:00:12 -08:00
Simon Michael
2be7ffc563
doc: manual: timelog cleanups
2015-11-04 16:33:27 -08:00
Simon Michael
6ea5ad9fbb
site: download page cleanups
2015-11-03 18:59:12 -08:00
Simon Michael
d401c7839f
site: relnotes, devguide updates
2015-11-03 18:58:52 -08:00
Simon Michael
ba89e58389
site: faq updates
2015-11-03 18:58:17 -08:00
Simon Michael
87a9e77d60
ui: add some screenshots to the user manual
2015-11-01 11:58:50 -08:00
Simon Michael
b2038b3997
doc: 0.27 announcement
2015-10-31 15:49:12 -07:00
Simon Michael
e6747c9530
site: relnotes: yet another fix
2015-10-30 14:28:01 -07:00
Simon Michael
fd5185a8e4
site: relnotes, devguide updates
2015-10-30 14:23:43 -07:00
Simon Michael
f858b85ddd
site: download: clarify stack snapshot status
2015-10-30 14:02:45 -07:00
Simon Michael
3d5e65a238
site: download, devguide updates
2015-10-30 13:56:13 -07:00
Simon Michael
fbfa725197
site: download: update recommended stack snapshot
2015-10-30 13:23:22 -07:00
Simon Michael
a5fd56223c
bump version to 0.27
2015-10-30 13:21:51 -07:00
Simon Michael
e061eabe2c
ui: C toggles --cleared; f -> F; UI tweaks
...
You can now toggle showing only cleared items in the accounts and
register screens, with C (like the command-line flag).
The f key has been changed to F for consistency (we don't have this as a
command-line flag, though we could, though Ledger uses it for something
different).
Screen titles have been tweaked, eg switching the cyan and yellow.
Screen help has been squeezed to fit better in 80 columns.
2015-10-30 10:42:44 -07:00
Simon Michael
4691454908
ui: txn: up/down steps through txns in the account
2015-10-29 20:19:18 -07:00
Simon Michael
68cd35c965
ui: txn: add a transaction-viewing screen
2015-10-29 17:45:57 -07:00
Simon Michael
f6a7070167
ui: reg: document the balance/total column better
2015-10-29 17:15:13 -07:00
Simon Michael
6f85e02f1a
ui: show an error screen when reloading fails
2015-10-26 07:41:45 -07:00
Simon Michael
13b6d142c6
doc: add hledger-ui to combined user manual
2015-10-26 07:13:43 -07:00
Simon Michael
5a0c1b03f4
doc: stop symlinking changelogs to doc/
2015-10-26 06:57:28 -07:00
Simon Michael
844e04812c
tools: simplify stack preamble in hakyll-std.hs
...
This doesn't yet quite install its deps when you run it from the
makefile, you may have to run the script directly to get the deps
(hakyll, pandoc) installed.
2015-10-26 06:54:29 -07:00
Simon Michael
60df129c7b
doc: changelog updates, combined release notes
2015-10-26 06:37:33 -07:00
Simon Michael
191c2e533f
doc: generate man pages for each package ( #282 )
...
There are now six man pages, one for each main executable and file
format, generated from markdown by the mighty pandoc. They are basically
the content of the user manual, split up and moved into the appropriate
package directory. I've also committed the generated man files.
The man pages' markdown source (hledger/hledger.1.md,
hledger-lib/hledger_journal.5.md etc.) are now the master documentation
files. The plan is to concatenate them (with a little munging) to form
the all-in-one user manual for the website, at release time. This also
separates the hledger.org user manual from the latest doc commits, which
should simplify website management.
2015-10-20 06:26:09 -07:00
Simon Michael
77cf3a83da
doc: lower-case hcar dir, part 2
...
in two parts to avoid any issues with git/osx
2015-10-19 08:56:21 -07:00
Simon Michael
2c170f63a6
doc: lower-case hcar dir, part 1
...
in two parts to avoid any issues with git/osx
2015-10-19 08:55:15 -07:00
Simon Michael
e2618210d2
doc: HCAR tweaks
2015-10-19 08:42:06 -07:00
Simon Michael
cbb076c224
doc: distinguish mockups from docs
2015-10-19 08:41:24 -07:00
Simon Michael
ef2dd9651d
doc: a new HCAR entry
2015-10-18 16:09:23 -07:00
Simon Michael
bf532948f6
doc: clean up HCAR files
2015-10-18 14:50:14 -07:00
Simon Michael
2e38aec410
doc: link to dev sprint #2
2015-10-11 17:47:04 -07:00
Simon Michael
1d944ac1a9
doc: balance --format does not support - any more
2015-10-10 15:07:49 -07:00
Simon Michael
e6d8a9d1bc
tools: add sample journals with wide characters
...
generatejournal now has --chinese and --mixed options, which are used to
generate some additional small sample journals.
2015-10-10 11:51:07 -07:00
Simon Michael
939f7184c9
journal: make "end comment" optional, like ledger
...
The "comment" directive longer requires an "end comment", and will
extend to the end of the file(s) without it.
2015-10-07 16:41:49 -07:00
Simon Michael
921a874e72
doc: front page: add gpl badge
2015-09-02 11:49:33 -07:00
Simon Michael
9647d350b1
doc: more download/devguide tweaks
2015-08-24 09:34:26 -07:00
Simon Michael
ee8161dd1c
doc: download: update instructions for stack LTS 3
2015-08-24 09:23:07 -07:00
Simon Michael
edd1d4268b
doc: devguide: rewrite setup docs
2015-08-24 07:42:49 -07:00
Simon Michael
62f0b879e5
doc: devguide: sample journals ( #197 )
2015-08-23 21:42:58 -07:00
