Warning, /office/skrooge/doc/index.docbook is written in an unsupported language. File is not indexed.
0001 <?xml version="1.0" ?>
0002 <!-- SPDX-FileCopyrightText: 2022 S. MANKOWSKI stephane@mankowski.fr -->
0003 <!-- SPDX-FileCopyrightText: 2022 G. DE BURE support@mankowski.fr -->
0004 <!-- SPDX-License-Identifier: GPL-3.0-or-later -->
0005 <!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [
0006 <!ENTITY skrooge '<application>Skrooge</application>'> <!--remove when skrooge requires kdoctools 5.13-->
0007 <!ENTITY % addindex "IGNORE">
0008 <!ENTITY % English "INCLUDE"><!-- change language only here -->
0009 <!ENTITY homepage "https://www.kde.org/applications/office/skrooge/">
0010 ]>
0011
0012 <book id="skrooge" lang="&language;">
0013 <title>The &skrooge; Handbook</title>
0014
0015 <bookinfo>
0016
0017 <authorgroup>
0018
0019 <author>
0020 <firstname>Stéphane</firstname>
0021 <surname>MANKOWSKI</surname>
0022 <affiliation>
0023 <address><email>stephane@mankowski.fr</email></address>
0024 </affiliation>
0025 </author>
0026
0027 <othercredit role="developer">
0028 <firstname>Guillaume</firstname>
0029 <surname>DE BURE</surname>
0030 <affiliation>
0031 <address><email>guillaume.debure@gmail.com</email></address>
0032 </affiliation>
0033 <contrib>Developer</contrib>
0034 </othercredit>
0035 <!-- TRANS:ROLES_OF_TRANSLATORS -->
0036 </authorgroup>
0037
0038 <copyright>
0039 <year>2007</year>
0040 <year>2008</year>
0041 <year>2009</year>
0042 <year>2010</year>
0043 <year>2011</year>
0044 <year>2012</year>
0045 <year>2013</year>
0046 <year>2014</year>
0047 <year>2015</year>
0048 <year>2016</year>
0049 <year>2017</year>
0050 <year>2018</year>
0051 <year>2019</year>
0052 <year>2020</year>
0053 <year>2021</year>
0054 <year>2022</year>
0055 <year>2023</year>
0056 <year>2024</year>
0057 <holder>Stéphane MANKOWSKI</holder>
0058 <holder>Guillaume DE BURE</holder>
0059 </copyright>
0060
0061 <legalnotice>&FDLNotice;</legalnotice>
0062
0063 <date>2020-04-11</date>
0064 <releaseinfo>&skrooge; 2.22.1</releaseinfo>
0065
0066 <abstract>
0067 <para>
0068 This document is a handbook for using &skrooge;, a personal finances manager application.
0069 </para>
0070 </abstract>
0071
0072 <keywordset>
0073 <keyword>KDE</keyword>
0074 <keyword>extragear</keyword>
0075 <keyword>office</keyword>
0076 <keyword>skrooge</keyword>
0077 <keyword>personal finances</keyword>
0078 </keywordset>
0079
0080 </bookinfo>
0081
0082 <chapter id="introduction">
0083 <title>Introduction</title>
0084
0085 <sect1 id="skrooge-intro">
0086 <title>&skrooge;</title>
0087
0088 <para>
0089 &skrooge; is an application for managing your personal finances. It can keep track of your incomes and expenses across several accounts, in several currencies. It has all the features you should expect from such a tool, such as categories, scheduled transactions, graphical reporting and stocks management. It also has some less common features, such as fast transaction editing, search as you type, refund trackers and customizable attributes.
0090 </para>
0091
0092 <screenshot>
0093 <screeninfo>&skrooge; displaying pie charts of expenses per category</screeninfo>
0094 <mediaobject>
0095 <imageobject>
0096 <imagedata fileref="reports.png" format="PNG"/>
0097 </imageobject>
0098 <textobject><phrase>&skrooge; displaying pie charts of expenses per category</phrase></textobject>
0099 </mediaobject>
0100 </screenshot>
0101
0102
0103 <sect2 id="what-skrooge-is">
0104 <title>What &skrooge; Is</title>
0105
0106 <para>
0107 &skrooge; is an Open Source personal finances manager built on &kde; frameworks. It is intended to be used by individuals who want to keep track of their incomes, expenses and investments.
0108 </para>
0109
0110 </sect2>
0111
0112 <sect2 id="what-skrooge-is-not">
0113 <title>What &skrooge; Is Not</title>
0114
0115 <para>
0116 &skrooge; is not a professional tool. It doesn't have functions expected from a software you would use to run a small business. It doesn't manage taxes, doesn't use double-entry system, or any advanced financial functions.
0117 </para>
0118 <para>If you were looking for such a tool, you may want to look at Kmymoney or Kraft instead.</para>
0119
0120 </sect2>
0121 </sect1>
0122
0123 <sect1 id="terminology">
0124 <title>Terminology</title>
0125
0126 <sect2 id="terminology-document">
0127 <title>Document</title>
0128 <para>
0129 A document is a &skrooge; file (extension .skg). It can contain an indefinite number of <link linkend="terminology-account">accounts</link>. You can use one document to manage all your accounts at once.
0130 </para>
0131 </sect2>
0132
0133 <sect2 id="terminology-account">
0134 <title>Account</title>
0135 <para>A &skrooge; account is similar to your bank account. For example, if you own one personal account, your wife has a personal account, and you both have a joint account, you can create these three accounts in &skrooge;. Every time you spend or earn some money, you register an <link linkend="terminology-transaction">transaction</link>, and indicate the account this transaction was made on.
0136 </para>
0137 </sect2>
0138
0139 <sect2 id="terminology-transaction">
0140 <title>Transaction</title>
0141 <para>An transaction is either a credit or debit to one of your accounts. If you assign a <link linkend="terminology-category">category</link> or <link linkend="trackers">tracker</link> to transactions, you can analyze how you spend your money.</para>
0142
0143 <sect3 id="terminology_standard_transaction">
0144 <title>Standard Transaction</title>
0145 <para>A standard transaction is the basic transaction in &skrooge;. For example, "Today, spent 20€ from credit card for groceries".</para>
0146 <para></para>
0147 </sect3>
0148
0149 <sect3 id="terminology_split_transaction">
0150 <title>Split Transaction</title>
0151 <para>A split transaction is a transaction for which the total amount is split over several <link linkend="terminology-category">categories</link>, dates and/or <link linkend="trackers">trackers</link>. For example, "Yesterday, spent 100€ at the supermarket, of which 60€ were for food, and 40€ for clothes".</para>
0152 </sect3>
0153
0154 <sect3 id="terminology_transfer">
0155 <title>Transfer</title>
0156 <para>A transfer in &skrooge; records the movement of a quantity of money from one of your &skrooge; accounts to another.</para>
0157 <para>This must not be confused with the payment mode chosen: if you made a transfer, for example using your bank's website, to someone else's account, this is not a transfer transaction, because &skrooge; doesn't know about that other person's account. It is a <link linkend="terminology_standard_transaction">standard transaction</link> with transfer as its payment mode.</para>
0158 <para>Read the <link linkend="transfer">transfer section</link> if things are still unclear.</para>
0159 </sect3>
0160
0161 <sect3 id="terminology_validated_transaction">
0162 <title>Validated Transaction</title>
0163 <para>When you <link linkend="import">import</link> transactions from your financial institution into &skrooge;, they are not considered valid right away and appear in blue. You need to manually validate them. Such validated transactions will no longer appear blue.</para>
0164 <para>Note that it is possible to automatically validate transactions on import, by turning on the corresponding option in the <link linkend="settings">settings</link>.</para>
0165 </sect3>
0166
0167 <sect3 id="terminology_marked_transaction">
0168 <title>Marked Transaction</title>
0169 <para>During the <link linkend="reconciliation">reconciliation process</link>, you mark all transactions in &skrooge; that appear in the corresponding account position. Such marked transactions display a half-filled square (or something else depending on your kde theme) in the Status column of an transactions view. A marked transaction is not <link linkend="terminology_checked_transaction">Checked</link> until you complete reconciliation.</para>
0170 </sect3>
0171
0172 <sect3 id="terminology_checked_transaction">
0173 <title>Checked Transaction</title>
0174 <para>When all transactions on your account's position have been marked in &skrooge;, you can complete the reconciliation process. &skrooge; then turns all <link linkend="terminology_marked_transaction">Marked</link> transactions into Checked Transactions, which display a filled square in the Status column of an transactions view.</para>
0175 </sect3>
0176
0177 </sect2>
0178
0179 <sect2 id="terminology-category">
0180 <title>Category</title>
0181 <para>A category is basically a class of transactions. Some classic examples include "Food", "Taxes", and "Salary". A category can contain other categories: it is a hierarchical structure. For example, category "transport" can contain categories "bus", "car" or "plane". &skrooge; can handle an infinite number of categories.
0182 </para>
0183 </sect2>
0184
0185 <sect2 id="terminology-unit">
0186 <title>Unit</title>
0187 <para>A unit in &skrooge; can be anything that has a value. Examples:
0188
0189 <itemizedlist>
0190 <listitem><para>Currency
0191 <itemizedlist>
0192 <listitem><para>$ (US Dollar)</para></listitem>
0193 <listitem><para>€ (euro)</para></listitem>
0194 <listitem><para>£ (Sterling Pound)</para></listitem>
0195 </itemizedlist>
0196 </para>
0197 </listitem>
0198 <listitem><para>Stock or index
0199 <itemizedlist>
0200 <listitem><para>GOOG (Google)</para></listitem>
0201 <listitem><para>NASDAQ</para></listitem>
0202 </itemizedlist>
0203 </para>
0204 </listitem>
0205 <listitem><para>Personal property
0206 <itemizedlist>
0207 <listitem><para>Your house</para></listitem>
0208 <listitem><para>Your car</para></listitem>
0209 </itemizedlist>
0210 </para>
0211 </listitem>
0212 </itemizedlist>
0213
0214 </para>
0215 </sect2>
0216 </sect1>
0217 </chapter>
0218
0219 <chapter id="main-concepts">
0220 <title>Main concepts</title>
0221
0222 <sect1 id="user_interface">
0223 <title>User Interface</title>
0224 <para>
0225 The &skrooge; window is composed of a main area, surrounded by docks, and a status bar. Docks can be closed and reopened, and positioned left or right of the main area.
0226 </para>
0227
0228 <sect2 id="main_area">
0229 <title>The main area</title>
0230 <para>
0231 This is where &skrooge; will display the information you are interested in. It can contain <link linkend="multi-tabs">many tabs</link>, each one with the view you assigned to it.
0232 </para>
0233 </sect2>
0234
0235 <sect2 id="docks">
0236 <title>Docks</title>
0237 <para>
0238 Docks can be found in many &kde; applications. They are a subpart of an application window, and can be relocated, stacked, closed, or even detached from the main window.
0239 </para>
0240
0241 <para>
0242 Some examples of docks layout:
0243 </para>
0244
0245 <informaltable>
0246 <tgroup cols="3">
0247 <tbody>
0248 <row>
0249 <entry>
0250 <inlinemediaobject>
0251 <imageobject>
0252 <imagedata fileref="docks_left_right.png"/>
0253 </imageobject>
0254 </inlinemediaobject>
0255 </entry>
0256 <entry>
0257 <inlinemediaobject>
0258 <imageobject>
0259 <imagedata fileref="docks_detached.png"/>
0260 </imageobject>
0261 </inlinemediaobject>
0262 </entry>
0263 <entry>
0264 <inlinemediaobject>
0265 <imageobject>
0266 <imagedata fileref="docks_stacked.png"/>
0267 </imageobject>
0268 </inlinemediaobject>
0269 </entry>
0270 </row>
0271 </tbody>
0272 </tgroup>
0273 </informaltable>
0274
0275 <para>
0276 &skrooge; docks are:
0277 <itemizedlist>
0278 <listitem><para><link linkend="page_chooser">The page chooser</link></para></listitem>
0279 <listitem><para><link linkend="bookmarks">The bookmark list</link></para></listitem>
0280 <listitem><para><link linkend="undo_redo">The undo / redo browser</link></para></listitem>
0281 <listitem><para><link linkend="property_editor">The property editor</link></para></listitem>
0282 <listitem><para><link linkend="message_list">The messages list</link></para></listitem>
0283 </itemizedlist>
0284 </para>
0285 </sect2>
0286
0287 <sect2 id="page_chooser">
0288 <title>Page Chooser</title>
0289 <para>
0290 The page chooser is a dock where you can select the view to be displayed, either in the current tab or in a new tab. To open in a new tab, hold the &Ctrl; key while clicking on the selected view.</para><tip><para>You can customize this list by using the contextual menu on this list.</para></tip>
0291
0292 <screenshot>
0293 <mediaobject>
0294 <imageobject><imagedata fileref="context_chooser.png" format="PNG"/></imageobject>
0295 <textobject><phrase>The page chooser</phrase></textobject>
0296 </mediaobject>
0297 </screenshot>
0298
0299 <para>Each context will be described in a specific chapter in this handbook.</para>
0300 </sect2>
0301
0302 <sect2 id="bookmarks">
0303 <title>Bookmarks</title>
0304 <para>Consider a situation where you need to customize the transactions view on a "per-account" basis. Each account would be displayed in its own tab, maybe with different columns in each table. The aforementioned method will not work, as it applies on all tabs with the same type.
0305 </para>
0306 <para>The solution here is to save each individual tab as a Bookmark. Much like in a web browser, bookmarks can be organized in a hierarchy of bookmark folders that you can visualize in the Bookmark Browser, as shown below:</para>
0307
0308 <screenshot>
0309 <mediaobject>
0310 <imageobject><imagedata fileref="bookmarks_browser.png" format="PNG"/></imageobject>
0311 <textobject><phrase>The bookmarks browser</phrase></textobject>
0312 </mediaobject>
0313 </screenshot>
0314
0315 <para>To create a bookmark, select a page from the <link linkend="page_chooser">page chooser</link> you want to bookmark, and customize its content to your liking. When finished, in the Bookmarks <link linkend="docks">dock</link>, bring up the contextual menu, and select <menuchoice><guimenu>Bookmark current page</guimenu></menuchoice>.</para>
0316
0317 <para>Each bookmark or bookmark folder can be "autostarted", &ie; it will be automatically opened when starting &skrooge; in the order of the bookmarks. This way, you can fully customize the default &skrooge; layout.</para>
0318 <para>You can select the text and icon you want for each bookmark or bookmark folder.</para>
0319 </sect2>
0320
0321 <sect2 id="undo_redo">
0322 <title>Undo / Redo</title>
0323 <para>
0324 &skrooge; manages undo/redo in a rather classic fashion, except that you can undo or redo any action, even if it was made several days ago. As per default <link linkend="settings">settings</link>, the history is not cleared upon closing &skrooge; (you can change this behaviour in the <link linkend="settings">settings</link>), which means you could undo virtually everything up to the document creation.
0325 </para>
0326 <para>
0327 In order to limit the impact on filesize, &skrooge; is configured by default to keep a history of 50 entries. You can change this value in the <link linkend="settings">settings</link>.
0328 </para>
0329 <para>
0330 &skrooge; has a <link linkend="docks">dock</link> that lists all undoable actions.
0331 </para>
0332
0333 <screenshot>
0334 <mediaobject>
0335 <imageobject><imagedata fileref="history_browser.png" format="PNG"/></imageobject>
0336 <textobject><phrase>The history browser</phrase></textobject>
0337 </mediaobject>
0338 </screenshot>
0339
0340 <para>
0341 The history browser shows three columns:
0342 </para>
0343
0344 <itemizedlist>
0345 <listitem>
0346 <para>
0347 an icon showing the state of the action. A yellow counter clockwise arrow <inlinemediaobject><imageobject><imagedata fileref="edit-undo.png" format="PNG"/></imageobject></inlinemediaobject> means the action is undoable. A green clockwise icon <inlinemediaobject><imageobject><imagedata fileref="edit-redo.png" format="PNG"/></imageobject></inlinemediaobject> means the action is redoable.
0348 </para>
0349 </listitem>
0350
0351 <listitem>
0352 <para>
0353 the description of the action
0354 </para>
0355 </listitem>
0356
0357 <listitem>
0358 <para>
0359 the date when the action was made
0360 </para>
0361 </listitem>
0362
0363 <listitem>
0364 <para>
0365 a disk icon <inlinemediaobject><imageobject><imagedata fileref="document-save.png" format="PNG"/></imageobject></inlinemediaobject> means this action corresponds to a saved state, &ie; the document was saved right after this action.
0366 </para>
0367 </listitem>
0368 </itemizedlist>
0369
0370 <para>
0371 To undo an undoable transaction, or redo a redoable transaction, double click on it.
0372 </para>
0373 </sect2>
0374
0375 <sect2 id="property_editor">
0376 <title>Property Editor</title>
0377 <para> One of the uncommon features of &skrooge; is the ability to add custom properties to any object. For example, you may want to add the name and phone number of a bank employee to an account, because they are your contact. Another example is attaching a file to a transaction, like an invoice scan.
0378 </para>
0379 <para>
0380 This can be achieved using the property editor, which is a <link linkend="docks">dock</link> of its own.
0381 </para>
0382
0383 <screenshot>
0384 <mediaobject>
0385 <imageobject><imagedata fileref="property_editor.png" format="PNG"/></imageobject>
0386 <textobject><phrase>The property editor, with an attachment</phrase></textobject>
0387 </mediaobject>
0388 </screenshot>
0389
0390 <para>
0391 When this dock is visible, it will display the custom properties of the selected object (For: Selection) or of all objects (For: All), whether it is an account, a transaction, category, unit, etc. This dock allows the user to create, update or delete properties.
0392 </para>
0393
0394 <para>
0395 A property can be:
0396 </para>
0397 <itemizedlist>
0398
0399 <listitem>
0400 <para>
0401 A simple string
0402 </para>
0403 </listitem>
0404
0405 <listitem>
0406 <para>
0407 A copied file regardless of format (.odt, .png, .pdf, …).
0408 This means that the file is copied into the &skrooge; document.
0409 This file can be opened from &skrooge; by clicking the appropriate button.
0410 Take care, as all modifications of the original file are not replicated in the version saved in &skrooge; document.
0411 </para>
0412 </listitem>
0413
0414 <listitem>
0415 <para>
0416 A link to an existing file whatever the format (odt, png, pdf, …).
0417 It means that the file is not copied into the &skrooge; document but just linked.
0418 This file can be opened from &skrooge; by clicking on the appropriate button.
0419 </para>
0420 </listitem>
0421
0422 <listitem>
0423 <para>
0424 A link to an http page, for example, the website of your bank.
0425 </para>
0426 </listitem>
0427 </itemizedlist>
0428 <para>
0429 Added properties can be displayed as a column on <link linkend="tables">tables</link>.
0430 </para>
0431 </sect2>
0432
0433 <sect2 id="message_list">
0434 <title>Message list</title>
0435 <para>
0436 This dock allows you to see all messages displayed.</para>
0437
0438 <screenshot>
0439 <mediaobject>
0440 <imageobject><imagedata fileref="messages.png" format="PNG"/></imageobject>
0441 <textobject><phrase>The messages list</phrase></textobject>
0442 </mediaobject>
0443 </screenshot>
0444
0445 <para>Each context will be described in a specific chapter in this handbook.</para>
0446 </sect2>
0447
0448 <sect2 id="multi-tabs">
0449 <title>Multiple Tabs</title>
0450
0451 <screenshot>
0452 <mediaobject>
0453 <imageobject><imagedata fileref="multi_tabs.png" format="PNG"/></imageobject>
0454 <textobject><phrase>&skrooge; showing several tabs</phrase></textobject>
0455 </mediaobject>
0456 </screenshot>
0457
0458 <para>&skrooge; can display several tabs. You can add as many tabs as you want, each one containing the information you need. The above screenshot shows 4 tabs (accounts, transactions, and two graphs).</para>
0459 </sect2>
0460
0461 <sect2 id="editing_panels">
0462 <title>Editing Panels</title>
0463 <para>In most &skrooge; views, you edit items in an editing panel located at the bottom of the page.</para>
0464
0465 <screenshot>
0466 <mediaobject>
0467 <imageobject><imagedata fileref="editing_panel_buttons.png" format="PNG"/></imageobject>
0468 <textobject><phrase>Buttons for showing or hiding the Transactions editing panel.</phrase></textobject>
0469 </mediaobject>
0470 </screenshot>
0471
0472 <para>When a view has more than one editing mode, buttons let you choose between them. In the above screenshot, there are four buttons to choose different editing modes for <link linkend="transactions">Transactions</link>: "Standard", "Split", "Transfer" and "Shares". In order to preserve maximum space for visualizing information, especially on small screens, you can hide or show some views' editing panel. In the above screenshot, if you click the button for the current mode to deselect it, the editing panel becomes hidden.</para>
0473
0474 <para>In editing panels, all numerical fields are interpreted. This means that you can enter mathematical expressions such as:
0475 <itemizedlist>
0476 <listitem><para>5*3+10</para></listitem>
0477 <listitem><para>5*(3+10)</para></listitem>
0478 <listitem><para>Math.sin(10)</para></listitem>
0479 </itemizedlist>
0480 </para>
0481 </sect2>
0482
0483 <sect2 id="tables">
0484 <title>Tables</title>
0485 <para>In &skrooge;, all tables are customizable. Bring up the table's context menu, by right-clicking on the column header or clicking the settings icon in the table header - you will see a menu appear, as described in more detail below:</para>
0486
0487 <screenshot>
0488 <mediaobject>
0489 <imageobject><imagedata fileref="table_menu.png" format="PNG"/></imageobject>
0490 <textobject><phrase>Customizing a table</phrase></textobject>
0491 </mediaobject>
0492 </screenshot>
0493
0494 <variablelist>
0495 <varlistentry>
0496 <term><menuchoice><guimenu>Columns</guimenu></menuchoice></term>
0497 <listitem>
0498 <para>Customize the columns appearance.</para>
0499 <variablelist>
0500 <varlistentry>
0501 <term><menuchoice><guimenu>View Appearance</guimenu></menuchoice></term>
0502 <listitem>
0503 <para>Use a predefined set of columns. The "default" column usually shows all columns. Other predefined sets may exist on a "per-table" basis.</para>
0504 </listitem>
0505 </varlistentry>
0506 <varlistentry>
0507 <term><menuchoice><guimenu>Resize to Content</guimenu></menuchoice></term>
0508 <listitem><para>Resize all columns to fit the content.</para></listitem>
0509 </varlistentry>
0510 <varlistentry>
0511 <term><menuchoice><guimenu>Auto Resize</guimenu></menuchoice></term>
0512 <listitem><para>When activated, you will not be able to manually resize columns. &skrooge; will do it automatically based on the columns content.</para></listitem>
0513 </varlistentry>
0514 <varlistentry>
0515 <term><guimenu>List of displayed columns</guimenu></term>
0516 <listitem><para>Shows the list of all columns that can be displayed for this table. The ones currently displayed are ticked. Untick to hide a column, tick to show. The added <link linkend="property_editor">properties</link> can be selected to be displayed as a column.</para></listitem>
0517 </varlistentry>
0518 </variablelist>
0519 </listitem>
0520 </varlistentry>
0521
0522 <varlistentry>
0523 <term><menuchoice><guimenu>Group by</guimenu></menuchoice></term>
0524 <listitem>
0525 <para>Choose how to group the lines.</para>
0526 <variablelist>
0527 <varlistentry>
0528 <term><menuchoice><guimenu>None</guimenu></menuchoice></term>
0529 <listitem>
0530 <para>No grouping.</para>
0531 </listitem>
0532 </varlistentry>
0533 <varlistentry>
0534 <term><menuchoice><guimenu>Sorting column</guimenu></menuchoice></term>
0535 <listitem><para>The lines will be grouped by the column where the sort is applied.</para></listitem>
0536 </varlistentry>
0537 <varlistentry>
0538 <term><guimenu>List of columns</guimenu></term>
0539 <listitem><para>Shows the list of all columns that can be used for grouping.</para></listitem>
0540 </varlistentry>
0541 </variablelist>
0542 </listitem>
0543 </varlistentry>
0544
0545 <varlistentry>
0546 <term><menuchoice><guimenu>Alternate row colors</guimenu></menuchoice></term>
0547 <listitem><para>Alternate the colors used for each row. The colors used are based on the chosen &kde; color scheme.</para></listitem>
0548 </varlistentry>
0549 <varlistentry>
0550 <term><menuchoice><guimenu>Export</guimenu></menuchoice></term>
0551 <listitem><para><link linkend="export_table">Export the table</link> as a stand-alone file. Supported formats are .pdf, .csv, .html, .SVG, .odt or .txt.</para></listitem>
0552 </varlistentry>
0553 </variablelist>
0554
0555 <para>You may also click on a header to choose the sorting column, or reorder columns by dragging them left or right.</para>
0556
0557 <sect3 id="show">
0558 <title>Filter the table</title>
0559 <screenshot>
0560 <mediaobject>
0561 <imageobject><imagedata fileref="show.png" format="PNG"/></imageobject>
0562 <textobject><phrase>Show table menu</phrase></textobject>
0563 </mediaobject>
0564 </screenshot>
0565 <para>In all &skrooge; views, you will find a "Show" drop down menu allowing you to limit what the table displays.
0566 </para>
0567 </sect3>
0568
0569 <sect3 id="search">
0570 <title>Search as you type</title>
0571 <screenshot>
0572 <mediaobject>
0573 <imageobject><imagedata fileref="search.png" format="PNG"/></imageobject>
0574 <textobject><phrase>Search field</phrase></textobject>
0575 </mediaobject>
0576 </screenshot>
0577 <para>
0578 In all &skrooge; views, you will find a search field that filters the table to only display lines matching what you type:
0579 <itemizedlist>
0580 <listitem><para>In an transactions view, it will filter the transactions containing the text entered, whatever the column (date, payee, category, comment, etc.)</para></listitem>
0581 <listitem><para>In an accounts view, it will filter the accounts containing the text entered, whatever the column (bank, account name, number, etc.)</para></listitem>
0582 <listitem><para>In a report view, it will redraw the graph based on this filter</para></listitem>
0583 <listitem><para>In a… well, you get the idea, right?</para></listitem>
0584 </itemizedlist>
0585 </para>
0586 <tip>
0587 <para>
0588 The filtering string follows these rules:
0589 </para>
0590 <itemizedlist>
0591 <listitem><para>Searching is not case-sensitive. So table, Table and TABLE are all the same.</para></listitem>
0592 <listitem><para>If you enter a word or series of words in the search box, the application will filter the table to only display lines having these words (logical operator AND).</para></listitem>
0593 <listitem><para>If you want to add (logical operator OR) some lines, you must prefix your word with "+".</para></listitem>
0594 <listitem><para>If you want to remove (logical operator NOT) some lines, you must prefix your word with "-".</para></listitem>
0595 <listitem><para>If you want to search only one column, you must prefix your word with the column name, like: col1:word.</para></listitem>
0596 <listitem><para>If you want to use the character ":" in value, you must specify the column name, like: col1:value:rest.</para></listitem>
0597 <listitem><para>If you want to search for a phrase or something that contains spaces, you must put it in quotes, like: "yes, this is a phrase".</para></listitem>
0598 <listitem><para>You can also use operator "<" and ">".</para></listitem>
0599 </itemizedlist>
0600 <para>
0601 Below are some examples that can illustrate these rules in a more intuitive way:
0602 </para>
0603 <itemizedlist>
0604 <listitem><para>+val1 +val2 => Keep lines containing val1 OR val2</para></listitem>
0605 <listitem><para>+val1 -val2 => Keep lines containing val1 but NOT val2</para></listitem>
0606 <listitem><para>"abc def" => Keep lines containing the sentence "abc def"</para></listitem>
0607 <listitem><para>"-att:abc def" => Remove lines having a column name starting by att and containing "abc def"</para></listitem>
0608 <listitem><para>abc:def => Keep lines having a column name starting by abc and containing def</para></listitem>
0609 <listitem><para>:abc:def => Keep lines containing "abc:def"</para></listitem>
0610 <listitem><para>Date>2015-03-01 => Keep lines where Date attribute is greater than 2015-03-01</para></listitem>
0611 <listitem><para>Amount<10 =>Keep lines where Amount attribute is less than 10</para></listitem>
0612 </itemizedlist>
0613 </tip>
0614 </sect3>
0615 </sect2>
0616
0617 <sect2 id="save_customized_content">
0618 <title>Save Customized Content</title>
0619
0620 <para>As explained in the <link linkend="tables">previous chapter</link>, tables can be totally customized to your liking. You probably do not want to lost all the customization work you made when you close a tab. For this reason, two ways are included to save this work.</para>
0621
0622 <sect3 id="save_default_context">
0623 <title>Save page state</title>
0624 <para>This option allows you to save the current tab state as the default state that will always be called when opening this page. For example, you may want your <link linkend="dashboard">Dashboard</link> to contain 4 widgets, organized to your liking - what's even more important is that you always want the Dashboard to look the same, you do not want to repeat the customization work every time you open it.</para>
0625 <para>To do this, you simply need to do the customization work once, then save the tab state as the Default State for the page being displayed. Setting the default state is done by right clicking on the tab and selecting <guimenuitem>Save page state</guimenuitem>. If you want to keep more than one state for a page then you must use <link linkend="bookmarks">bookmarks</link>.</para>
0626
0627 <screenshot>
0628 <mediaobject>
0629 <imageobject><imagedata fileref="tab_state_management.png" format="PNG"/></imageobject>
0630 <textobject><phrase>Contextual menu on tabs</phrase></textobject>
0631 </mediaobject>
0632 </screenshot>
0633
0634 <para>A faster way is to click on the disk icon <inlinemediaobject><imageobject><imagedata fileref="document-save.png" format="PNG"/></imageobject></inlinemediaobject> that appears on the left of the tab title whenever you modify the default state in a tab.</para>
0635
0636 </sect3>
0637 </sect2>
0638
0639 <sect2 id="mass_update">
0640 <title>Mass Update</title>
0641 <para>In &skrooge;, it is possible to update a large selection of items. Though mostly useful for <link linkend="transactions">transactions</link>, it can also be used on <link linkend="accounts">accounts</link>, <link linkend="units">units</link>, <link linkend="scheduled">scheduled transactions</link>, etc.</para>
0642 <para>The way to do this is quite straightforward. First, select items to be updated, set the attribute value(s) that should be applied on all items, and click on <guibutton>Apply</guibutton>. All attributes where you didn't set a value, will be left untouched on the items.</para>
0643
0644 <screenshot>
0645 <mediaobject>
0646 <imageobject><imagedata fileref="before_mass_update.png"/></imageobject>
0647 <caption><para>Set mode as "Credit Card" and payee as "ACME" on selected transactions.</para></caption>
0648 </mediaobject>
0649 </screenshot>
0650
0651 <screenshot>
0652 <mediaobject>
0653 <imageobject><imagedata fileref="after_mass_update.png"/></imageobject>
0654 <caption><para>Updated transactions.</para></caption>
0655 </mediaobject>
0656 </screenshot>
0657
0658 <note><para>It is intentionally impossible to set date or quantity with a mass update</para></note>
0659
0660 </sect2>
0661
0662 <sect2 id="status_bar">
0663 <title>Status Bar</title>
0664 <para>
0665 The status bar is a small section at the bottom of the &skrooge; window, displaying various information as you work. It includes a progress bar and a cancel button, in case you want to interrupt a long task, such as importing a large file.
0666 <screenshot>
0667 <mediaobject>
0668 <imageobject><imagedata fileref="progress-bar.png" format="PNG"/></imageobject>
0669 <textobject><phrase>The &skrooge; progress bar</phrase></textobject>
0670 </mediaobject>
0671 </screenshot>
0672 </para>
0673 </sect2>
0674
0675 </sect1>
0676
0677 <sect1 id="import">
0678 <title>Import Files</title>
0679
0680 <para>&skrooge; is able to import files from other financial applications or from your bank. So, whether you are migrating from another application, or simply do not want to go through the hassle of manually entering your transactions, &skrooge; has a quick-start option for this.</para>
0681
0682 <sect2 id="supported_file_formats">
0683 <title>Supported File Formats</title>
0684
0685 <para>One of the following formats may be used:</para>
0686
0687 <itemizedlist>
0688 <listitem><para>AFB120: A French standard.</para></listitem>
0689 <listitem><para>CSV: Comma Separated Value. Though not strictly a financial format, it is quite often available as an export format from banks or other applications, mostly because it is so easy to use in a spreadsheet.</para></listitem>
0690 <listitem><para>GnuCash: Format of the GnuCash application. If you want to migrate from this application, this is the recommended format to use.</para></listitem>
0691 <listitem><para>Grisbi: Format of the Grisbi application. If you want to migrate from this application, this is the recommended format to use.</para></listitem>
0692 <listitem><para>Homebank: Format of the Homebank application. If you want to migrate from this application, this is the recommended format to use.</para></listitem>
0693 <listitem><para>Kmymoney: Format of the Kmymoney application. If you want to migrate from this application, this is the recommended format to use.</para></listitem>
0694 <listitem><para>MT940: An international standard defined by SWIFT.</para></listitem>
0695 <listitem><para>&Microsoft; Money: Format of the &Microsoft; Money application. If you want to migrate from this application, this is the recommended format to use.</para></listitem>
0696 <listitem><para>Money Manager Ex: Format of the Money Manager Ex application. If you want to migrate from this application, this is the recommended format to use.</para></listitem>
0697 <listitem><para>OFX: Open Financial eXchange. It is a well defined and documented format, that &skrooge; imports using a third party library (libofx). This is the recommended format for imports.</para></listitem>
0698 <listitem><para>QFX: QFX is a customization of OFX from the commercial software <trademark>Quicken</trademark>.</para></listitem>
0699 <listitem><para>QIF: <trademark>Quicken</trademark> Import File. Maybe the most common financial file format. However, it has some rather limitations, like not giving the unit for transaction, or no strict date formatting.</para></listitem>
0700 <listitem><para>IIF: <trademark>Intuit</trademark> Interchange Format used by <trademark>QuickBooks</trademark>.</para></listitem>
0701 <listitem><para>SKG: This is useful for merging two &skrooge; documents</para></listitem>
0702 <listitem><para>&PDF;: This allows to create the transaction from a &PDF; invoice. The invoice is also associated to the transaction as a property. Read the <link linkend="howto_extractor">How to</link> if you want to know how to extract information from an invoice not yet supported.</para></listitem>
0703 <listitem><para>Backend: &skrooge; can also import transactions by using a backend. For the moment, the three following backends can be used:
0704 <itemizedlist>
0705 <listitem><para><ulink url="http://weboob.org/">weboob</ulink>: By using this backend you can import all transactions from all your banks in only one click. For that, you just have to install <ulink url="http://weboob.org/">weboob</ulink> and activate the corresponding backend from <link linkend="settings">settings</link>.</para></listitem>
0706 <listitem><para><ulink url="http://weboob.org/">weboob_coming</ulink>: By using this backend you can import all coming transactions from all your banks with one click. This can be used for cards with deferred debit. For that, you just have to install <ulink url="http://weboob.org/">weboob</ulink> and activate the corresponding backend from <link linkend="settings">settings</link>.</para></listitem>
0707 <listitem><para><ulink url="https://www.aquamaniac.de/sites/aqbanking/overview.php">aqbanking</ulink>: By using this backend you can import all transactions from all your banks in one click. For that, you just have to install and configure <ulink url="https://www.aquamaniac.de/sites/aqbanking/cli.php">aqbanking-cli</ulink>.</para></listitem>
0708 </itemizedlist></para>
0709
0710 <tip><para>If you do not want to store your bank passwords in the configuration file of WEBOOB, you can do so using the following method:
0711
0712 <itemizedlist>
0713 <listitem><para>Add passwords for each bank by doing <quote>kwallet-query -f Weboob kdewallet -w m_bank_name</quote></para></listitem>
0714 <listitem><para>Edit the file <quote>~/.config/weboob/backends</quote> in your favorite text editor</para></listitem>
0715 <listitem><para>Replace in the config file <quote>password = my_password</quote> by <quote>password = `kwallet-query -f Weboob kdewallet -r m_bank_name `</quote></para></listitem>
0716 </itemizedlist>
0717 </para></tip>
0718 </listitem>
0719 </itemizedlist>
0720 </sect2>
0721
0722 <sect2 id="csv_specificities">
0723 <title>CSV Specificities</title>
0724 <para>Since CSV has no strictly defined format, there is no way for &skrooge; to know where it is supposed to find dates, categories, values, etc. For this reason, &skrooge; expects your CSV file to contain some headers indicating what each column is used for. The file must contain at least the columns "Date" and "Amount".</para>
0725 <para>You may manually define how the file is set up (&ie; ignoring the headers in the file) by setting them in the application's <link linkend="settings">settings</link> (<menuchoice><guimenu>Settings</guimenu> <guimenuitem>Configure &skrooge;</guimenuitem></menuchoice>), in the <guilabel>Import / Export</guilabel> section.</para>
0726 </sect2>
0727
0728 <sect2 id="import_transactions">
0729 <title>Importing Transactions</title>
0730 <para>One of the principles of &skrooge; is to avoid multiple wizards or dialog boxes. This is especially true for imports, where other applications require much information from the user. When selecting <menuchoice><guimenu>File</guimenu><guimenuitem>Import</guimenuitem></menuchoice>, you will be asked to select the files (multiple file imports are permitted), and that is all the information that is required. Behind the scenes, &skrooge; will find the file format and apply the relevant import mode.</para>
0731
0732 <sect3 id="import_account">
0733 <title>Account</title>
0734 <para>One thing that might surprise you is that you won't be asked which account the transactions should be imported into. That is because &skrooge; will read the account number in the file, and will associate imported transactions to that account.</para>
0735 <para>If no account exists with this account number, or if the file does not contain this information, &skrooge; will use the file name as the account number.</para>
0736 <para>If you create a property named <quote>alias</quote> on the account, &skrooge; will try to match the value of the property to find the most appropriated account.</para>
0737 <para>If there is still no account with that number, &skrooge; will create a new account having the filename as the account number, and import all transactions in that account. You will then be free to either rename the account, perform a <link linkend="mass_update">mass update</link>, or use <link linkend="search_and_process">Search & Process</link> to associate imported transactions to an existing account.</para>
0738 </sect3>
0739
0740 <sect3 id="import_unit">
0741 <title>Unit</title>
0742 <para>If no unit is specified in the imported file (which is often the case for QIF and CSV formats), &skrooge; will assume the unit is your <link linkend="unit_types">primary currency</link>. If this was not the case, use the <link linkend="search_and_process">Search & Process</link> function to correct.</para>
0743 </sect3>
0744
0745 <sect3 id="import_date">
0746 <title>Date</title>
0747 <para>Sometimes, the input files will not have dates formatted as per your country's customs (it may happen in QIF or CSV, OFX has an imposed date format). &skrooge; will do its best to detect the format. If this doesn't work as expected, you can force the date format in the application's <link linkend="settings">settings</link>.</para>
0748 </sect3>
0749
0750 <sect3 id="import_status">
0751 <title>Import Status</title>
0752 <para>Imported Transactions have a specific status. Right after import, they are considered as "Imported, not yet validated". The idea here is that you may want to check if the import went as expected, so you need to identify those transactions quickly. As per default <link linkend="settings">settings</link>, those transactions will also appear in blue.</para>
0753 <tip><para>If you do not want this behaviour, you can set the option <guilabel>Automatic Validation after Import</guilabel> in the application's <link linkend="settings">settings</link>.</para></tip>
0754 <tip><para>The <link linkend="search_and_process">Search & Process</link> function can be automatically launched after import to categorize transactions.</para></tip>
0755 </sect3>
0756 </sect2>
0757
0758 <sect2 id="merge_transactions">
0759 <title>Merge transactions after import</title>
0760 <para>There are some cases where you have manually entered a transaction, but also imported it from your bank. In such cases, the transaction will appear twice in the list.</para>
0761 <para>You may merge these two transactions by selecting them, and select <guimenuitem>Merge imported transactions</guimenuitem> in the contextual menu or the edit menu. This will add all information you manually entered to the imported transaction, and will delete the manually entered transaction.</para>
0762 </sect2>
0763 </sect1>
0764
0765 <sect1 id="export">
0766 <title>Export</title>
0767 <para>There are different ways of exporting data with &skrooge; depending on what your needs.</para>
0768
0769 <sect2 id="export_file">
0770 <title>Export all your data in one file</title>
0771 <para>Using the menu <menuchoice><guimenu>File</guimenu> <guimenuitem>Export</guimenuitem></menuchoice>, a CSV, QIF, JSON, Kmymoney, Ledger, IIF, Sqlite, Sqlcipher or <!---->&XML; file will be created, containing all transactions in the current document. This is the option to choose if you need to export your data to another application.</para>
0772 </sect2>
0773
0774 <sect2 id="export_partial_file">
0775 <title>Partially export your data in one file</title>
0776 <para>If you select some accounts or some transactions before using the menu <menuchoice><guimenu>File</guimenu> <guimenuitem>Export</guimenuitem></menuchoice>, a CSV, QIF, JSON, Kmymoney, Ledger, IIF, Sqlite, Sqlcipher or &XML; file will be created, containing the selected accounts (with their transactions) or the selected transaction. This is the option to choose if you need to export your data to another application.</para>
0777 </sect2>
0778
0779 <sect2 id="export_table">
0780 <title>Export a specific table</title>
0781 <para>All <link linkend="tables">tables</link> in &skrooge; can be exported, in CSV, plain text, &HTML;, ODT, &PDF;, or SVG format. You can do so by right-clicking on the column header or clicking the settings icon in the table header to bring up the table's context menu, and choosing the <guimenu>Export</guimenu> option.</para>
0782
0783 <screenshot>
0784 <mediaobject>
0785 <imageobject><imagedata fileref="export_table_menu.png"/></imageobject>
0786 </mediaobject>
0787 </screenshot>
0788
0789 <para>This works wherever a table is displayed, so you can use it to export whatever tabular information you need.</para>
0790 </sect2>
0791
0792 <sect2 id="export_graph">
0793 <title>Export Graph</title>
0794 <para>&skrooge; allows you to export a <link linkend="reports">graph</link>, either in &PDF;, SVG or just any image format supported by &Qt; (PNG, JPG, &GIF;, TIFF…). You can do so by right-clicking on the graph, and choosing the <guimenu>Export</guimenu> option.</para>
0795
0796 <screenshot>
0797 <mediaobject>
0798 <imageobject><imagedata fileref="export_graph_menu.png"/></imageobject>
0799 </mediaobject>
0800 </screenshot>
0801
0802
0803 </sect2>
0804
0805 </sect1>
0806 </chapter>
0807
0808 <chapter id="using-skrooge-beginner">
0809 <title>Using &skrooge; (beginner)</title>
0810
0811 <sect1 id="menu-main">
0812 <title>The main menu</title>
0813 <para>
0814 &skrooge; follows the standard &kde; menu scheme, and as such it has many menu entries that are common for all &kde; applications. More information on these menu entries can be found <ulink url="help:/fundamentals/menus.html">in this help section</ulink>.
0815 </para>
0816 <para>
0817 Below, you can find descriptions for &skrooge;-specific menu entries.
0818 </para>
0819 <sect2 id="menu-file">
0820 <title>The File Menu</title>
0821 <para>In this menu, you can find all functions relative to the &skrooge; document</para>
0822 <screenshot>
0823 <mediaobject>
0824 <imageobject><imagedata fileref="menu_file.png"/></imageobject>
0825 </mediaobject>
0826 </screenshot>
0827
0828 <itemizedlist>
0829 <listitem><para><guimenuitem>Change password…</guimenuitem>: To change the password. Leave the field empty to remove the password</para></listitem>
0830 <listitem><para><guimenuitem>Print…</guimenuitem>: To print the open pages</para></listitem>
0831 <listitem><para><guimenuitem>Print preview</guimenuitem>: To display the preview before printing</para></listitem>
0832 <listitem><para><guimenuitem>Import</guimenuitem>: To import data.
0833 <screenshot>
0834 <mediaobject>
0835 <imageobject><imagedata fileref="menu_import.png"/></imageobject>
0836 </mediaobject>
0837 </screenshot>
0838 <itemizedlist>
0839 <listitem><para><guimenuitem>Import standard bookmarks</guimenuitem>: To import the standard bookmarks. They are created at the creation of a new document</para></listitem>
0840 <listitem><para><guimenuitem>Import categories</guimenuitem>: To import a set of predefined categories. This option depends of your country</para></listitem>
0841 <listitem><para><guimenuitem>Import</guimenuitem>: To <link linkend="import">import</link> transaction from files</para></listitem>
0842 <listitem><para><guimenuitem>Import with backend</guimenuitem>: To <link linkend="import">import</link> transactions with all declared backends</para></listitem>
0843 <listitem><para><guimenuitem>Import currency values…</guimenuitem>: To import currency values from files. Of course, the csv file must have the three columns (unit, date and amount).</para></listitem>
0844 <listitem><para><guimenuitem>Import rules…</guimenuitem>: To import <link linkend="search_and_process">Search and process</link> rules to associate a category to a payee. Of course, the csv file must have the two columns (payee and category).</para></listitem>
0845 </itemizedlist> </para></listitem>
0846 <listitem><para><guimenuitem>Export…</guimenuitem>: To <link linkend="export_file">export</link> transactions into a file</para></listitem>
0847 </itemizedlist>
0848 </sect2>
0849
0850 <sect2 id="menu-edit">
0851 <title>The Edit Menu</title>
0852 <para>In this menu, you can find all functions that can be used to modify selected objects.</para>
0853 <screenshot>
0854 <mediaobject>
0855 <imageobject><imagedata fileref="menu_edit.png"/></imageobject>
0856 </mediaobject>
0857 </screenshot>
0858
0859 <itemizedlist>
0860 <listitem><para><guimenuitem>Undo</guimenuitem>: Cancel the previous modification done</para></listitem>
0861 <listitem><para><guimenuitem>Redo</guimenuitem>: Reapply the previous modification cancelled</para></listitem>
0862 <listitem><para><guimenuitem>Revert document</guimenuitem>: Cancel the previous modifications done up to the last save</para></listitem>
0863 <listitem><para><guimenuitem>Delete</guimenuitem>: Delete the selected objects (transactions, accounts, categories, etc.)</para></listitem>
0864 <listitem><para><guimenuitem>Add property</guimenuitem>: Add a property regularly used on the selected objects</para></listitem>
0865 <listitem><para><guimenuitem>Select all</guimenuitem>: Select all lines of the <link linkend="tables">table</link> of the current page</para></listitem>
0866 <listitem><para><guimenuitem>Fast edit</guimenuitem>: Facilitates the creation of new <link linkend="transactions">transactions</link> by filling fields automatically based on previous transactions created</para></listitem>
0867 <listitem><para><guimenuitem>Find…</guimenuitem>: Open the <link linkend="search_and_process">Search and process</link> page with a predefined filter corresponding to the selected objects</para></listitem>
0868 <listitem><para><guimenuitem>Switch highlight</guimenuitem>: Switch the highlight state of objects</para></listitem>
0869 <listitem><para><guimenuitem>Switch close</guimenuitem>: Switch the close state of objects</para></listitem>
0870 <listitem><para><guimenuitem>Reconcile…</guimenuitem>: Open the <link linkend="transactions">Transactions</link> page in <link linkend="reconciliation">reconciliation</link> mode</para></listitem>
0871 <listitem><para><guimenuitem>Mark</guimenuitem>: Mark the selected transactions</para></listitem>
0872 <listitem><para><guimenuitem>Group transactions</guimenuitem>: Group the selected transactions. It serves as a link between transactions. It is used in the case of transfers between accounts or in the case of buying/selling shares. You can use it for any other purpose. Be aware that reports and graphs allow you to ignore or to take into account the grouped transactions</para></listitem>
0873 <listitem><para><guimenuitem>Ungroup transactions</guimenuitem>: Ungroup the selected transactions</para></listitem>
0874 <listitem><para><guimenuitem>Duplicate</guimenuitem>: Duplicate the selected transaction to create a new one from a previous one</para></listitem>
0875 <listitem><para><guimenuitem>Create template</guimenuitem>: Create a <link linkend="templates">template</link> from a selected transaction</para></listitem>
0876 <listitem><para><guimenuitem>Apply template</guimenuitem>: Apply a <link linkend="templates">template</link> on selected transactions</para></listitem>
0877 <listitem><para><guimenuitem>Merge sub transactions</guimenuitem>: Merge selected transactions in one split transaction</para></listitem>
0878 <listitem><para><guimenuitem>Schedule</guimenuitem>: Schedule the selected transaction</para></listitem>
0879 <listitem><para><guimenuitem>Switch validation of imported transactions</guimenuitem>: Validate all selected imported transactions</para></listitem>
0880 <listitem><para><guimenuitem>Merge imported transactions</guimenuitem>: Merge one imported transaction with another transaction entered manually. If amounts are different then a confirmation is requested</para></listitem>
0881 <listitem><para><guimenuitem>Split share</guimenuitem>: Split selected <link linkend="units">share</link></para></listitem>
0882 </itemizedlist>
0883 </sect2>
0884
0885 <sect2 id="menu-view">
0886 <title>The View Menu</title>
0887 <para>In this menu, you can find all functions related to <link linkend="multi-tabs">pages</link></para>
0888 <screenshot>
0889 <mediaobject>
0890 <imageobject><imagedata fileref="menu_view.png"/></imageobject>
0891 </mediaobject>
0892 </screenshot>
0893
0894 <itemizedlist>
0895 <listitem><para><guimenuitem>Enable editor</guimenuitem>: Activate the editor on the current page</para></listitem>
0896 <listitem><para><guimenuitem>New tab</guimenuitem>: Open a new tab</para></listitem>
0897 <listitem><para><guimenuitem>Reopen last closed page</guimenuitem>: Recover the last closed page</para></listitem>
0898 <listitem><para><guimenuitem>Close</guimenuitem>: Close the current page</para></listitem>
0899 <listitem><para><guimenuitem>Close All</guimenuitem>: Close all pages except pinned ones</para></listitem>
0900 <listitem><para><guimenuitem>Close All Other</guimenuitem>: Close all pages except the current one and the pinned ones</para></listitem>
0901 <listitem><para><guimenuitem>Pin this page</guimenuitem>: Set the current page pinned. This will top it from being replaced by another page, or from being closed</para></listitem>
0902 <listitem><para><guimenuitem>Reset page state</guimenuitem>: Reset the status of the current page</para></listitem>
0903 <listitem><para><guimenuitem>Save page state</guimenuitem>: Save the status of the current page</para></listitem>
0904 <listitem><para><guimenuitem>Overwrite bookmark state</guimenuitem>: Save the status of the current bookmarked page. The bookmark is updated with the new state</para></listitem>
0905 </itemizedlist>
0906 </sect2>
0907
0908 <sect2 id="menu-do">
0909 <title>The Go Menu</title>
0910 <para>In this menu, you can find all functions related to <link linkend="multi-tabs">pages</link></para>
0911 <screenshot>
0912 <mediaobject>
0913 <imageobject><imagedata fileref="menu_go1.png"/></imageobject>
0914 </mediaobject>
0915 </screenshot>
0916
0917 <itemizedlist>
0918 <listitem><para><guimenuitem>Home</guimenuitem>: Close all pages and reopen all bookmarks autostarted like when the document is opened</para></listitem>
0919 <listitem><para><guimenuitem>Previous</guimenuitem>: Change the content of the current page with the content of the previous one (like in a web browser)</para></listitem>
0920 <listitem><para><guimenuitem>Next</guimenuitem>: Change the content of the current page with the content of the next one. (like in a web browser)</para></listitem>
0921 <listitem><para><guimenuitem>Open highlights…</guimenuitem>: Open highlighted transactions</para></listitem>
0922 <listitem><para><guimenuitem>Open last modified…</guimenuitem>: Open transactions modified by the last action done</para></listitem>
0923 <listitem><para><guimenuitem>Open potential duplicates…</guimenuitem>: Open a page with transactions that have the same amounts and same dates</para></listitem>
0924 <listitem><para><guimenuitem>Open sub transactions…</guimenuitem>: Open sub transactions of the selected transaction. Similar to a double click</para></listitem>
0925 <listitem><para><guimenuitem>Open report…</guimenuitem>: Open a report based on the selection. This is really useful. For example: if you select two accounts and launch this action then the <link linkend="reports">report</link> page will be opened but only for transactions of those accounts</para></listitem>
0926 <listitem><para><guimenuitem>Open imported transactions not yet validated…</guimenuitem>: nothing to add</para></listitem>
0927 </itemizedlist>
0928
0929 <screenshot>
0930 <mediaobject>
0931 <imageobject><imagedata fileref="menu_go2.png"/></imageobject>
0932 </mediaobject>
0933 </screenshot>
0934 <itemizedlist>
0935 <listitem><para><guimenuitem>Open transactions without category…</guimenuitem>: Open all transactions not having a category</para></listitem>
0936 <listitem><para><guimenuitem>Open transfers without category…</guimenuitem>: Open all transfers not having a category</para></listitem>
0937 <listitem><para><guimenuitem>Open transactions without payee…</guimenuitem>: Open all transactions not having a payee</para></listitem>
0938 <listitem><para><guimenuitem>Open transfers without payee…</guimenuitem>: Open all transfers not having a payee</para></listitem>
0939 <listitem><para><guimenuitem>Open transactions without mode…</guimenuitem>: Open all transactions not having a mode</para></listitem>
0940 <listitem><para><guimenuitem>Open transactions with dates not aligned…</guimenuitem>: Open all single transactions not having the date aligned with its sub transaction</para></listitem>
0941 <listitem><para><guimenuitem>Open transactions with comments not aligned…</guimenuitem>: Open all single transactions not having the comment aligned with its sub transaction</para></listitem>
0942 <listitem><para><guimenuitem>Open transactions in groups with only one transaction…</guimenuitem>: Open all single transactions alone in a group</para></listitem>
0943 <listitem><para><guimenuitem>Open very old transactions</guimenuitem>: As per the title</para></listitem>
0944 </itemizedlist>
0945 </sect2>
0946
0947 <sect2 id="menu-tools">
0948 <title>The Tools Menu</title>
0949 <screenshot>
0950 <mediaobject>
0951 <imageobject><imagedata fileref="menu_tools.png"/></imageobject>
0952 </mediaobject>
0953 </screenshot>
0954
0955 <itemizedlist>
0956 <listitem><para><guimenuitem>Find and group transfers</guimenuitem>: Create potential transfers</para></listitem>
0957 <listitem><para><guimenuitem>Clean bank's import</guimenuitem>: Clean transactions after imports</para></listitem>
0958 <listitem><para><guimenuitem>Anonymize</guimenuitem>: Anonymize your document to help debugging of &skrooge; </para></listitem>
0959 <listitem><para><guimenuitem>Align comment of subtransactions</guimenuitem>: Correct single transactions having comments not aligned</para></listitem>
0960 <listitem><para><guimenuitem>Align date of subtransactions</guimenuitem>: Correct single transactions having dates not aligned</para></listitem>
0961 <listitem><para><guimenuitem>Remove groups with only one transaction</guimenuitem>: Correct alone in a group</para></listitem>
0962 <listitem><para><guimenuitem>Delete unused payees</guimenuitem>: As per the title</para></listitem>
0963 <listitem><para><guimenuitem>Delete unused categories</guimenuitem>: As per the title</para></listitem>
0964 <listitem><para><guimenuitem>Delete unused units</guimenuitem>: As per the title</para></listitem>
0965 <listitem><para><guimenuitem>Validate transactions that do not require further action</guimenuitem>: Validate imported transactions </para></listitem>
0966 <listitem><para><guimenuitem>Process budget rules</guimenuitem>: Recompute the <link linkend="budgets">budgets</link> based on defined rules</para></listitem>
0967 </itemizedlist>
0968 </sect2>
0969 <sect2 id="menu-settings">
0970 <title>The Settings Menu</title>
0971 <screenshot>
0972 <mediaobject>
0973 <imageobject><imagedata fileref="menu_settings.png"/></imageobject>
0974 </mediaobject>
0975 </screenshot>
0976
0977 <itemizedlist>
0978 <listitem><para><guimenuitem>Show Menubar</guimenuitem>: To show or hide the menu</para></listitem>
0979 <listitem><para><guimenuitem>Toolbars Shown</guimenuitem>: To show or hide the toolbars</para></listitem>
0980 <listitem><para><guimenuitem>Show Statusbar</guimenuitem>: To show or hide the status bar</para></listitem>
0981 <listitem><para><guimenuitem>Configure Keyboard Shortcuts…</guimenuitem>: To change the shortcuts of each command</para></listitem>
0982 <listitem><para><guimenuitem>Configure Toolbars…</guimenuitem>: To modify the toolbars layouts</para></listitem>
0983 <listitem><para><guimenuitem>Configure Notifications…</guimenuitem>: To modify the notifications </para></listitem>
0984 <listitem><para><guimenuitem>Configure &skrooge;…</guimenuitem>: To access to the main <link linkend="settings">settings</link> of &skrooge;</para></listitem>
0985 </itemizedlist>
0986 </sect2>
0987 </sect1>
0988
0989 <sect1 id="dashboard">
0990 <title>Dashboard</title>
0991 <para>The Dashboard is a &skrooge; plugin that displays global information about your financial status.</para>
0992
0993 <screenshot>
0994 <mediaobject>
0995 <imageobject><imagedata fileref="dashboard.png"/></imageobject>
0996 </mediaobject>
0997 </screenshot>
0998
0999 <para>You can add new graphical items using button on the top right corner. You can configure each graphical item by clicking on the icon on it. You can organize the graphical items on the dashboard by using drag and drop.</para>
1000 <tip><para>Combined with <link linkend="bookmarks">bookmarks</link>, this is a good way to have quick different views of your financial status.</para></tip>
1001
1002 <sect2 id="dashboard_advice">
1003 <title>Advice</title>
1004 <screenshot>
1005 <mediaobject>
1006 <imageobject><imagedata fileref="dashboard_advice.png"/></imageobject>
1007 </mediaobject>
1008 </screenshot>
1009
1010 <para>This graphical item displays some advice by order of priority. For each of them, you will be able to:
1011 <itemizedlist>
1012 <listitem><para>Open or clean concerned transactions</para></listitem>
1013 <listitem><para>Dismiss this advice</para></listitem>
1014 <listitem><para>Dismiss this advice for the current month</para></listitem>
1015 <listitem><para>Dismiss this kind of advice</para></listitem>
1016 <listitem><para>Dismiss this kind of advice for the current month</para></listitem>
1017 </itemizedlist>
1018 </para>
1019 </sect2>
1020
1021 <sect2 id="dashboard_tip">
1022 <title>Tip of the day</title>
1023 <screenshot>
1024 <mediaobject>
1025 <imageobject><imagedata fileref="dashboard_tip.png"/></imageobject>
1026 </mediaobject>
1027 </screenshot>
1028
1029 <para>Display the tip of the day. You can click on the graphical item to see the next tip.</para>
1030 </sect2>
1031
1032 <sect2 id="dashboard_accounts_light">
1033 <title>Accounts (Light)</title>
1034 <screenshot>
1035 <mediaobject>
1036 <imageobject><imagedata fileref="dashboard_accounts_light.png"/></imageobject>
1037 </mediaobject>
1038 </screenshot>
1039
1040 <para>Display the balance of each account and type of account. You can configure this graphical item to select what you want to see.</para>
1041 </sect2>
1042
1043 <sect2 id="dashboard_accounts_full">
1044 <title>Accounts (Full)</title>
1045 <screenshot>
1046 <mediaobject>
1047 <imageobject><imagedata fileref="dashboard_accounts_full.png"/></imageobject>
1048 </mediaobject>
1049 </screenshot>
1050
1051 <para>Display the balance of each account and type of account. The balance can be compared with the balance one month before and one year before.</para>
1052 </sect2>
1053
1054 <sect2 id="dashboard_banks_light">
1055 <title>Banks (Light)</title>
1056 <screenshot>
1057 <mediaobject>
1058 <imageobject><imagedata fileref="dashboard_banks_light.png"/></imageobject>
1059 </mediaobject>
1060 </screenshot>
1061
1062 <para>Display the balance of each bank. The corresponding report can be directly opened from the graphical item.</para>
1063 </sect2>
1064
1065 <sect2 id="dashboard_banks_full">
1066 <title>Banks (Full)</title>
1067 <screenshot>
1068 <mediaobject>
1069 <imageobject><imagedata fileref="dashboard_banks_full.png"/></imageobject>
1070 </mediaobject>
1071 </screenshot>
1072
1073 <para>Display the balance of each bank. The balance can be compared with the balance one month before and one year before.</para>
1074 </sect2>
1075
1076 <sect2 id="dashboard_income">
1077 <title>Income & Expenditure</title>
1078 <screenshot>
1079 <mediaobject>
1080 <imageobject><imagedata fileref="dashboard_income.png"/></imageobject>
1081 </mediaobject>
1082 </screenshot>
1083
1084 <para>Display the incomes, expenditures and savings for two different periods (example: current month, current year, previous month, etc.). You can also:
1085 <itemizedlist>
1086 <listitem><para>Select the two periods of your choosing</para></listitem>
1087 <listitem><para>Choose if <link linkend="transfer">transfers</link> are taken into account or not</para></listitem>
1088 <listitem><para>Choose if <link linkend="trackers">tracked</link> transactions are taken into account or not</para></listitem>
1089 <listitem><para>Open the corresponding <link linkend="reports">report</link></para></listitem>
1090 </itemizedlist>
1091 </para>
1092 </sect2>
1093
1094 <sect2 id="dashboard_highlighted">
1095 <title>Highlighted transactions</title>
1096 <screenshot>
1097 <mediaobject>
1098 <imageobject><imagedata fileref="dashboard_highlighted.png"/></imageobject>
1099 </mediaobject>
1100 </screenshot>
1101
1102 <para>Display the list of highlighted transactions.</para>
1103 </sect2>
1104
1105 <sect2 id="dashboard_scheduled">
1106 <title>Scheduled transactions</title>
1107 <screenshot>
1108 <mediaobject>
1109 <imageobject><imagedata fileref="dashboard_scheduled.png"/></imageobject>
1110 </mediaobject>
1111 </screenshot>
1112
1113 <para>Display the list of <link linkend="scheduled">scheduled</link> transactions.</para>
1114 </sect2>
1115
1116 <sect2 id="dashboard_categories">
1117 <title>5 main categories of expenditure</title>
1118 <screenshot>
1119 <mediaobject>
1120 <imageobject><imagedata fileref="dashboard_categories.png"/></imageobject>
1121 </mediaobject>
1122 </screenshot>
1123
1124 <para>Display the five main categories of expenditure for the desired period.</para>
1125 </sect2>
1126
1127 <sect2 id="dashboard_variations">
1128 <title>5 main variations</title>
1129 <screenshot>
1130 <mediaobject>
1131 <imageobject><imagedata fileref="dashboard_variations.png"/></imageobject>
1132 </mediaobject>
1133 </screenshot>
1134
1135 <para>Display the five main variations of income and expenditure for the desired period.</para>
1136 </sect2>
1137
1138 <sect2 id="dashboard_budget">
1139 <title>Budget</title>
1140 <screenshot>
1141 <mediaobject>
1142 <imageobject><imagedata fileref="dashboard_budget.png"/></imageobject>
1143 </mediaobject>
1144 </screenshot>
1145
1146 <para>Display the budget for the desired period.</para>
1147 </sect2>
1148
1149 <sect2 id="dashboard_alarms">
1150 <title>Alarms</title>
1151 <para>Display the alarms defined in <link linkend="search_and_process">Search and Process</link>.</para>
1152 </sect2>
1153
1154 <sect2 id="dashboard_report">
1155 <title>Report</title>
1156 <screenshot>
1157 <mediaobject>
1158 <imageobject><imagedata fileref="dashboard_report.png"/></imageobject>
1159 </mediaobject>
1160 </screenshot>
1161
1162 <para>Display the <link linkend="reports">report</link> you want.</para>
1163 </sect2>
1164
1165 <sect2 id="dashboard_quotes">
1166 <title>Quotes</title>
1167 <screenshot>
1168 <mediaobject>
1169 <imageobject><imagedata fileref="dashboard_quotes.png"/></imageobject>
1170 </mediaobject>
1171 </screenshot>
1172
1173 <para>Display the quote of the defined <link linkend="units">units</link> and the variations. You can choose the types of units to display.</para>
1174 </sect2>
1175
1176 <sect2 id="dashboard_portfolio">
1177 <title>Portfolio</title>
1178 <screenshot>
1179 <mediaobject>
1180 <imageobject><imagedata fileref="dashboard_portfolio.png"/></imageobject>
1181 </mediaobject>
1182 </screenshot>
1183
1184 <para>Display all information relative to the shares you have.</para>
1185 </sect2>
1186
1187 <sect2 id="dashboard_interest">
1188 <title>Estimated interest</title>
1189 <screenshot>
1190 <mediaobject>
1191 <imageobject><imagedata fileref="dashboard_interest.png"/></imageobject>
1192 </mediaobject>
1193 </screenshot>
1194
1195 <para>Display the estimation of interest for each account. You have to use the <link linkend="simulations">simulation</link> page to define the rate of each account.</para>
1196 </sect2>
1197
1198 <sect2 id="dashboard_pfs">
1199 <title>Personal financial score</title>
1200 <screenshot>
1201 <mediaobject>
1202 <imageobject><imagedata fileref="dashboard_pfs.png"/></imageobject>
1203 </mediaobject>
1204 </screenshot>
1205
1206 <para>Display your personal financial score.</para>
1207 </sect2>
1208 </sect1>
1209
1210 <sect1 id="accounts">
1211 <title>Bank & Accounts</title>
1212 <para>This is the plugin dedicated to managing your different accounts.</para>
1213
1214 <screenshot>
1215 <mediaobject>
1216 <imageobject><imagedata fileref="bank_accounts.png" format="PNG"/></imageobject>
1217 <textobject><phrase>The Bank & Accounts view</phrase></textobject>
1218 </mediaobject>
1219 </screenshot>
1220
1221
1222 <sect2 id="account_properties">
1223 <title>Account properties</title>
1224 <para>A &skrooge; account has the following properties:
1225
1226 <variablelist>
1227 <varlistentry>
1228 <term>Bank</term>
1229 <listitem><para>You may choose a bank from the drop down box (containing the list of known banks for your country), or type the name if your bank is not in the list (If the list is empty, the &skrooge; team has not yet been provided this information. You may contact us to help!).</para></listitem>
1230 </varlistentry>
1231 <varlistentry>
1232 <term>Account</term>
1233 <listitem><para>The name you want to use for this account.</para></listitem>
1234 </varlistentry>
1235 <varlistentry>
1236 <term>Type</term>
1237 <listitem><para>The account type can be
1238 <itemizedlist>
1239 <listitem><para>Current</para></listitem>
1240 <listitem><para>Credit Card: This kind of account has a specific <link linkend="reconciliation">reconciliation</link> mode.</para></listitem>
1241 <listitem><para>Saving</para></listitem>
1242 <listitem><para>Investment</para></listitem>
1243 <listitem><para>Assets</para></listitem>
1244 <listitem><para>Loan: The transfers to this kind of account are not taken into account in reports.</para></listitem>
1245 <listitem><para>Pension</para></listitem>
1246 <listitem><para>Wallet: This kind of account does not have a bank name.</para></listitem>
1247 <listitem><para>Other</para></listitem>
1248 </itemizedlist>
1249 </para></listitem>
1250 </varlistentry>
1251 <varlistentry>
1252 <term>Bank Number</term>
1253 <listitem><para>The identification number of your bank</para></listitem>
1254 </varlistentry>
1255 <varlistentry>
1256 <term>Agency Number</term>
1257 <listitem><para>The identification number of the agency</para></listitem>
1258 </varlistentry>
1259 <varlistentry>
1260 <term>Account Number</term>
1261 <listitem><para>The identification number of the account. This value is very important to match the appropriate account during imports</para></listitem>
1262 </varlistentry>
1263 <varlistentry>
1264 <term>Address</term>
1265 <listitem><para>The address of the agency</para></listitem>
1266 </varlistentry>
1267 <varlistentry>
1268 <term>Comment</term>
1269 <listitem><para>Anything you want!</para></listitem>
1270 </varlistentry>
1271 <varlistentry>
1272 <term>Initial balance</term>
1273 <listitem><para>The initial amount of the account. For a loan account, the amount should be a negative amount corresponding to the loan.</para></listitem>
1274 </varlistentry>
1275 <varlistentry>
1276 <term>Minimum limit</term>
1277 <listitem><para>The minimum limit when &skrooge; must raise an alarm </para></listitem>
1278 </varlistentry>
1279 <varlistentry>
1280 <term>Maximum limit</term>
1281 <listitem><para>The maximum limit when &skrooge; must raise an alarm </para></listitem>
1282 </varlistentry>
1283 </variablelist>
1284 </para>
1285 </sect2>
1286
1287 <sect2 id="accounts_list">
1288 <title>Accounts list</title>
1289 <para>The accounts list takes the form of a table with one line per account. In addition to the <link linkend="account_properties">properties</link> you defined for this account, &skrooge; displays the following columns:</para>
1290
1291 <variablelist>
1292 <varlistentry>
1293 <term>Amount</term>
1294 <listitem><para>The amount available on the account, considering all transactions registered, whether they are validated or not.</para></listitem>
1295 </varlistentry>
1296 <varlistentry>
1297 <term>Checked</term>
1298 <listitem><para>The amount of all validated transactions. This should be equal to the amount written on your last account's position from your bank.</para></listitem>
1299 </varlistentry>
1300 <varlistentry>
1301 <term>Foreseen</term>
1302 <listitem><para>The difference between the two previous columns</para></listitem>
1303 </varlistentry>
1304 <varlistentry>
1305 <term>Number of transactions</term>
1306 <listitem><para>The total number of transactions made on this account</para></listitem>
1307 </varlistentry>
1308 </variablelist>
1309
1310 <para>As with all &skrooge; list views, you can fully <link linkend="tables">customize the table appearance</link>.</para>
1311
1312 </sect2>
1313
1314 <sect2 id="create_account">
1315 <title>Create an Account</title>
1316 <para>You create accounts in the editing panel below the accounts list in Accounts view.</para>
1317
1318 <para>
1319 To create an account, enter its attributes (the mandatory ones are in bold), and click on <guibutton>Add</guibutton>. &skrooge; doesn't need you to provide the initial amount of this account. In order to set the initial amount of the account, create a transaction corresponding to the initial amount.</para>
1320 </sect2>
1321
1322 <sect2 id="modify_account">
1323 <title>Modify an Account</title>
1324 <para>To modify an account, select it, modify its attributes, and click on "Modify"</para>
1325 </sect2>
1326
1327 <sect2 id="delete_account">
1328 <title>Delete Accounts</title>
1329 <para>To delete accounts, select them and either press <keycap>Delete</keycap> on the keyboard, use the contextual menu, or use the icon in the toolbar.</para>
1330 <warning><para>Upon deleting an account, all transactions belonging to this account will also be deleted! However, you can always <link linkend="undo_redo">undo</link> the deletion.</para></warning>
1331 </sect2>
1332
1333 </sect1>
1334
1335 <sect1 id="transactions">
1336 <title>Transactions</title>
1337 <para>Transactions are any transaction you make on an account, be it an expense, income, transfer, sales, purchase, etc. This is where you will probably spend most of your time when using &skrooge;.</para>
1338
1339 <para>In order to enter transactions, you need to have at least one <link linkend="accounts">account</link> created.</para>
1340
1341 <screenshot>
1342 <mediaobject>
1343 <imageobject><imagedata fileref="transactions.png" format="PNG"/></imageobject>
1344 <textobject><phrase>The transactions view</phrase></textobject>
1345 </mediaobject>
1346 </screenshot>
1347
1348 <sect2 id="transaction_properties">
1349 <title>Transaction Properties</title>
1350
1351 <variablelist>
1352 <varlistentry>
1353 <term>Account</term>
1354 <listitem><para>The account the transaction is made on. Select it from the list of existing accounts.</para></listitem>
1355 </varlistentry>
1356 <varlistentry>
1357 <term>Date</term>
1358 <listitem><para>The date when the transaction was made. A calendar is accessible using the down arrow right of the field.</para></listitem>
1359 </varlistentry>
1360 <varlistentry>
1361 <term id="quantity_field">Amount</term>
1362 <listitem>
1363 <para>The amount is how much you spent or earned with this transaction. &skrooge; requires you enter this in two separate fields: Quantity and Unit.</para>
1364 <para>The quantity is negative for an expense (-30, for example), and positive for an income (+250, or simply 250). This field acts as a calculator, &ie; entering an expression such as 10 + 3.23*2 will result in the field containing 16.46.</para>
1365 <para>If the sign of the quantity is not specified, then &skrooge; will use the category to find the most appropriate one.</para>
1366 <para>&skrooge; requires you to enter the <link linkend="units">unit</link> because a transaction is not necessarily made in your main currency. For example, when you buy or purchase shares, the unit of the transaction is the share unit.</para>
1367 </listitem>
1368 </varlistentry>
1369 <varlistentry>
1370 <term>Payee</term>
1371 <listitem><para>Who did you pay this to, or who gave you the money.</para></listitem>
1372 </varlistentry>
1373 <varlistentry>
1374 <term>Mode</term>
1375 <listitem>
1376 <para>What was the payment mode used for this transaction. Something in the line of Credit Card, Cheque, Deposit… You name it!</para>
1377 <para>Associated with the transaction mode, it is an optional number. It is mostly used to enter the check number, or a transfer number.</para>
1378 </listitem>
1379 </varlistentry>
1380 <varlistentry>
1381 <term>Category</term>
1382 <listitem>
1383 <para>Which <link linkend="categories">Category</link> this transaction belongs to. If you need to affect more than one category to a transaction, use the <link linkend="split_transaction">split</link> mode.</para>
1384 <para>You can either choose an existing category, or type a new one. In this case, &skrooge; will create it for you along with the transaction.</para>
1385 <para>The separator between a parent category and its children is the > character. If you type Clothes > Shoes, &skrooge; will create the category Clothes if it doesn't exist yet, and its child category Shoes.</para>
1386 <para>Of course, you may create entire category trees, such as Transport > Car > Fuel > Unleaded, &skrooge; will happily create all the hierarchical structure.</para>
1387 </listitem>
1388 </varlistentry>
1389 <varlistentry>
1390 <term>Comment</term>
1391 <listitem><para>Any comment you'd like.</para></listitem>
1392 </varlistentry>
1393 <varlistentry>
1394 <term>Tracker</term>
1395 <listitem><para>If you want to track refund for this transaction, enter the name of the <link linkend="trackers">Tracker</link> here. If you need to affect more than one tracker to a transaction, use the <link linkend="split_transaction">split</link> mode.</para></listitem>
1396 </varlistentry>
1397 </variablelist>
1398
1399 </sect2>
1400
1401 <sect2 id="transactions_list">
1402 <title>Transactions list</title>
1403 <para>The transactions list takes the form of a table showing all transactions that match the current <link linkend="show">table filter</link> and search terms, with a row for each transaction. In addition to the standard <link linkend="transaction_properties">transaction properties</link> and any other <link linkend="account_properties">properties</link> you defined for this account, &skrooge; displays the following columns:</para>
1404
1405 <variablelist>
1406 <varlistentry>
1407 <term>Status</term>
1408 <listitem><para>A filled square means this transaction has been confirmed during account <link linkend="reconciliation">reconciliation</link>. A half-filled square means this transaction has been <link linkend="terminology_marked_transaction">marked</link>, and <link linkend="reconciliation">reconciliation</link> is ongoing.</para></listitem>
1409 </varlistentry>
1410 <varlistentry>
1411 <term>Bookmark</term>
1412 <listitem><para>Mark this transaction as Bookmarked, a synonym for Favorite.</para></listitem>
1413 </varlistentry>
1414 <varlistentry>
1415 <term>Scheduled</term>
1416 <listitem><para>When a transaction is scheduled, this column shows a chronometer icon.</para></listitem>
1417 </varlistentry>
1418 </variablelist>
1419
1420 <para>These columns also have some specificities:</para>
1421
1422 <variablelist>
1423 <varlistentry>
1424 <term>Mode</term>
1425 <listitem><para>When the transaction is part of a <link linkend="transfer">transfer</link>, the mode is preceded by a double arrow icon.<!-- Insert the icon here --></para></listitem>
1426 </varlistentry>
1427 <varlistentry>
1428 <term>Category</term>
1429 <listitem><para>When the transaction is <link linkend="split_transaction">split</link>, the category is preceded by a triple arrow icon.<!-- Insert the icon here --></para></listitem>
1430 </varlistentry>
1431 </variablelist>
1432
1433 <para>As with all &skrooge; list views, you can fully <link linkend="tables">customize the table appearance</link>.</para>
1434
1435 </sect2>
1436
1437 <sect2 id="standard_transaction">
1438 <title>Create an Transaction</title>
1439 <para>To create a standard transaction, you may use the <guibutton>Clear button</guibutton> to clear all fields and start a new transaction from scratch. You can then fill its attributes (manually or using <link linkend="fast_editing">fast editing</link>), and click on <guibutton>Add</guibutton>.</para>
1440 <para>If the appropriate setting is enabled, then the category will be set automatically when the payee is set.</para>
1441 <para>You may also select a similar transaction from the existing transactions, modify what needs to be changed, and then click on <guibutton>Add</guibutton>.</para>
1442 </sect2>
1443
1444
1445 <sect2 id="split_transaction">
1446 <title>Split Transaction</title>
1447 <para>A split transaction is a transaction that has several dates, categories, comments or trackers. You switch to the split transaction editing mode using the <guibutton>Split Button</guibutton> at the bottom of the Transactions view. When switching into the split transaction editing mode, the fields Category, Comment and Tracker are replaced by a table.</para>
1448
1449 <screenshot>
1450 <mediaobject>
1451 <imageobject><imagedata fileref="split_transaction.png" format="PNG"/></imageobject>
1452 <textobject><phrase>The split transaction editing panel.</phrase></textobject>
1453 </mediaobject>
1454 </screenshot>
1455
1456 <para>To edit a cell in this table, double click on it.</para>
1457
1458 <para>You can add as many lines in this table as you need. When changing the quantity in a line, &skrooge; will compute the difference with the transaction global quantity, and display the remaining quantity in the last table line. If you changed the quantity in the last line, a new line will be added with the remaining quantity.</para>
1459
1460 <para>The fields here have the same behaviour as in the standard transaction editing mode:</para>
1461
1462 <itemizedlist>
1463 <listitem><para>The split by Date can be useful, for example, in a hypotheical scenario where you paid your sport training for three months. In this case, you can split the payment by three months - this will have an impact on reports.</para></listitem>
1464 <listitem><para>The Category is a drop down box of existing categories. You can add a new category structure, &skrooge; will create it when creating the transaction.</para></listitem>
1465 <listitem><para>The Amount <link linkend="quantity_field">acts as a calculator</link>.</para></listitem>
1466 <listitem><para>The Tracker is a drop down box of existing trackers. You can add a new tracker, &skrooge; will create it when creating the transaction.</para></listitem>
1467 </itemizedlist>
1468 </sect2>
1469
1470 <sect2 id="transfer">
1471 <title>Transfer</title>
1472 <para>A transfer transaction is effectively a dual transaction: when creating a transfer, &skrooge; will create two transactions of opposite amounts (one positive, the other negative), on two different accounts. The attributes to provide here are slightly different from a standard transaction:</para>
1473
1474 <screenshot>
1475 <mediaobject>
1476 <imageobject><imagedata fileref="transfer_transaction.png" format="PNG"/></imageobject>
1477 <textobject><phrase>The transfer transaction editing panel.</phrase></textobject>
1478 </mediaobject>
1479 </screenshot>
1480
1481 <para>You will find a "To Account" list where you should select the account receiving the money.</para>
1482
1483 <para>Since a transfer means "Take some money from account A and put it account B", if you put a sign in the quantity field (+ or -), it will be ignored. The transaction for account A will always be negative, positive for account B.</para>
1484 </sect2>
1485
1486 <sect2 id="shares">
1487 <title>Shares</title>
1488 <para>First, you have to create some units with the shares you want to track, from the <link linkend="settings">settings</link> you can choose to update the data automatically when the
1489 file is opened. It is also recommended to create a different account (⪚ "ETF") in order to keep the investments separated and be able to see them from the dashboard.
1490 </para>
1491 <para>Now you can add your transactions as "shares":
1492 <screenshot>
1493 <mediaobject>
1494 <imageobject><imagedata fileref="shares.png" format="PNG"/></imageobject>
1495 <textobject><phrase>The shares editing panel.</phrase></textobject>
1496 </mediaobject>
1497 </screenshot>
1498 <itemizedlist>
1499 <listitem><para>Amount is the number of shares you've bought (positive value) or sold (negative value)</para></listitem>
1500 <listitem><para>Symbol is the previous unit you created</para></listitem>
1501 <listitem><para>Amount of shares is the total price you payed for the shares / the amount you got from the selling, excluding commissions and taxes</para></listitem>
1502 <listitem><para>Commissions is the amount you payed your bank for that transaction</para></listitem>
1503 <listitem><para>Tax is any amount you paid (usually when there are earnings)</para></listitem>
1504 </itemizedlist>
1505 </para>
1506 </sect2>
1507
1508 <sect2 id="schedule_transaction">
1509 <title>Schedule Transactions</title>
1510
1511 <para>If a transaction is known to be repeated on a regular basis, you may want &skrooge; to automatically enter it for you in the list of transactions. This can be done by scheduling a transaction, using the <guibutton>Schedule button <inlinemediaobject><imageobject><imagedata fileref="schedule_transaction.png"/></imageobject></inlinemediaobject></guibutton>.</para>
1512
1513 <para>The default scheduling parameters are:</para>
1514 <itemizedlist>
1515 <listitem><para>Repeat every month</para></listitem>
1516 <listitem><para>Remind me five days before term</para></listitem>
1517 <listitem><para>Automatically write on term</para></listitem>
1518 </itemizedlist>
1519
1520 <para>You may change the default parameters in &skrooge; <link linkend="settings">settings</link>.</para>
1521 <para>You may also change each scheduled transaction parameters in the <link linkend="scheduled">Scheduled plugin</link>.</para>
1522 <para>&skrooge; uses values from the last entry of the scheduled transaction for writing the next one. If you increase, for example, the amount of your monthly contribution to the &kde; effort from 100$ to 200$, the next transactions automatically written by &skrooge; will have an amount of 200$.</para>
1523
1524 </sect2>
1525
1526 <sect2 id="fast_editing">
1527 <title>Fast Editing</title>
1528
1529 <para>Regardless of the chosen editing mode, there is a nifty function called Fast Editing that may speed up the work while creating new transactions. It will fill the transaction's attributes based on previously entered transactions. Enter a value in any field of the editor, and press <keycap>F10</keycap>, or click on the <guibutton>Fast Editing Icon <inlinemediaobject><imageobject><imagedata fileref="fast_editing.png" format="PNG"/></imageobject></inlinemediaobject></guibutton> (without leaving the selected field).</para>
1530
1531 <para>&skrooge; will look for the first (&ie; the most recent one) transaction that has the same value in the same field, and fill all other fields with values from that transaction. It will continue to do so with each call.</para>
1532
1533 <warning>
1534 <para>Fast Editing has no effect on the date, since it is rather unlikely that you want to create exactly the same transaction, complete with the same date.</para>
1535 <para>If you modified a field's value before calling Fast Editing, its content will not be affected. This is materialized by a different background color in the field, so you know it is "frozen".</para>
1536 </warning>
1537
1538 <para>Below are the differences when compared to similar functions in other personal finances software:</para>
1539 <itemizedlist>
1540 <listitem><para>It is called on user demand</para></listitem>
1541 <listitem><para>It loops in all past transactions with the same field value</para></listitem>
1542 </itemizedlist>
1543
1544 <para>And it even works on split transactions !</para>
1545 </sect2>
1546
1547 <sect2 id="reconciliation">
1548 <title>Reconciliation</title>
1549 <para>Reconciliation is the process by which you ensure that all transactions in an account match the bank's view of that account. It will involve you, your account's position, and a pen. Reconciliation can happen only for an account at one mark in time.</para>
1550 <para>First, enter all the transactions for the account up to that mark in time; if you can, download transactions from the bank and <link linkend="import">import</link> them into &skrooge; to minimize data entry. Then, in the Transactions view, select the account you wish to reconcile from the drop-down box; or in the Accounts view, double-click the account name or bring up the contextual menu and choose <menuchoice><guimenu>Open transactions…</guimenu></menuchoice>. Switch into reconciliation mode using the <guibutton>Switch Information button <inlinemediaobject><imageobject><imagedata fileref="switch_information.png" format="PNG"/></imageobject></inlinemediaobject></guibutton> below the transactions table.</para>
1551
1552 <screenshot>
1553 <mediaobject>
1554 <imageobject><imagedata fileref="reconciliation_information.png" format="PNG"/></imageobject>
1555 <textobject><phrase>The reconciliation mode information.</phrase></textobject>
1556 </mediaobject>
1557 </screenshot>
1558
1559 <para>Enter the position of your account as provided by your bank in the dedicated field. Now, you can proceed to pointing in &skrooge; every transaction that appears in the bank's statement: you can either click on its checkbox in the status column or bring up the contextual menu and choose <guimenuitem>Mark</guimenuitem>. The check box for this transaction will appear partially filled until you complete reconciliation.</para>
1560
1561 <para>As you mark transactions, you will see &skrooge; display in the information zone:</para>
1562 <itemizedlist>
1563 <listitem><para>Delta: the difference between the previously entered account position and the sum of all checked transactions</para></listitem><!--TODO: explain 'previously entered'; what happens-->
1564 <listitem><para>Expenditure:the total amount of Marked debits</para></listitem>
1565 <listitem><para>Income: the total amount of Marked credits</para></listitem>
1566 </itemizedlist>
1567
1568 <para>These running totals help you spot transactions you may have forgotten to enter in &skrooge;. Many bank statements provide similar totals such as "Withdrawals" or "Deposits and Credits", although they may have separate totals for "Interest", "Fees". When the Delta is equal to 0, you <emphasis>may</emphasis> have marked all transactions matching the bank's record. For example, you may have mistakenly marked a debit of 8€ and a credit of 2€, and overlooked a bank debit of 6€ - the net is the same, minus 6€. When the Delta is 0, the <guibutton>Validate marked transactions button <inlinemediaobject><imageobject><imagedata fileref="validate.png" format="PNG" /></imageobject></inlinemediaobject></guibutton> is enabled. Click on this button to complete your reconciliation: all marked transactions are now checked.</para>
1569
1570 <tip><para><inlinemediaobject><imageobject><imagedata fileref="fast_editing.png" format="PNG" /></imageobject></inlinemediaobject> can automatically mark all imported transactions for you.</para></tip>
1571
1572 <para>If the option <guibutton>Hide checked transactions</guibutton> for the table is selected from its "Show" menu (see <link linkend="show">Filter the table</link>), then all these transactions will now be hidden.</para>
1573
1574 <para>If the reconciliation is not possible for any reason, you can create a fake transaction that in combination with the other transactions you marked sets the Delta to 0, thus allowing you to complete the reconciliation. To do so, click the "add" button <!-- TODO: add inline screenshot of kCreateFaketransaction's "list-add" icon.-->in the reconciliation mode toolbar. You can set the default values of this fake transaction in the application's <link linkend="settings">settings</link>, in the <guilabel>Transactions</guilabel> section. During reconciliation, if you enable the appropriate setting, &skrooge; automatically points all created transactions.</para>
1575
1576 </sect2>
1577
1578 <sect2 id="templates">
1579 <title>Template Transactions</title>
1580 <para>&skrooge; allows you creating template transactions, &ie; transactions that can be reused whenever you need it. For example, say that you frequently rent &DVD;s to watch at home. The transaction is always the same :</para>
1581
1582 <itemizedlist>
1583 <listitem><para>Amount: -4.99</para></listitem>
1584 <listitem><para>Mode: Credit Card</para></listitem>
1585 <listitem><para>Payee: Acme Video</para></listitem>
1586 <listitem><para>Category: Leisure > Video</para></listitem>
1587 </itemizedlist>
1588
1589 <para>However, you cannot make it a recurring transaction, because you rent a &DVD; when you feel like it, not every week. The idea behind template transactions is that it gives you a basic skeleton that can be quickly inserted in your transactions list.</para>
1590
1591 <para>Since Template transactions are just another kind of transactions, you can access them through the transactions tab, using the dedicated option in <guimenu>Show</guimenu> menu:</para>
1592
1593 <screenshot>
1594 <mediaobject>
1595 <imageobject><imagedata fileref="template_button.png" format="PNG"/></imageobject>
1596 <textobject><phrase>Switching between templates and transactions.</phrase></textobject>
1597 </mediaobject>
1598 </screenshot>
1599
1600 <para>Creating a template is strictly equal to creating a transaction by defining its attributes. Note that you can also create a template from an existing transaction (bring up the contextual menu on a transaction). In this case, the template will have the same attributes as the transaction.</para>
1601
1602 <para>To use a template and create a new transaction from it, double click on it. A new transaction will be created with the same attributes as the template, at the current date. You can then modify its attributes if needed.</para>
1603
1604 <para>Templates can also be <link linkend="scheduled">scheduled.</link></para>
1605
1606 </sect2>
1607
1608 </sect1>
1609
1610 <sect1 id="payees">
1611 <title>Payees</title>
1612 <para>The Payees view allow you to browse the payees list.</para>
1613
1614 <screenshot>
1615 <mediaobject>
1616 <imageobject>
1617 <imagedata fileref="payees.png" format="PNG"/>
1618 </imageobject>
1619 </mediaobject>
1620 </screenshot>
1621
1622 <para>In addition to the name of payees, the table also shows:</para>
1623
1624 <variablelist>
1625 <varlistentry>
1626 <term>Address</term>
1627 <listitem><para>The address of this payee.</para></listitem>
1628 </varlistentry>
1629 <varlistentry>
1630 <term>Category</term>
1631 <listitem><para>The default category for this payee. This category is used automatically when the payee is set in <link linkend="transactions">transactions</link> page. If you don't set it, then the default category is computed with the existing transactions.</para></listitem>
1632 </varlistentry>
1633 <varlistentry>
1634 <term>Amount</term>
1635 <listitem><para>The sum of all transactions in this payee.</para></listitem>
1636 </varlistentry>
1637 <varlistentry>
1638 <term>Number of Transactions</term>
1639 <listitem><para>The number of transactions in this payee.</para></listitem>
1640 </varlistentry>
1641 </variablelist>
1642
1643 <para>Double-clicking on a line in this table will open the list of all transactions in this payee in a new tab.</para>
1644 </sect1>
1645
1646 <sect1 id="categories">
1647 <title>Categories</title>
1648 <para>The Categories view allow you to browse the categories tree.</para>
1649
1650 <screenshot>
1651 <mediaobject>
1652 <imageobject>
1653 <imagedata fileref="categories.png" format="PNG"/>
1654 </imageobject>
1655 </mediaobject>
1656 </screenshot>
1657
1658 <para>In addition to the name of categories, the table also shows: </para>
1659
1660 <variablelist>
1661 <varlistentry>
1662 <term>Amount</term>
1663 <listitem><para>The sum of all transactions in this category.</para></listitem>
1664 </varlistentry>
1665 <varlistentry>
1666 <term>Number of Transactions</term>
1667 <listitem><para>The number of transactions in this category.</para></listitem>
1668 </varlistentry>
1669 <varlistentry>
1670 <term>Amount (Cumulative)</term>
1671 <listitem><para>The sum of all transactions in this category and children categories (down to the last level).</para></listitem>
1672 </varlistentry>
1673 <varlistentry>
1674 <term>Number of Transactions (Cumulative)</term>
1675 <listitem><para>The number of transactions in this category and children categories (down to the last level).</para></listitem>
1676 </varlistentry>
1677 </variablelist>
1678
1679 <para>Double clicking on a line in this table will open the list of all transactions in this category in a new tab.</para>
1680 <warning><para>When deleting a category, all transactions attached to it will have their category deleted, hence will not have any category attached</para></warning>
1681 </sect1>
1682
1683 <sect1 id="reports">
1684 <title>Reports</title>
1685 <para>&skrooge; allows you to build highly customized reports, for a deep analysis of your financial status.</para>
1686
1687 <screenshot>
1688 <mediaobject>
1689 <imageobject>
1690 <imagedata fileref="reports.png" format="PNG"/>
1691 </imageobject>
1692 </mediaobject>
1693 </screenshot>
1694
1695 <para>A report is composed of a table (on the left) containing all data used to draw the graph (on the right). The table can be filtered using the dedicated field above, causing the graph to be redrawn with filtered data.</para>
1696
1697 <para>You can choose to display only the table, only the graph, or both.</para>
1698
1699 <sect2 id="setup_report">
1700 <title>Set up report</title>
1701
1702 <sect3 id="report_representation">
1703 <title>Representation</title>
1704 <variablelist>
1705 <varlistentry>
1706 <term>Table</term>
1707 <listitem><para>Display the table.</para></listitem>
1708 </varlistentry>
1709 <varlistentry>
1710 <term>Graph</term>
1711 <listitem><para>Display the graph.</para></listitem>
1712 </varlistentry>
1713 <varlistentry>
1714 <term>Text</term>
1715 <listitem><para>Display the text report, hide table and graph.</para></listitem>
1716 </varlistentry>
1717 </variablelist>
1718 </sect3>
1719
1720 <sect3 id="report_data">
1721 <title>Data</title>
1722 <para>This is where you choose the data to be present in the report. Select what will be shown in lines and in columns, and the mode of computation. There are two distinct values for the mode:</para>
1723 <variablelist>
1724 <varlistentry>
1725 <term>Sum of transactions</term>
1726 <listitem>
1727 <para>In this mode, the total amount of transactions for each month will be computed. If you selected "category" in line, and "month" in column, this will compute the total amount of transactions for each category and for every month.</para>
1728 </listitem>
1729 </varlistentry>
1730 <varlistentry>
1731 <term>Cumulated sum of transactions</term>
1732 <listitem>
1733 <para>If we reuse our previous example ("category" in line, "month" in column), we will have here a cumulated sum, &ie; for each month, we will compute the total amount of transactions up to this month, for each category.</para>
1734 <para>As a practical example, this author uses this mode to draw the evolution of his accounts balance by setting "Accounts" for Lines, and "Month" for Columns.</para>
1735 </listitem>
1736 </varlistentry>
1737 <varlistentry>
1738 <term>Base 100</term>
1739 <listitem>
1740 <para>Like "Sum of transactions" but on base 100.</para>
1741 </listitem>
1742 </varlistentry>
1743 <varlistentry>
1744 <term>Cumulated sum in base 100</term>
1745 <listitem>
1746 <para>Like "Cumulated sum of transactions" but on base 100.</para>
1747 </listitem>
1748 </varlistentry>
1749 <varlistentry>
1750 <term>Percent of columns</term>
1751 <listitem>
1752 <para>The values are expressed in percent of the high column value.</para>
1753 </listitem>
1754 </varlistentry>
1755 <varlistentry>
1756 <term>Absolute percent of columns</term>
1757 <listitem>
1758 <para>The values are expressed in percent of the high column value in absolute.</para>
1759 </listitem>
1760 </varlistentry>
1761 <varlistentry>
1762 <term>Percent of lines</term>
1763 <listitem>
1764 <para>The values are expressed in percent of the high line value.</para>
1765 </listitem>
1766 </varlistentry>
1767 <varlistentry>
1768 <term>Absolute percent of lines</term>
1769 <listitem>
1770 <para>The values are expressed in percent of the high line value in absolute.</para>
1771 </listitem>
1772 </varlistentry>
1773 <varlistentry>
1774 <term>Count number of transactions</term>
1775 <listitem>
1776 <para>.</para>
1777 </listitem>
1778 </varlistentry>
1779 </variablelist>
1780
1781 <para>For lines and columns, it is possible to expand the level of data presented using the <guibutton>plus</guibutton> icon <inlinemediaobject><imageobject><imagedata fileref="plus.png"/></imageobject></inlinemediaobject> right of the field. Use this to show subcategories in the report.</para>
1782 </sect3>
1783
1784 <sect3 id="report_dates">
1785 <title>Dates</title>
1786 <para>Use this to specify the date range for your report. You can use several ways to specify the date range that should cover pretty much every possible date range you need.</para>
1787 </sect3>
1788
1789 <sect3 id="report_transaction_types">
1790 <title>Transaction Types</title>
1791 <para>Select the type of transactions you want to include in your report. For example, if you want to draw a graph showing your expenses distribution per category, you probably do not want to include "Incomes" to your report.</para>
1792 </sect3>
1793
1794 <sect3 id="report_other_filters">
1795 <title>Other filters</title>
1796 <para>From this section, you can select some other filters defined by selection done in other pages. If you want a report only for the categories "Food" and "Gift", you just have to open the page of <link linkend="categories">categories</link>, select the two categories and come back to the report to activate the corresponding filter.</para>
1797 </sect3>
1798
1799 </sect2>
1800
1801 <sect2 id="graph_types">
1802 <title>Graph Types</title>
1803
1804 <para>Once everything is set up to your needs, you should select the graph appearance using the drop down box below the graph. To better understand the differences between each type, let us build a report showing expenses per category (lines) and month (columns):</para>
1805
1806 <screenshot>
1807 <mediaobject>
1808 <imageobject>
1809 <imagedata fileref="report_table.png"/>
1810 </imageobject>
1811 </mediaobject>
1812 </screenshot>
1813
1814 <sect3 id="stack">
1815 <title>Stack</title>
1816 <para>One bar per line, columns stacked.</para>
1817
1818 <screenshot>
1819 <mediaobject>
1820 <imageobject>
1821 <imagedata fileref="stack.png"/>
1822 </imageobject>
1823 </mediaobject>
1824 </screenshot>
1825
1826 <para>The second bar (yellowish) shows category "Security", all months stacked up.</para>
1827
1828 </sect3>
1829
1830 <sect3 id="histogram">
1831 <title>Histogram</title>
1832 <para>For each columns, every line has its own bar.</para>
1833
1834 <screenshot>
1835 <mediaobject>
1836 <imageobject>
1837 <imagedata fileref="histogram.png"/>
1838 </imageobject>
1839 </mediaobject>
1840 </screenshot>
1841
1842 </sect3>
1843
1844
1845 <sect3 id="line">
1846 <title>Line</title>
1847 <screenshot>
1848 <mediaobject>
1849 <imageobject>
1850 <imagedata fileref="line_graph.png"/>
1851 </imageobject>
1852 </mediaobject>
1853 </screenshot>
1854 </sect3>
1855
1856 <sect3 id="point">
1857 <title>Mark</title>
1858 <screenshot>
1859 <mediaobject>
1860 <imageobject>
1861 <imagedata fileref="point_report.png"/>
1862 </imageobject>
1863 </mediaobject>
1864 </screenshot>
1865 </sect3>
1866
1867
1868 <sect3 id="pie">
1869 <title>Pie</title>
1870 <para>The classical pie graph. If the selected value for column is different from "nothing", displays one pie per column.</para>
1871
1872 <screenshot>
1873 <mediaobject>
1874 <imageobject>
1875 <imagedata fileref="pie.png"/>
1876 </imageobject>
1877 </mediaobject>
1878 </screenshot>
1879
1880
1881 </sect3>
1882
1883 <sect3 id="concentric_pie">
1884 <title>Concentric Pie</title>
1885 <para>This one is a bit tricky, and probably needs rework on our side. The intention is to show one ring per level of data.</para>
1886
1887 <screenshot>
1888 <mediaobject>
1889 <imageobject>
1890 <imagedata fileref="concentric_pie.png"/>
1891 </imageobject>
1892 </mediaobject>
1893 </screenshot>
1894
1895 </sect3>
1896
1897 </sect2>
1898
1899
1900 <sect2 id="zoom_graph">
1901 <title>Zoom on graph</title>
1902 <para>&skrooge; makes it possible to zoom in a graph for getting all the small details. Use the zoom control zone above the graph:</para>
1903
1904 <screenshot>
1905 <mediaobject>
1906 <imageobject>
1907 <imagedata fileref="zoom_graph.png"/>
1908 </imageobject>
1909 </mediaobject>
1910 </screenshot>
1911
1912
1913 </sect2>
1914
1915 <sect2 id="report_examples">
1916 <title>Report Examples</title>
1917 <para>Here are some screenshots showing some classical report configurations. You may use them as a reference for your own reports.</para>
1918
1919 <sect3 id="income_expense">
1920 <title>Incomes and Expenses</title>
1921 <para>For each month, compare the total amount of incomes versus the total amount of expenses. Incomes are in blue, expenses in yellow.</para>
1922 <screenshot>
1923 <mediaobject>
1924 <imageobject>
1925 <imagedata fileref="incomes_expenses.png"/>
1926 </imageobject>
1927 </mediaobject>
1928 </screenshot>
1929 </sect3>
1930
1931 <sect3 id="balance_evolution">
1932 <title>Balance Evolution</title>
1933 <para>Show the evolution of the final balance on a monthly basis.</para>
1934 <screenshot>
1935 <mediaobject>
1936 <imageobject>
1937 <imagedata fileref="balance_evolution.png"/>
1938 </imageobject>
1939 </mediaobject>
1940 </screenshot>
1941 </sect3>
1942
1943 <sect3 id="category_distribution">
1944 <title>Incomes and Expenses</title>
1945 <para>Display the distribution of expenses per category for the previous month.</para>
1946 <screenshot>
1947 <mediaobject>
1948 <imageobject>
1949 <imagedata fileref="category_distribution.png"/>
1950 </imageobject>
1951 </mediaobject>
1952 </screenshot>
1953 </sect3>
1954
1955
1956 </sect2>
1957
1958 <sect2 id="going_deeper">
1959 <title>Going Deeper</title>
1960 <para>By double clicking on an item of a graph, you will open the transactions included in this item.</para>
1961 <para>You can open a new report based on an item of a graph too.</para>
1962 <para>So you know you can make a deep analysis of your finances thanks to reports. But how deep is deep? Well, that's even deeper than you imagined… If you are interested, read the <link linkend="holidays_expenses_analysis">hands on exercise</link> analysing this author's expenses during its holidays :)</para>
1963 </sect2>
1964
1965
1966 </sect1>
1967
1968 <sect1 id="monthly_report">
1969 <title>Monthly Report</title>
1970
1971 <para>This plugin shows an overview of your financial situation for a chosen period.</para>
1972
1973 <screenshot>
1974 <mediaobject>
1975 <imageobject>
1976 <imagedata fileref="monthly.png"/>
1977 </imageobject>
1978 </mediaobject>
1979 </screenshot>
1980
1981 <para>You can choose the template you want. You can even create your own template by entering the name of the template you would like to create. Your default text editor will be launched with a sample for your template. You just have to follow the comments in this sample.</para>
1982 <para>Do not hesitate to distribute your templates in the category <literal>&skrooge; report templates</literal> of the <ulink url="https://store.kde.org/browse/cat/338/">KDE Store</ulink>.</para>
1983 </sect1>
1984
1985 <sect1 id="units">
1986 <title>Units</title>
1987 <para>A unit is anything you can express a transaction in. In most cases, this is a currency, but it can also be a stock, or even a car or a house. A unit has different values over time, its value being express in another unit. Example: ACME stock is worth 31.2$ on January 2009.</para>
1988
1989 <screenshot>
1990 <mediaobject>
1991 <imageobject>
1992 <imagedata fileref="units.png" format="PNG"/>
1993 </imageobject>
1994 </mediaobject>
1995 </screenshot>
1996
1997 <sect2 id="edit_units">
1998 <title>Edit Units</title>
1999 <para>Editing units can be done in different ways:</para>
2000 <variablelist>
2001 <varlistentry>
2002 <term>Standard</term>
2003 <listitem><para>This mode allows you choosing amongst the set of predefined units which one you would like to add to the current document.</para></listitem>
2004 </varlistentry>
2005 <varlistentry>
2006 <term>Manual</term>
2007 <listitem><para>This mode allows you to create your own unit. Parameters to be provided are:</para>
2008 <itemizedlist>
2009 <listitem><para>Name: the comprehensive unit name.</para></listitem>
2010 <listitem><para>Symbol: the unit symbol, displayed in most tables and drop down boxes.</para></listitem>
2011 <listitem><para>Type: see <link linkend="unit_types">Unit Types</link>.</para></listitem>
2012 <listitem><para>Reference Unit: the (other) unit used to compute value of the (current) unit. For example, if you have EADS shares, and want to see their value in euros, you should select € as reference unit in EADS unit.</para></listitem>
2013 <listitem><para>Country</para></listitem>
2014 <listitem><para>Download source: The source to download quotes. The recommended one is "Yahoo". By clicking on the arrow on the right of the "Download" field, you can directly download new sources from <ulink url="https://store.kde.org/browse/cat/339/ord/latest/">store.kde.org</ulink></para></listitem>
2015 <listitem><para>Internet Code: The Internet code for this unit. If given this code, &skrooge; is able to download the unit values from selected source.</para></listitem>
2016 </itemizedlist>
2017 </listitem>
2018 </varlistentry>
2019 <varlistentry>
2020 <term>Values</term>
2021 <listitem><para>This editing mode allows for downloading unit values from the Internet, or manual entry of a unit value at a given date.</para></listitem>
2022 </varlistentry>
2023 </variablelist>
2024 </sect2>
2025
2026 <sect2 id="unit_types">
2027 <title>Unit Types</title>
2028 <para>&skrooge; may consider just about anything as a unit, but it does makes a distinction depending on such unit's type:</para>
2029
2030 <variablelist>
2031 <varlistentry>
2032 <term>Primary Currency</term>
2033 <listitem><para>This is the currency that will be used for displaying real transactions amount.</para></listitem>
2034 </varlistentry>
2035 <varlistentry>
2036 <term>Secondary Currency</term>
2037 <listitem><para>If defined, the value in the secondary unit will be displayed upon hovering over a transaction amount.</para>
2038
2039 <screenshot>
2040 <mediaobject>
2041 <imageobject>
2042 <imagedata fileref="secondary_unit_display.png"/>
2043 </imageobject>
2044 </mediaobject>
2045 </screenshot>
2046
2047 </listitem>
2048 </varlistentry>
2049 <varlistentry>
2050 <term>Currency</term>
2051 <listitem><para>Any currency, with no specific role for display.</para></listitem>
2052 </varlistentry>
2053 <varlistentry>
2054 <term>Share</term>
2055 <listitem><para>This type of unit can be used for managing shares.</para></listitem>
2056 </varlistentry>
2057 <varlistentry>
2058 <term>Index</term>
2059 <listitem><para>A stock exchange index, such as the Dow Jones, NASDAQ, CAC40, SBF120…</para></listitem>
2060 </varlistentry>
2061 <varlistentry>
2062 <term>Other</term>
2063 <listitem><para>Any unit that doesn't fit in the above types.</para></listitem>
2064 </varlistentry>
2065 </variablelist>
2066 </sect2>
2067 </sect1>
2068 </chapter>
2069 <chapter id="using-skrooge-advanced">
2070 <title>Using &skrooge; (advanced)</title>
2071
2072 <sect1 id="scheduled">
2073 <title>Scheduled</title>
2074 <para>This plugin shows you the list of all scheduled transactions.</para>
2075
2076 <screenshot>
2077 <mediaobject>
2078 <imageobject>
2079 <imagedata fileref="scheduled.png" format="PNG"/>
2080 </imageobject>
2081 </mediaobject>
2082 </screenshot>
2083
2084 <para>This is where you can set up each scheduled transaction to have its own parameters.</para>
2085
2086 <variablelist>
2087 <varlistentry>
2088 <term>Next Occurrence</term>
2089 <listitem><para>Displayed for information, but can also be used to force the date of the next occurrence.</para></listitem>
2090 </varlistentry>
2091 <varlistentry>
2092 <term>Once every</term>
2093 <listitem><para>You can set a transaction to be repeated over a given number of days, months, or years.</para></listitem>
2094 </varlistentry>
2095 <varlistentry>
2096 <term>Number of Occurrences</term>
2097 <listitem><para>If the occurrence has a limited number of occurrences, you can check this option and define either the number of remaining occurrences, or the date of the last occurrence.</para></listitem>
2098 </varlistentry>
2099 <varlistentry>
2100 <term>Remind me</term>
2101 <listitem><para>If you want &skrooge; to display a notification to remind you about the upcoming scheduled transaction, you may check this option and set the number of days before term when the warning shall occur.</para></listitem>
2102 </varlistentry>
2103 <varlistentry>
2104 <term>Automatically Write</term>
2105 <listitem><para>If you want &skrooge; to automatically write the upcoming scheduled transaction, you may check this option and set the number of days before term when it will be written.</para></listitem>
2106 </varlistentry>
2107 <varlistentry>
2108 <term>Template</term>
2109 <listitem><para>You can convert a schedule to template or non-template mode. This will create/remove a corresponding template transaction.</para></listitem>
2110 </varlistentry>
2111 </variablelist>
2112 <para>To modify the transaction (category, amount, etc.), you have to click on <guilabel>Jump to the transaction</guilabel>.</para>
2113
2114
2115 <para>Double clicking on a scheduled transaction will display the list of transactions already registered for this scheduled transaction in a new tab.</para>
2116
2117 <sect2 id="scheduled_transactions">
2118 <title>Scheduled Transactions</title>
2119
2120 <para>If you schedule a transaction, it will be used as a reference when inserting the next occurrence. Let us see an example, with this transaction:</para>
2121
2122 <table>
2123 <title>Scheduled Transactions (step 1)</title>
2124 <tgroup cols="4">
2125 <thead>
2126 <row>
2127 <entry>Date</entry>
2128 <entry>Payee</entry>
2129 <entry>Category</entry>
2130 <entry>Amount</entry>
2131 </row>
2132 </thead>
2133 <tbody>
2134 <row>
2135 <entry>20/06/2009</entry>
2136 <entry>&kde;</entry>
2137 <entry>Donations > Open Source</entry>
2138 <entry>20€</entry>
2139 </row>
2140 </tbody>
2141 </tgroup>
2142 </table>
2143
2144 <para>Now, if you schedule this transaction, it will be written exactly like this for the next occurrence:</para>
2145
2146 <table>
2147 <title>Scheduled Transactions (Step 2)</title>
2148 <tgroup cols="4">
2149 <thead>
2150 <row>
2151 <entry>Date</entry>
2152 <entry>Payee</entry>
2153 <entry>Category</entry>
2154 <entry>Amount</entry>
2155 </row>
2156 </thead>
2157 <tbody>
2158 <row>
2159 <entry>20/06/2009</entry>
2160 <entry>&kde;</entry>
2161 <entry>Donations > Open Source</entry>
2162 <entry>20€</entry>
2163 </row>
2164 <row>
2165 <entry>20/07/2009</entry>
2166 <entry>&kde;</entry>
2167 <entry>Donations > Open Source</entry>
2168 <entry>20€</entry>
2169 </row>
2170 </tbody>
2171 </tgroup>
2172 </table>
2173
2174 <para>If you change something in the last occurrence, it will become the new reference for the next occurrence. For example, if you raise your monthly contribution to &kde; to 25€ in July, the next occurrence will also have an amount of 25€:</para>
2175
2176 <table>
2177 <title>Scheduled Transactions (step 3)</title>
2178 <tgroup cols="4">
2179 <thead>
2180 <row>
2181 <entry>Date</entry>
2182 <entry>Payee</entry>
2183 <entry>Category</entry>
2184 <entry>Amount</entry>
2185 </row>
2186 </thead>
2187 <tbody>
2188 <row>
2189 <entry>20/06/2009</entry>
2190 <entry>&kde;</entry>
2191 <entry>Donations > Open Source</entry>
2192 <entry>20€</entry>
2193 </row>
2194 <row>
2195 <entry>20/07/2009</entry>
2196 <entry>&kde;</entry>
2197 <entry>Donations > Open Source</entry>
2198 <entry>25€</entry>
2199 </row>
2200 <row>
2201 <entry>20/08/2009</entry>
2202 <entry>&kde;</entry>
2203 <entry>Donations > Open Source</entry>
2204 <entry>25€</entry>
2205 </row>
2206 </tbody>
2207 </tgroup>
2208 </table>
2209
2210 <para>All in all, a scheduled transaction is a dynamic object, where the last occurrence is the reference. But maybe you'd like all occurrences to be static, &ie; the same values are always inserted for each new occurrence ? Enter <link linkend="scheduled_templates">Scheduled Templates</link>.</para>
2211
2212 </sect2>
2213
2214
2215 <sect2 id="scheduled_templates">
2216 <title>Scheduled Templates</title>
2217
2218 <para><link linkend="templates">Templates</link> are a kind of reference transactions. When scheduling a template, every new occurrence will be exactly equal to the template. Let's reuse our <link linkend="schedule_transaction">previous chapter</link> example, by creating a template like this:</para>
2219
2220 <table>
2221 <title>Scheduled Templates (step 1)</title>
2222 <tgroup cols="4">
2223 <thead>
2224 <row>
2225 <entry>Date</entry>
2226 <entry>Payee</entry>
2227 <entry>Category</entry>
2228 <entry>Amount</entry>
2229 </row>
2230 </thead>
2231 <tbody>
2232 <row>
2233 <entry>20/06/2009</entry>
2234 <entry>&kde;</entry>
2235 <entry>Donations > Open Source</entry>
2236 <entry>20€</entry>
2237 </row>
2238 </tbody>
2239 </tgroup>
2240 </table>
2241
2242 <para>The next occurrence will be:</para>
2243
2244
2245 <table>
2246 <title>Scheduled Templates (step 2)</title>
2247 <tgroup cols="4">
2248 <thead>
2249 <row>
2250 <entry>Date</entry>
2251 <entry>Payee</entry>
2252 <entry>Category</entry>
2253 <entry>Amount</entry>
2254 </row>
2255 </thead>
2256 <tbody>
2257 <row>
2258 <entry>20/06/2009</entry>
2259 <entry>&kde;</entry>
2260 <entry>Donations > Open Source</entry>
2261 <entry>20€</entry>
2262 </row>
2263 <row>
2264 <entry>20/07/2009</entry>
2265 <entry>&kde;</entry>
2266 <entry>Donations > Open Source</entry>
2267 <entry>20€</entry>
2268 </row>
2269 </tbody>
2270 </tgroup>
2271 </table>
2272
2273 <para>Now change your July contribution to &kde; to 25€. Because you have scheduled a template with 20€ as amount, the next occurrence will also have an amount of 20€:</para>
2274
2275 <table>
2276 <title>Scheduled Templates (step 3)</title>
2277 <tgroup cols="4">
2278 <thead>
2279 <row>
2280 <entry>Date</entry>
2281 <entry>Payee</entry>
2282 <entry>Category</entry>
2283 <entry>Amount</entry>
2284 </row>
2285 </thead>
2286 <tbody>
2287 <row>
2288 <entry>20/06/2009</entry>
2289 <entry>&kde;</entry>
2290 <entry>Donations > Open Source</entry>
2291 <entry>20€</entry>
2292 </row>
2293 <row>
2294 <entry>20/07/2009</entry>
2295 <entry>&kde;</entry>
2296 <entry>Donations > Open Source</entry>
2297 <entry>25€</entry>
2298 </row>
2299 <row>
2300 <entry>20/08/2009</entry>
2301 <entry>&kde;</entry>
2302 <entry>Donations > Open Source</entry>
2303 <entry>20€</entry>
2304 </row>
2305 </tbody>
2306 </tgroup>
2307 </table>
2308
2309 <para>If you need to change the monthly value, just edit the template, and all future occurrences will have the new value.</para>
2310 </sect2>
2311
2312 <sect2 id="schedule_assign">
2313 <title>Assign Schedule</title>
2314
2315 <para>If you scheduled a transaction that is being repeated on a regular basis, you can link some old transactions to this schedule using the "Assign schedule" context menu of a transaction. This menu also allow to unlink a transaction from a schedule or link it to a different one.</para>
2316
2317 <screenshot>
2318 <mediaobject>
2319 <imageobject>
2320 <imagedata fileref="assign_schedule.png" format="PNG"/>
2321 </imageobject>
2322 </mediaobject>
2323 </screenshot>
2324 </sect2>
2325 </sect1>
2326
2327 <sect1 id="trackers">
2328 <title>Trackers</title>
2329 <para>The trackers allow you to aggregate some transactions together in a group, so you can follow them more closely. This may come in handy to follow expenses for which you expect a refund, or simply knowing how much you spent during your last holidays in the Bahamas.</para>
2330
2331 <screenshot>
2332 <mediaobject>
2333 <imageobject>
2334 <imagedata fileref="trackers.png" format="PNG"/>
2335 </imageobject>
2336 </mediaobject>
2337 </screenshot>
2338
2339 <para>For example, imagine you have been sent to Italy by your company. Once there, you paid for your hotel room. In &skrooge;, you can create a transaction in the category "Business > Travels > Hotel", and assign a tracker called "Business Travel in Italy". You can assign this tracker to all professional expenses you make there. Then, if all goes well, your company pays you back for all these expenses, and you can create an income transaction, and also affect it to the "Business Travel in Italy" tracker.</para>
2340 <para>By affecting trackers to transactions that shall be reimbursed, you are able to follow completion of the reimbursement.</para>
2341 <para>This, of course, also works the other way round: if someone lends you some money, you are able to monitor how much you still have to reimburse.</para>
2342 <para>Double clicking on a tracker in the track view will open a new tab containing all transactions attached to this tracker.</para>
2343
2344 <tip><para>Sometimes, you would like to track the refund of a payment done before you started to use &skrooge;. What is the best way of doing this, as it is not possible to set an initial amount on a tracker?</para>
2345
2346 <para>You can create a split transaction with:
2347 <itemizedlist>
2348 <listitem><para>amount=0 to avoid impact on reports.</para></listitem>
2349 <listitem><para>a split with the expected amount associated to the tracker.</para></listitem>
2350 <listitem><para>the other split with the opposite amount not associated to a tracker.</para></listitem>
2351 </itemizedlist>
2352 </para></tip>
2353
2354 <sect2 id="close_tracker">
2355 <title>Close Tracker</title>
2356
2357 <para>When you no longer need the tracker, for example, because it has been fully reimbursed, you may simply delete it. Doing, this, however, will discard all information you have entered, which you may not wish to do as such information may be of use to you in the future.</para>
2358 <para>A cleaner solution is to close the tracker: when a tracker is closed, it can be easily hidden from the tracker's view using the dedicated option.</para>
2359 </sect2>
2360
2361 </sect1>
2362
2363 <sect1 id="search_and_process">
2364 <title>Search & Process</title>
2365
2366 <para>This plugin allows for the building of complex queries to find transactions. You can also optionally apply some transformations to them. Here is a use case:</para>
2367
2368 <blockquote><para><!-- Please make sure it is identical to use case in the Search & Process real case study, in appendix -->John downloads some data from his bank. The data comes, obviously, without indication as to the category. In fact, everything is written in the comment field. John would like some automatic way to correctly set up the category and other attributes based on the content of the comment.</para></blockquote>
2369
2370 <para>So how does this work? First, you will define a search criteria, which will give you a list of transactions. Then, define the transformations to apply on these transactions.</para>
2371
2372 <note><para>A <link linkend="search_process_real_case">real case study</link> can be found in appendix, providing some hands on exercise for the aforementioned use case.</para></note>
2373
2374 <sect2 id="define_search_criteria">
2375 <title>Define search criteria</title>
2376
2377 <screenshot>
2378 <mediaobject>
2379 <imageobject>
2380 <imagedata fileref="define_search.png" format="PNG"/>
2381 </imageobject>
2382 </mediaobject>
2383 </screenshot>
2384
2385 <para>Here, you can define the query for finding transactions using a combination of parameters. In the above picture, you can find a table with transaction attributes for the header. By editing a line, you create a new clause in the query. Each column is combined with other columns using a logical "and":</para>
2386 <para>(column1 and column2)</para>
2387 <para>If you add a new line, you create another clause combine with the first line by a logical "or":</para>
2388 <para>[line1] or [line2].</para>
2389
2390 <para>All in all, the combination of columns and lines can be read as:</para>
2391 <para>(column1 and column3) or (column2 and column3)</para>
2392
2393 <para>Of course, you can have as many lines and columns as you need in a search query.</para>
2394
2395 <para>Once satisfied with a query definition, you can add it to the list of existing search criteria, or modify an existing one.</para>
2396
2397 </sect2>
2398
2399
2400 <sect2 id="view_search_result">
2401 <title>View search results</title>
2402
2403 <para>When selecting a search query in the queries view, the number of found transactions is displayed below the table:</para>
2404
2405 <screenshot>
2406 <mediaobject>
2407 <imageobject>
2408 <imagedata fileref="preview_search_result.png" format="PNG"/>
2409 </imageobject>
2410 </mediaobject>
2411 </screenshot>
2412
2413
2414 <para>When double-clicking on a search query in the query view, all found transactions are displayed in a new tab:</para>
2415
2416 <screenshot>
2417 <mediaobject>
2418 <imageobject>
2419 <imagedata fileref="search_result.png" format="PNG"/>
2420 </imageobject>
2421 </mediaobject>
2422 </screenshot>
2423
2424 </sect2>
2425
2426
2427 <sect2 id="define_processing">
2428 <title>Define Processing</title>
2429
2430 <para>If you need to apply some processing on all transactions found, select the concerned query, and activate the process definition panel:</para>
2431
2432 <screenshot>
2433 <mediaobject>
2434 <imageobject>
2435 <imagedata fileref="define_processing.png" format="PNG"/>
2436 </imageobject>
2437 </mediaobject>
2438 </screenshot>
2439
2440 <para>In this panel, you can define the transformations to perform on transactions. Note that it is intentionally impossible to set a transaction's amount or date in this panel.</para>
2441
2442 </sect2>
2443
2444
2445 <sect2 id="define_alarm">
2446 <title>Define Alarm</title>
2447 <para>A special kind of use of the Search & Process plugin is the ability to define alarms. An alarm is basically &skrooge; calling your attention to some kind of event, such as your monthly budget for a category being reached.</para>
2448
2449 <screenshot>
2450 <mediaobject>
2451 <imageobject>
2452 <imagedata fileref="alarm.png" format="PNG"/>
2453 </imageobject>
2454 </mediaobject>
2455 </screenshot>
2456
2457 <para>To define an alarm, first define the search criteria giving the set of transactions for which you need an alert. For example, all transactions in current month and in category "Clothes". Then, define the amount for which the alert shall be raised, for example 100€, and define the Alarm message that &skrooge; will send to you when the amount is reached.</para>
2458 <tip><para>Alarm messages can have parameters for the total amount (%1), alarm amount (%2) and difference (%3).</para></tip>
2459
2460 </sect2>
2461
2462 </sect1>
2463
2464 <sect1 id="budgets">
2465 <title>Budgets</title>
2466 <para>This plugin allows you to define and manage your budget.</para>
2467
2468 <screenshot>
2469 <mediaobject>
2470 <imageobject>
2471 <imagedata fileref="budgets.png" format="PNG"/>
2472 </imageobject>
2473 </mediaobject>
2474 </screenshot>
2475 <para>Like in all other financial software, &skrooge; allows you to define a budget. You can do it manually or automatically.</para>
2476 <sect2 id="budget_definition">
2477 <title>Budget definition</title>
2478 <para>In manual mode, you can:
2479 <itemizedlist>
2480 <listitem><para>Define a budget amount for a category for a year.</para></listitem>
2481 <listitem><para>Define a budget amount for a category for all months of a year.</para></listitem>
2482 <listitem><para>Define a budget amount for a category for a specific month of a year.</para></listitem>
2483 <listitem><para>Define if income or expenditure of sub-categories must be taken into account in the defined budget (example: if the option is selected then a budget for the category "Car" will take into account the category "Car > Fuel").</para></listitem>
2484 </itemizedlist>
2485 <tip><para>You can define a budget capturing all income or expenditure not defined in another budget by leaving the category empty. This is really useful to make sure that you do not miss an expenditure.</para></tip>
2486 </para>
2487
2488 <para>In automatic mode, you can:
2489 <itemizedlist>
2490 <listitem><para>Define a budget for a year based on the transactions of the previous year.</para></listitem>
2491 <listitem><para>Define missing budget items to balance each month and/or the year (even on manually defined budget).</para></listitem>
2492 </itemizedlist>
2493 </para>
2494 </sect2>
2495
2496 <sect2 id="budget_rules">
2497 <title>Budget rules</title>
2498 <para>To go further in budgeting we will take as example the following balanced budget:
2499 <itemizedlist>
2500 <listitem><para>-500€ per month for "Food".</para></listitem>
2501 <listitem><para>+500€ per month for all other categories of expenditure and income.</para></listitem>
2502 </itemizedlist>
2503 </para>
2504
2505 <para>Imagine that you spent 600€ for "Food" during the previous month! &skrooge; informed you that you are over the defined budget but you could not stop eating. So you spent more than expected! How should you deal with this?</para>
2506 <para>Budget rules will allow you to define how you want to do with the delta (positive or negative). For example, you can choose to transfer the delta of one month to the next month. In this case, your new budget for "Food" for the current month is -400€ (-500+100). So you have to take care to recover the situation.</para>
2507 <para>Budget rules can also help you for your project. For example, you can define a rule like this: All positive delta (saving) on "Food" are transferred in "Holidays". This way, when you have the expected amount in "Holidays" budget, then you know that you can go.</para>
2508 </sect2>
2509 </sect1>
2510
2511 <sect1 id="simulations">
2512 <title>Simulations</title>
2513 <para>This plugin allows you to carry out simulations</para>
2514
2515 <screenshot>
2516 <mediaobject>
2517 <imageobject>
2518 <imagedata fileref="simulations.png" format="PNG"/>
2519 </imageobject>
2520 </mediaobject>
2521 </screenshot>
2522 <para>You can define the rates for each account and estimate the annual interest. You can also generate an amortization table.</para>
2523 </sect1>
2524
2525 </chapter>
2526
2527 <chapter id="settings">
2528 <title>Settings</title>
2529 <para>You can find here a description of all settings used by &skrooge;. These settings are common with all your documents.</para>
2530
2531 <sect1 id="settings_general">
2532 <title>General</title>
2533
2534 <screenshot>
2535 <mediaobject>
2536 <imageobject>
2537 <imagedata fileref="settings_general.png" format="PNG"/>
2538 </imageobject>
2539 </mediaobject>
2540 </screenshot>
2541 <para>You can set here the main general settings. The most important ones are those to describe what to do when a page or a bookmark is modified.</para>
2542 </sect1>
2543
2544 <sect1 id="settings_file">
2545 <title>File</title>
2546
2547 <screenshot>
2548 <mediaobject>
2549 <imageobject>
2550 <imagedata fileref="settings_file.png" format="PNG"/>
2551 </imageobject>
2552 </mediaobject>
2553 </screenshot>
2554 <para>All these settings are relative to the storage. You can choose how to create backup files, if you want to use the &kde; wallet to store passwords, etc.</para>
2555 </sect1>
2556
2557 <sect1 id="settings_bookmarks">
2558 <title>Bookmarks</title>
2559
2560 <screenshot>
2561 <mediaobject>
2562 <imageobject>
2563 <imagedata fileref="settings_bookmarks.png" format="PNG"/>
2564 </imageobject>
2565 </mediaobject>
2566 </screenshot>
2567 <para>Only one option here to choose whether or not we want to pin automatically loaded bookmarks.</para>
2568 </sect1>
2569
2570 <sect1 id="settings_history">
2571 <title>History</title>
2572
2573 <screenshot>
2574 <mediaobject>
2575 <imageobject>
2576 <imagedata fileref="settings_history.png" format="PNG"/>
2577 </imageobject>
2578 </mediaobject>
2579 </screenshot>
2580 <para>These options will help you to better manage your modifications history.</para>
2581 </sect1>
2582
2583 <sect1 id="settings_dashboard">
2584 <title>Dashboard</title>
2585
2586 <screenshot>
2587 <mediaobject>
2588 <imageobject>
2589 <imagedata fileref="settings_dashboard.png" format="PNG"/>
2590 </imageobject>
2591 </mediaobject>
2592 </screenshot>
2593 <para>Only one option here to choose the dashboard you want (QML or not).</para>
2594 </sect1>
2595
2596 <sect1 id="settings_transactions">
2597 <title>Transactions</title>
2598
2599 <screenshot>
2600 <mediaobject>
2601 <imageobject>
2602 <imagedata fileref="settings_transactions.png" format="PNG"/>
2603 </imageobject>
2604 </mediaobject>
2605 </screenshot>
2606 <para>Here you will find options for editing transactions.</para>
2607 <para>Please note that you can improve performance if you don't use the "balance" column by avoiding calculating balances for no reason.</para>
2608 <para>What to do if an action breaks a reconciliation: A check is made after each modification to see if the modification breaks the previous reconciliation. Here you can choose what to do if this happens.</para>
2609 <para>What to do if an action breaks an import: A check is made after each modification to see if the modification breaks the previous import. Here you can choose what to do if this happens.</para>
2610 </sect1>
2611
2612 <sect1 id="settings_scheduled">
2613 <title>Scheduled transactions</title>
2614
2615 <screenshot>
2616 <mediaobject>
2617 <imageobject>
2618 <imagedata fileref="settings_scheduled.png" format="PNG"/>
2619 </imageobject>
2620 </mediaobject>
2621 </screenshot>
2622 <para>Here you will find options for editing scheduled transactions.</para>
2623 <para>If you toggle the create template option, and additional option will appear that will allow you to convert all existing scheduled transactions.</para>
2624 <screenshot>
2625 <mediaobject>
2626 <imageobject>
2627 <imagedata fileref="settings_scheduled_convert.png" format="PNG"/>
2628 </imageobject>
2629 </mediaobject>
2630 </screenshot>
2631 </sect1>
2632
2633 <sect1 id="settings_search">
2634 <title>Search and process</title>
2635
2636 <screenshot>
2637 <mediaobject>
2638 <imageobject>
2639 <imagedata fileref="settings_search.png" format="PNG"/>
2640 </imageobject>
2641 </mediaobject>
2642 </screenshot>
2643 <para>Only one option here to choose the alarm frequency.</para>
2644 </sect1>
2645
2646 <sect1 id="settings_report">
2647 <title>Report</title>
2648
2649 <screenshot>
2650 <mediaobject>
2651 <imageobject>
2652 <imagedata fileref="settings_report.png" format="PNG"/>
2653 </imageobject>
2654 </mediaobject>
2655 </screenshot>
2656 <para>You can choose some display options for reports here.</para>
2657 </sect1>
2658
2659 <sect1 id="settings_units">
2660 <title>Units</title>
2661
2662 <screenshot>
2663 <mediaobject>
2664 <imageobject>
2665 <imagedata fileref="settings_units.png" format="PNG"/>
2666 </imageobject>
2667 </mediaobject>
2668 </screenshot>
2669 <para>You can choose some options relative to download of unit quotes here.</para>
2670 </sect1>
2671
2672 <sect1 id="settings_import">
2673 <title>Import / Export</title>
2674
2675 <screenshot>
2676 <mediaobject>
2677 <imageobject>
2678 <imagedata fileref="settings_import_1.png" format="PNG"/>
2679 </imageobject>
2680 </mediaobject>
2681 </screenshot>
2682 <para>The general import settings.</para>
2683
2684 <screenshot>
2685 <mediaobject>
2686 <imageobject>
2687 <imagedata fileref="settings_import_2.png" format="PNG"/>
2688 </imageobject>
2689 </mediaobject>
2690 </screenshot>
2691 <para>If you use the CSV import, you will have to modify these settings to help &skrooge; to identify the columns.</para>
2692
2693 <screenshot>
2694 <mediaobject>
2695 <imageobject>
2696 <imagedata fileref="settings_import_3.png" format="PNG"/>
2697 </imageobject>
2698 </mediaobject>
2699 </screenshot>
2700 <para>In some specific cases, you could have to force the date format for QIF files. Most of the time, &skrooge; is able to find it automatically.</para>
2701
2702 <screenshot>
2703 <mediaobject>
2704 <imageobject>
2705 <imagedata fileref="settings_import_4.png" format="PNG"/>
2706 </imageobject>
2707 </mediaobject>
2708 </screenshot>
2709 <para>You can activate the import backends from the list here.</para>
2710 </sect1>
2711 </chapter>
2712
2713 <chapter id="howto">
2714 <title>How to…</title>
2715 <qandaset id="faqlist">
2716 <qandaentry>
2717 <question id="howto_language">
2718 <para>How to use &skrooge; in my language?</para>
2719 </question>
2720 <answer>
2721 <para>Check if &skrooge; is well <ulink url="http://l10n.kde.org/stats/gui/trunk-kf5/po/skrooge.po/">translated to your language</ulink>
2722 and if you have installed all packages for &skrooge; provided by your distribution.</para>
2723 </answer>
2724 </qandaentry>
2725
2726 <qandaentry>
2727 <question id="howto_currency">
2728 <para>How to set default currency and date format?</para>
2729 </question>
2730 <answer>
2731 <para>Default currency and date format are retrieved from &plasma;'s &systemsettings;. Some distributions do not ship it with &skrooge;. In such case you should install it through your distribution's package manager.</para>
2732
2733 <para>You can then start it in a console: <userinput>systemsettings5</userinput></para>
2734
2735 <para>And select your preferred settings, in the <guilabel>Format</guilabel> section.</para>
2736 </answer>
2737 </qandaentry>
2738
2739 <qandaentry>
2740 <question id="howto_size">
2741 <para>How to reduce the size of my document?</para>
2742 </question>
2743 <answer>
2744 <para>The size of your document can be very important. If you delete some old transactions, the size will increase.
2745 This is normal because &skrooge; keeps the history of all modifications for the undo/redo mechanism.
2746 So if you want to reduce the size of your document, you just have to clear the history.</para>
2747 </answer>
2748 </qandaentry>
2749
2750 <qandaentry>
2751 <question id="howto_extractor">
2752 <para>How to define a new invoice extractor?</para>
2753 </question>
2754 <answer>
2755 <para>&skrooge; uses pdftotext to extract all strings of a &PDF;. After that, it uses a text file describing how to find key values. If you want to define a new invoice extractor, you have to do the following:</para>
2756 <itemizedlist>
2757 <listitem><para>Launch <command>pdftotext</command> on your &PDF; file</para></listitem>
2758 <listitem><para>Open the text file generated and the corresponding &PDF; file</para></listitem>
2759 <listitem><para>Create a new text with an extension <filename class="extension">.extractor</filename>. Example: <filename>google.extractor</filename></para></listitem>
2760 <listitem><para>Your file must be like this:</para>
2761 <programlisting>
2762 payee=REGEXPCAP:^(Biofan) SPRL$
2763 date=REGEXPCAP:^Order Date: (.*)$
2764 dateformat=dd MMM yyyy
2765 number=REGEXPCAP:^N° de facture (.*)$
2766 mode=SET:Carte
2767 comment=REGEXPCAP:^N° de commande (.*)$|SET:Commande %1
2768 amount=REGEXP:^Montant global:$|LINEOFFSET:2
2769 </programlisting>
2770 <para>Each attribute (payee, date, number, mode, comment and amount) use the same syntax: COMMAND:value|COMMAND:value|…</para>
2771 <para>The command can be:</para>
2772 <itemizedlist>
2773 <listitem><para><command>REGEXPCAP</command>: This is a regular expression capturing a value</para></listitem>
2774 <listitem><para><command>REGEXP</command>: To find the line in the file matching a regular expression</para></listitem>
2775 <listitem><para><command>LINEOFFSET</command>: To change the line index.</para></listitem>
2776 <listitem><para><command>SET</command>: To force the value. Can be used as first command or after the REGEXPCAP (see example).</para></listitem>
2777 </itemizedlist>
2778 <para>dateformat is the format of the date extracted.</para>
2779 </listitem>
2780 <listitem><para>Put this file into the same folder as all other <filename class="extension">.extractor</filename> files</para></listitem>
2781 </itemizedlist>
2782 </answer>
2783 </qandaentry>
2784 </qandaset>
2785
2786 </chapter>
2787
2788 <chapter id="credits">
2789 <title>Credits and License</title>
2790 <para>
2791 &skrooge;
2792 </para>
2793 <para>
2794 Program copyright 2008-2020 Stéphane Mankowski
2795 <email>stephane@mankowski.fr</email>
2796 </para>
2797 <para>
2798 Documentation copyright 2008-2020 Guillaume DE BURE
2799 <email>gdebure@yahoo.com</email>
2800 </para>
2801 <!-- TRANS:CREDIT_FOR_TRANSLATORS -->
2802 &underFDL;
2803 &underGPL;
2804 </chapter>
2805
2806 <appendix id="search_process_real_case">
2807 <title>Search & Process real case study</title>
2808
2809 <para>OK, we have to admit that while being quite powerful, the <link linkend="search_and_process">Search & Process</link> plugin is maybe a bit tricky to understand. Here is a small exercise that will come to grips with it. Remember the use case for Search & Process ?</para>
2810
2811 <blockquote><para><!-- Please make sure it is identical to use case in the Search & Process section -->John downloads some data from his bank. The data comes, obviously, without indication as to the category. In fact, everything is written in the comment field. John would like some automatic way to correctly set up the category and other attributes based on the content of the comment.</para></blockquote>
2812
2813
2814 <para>John knows that his bank put the name of the payee in the comment field, and he wants all his payments to &kde; to be in category Donations & Open Source. We will look for all transactions with the comment field containing &kde;:</para>
2815
2816 <table>
2817 <title>Search Definition</title>
2818 <tgroup cols="1">
2819 <thead>
2820 <row>
2821 <entry>Comment</entry>
2822 </row>
2823 </thead>
2824 <tbody>
2825 <row>
2826 <entry>contains '&kde;'</entry>
2827 </row>
2828 </tbody>
2829 </tgroup>
2830 </table>
2831
2832 <para>Add this search definition to the list of existing searches using the <guibutton>Add</guibutton> button.</para>
2833
2834 <para>Next, we need to tell &skrooge; to set all transactions found by this query in category Donations > Open Source. Change the Query type to Update using the drop down box, and define the transformations to apply:</para>
2835
2836 <table>
2837 <title>Update Definition</title>
2838 <tgroup cols="2">
2839 <thead>
2840 <row>
2841 <entry>Comment</entry>
2842 <entry>Category</entry>
2843 </row>
2844 </thead>
2845 <tbody>
2846 <row>
2847 <entry>=''</entry>
2848 <entry>='Donations > Open Source'</entry>
2849 </row>
2850 </tbody>
2851 </tgroup>
2852 </table>
2853
2854 <tip><para>Notice that we also removed the original comment by setting it to an empty string. This is for readability sake, but you may wish to keep it for historical reasons.</para></tip>
2855
2856 <para>Add this process to the previously defined search using the <guibutton>Add</guibutton> button.</para>
2857
2858 <para>So far, so good. Now, let's apply the process on all imported transactions not yet validated (click on the <guibutton>Apply</guibutton> button):</para>
2859
2860 <screenshot>
2861 <mediaobject>
2862 <imageobject>
2863 <imagedata fileref="apply_process.png" format="PNG"/>
2864 </imageobject>
2865 </mediaobject>
2866 </screenshot>
2867
2868 <para>That's it! If you go back to the transactions view, you will notice that all concerned transactions have been updated. In case anything went wrong, do not forget that <link linkend="undo_redo">Undo</link> is your friend! Even if the process modified 2327 transactions, this is still one undoable action for &skrooge;.</para>
2869
2870 </appendix>
2871
2872 <appendix id="holidays_expenses_analysis">
2873 <title>Deep analysis exercise: Holidays expenses</title>
2874 <para>To illustrate the analysis capabilities of &skrooge;, we are going to examine this author's expenses during his holidays :).</para>
2875
2876 <sect1 id="analysis_context">
2877 <title>Analysis Context</title>
2878 <para>In order to understand the exercise, you need to know a few things about these holidays. They span over nearly a full month during summer 2009, and involved renting several rooms in several locations in France. There was also a fair amount of fuel, as these holidays also spanned over a rather large part of France.</para>
2879 </sect1>
2880
2881 <sect1 id="analysis_data_organisation">
2882 <title>Data Organisation</title>
2883 <para>The author carefully entered his transactions, by affecting them categories, but also by adding them to the "Holidays, summer 2009" <link linkend="trackers">tracker</link>. Categories often have subcategories, such as "Transport > Car > Fuel", allowing for this detailed analysis.</para>
2884 <screenshot>
2885 <mediaobject>
2886 <imageobject>
2887 <imagedata fileref="analysis_transactions_view.png" format="PNG"/>
2888 </imageobject>
2889 </mediaobject>
2890 </screenshot>
2891 </sect1>
2892
2893 <sect1 id="analysis_total_cost">
2894 <title>Finding the holidays total cost</title>
2895 <para>This is so easy, it is not even funny: open the Trackers view, read the "Amount" column for our tracker:</para>
2896 <screenshot>
2897 <mediaobject>
2898 <imageobject>
2899 <imagedata fileref="analysis_trackers_view.png" format="PNG"/>
2900 </imageobject>
2901 </mediaobject>
2902 </screenshot>
2903 <para>Let's move to more interesting stuff…</para>
2904 </sect1>
2905
2906 <sect1 id="analysis_expenses_distribution">
2907 <title>Expenses Distribution</title>
2908 <para>So this is all very good, but where did all that money go ? To find this out, let us build a report on the tracker. Right click on our tracker line and choose <guimenuitem>Open report…</guimenuitem>.</para>
2909 <screenshot>
2910 <mediaobject>
2911 <imageobject>
2912 <imagedata fileref="analysis_build_report.png" format="PNG"/>
2913 </imageobject>
2914 </mediaobject>
2915 </screenshot>
2916
2917
2918 <para>This will open a report in a new tab, only for transactions associated with the tracker. The default parameters for dates are "Current Month", so there is a possibility that the report is empty if all transactions in the tracker were made before this. Let's change it to "All Dates":</para>
2919 <screenshot>
2920 <mediaobject>
2921 <imageobject>
2922 <imagedata fileref="analysis_report_1.png" format="PNG"/>
2923 </imageobject>
2924 </mediaobject>
2925 </screenshot>
2926 <para>This gives a first nice overview of the expenses per category. Let's display this in a pie chart, for a more natural presentation:</para>
2927
2928 <screenshot>
2929 <mediaobject>
2930 <imageobject>
2931 <imagedata fileref="analysis_report_2.png" format="PNG"/>
2932 </imageobject>
2933 </mediaobject>
2934 </screenshot>
2935
2936
2937 <para>It is now quite clear that most of the holidays expenses were for transport and food. Any more indication ? Sure, let's dig one level more in categories, using the <guibutton>plus</guibutton> icon <inlinemediaobject><imageobject><imagedata fileref="category_one_level_more.png"/></imageobject></inlinemediaobject>.</para>
2938 <screenshot>
2939 <mediaobject>
2940 <imageobject>
2941 <imagedata fileref="analysis_report_3.png" format="PNG"/>
2942 </imageobject>
2943 </mediaobject>
2944 </screenshot>
2945
2946 <para>Hmm, not much more information here, except that in the "Transport" category, the "Car" subcategory is the only one used. Let's build a graph on that subcategory, by selecting the pie slice, right-clicking on it, and select <guimenuitem>Open report</guimenuitem>:</para>
2947 <screenshot>
2948 <mediaobject>
2949 <imageobject>
2950 <imagedata fileref="analysis_build_transport_report.png" format="PNG"/>
2951 </imageobject>
2952 </mediaobject>
2953 </screenshot>
2954
2955 <para>This will open another tab with a report only with the "Transport > Car" category.</para>
2956 <screenshot>
2957 <mediaobject>
2958 <imageobject>
2959 <imagedata fileref="analysis_report_4.png" format="PNG"/>
2960 </imageobject>
2961 </mediaobject>
2962 </screenshot>
2963 <para>Hmm, not really interesting… But there are more subcategories. Let's expand it again:</para>
2964 <screenshot>
2965 <mediaobject>
2966 <imageobject>
2967 <imagedata fileref="analysis_report_5.png" format="PNG"/>
2968 </imageobject>
2969 </mediaobject>
2970 </screenshot>
2971 <para>Ah, now we know that we spent 362.27€ on fuel, and 131.90€ on road taxes (in France, you have to pay to drive on some highways). Ok, I know this was to be expected ;-). I am also interested in knowing how these two categories were used over time:</para>
2972 <screenshot>
2973 <mediaobject>
2974 <imageobject>
2975 <imagedata fileref="analysis_report_6.png" format="PNG"/>
2976 </imageobject>
2977 </mediaobject>
2978 </screenshot>
2979 <para>Note that we changed the graph type to "Line", and the columns to "Week".</para>
2980
2981 </sect1>
2982
2983 <sect1 id="analysis_conclusion">
2984 <title>Conclusion</title>
2985 <para>Through this simple exercise, we have been able to use the advanced reporting capabilities of &skrooge; to perform a fine analysis of the expenses made during holidays, specifically in the "Transports" category. Of course, you may think of other use cases: &skrooge; is probably able to cope with them.</para>
2986 </sect1>
2987
2988 </appendix>
2989
2990 &documentation.index;
2991
2992 </book>
2993 <!--
2994 Local Variables:
2995 mode: sgml
2996 sgml-minimize-attributes:nil
2997 sgml-general-insert-case:lower
2998 sgml-indent-step:0
2999 sgml-indent-data:nil
3000 End:
3001 -->