merge: rewrite-docs
I've omitted docs/*.org from this merge, as there is still work left to do there, but I am pushing the module docs early so folks can benefit from the new docs sooner.
This commit is contained in:
commit
1f8bf7accb
179 changed files with 13125 additions and 8630 deletions
|
@ -1,56 +1,74 @@
|
|||
#+TITLE: lang/ledger
|
||||
#+DATE: October 13, 2019
|
||||
#+SINCE: v2.0.4
|
||||
#+STARTUP: inlineimages
|
||||
# -*- mode: doom-docs-org -*-
|
||||
#+title: :lang ledger
|
||||
#+subtitle: Be audit you can be
|
||||
#+created: September 09, 2017
|
||||
#+since: 2.0.6 (#194)
|
||||
|
||||
* Table of Contents :TOC_3:noexport:
|
||||
- [[#description][Description]]
|
||||
- [[#module-flags][Module Flags]]
|
||||
- [[#plugins][Plugins]]
|
||||
- [[#hacks][Hacks]]
|
||||
- [[#prerequisites][Prerequisites]]
|
||||
- [[#features][Features]]
|
||||
- [[#configuration][Configuration]]
|
||||
|
||||
* Description
|
||||
* Description :unfold:
|
||||
This module adds support for [[https://www.ledger-cli.org/][ledger]] files. Ledger is a command line double-entry
|
||||
accounting system that works with simple text files holding transactions in the
|
||||
following format:
|
||||
|
||||
#+BEGIN_SRC ledger
|
||||
#+begin_src ledger
|
||||
2015/10/12 Exxon
|
||||
Expenses:Auto:Gas $10.00
|
||||
Liabilities:MasterCard $-10.00
|
||||
#+END_SRC
|
||||
#+end_src
|
||||
|
||||
This modules enables the following features:
|
||||
+ Syntax and indentation support for ledger files
|
||||
+ Add, edit, and delete transactions
|
||||
+ Generate reports
|
||||
+ Schedule transactions
|
||||
+ Sort transactions
|
||||
+ Display statistics about transactions
|
||||
+ Display balance up to a point
|
||||
- Syntax and indentation support for ledger files
|
||||
- Add, edit, and delete transactions
|
||||
- Generate reports
|
||||
- Schedule transactions
|
||||
- Sort transactions
|
||||
- Display statistics about transactions
|
||||
- Display balance up to a point
|
||||
|
||||
** Module Flags
|
||||
This module provides no flags.
|
||||
** Maintainers
|
||||
/This module has no dedicated maintainers./ [[doom-contrib-maintainer:][Become a maintainer?]]
|
||||
|
||||
** Plugins
|
||||
+ [[https://github.com/purcell/flycheck-ledger][flycheck-ledger]]
|
||||
+ [[https://github.com/atheriel/evil-ledger][evil-ledger]]
|
||||
** Module flags
|
||||
/This module has no flags./
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][evil-ledger]] if [[doom-module:][:editor evil +everywhere]]
|
||||
- [[doom-package:][flycheck-ledger]] if [[doom-module:][:checkers syntax]]
|
||||
- [[doom-package:][ledger-mode]]
|
||||
|
||||
** Hacks
|
||||
This module sets ~ledger-clear-whole-transactions~ to ~t~ (default value is
|
||||
~nil~). This results in ~ledger-toggle-current~ toggling the clear status of the
|
||||
whole transaction instead of toggling just the current posting.
|
||||
- This module sets ~ledger-clear-whole-transactions~ to ~t~ (default value is
|
||||
~nil~). This results in ~ledger-toggle-current~ toggling the clear status of
|
||||
the whole transaction instead of toggling just the current posting.
|
||||
|
||||
* Prerequisites
|
||||
In order for ~flycheck-ledger~ to work and to be able to generate reports you
|
||||
will need to install [[https://www.ledger-cli.org/][ledger]].
|
||||
** TODO Changelog
|
||||
# This section will be machine generated. Don't edit it by hand.
|
||||
/This module does not have a changelog yet./
|
||||
|
||||
* TODO Features
|
||||
An in-depth list of features, how to use them, and their dependencies.
|
||||
* Installation
|
||||
[[id:01cffea4-3329-45e2-a892-95a384ab2338][Enable this module in your ~doom!~ block.]]
|
||||
|
||||
This module requires [[https://www.ledger-cli.org/][ledger]] to syntax check and generate reports from your
|
||||
ledgers.
|
||||
|
||||
* TODO Usage
|
||||
#+begin_quote
|
||||
🔨 This module has no usage documentation yet. [[doom-contrib-module:][Write some?]]
|
||||
#+end_quote
|
||||
|
||||
* TODO Configuration
|
||||
#+begin_quote
|
||||
🔨 /This module's configuration documentation is incomplete./ [[doom-contrib-module:][Complete it?]]
|
||||
#+end_quote
|
||||
|
||||
* Configuration
|
||||
Please refer to ~ledger-mode~'s documentation for information on how to
|
||||
configure it. You can do so within emacs with =C-h i=
|
||||
configure it. You can do so within emacs with [[kbd:][C-h i]]
|
||||
|
||||
* Troubleshooting
|
||||
/There are no known problems with this module./ [[doom-report:][Report one?]]
|
||||
|
||||
* Frequently asked questions
|
||||
/This module has no FAQs yet./ [[doom-suggest-faq:][Ask one?]]
|
||||
|
||||
* TODO Appendix
|
||||
#+begin_quote
|
||||
🔨 This module has no appendix yet. [[doom-contrib-module:][Write one?]]
|
||||
#+end_quote
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue