diff --git a/documentation/_doc.css b/documentation/_doc.css new file mode 100644 index 0000000..c7f2148 --- /dev/null +++ b/documentation/_doc.css @@ -0,0 +1,243 @@ +/* + * Copyright 2008-2017, Haiku. All rights reserved. + * Distributed under the terms of the MIT License. + * + * Authors: + * François Revol + * Stephan Aßmus + * Braden Ewing + * Humdinger + * Vincent Duvert + * Augustin Cavalier + */ + +html { + margin: 0; + padding: 0; + background: #FFF; +} +body { + color: #333333; + line-height: 1.5; + font-family: "Noto Sans", Arial, Helvetica, sans-serif; + font-size: 0.9em; + min-width: 45em; + max-width: 70em; +} +/* link colors and text decoration */ + +a:link { + font-weight: bold; + text-decoration: none; + color: #dc3c01; +} +a:visited { + font-weight: bold; + text-decoration: none; + color: #892601; +} +a:hover, a:active { + text-decoration: underline; + color: #ff4500; +} + +/* Some headers act as anchors, don't give them a hover effect */ + +h1, h2, h3, h4, h5 { + a:hover, a:active { + text-decoration: none; + color: #000; + } +} + +/* Index table */ + +table.index { + margin: 6px 6px 6px 30px; + padding: 1px; + border-width: 1px; + border-style: dotted; + border-color: #e0e0e0; + float: right; + position: relative; +} +table.index tr.heading { + background-color: #e0e0e0; + text-align: center; + font-weight: bold; + font-size: 1.1em; +} +table.index tr.index { + background-color: #eeeeee; +} +table.index td { + padding: 5px 20px; +} + +table.index a:link, table.index a:visited { + font-weight: normal; + text-decoration: none; + color: #dc3c01; +} +table.index a:hover, table.index a:active { + text-decoration: underline; + color: #ff4500; +} + +/* heading and navigation */ + +#navbar { + overflow: hidden; + background-color: #555; + position: fixed; + top: 0; + width: 100%; + z-index: 10; +} + +#navbar a { + float: left; + display: block; + color: #f2f2f2; + text-align: center; + padding: 0px 14px; + text-decoration: none; + font-size: 12px; +} + +#navbar a:hover { + background-color: #ddd; + color: black; +} + +#navbar a.active { + background-color: #D1A600; + color: white; +} + +#content { + margin-left: 20px; + margin-right: 20px; + padding-top: 5px; +} + + +hr { + margin-top: 45px; + border: dotted thin #e0e0e0; +} +h1 { + font-size: 1.6em; + border-bottom: dotted thin #e0e0e0; + margin: 45px; + text-align: center; +} +h2 { + font-size: 1.5em; + border-bottom: dotted thin #e0e0e0; + margin-top: 40px; +} +h3 { + font-size: 1.2em; + border-bottom: none; + margin-top: 30px; + margin-bottom: 0px; +} +h4 { + font-size: 1.1em; + border-bottom: none; + margin-top: 30px; + margin-bottom: 0px; +} +.key { /* Shortcut (separate with   */ + -webkit-border-radius: 3px; + -khtml-border-radius: 3px; + -moz-border-radius: 3px; + border-radius: 3px; + border-color: #c7c7c7; + border-style: solid; + border-width: 1px; + padding: 0px 2px; + background-color: #e8e8e8; + font-family: sans; + font-variant: small-caps; + font-size: 0.9em; +} +.menu { /* Menu */ + font-size: 1.0em; + font-family: serif; + font-style: italic; + color: #24225e; +} +.button { /* Button */ + font-size: 1.0em; + font-family: serif; + font-style: italic; + color: #33583c; +} +.path { /* File path */ + background-color: #e8e8e8; + font-size: 0.9em; + font-family: monospace; +} +.cli { /* Shell command or file */ + background-color: #e8e8e8; + font-size: 0.9em; + font-family: monospace; +} + +pre.terminal { /* Terminal output*/ + border-color: #ffb11f; + border-style: dotted; + border-width: thin; + margin: 0em; + padding: 1.5em; + background-color: #3a3a3a; + color: #ffb11f; +} + +tt { + background-color: #e8e8e8; +} + +td.onelinetop { + padding-right: 1em; + vertical-align: top; + white-space: nowrap; +} + +ol { + padding-left: 20px; +} + +ul { + padding-left: 14px; +} + +/* Rounded corner boxes */ +/* Common declarations */ +.box-info, .box-stop, .box-warning { + -webkit-border-radius: 10px; + -khtml-border-radius: 10px; + -moz-border-radius: 10px; + border-radius: 10px; + border-style: dotted; + border-width: thin; + border-color: 8f7200; + padding: 10px 15px 10px 80px; + margin: 15px 56px 15px 56px; + min-height: 42px; +} +.box-info { + background: #fff1bc url(./icons/info-box_32.png) 15px 15px no-repeat; +} +.box-warning { + background: #ffe992 url(./icons/warning-box_32.png) 15px 15px no-repeat; +} + +/* Images floating to the left of text */ +.floatleft { + border:none; + padding:0 1em 2em 0; + float:left +} diff --git a/documentation/en/budget.html b/documentation/en/budget.html new file mode 100644 index 0000000..74a76b7 --- /dev/null +++ b/documentation/en/budget.html @@ -0,0 +1,64 @@ + + + + + + + + + + CapitalBe's User Documentation + + + + + + +
+

Budget

+ +

If you want to have extra money, you need a budget. While you are the only one who knows what is a good choice for the amount to put into each category, Capital Be gives you the tools to make the best decisions more easily.

+ +

The budget window

+ +

There are four parts:

+
    +

  1. Category list - this lists each category, the amount set aside for it, and the period of time for which you are allocating the money, such as each week or month.

    2. +

  2. Budget editor - making changes here will change the item you've chosen in the category list.

    3. +

  3. Information box - displays information about the category selected in the category list. The information includes the biggest and smallest transactions and the average monthly spending over the past 12 months for the chosen category.

    4. +

  4. Budget summary - shows what your budget looks like over the course of a year.

    5. +
+ +

How to make a budget

+ +

When you open the Budget window for the first time, it automatically generates a budget for you, based on your spending for the past 12 months. This is only a starting point.

+ +
+

You get back to the auto-generated budget by clicking Recalculate all in the menu bar.
+This will remove any budget plans you may have entered!

+

Set all to zero in the menu bar will erase all auto-generated or manually edited values!

+ +

Click on each item in the Category list for which you want to set aside money and type in the amount in the Budget editor on the right. Unless you've seen a significant change in your financial situation in the last year, choosing an amount which is just a little more than the average is a good idea unless the amount is not expected to change.

+ +

Make sure that there is some money left over to account for unexpected expenses — 5% of your monthly income is a good start.

+ +
If you need more information than what the Information box can give, leave the Budget window open, go back to the main window, and open up the Reports window. Placed side-by-side, you can easily see where you've been and plan where you're going.
+ + +
+Previous: Menus +Next: Reports +

+
+ + diff --git a/documentation/en/images/account_new.png b/documentation/en/images/account_new.png new file mode 100644 index 0000000..96c7b89 Binary files /dev/null and b/documentation/en/images/account_new.png differ diff --git a/documentation/en/images/app_settings.png b/documentation/en/images/app_settings.png new file mode 100644 index 0000000..78bd372 Binary files /dev/null and b/documentation/en/images/app_settings.png differ diff --git a/documentation/en/images/budget.png b/documentation/en/images/budget.png new file mode 100644 index 0000000..4fcabfb Binary files /dev/null and b/documentation/en/images/budget.png differ diff --git a/documentation/en/images/categories_window.png b/documentation/en/images/categories_window.png new file mode 100644 index 0000000..4f2755a Binary files /dev/null and b/documentation/en/images/categories_window.png differ diff --git a/documentation/en/images/filter.png b/documentation/en/images/filter.png new file mode 100644 index 0000000..d5168e9 Binary files /dev/null and b/documentation/en/images/filter.png differ diff --git a/documentation/en/images/main_window.png b/documentation/en/images/main_window.png new file mode 100644 index 0000000..2fa7f6b Binary files /dev/null and b/documentation/en/images/main_window.png differ diff --git a/documentation/en/images/menu_account.png b/documentation/en/images/menu_account.png new file mode 100644 index 0000000..3d8b907 Binary files /dev/null and b/documentation/en/images/menu_account.png differ diff --git a/documentation/en/images/menu_app.png b/documentation/en/images/menu_app.png new file mode 100644 index 0000000..3c66504 Binary files /dev/null and b/documentation/en/images/menu_app.png differ diff --git a/documentation/en/images/menu_file.png b/documentation/en/images/menu_file.png new file mode 100644 index 0000000..4891a74 Binary files /dev/null and b/documentation/en/images/menu_file.png differ diff --git a/documentation/en/images/menu_tools.png b/documentation/en/images/menu_tools.png new file mode 100644 index 0000000..4802c54 Binary files /dev/null and b/documentation/en/images/menu_tools.png differ diff --git a/documentation/en/images/menu_transaction.png b/documentation/en/images/menu_transaction.png new file mode 100644 index 0000000..4292058 Binary files /dev/null and b/documentation/en/images/menu_transaction.png differ diff --git a/documentation/en/images/reconcile.png b/documentation/en/images/reconcile.png new file mode 100644 index 0000000..6769b8d Binary files /dev/null and b/documentation/en/images/reconcile.png differ diff --git a/documentation/en/images/reports.png b/documentation/en/images/reports.png new file mode 100644 index 0000000..3be46c4 Binary files /dev/null and b/documentation/en/images/reports.png differ diff --git a/documentation/en/images/schedule_transaction.png b/documentation/en/images/schedule_transaction.png new file mode 100644 index 0000000..906b0cc Binary files /dev/null and b/documentation/en/images/schedule_transaction.png differ diff --git a/documentation/en/images/scheduled_transactions.png b/documentation/en/images/scheduled_transactions.png new file mode 100644 index 0000000..da7516d Binary files /dev/null and b/documentation/en/images/scheduled_transactions.png differ diff --git a/documentation/en/images/split_transaction.png b/documentation/en/images/split_transaction.png new file mode 100644 index 0000000..283d102 Binary files /dev/null and b/documentation/en/images/split_transaction.png differ diff --git a/documentation/en/images/transaction_edit.png b/documentation/en/images/transaction_edit.png new file mode 100644 index 0000000..e342489 Binary files /dev/null and b/documentation/en/images/transaction_edit.png differ diff --git a/documentation/en/images/transaction_init.png b/documentation/en/images/transaction_init.png new file mode 100644 index 0000000..680a847 Binary files /dev/null and b/documentation/en/images/transaction_init.png differ diff --git a/documentation/en/images/transfer.png b/documentation/en/images/transfer.png new file mode 100644 index 0000000..203214b Binary files /dev/null and b/documentation/en/images/transfer.png differ diff --git a/documentation/en/menus.html b/documentation/en/menus.html new file mode 100644 index 0000000..5344b3c --- /dev/null +++ b/documentation/en/menus.html @@ -0,0 +1,162 @@ + + + + + + + + + + CapitalBe's User Documentation + + + + + + +
+ + + + +
Index
+ The app menu
+ ┗━ Categories
+ ┗━ Settings
+ The file menu
+ The account menu
+ The transaction menu
+ ┗━ Schedule a transaction
+ The tools menu
+ ┗━ Scheduled transactions +
+ +

CapitalBe's Menus

+ +

To learn about all aspects of CapitalBe, let's quickly go through all menu items, only giving a more detailed description to the ones that need explanation. Bigger topics will link to their own separate page.

+ + +

The application (icon) menu

+ +Application menu + +

The menu sporting the CapitalBe icon has all the items concerning the app in general.

+ +

Quit of course closes the application and About CapitalBe shows information about the developers etc.

+ +

Report a bug… opens the webbrowser with CapitalBe's project page where you can file issues about problems you encounter or ask for new features.

+ +

The first two items, Categories… and Settings… deserve a bit of further explanation.

+

+ + +

+index +Categories…

+ +

Every time you enter a new category when doing a transaction, it is saved and gets suggested as auto-complete when typing the next time. The Categories… window allows you to manage your categories.

+ +

The categories window

+ +

Categories are sorted into two types: Income and Spending.

+

You can select an item and Edit… its name, or Remove… it completely. In the later case, a new window opens where you have to choose another category for all the transactions that were filed under the one you're about to remove.

+ +

You can also Add… a new category, give it a unique name and choose if it's an Income category or Spending category.

+ + +

+index +Settings…

+ +

The application settings

+ +

CapitalBe's settings only have one item at the moment: the Color for negative amounts.
+All other colors are provided by the system and should work perfectly together, because they are also customized by the user to keep working together. The color for negative numbers, however, has to work on different backgrounds which could be any color.

+

When the default red color doesn't work for you, use the color picker at the top and make sure the new color works well on the different backgrounds shown in the preview at the bottom.

+ + +

+index +The file menu

+ +File menu + +

To share data with other financial software, you can Import from QIF file an Export to QIF file. Note that only the current account will be exported as QIF, so to export all your accounts you'll have to invoke the export on each one.

+

+ + +

+index +The account menu

+ +Account menu + +

With Reconcile… you can synchronize the records of your accounts to the actual bank statements. As this deserves somemore explanation, please refer to the page Reconcile.

+

You can create a New… account (see QuickStart), and Delete… the currently selected account.

+

You can Close (and Reopen) an account, which keeps all the data, but won't allow further transactions or transfers.

+

The Settings… allow changing name and currency configuration, just like when the account was created.

+

Previous and Next let you change between your account. Handy especially with the provided shortcuts ALT SHIFT ↑/↓.

+

+ + +

+index +The transaction menu

+ +Transaction menu + +

You can Edit… the currently selected transaction, same as a double-click.

+

Enter a transfer… to move money between accounts, see QuickStart for more details.

+

Delete removes the currently selected transaction.

+

Previous and Next let you move up and down the transaction list. Handy especially with the provided shortcuts ALT ↑/↓.

+

+ +

+index +Schedule this transaction…

+ +

After entering a transaction, you can decide to schedule it. That is create identical transactions (or transfers between accounts) in regular intervalls.

+ +

Schedule transaction window

+ +

The data of the transaction – payee, amount, category and memo text – aren't editable, because all the scheduled transactions will be identical.

+

Frequency sets the intervall: Monthly, Quarterly or Yearly.

+

Then you choose a Starting date and decide if the transaction will be scheduled Indefinitely of just a certin number of times.

+

Note, this feature only creates normal transactions at the set interval. After it was created, you can edit or delete a transaction like any other.

+ +

+index +The tools menu

+ +Tools menu + +

There are separate pages describing the first two items: Budget and Reports.

+

+ +

+index +Scheduled transactions

+ +

This window shows all currently active scheduled transactions:

+ +

Scheduled transactions window

+ +

The list shows all relevant information, similar to what was provided when the scheduled transaction was created, plus the date of the next scheduled payment.

+

While you cannot edit a scheduled transaction, you can Remove it.

+ +
+Previous: QuickStart +Next: Budget +

+
+ + diff --git a/documentation/en/reconcile.html b/documentation/en/reconcile.html new file mode 100644 index 0000000..62bd326 --- /dev/null +++ b/documentation/en/reconcile.html @@ -0,0 +1,60 @@ + + + + + + + + + + CapitalBe's User Documentation + + + + + + +
+

Reconcile

+ +

When it comes time to balance your checkbook, you will need to go here.

+ +

Many banks today group deposits together in one area on a statement, and expenses in another. CapitalBe does the exact same thing so you don't have to keep hunting around your statement.

+ +

Reconcile window

+ +

To reconcile your account:

+
    +
  • Enter the Starting balance and Ending balance in the top boxes with numbers from your bank statement.
    • +
  • If your bank imposed a service charge for something, such as an account maintenance fee, enter it into the Bank charges box.
    • +
  • If this account earns interest, put your monthly interest in the Interest earned box.
    • +
+ +

Now all you have to do is double-click all the items in the lists below that you find on your statement. To indicate they're now accounted for, their text gets bold.
+When the number of deposits and charges add up to the difference between the Starting balance and Ending balance amounts, you're finished.

+

If you made a mistake, you can click Reset to start over.

+

Click Reconcile when everything is in order.

+ +
Did you forget to punch something in? Do you need to correct an amount? Not a problem! Move the Reconcile window to the side and do what's needed in the main window. The Reconcile window will update itself and you can move on.
+ +

Quick balance

+ +

The Quick balance button can balance your checkbook with one click if all the deposits and charges before the statement date have cleared. When that happens, it will automatically reconcile your account, saving you all the clicking normally required to do that.

+ +
Setting the Date at the top to the day of the most recent transaction on your bank statement will help Quick balance work more often.
+ +
+Previous: Reports +

+
+ + diff --git a/documentation/en/reports.html b/documentation/en/reports.html new file mode 100644 index 0000000..3fc68be --- /dev/null +++ b/documentation/en/reports.html @@ -0,0 +1,54 @@ + + + + + + + + + + CapitalBe's User Documentation + + + + + + +
+

Reports

+ +

This can be a powerful tool for you to find out just how and where you spend your money.

+ +

The report window

+ +

Three different Reports are available:

+ +
    +
  • Income / Spending - A breakdown of your income and spending by category.
    • +
  • Total worth - How much money you have when your debts are weighed against your savings.
    • +
  • Transactions - Show all transactions in a particular category.
    • +
+ +

For any report, you can show a Subtotal for each Month, Quarter of a year, Year, or (picking None) just the total for the period of time that you have set with the Starting date and Ending date for the report.

+ +

Reports can be run on just certain Categories or Accounts.
+If you hold ALT while clicking on items of a list, you can select multiple items. You select a range of items by holding SHIFT and clicking on the list.
+If you want to select all, click on any item in the list and then press ALT A.

+ + +
+Previous: Budget +Next: Reconcile +

+
+ + diff --git a/documentation/en/start.html b/documentation/en/start.html new file mode 100644 index 0000000..1a6308c --- /dev/null +++ b/documentation/en/start.html @@ -0,0 +1,171 @@ + + + + + + + + + + CapitalBe's User Documentation + + + + + + +
+ + + + +
Index
+ Create accounts
+ Enter transactions
+ ┗━ Split transactions
+ Transfer between accounts
+ Filtering the list +
+ +

CapitalBe's User Documentation

+ +Big CapitalBe icon + +

CapitalBe is an application to keep track of your personal finances. It lets you manage all the transactions of your accounts, create various reports and assists you drawing up a budget. It offers im- and export of files in the popular QIF format to share data with other finance software packages.

+

+ + +

Quick start

+ +

Let's have a quick look at the main window before we go through a quick start, setting up accounts and doing some transactions.

+ +

CapitalBe's main window

+ +
    +
  1. At the top left is a list of all your Accounts.
    2. +
  2. Below that is a Filter section to filter the list of transactions.
    3. +
  3. Then comes a QuickTracker that shows the current balance of all accounts.
    4. +
  4. To the right is a list of all Transactions.
    5. +
  5. Below it follow the text boxes for the data entry for a new transaction that is created by hitting Enter.
    6. +
+ +

When you see a you can click it to get help on the related topic.

+ +

+index +Create accounts

+ +

Let's start by creating a new account. You're prompted to set one up when there isn't one already – like when first launching CapitalBe – or you initiate it yourself by clicking the menu item Account | New….

+ +

Creating new accounts

+ +

First you Name your new account, here "Bank account #1".

+ +

By default, CapitalBe uses your system settings (configured with Haiku's Locale preferences) for the currency settings and formatting. If you have accounts that differ from that, you can untick the checkbox Use system currency format to see additional options:

+ +

You can choose a currency Symbol, decide to have it Appear before amount (otherwise it's shown after), and set the number of Decimals to use.

+ +

You see a preview of this custom setting as the bold Currency format label of this setting box.

+ +

In order to show transfers later on, let's create a second account named "Cash account".

+ + +

+index +Enter transactions

+ +

Now we start entering transactions, using those text boxed below the list of transactions.

+ +

Initial transaction

+ +

Filling Date, Payee and Amount is mandatory, of course. Note, that you always enter positive amounts, the category decides if it will be added or substracted.

+ +

There are some features that help entering data.

+
    +
  • Use TAB to jump to the next text field, SHIFT TAB to go back to the previous one. ENTER completes the transaction.
    • +
  • All entered categories and payees are saved and CapitalBe tries to auto-complete them while you are typing.
    • +
  • When the date box has focus ↑/↓ in/decreases the day, SHIFT ↑/↓ in/decreases the month, and Page↑/Page↓ in/decreases the year.
    • +
  • The little icon beside the date box opens a calendar window to conveniently choose a date.
    • +
  • The little icon beside the category box opens a menu to choose from your categories.
    • +
+ +

Normally you also enter a Category. If you don't, a little window pops up where you have to choose the type of transaction: Income or Spending.

+ +

The Memo field is not mandatory, but normally it makes sense to add a short description. The text is limited to 63 characters.

+ +

For this quick start example, we create a transaction to add an initial balance for our bank account:

+ + + + + + +
Date:01.01.2024
Payee:Init
Amount:1.200,00 €
Category:We leave it empty and choose "Income" later in the pop-up window
Memo:Initial balance
+ +

If you need to edit a transaction, just double-click it and it opens in an editing window:

+ +

Editing a transaction

+ +

This is also how you enter a transaction for items with different categories: First enter a normal transaction, then edit it, and tick Show split to create a "split transaction".

+ + +

Split transactions

+ +

The normal transaction editing window gets extended to split the transaction into several categories:

+ +

Split transaction window

+ +

With Add item you split the transaction into one more category. Remove item removes the selected split-transaction. The Total adds up all the split-transactions. At the end it must be equal to the original Amount at the top.

+ +

To have CapitalBe help with keeping the correct total over all splits, it's best to do it like this:

+
    +

  1. Select the top item in the list at the bottom – which is identical to the original transaction – and change the amount to what should be booked under the original category.

    2. +

  2. Click Add item and a new item with the remaning amount is added to the list.

    3. +

  3. Choose a category for the new item and add some info in the memo text field.

    4. +

  4. Continue to split the transaction into more categories until you're satisfied.

    5. +

  5. Hit Enter.

    6. +
+ +

+index +Transfer money between accounts

+ +

Transfer between accounts

+ +


Let's put some money in our pocket by transfering some from the bank account to the cash account. For that, select the menu Transaction | Enter a transfer…

+ +

It's pretty straight forward: select the source account from the list on the left and the destination on the right. Set the date, amount and optionally enter a memo.

+ +

After clicking OK you'll find the created transactions in the lists for those two accounts, substracting the amount from one, adding to the other.

+ +

Filtering the transaction list

+ +Filter section + +

You can filter the transaction list according to several criteria.

+

Choose the Period (e.g. This month, Last quarter etc.) to limit the list to that time frame.
+Enter a term in Payee, Category or Memo and only transactions containing those letters are shown.
+You can set an Amount and only transaction ≦, ＝ or ≧ appear in the list.

+ +

Clear resets the filter.
+Filter starts the filtering, though you'll find that pressing TAB to jump to the next text field or choosing from the popup menus also triggers an update of the filtered list.

+

+ +


+

This should be enough to get you started. The following pages describe more features, like settings, scheduled transactions and the tools "Report" and "Budget".

+ +
+Next: Menus +

+
+ + diff --git a/documentation/icons/capitalbe-logo_64.png b/documentation/icons/capitalbe-logo_64.png new file mode 100644 index 0000000..3baf956 Binary files /dev/null and b/documentation/icons/capitalbe-logo_64.png differ diff --git a/documentation/icons/help_16.png b/documentation/icons/help_16.png new file mode 100644 index 0000000..eed72a9 Binary files /dev/null and b/documentation/icons/help_16.png differ diff --git a/documentation/icons/info-box_32.png b/documentation/icons/info-box_32.png new file mode 100644 index 0000000..f28a92e Binary files /dev/null and b/documentation/icons/info-box_32.png differ diff --git a/documentation/icons/up.png b/documentation/icons/up.png new file mode 100644 index 0000000..7c639e8 Binary files /dev/null and b/documentation/icons/up.png differ diff --git a/documentation/icons/warning-box_32.png b/documentation/icons/warning-box_32.png new file mode 100644 index 0000000..73c669b Binary files /dev/null and b/documentation/icons/warning-box_32.png differ