r22592 - gnucash-docs/trunk/help/C - Bug #684709: add explanation of transaction statuses (R field) and cross reference it. BP

[Cristian Marchi]

Author: cmarchi
Date: 2012-11-23 15:56:29 -0500 (Fri, 23 Nov 2012)
New Revision: 22592
Trac: http://svn.gnucash.org/trac/changeset/22592

Modified:
   gnucash-docs/trunk/help/C/Help_ch_Tools_Assistants.xml
   gnucash-docs/trunk/help/C/Help_ch_Transactions.xml
Log:
Bug #684709: add explanation of transaction statuses (R field) and cross reference it. BP

Modified: gnucash-docs/trunk/help/C/Help_ch_Tools_Assistants.xml
===================================================================
--- gnucash-docs/trunk/help/C/Help_ch_Tools_Assistants.xml	2012-11-23 18:08:55 UTC (rev 22591)
+++ gnucash-docs/trunk/help/C/Help_ch_Tools_Assistants.xml	2012-11-23 20:56:29 UTC (rev 22592)
@@ -487,8 +487,9 @@
                 <guilabel>Reconcile</guilabel> option applies the selected criteria to each line
 		of a transaction individually. Each transaction line may have only one of the indicated values,
 		but there is often a mix of values within a complete transaction, so companion lines may 
-		not meet the selected criteria. See separate note defining status values.</para></footnote>
-                </para></entry>
+		not meet the selected criteria. See separate note defining status values. For a detailed 
+                description of transaction statuses see <xref linkend="trans-stts" />
+                </para></footnote></para></entry>
 
                 <entry><para>is</para></entry>
 

Modified: gnucash-docs/trunk/help/C/Help_ch_Transactions.xml
===================================================================
--- gnucash-docs/trunk/help/C/Help_ch_Transactions.xml	2012-11-23 18:08:55 UTC (rev 22591)
+++ gnucash-docs/trunk/help/C/Help_ch_Transactions.xml	2012-11-23 20:56:29 UTC (rev 22592)
@@ -472,6 +472,53 @@
         </itemizedlist>
    </sect1>
 
+ <sect1 id="trans-stts">
+        <title>Setting the reconcile status (<guilabel>R</guilabel> field) of a transaction</title>
+	<para>In the <application>&app;</application> register there is a column named <guilabel>R</guilabel>. This field 
+        indicates the status of a transaction. Possible values are:</para>
+
+	<variablelist>
+	  <varlistentry>
+            <term><guilabel>n</guilabel></term>
+	      <listitem>
+	        <para>Default status when a transaction is created</para>
+  	      </listitem>
+  	  </varlistentry>
+
+	  <varlistentry>
+            <term><guilabel>c</guilabel></term>
+	      <listitem>
+	        <para>Cleared. Status may be assigned either manually or by an import process.</para>
+  	      </listitem>
+  	  </varlistentry>
+
+	  <varlistentry>
+            <term><guilabel>y</guilabel></term>
+	      <listitem>
+	        <para>Status assigned solely by the reconciliation process (see <xref linkend="acct-reconcile" />).  
+                Places limits optionally requiring confirmation on editing fields in that line of a transaction.</para>
+  	      </listitem>
+  	  </varlistentry>
+
+	  <varlistentry>
+            <term><guilabel>f</guilabel></term>
+	      <listitem>
+	        <para>Frozen. Not implemented at this time</para>
+  	      </listitem>
+  	  </varlistentry>
+
+	  <varlistentry>
+            <term><guilabel>v</guilabel></term>
+	      <listitem>
+	        <para>Voided. Status is assigned or released manually through the transaction menu (<xref linkend="Trans-transaction-menu" />)
+                to a transaction and applies to every line in the transaction. It hides most of the transaction details but does not delete them. 
+                When a transaction is voided a reason entry is required that appears to the right of the description.</para>
+  	      </listitem>
+  	  </varlistentry>
+	</variablelist>
+
+ </sect1>
+
    <sect1 id="acct-jump">
     <title>Jump to another Account Register</title>