[skrooge] doc: adapt skrooge docbook to kf5
Burkhard Lück
lueck at hube-lueck.de
Wed Dec 7 20:35:14 UTC 2016
Git commit 14fd37cb4eeffada6bff4ee2cd12650272904520 by Burkhard Lück.
Committed on 07/12/2016 at 20:35.
Pushed by lueck into branch 'master'.
adapt skrooge docbook to kf5
remove entities tbw + kappname, no longer used
replace &appname; with &skrooge;
fix date + releaseinfo format
remove Settings + Help menu, the docbook already has a link to fundamentals menus
convert chapter How to in FAQ markup
fix wrong links (homepage, store)
remove obsolete appendix installation
REVIEW:129620
M +187 -253 doc/index.docbook
https://commits.kde.org/skrooge/14fd37cb4eeffada6bff4ee2cd12650272904520
diff --git a/doc/index.docbook b/doc/index.docbook
index bbcafad0..80d74fad 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -1,15 +1,13 @@
<?xml version="1.0" ?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [
-<!ENTITY appname '<application>Skrooge</application>'>
-<!ENTITY kappname "&appname;">
-<!ENTITY tbw "TO BE WRITTEN">
+<!ENTITY skrooge '<application>Skrooge</application>'> <!--remove when skrooge requires kdoctools 5.13-->
<!ENTITY % addindex "IGNORE">
<!ENTITY % English "INCLUDE"><!-- change language only here -->
-<!ENTITY homepage "http://extragear.kde.org/apps/skrooge/">
+<!ENTITY homepage "https://www.kde.org/applications/office/skrooge/">
]>
<book id="skrooge" lang="&language;">
- <title>The &appname; Handbook</title>
+ <title>The &skrooge; Handbook</title>
<bookinfo>
@@ -51,12 +49,12 @@
<legalnotice>&FDLNotice;</legalnotice>
- <date>15/06/2016</date>
- <releaseinfo>2.5.0</releaseinfo>
+ <date>2016-06-15</date>
+ <releaseinfo>Skrooge 2.5.0</releaseinfo>
<abstract>
<para>
- This document is a handbook for using &appname;, a personal finances manager application.
+ This document is a handbook for using &skrooge;, a personal finances manager application.
</para>
</abstract>
@@ -74,37 +72,37 @@
<title>Introduction</title>
<sect1 id="skrooge-intro">
- <title>&appname;</title>
+ <title>&skrooge;</title>
<para>
- &appname; 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 operations, graphical reporting, stocks management... It also has some less common features, like fast operation edition, search as you type, refund trackers, customizable attributes...
+ &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 operations, graphical reporting, stocks management... It also has some less common features, like fast operation edition, search as you type, refund trackers, customizable attributes...
</para>
<screenshot>
- <screeninfo>&appname; displaying pie charts of expenses per category</screeninfo>
+ <screeninfo>&skrooge; displaying pie charts of expenses per category</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="reports.png" format="PNG"/>
</imageobject>
- <textobject><phrase>&appname; displaying pie charts of expenses per category</phrase></textobject>
+ <textobject><phrase>&skrooge; displaying pie charts of expenses per category</phrase></textobject>
</mediaobject>
</screenshot>
<sect2 id="what-skrooge-is">
- <title>What &appname; Is</title>
+ <title>What &skrooge; Is</title>
<para>
- &appname; 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.
+ &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.
</para>
</sect2>
<sect2 id="what-skrooge-is-not">
- <title>What &appname; Is Not</title>
+ <title>What &skrooge; Is Not</title>
<para>
- &appname; 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 function.
+ &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 function.
</para>
<para>If you were looking for such a tool, you may want to look at Kmymoney or Kraft instead.</para>
@@ -117,13 +115,13 @@
<sect2 id="terminology-document">
<title>Document</title>
<para>
- A document is a &appname; 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.
+ 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.
</para>
</sect2>
<sect2 id="terminology-account">
<title>Account</title>
- <para>A &appname; account is similar to your bank account. For example, if you own one account for you, one for your wife, and one in common, you can create these three accounts in &appname;. Every time you spend or earn some money, you register an <link linkend="terminology-operation">operation</link>, and indicate the account this operation was made on.
+ <para>A &skrooge; account is similar to your bank account. For example, if you own one account for you, one for your wife, and one in common, you can create these three accounts in &skrooge;. Every time you spend or earn some money, you register an <link linkend="terminology-operation">operation</link>, and indicate the account this operation was made on.
</para>
</sect2>
@@ -134,7 +132,7 @@
<sect3 id="terminology_standard_operation">
<title>Standard Operation</title>
- <para>A standard operation is the basic operation in &appname;. Like "Today, spent 20€ in credit card for groceries".</para>
+ <para>A standard operation is the basic operation in &skrooge;. Like "Today, spent 20€ in credit card for groceries".</para>
<para></para>
</sect3>
@@ -146,8 +144,8 @@
<sect3 id="terminology_transfer">
<title>Transfer</title>
- <para>A transfer in &appname; is equivalent to moving a quantity of money from one of your &appname; accounts to another of your &appname; accounts.</para>
- <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 operation, because &appname; doesn't know about that other person's account. It is a <link linkend="terminology_standard_operation">standard operation</link> made with transfer as a payment mode.</para>
+ <para>A transfer in &skrooge; is equivalent to moving a quantity of money from one of your &skrooge; accounts to another of your &skrooge; accounts.</para>
+ <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 operation, because &skrooge; doesn't know about that other person's account. It is a <link linkend="terminology_standard_operation">standard operation</link> made with transfer as a payment mode.</para>
<para>Read the <link linkend="transfer">dedicated chapter</link> if things are still unclear</para>
</sect3>
@@ -159,12 +157,12 @@
<sect3 id="terminology_pointed_operation">
<title>Pointed Operation</title>
- <para>During the <link linkend="reconciliation">reconciliation process</link>, you point in &appname; all operations that appear in the corresponding account position. A pointed operation is one of these operations. It is not <link linkend="terminology_checked_operation">Checked</link> until the reconciliation is completed.</para>
+ <para>During the <link linkend="reconciliation">reconciliation process</link>, you point in &skrooge; all operations that appear in the corresponding account position. A pointed operation is one of these operations. It is not <link linkend="terminology_checked_operation">Checked</link> until the reconciliation is completed.</para>
</sect3>
<sect3 id="terminology_checked_operation">
<title>Checked Operation</title>
- <para>When all operations on your account's position have been pointed in &appname;, you can complete the reconciliation process. All <link linkend="terminology_pointed_operation">Pointed</link> operation are then turned into Checked Operations.</para>
+ <para>When all operations on your account's position have been pointed in &skrooge;, you can complete the reconciliation process. All <link linkend="terminology_pointed_operation">Pointed</link> operation are then turned into Checked Operations.</para>
</sect3>
@@ -172,13 +170,13 @@
<sect2 id="terminology-category">
<title>Category</title>
- <para>A category is basically a class of operations. Some classic examples include "Food", "Taxes","Salary"... A category can contain other categories: it is a hierarchical structure. For example, category "transport" can contain categories "Bus", "Automotive", "plane"... &appname; handles an infinite depth of categories.
+ <para>A category is basically a class of operations. Some classic examples include "Food", "Taxes","Salary"... A category can contain other categories: it is a hierarchical structure. For example, category "transport" can contain categories "Bus", "Automotive", "plane"... &skrooge; handles an infinite depth of categories.
</para>
</sect2>
<sect2 id="terminology-unit">
<title>Unit</title>
- <para>A unit in &appname; can be anything that has a value. Examples:
+ <para>A unit in &skrooge; can be anything that has a value. Examples:
<itemizedlist>
<listitem><para>Currency
@@ -216,13 +214,13 @@
<sect1 id="user_interface">
<title>User Interface</title>
<para>
- The &appname; 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.
+ 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.
</para>
<sect2 id="main_area">
<title>The main area</title>
<para>
- This is where &appname; 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.
+ 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.
</para>
</sect2>
@@ -267,7 +265,7 @@
</informaltable>
<para>
- &appname; docks are:
+ &skrooge; docks are:
<itemizedlist>
<listitem><para><link linkend="page_chooser">The page chooser</link></para></listitem>
<listitem><para><link linkend="bookmarks">The bookmark list</link></para></listitem>
@@ -308,20 +306,20 @@
<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. Once you are done with that, in the Bookmarks <link linkend="docks">dock</link>, bring up the contextual menu, and select <menuchoice><guimenu>Bookmark current page</guimenu></menuchoice>.</para>
- <para>Each bookmark or bookmark folder can be "autostarted", &ie; it will be automatically opened when starting &appname;. This way, you can fully customize the default &appname; layout.</para>
+ <para>Each bookmark or bookmark folder can be "autostarted", &ie; it will be automatically opened when starting &skrooge;. This way, you can fully customize the default &skrooge; layout.</para>
<para>You can select the text and icon you want for each bookmark or bookmark folder.</para>
</sect2>
<sect2 id="undo_redo">
<title>Undo / Redo</title>
<para>
- &appname; 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 settings, the history is not cleared upon closing &appname; (you can change this behaviour in the <!-- TODO:put a link here--> settings), which means you could undo virtually everything up to the document creation.
+ &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 settings, the history is not cleared upon closing &skrooge; (you can change this behaviour in the <!-- TODO:put a link here--> settings), which means you could undo virtually everything up to the document creation.
</para>
<para>
- In order to limit the impact on filesize, &appname; is configured by default to keep a history of 50 entries. You can change this value in the <!-- TODO:put a link here--> settings.
+ 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 <!-- TODO:put a link here--> settings.
</para>
<para>
- &appname; has a <link linkend="docks">dock</link> that lists all undoable actions.
+ &skrooge; has a <link linkend="docks">dock</link> that lists all undoable actions.
</para>
<screenshot>
@@ -368,7 +366,7 @@
<sect2 id="property_editor">
<title>Property Editor</title>
- <para> One of &appname; rather uncommon features 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 he / she is your contact. Or maybe attach a file to an operation, like an invoice scan.
+ <para> One of &skrooge; rather uncommon features 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 he / she is your contact. Or maybe attach a file to an operation, like an invoice scan.
</para>
<para>
This can be achieved using the property editor, which is a <link linkend="docks">dock</link> of its own.
@@ -399,17 +397,17 @@
<listitem>
<para>
A copied file whatever the format (odt, png, pdf, ...).
- It means that the file is copied into the &appname; document.
- This file can be opened from &appname; by clicking on the appropriate button.
- Take care, all modifications of original file are not replicated in the version saved in &appname; document.
+ It means that the file is copied into the &skrooge; document.
+ This file can be opened from &skrooge; by clicking on the appropriate button.
+ Take care, all modifications of original file are not replicated in the version saved in &skrooge; document.
</para>
</listitem>
<listitem>
<para>
A link to an existing file whatever the format (odt, png, pdf, ...).
- It means that the file is not copied into the &appname; document but just linked.
- This file can be opened from &appname; by clicking on the appropriate button.
+ It means that the file is not copied into the &skrooge; document but just linked.
+ This file can be opened from &skrooge; by clicking on the appropriate button.
</para>
</listitem>
@@ -445,16 +443,16 @@
<screenshot>
<mediaobject>
<imageobject><imagedata fileref="multi_tabs.png" format="PNG"/></imageobject>
- <textobject><phrase>&appname; showing several tabs</phrase></textobject>
+ <textobject><phrase>&skrooge; showing several tabs</phrase></textobject>
</mediaobject>
</screenshot>
- <para>&appname; 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, operations, and two graphs).</para>
+ <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, operations, and two graphs).</para>
</sect2>
<sect2 id="edition_panels">
<title>Edition Panels</title>
- <para>In most &appname; tabs, the way to edit items is to use the edition panel, located at the bottom of the page. In order to preserve maximum space for visualizing information, especially on small screens, edition panels can be hidden or displayed using buttons.</para>
+ <para>In most &skrooge; tabs, the way to edit items is to use the edition panel, located at the bottom of the page. In order to preserve maximum space for visualizing information, especially on small screens, edition panels can be hidden or displayed using buttons.</para>
<screenshot>
<mediaobject>
@@ -476,7 +474,7 @@
<sect2 id="tables">
<title>Tables</title>
- <para>In &appname;, all tables are customizable. Bring up the contextual menu (usually by right-clicking) on the column header, and you will see a menu appear:</para>
+ <para>In &skrooge;, all tables are customizable. Bring up the contextual menu (usually by right-clicking) on the column header, and you will see a menu appear:</para>
<screenshot>
<mediaobject>
@@ -503,7 +501,7 @@
</varlistentry>
<varlistentry>
<term><menuchoice><guimenu>Auto Resize</guimenu></menuchoice></term>
- <listitem><para>When activated, you will not be able to manually resize columns, &appname; will do it automatically based on the columns content.</para></listitem>
+ <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>
</varlistentry>
<varlistentry>
<term><guimenu>List of displayed columns</guimenu></term>
@@ -556,7 +554,7 @@
<textobject><phrase>Show table menu</phrase></textobject>
</mediaobject>
</screenshot>
- <para>In all &appname; views, you will find a "Show" menu allowing you to filter the view.
+ <para>In all &skrooge; views, you will find a "Show" menu allowing you to filter the view.
</para>
</sect3>
@@ -569,7 +567,7 @@
</mediaobject>
</screenshot>
<para>
- In all &appname; views, you will find a "filter" field allowing you to search as you type in the view:
+ In all &skrooge; views, you will find a "filter" field allowing you to search as you type in the view:
<itemizedlist>
<listitem><para>In an operation view, it will filter the operations containing the text entered, whatever the column (date, payee, category, comment...)</para></listitem>
<listitem><para>In an accounts view, it will filter the accounts containing the text entered, whatever the column (bank, account name, number...)</para></listitem>
@@ -632,7 +630,7 @@
<sect2 id="mass_update">
<title>Mass Update</title>
- <para>In &appname;, it is possible to massively update a selection of items. Though mostly useful for <link linkend="operations">operations</link>, it can also be used on <link linkend="accounts">accounts</link>, <link linkend="units">units</link>, <link linkend="scheduled">scheduled operations</link>...</para>
+ <para>In &skrooge;, it is possible to massively update a selection of items. Though mostly useful for <link linkend="operations">operations</link>, it can also be used on <link linkend="accounts">accounts</link>, <link linkend="units">units</link>, <link linkend="scheduled">scheduled operations</link>...</para>
<para>The way to do this is quite straightforward : select items to be updated, set the attribute value(s) that should be applied on all items, and click on <guibutton>Apply</guibutton>. For all attributes where you didn't set a value, it will be left untouched on items.</para>
<screenshot>
@@ -656,11 +654,11 @@
<sect2 id="status_bar">
<title>Status Bar</title>
<para>
- The status bar is a small section at the bottom of the &appname; 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.
+ 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.
<screenshot>
<mediaobject>
<imageobject><imagedata fileref="progress-bar.png" format="PNG"/></imageobject>
- <textobject><phrase>The &appname; progress bar</phrase></textobject>
+ <textobject><phrase>The &skrooge; progress bar</phrase></textobject>
</mediaobject>
</screenshot>
</para>
@@ -671,7 +669,7 @@
<sect1 id="import">
<title>Import Files</title>
- <para>&appname; is able to import files from other financial applications or from your bank. So, whether you are coming from another application, or simply do not want to go through the hassle of manually entering your operations, &appname; has a fast lane for you.</para>
+ <para>&skrooge; is able to import files from other financial applications or from your bank. So, whether you are coming from another application, or simply do not want to go through the hassle of manually entering your operations, &skrooge; has a fast lane for you.</para>
<sect2 id="supported_file_formats">
<title>Supported File Formats</title>
@@ -688,13 +686,13 @@
<listitem><para>MT940: An international norm defined by SWIFT.</para></listitem>
<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>
<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>
- <listitem><para>OFX: Open Financial eXchange. It is a well defined & documented format, that &appname; imports using a third party library (libofx). This is the recommended format for imports.</para></listitem>
+ <listitem><para>OFX: Open Financial eXchange. It is a well defined & documented format, that &skrooge; imports using a third party library (libofx). This is the recommended format for imports.</para></listitem>
<listitem><para>QFX: QFX is a customization of OFX from the commercial software <trademark>Quicken</trademark>.</para></listitem>
<listitem><para>QIF: <trademark>Quicken</trademark> Import File. Maybe the most common financial file format. However, it has some rather annoying limitations, like not giving the unit for operation, or no strict date formatting.</para></listitem>
<listitem><para>IIF: <trademark>Intuit</trademark> Interchange Format is used by <trademark>QuickBooks</trademark>.</para></listitem>
- <listitem><para>SKG: This is useful to merge 2 &appname; documents</para></listitem>
- <listitem><para>PDF: This allows to create the operation from a PDF invoice. The invoice is also associated to the operation 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 supported yet.</para></listitem>
- <listitem><para>Backend: &appname; can also import operations by using a backend. The only one supported is <ulink url="http://weboob.org/">WEBOOB</ulink>. By using this backend you can import all operations 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 settings.</para>
+ <listitem><para>SKG: This is useful to merge 2 &skrooge; documents</para></listitem>
+ <listitem><para>PDF: This allows to create the operation from a &PDF; invoice. The invoice is also associated to the operation 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 supported yet.</para></listitem>
+ <listitem><para>Backend: &skrooge; can also import operations by using a backend. The only one supported is <ulink url="http://weboob.org/">WEBOOB</ulink>. By using this backend you can import all operations 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 settings.</para>
<tip><para>If you do not want to store your bank passwords in the configuration file of WEBOOB, you can do that:
@@ -710,29 +708,29 @@
<sect2 id="csv_specificities">
<title>CSV Specificities</title>
- <para>Since CSV has no strictly defined format, there is no way for &appname; to know where it is supposed to find dates, categories, values... To do so, &appname; expects your CSV file to contain some headers indicating what is the column for. The file must contain at least columns "Date" and "Amount".</para>
- <para><!-- TODO: Put a link to the settings documentation section -->You may manually define how the file is set up (&ie; ignoring the headers in the file) by setting them in the application settings (<menuchoice><guimenu>Settings</guimenu> <guimenuitem>Configure &appname;</guimenuitem></menuchoice>), in the <guilabel>Import / Export</guilabel> section.</para>
+ <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... To do so, &skrooge; expects your CSV file to contain some headers indicating what is the column for. The file must contain at least columns "Date" and "Amount".</para>
+ <para><!-- TODO: Put a link to the settings documentation section -->You may manually define how the file is set up (&ie; ignoring the headers in the file) by setting them in the application settings (<menuchoice><guimenu>Settings</guimenu> <guimenuitem>Configure &skrooge;</guimenuitem></menuchoice>), in the <guilabel>Import / Export</guilabel> section.</para>
</sect2>
<sect2 id="import_operations">
<title>Importing Operations</title>
- <para>One of &appname; principles is to avoid multiple wizards or dialog boxes. This is especially true for imports, where other applications require many information from the user. Not &appname;. When selecting <menuchoice><guimenu>File</guimenu><guimenuitem>Import</guimenuitem></menuchoice>, you will be asked to select the files (yes you can import many at once), and that's it. Behind the scene, &appname; will find the file format and apply the relevant import mode.</para>
+ <para>One of &skrooge; principles is to avoid multiple wizards or dialog boxes. This is especially true for imports, where other applications require many information from the user. Not &skrooge;. When selecting <menuchoice><guimenu>File</guimenu><guimenuitem>Import</guimenuitem></menuchoice>, you will be asked to select the files (yes you can import many at once), and that's it. Behind the scene, &skrooge; will find the file format and apply the relevant import mode.</para>
<sect3 id="import_account">
<title>Account</title>
- <para>One thing that might surprise you is that you won't be asked in which account the operations should be imported. That is because &appname; will read the account number in the file, and will associate imported operations to that account.</para>
- <para>If no account exists with this account number, or if the file does not contain this information, &appname; will use the file name as the account number.</para>
- <para>If there is still no account with that number, &appname; will create a new account having the filename as the account number, and import all operations 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 operations to an existing account.</para>
+ <para>One thing that might surprise you is that you won't be asked in which account the operations should be imported. That is because &skrooge; will read the account number in the file, and will associate imported operations to that account.</para>
+ <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>
+ <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 operations 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 operations to an existing account.</para>
</sect3>
<sect3 id="import_unit">
<title>Unit</title>
- <para>If no unit is specified in the imported file (which is often the case for QIF & CSV), &appname; 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>
+ <para>If no unit is specified in the imported file (which is often the case for QIF & CSV), &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>
</sect3>
<sect3 id="import_date">
<title>Date</title>
- <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). &appname; 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 <!-- TODO: Put a link here-->settings.</para>
+ <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 <!-- TODO: Put a link here-->settings.</para>
</sect3>
<sect3 id="import_status">
@@ -752,7 +750,7 @@
<sect1 id="export">
<title>Export</title>
- <para>There are different ways of exporting data with &appname; depending on what you intend to do.</para>
+ <para>There are different ways of exporting data with &skrooge; depending on what you intend to do.</para>
<sect2 id="export_file">
<title>Export all your data in one file</title>
@@ -761,7 +759,7 @@
<sect2 id="export_table">
<title>Export a specific table</title>
- <para>All <link linkend="tables">tables</link> in &appname; can be exported, either in CSV, &HTML;, ODT, PDF, SVG or TXT format. </para>
+ <para>All <link linkend="tables">tables</link> in &skrooge; can be exported, either in CSV, &HTML;, ODT, &PDF;, SVG or TXT format. </para>
<screenshot>
<mediaobject>
@@ -774,7 +772,7 @@
<sect2 id="export_graph">
<title>Export Graph</title>
- <para>&appname; allows you exporting a <link linkend="reports">graph</link>, either in PDF, SVG or just any image format supported by &kde; (PNG, JPG, &GIF;, TIFF...). You can do so by right-clicking on the graph, and choosing the <guimenu>Export</guimenu> option.</para>
+ <para>&skrooge; allows you exporting 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>
<screenshot>
<mediaobject>
@@ -789,19 +787,19 @@
</chapter>
<chapter id="using-skrooge-beginner">
- <title>Using &appname; (beginner)</title>
+ <title>Using &skrooge; (beginner)</title>
<sect1 id="menu-main">
<title>The main menu</title>
<para>
- &kappname; follows the standard &kde; menu scheme. So 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">this help section</ulink>.
+ &skrooge; follows the standard &kde; menu scheme. So 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">this help section</ulink>.
</para>
<para>
- Below, you can find descriptions for &kappname;-specific menu entries.
+ Below, you can find descriptions for &skrooge;-specific menu entries.
</para>
<sect2 id="menu-file">
- <title>The file menu</title>
- <para>You can find in this menu all functions relative to the &appname; document</para>
+ <title>The File Menu</title>
+ <para>You can find in this menu all functions relative to the &skrooge; document</para>
<screenshot>
<mediaobject>
<imageobject><imagedata fileref="menu_file.png"/></imageobject>
@@ -831,7 +829,7 @@
</sect2>
<sect2 id="menu-edit">
- <title>The edit menu</title>
+ <title>The Edit Menu</title>
<para>You can find in this menu all functions that can be used to modify selected objects</para>
<screenshot>
<mediaobject>
@@ -866,7 +864,7 @@
</sect2>
<sect2 id="menu-view">
- <title>The view menu</title>
+ <title>The View Menu</title>
<para>You can find in this menu all functions relative to <link linkend="multi-tabs">pages</link></para>
<screenshot>
<mediaobject>
@@ -889,7 +887,7 @@
</sect2>
<sect2 id="menu-do">
- <title>The go menu</title>
+ <title>The Go Menu</title>
<para>You can find in this menu all functions relative to <link linkend="multi-tabs">pages</link></para>
<screenshot>
<mediaobject>
@@ -928,7 +926,7 @@
</sect2>
<sect2 id="menu-tools">
- <title>The tools menu</title>
+ <title>The Tools Menu</title>
<screenshot>
<mediaobject>
<imageobject><imagedata fileref="menu_tools.png"/></imageobject>
@@ -938,7 +936,7 @@
<itemizedlist>
<listitem><para><guimenuitem>Find and group transfers</guimenuitem>: Create potential transfers</para></listitem>
<listitem><para><guimenuitem>Clean bank's import</guimenuitem>: Clean operations after imports</para></listitem>
- <listitem><para><guimenuitem>Anonymize</guimenuitem>: Anonymize your document to help debugging of &appname; </para></listitem>
+ <listitem><para><guimenuitem>Anonymize</guimenuitem>: Anonymize your document to help debugging of &skrooge; </para></listitem>
<listitem><para><guimenuitem>Align comment of suboperations</guimenuitem>: Correct single operations having comments not aligned</para></listitem>
<listitem><para><guimenuitem>Align date of suboperations</guimenuitem>: Correct single operations having dates not aligned</para></listitem>
<listitem><para><guimenuitem>Remove groups with only one operation</guimenuitem>: Correct alone in a group</para></listitem>
@@ -950,32 +948,11 @@
</itemizedlist>
</sect2>
- <sect2 id="menu-settings">
- <title>The settings menu</title>
- <screenshot>
- <mediaobject>
- <imageobject><imagedata fileref="menu_settings.png"/></imageobject>
- </mediaobject>
- </screenshot>
-
- <para>This is the standard setting menu.</para>
- </sect2>
-
- <sect2 id="menu-help">
- <title>The help menu</title>
- <screenshot>
- <mediaobject>
- <imageobject><imagedata fileref="menu_help.png"/></imageobject>
- </mediaobject>
- </screenshot>
-
- &help.menu.documentation;
- </sect2>
</sect1>
<sect1 id="dashboard">
<title>Dashboard</title>
- <para>The Dashboard is a &appname; plugin that displays global information about your financial situation.</para>
+ <para>The Dashboard is a &skrooge; plugin that displays global information about your financial situation.</para>
<screenshot>
<mediaobject>
@@ -1197,12 +1174,12 @@
<sect2 id="account_properties">
<title>Account properties</title>
- <para>A &appname; account has the following properties:
+ <para>A &skrooge; account has the following properties:
<variablelist>
<varlistentry>
<term>Bank</term>
- <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 &appname; team has not yet been provided this information. You may contact us to help!).</para></listitem>
+ <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>
</varlistentry>
<varlistentry>
<term>Account</term>
@@ -1250,11 +1227,11 @@
</varlistentry>
<varlistentry>
<term>Minimum limit</term>
- <listitem><para>The minimum limit when &appname; must raise an alarm </para></listitem>
+ <listitem><para>The minimum limit when &skrooge; must raise an alarm </para></listitem>
</varlistentry>
<varlistentry>
<term>Maximum limit</term>
- <listitem><para>The maximum limit when &appname; must raise an alarm </para></listitem>
+ <listitem><para>The maximum limit when &skrooge; must raise an alarm </para></listitem>
</varlistentry>
</variablelist>
</para>
@@ -1262,7 +1239,7 @@
<sect2 id="accounts_list">
<title>Accounts list</title>
- <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, &appname; displays the following columns:</para>
+ <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>
<variablelist>
<varlistentry>
@@ -1283,7 +1260,7 @@
</varlistentry>
</variablelist>
- <para>As with all &appname; list views, you can fully <link linkend="tables">customize the table appearance</link>.</para>
+ <para>As with all &skrooge; list views, you can fully <link linkend="tables">customize the table appearance</link>.</para>
</sect2>
@@ -1292,7 +1269,7 @@
<para>The account creation is done using the edition panel below the accounts list.</para>
<para>
- To create an account, enter its attributes (the mandatory ones are in bold), and click on <guibutton>Add</guibutton>. &appname; doesn't need you to provide the initial amount of this account. In order to set the initial amount of the account, create an operation corresponding to the initial amount.</para>
+ 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 an operation corresponding to the initial amount.</para>
</sect2>
<sect2 id="modify_account">
@@ -1310,7 +1287,7 @@
<sect1 id="operations">
<title>Operations</title>
- <para>Operations are, well, any operation you make on an account, be it an expense, income, transfer, sales, purchase... This is where you will probably spend most of your time when using &appname;.</para>
+ <para>Operations are, well, any operation you make on an account, be it an expense, income, transfer, sales, purchase... This is where you will probably spend most of your time when using &skrooge;.</para>
<para>In order to enter operations, you need to have at least one <link linkend="accounts">account</link> created.</para>
@@ -1336,10 +1313,10 @@
<varlistentry>
<term id="quantity_field">Amount</term>
<listitem>
- <para>The amount is how much you spent or earned with this operation. &appname; requires you enter this in two separate fields: Quantity, and Unit.</para>
+ <para>The amount is how much you spent or earned with this operation. &skrooge; requires you enter this in two separate fields: Quantity, and Unit.</para>
<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>
- <para>If the sign of the quantity is not specified, then &appname; will use the category to find the most appropriate one.</para>
- <para>&appname; requires you to enter the <link linkend="units">unit</link> because an operation is not necessarily made in your main currency. For example, when you buy or purchase shares, the unit of the operation is the share unit.</para>
+ <para>If the sign of the quantity is not specified, then &skrooge; will use the category to find the most appropriate one.</para>
+ <para>&skrooge; requires you to enter the <link linkend="units">unit</link> because an operation is not necessarily made in your main currency. For example, when you buy or purchase shares, the unit of the operation is the share unit.</para>
</listitem>
</varlistentry>
<varlistentry>
@@ -1357,9 +1334,9 @@
<term>Category</term>
<listitem>
<para>Which <link linkend="categories">Category</link> this operation belongs to. If you need to affect more than one category to an operation, use the <link linkend="split_operation">split</link> mode.</para>
- <para>You can either choose an existing category, or type a new one. In this case, &appname; will create it for you along with the operation.</para>
- <para>The separator between a parent category and its children is the > character. If you type Clothes > Shoes, &appname; will create the category Clothes if it doesn't exist yet, and its child category Shoes.</para>
- <para>Of course, you may create entire category trees, such as Transport > Car > Fuel > Unleaded, &appname; will happily create all the hierarchical structure.</para>
+ <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 operation.</para>
+ <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>
+ <para>Of course, you may create entire category trees, such as Transport > Car > Fuel > Unleaded, &skrooge; will happily create all the hierarchical structure.</para>
</listitem>
</varlistentry>
<varlistentry>
@@ -1376,7 +1353,7 @@
<sect2 id="operations_list">
<title>Operations list</title>
- <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, &appname; displays the following columns:</para>
+ <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>
<variablelist>
<varlistentry>
@@ -1406,7 +1383,7 @@
</varlistentry>
</variablelist>
- <para>As with all &appname; list views, you can fully <link linkend="tables">customize the table appearance</link>.</para>
+ <para>As with all &skrooge; list views, you can fully <link linkend="tables">customize the table appearance</link>.</para>
</sect2>
@@ -1419,7 +1396,7 @@
<sect2 id="split_operation">
<title>Split Operation</title>
- <para>A split operation is an operation that has several dates, categories, comments or trackers. You switch to the split operation edition mode using the <guibutton>Split Button</guibutton> at the bottom of &appname; window. When switching into the split operation edition mode, the fields Category, Comment and Tracker are replaced by a table.</para>
+ <para>A split operation is an operation that has several dates, categories, comments or trackers. You switch to the split operation edition mode using the <guibutton>Split Button</guibutton> at the bottom of &skrooge; window. When switching into the split operation edition mode, the fields Category, Comment and Tracker are replaced by a table.</para>
<screenshot>
<mediaobject>
@@ -1430,21 +1407,21 @@
<para>To edit a cell in this table, double click on it.</para>
- <para>You can add as many lines in this table as you need. When changing the quantity in a line, &appname; will compute the difference with the operation 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>
+ <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 operation 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>
<para>The fields here have the same behaviour as in the standard operation edition mode:</para>
<itemizedlist>
<listitem><para>The split by Date is useful for example when you paid your sport training for 3 months. In this case, you can split the payment on 3 months, this will have an impact on reports.</para></listitem>
- <listitem><para>The Category is a drop down box of existing categories. You can add a new category structure, &appname; will create it when creating the operation.</para></listitem>
+ <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 operation.</para></listitem>
<listitem><para>The Amount <link linkend="quantity_field">acts as a calculator</link>.</para></listitem>
- <listitem><para>The Tracker is a drop down box of existing trackers. You can add a new tracker, &appname; will create it when creating the operation.</para></listitem>
+ <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 operation.</para></listitem>
</itemizedlist>
</sect2>
<sect2 id="transfer">
<title>Transfer</title>
- <para>A transfer operation is effectively a dual operation: when creating a transfer, &appname; will create two operations of opposite amounts (one positive, the other negative), on two different accounts. The attributes to provide here are slightly different from a standard operation:</para>
+ <para>A transfer operation is effectively a dual operation: when creating a transfer, &skrooge; will create two operations of opposite amounts (one positive, the other negative), on two different accounts. The attributes to provide here are slightly different from a standard operation:</para>
<screenshot>
<mediaobject>
@@ -1483,7 +1460,7 @@ file is opened. It is also recommended to create a different account (⪚ "ETF"
<sect2 id="schedule_operation">
<title>Schedule Operations</title>
- <para>If an operation is known to be repeated on a regular basis, you may want &appname; to automatically enter it for you in the list of operations. This can be done by scheduling an operation, using the <guibutton>Schedule button <inlinemediaobject><imageobject><imagedata fileref="schedule_operation.png"/></imageobject></inlinemediaobject></guibutton>.</para>
+ <para>If an operation is known to be repeated on a regular basis, you may want &skrooge; to automatically enter it for you in the list of operations. This can be done by scheduling an operation, using the <guibutton>Schedule button <inlinemediaobject><imageobject><imagedata fileref="schedule_operation.png"/></imageobject></inlinemediaobject></guibutton>.</para>
<para>The default scheduling parameters are:</para>
<itemizedlist>
@@ -1492,9 +1469,9 @@ file is opened. It is also recommended to create a different account (⪚ "ETF"
<listitem><para>Automatically write on term</para></listitem>
</itemizedlist>
- <para>You may change the default parameters in &appname; settings.</para>
+ <para>You may change the default parameters in &skrooge; settings.</para>
<para>You may also change each scheduled operation parameters in the <link linkend="scheduled">Scheduled plugin</link>.</para>
- <para>&appname; uses values from the last entry of the scheduled operation for writing the next one. If you increase for example the amount of your monthly contribution to the &kde; effort from 100$ to 200$, next operations automatically written by &appname; will have an amount of 200$.</para>
+ <para>&skrooge; uses values from the last entry of the scheduled operation for writing the next one. If you increase for example the amount of your monthly contribution to the &kde; effort from 100$ to 200$, next operations automatically written by &skrooge; will have an amount of 200$.</para>
</sect2>
@@ -1503,7 +1480,7 @@ file is opened. It is also recommended to create a different account (⪚ "ETF"
<para>Whatever the chosen edition mode, there is a nifty function called Fast Edition that may speed up the work while creating new operations. It will fill the operation's attributes based on previously entered operations. Enter a value in any field of the editor, and press <keycap>F10</keycap>, or click on the <guibutton>Fast Edition Icon <inlinemediaobject><imageobject><imagedata fileref="fast_edition.png" format="PNG"/></imageobject></inlinemediaobject></guibutton> (without leaving the selected field).</para>
- <para>&appname; will look for the first (&ie; the most recent one) operation that has the same value in the same field, and fill all other fields with values from that operation. Call Fast Edition again, it will look for the next operation, and so on.</para>
+ <para>&skrooge; will look for the first (&ie; the most recent one) operation that has the same value in the same field, and fill all other fields with values from that operation. Call Fast Edition again, it will look for the next operation, and so on.</para>
<warning>
<para>Fast Edition has no effect on the date, since it is rather unlikely that you want to create exactly the same operation, complete with the same date...</para>
@@ -1531,16 +1508,16 @@ file is opened. It is also recommended to create a different account (⪚ "ETF"
</mediaobject>
</screenshot>
- <para>Enter the position of your account as provided by your bank in the dedicated field. Now, you can proceed to checking in &appname; every operation that appears on the account recordings. For the moment, the check box for this operation will appear half greyed, until you really validate the reconciliation.</para>
+ <para>Enter the position of your account as provided by your bank in the dedicated field. Now, you can proceed to checking in &skrooge; every operation that appears on the account recordings. For the moment, the check box for this operation will appear half greyed, until you really validate the reconciliation.</para>
- <para>As you check operations, you will see &appname; display in the information zone:</para>
+ <para>As you check operations, you will see &skrooge; display in the information zone:</para>
<itemizedlist>
<listitem><para>Delta: the difference between the previously entered account position and the sum of all checked operations</para></listitem>
<listitem><para>Expenditure:the total amount of expenses</para></listitem>
<listitem><para>Income: the total amount of incomes</para></listitem>
</itemizedlist>
- <para>This may be useful when trying to spot operations you may have forgot to enter in &appname;. When all relevant operations have been checked, Delta is equal to 0, and the <guibutton>Validate checked operations button <inlinemediaobject><imageobject><imagedata fileref="validate.png" format="PNG" /></imageobject></inlinemediaobject></guibutton> is activated. Click on this button to validate the reconciliation: all checked operations are now validated.</para>
+ <para>This may be useful when trying to spot operations you may have forgot to enter in &skrooge;. When all relevant operations have been checked, Delta is equal to 0, and the <guibutton>Validate checked operations button <inlinemediaobject><imageobject><imagedata fileref="validate.png" format="PNG" /></imageobject></inlinemediaobject></guibutton> is activated. Click on this button to validate the reconciliation: all checked operations are now validated.</para>
<tip><para><inlinemediaobject><imageobject><imagedata fileref="fast_edition.png" format="PNG" /></imageobject></inlinemediaobject> can automatically point all imported operations for you.</para></tip>
@@ -1552,7 +1529,7 @@ file is opened. It is also recommended to create a different account (⪚ "ETF"
<sect2 id="templates">
<title>Template Operations</title>
- <para>&appname; allows you creating template operations, &ie; operations that can be reused whenever you need it. For example, imagine are used to renting a DVD to watch at home. The operation is always the same :</para>
+ <para>&skrooge; allows you creating template operations, &ie; operations that can be reused whenever you need it. For example, imagine are used to renting a DVD to watch at home. The operation is always the same :</para>
<itemizedlist>
<listitem><para>Amount: -4.99</para></listitem>
@@ -1653,7 +1630,7 @@ file is opened. It is also recommended to create a different account (⪚ "ETF"
<sect1 id="reports">
<title>Reports</title>
- <para>&appname; allows you to build highly customized reports, for a deep analysis of your financial status.</para>
+ <para>&skrooge; allows you to build highly customized reports, for a deep analysis of your financial status.</para>
<screenshot>
<mediaobject>
@@ -1870,7 +1847,7 @@ file is opened. It is also recommended to create a different account (⪚ "ETF"
<sect2 id="zoom_graph">
<title>Zoom on graph</title>
- <para>&appname; makes it possible to zoom in a graph for getting all the small details. Use the zoom control zone above the graph:</para>
+ <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>
<screenshot>
<mediaobject>
@@ -1950,7 +1927,7 @@ file is opened. It is also recommended to create a different account (⪚ "ETF"
</screenshot>
<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>
- <para>Do not hesitate to distribute your templates in the category <literal>Skrooge report templates</literal> of <ulink url="https://store.kde.org/">store.kde.org</ulink>.</para>
+ <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>
</sect1>
<sect1 id="units">
@@ -1983,7 +1960,7 @@ file is opened. It is also recommended to create a different account (⪚ "ETF"
<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>
<listitem><para>Country</para></listitem>
<listitem><para>Download source: The source to download quotes. The recommended one is "Yahoo".</para></listitem>
- <listitem><para>Internet Code: The Internet code for this unit. If given this code, &appname; is able to download the unit values from selected source.</para></listitem>
+ <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>
</itemizedlist>
</listitem>
</varlistentry>
@@ -1996,7 +1973,7 @@ file is opened. It is also recommended to create a different account (⪚ "ETF"
<sect2 id="unit_types">
<title>Unit Types</title>
- <para>Even if &appname; considers just about anything as a unit, it makes a distinction depending on their type:</para>
+ <para>Even if &skrooge; considers just about anything as a unit, it makes a distinction depending on their type:</para>
<variablelist>
<varlistentry>
@@ -2040,7 +2017,7 @@ file is opened. It is also recommended to create a different account (⪚ "ETF"
</chapter>
<chapter id="using-skrooge-advanced">
- <title>Using &appname; (advanced)</title>
+ <title>Using &skrooge; (advanced)</title>
<sect1 id="scheduled">
<title>Scheduled</title>
@@ -2071,11 +2048,11 @@ file is opened. It is also recommended to create a different account (⪚ "ETF"
</varlistentry>
<varlistentry>
<term>Remind me</term>
- <listitem><para>If you want &appname; to display a notification to remind you about the upcoming scheduled operation, you may check this option and set the number of days before term when the warning shall occur.</para></listitem>
+ <listitem><para>If you want &skrooge; to display a notification to remind you about the upcoming scheduled operation, you may check this option and set the number of days before term when the warning shall occur.</para></listitem>
</varlistentry>
<varlistentry>
<term>Automatically Write</term>
- <listitem><para>If you want &appname; to automatically write the upcoming scheduled operation, you may check this option and set the number of days before term when it will be written.</para></listitem>
+ <listitem><para>If you want &skrooge; to automatically write the upcoming scheduled operation, you may check this option and set the number of days before term when it will be written.</para></listitem>
</varlistentry>
</variablelist>
<para>To modify the operation (category, amount, ...), you have to click on <guilabel>Jump to the operation</guilabel>.</para>
@@ -2292,12 +2269,12 @@ file is opened. It is also recommended to create a different account (⪚ "ETF"
</mediaobject>
</screenshot>
- <para>For example, imagine you have been sent to Italy by your company. Once there, you paid your hotel room: in &appname;, you can create an operation in 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 these, and you can create an income operation, and also affect it to the "Business Travel in Italy" tracker.</para>
+ <para>For example, imagine you have been sent to Italy by your company. Once there, you paid your hotel room: in &skrooge;, you can create an operation in 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 these, and you can create an income operation, and also affect it to the "Business Travel in Italy" tracker.</para>
<para>By affecting trackers to operations that shall be reimbursed, you are able to follow completion of the reimbursement.</para>
<para>This, of course, works also the other way round: if someone lends you some money, you are able to monitor how much you still have to reimburse.</para>
<para>Double clicking on a tracker in the track view will open a new tab containing all operations attached to this tracker.</para>
- <tip><para>Sometimes, you would like to track the refund of a payment done before you started to use &appname;. How to do that because it is not possible to set an initial amount on a tracker?</para>
+ <tip><para>Sometimes, you would like to track the refund of a payment done before you started to use &skrooge;. How to do that because it is not possible to set an initial amount on a tracker?</para>
<para>You can create a split operation with:
<itemizedlist>
@@ -2400,7 +2377,7 @@ file is opened. It is also recommended to create a different account (⪚ "ETF"
<sect2 id="define_alarm">
<title>Define Alarm</title>
- <para>A special kind of use of the Search & Process plugin is the ability to define alarms. An alarm is basically &appname; calling your attention on some kind of event, such as your monthly budget for a category has been reached.</para>
+ <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 on some kind of event, such as your monthly budget for a category has been reached.</para>
<screenshot>
<mediaobject>
@@ -2410,7 +2387,7 @@ file is opened. It is also recommended to create a different account (⪚ "ETF"
</mediaobject>
</screenshot>
- <para>To define an alarm, define first the search criteria giving the set of operations on which you need alert. For example, all operations 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 &appname; will send you when the amount is reached.</para>
+ <para>To define an alarm, define first the search criteria giving the set of operations on which you need alert. For example, all operations 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 you when the amount is reached.</para>
<tip><para>Alarm messages can have parameters for the total amount (%1), alarm amount (%2) and difference (%3).</para></tip>
</sect2>
@@ -2428,7 +2405,7 @@ file is opened. It is also recommended to create a different account (⪚ "ETF"
</imageobject>
</mediaobject>
</screenshot>
- <para>Like in all other financial software, &appname; allows you to define a budget. You can do it manually or automatically.</para>
+ <para>Like in all other financial software, &skrooge; allows you to define a budget. You can do it manually or automatically.</para>
<sect2 id="budget_definition">
<title>Budget definition</title>
<para>In manual mode, you can:
@@ -2458,7 +2435,7 @@ file is opened. It is also recommended to create a different account (⪚ "ETF"
</itemizedlist>
</para>
- <para>Imagine now, that you spent 600 € for "Food" during the previous month! &appname; informed you that you are over the defined budget but you cannot stop to eat. So you spent more than expected! How to do with that?</para>
+ <para>Imagine now, that you spent 600 € for "Food" during the previous month! &skrooge; informed you that you are over the defined budget but you cannot stop to eat. So you spent more than expected! How to do with that?</para>
<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>
<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". By this way, when you have the expected amount in "Holidays" budget then you know that you can go.</para>
</sect2>
@@ -2482,68 +2459,83 @@ file is opened. It is also recommended to create a different account (⪚ "ETF"
<chapter id="howto">
<title>How to...</title>
- <sect1 id="howto_language">
- <title>How to have &appname; in my language?</title>
- <para>First, check if &appname; is well <ulink url="http://l10n.kde.org/stats/gui/trunk-kde4/po/skrooge.po/">translated to your language</ulink>.</para>
- <para>Second, do not forget to install packages for your language. Example for french (fr): <literal>language-pack-kde-fr</literal> and <literal>kde-l10n-fr</literal>.</para>
- </sect1>
-
- <sect1 id="howto_currency">
- <title>How to set default currency and date format?</title>
- <para>Default currency and date format are retrieved from &kde;'s system settings. Some distributions do not ship it with base &kde; packages, that should have been installed along &appname;. In such case you should install it through your distribution's package manager.</para>
+ <qandaset id="faqlist">
+ <qandaentry>
+ <question id="howto_language">
+ <para>How to use &skrooge; in my language?</para>
+ </question>
+ <answer>
+ <para>Check if &skrooge; is well <ulink url="http://l10n.kde.org/stats/gui/trunk-kf5/po/skrooge.po/">translated to your language</ulink>
+ and if you have installed all packages for &skrooge; provided by your distribution.</para>
+ </answer>
+ </qandaentry>
- <para>You can then start it in a console: <userinput>systemsettings</userinput></para>
+ <qandaentry>
+ <question id="howto_currency">
+ <para>How to set default currency and date format?</para>
+ </question>
+ <answer>
+ <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>
- <para>And select your preferred settings, in the <guilabel>Locale</guilabel> section.</para>
- </sect1>
-
- <sect1 id="howto_size">
- <title>How to reduce the size of my document?</title>
+ <para>You can then start it in a console: <userinput>systemsettings5</userinput></para>
+
+ <para>And select your preferred settings, in the <guilabel>Format</guilabel> section.</para>
+ </answer>
+ </qandaentry>
+
+ <qandaentry>
+ <question id="howto_size">
+ <para>How to reduce the size of my document?</para>
+ </question>
+ <answer>
<para>The size of your document can be very important. If you delete some old transactions, the size will increase.
- This is normal because &appname; keeps the history of all modifications for the undo/redo mechanism.
+ This is normal because &skrooge; keeps the history of all modifications for the undo/redo mechanism.
So if you want to reduce the size of your document, you just have to clear the history.</para>
- </sect1>
-
- <sect1 id="howto_extractor">
- <title>How to define a new invoice extractor?</title>
- <para>&appname; 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 that:</para>
- <itemizedlist>
- <listitem><para>Launch <command>pdftotext</command> on your PDF file</para></listitem>
- <listitem><para>Open the text file generated and the corresponding PDF file</para></listitem>
- <listitem><para>Create a new text with an extension ".extractor". Example: google.extractor</para></listitem>
- <listitem><para>Your file must be like this:</para>
-<programlisting>
-payee=REGEXPCAP:^(Biofan) SPRL$
-date=REGEXPCAP:^Order Date: (.*)$
-dateformat=dd MMM yyyy
-number=REGEXPCAP:^N° de facture (.*)$
-mode=SET:Carte
-comment=REGEXPCAP:^N° de commande (.*)$|SET:Commande %1
-amount=REGEXP:^Montant global:$|LINEOFFSET:2
-</programlisting>
-<para>Each attribute (payee, date, number, mode, comment and amount) use the same syntax: COMMAND:value|COMMAND:value|...</para>
-<para>The command can be:</para>
- <itemizedlist>
- <listitem><para><command>REGEXPCAP</command>: This is a regular expression capturing a value</para></listitem>
- <listitem><para><command>REGEXP</command>: To find the line in the file matching a regular expression</para></listitem>
- <listitem><para><command>LINEOFFSET</command>: To change the line index.</para></listitem>
- <listitem><para><command>SET</command>: To force the value. Can be used as first command or after the REGEXPCAP (see example).</para></listitem>
- </itemizedlist>
-<para>dateformat is the format of the date extracted.</para>
-</listitem>
+ </answer>
+ </qandaentry>
+
+ <qandaentry>
+ <question id="howto_extractor">
+ <para>How to define a new invoice extractor?</para>
+ </question>
+ <answer>
+ <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 that:</para>
+ <itemizedlist>
+ <listitem><para>Launch <command>pdftotext</command> on your &PDF; file</para></listitem>
+ <listitem><para>Open the text file generated and the corresponding &PDF; file</para></listitem>
+ <listitem><para>Create a new text with an extension <filename class="extension">.extractor</filename>. Example: <filename>google.extractor</filename></para></listitem>
+ <listitem><para>Your file must be like this:</para>
+ <programlisting>
+ payee=REGEXPCAP:^(Biofan) SPRL$
+ date=REGEXPCAP:^Order Date: (.*)$
+ dateformat=dd MMM yyyy
+ number=REGEXPCAP:^N° de facture (.*)$
+ mode=SET:Carte
+ comment=REGEXPCAP:^N° de commande (.*)$|SET:Commande %1
+ amount=REGEXP:^Montant global:$|LINEOFFSET:2
+ </programlisting>
+ <para>Each attribute (payee, date, number, mode, comment and amount) use the same syntax: COMMAND:value|COMMAND:value|...</para>
+ <para>The command can be:</para>
+ <itemizedlist>
+ <listitem><para><command>REGEXPCAP</command>: This is a regular expression capturing a value</para></listitem>
+ <listitem><para><command>REGEXP</command>: To find the line in the file matching a regular expression</para></listitem>
+ <listitem><para><command>LINEOFFSET</command>: To change the line index.</para></listitem>
+ <listitem><para><command>SET</command>: To force the value. Can be used as first command or after the REGEXPCAP (see example).</para></listitem>
+ </itemizedlist>
+ <para>dateformat is the format of the date extracted.</para>
+ </listitem>
+ <listitem><para>Put this file into the same directory as all other <filename class="extension">.extractor</filename> files</para></listitem>
+ </itemizedlist>
+ </answer>
+ </qandaentry>
+ </qandaset>
- <listitem><para>Put this file into the same directory as all other .extractor files</para></listitem>
- </itemizedlist>
- <para>
- </para>
- </sect1>
-
</chapter>
<chapter id="credits">
<title>Credits and License</title>
<para>
- &appname;
+ &skrooge;
</para>
<para>
Program copyright 2001-2014 Stéphane Mankowski
@@ -2558,64 +2550,6 @@ amount=REGEXP:^Montant global:$|LINEOFFSET:2
&underGPL;
</chapter>
- <appendix id="installation">
- <title>Installation</title>
-
- <sect1 id="getting-skrooge">
- <title>How to obtain &appname;</title>
-
- <para>The &appname; home page can be found at <ulink url="&homepage;">&homepage;</ulink>. Updates and news can be found there.
- </para>
- </sect1>
-
- <sect1 id="requirements">
- <title>Requirements</title>
-
- <para>In order to successfully use &appname;, you need &kde; 4, qt-sqlite3, libofx, and qca.
- </para>
-
- </sect1>
-
- <sect1 id="Installation">
- <title>Installing &appname;</title>
-
- <para>It is recommended that you install &appname; using your distribution packaging system. If for any reason you would like to compile and install &appname; by yourself, this chapter contains all necessary steps.
- </para>
-
- <sect2 id="prerequisites">
- <title>Prerequisites</title>
- <para>
- &appname; uses several components you need to install in order to compile it:</para>
- <itemizedlist>
- <listitem><para>sqlite3: a lightweight SQL database. &appname; files are sqlite databases.</para></listitem>
- <listitem><para>libofx: a library to handle OFX file format. OFX is a standard &XML; format for financial exchanges.</para></listitem>
- <listitem><para>qca: &Qt; Cryptographic Architecture. Used for password protection.</para></listitem>
- </itemizedlist>
- </sect2>
-
- <sect2 id="compilation">
- <title>Compilation and Installation</title>
-
- <para>
- In order to compile and install &appname; on your system, type the following
- in the base folder of the archive, where the third step must be done as
- root if you are installing in a system folder:
-
- <screen width="40">
- <prompt>$</prompt> <userinput>cmake . <option>-DCMAKE_INSTALL_PREFIX=`kde4-config --prefix`</option></userinput>
- <prompt>$</prompt> <userinput>make</userinput>
- <prompt>$</prompt> <userinput>make install</userinput>
- </screen>
- </para>
- <para>Since &appname; uses <command>cmake</command> you should have no
- trouble compiling it. Should you run into problems please report them to the
- authors.</para>
- </sect2>
-
- </sect1>
-
- </appendix>
-
<appendix id="search_process_real_case">
<title>Search & Process real case study</title>
@@ -2644,7 +2578,7 @@ amount=REGEXP:^Montant global:$|LINEOFFSET:2
<para>Add this search definition to the list of existing searches using the <guibutton>Add</guibutton> button.</para>
- <para>Next we need to tell &appname; to set all operations 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>
+ <para>Next we need to tell &skrooge; to set all operations 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>
<table>
<title>Update Definition</title>
@@ -2678,13 +2612,13 @@ amount=REGEXP:^Montant global:$|LINEOFFSET:2
</mediaobject>
</screenshot>
- <para>That's it ! If you go back to the operations view, you will notice that all concerned operations 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 operations, this is still one undoable action for &appname;.</para>
+ <para>That's it ! If you go back to the operations view, you will notice that all concerned operations 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 operations, this is still one undoable action for &skrooge;.</para>
</appendix>
<appendix id="holidays_expenses_analysis">
<title>Deep analysis exercise: Holidays expenses</title>
- <para>To illustrate the analysis capabilities of &appname;, we are going to examine this author's expenses during his holidays :).</para>
+ <para>To illustrate the analysis capabilities of &skrooge;, we are going to examine this author's expenses during his holidays :).</para>
<sect1 id="analysis_context">
<title>Analysis Context</title>
@@ -2795,7 +2729,7 @@ amount=REGEXP:^Montant global:$|LINEOFFSET:2
<sect1 id="analysis_conclusion">
<title>Conclusion</title>
- <para>Through this simple exercise, we have been able to use the advanced reporting capabilities of &appname; 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: &appname; is probably able to cope with them.</para>
+ <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>
</sect1>
</appendix>
More information about the kde-doc-english
mailing list