[kde-doc-english] [skrooge] doc: Doc update
Stephane Mankowski
stephane at mankowski.fr
Wed Jun 18 20:45:42 UTC 2014
Git commit 4f6b72468bd9cf366f474ca810969a5d15336f5a by Stephane Mankowski.
Committed on 18/06/2014 at 20:43.
Pushed by smankowski into branch 'master'.
Doc update
M +72 -25 doc/index.docbook
A +- -- doc/monthly.png
M +- -- doc/reconciliation_information.png
M +- -- doc/report_table.png
M +- -- doc/split_operation.png
M +- -- doc/template_button.png
M +- -- doc/transfer_operation.png
http://commits.kde.org/skrooge/4f6b72468bd9cf366f474ca810969a5d15336f5a
diff --git a/doc/index.docbook b/doc/index.docbook
index 51f5641..045cb7a 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -1378,7 +1378,7 @@
<sect2 id="split_operation">
<title>Split Operation</title>
- <para>A split operation is an operation that has several 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 &appname; window. When switching into the split operation edition mode, the fields Category, Comment and Tracker are replaced by a table.</para>
<screenshot>
<mediaobject>
@@ -1394,14 +1394,13 @@
<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 payement 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 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>
</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>
@@ -1413,7 +1412,7 @@
</mediaobject>
</screenshot>
- <para>Instead of a Payee field, you will find a "To Account" list where you should select the account receiving the money.</para>
+ <para>You will find a "To Account" list where you should select the account receiving the money.</para>
<para>Since a transfer means "Take some money from account A and put it account B", if you put a sign in the quantity field (+ or -), it will be ignored. The operation for account A will always be negative, positive for account B.</para>
@@ -1505,6 +1504,8 @@ file is opened. It's also recommended to create a different account (⪚ "ETF")
<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>
+ <tip><para><inlinemediaobject><imageobject><imagedata fileref="fast_edition.png" format="PNG" /></imageobject></inlinemediaobject> can automatically point all imported operations for you.</para></tip>
+
<para>If the option <guibutton>Hide checked operations</guibutton> is selected, all these operations will now be hidden.</para>
</sect2>
@@ -1522,7 +1523,7 @@ file is opened. It's also recommended to create a different account (⪚ "ETF")
<para>However, you cannot make it a recurrent operation, because you rent a DVD when you feel like it, not every week. The idea behind template operations is that it gives you a basic skeleton that can be quickly inserted in your operations list.</para>
- <para>Since Template operations are just another kind of operations, you can access them through the operations tab, using the button above the edition panel:</para>
+ <para>Since Template operations are just another kind of operations, you can access them through the operations tab, using the dedicated option in Show menu:</para>
<screenshot>
<mediaobject>
@@ -1571,7 +1572,6 @@ file is opened. It's also recommended to create a different account (⪚ "ETF")
</variablelist>
<para>Double clicking on a line in this table will open the list of all operations in this payee in a new tab.</para>
-
</sect1>
<sect1 id="categories">
@@ -1608,9 +1608,7 @@ file is opened. It's also recommended to create a different account (⪚ "ETF")
</variablelist>
<para>Double clicking on a line in this table will open the list of all operations in this category in a new tab.</para>
-
<warning><para>When deleting a category, all operations attached to it will have their category deleted, hence will not have any category attached</para></warning>
-
</sect1>
<sect1 id="reports">
@@ -1629,7 +1627,6 @@ file is opened. It's also recommended to create a different account (⪚ "ETF")
<para>You can choose to display only the table, only the graph, or both.</para>
-
<sect2 id="setup_report">
<title>Set up report</title>
@@ -1637,16 +1634,16 @@ file is opened. It's also recommended to create a different account (⪚ "ETF")
<title>Representation</title>
<variablelist>
<varlistentry>
- <term>Table Only</term>
- <listitem><para>Display only the table, and hide the graph.</para></listitem>
+ <term>Table</term>
+ <listitem><para>Display the table.</para></listitem>
</varlistentry>
<varlistentry>
- <term>Graph Only</term>
- <listitem><para>Display only the graph, and hide the table.</para></listitem>
+ <term>Graph</term>
+ <listitem><para>Display the graph.</para></listitem>
</varlistentry>
<varlistentry>
- <term>Both</term>
- <listitem><para>Display the table and the graph.</para></listitem>
+ <term>Text</term>
+ <listitem><para>Display the text report, hide table and graph.</para></listitem>
</varlistentry>
</variablelist>
</sect3>
@@ -1656,18 +1653,60 @@ file is opened. It's also recommended to create a different account (⪚ "ETF")
<para>This is where you choose what is the data to be present in the report. Select what will be shown in lines and in columns, and the mode of computation. There are two distinct values for the mode:</para>
<variablelist>
<varlistentry>
- <term>Sum</term>
+ <term>Sum of operations</term>
<listitem>
<para>In this mode, the total amount of operations for each month will be computed. If you selected "category" in line, and "month" in column, this will compute the total amount of operations for each category and for every month.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>History</term>
+ <term>Cumulated sum of operations</term>
<listitem>
<para>If we reuse our previous example ("category" in line, "month" in column), we will have here a cumulated sum, &ie; for each month, we will compute the total amount of operations up to this month, for each category.</para>
<para>As a hand on example, this author uses this mode to draw the evolution of his accounts balance by setting "Accounts" for Lines, and "Month" for Columns.</para>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term>Base 100</term>
+ <listitem>
+ <para>Like "Sum of operations" but on base 100.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Cumulated sum in base 100</term>
+ <listitem>
+ <para>Like "Cumulated sum of operations" but on base 100.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Percent of columns</term>
+ <listitem>
+ <para>The values are express in pourcent of the high column value.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Absolute percent of columns</term>
+ <listitem>
+ <para>The values are express in pourcent of the high column value in absolute.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Percent of lines</term>
+ <listitem>
+ <para>The values are express in pourcent of the high line value.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Absolute percent of lines</term>
+ <listitem>
+ <para>The values are express in pourcent of the high line value in absolute.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Count number of operationq</term>
+ <listitem>
+ <para>.</para>
+ </listitem>
+ </varlistentry>
</variablelist>
<para>For lines and columns, it is possible to expand the level of data presented using the <guibutton>plus</guibutton> icon <inlinemediaobject><imageobject><imagedata fileref="plus.png"/></imageobject></inlinemediaobject> right of the field. Use this to show subcategories in the report.</para>
@@ -1844,6 +1883,8 @@ file is opened. It's also recommended to create a different account (⪚ "ETF")
<sect2 id="going_deeper">
<title>Going Deeper</title>
+ <para>By double clicking on an item of a graph, you will open the operations included in this item.</para>
+ <para>You can open a new report based on an item of a graph too.</para>
<para>So you know you can make a deep analysis of your finances thanks to reports. But how deep is deep ? Well, that's even deeper than you imagined... If you're interested, read the <link linkend="holidays_expenses_analysis">hands on exercise</link> analysing this author's expenses during its holidays :)</para>
</sect2>
@@ -1853,10 +1894,15 @@ file is opened. It's also recommended to create a different account (⪚ "ETF")
<sect1 id="monthly_report">
<title>Monthly Report</title>
- <para>This plugin shows an overview of your financial situation for a chosen month.</para>
-
- <!-- Sub par compared to the quality of other plugins and functionality partly covered by dashboard... Shall we deprecate it and extend dashboard instead ?-->
+ <para>This plugin shows an overview of your financial situation for a chosen period.</para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="monthly.png"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
</sect1>
<sect1 id="units">
@@ -1888,7 +1934,8 @@ file is opened. It's also recommended to create a different account (⪚ "ETF")
<listitem><para>Type: see <link linkend="unit_types">Unit Types</link>.</para></listitem>
<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>Internet Code: The yahoo Internet code for this unit. If given this code, &appname; is able to download the unit values from yahoo.</para></listitem>
+ <listitem><para>Download source: The source to download quotes. The recommanded 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>
</itemizedlist>
</listitem>
</varlistentry>
@@ -1937,10 +1984,8 @@ file is opened. It's also recommended to create a different account (⪚ "ETF")
<varlistentry>
<term>Other</term>
<listitem><para>Any unit that doesn't fit in the above types.</para></listitem>
- </varlistentry>
-
- </variablelist>
-
+ </varlistentry>
+ </variablelist>
</sect2>
</sect1>
@@ -1985,6 +2030,8 @@ file is opened. It's also recommended to create a different account (⪚ "ETF")
<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>
</varlistentry>
</variablelist>
+ <para>To modify the operation (category, amount, ...), you have to click on "Jump to the operation".</para>
+
<para>Double clicking on a scheduled operation will display the list of operations already registered for this scheduled operation in a new tab.</para>
diff --git a/doc/monthly.png b/doc/monthly.png
new file mode 100644
index 0000000..4fdd799
Binary files /dev/null and b/doc/monthly.png differ
diff --git a/doc/reconciliation_information.png b/doc/reconciliation_information.png
index dcbb6a7..71f632d 100644
Binary files a/doc/reconciliation_information.png and b/doc/reconciliation_information.png differ
diff --git a/doc/report_table.png b/doc/report_table.png
index db8ea84..042ea70 100644
Binary files a/doc/report_table.png and b/doc/report_table.png differ
diff --git a/doc/split_operation.png b/doc/split_operation.png
index faf4f46..7bb0386 100644
Binary files a/doc/split_operation.png and b/doc/split_operation.png differ
diff --git a/doc/template_button.png b/doc/template_button.png
index 613878b..45c463c 100644
Binary files a/doc/template_button.png and b/doc/template_button.png differ
diff --git a/doc/transfer_operation.png b/doc/transfer_operation.png
index 496d538..48697a9 100644
Binary files a/doc/transfer_operation.png and b/doc/transfer_operation.png differ
More information about the kde-doc-english
mailing list