From a920fa62f034562f700fce7e341f0b297d9a1264 Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Tue, 13 Jul 2010 23:27:31 +0000 Subject: [PATCH] site: updates --- MANUAL.markdown | 18 ++++++++++-------- README.rst | 8 ++++---- README2.rst | 16 +++++++++------- site/hakyll.hs | 3 ++- site/site.tmpl | 8 ++++---- 5 files changed, 29 insertions(+), 24 deletions(-) diff --git a/MANUAL.markdown b/MANUAL.markdown index bcda08f08..7217a4e6a 100644 --- a/MANUAL.markdown +++ b/MANUAL.markdown @@ -124,13 +124,15 @@ on: You'll find more examples below. -### File format + -hledger's data file, aka the journal, is a plain text representation of a -standard accounting -[general journal](http://en.wikipedia.org/wiki/General_journal). It -contains a number of transactions, each describing a transfer of money (or -another commodity) between two or more named accounts. Here's an example: +### Journal file + +hledger's data file, aka the journal, is a standard accounting +[general journal](http://en.wikipedia.org/wiki/General_journal) in a plain +text format. It contains a number of transactions, each describing a +transfer of money (or another commodity) between two or more named +accounts. Here's an example: ; A sample journal file. This is a comment. @@ -739,9 +741,9 @@ You can pull in the content of additional journal files, by writing lines like t The `!include` directive may only be used in journal files, and currently it may only include other journal files (eg, not timelog files.) -#### Set parent account +#### Default parent account -You can specify a default parent account in a section of the journal with +You can specify a default parent account within a section of the journal with the `!account` directive: !account home diff --git a/README.rst b/README.rst index c622c4710..44aabf29a 100644 --- a/README.rst +++ b/README.rst @@ -20,14 +20,14 @@ I use it every day to: Here is a demo_ of the web interface. Here are ready-to-run binaries_ for mac, windows and gnu/linux. -They are not always the `latest release`_, sorry about that. +They are not the `current release`_, sorry about that. Here is the manual_. -For support and more technical info, see `hledger for techies`_ or `email me`_. +For support and more technical info, see `development`_ or `email me`_. .. (If you're reading this in plain text, see also README2, MANUAL etc., or http://hledger.org) -.. _hledger for techies: README2.html +.. _development: README2.html .. _manual: MANUAL.html .. _demo: http://demo.hledger.org .. _binaries: http://hledger.org/binaries/ @@ -36,4 +36,4 @@ For support and more technical info, see `hledger for techies`_ or `email me`_. .. _32 bit intel: http://hledger.org/binaries/hledger-0.6.1+9-linux-i386.gz .. _64 bit intel: http://hledger.org/binaries/hledger-0.6-linux-x86_64.gz .. _email me: mailto:simon@joyful.com -.. _latest release: http://hledger.org/MANUAL.html#installing +.. _current release: http://hledger.org/MANUAL.html#installing diff --git a/README2.rst b/README2.rst index b9f8833ce..c34ad600f 100644 --- a/README2.rst +++ b/README2.rst @@ -1,12 +1,14 @@ --- -title: hledger for techies +title: hledger development --- -hledger for techies +hledger development =================== +**Techie intro** + hledger_ is a remix, in haskell_, of John Wiegley's excellent ledger_ accounting tool. -It reads a plain text `ledger file`_ or timelog_ describing your transactions -and displays reports via `command line`_, curses_ or `web interface`_ (click for a demo). +It reads a plain text journal_ or timelog_ file describing your transactions +and displays reports via command line, curses or web interfaces. The hledger project aims to produce: @@ -43,7 +45,7 @@ hledger is free software by `Simon Michael`_ & `co.`_, released under GNU GPLv3. - chat Simon (sm) on the `#ledger`_ irc channel which we share, or `email me`_ - report problems at `bugs.hledger.org `_ -- share and test ledger snippets at paste . hledger.org +- share and test journal snippets at paste . hledger.org - .. raw:: html
@@ -53,7 +55,7 @@ hledger is free software by `Simon Michael`_ & `co.`_, released under GNU GPLv3. **Related projects** -- John Wiegley's ledger_ inspired hledger, and we try to stay compatible. You can often use both tools on the same ledger file. +- John Wiegley's ledger_ inspired hledger, and we try to stay compatible. You can often use both tools on the same journal file. - Uwe Hollerbach's umm_ is another haskell tool inspired by h/ledger. - Tim Docker's ledger-reports_ uses hledger as a library to generate `html reports`_. - I have a few older bits and pieces `here `_. @@ -65,7 +67,7 @@ hledger is free software by `Simon Michael`_ & `co.`_, released under GNU GPLv3. .. _hledger: README.html -.. _`ledger file`: http://joyful.com/repos/hledger/sample.ledger +.. _journal: http://joyful.com/repos/hledger/sample.journal .. _timelog: http://joyful.com/repos/hledger/sample.timelog .. _command line: SCREENSHOTS.html#hledger-screen-1 .. _curses: SCREENSHOTS.html#sshot diff --git a/site/hakyll.hs b/site/hakyll.hs index f64ddf8a0..d750664d4 100644 --- a/site/hakyll.hs +++ b/site/hakyll.hs @@ -66,6 +66,7 @@ cfg = (defaultHakyllConfiguration baseurl) { -- stateIndentedCodeClasses = [] -- ^ Classes to use for indented code blocks }, pandocWriterOptions = defaultWriterOptions { + -- so we can have a TOC: writerStandalone = True, -- ^ Include header and footer writerTemplate = pandocTemplate, -- ^ Template to use in standalone mode -- writerVariables = [], -- ^ Variables to set in template @@ -88,7 +89,7 @@ cfg = (defaultHakyllConfiguration baseurl) { } } --- the body part of pandoc 1.5.1.1's html output template, so we can have a TOC +-- the body part of pandoc 1.5.1.1's html output template pandocTemplate = "\ \$if(title)$\ \

$title$

\ diff --git a/site/site.tmpl b/site/site.tmpl index 1341286c9..daeef9c7f 100644 --- a/site/site.tmpl +++ b/site/site.tmpl @@ -12,12 +12,12 @@ $body