[kde-doc-english] [skrooge] doc: Documentation update
Stephane Mankowski
stephane at mankowski.fr
Thu Jun 12 20:05:23 UTC 2014
Git commit e3c38a97e959a834365f42e817ac83ec4728a370 by Stephane Mankowski.
Committed on 11/06/2014 at 20:30.
Pushed by smankowski into branch 'master'.
Documentation update
M +- -- doc/categories.png
M +60 -4 doc/index.docbook
A +- -- doc/payees.png
M +- -- doc/reports.png
M +- -- doc/units.png
http://commits.kde.org/skrooge/e3c38a97e959a834365f42e817ac83ec4728a370
diff --git a/doc/categories.png b/doc/categories.png
index 22911f1..e0e4164 100644
Binary files a/doc/categories.png and b/doc/categories.png differ
diff --git a/doc/index.docbook b/doc/index.docbook
index 50ec271..203d1af 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -746,6 +746,7 @@
</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>
<screenshot>
<mediaobject>
<imageobject><imagedata fileref="menu_file.png"/></imageobject>
@@ -775,6 +776,7 @@
<sect2 id="menu-edit">
<title>The edit menu</title>
+ <para>You can find in this menu all functions modifing selected objects</para>
<screenshot>
<mediaobject>
<imageobject><imagedata fileref="menu_edit.png"/></imageobject>
@@ -782,12 +784,32 @@
</screenshot>
<itemizedlist>
- <listitem><para></para></listitem>
+ <listitem><para><guimenuitem>Undo</guimenuitem>: Cancel the previous modification done</para></listitem>
+ <listitem><para><guimenuitem>Redo</guimenuitem>: Reapply the previous modification cancelled</para></listitem>
+ <listitem><para><guimenuitem>Undo</guimenuitem>: Cancel the previous modifications done up to the last save</para></listitem>
+ <listitem><para><guimenuitem>Delete</guimenuitem>: Delete the selected objects (operations, accounts, categories, ...)</para></listitem>
+ <listitem><para><guimenuitem>Add property</guimenuitem>: Add a property regularly used on the selected objects</para></listitem>
+ <listitem><para><guimenuitem>Select all</guimenuitem>: Select all lines of the <link linkend="tables">table</link> of the current page</para></listitem>
+ <listitem><para><guimenuitem>Fast edit:</guimenuitem>: Facilitation the creation of new <link linkend="operations">operations</link> by filling fields automatically based on previous operations created</para></listitem>
+ <listitem><para><guimenuitem>Find...</guimenuitem>: Open the <link linkend="search_and_process">Search and process</link> page with a predefined filter corresponding to the selected objects</para></listitem>
+ <listitem><para><guimenuitem>Switch highlight</guimenuitem>: Switch the highlight 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>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>
+ <listitem><para><guimenuitem>Merge sub operations</guimenuitem>: Merge selected operations in one split operation</para></listitem>
+ <listitem><para><guimenuitem>Schedule</guimenuitem>: </para></listitem>
+ <listitem><para><guimenuitem>Validate imported operations</guimenuitem>: Validate all selected imported operations</para></listitem>
+ <listitem><para><guimenuitem>Merge imported operations</guimenuitem>: Merge one imported operation with an other operation entered manually. If amounts are different then a confirmation is requested</para></listitem>
+ <listitem><para><guimenuitem>Split shares</guimenuitem>: Split selected <link linkend="units">shares</link></para></listitem>
</itemizedlist>
</sect2>
<sect2 id="menu-view">
<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>
<imageobject><imagedata fileref="menu_view.png"/></imageobject>
@@ -795,12 +817,13 @@
</screenshot>
<itemizedlist>
- <listitem><para></para></listitem>
+ <listitem><para><guimenuitem></guimenuitem>: </para></listitem>
</itemizedlist>
</sect2>
<sect2 id="menu-do">
<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>
<imageobject><imagedata fileref="menu_go1.png"/></imageobject>
@@ -900,7 +923,7 @@
<listitem><para>The account type can be
<itemizedlist>
<listitem><para>Current</para></listitem>
- <listitem><para>Credit Card: This kind of account has a specific reconciliation mode.</para></listitem>
+ <listitem><para>Credit Card: This kind of account has a specific <link linkend="reconciliation">reconciliation</link> mode.</para></listitem>
<listitem><para>Saving</para></listitem>
<listitem><para>Investment</para></listitem>
<listitem><para>Assets</para></listitem>
@@ -1067,7 +1090,7 @@
<variablelist>
<varlistentry>
<term>Status</term>
- <listitem><para>This check box indicates whether this operation has been confirmed during account reconciliation. A half-greyed check box means the reconciliation is ongoing.</para></listitem>
+ <listitem><para>This check box indicates whether this operation has been confirmed during account <link linkend="reconciliation">reconciliation</link>. A half-greyed check box means the <link linkend="reconciliation">reconciliation</link> is ongoing.</para></listitem>
</varlistentry>
<varlistentry>
<term>Bookmark</term>
@@ -1268,6 +1291,39 @@ file is opened. It's also recommended to create a different account (⪚ "ETF")
</sect1>
+ <sect1 id="payees">
+ <title>Payees</title>
+ <para>The Payees view allow you to browse the payees list.</para>
+
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="payees.png" format="PNG"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+
+ <para>In addition to the name of payees, the table also shows: </para>
+
+ <variablelist>
+ <varlistentry>
+ <term>Address</term>
+ <listitem><para>The address of this payee.</para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Amount</term>
+ <listitem><para>The sum of all operations in this payee.</para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Number of Operations</term>
+ <listitem><para>The number of operations in this payee.</para></listitem>
+ </varlistentry>
+ </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">
<title>Categories</title>
<para>The Categories view allow you to browse the categories tree.</para>
diff --git a/doc/payees.png b/doc/payees.png
new file mode 100644
index 0000000..d9a3524
Binary files /dev/null and b/doc/payees.png differ
diff --git a/doc/reports.png b/doc/reports.png
index 6641fb3..0146454 100644
Binary files a/doc/reports.png and b/doc/reports.png differ
diff --git a/doc/units.png b/doc/units.png
index 83fa0fb..20a3828 100644
Binary files a/doc/units.png and b/doc/units.png differ
More information about the kde-doc-english
mailing list