Journal cheatsheet, reorg

13 views
Skip to first unread message

Simon Michael

unread,
Dec 21, 2022, 2:18:52 PM12/21/22
to hledger
G'day all,

I put together a new cheatsheet for journal format - all the main/recommended features in 100 lines:
https://hledger.org/dev/hledger.html#journal

Related, I also did a review of journal syntax and have split it into "main" and less-recommended "other" features, moving the latter to their own section, with justifications:
https://hledger.org/dev/hledger.html#other-syntax

Secondary dates, auto postings, balance assignments are some of those. See if you agree or not.

I am expecting to add more support legacy Ledger syntax, so this Other syntax section should grow, and having all syntax in one big list made it hard to see the good stuff.

Thirdly, https://github.com/simonmichael/hledger/tree/master/hledger/test/ledger-compat is the start of a test suite for Ledger file compatibility. It uses Ledger's functional tests as a source of diverse sample Ledger files, and others collected manually can be added over time. Let me know if you can think of another good source.

https://gist.github.com/simonmichael/052703b1641669bfe067c68b81f707cc is the categorised results of a test run.. easier to read in Emacs, but to summarise, we currently read about 80% of Ledger's tests' sample data files. The most frequent causes of read failure were amount expressions and lot notation. There was ~20 other distinct causes of failure as well.
this will eventually lead to a detailed compatibility table on our Ledger page I hope.

Season's greetings!
-Simon

Francesco Ariis

unread,
Dec 21, 2022, 2:40:01 PM12/21/22
to hle...@googlegroups.com
Il 21 dicembre 2022 alle 09:18 Simon Michael ha scritto:
> G'day all,
>
> I put together a new cheatsheet for journal format - all the main/recommended features in 100 lines:
> https://hledger.org/dev/hledger.html#journal

Cheatsheet is ace, you can go through it quickly and despite being a long
time hledger user I learned something new.

niels...@gmail.com

unread,
Jan 1, 2023, 11:17:49 AMJan 1
to hledger
I like the cheatsheet for the journal format! It's a worthy addition to the current resources for learning hledger.

Also, I think that there is much wisdom in splitting off the less-commonly used, or even less-commonly recommended, hledger features, especially for beginners. That is, people new to hledger will benefit most from the things that will provide them immediate benefit. The special cases and frills can wait until later. 

Rob
Reply all
Reply to author
Forward
0 new messages