slaesvuo/hledger
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs, site: a bunch of updates

Browse Source
This commit is contained in:
Simon Michael 2010-07-24 19:45:18 +00:00
parent 3d0c885e58
commit b16943a4bf
11 changed files with 80 additions and 78 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README2.rst → DEVELOPMENT.rst
View File

@ -30,13 +30,13 @@ hledger is free software by `Simon Michael`_ & `co.`_, released under GNU GPLv3.
``darcs get http://joyful.com/repos/hledger``,
`browse the repo`_,
`hackage page`_,
`hledger-lib api docs`_,
`hledger api docs`_,
`hledger-lib sourcegraph report`_,
`hledger sourcegraph report`_,
`hledger haddock docs`_,
benchmark_\/profile_\/heap_\/coverage_ reports,
`developer notes`_
.. `hledger-lib sourcegraph report`_,
.. `hledger sourcegraph report`_,
.. raw:: html
<a name="support" />
@ -78,8 +78,7 @@ hledger is free software by `Simon Michael`_ & `co.`_, released under GNU GPLv3.
.. _manual: MANUAL.html
.. _news: NEWS.html
.. _screenshots: SCREENSHOTS.html
.. _hledger-lib api docs: http://joyful.com/repos/hledger/hledger-lib/dist/doc/html/hledger-lib/index.html
.. _hledger api docs: http://joyful.com/repos/hledger/dist/doc/html/hledger/index.html
.. _hledger haddock docs: http://hledger.org/api-doc/
.. _hledger-lib sourcegraph report: http://joyful.com/repos/hledger/hledger-lib/SourceGraph/hledger-lib.html
.. _hledger sourcegraph report: http://joyful.com/repos/hledger/SourceGraph/hledger.html
.. _developer notes: http://joyful.com/darcsweb/darcsweb.cgi?r=hledger;a=plainblob;f=/NOTES
@ -88,7 +87,7 @@ hledger is free software by `Simon Michael`_ & `co.`_, released under GNU GPLv3.
.. _heap: http://hledger.org/profs/latest.ps
.. _coverage: http://hledger.org/profs/coverage/hpc_index_fun.html
.. _browse the repo: http://joyful.com/darcsweb/darcsweb.cgi?r=hledger
.. _email me: mailto:simon@joyful.com
.. _email me: mailto:simon@joyful.com?subject=hledger:
.. _Simon Michael: http://joyful.com
.. _co.: http://hledger.org/CONTRIBUTORS.html
.. _hackage page: http://hackage.haskell.org/package/hledger

24
MANUAL.markdown
View File

