sfos/ledger
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #288 from thdox/fix-doc-and-typos

Browse source 
Fix doc and typos
This commit is contained in:
Craig Earls 2014-05-11 19:38:55 -07:00
commit a505f22e15
1 changed files with 106 additions and 109 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

215
doc/GLOSSARY.md
View file

@ -1,65 +1,63 @@
ACCOUNTING GLOSSARY ACCOUNTING GLOSSARY
--- ---
Accounting and bookkeeping represent an entire field of human effort and Accounting and bookkeeping represent an entire field of human effort and has
has evolved its own specialized vocabulary. Accounting hopes to evolved its own specialized vocabulary. Accounting hopes to summarize and
summarize and add understanding to where the money is going. add understanding to where the money is going.
**Account**: A category for grouping together amounts from similar **Account**: A category for grouping together amounts from similar
transactions. Each account has a name, which is usually capitalized, and transactions. Each account has a name, which is usually capitalized, and an
an account type. Accounts are often organized into a heirarchy when it account type. Accounts are often organized into a hierarchy when it helps
helps understanding. For example, a coffee shop might have Coffee, understanding. For example, a coffee shop might have Coffee, Merchandise,
Merchandise, and Equipment as accounts but arranged under an Inventory and Equipment as accounts but arranged under an Inventory account because
account because different decisions are made on the total inventory different decisions are made on the total inventory rather than just coffee.
rather than just coffee. A heirarchy can be part of the account name in A hierarchy can be part of the account name in Ledger, e.g.,
Ledger, e.g., "Assets:Inventory:Coffee". Note that the Ledger software "Assets:Inventory:Coffee". Note that the Ledger software usually creates
usually creates the list of accounts on the fly: accounts are created the list of accounts on the fly: accounts are created when transactions use
when transactions use them. them.
**Account Type**: Each account has a type of Asset, Liability, Equity, **Account Type**: Each account has a type of Asset, Liability, Equity, Income,
Income, or Expense. Assets represent something owned, e.g., Cash or or Expense. Assets represent something owned, e.g., Cash or Inventory.
Inventory. Liabilities represent sometime owed, e.g., a Loan or Liabilities represent sometime owed, e.g., a Loan or Mortgage. Equity, also
Mortgage. Equity, also called capital, is everything owned minus called capital, is everything owned minus everything owed (Assets -
everything owed (Assets - Liabilities). It is the financial measure of Liabilities). It is the financial measure of how much you are ahead.
how much you are ahead. Income is money earned somewhere, which puts you Income is money earned somewhere, which puts you more ahead. Expenses is
more ahead. Expenses is money spent somewhere, which puts you less money spent somewhere, which puts you less ahead. The type of account
ahead. The type of account determines if a debit represents an increase determines if a debit represents an increase or decrease in an account. For
or decrease in an account. For example, Inventory is an asset so a example, Inventory is an asset so a transaction debiting Inventory would
transcation debiting Inventory would increase its value. Assets and increase its value. Assets and Expenses increase with debits and decrease
Expenses increase with debits and decrease with credits; Liabilities, with credits; Liabilities, Equity, and Expenses increase with credits and
Equity, and Expenses increase with credits and decrease with debits. decrease with debits.
**Journal**: A record of all the financial transactions of a person or **Journal**: A record of all the financial transactions of a person or firm.
firm. This data of where money goes can be collated into reports. This This data of where money goes can be collated into reports. This used to be
used to be done with a physical book, called a ledger, where each account done with a physical book, called a ledger, where each account was on one
was on one page. Each debit or credit in the journal was transfered to page. Each debit or credit in the journal was transferred to the
the appropriate account page and the pages were totalled to produce appropriate account page and the pages were totalled to produce reports.
reports. This process is now done with the Ledger software which creates This process is now done with the Ledger software which creates reports from
reports from the journal. A journal is sometimes called a register. the journal. A journal is sometimes called a register.
**Posting**: A single debit or credit line of a transaction. A posting **Posting**: A single debit or credit line of a transaction. A posting
comprises an account and the debit or credit amount. It also inherits the comprises an account and the debit or credit amount. It also inherits the
shared description and date from the transaction. In the Ledger software, shared description and date from the transaction. In the Ledger software,
a posting may also have metadata and an account state. a posting may also have metadata and an account state.
**Report**: A summary made from a journal of transactions. Each **Report**: A summary made from a journal of transactions. Each transaction
transaction affects accounts and those effects are collated and totaled. affects accounts and those effects are collated and totaled. The two most
The two most common reports are the balance sheet, which shows what is common reports are the balance sheet, which shows what is owned and owed on
owned and owed on a specific date, and the cash flow statement, which a specific date, and the cash flow statement, which shows how money was
shows how money was earned and spent over a period. The cash flow earned and spent over a period. The cash flow statement is also called
statement is also called a profit and loss statement or an income a profit and loss statement or an income statement.
statement.
**Transaction**: Our financial lives are recorded as a series of **Transaction**: Our financial lives are recorded as a series of transactions.
transactions. Each transaction has a specific date, an equal total of Each transaction has a specific date, an equal total of debits and credits
debits and credits affecting accounts, and some sort of description. For affecting accounts, and some sort of description. For example, "On January
example, "On January 1, pay $100 with check #243 from Checking to 1, pay $100 with check #243 from Checking to Utilities for my Verizon phone
Utilities for my Verizon phone bill" is a transaction. A credit of $100 bill" is a transaction. A credit of $100 decreases my Checking asset, while
decreases my Checking asset, while a balancing debit of $100 increases my a balancing debit of $100 increases my Utility expense. A transaction needs
Utility expense. A transaction needs at least two *postings*, meaning at least two *postings*, meaning account debits or credits, but can be as
account debits or credits, but can be as complicated as humans can make complicated as humans can make finances.
finances.
LEDGER GLOSSARY LEDGER GLOSSARY
--- ---
@ -69,29 +67,29 @@ The Ledger software also has its own terms.
**Automated Transaction**: a command directive that modifies subsequent **Automated Transaction**: a command directive that modifies subsequent
transactions that match an expression. An automated transaction can add transactions that match an expression. An automated transaction can add
additional postings to a transaction, add metadata, or change transaction additional postings to a transaction, add metadata, or change transaction
amounts. Reports can be filter postings modified or generated by an automated amounts. Reports can be filter postings modified or generated by an
transaction. automated transaction.
[§ Automated Transactions](http://www.ledger-cli.org/3.0/doc/ledger3.html#Automated-Transactions); [§ Automated Transactions](http://www.ledger-cli.org/3.0/doc/ledger3.html#Automated-Transactions);
[§ Concrete Example of Automated Transactions](http://www.ledger-cli.org/3.0/doc/ledger3.html#Concrete-Example-of-Automated-Transactions) [§ Concrete Example of Automated Transactions](http://www.ledger-cli.org/3.0/doc/ledger3.html#Concrete-Example-of-Automated-Transactions)
**Command Directive**: a command in a journal file to change how subsequent **Command Directive**: a command in a journal file to change how subsequent
lines and transactions in a journal file are processed. Command directives lines and transactions in a journal file are processed. Command directives
control processing, set default values for subsequent accounts and control processing, set default values for subsequent accounts and
transactions, or override parts of subsequent transactions. A directive transactions, or override parts of subsequent transactions. A directive
line begins with name of the directive and may have addidtional arguments line begins with name of the directive and may have additional arguments or
or additional indented lines. The single letters *AbCDhIiNOoY* are aliased additional indented lines. The single letters *AbCDhIiNOoY* are aliased to
to other command directives, providing compatiblity with the ancient past. other command directives, providing compatibility with the ancient past.
The characters **'='** and **'-'** are command directives for a automatic The characters **'='** and **'-'** are command directives for a automatic
transactions and periodic transactions, respectively. transactions and periodic transactions, respectively.
[§ Command Directives](http://www.ledger-cli.org/3.0/doc/ledger3.html#Command-Directives) [§ Command Directives](http://www.ledger-cli.org/3.0/doc/ledger3.html#Command-Directives)
**Commodity**: any currency, stock, time or resource to be tracked **Commodity**: any currency, stock, time or resource to be tracked
numerically. While many people only track money in Ledger, Ledger can numerically. While many people only track money in Ledger, Ledger can track
track different resources and manage rules to convert between them. The different resources and manage rules to convert between them. The system is
system is flexible enough for the needs of very different users. Some flexible enough for the needs of very different users. Some track billable
track billable time, converting minutes and hours into dollars. Others time, converting minutes and hours into dollars. Others track multiple
track multiple currencies. Still others track the purchase and sale of currencies. Still others track the purchase and sale of stocks. Each
stocks. Each commodity is seperate unless a conversion rule is given. commodity is separate unless a conversion rule is given.
[§ Commodities and Currencies](http://www.ledger-cli.org/3.0/doc/ledger3.html#Commodities-and-Currencies); [§ Commodities and Currencies](http://www.ledger-cli.org/3.0/doc/ledger3.html#Commodities-and-Currencies);
[§ Currencies and Commodities](http://www.ledger-cli.org/3.0/doc/ledger3.html#Currency-and-Commodities); [§ Currencies and Commodities](http://www.ledger-cli.org/3.0/doc/ledger3.html#Currency-and-Commodities);
[§ Accounts and Inventories](http://www.ledger-cli.org/3.0/doc/ledger3.html#Accounts-and-Inventories); [§ Accounts and Inventories](http://www.ledger-cli.org/3.0/doc/ledger3.html#Accounts-and-Inventories);
@ -99,56 +97,55 @@ transactions and periodic transactions, respectively.
*(and next ten sections)*; *(and next ten sections)*;
[§ Commodity Reporting](http://www.ledger-cli.org/3.0/doc/ledger3.html#Commodity-Reporting) [§ Commodity Reporting](http://www.ledger-cli.org/3.0/doc/ledger3.html#Commodity-Reporting)
**Effective Date**: an optional, second date information item in for a **Effective Date**: an optional, second date information item in for a posting
posting or transaction. Some use the effective date for when work is or transaction. Some use the effective date for when work is billed or when
billed or when a check has cleared. The `--effective-date` option causes a check has cleared. The `--effective-date` option causes the effective
the effective date to override the transaction's initial date for that date to override the transaction's initial date for that report.
report. [§ Effective Dates](http://www.ledger-cli.org/3.0/doc/ledger3.html#Effective-Dates);
[§ Effective Dates](http://www.ledger-cli.org/3.0/doc/ledger3.html#Effective-Dates);
**Journal File**: the text input file for ledger, sometimes called a **Journal File**: the text input file for ledger, sometimes called a register
register file. A journal file is a series of transactions, command file. A journal file is a series of transactions, command directives, and
directives, and comments. Command directives start with the single word comments. Command directives start with the single word name of the
name of the directive at the beginning of the line and include any directive at the beginning of the line and include any following indented
following indented lines. Transactions start with a date a the beginning lines. Transactions start with a date a the beginning of the line and
of the line and include any indented lines following. The journal file is include any indented lines following. The journal file is expected to be
expected to be encoded as ASCII or utf-8 text. encoded as ASCII or UTF-8 text.
**Periodic Transaction**: the estimate of a transaction that would occur **Periodic Transaction**: the estimate of a transaction that would occur
periodically, e.g., a monthly expense. These estimates are only used in periodically, e.g., a monthly expense. These estimates are only used in
budgeting and forecasting reports using the `--budget`, budgeting and forecasting reports using the `--budget`, `--forecast`, or
`--forecast`, or `--unbudgeted` options. `--unbudgeted` options.
[§ Budgeting and Forecasting](http://www.ledger-cli.org/3.0/doc/ledger3.html#Budgeting-and-Forecasting) [§ Budgeting and Forecasting](http://www.ledger-cli.org/3.0/doc/ledger3.html#Budgeting-and-Forecasting)
**Transaction Code**: an optional item in a transaction or posting often **Transaction Code**: an optional item in a transaction or posting often used
used to record a check number or bank code. Certain custom reports can to record a check number or bank code. Certain custom reports can report
report this code. this code.
[§ Codes](http://www.ledger-cli.org/3.0/doc/ledger3.html#Codes); [§ Codes](http://www.ledger-cli.org/3.0/doc/ledger3.html#Codes);
[§ Format Expressions](http://www.ledger-cli.org/3.0/doc/ledger3.html#Format-Expressions) [§ Format Expressions](http://www.ledger-cli.org/3.0/doc/ledger3.html#Format-Expressions)
**Transaction Metadata**: a term for comments and tags annotating a **Transaction Metadata**: a term for comments and tags annotating
transaction. Comments indented with a transaction will be stored with each a transaction. Comments indented with a transaction will be stored with
posting of a transaction. Tags are words in comments followed by colons. each posting of a transaction. Tags are words in comments followed by
Tags can be used as filters in reports and certain tags, "Payee" or colons. Tags can be used as filters in reports and certain tags, "Payee" or
"Value", may affect fields of the transaction. "Value", may affect fields of the transaction.
[§ Metadata](http://www.ledger-cli.org/3.0/doc/ledger3.html#Metadata), [§ Metadata](http://www.ledger-cli.org/3.0/doc/ledger3.html#Metadata),
[§ Applying Metadata to every matched posting](http://www.ledger-cli.org/3.0/doc/ledger3.html#Applying-metadata-to-every-matched-posting), [§ Applying Metadata to every matched posting](http://www.ledger-cli.org/3.0/doc/ledger3.html#Applying-metadata-to-every-matched-posting),
[§ Applying Metadata to the generated posting](http://www.ledger-cli.org/3.0/doc/ledger3.html#Applying-metadata-to-the-generated-posting) [§ Applying Metadata to the generated posting](http://www.ledger-cli.org/3.0/doc/ledger3.html#Applying-metadata-to-the-generated-posting)
**Transaction State**: a state of *cleared*, *pending*, or *uncleared* on **Transaction State**: a state of *cleared*, *pending*, or *uncleared* on each
each posting. The state is usually set for an entire transaction at once posting. The state is usually set for an entire transaction at once with
with a mark after the date. The marks are ***** (cleared), **!** a mark after the date. The marks are ***** (cleared), **!** (pending),
(pending), or no mark (uncleared). The interpretation of this state is up or no mark (uncleared). The interpretation of this state is up to the user,
to the user, but is typically used in bank reconcilations or but is typically used in bank reconciliations or differentiating time worked
differentiating time worked versus billed. Ledger supports reports and versus billed. Ledger supports reports and filters based on state.
filters based on state. [§ Transaction State](http://www.ledger-cli.org/3.0/doc/ledger3.html#Transaction-state);
[§ Transaction State](http://www.ledger-cli.org/3.0/doc/ledger3.html#Transaction-state); [§ Cleared Report]( http://www.ledger-cli.org/3.0/doc/ledger3.html#Cleared-Report)
[§ Cleared Report](
http://www.ledger-cli.org/3.0/doc/ledger3.html#Cleared-Report)
**Virtual Posting**: an annotation posting in a transaction, similar in form as a regular posting but not required to balance debits and **Virtual Posting**: an annotation posting in a transaction, similar in form
credits. It is often used to support as a regular posting but not required to balance debits and credits. It is
[Fund Accounting](http://en.wikipedia.org/wiki/Fund_accounting) and various reports will collate and summarize virtual postings. Virtual postings should not be often used to support
confused with virtual posting costs. [Fund Accounting](http://en.wikipedia.org/wiki/Fund_accounting) and various
[§ Virtual Postings](http://www.ledger-cli.org/3.0/doc/ledger3.html#Virtual-postings) reports will collate and summarize virtual postings. Virtual postings
[§ Working with Multiple Funds and Accounts](http://www.ledger-cli.org/3.0/doc/ledger3.html#Working-with-multiple-funds-and-accounts) should not be confused with virtual posting costs.
[§ Virtual Postings](http://www.ledger-cli.org/3.0/doc/ledger3.html#Virtual-postings)
[§ Working with Multiple Funds and Accounts](http://www.ledger-cli.org/3.0/doc/ledger3.html#Working-with-multiple-funds-and-accounts)