Help manual edit

[Yawar Amin]

Hi David,

On 2012-02-26, at 12:38, David Carlson wrote:

> Hi,
> 
> I am using a windows 7 computer and have yet to set up an equivalent to
> xmllint.
> 
> This time I will attach my edited xml file and ask for someone to
> validate my changes.  There are only a few minor edits and I really
> expect the file to 'pass'.

The changes all pass the automated check, and the output HTML files come out successfully. However, I made a couple of tweaks to your changes:

* Formatted all the lines to 75-character width to keep things readable in most text editors

* Highlighted the menu commands and keyboard shortcuts using the standard DocBook XML tags

* Changed the description of regexes slightly to a very short definition and a link to Wikipedia

You can see the changes below. I do have one question: the last line you added says ‘See separate note defining status values’. Which note does this refer to? We can actually put in a link at this point so the reader can jump directly to the note.

Regards,

Yawar

The changes as a diff from the current version in the repository:

diff --git a/help/C/Help_ch_Tools_Assistants.xml b/help/C/Help_ch_Tools_Assistants.xml
index 0a54c63..5123bf9 100644
--- a/help/C/Help_ch_Tools_Assistants.xml
+++ b/help/C/Help_ch_Tools_Assistants.xml
@@ -38,11 +38,17 @@
         invoked.  Access to the Tool via <menuchoice><guimenu>Business</guimenu><guisubmenu>(Customer/Vendor/Employee)</guisubmenu></menuchoice>.
         </para></note>
 
-        <para>To open the Find Transactions dialog in the Account Tree Window
-        go to the Tools menu and select Find Transactions or type menu
-        shortcut Ctrl-F. To open the Find Transactions dialog in the Account
-        Register Window go to the Edit menu and select Find... or type menu
-        shortcut F6.</para>
+        <para>When selecting your search criteria keep in mind the fact
+        that the criteria are applied to individual “sides“,
+        lines or fields in transactions, but the entire transaction is
+        included in the results register display. There is no visual
+        indication of which lines or fields actually meet the search
+        criteria versus which lines come along for the ride.</para>
+
+        <para>To open the Find Transactions dialog go to
+        <menuchoice><guimenu>Edit</guimenu><guimenuitem>Find...</guimenuitem></menuchoice>
+        or type keyboard shortcut
+        <keycombo><keycap>Ctrl</keycap><keycap>F</keycap></keycombo>.</para>
 
         <para>There are two panes in the search dialog. The top pane contains
         the Search Criteria buttons and the bottom pane contains the Type of
@@ -57,9 +63,21 @@
         to have at least one match. The any criteria are met search requires
         only one of the criteria rows to be matched.</para>
 
-        <para>The criteria row is used to combine different criteria buttons.
-        The following table describes the possible button combinations (regex
-        means regular expression search);</para>
+        <para>The criteria row is used to combine different criteria
+        buttons. The following table describes the possible button
+        combinations (regex means a <ulink type="http"
+        url="http://en.wikipedia.org/wiki/Regular_expression">regular
+        expression</ulink>, which is similar to but more powerful than the
+        “wildcards” used in various programs.</para>
+
+        <para>To search within a smaller group of transactions, you may
+        start from within a single account register and also use the
+        register view <guilabel>Filter By...</guilabel> option to include a
+        limited number of transactions. When starting from a single account
+        register, only the parts of transactions applying to that account
+        are searched. Thus the transfer accounts, notes and transfer values
+        are not searched, but they do appear in the search result
+        register.</para>
 
         <table frame="topbot" id="tool-find-buttons">
           <title>Search criteria buttons.</title>
@@ -1223,6 +1241,13 @@
           </tgroup>
         </table>
 
+        <para>The Reconcile button 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>
+
         <para>The Account button performs a search where the accounts selected
         in the Choose Accounts dialog will both be searched individually for
         results. This means that a match in any of the selected accounts will
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 194 bytes
Desc: Message signed with OpenPGP using GPGMail
URL: <http://lists.gnucash.org/pipermail/gnucash-devel/attachments/20120226/a2b10885/attachment.sig>