@ -578,11 +578,11 @@ subsequent dates may be written as month/day. Eg:
Y2009
12/15 ...
12/15 ; <- equivalent to 2009/12/15
Y2010
1/31 ...
1/31 ; <- equivalent to 2010/1/31
##### Actual/effective dates
@ -862,6 +862,9 @@ Generally, it's easy to keep a journal file that works with both hledger
and c++ledger if you avoid the more esoteric syntax. Occasionally you'll
need to make small edits to restore compatibility for one or the other.
hledger does not allow separate dates for individual postings, unlike c++
ledger.
#### Features not supported
c++ ledger features not currently supported include: modifier and periodic
@ -927,23 +930,28 @@ entries, and the following c++ ledger options and commands:
- hledger recognises description and negative patterns by "desc:"
and "not:" prefixes, unlike ledger 3's free-form parser
- hledger doesn't require a space before command-line option
values, you can write -f-
values, eg either `-f-` or `-f -` is fine
- hledger's weekly reporting intervals always start on mondays
- hledger shows start and end dates of the intervals requested,
not just the span containing data
- hledger period expressions don't support "biweekly",
"bimonthly", or "every N days/weeks/..."
- hledger always shows timelog balances in hours
- hledger splits multi-day timelog sessions at midnight
- hledger doesn't track the value of commodities with varying
price; prices are fixed as of the transaction date
- hledger print shows amounts for all postings, and shows unit
prices for amounts which have them
- hledger assumes a transaction's actual date comes first, and is
required, while the optional effective date comes second (cf
[Actual and effective dates](#actual-and-effective-dates))
- hledger does not support per-posting actual or effective dates
prices for amounts which have them. (This currently means that
it does not print multi-commodity transactions in valid journal format.)
### More examples and recipes

23
README.rst
View File

@ -8,6 +8,7 @@ hledger is a computer program for easily tracking money, time, or other
commodities, using standard accounting principles. It is quite limited in
features, but reliable. For some, it is a bare-bones, less complex, less
expensive alternative to Quicken or Microsoft Money.
hledger is available for free under the GNU General Public License.
hledger aims to help both computer experts and every-day users gain clarity in their finances and time management.
I use it every day to:
@ -17,23 +18,17 @@ I use it every day to:
- get accurate numbers for client billing and tax filing
- track invoices
Here is a demo_ of the web interface.
The manual_ and screenshots_ will explain more. There's also a demo_ of hledger's web interface.
To get started tracking your own numbers, download_ a copy.
Here are ready-to-run binaries_ for mac, windows and gnu/linux;
or here's how to `build your own`_.
Here is the manual_.
For support and more technical info, see `development`_ or `email me`_.
I appreciate feedback on all aspects of hledger. Thanks!
.. (If you're reading this in plain text, see also README2, MANUAL etc., or http://hledger.org)
.. _development: README2.html
.. _manual: MANUAL.html
.. _screenshots: SCREENSHOTS.html
.. _demo: http://demo.hledger.org
.. _binaries: http://hledger.org/binaries/
.. _hledger for mac: http://hledger.org/binaries/hledger-0.6-mac-i386.gz
.. _hledger for windows: http://hledger.org/binaries/hledger-0.6-win-i386.zip
.. _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
.. _build your own: http://hledger.org/MANUAL.html#installing
.. _web interface: MANUAL.html#web
.. _download: download
.. _development: DEVELOPMENT.html
.. _email me: mailto:simon@joyful.com?subject=hledger:

3
SCREENSHOTS.markdown
View File

@ -4,7 +4,8 @@ title: hledger screenshots
# hledger screenshots
Mouse over for captions, click to enlarge.
Click to enlarge, or mouse over for captions..
<style>
.highslide img {height:90px;}

2
hledger.cabal
View File

@ -33,7 +33,7 @@ data-files:
extra-tmp-files:
extra-source-files:
README.rst
README2.rst
DEVELOPMENT.rst
MANUAL.markdown
NEWS.markdown
CONTRIBUTORS.rst

2
site/api-doc-frames.html
View File

@ -4,7 +4,7 @@
<head>
<title>hledger api docs</title>
</head>
<frameset cols="30%, 70%">
<frameset cols="40%, 60%">
<frameset rows="100%">
<frame name="side1" src="modules-index.html">
<!-- frame name="side2" src="hoogle-small.html" -->

4
site/download/FOOTER.html
View File

@ -16,5 +16,5 @@ pageTracker._trackPageview();
} catch(err) {}
</script>
</body>
</html>

24
site/download/HEADER.html
View File

@ -21,41 +21,39 @@
<div id="navigation">
<a href="/README.html">Home</a>
<a href="/download/">Download</a>
<a href="/README2.html">Development</a>
<a href="/MANUAL.html">Manual</a>
<a href="/DEVELOPMENT.html">Development</a>
<a href="/NEWS.html">News</a>
<a href="/MANUAL.html">Manual</a>
<a href="/SCREENSHOTS.html">Screenshots</a>
<a href="http://demo.hledger.org">Demo</a>
</div>
<style>
/* #platformdocs table {border:none;} */
td { padding:0 0.5em 0 0.5em; }
#platformdocs code { white-space:nowrap; }
#platformdocs td {
width:33%;
vertical-align:top;
padding-left:0.5em;
padding-right:0.5em;
font-size:small;
}
code {white-space:nowrap;}
</style>
<h1 class="title">hledger downloads</h1>
<p>
Here are hledger binaries ready to run on your platform. Choose
GNU/Linux, Mac or Windows and follow the instructions.
If you have any trouble, please
<a href="http://hledger.org/README2.html#support">report it</a> (-> Support).
To build your own custom version of hledger, see the
<a href="http://hledger.org/MANUAL.html#installing">cabal installation docs</a> instead.
Here are hledger binaries which "might just work" on your computer.
Choose GNU/Linux, Mac or Windows and follow the instructions. If you
have any trouble, please <a
href="http://hledger.org/README2.html#support">report it to Support</a>.
To build your own custom version of hledger, see
<a href="http://hledger.org/MANUAL.html#installing">installing with cabal</a> instead.
<p>
<table id="platformdocs">
<tr>
<th>GNU/Linux</th>
<th>GNU/Linux (intel)</th>
<th>Mac</th>
<th>Windows</th>
</tr>

2
site/hakyll.hs
View File

@ -19,7 +19,7 @@ baseurl = "http://hledger.org"
main = hakyllWithConfiguration cfg $ do
mapM_ renderParentDirPage
["README.rst"
,"README2.rst"
,"DEVELOPMENT.rst"
,"NEWS.rst"
,"SCREENSHOTS.markdown"
,"MANUAL.markdown"

4
site/site.tmpl
View File

@ -21,9 +21,9 @@
<div id="navigation">
<a href="$root/README.html">Home</a>
<a href="$root/download/">Download</a>
<a href="$root/README2.html">Development</a>
<a href="$root/MANUAL.html">Manual</a>
<a href="$root/DEVELOPMENT.html">Development</a>
<a href="$root/NEWS.html">News</a>
<a href="$root/MANUAL.html">Manual</a>
<a href="$root/SCREENSHOTS.html">Screenshots</a>
<a href="http://demo.hledger.org">Demo</a>
</div>

53
site/style.css
View File

@ -40,40 +40,41 @@ code {
}
h1 {
font-size: 3em;
/* color: #49637C; */
/* color: #226600; */
margin-bottom: 3px;
text-align: left;
/* margin-top: 0.7em; */
/* margin-bottom: 0.7em; */
}
/* h1 { */
/* margin-top:1em; */
/* text-align: left; */
/* } */
/* h1 .small { */
/* font-size: 0.4em; */
/* } */
/* h1 a { */
/* text-decoration: none; */
/* } */
h2 {
font-size: 1.5em;
}
h2 a {
text-decoration: none;
font-size: 2em;
/* margin-top: 0.7em; */
/* margin-bottom: 0.6em; */
}
h3 {
/* text-align: center; */
}
h3 a {
text-decoration: none;
font-size: 1.6em;
/* margin-top: 0.7em; */
/* margin-bottom: 0.5em; */
}
h4 {
font-size: 1.4em;
/* margin-top: 0.7em; */
/* margin-bottom: 0.4em; */
}
h4 a {
/* text-decoration: none; */
h5 {
font-size: 1.2em;
margin-top: 1em;
/* margin-bottom: 0.3em; */
}
h5 a {
text-decoration: none;
h6 {
font-size: 1em;
margin-top: 0.5em;
/* margin-bottom: 0.2em; */
}
h1, h2, h3, h4, h5, h6 {
margin-bottom: 0em;
color:black;
}
h1 a, h2 a, h3 a, h4 a, h5 a, h6 a {
text-decoration:none;
color:black;
}
a {
}