-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
65 additions
and
24 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,49 +1,90 @@ | ||
| Converts the coin database into an HTML doc with a single page, interactive JS app for viewing. | ||
| Check out the [examples/yearly](https://mkobetic.github.io/coin/). | ||
| Converts the coin database into an HTML doc with an embedded single page, interactive JS app for viewing. No server needed, just open the file in any browser. | ||
| Check out [examples/yearly](https://mkobetic.github.io/coin/). | ||
|
|
||
|  | ||
|
|
||
| Account hierarchy nav on the left, segregated by account type (`Assets`, `Income`, `Expenses`, `Liabilities`, `Equity`). | ||
|
|
||
| Clicking a specific account restricts the detail view on the right to that account's hierarchy. | ||
| Currently selected account is shown as a heading above the details view. The individual names in the heading can be clicked to select the account represented by the name (this allows climbing up the account parent chain conveniently). | ||
| Currently selected account is shown as a heading above the details view. Individual segments of the account name in the heading can be clicked to select the parent account represented by that name, this allows climbing up the account parent chain conveniently. | ||
|
|
||
| Details of the selected account are shown on the right with different presentation options (`Balances`, `Register`, `Balances - Chart`, ...). | ||
| The details show account postings/balances restricted to selected time range, controlled by the `From/To` inputs. | ||
| The `Closed Accounts` checkbox controls whether closed accounts are excluded (i.e. accounts closed before the `To` date). | ||
|
|
||
| Details of the selected account are shown on the right with different presentation options (`Register`, `Chart`, ...). | ||
| The details show account transactions restricted to selected time range, controlled by the `From/To` inputs. | ||
| The `Closed Accounts` checkbox controls whether closed accounts are excluded from the account list. | ||
|  | ||
|
|
||
| # Balances View | ||
|
|
||
| Lists the balances of the selected account and its sub-accounts as of the `To` date. `Balance` is the balance of the account itself, `Total` sums up balances of the account and its sub-accounts. | ||
|
|
||
| # Register View | ||
|
|
||
| Shows the transaction details in tabular form | ||
| Shows the account transaction details in tabular form. `Account` column shows the other side of the transaction. `Balance` is the balance of the account as of that posting. `Cum.Total` shows the running total of the listed transaction amounts. | ||
|
|
||
|  | ||
|  | ||
|
|
||
| ## SubAccounts | ||
| ### SubAccounts | ||
|
|
||
| When un-checked only transactions for the selected account are shown. | ||
| When checked transactions of the account and any sub-accounts are shown. | ||
| When checked transactions of the account and any sub-accounts are shown. Sub-account is indicated in the additional `SubAccount` column. | ||
|
|
||
|  | ||
|
|
||
|  | ||
| ### Show Notes | ||
|
|
||
| ## Aggregate | ||
| When `Show Notes` is checked, each transaction is displayed with an additional row containing the transaction notes. | ||
|
|
||
| When `None`, the individual transactions are shown. | ||
| When not `None`, the transactions are aggregated by the selected aggregation period (`Weekly`, `Monthly`, `Quarterly`, `Yearly`). | ||
| When aggregated with sub-accounts, the `SubAccount Max` option controls how many "top" sub-accounts should be shown; the rest of the sub-accounts are combined into the "Other" column. Top here means the sub-accounts with the highest average transaction value across the time range. | ||
| ### Show Location | ||
|
|
||
|  | ||
| When `Show Location` is checked, each transaction is displayed with an additional column showing the file location of the transaction in the path:lineNr format, e.g. examples/yearly/2010.coin:17; supported by some editors for file navigation. | ||
|
|
||
| ## Aggregation | ||
|
|
||
| When `Aggregate` is not `None`, the transactions are aggregated by the selected aggregation period (`Weekly`, `Monthly`, `Quarterly`, `Yearly`). | ||
|
|
||
|  | ||
|
|
||
| ### Aggregation Style | ||
|
|
||
| When transactions are being aggregated, the aggregation is performed using one of two styles. `Flows` style sums the incoming/outgoing amounts for the period, and is generally useful for Income and Expenses accounts. `Balances` style shows the final account balance at the end of the period, and is generally useful for Assets and Liabilities accounts. | ||
| When transactions are being aggregated, the aggregation is performed using one of two styles. `Flows` style sums the incoming/outgoing amounts for the period, and is generally interesting for Income and Expenses accounts. `Balances` style shows the final account balance at the end of the period, and is generally useful for Assets and Liabilities accounts. | ||
|
|
||
|  | ||
|
|
||
| ### Aggregation Max SubAccounts | ||
|
|
||
| When aggregating with sub-accounts, the `SubAccount Max` option controls how many "top" sub-accounts should be shown; the rest of the sub-accounts are combined into the "Other" column. Top here means the sub-accounts with the highest average transaction value across the time range. | ||
|
|
||
|  | ||
|
|
||
| The `Total` column sums up the amounts in the row. The `Cum.Total` is the running total of the rows. | ||
|
|
||
| ### Aggregation Details | ||
|
|
||
| When aggregating each row represents a group of postings. If aggregating with subaccounts each column in the row represents different group of postings. Clicking the amount field opens a `Details` view that lists top 20 postings by the absolute value of their amounts. This can be useful to find any outliers. | ||
|
|
||
|  | ||
|
|
||
| # Balanaces - Chart View | ||
|
|
||
| Balances chart can be useful with a larger account hierarchy. It provides visual representation of the proportions of the individual account. | ||
|
|
||
|  | ||
|
|
||
| The `Depth` controls how deep down the account hierarchy it should go. | ||
|
|
||
| Clicking a rectangle makes the corresponding account the selected account, this can be useful when exploring larger account structure. | ||
| A hover tooltip shows the full balance details when the text in the chart is clipped due to the rectangle layout. | ||
|
|
||
| # Aggregated Register - Chart View | ||
|
|
||
| ## Show Notes | ||
| This chart is a visual analog of the tabular Register view when aggregating with sub-accounts. The meaning of the available options is the same as for the Register aggregations. | ||
|
|
||
| When Aggregate is set to None, and Show Notes is checked, each transaction is displayed with an additional row containing the transaction notes. | ||
|  | ||
|
|
||
| ## Show Location | ||
| A hover tooltip shows the amount that each rectangle represents. As with aggregated Register view, clicking a rectangle shows the top 20 posting details | ||
|
|
||
| When Aggregate is set to None, and Show Location is checked, each transaction is displayed with an additional column showing the file location of the transaction in the path:lineNr format, e.g. examples/yearly/2010.coin:17, supported by some editors for navigation. | ||
|  | ||
|
|
||
| # Chart View | ||
|
|
||
| Chart shows aggregated transactions (including sub-accounts) by the selected aggregation period as a bar chart. The meaning of the available options is the same as for the Register aggregations. | ||
|
|
||
|  |