[kde-doc-english] [skrooge] doc: Update documentation
Stephane Mankowski
stephane at mankowski.fr
Sun Feb 15 15:54:19 UTC 2015
Git commit 0a202d828912754f2795e80d5f35549981f2b42a by Stephane Mankowski.
Committed on 14/02/2015 at 16:09.
Pushed by smankowski into branch 'master'.
Update documentation
M +27 -4 doc/index.docbook
M +1 -1 doc/kde_docbook
A +- -- doc/messages.png
M +- -- doc/reports.png
http://commits.kde.org/skrooge/0a202d828912754f2795e80d5f35549981f2b42a
diff --git a/doc/index.docbook b/doc/index.docbook
index effbe8a..8fa5a62 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -5,9 +5,7 @@
<!ENTITY tbw "TO BE WRITTEN">
<!ENTITY % addindex "IGNORE">
<!ENTITY % English "INCLUDE"><!-- change language only here -->
-
<!ENTITY homepage "http://extragear.kde.org/apps/skrooge/">
-
]>
<book id="skrooge" lang="&language;">
@@ -274,6 +272,7 @@
<listitem><para><link linkend="bookmarks">The bookmark list</link></para></listitem>
<listitem><para><link linkend="undo_redo">The undo / redo browser</link></para></listitem>
<listitem><para><link linkend="property_editor">The property editor</link></para></listitem>
+ <listitem><para><link linkend="message_list">The Message list</link></para></listitem>
</itemizedlist>
</para>
</sect2>
@@ -423,7 +422,22 @@
Added properties can be displayed as a column on <link linkend="tables">tables</link>
</para>
</sect2>
-
+
+ <sect2 id="message_list">
+ <title>Message list</title>
+ <para>
+ This dock allows you to see all message displayed.</para>
+
+ <screenshot>
+ <mediaobject>
+ <imageobject><imagedata fileref="messages.png" format="PNG"/></imageobject>
+ <textobject><phrase>The message list</phrase></textobject>
+ </mediaobject>
+ </screenshot>
+
+ <para>Each context will be described in a specific chapter in this handbook.</para>
+ </sect2>
+
<sect2 id="multi-tabs">
<title>Multiple Tabs</title>
@@ -658,6 +672,7 @@
<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>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>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>
<tip><para>If you don't want to store your bank passwords in the configuration file of WEBOOB, you can do that:
@@ -1518,6 +1533,8 @@ file is opened. It's also recommended to create a different account (⪚ "ETF")
<para>If the option <guibutton>Hide checked operations</guibutton> is selected, all these operations will now be hidden.</para>
+ <para>If the reconciliation is not possible for any reason, a fake can be automatically created to allow the reconcilation. The default attributes of the fake operation can be defined from settings.</para>
+
</sect2>
<sect2 id="templates">
@@ -1732,6 +1749,11 @@ file is opened. It's also recommended to create a different account (⪚ "ETF")
<para>Select the type of operations you want to include in your report. For example, if you want to draw a graph showing your expenses distribution per category, you probably do not want to include "Incomes" to your report.</para>
</sect3>
+ <sect3 id="report_other_filters">
+ <title>Other filters</title>
+ <para>From this section, you can select some other filters defined by selection done in other pages. If you want a report only for the categories "Food" and "Gift", you just have to open the page of <link linkend="categories">categories</link>, select the 2 categories and come back to the report to active the corresponding filter.</para>
+ </sect3>
+
</sect2>
<sect2 id="graph_types">
@@ -2375,7 +2397,8 @@ file is opened. It's 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 &appname; will send you when the amount is reached.
+ <tip>Alarm messages can be have parameters for the total amount (%1), alarm amount (%2) and difference (%3).</tip></para>
</sect2>
diff --git a/doc/kde_docbook b/doc/kde_docbook
index a4ef97e..893e05b 100755
--- a/doc/kde_docbook
+++ b/doc/kde_docbook
@@ -14,7 +14,7 @@ echo " -> OK !";
# Convert to html
echo "Running xsltproc... ";
-xsltproc -o $2 /usr/share/apps/ksgmltools2/customization/kde-nochunk.xsl $1;
+xsltproc -o $2 /usr/share/kde4/apps/ksgmltools2/customization/kde-nochunk.xsl $1;
if [ $? -gt 0 ]; then
echo " -> xsltproc failed !";
exit 1;
diff --git a/doc/messages.png b/doc/messages.png
new file mode 100644
index 0000000..7bd2819
Binary files /dev/null and b/doc/messages.png differ
diff --git a/doc/reports.png b/doc/reports.png
index 0146454..559c77f 100644
Binary files a/doc/reports.png and b/doc/reports.png differ
More information about the kde-doc-english
mailing list