[skrooge] /: Add "Settings" description in documentation
Stephane MANKOWSKI
null at kde.org
Tue Apr 14 17:29:09 BST 2020
Git commit 07f5f95dbf3b63e1497645276d9a8accae3259f0 by Stephane MANKOWSKI.
Committed on 14/04/2020 at 16:28.
Pushed by smankowski into branch 'master'.
Add "Settings" description in documentation
M +1 -0 CHANGELOG
M +211 -18 doc/index.docbook
M +1 -1 doc/kde_docbook
M +- -- doc/menu_settings.png
A +- -- doc/settings_bookmarks.png
A +- -- doc/settings_dashboard.png
A +- -- doc/settings_file.png
A +- -- doc/settings_general.png
A +- -- doc/settings_history.png
A +- -- doc/settings_import_1.png
A +- -- doc/settings_import_2.png
A +- -- doc/settings_import_3.png
A +- -- doc/settings_import_4.png
A +- -- doc/settings_operations.png
A +- -- doc/settings_report.png
A +- -- doc/settings_scheduled.png
A +- -- doc/settings_search.png
A +- -- doc/settings_units.png
https://commits.kde.org/skrooge/07f5f95dbf3b63e1497645276d9a8accae3259f0
diff --git a/CHANGELOG b/CHANGELOG
index 388ace535..3ca12c77c 100644
--- a/CHANGELOG
+++ b/CHANGELOG
@@ -2,6 +2,7 @@ skrooge (2.23.0)
*Correction: cryptocompare fails if too many values are requested (>2000)
*Correction: Change icon for trackers by a "crosshairs"
*Correction: Source ratesapi doesn't work in appimage
+ *Correction: Add "Settings" description in documentation
*Feature: Add new source "exchangeratesapi.io"
-- Stephane MANKOWSKI <stephane at mankowski.fr> NotPlannedYet
diff --git a/doc/index.docbook b/doc/index.docbook
index aa8edea0a..075e00337 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -155,7 +155,7 @@
<sect3 id="terminology_validated_operation">
<title>Validated Operation</title>
<para>When you <link linkend="import">import</link> operations 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 operations no longer appear blue.</para>
- <para>Note that it is possible to automatically validate operations on import, by turning on the corresponding option in the <!--TODO: put a link to the settings here-->settings.</para>
+ <para>Note that it is possible to automatically validate operations on import, by turning on the corresponding option in the <link linkend="settings">settings</link>.</para>
</sect3>
<sect3 id="terminology_pointed_operation">
@@ -315,10 +315,10 @@
<sect2 id="undo_redo">
<title>Undo / Redo</title>
<para>
- &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.
+ &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.
</para>
<para>
- 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.
+ 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>.
</para>
<para>
&skrooge; has a <link linkend="docks">dock</link> that lists all undoable actions.
@@ -696,8 +696,8 @@
<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. For the moment, the three following backends can be used:
<itemizedlist>
- <listitem><para><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>
- <listitem><para><ulink url="http://weboob.org/">weboob_coming</ulink>: By using this backend you can import all coming operations from all your banks in only one click. This can be used for card with deferred debit. For that, you just have to install <ulink url="http://weboob.org/">activate</ulink> and activate the corresponding backend from settings.</para></listitem>
+ <listitem><para><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 <link linkend="settings">settings</link>.</para></listitem>
+ <listitem><para><ulink url="http://weboob.org/">weboob_coming</ulink>: By using this backend you can import all coming operations from all your banks in only one click. This can be used for card with deferred debit. For that, you just have to install <ulink url="http://weboob.org/">activate</ulink> and activate the corresponding backend from <link linkend="settings">settings</link>.</para></listitem>
<listitem><para><ulink url="https://www.aquamaniac.de/sites/aqbanking/overview.php">aqbanking</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 and configure <ulink url="https://www.aquamaniac.de/sites/aqbanking/cli.php">aqbanking-cli</ulink>.</para></listitem>
</itemizedlist></para>
@@ -716,7 +716,7 @@
<sect2 id="csv_specificities">
<title>CSV Specificities</title>
<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's <!-- TODO: Put a link here-->settings (<menuchoice><guimenu>Settings</guimenu> <guimenuitem>Configure &skrooge;</guimenuitem></menuchoice>), in the <guilabel>Import / Export</guilabel> section.</para>
+ <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>
</sect2>
<sect2 id="import_operations">
@@ -737,13 +737,13 @@
<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). &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>
+ <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>
</sect3>
<sect3 id="import_status">
<title>Import Status</title>
- <para>Imported Operations 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 quickly those operations. As per default settings, those operations will also appear in blue.</para>
- <tip><para>If you do not want this behaviour, you can set the option <guilabel>Automatic Validation after Import</guilabel> in the application's <!-- TODO: Put a link here-->settings.</para></tip>
+ <para>Imported Operations 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 quickly those operations. As per default <link linkend="settings">settings</link>, those operations will also appear in blue.</para>
+ <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>
<tip><para>The <link linkend="search_and_process">Search & Process</link> function can be automatically launched after import to categorize operations.</para></tip>
</sect3>
</sect2>
@@ -862,7 +862,7 @@
<listitem><para><guimenuitem>Switch close</guimenuitem>: Switch the close state of objects</para></listitem>
<listitem><para><guimenuitem>Reconcile...</guimenuitem>: Open the <link linkend="operations">Operations</link> page in <link linkend="reconciliation">reconciliation</link> mode</para></listitem>
<listitem><para><guimenuitem>Point</guimenuitem>: Point the selected operations</para></listitem>
- <listitem><para><guimenuitem>Group operations</guimenuitem>: Group the selected operations</para></listitem>
+ <listitem><para><guimenuitem>Group operations</guimenuitem>: Group the selected operations. It serves to keep a link between operations. 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 not grouped operations</para></listitem>
<listitem><para><guimenuitem>Ungroup operations</guimenuitem>: Ungroup the selected operations</para></listitem>
<listitem><para><guimenuitem>Duplicate</guimenuitem>: Duplicate the selected operation to create a new one from a previous one</para></listitem>
<listitem><para><guimenuitem>Create template</guimenuitem>: Create a <link linkend="templates">template</link> from a selected operation</para></listitem>
@@ -959,7 +959,24 @@
<listitem><para><guimenuitem>Process budget rules</guimenuitem>: Recompute the <link linkend="budgets">budgets</link> based on defined rules</para></listitem>
</itemizedlist>
</sect2>
-
+ <sect2 id="menu-settings">
+ <title>The Settings Menu</title>
+ <screenshot>
+ <mediaobject>
+ <imageobject><imagedata fileref="menu_settings.png"/></imageobject>
+ </mediaobject>
+ </screenshot>
+
+ <itemizedlist>
+ <listitem><para><guimenuitem>Show Menubar</guimenuitem>: To show or hide the menu</para></listitem>
+ <listitem><para><guimenuitem>Toolbars Shown</guimenuitem>: To show or hide the toolbars</para></listitem>
+ <listitem><para><guimenuitem>Show Statusbar</guimenuitem>: To show or hide the status bar</para></listitem>
+ <listitem><para><guimenuitem>Configure Keyboard Shortcuts...</guimenuitem>: To change the shortcuts of each command</para></listitem>
+ <listitem><para><guimenuitem>Configure Toolbars...</guimenuitem>: To modify the toolbars layouts</para></listitem>
+ <listitem><para><guimenuitem>Configure Notifications...</guimenuitem>: To modify the notifications </para></listitem>
+ <listitem><para><guimenuitem>Configure &skrooge;...</guimenuitem>: To access to the main <link linkend="settings">settings</link> of &skrooge;</para></listitem>
+ </itemizedlist>
+ </sect2>
</sect1>
<sect1 id="dashboard">
@@ -1461,7 +1478,7 @@
<sect2 id="shares">
<title>Shares</title>
- <para>First of all you have to create some units with the shares you want to track, from the settings you can choose to update the data automatically when the
+ <para>First of all 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
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.
</para>
<para>Now you can add your operations as "shares":
@@ -1493,7 +1510,7 @@ 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 &skrooge; settings.</para>
+ <para>You may change the default parameters in &skrooge; <link linkend="settings">settings</link>.</para>
<para>You may also change each scheduled operation parameters in the <link linkend="scheduled">Scheduled plugin</link>.</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>
@@ -1547,7 +1564,7 @@ file is opened. It is also recommended to create a different account (⪚ "ETF"
<para>If the option <guibutton>Hide checked operations</guibutton> for the table is selected from its "Show" menu (see <link linkend="show">Filter the table</link>), then all these operations will now be hidden.</para>
- <para>If the reconciliation is not possible for any reason, you can create a fake operation that in combination with the other operations you pointed sets the Delta to 0, thus allowing you to complete the reconciliation. To do so, click the "add" button <!-- TODO: add inline screenshot of kCreateFakeOperation's "list-add" icon.-->in the reconciliation mode toolbar. You can set the default values of this fake operation in the application's <!-- TODO: Put a link here-->settings, in the <guilabel>Operations</guilabel> section. During reconciliation, if you enable the appropriate setting, &skrooge; automatically points all created operations.</para>
+ <para>If the reconciliation is not possible for any reason, you can create a fake operation that in combination with the other operations you pointed sets the Delta to 0, thus allowing you to complete the reconciliation. To do so, click the "add" button <!-- TODO: add inline screenshot of kCreateFakeOperation's "list-add" icon.-->in the reconciliation mode toolbar. You can set the default values of this fake operation in the application's <link linkend="settings">settings</link>, in the <guilabel>Operations</guilabel> section. During reconciliation, if you enable the appropriate setting, &skrooge; automatically points all created operations.</para>
</sect2>
@@ -2040,10 +2057,8 @@ file is opened. It is also recommended to create a different account (⪚ "ETF"
</varlistentry>
</variablelist>
</sect2>
-
</sect1>
</chapter>
-
<chapter id="using-skrooge-advanced">
<title>Using &skrooge; (advanced)</title>
@@ -2484,6 +2499,184 @@ file is opened. It is also recommended to create a different account (⪚ "ETF"
</sect1>
</chapter>
+
+ <chapter id="settings">
+ <title>Settings</title>
+ <para>You can find here a description of all settings used by &skrooge;. These settings are common with all your documents.</para>
+
+ <sect1 id="settings_general">
+ <title>General</title>
+
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="settings_general.png" format="PNG"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ <para>You can set here the main general settings. The main important onces are those to describe what to do when a page or a bookmark is modified.</para>
+ </sect1>
+
+ <sect1 id="settings_file">
+ <title>File</title>
+
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="settings_file.png" format="PNG"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ <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...</para>
+ </sect1>
+
+ <sect1 id="settings_bookmarks">
+ <title>Bookmarks</title>
+
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="settings_bookmarks.png" format="PNG"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ <para>Only one option here to choose whether or not we want to pin automatically loaded bookmarks.</para>
+ </sect1>
+
+ <sect1 id="settings_history">
+ <title>History</title>
+
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="settings_history.png" format="PNG"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ <para>These options will help you to better manage your modifications history.</para>
+ </sect1>
+
+ <sect1 id="settings_dashboard">
+ <title>Dashboard</title>
+
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="settings_dashboard.png" format="PNG"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ <para>Only one option here to choose the dashboard you want (QML or not).</para>
+ </sect1>
+
+ <sect1 id="settings_operations">
+ <title>Operations</title>
+
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="settings_operations.png" format="PNG"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ <para>Here you will find options for editing operations.</para>
+ <para>Please note that you can improve performances if you don't use the "balance" column by avoiding calculating balances for nothing.</para>
+ <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>
+ <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>
+ </sect1>
+
+ <sect1 id="settings_scheduled">
+ <title>Scheduled operations</title>
+
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="settings_scheduled.png" format="PNG"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ <para>Here you will find options for editing scheduled operations.</para>
+ </sect1>
+
+ <sect1 id="settings_search">
+ <title>Search and process</title>
+
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="settings_search.png" format="PNG"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ <para>Only one option here to choose the alarm frequency.</para>
+ </sect1>
+
+ <sect1 id="settings_report">
+ <title>Report</title>
+
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="settings_report.png" format="PNG"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ <para>You can choose here some display options for reports.</para>
+ </sect1>
+
+ <sect1 id="settings_units">
+ <title>Units</title>
+
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="settings_units.png" format="PNG"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ <para>You can choose here some options relative to download of quotes of units.</para>
+ </sect1>
+
+ <sect1 id="settings_import">
+ <title>Import / Export</title>
+
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="settings_import_1.png" format="PNG"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ <para>The general import settings.</para>
+
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="settings_import_2.png" format="PNG"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ <para>If you use the CSV import, you will have to modify these settings to help &skrooge; to identify the columns.</para>
+
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="settings_import_3.png" format="PNG"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ <para>In some specific case, you could have to force the date format for QIF files. Most of the time, &skrooge; is able to find it automatically.</para>
+
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="settings_import_4.png" format="PNG"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ <para>You can here active the import backends listed.</para>
+ </sect1>
+ </chapter>
<chapter id="howto">
<title>How to...</title>
@@ -2566,11 +2759,11 @@ file is opened. It is also recommended to create a different account (⪚ "ETF"
&skrooge;
</para>
<para>
- Program copyright 2001-2017 Stéphane Mankowski
+ Program copyright 2008-2020 Stéphane Mankowski
<email>stephane at mankowski.fr</email>
</para>
<para>
- Documentation copyright 2001-2017 Guillaume DE BURE
+ Documentation copyright 2008-2020 Guillaume DE BURE
<email>gdebure at yahoo.com</email>
</para>
<!-- TRANS:CREDIT_FOR_TRANSLATORS -->
diff --git a/doc/kde_docbook b/doc/kde_docbook
index 59cd3c763..e0ca0f2d5 100755
--- a/doc/kde_docbook
+++ b/doc/kde_docbook
@@ -1,7 +1,7 @@
#!/bin/bash
# Let's call the KDE catalog first
-export XML_CATALOG_FILES="/usr/share/apps/ksgmltools2/customization/catalog.xml"
+export XML_CATALOG_FILES="/usr/share/kf5/kdoctools/customization/catalog.xml"
# Check if docbook is well formed
echo "Running checkXML... ";
diff --git a/doc/menu_settings.png b/doc/menu_settings.png
index 8e4c625e2..c54d589e9 100644
Binary files a/doc/menu_settings.png and b/doc/menu_settings.png differ
diff --git a/doc/settings_bookmarks.png b/doc/settings_bookmarks.png
new file mode 100644
index 000000000..334f2e9ac
Binary files /dev/null and b/doc/settings_bookmarks.png differ
diff --git a/doc/settings_dashboard.png b/doc/settings_dashboard.png
new file mode 100644
index 000000000..78d8351a2
Binary files /dev/null and b/doc/settings_dashboard.png differ
diff --git a/doc/settings_file.png b/doc/settings_file.png
new file mode 100644
index 000000000..8fb2800e5
Binary files /dev/null and b/doc/settings_file.png differ
diff --git a/doc/settings_general.png b/doc/settings_general.png
new file mode 100644
index 000000000..5dfa06f79
Binary files /dev/null and b/doc/settings_general.png differ
diff --git a/doc/settings_history.png b/doc/settings_history.png
new file mode 100644
index 000000000..9239ce24f
Binary files /dev/null and b/doc/settings_history.png differ
diff --git a/doc/settings_import_1.png b/doc/settings_import_1.png
new file mode 100644
index 000000000..c0983efa4
Binary files /dev/null and b/doc/settings_import_1.png differ
diff --git a/doc/settings_import_2.png b/doc/settings_import_2.png
new file mode 100644
index 000000000..74afc2712
Binary files /dev/null and b/doc/settings_import_2.png differ
diff --git a/doc/settings_import_3.png b/doc/settings_import_3.png
new file mode 100644
index 000000000..19218784f
Binary files /dev/null and b/doc/settings_import_3.png differ
diff --git a/doc/settings_import_4.png b/doc/settings_import_4.png
new file mode 100644
index 000000000..530dc127d
Binary files /dev/null and b/doc/settings_import_4.png differ
diff --git a/doc/settings_operations.png b/doc/settings_operations.png
new file mode 100644
index 000000000..2cbe656aa
Binary files /dev/null and b/doc/settings_operations.png differ
diff --git a/doc/settings_report.png b/doc/settings_report.png
new file mode 100644
index 000000000..9cfe23d6c
Binary files /dev/null and b/doc/settings_report.png differ
diff --git a/doc/settings_scheduled.png b/doc/settings_scheduled.png
new file mode 100644
index 000000000..543ee64a7
Binary files /dev/null and b/doc/settings_scheduled.png differ
diff --git a/doc/settings_search.png b/doc/settings_search.png
new file mode 100644
index 000000000..69fdba605
Binary files /dev/null and b/doc/settings_search.png differ
diff --git a/doc/settings_units.png b/doc/settings_units.png
new file mode 100644
index 000000000..cc5103820
Binary files /dev/null and b/doc/settings_units.png differ
More information about the kde-doc-english
mailing list