[kde-doc-english] [skrooge] /: Documentation update (description of each dashboard graphical item)
Stephane Mankowski
stephane at mankowski.fr
Wed Jun 18 13:46:52 UTC 2014
Git commit aec4ea4b53c4824fa492d346764f3845a243bf3e by Stephane Mankowski.
Committed on 18/06/2014 at 13:46.
Pushed by smankowski into branch 'master'.
Documentation update (description of each dashboard graphical item)
A +- -- doc/dashboard_accounts_full.png
A +- -- doc/dashboard_accounts_light.png
A +- -- doc/dashboard_advice.png
A +- -- doc/dashboard_banks_full.png
A +- -- doc/dashboard_banks_light.png
A +- -- doc/dashboard_budget.png
A +- -- doc/dashboard_categories.png
A +- -- doc/dashboard_highlighted.png
A +- -- doc/dashboard_income.png
A +- -- doc/dashboard_interest.png
A +- -- doc/dashboard_portfolio.png
A +- -- doc/dashboard_quotes.png
A +- -- doc/dashboard_report.png
A +- -- doc/dashboard_scheduled.png
A +- -- doc/dashboard_tip.png
A +- -- doc/dashboard_variations.png
M +212 -3 doc/index.docbook
M +- -- doc/simulations.png
M +- -- examples/demo.skg
http://commits.kde.org/skrooge/aec4ea4b53c4824fa492d346764f3845a243bf3e
diff --git a/doc/dashboard_accounts_full.png b/doc/dashboard_accounts_full.png
new file mode 100644
index 0000000..7d3ad52
Binary files /dev/null and b/doc/dashboard_accounts_full.png differ
diff --git a/doc/dashboard_accounts_light.png b/doc/dashboard_accounts_light.png
new file mode 100644
index 0000000..c969a73
Binary files /dev/null and b/doc/dashboard_accounts_light.png differ
diff --git a/doc/dashboard_advice.png b/doc/dashboard_advice.png
new file mode 100644
index 0000000..ea4746f
Binary files /dev/null and b/doc/dashboard_advice.png differ
diff --git a/doc/dashboard_banks_full.png b/doc/dashboard_banks_full.png
new file mode 100644
index 0000000..e518639
Binary files /dev/null and b/doc/dashboard_banks_full.png differ
diff --git a/doc/dashboard_banks_light.png b/doc/dashboard_banks_light.png
new file mode 100644
index 0000000..341f9e2
Binary files /dev/null and b/doc/dashboard_banks_light.png differ
diff --git a/doc/dashboard_budget.png b/doc/dashboard_budget.png
new file mode 100644
index 0000000..957d854
Binary files /dev/null and b/doc/dashboard_budget.png differ
diff --git a/doc/dashboard_categories.png b/doc/dashboard_categories.png
new file mode 100644
index 0000000..4356c55
Binary files /dev/null and b/doc/dashboard_categories.png differ
diff --git a/doc/dashboard_highlighted.png b/doc/dashboard_highlighted.png
new file mode 100644
index 0000000..2b0d14e
Binary files /dev/null and b/doc/dashboard_highlighted.png differ
diff --git a/doc/dashboard_income.png b/doc/dashboard_income.png
new file mode 100644
index 0000000..a20b5e0
Binary files /dev/null and b/doc/dashboard_income.png differ
diff --git a/doc/dashboard_interest.png b/doc/dashboard_interest.png
new file mode 100644
index 0000000..a3c173e
Binary files /dev/null and b/doc/dashboard_interest.png differ
diff --git a/doc/dashboard_portfolio.png b/doc/dashboard_portfolio.png
new file mode 100644
index 0000000..79079fe
Binary files /dev/null and b/doc/dashboard_portfolio.png differ
diff --git a/doc/dashboard_quotes.png b/doc/dashboard_quotes.png
new file mode 100644
index 0000000..6cd7a7c
Binary files /dev/null and b/doc/dashboard_quotes.png differ
diff --git a/doc/dashboard_report.png b/doc/dashboard_report.png
new file mode 100644
index 0000000..728f40e
Binary files /dev/null and b/doc/dashboard_report.png differ
diff --git a/doc/dashboard_scheduled.png b/doc/dashboard_scheduled.png
new file mode 100644
index 0000000..9f8ae9b
Binary files /dev/null and b/doc/dashboard_scheduled.png differ
diff --git a/doc/dashboard_tip.png b/doc/dashboard_tip.png
new file mode 100644
index 0000000..4702e57
Binary files /dev/null and b/doc/dashboard_tip.png differ
diff --git a/doc/dashboard_variations.png b/doc/dashboard_variations.png
new file mode 100644
index 0000000..71cc032
Binary files /dev/null and b/doc/dashboard_variations.png differ
diff --git a/doc/index.docbook b/doc/index.docbook
index d8feb1b..51f5641 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -943,9 +943,204 @@
</mediaobject>
</screenshot>
- <para>You can add new graphical items using button on the top right corner. You can configure each graphical item by clicking on the icon on it. Combined with <link linkend="bookmarks">bookmarks</link>, this is a good way to have quick different views of your financial status.
- </para>
- <!-- TODO: Describe each graphical items-->
+ <para>You can add new graphical items using button on the top right corner. You can configure each graphical item by clicking on the icon on it. You can organize the graphical items on the dashboard by using the drag and drop.</para>
+ <tip><para>Combined with <link linkend="bookmarks">bookmarks</link>, this is a good way to have quick different views of your financial status.</para></tip>
+
+ <sect2 id="dashboard_advice">
+ <title>Advice</title>
+ <screenshot>
+ <mediaobject>
+ <imageobject><imagedata fileref="dashboard_advice.png"/></imageobject>
+ </mediaobject>
+ </screenshot>
+
+ <para>This graphical item displays some advice by order of priority. For each of them, you will be able to:
+ <itemizedlist>
+ <listitem><para>Open or clean concerned operations</para></listitem>
+ <listitem><para>Dismiss this advice</para></listitem>
+ <listitem><para>Dismiss this advice for the current month</para></listitem>
+ <listitem><para>Dismiss this kind of advice</para></listitem>
+ <listitem><para>Dismiss this kind of advice for the current month</para></listitem>
+ </itemizedlist>
+ </para>
+ </sect2>
+
+ <sect2 id="dashboard_tip">
+ <title>Tip of the day</title>
+ <screenshot>
+ <mediaobject>
+ <imageobject><imagedata fileref="dashboard_tip.png"/></imageobject>
+ </mediaobject>
+ </screenshot>
+
+ <para>Display the tip of the day. You can click on the graphical item to see the next tip.</para>
+ </sect2>
+
+ <sect2 id="dashboard_accounts_light">
+ <title>Accounts (Light)</title>
+ <screenshot>
+ <mediaobject>
+ <imageobject><imagedata fileref="dashboard_accounts_light.png"/></imageobject>
+ </mediaobject>
+ </screenshot>
+
+ <para>Display the balance of each account and type of account. You can configure this graphical item to select what you want to see.</para>
+ </sect2>
+
+ <sect2 id="dashboard_accounts_full">
+ <title>Accounts (Full)</title>
+ <screenshot>
+ <mediaobject>
+ <imageobject><imagedata fileref="dashboard_accounts_full.png"/></imageobject>
+ </mediaobject>
+ </screenshot>
+
+ <para>Display the balance of each account and type of account. The balance can be compare with the balance one month before and one year before.</para>
+ </sect2>
+
+ <sect2 id="dashboard_banks_light">
+ <title>Banks (Light)</title>
+ <screenshot>
+ <mediaobject>
+ <imageobject><imagedata fileref="dashboard_banks_light.png"/></imageobject>
+ </mediaobject>
+ </screenshot>
+
+ <para>Display the balance of each bank. The corresponding report can be directly opened from the graphical item.</para>
+ </sect2>
+
+ <sect2 id="dashboard_banks_full">
+ <title>Banks (Full)</title>
+ <screenshot>
+ <mediaobject>
+ <imageobject><imagedata fileref="dashboard_banks_full.png"/></imageobject>
+ </mediaobject>
+ </screenshot>
+
+ <para>Display the balance of each bank. The balance can be compare with the balance one month before and one year before.</para>
+ </sect2>
+
+ <sect2 id="dashboard_income">
+ <title>Income & Expenditure</title>
+ <screenshot>
+ <mediaobject>
+ <imageobject><imagedata fileref="dashboard_income.png"/></imageobject>
+ </mediaobject>
+ </screenshot>
+
+ <para>Display the incomes, expenditures and savings for two different periods (example: current month, current year, previous month, ...). Of course, you can:
+ <itemizedlist>
+ <listitem><para>Select the two periods you want</para></listitem>
+ <listitem><para>Choose if <link linkend="transfer">transfers</link> are taken into account or not</para></listitem>
+ <listitem><para>Choose if <link linkend="trackers">tracked</link> operations are taken into account or not</para></listitem>
+ <listitem><para>Open the corresponding <link linkend="reports">report</link></para></listitem>
+ </itemizedlist>
+ </para>
+ </sect2>
+
+ <sect2 id="dashboard_highlighted">
+ <title>Highlighted operations</title>
+ <screenshot>
+ <mediaobject>
+ <imageobject><imagedata fileref="dashboard_highlighted.png"/></imageobject>
+ </mediaobject>
+ </screenshot>
+
+ <para>Display the list of highlighted operations.</para>
+ </sect2>
+
+ <sect2 id="dashboard_scheduled">
+ <title>Scheduled operations</title>
+ <screenshot>
+ <mediaobject>
+ <imageobject><imagedata fileref="dashboard_scheduled.png"/></imageobject>
+ </mediaobject>
+ </screenshot>
+
+ <para>Display the list of <link linkend="scheduled">scheduled</link> operations.</para>
+ </sect2>
+
+ <sect2 id="dashboard_categories">
+ <title>5 main categories of expenditure</title>
+ <screenshot>
+ <mediaobject>
+ <imageobject><imagedata fileref="dashboard_categories.png"/></imageobject>
+ </mediaobject>
+ </screenshot>
+
+ <para>Display the 5 main categories of expenditure for the current month or the previous month.</para>
+ </sect2>
+
+ <sect2 id="dashboard_variations">
+ <title>5 main variations</title>
+ <screenshot>
+ <mediaobject>
+ <imageobject><imagedata fileref="dashboard_variations.png"/></imageobject>
+ </mediaobject>
+ </screenshot>
+
+ <para>Display the 5 main variations of income and expenditure for the current month or the previous month.</para>
+ </sect2>
+
+ <sect2 id="dashboard_budget">
+ <title>Budget</title>
+ <screenshot>
+ <mediaobject>
+ <imageobject><imagedata fileref="dashboard_budget.png"/></imageobject>
+ </mediaobject>
+ </screenshot>
+
+ <para>Display the budget for the current month or the previous month.</para>
+ </sect2>
+
+ <sect2 id="dashboard_alarms">
+ <title>Alarms</title>
+ <para>Display the alarms defined in <link linkend="search_and_process">Search and Process</link> .</para>
+ </sect2>
+
+ <sect2 id="dashboard_report">
+ <title>Report</title>
+ <screenshot>
+ <mediaobject>
+ <imageobject><imagedata fileref="dashboard_report.png"/></imageobject>
+ </mediaobject>
+ </screenshot>
+
+ <para>Display the <link linkend="reports">report</link> you want..</para>
+ </sect2>
+
+ <sect2 id="dashboard_quotes">
+ <title>Quotes</title>
+ <screenshot>
+ <mediaobject>
+ <imageobject><imagedata fileref="dashboard_quotes.png"/></imageobject>
+ </mediaobject>
+ </screenshot>
+
+ <para>Display the quote of the defined <link linkend="units">units</link> and the variations. You can choose the types of units to display.</para>
+ </sect2>
+
+ <sect2 id="dashboard_portfolio">
+ <title>Portfolio</title>
+ <screenshot>
+ <mediaobject>
+ <imageobject><imagedata fileref="dashboard_portfolio.png"/></imageobject>
+ </mediaobject>
+ </screenshot>
+
+ <para>Display all information relative to the shares you have.</para>
+ </sect2>
+
+ <sect2 id="dashboard_interest">
+ <title>Estimated interest</title>
+ <screenshot>
+ <mediaobject>
+ <imageobject><imagedata fileref="dashboard_interest.png"/></imageobject>
+ </mediaobject>
+ </screenshot>
+
+ <para>Display the estimation of interest for each account. You have to use the <link linkend="simulations">simulation</link> page to define the rate of each account.</para>
+ </sect2>
</sect1>
<sect1 id="accounts">
@@ -2130,6 +2325,20 @@ file is opened. It's also recommended to create a different account (⪚ "ETF")
<para><!-- TODO --></para>
</sect1>
+ <sect1 id="simulations">
+ <title>Simulations</title>
+ <para><!-- TODO --></para>
+
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="simulations.png" format="PNG"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ <para><!-- TODO --></para>
+ </sect1>
+
</chapter>
<chapter id="credits">
diff --git a/doc/simulations.png b/doc/simulations.png
index f1c7f41..9e63b83 100644
Binary files a/doc/simulations.png and b/doc/simulations.png differ
diff --git a/examples/demo.skg b/examples/demo.skg
index 99db725..83bffdf 100644
Binary files a/examples/demo.skg and b/examples/demo.skg differ
More information about the kde-doc-english
mailing list