Git commit f525111c20c8f30b4e7e7f7dbdc33d12d62f1026 by Stephane MANKOWSKI.
Committed on 17/11/2019 at 17:56.
Pushed by smankowski into branch 'master'.

improve Reconciliation doc
BUG:D25085

M  +11   -11   doc/index.docbook

https://commits.kde.org/skrooge/f525111c20c8f30b4e7e7f7dbdc33d12d62f1026

diff --git a/doc/index.docbook b/doc/index.docbook
index e81b98b15..1f32e5faa 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -713,7 +713,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 settings 
(<menuchoice><guimenu>Settings</guimenu> <guimenuitem>Configure 
&skrooge;</guimenuitem></menuchoice>), in the <guilabel>Import / 
Export</guilabel> section.</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>
       </sect2>
       
       <sect2 id="import_operations">
@@ -1519,8 +1519,8 @@ file is opened. It is also recommended to create a 
different account (&eg; "ETF"
       
       <sect2 id="reconciliation">
        <title>Reconciliation</title>
-       <para>Reconciliation is the process by which you ensure that all 
operations are aligned with your account's position from the bank point of 
view. It will involve you, your account's position, and a pen. Reconciliation 
can happen only for an account at one point in time.</para>
-       <para>In the operation view, select the account you wish to 
reconciliate from the drop down box. Switch into reconciliation mode using the 
<guibutton>Switch Information button <inlinemediaobject><imageobject><imagedata 
fileref="switch_information.png" 
format="PNG"/></imageobject></inlinemediaobject></guibutton> below the 
operations table.</para>
+       <para>Reconciliation is the process by which you ensure that all 
operations in an account match the bank's view of that account. It will involve 
you, your account's position, and a pen. Reconciliation can happen only for an 
account at one point in time.</para>
+       <para>First, enter all the operations for the account up to that point 
in time; if you can, download transactions from the bank and <link 
linkend="import">import</link> them into &skrooge; to minimize data entry. 
Then, in the Operations view, select the account you wish to reconcile from the 
drop-down box; or in the Accounts view, double-click the account name or bring 
up the contextual menu and choose <menuchoice><guimenu>Open 
operations...</guimenu></menuchoice>. Switch into reconciliation mode using the 
<guibutton>Switch Information button <inlinemediaobject><imageobject><imagedata 
fileref="switch_information.png" 
format="PNG"/></imageobject></inlinemediaobject></guibutton> below the 
operations table.</para>
        
        <screenshot>
          <mediaobject>
@@ -1529,22 +1529,22 @@ file is opened. It is also recommended to create a 
different account (&eg; "ETF"
          </mediaobject>
        </screenshot>
        
-       <para>Enter the position of your account as provided by your bank in 
the dedicated field. Now, you can proceed to checking in &skrooge; every 
operation that appears on the account recordings. For the moment, the check box 
for this operation will appear half greyed, until you really validate the 
reconciliation.</para>
+       <para>Enter the position of your account as provided by your bank in 
the dedicated field. Now, you can proceed to pointing in &skrooge; every 
operation that appears in the bank's statement: you can either click on its 
checkbox in the status column or bring up the contextual menu and choose 
<guimenuitem>Point</guimenuitem>. The check box for this operation will appear 
part filled, until you complete reconciliation.</para>
        
-       <para>As you check operations, you will see &skrooge; display in the 
information zone:</para>
+       <para>As you point operations, you will see &skrooge; display in the 
information zone:</para>
        <itemizedlist>
-         <listitem><para>Delta: the difference between the previously entered 
account position and the sum of all checked operations</para></listitem>
-         <listitem><para>Expenditure:the total amount of 
expenses</para></listitem>
-         <listitem><para>Income: the total amount of incomes</para></listitem>
+         <listitem><para>Delta: the difference between the previously entered 
account position and the sum of all checked 
operations</para></listitem><!--TODO: explain 'previously entered'; what 
happens-->
+         <listitem><para>Expenditure:the total amount of Pointed 
debits</para></listitem>
+         <listitem><para>Income: the total amount of Pointed 
credits</para></listitem>
        </itemizedlist>
        
-       <para>This may be useful when trying to spot operations you may have 
forgot to enter in &skrooge;. 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>
+       <para>These running totals help you spot operations you may have 
forgotten to enter in &skrooge;. Many bank statements provide similar totals 
such as "Withdrawals" or "Deposits and Credits", although they may have 
separate totals for "Interest", "Fees". When the Delta is equal to 0, you 
<emphasis>may</emphasis> have pointed all operations matching the bank's 
record. For example, you may have mistakenly pointed a debit of 8€ and a credit 
of 2€, and overlooked a bank debit of 6€; the net is the same, minus 6€. When 
the Delta is 0, the <guibutton>Validate pointed operations button 
<inlinemediaobject><imageobject><imagedata fileref="validate.png" format="PNG" 
/></imageobject></inlinemediaobject></guibutton> is enabled. Click on this 
button to complete your reconciliation: all pointed operations are now 
checked.</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>
+       <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, a fake can 
be automatically created to allow the reconciliation. The default attributes of 
the fake operation can be defined from settings. During reconciliation, if the 
appropriate setting is enabled, all created operations are automatically 
pointed.</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>
        
       </sect2>
       

Reply via email to