[office/kmymoney/Handbook-5.2] /: search chapter
Jack Ostroff
null at kde.org
Wed Nov 22 00:41:42 GMT 2023
Git commit 8167cfb4f832e4043eb1591a1e032e45d840be5c by Jack Ostroff.
Committed on 22/11/2023 at 01:41.
Pushed by ostroffjh into branch 'Handbook-5.2'.
search chapter
M +17 -5 README-CONTRIBUTORS
M +196 -178 doc/details-search.docbook
M +15 -17 doc/details-settings.docbook
M +1 -1 doc/details-tags.docbook
A +- -- doc/find-tag.png
https://invent.kde.org/office/kmymoney/-/commit/8167cfb4f832e4043eb1591a1e032e45d840be5c
diff --git a/README-CONTRIBUTORS b/README-CONTRIBUTORS
index dd43c895e..424cae9db 100644
--- a/README-CONTRIBUTORS
+++ b/README-CONTRIBUTORS
@@ -87,15 +87,15 @@ This is in the order pulled in from index.docbook, with brief note on state of u
<!ENTITY details-forecast SYSTEM "details-forecast.docbook">
prelim update complete
-<!ENTITY details-settings SYSTEM "details-settings.docbook">
- prelim update begun
-
<!ENTITY details-search SYSTEM "details-search.docbook">
-
+ prelim update complete
+
<!ENTITY details-formats SYSTEM "details-formats.docbook">
<!ENTITY details-database SYSTEM "details-database.docbook">
+<!ENTITY details-settings SYSTEM "details-settings.docbook">
+
<!ENTITY faq SYSTEM "faq.docbook">
<!ENTITY reference SYSTEM "reference.docbook">
@@ -339,4 +339,16 @@ elsewhere.
- Forecast View, Budget tab seems final column really is Total, not anything
predicted, and values seem history predicted, even though my Forecast Method is
- Scheduled.
\ No newline at end of file
+ Scheduled.
+
+- Search dialog - some tabs say "All"/"None" but some say "Select all"/"Select none."
+ These should be consisstent.
+
+- The Search Dialog Deatils subtab has a problem with vertical alignment. "Search
+ number in range" is at the vertical midpoint of from and to (looks good) but
+ "Search this number" seems lower than the text field for that number.
+
+- Search results should include (optional) Number column if you can search on it.
+
+- Cant search results be sorted any more? (Could they ever?)
+
diff --git a/doc/details-search.docbook b/doc/details-search.docbook
index 051dfeaab..190b5f899 100644
--- a/doc/details-search.docbook
+++ b/doc/details-search.docbook
@@ -3,45 +3,41 @@
<chapterinfo>
<authorgroup>
<author> &Darin.Strait; &Darin.Strait.mail; </author>
+ <author> &Jack.H.Ostroff; &Jack.H.Ostroff.mail; </author>
</authorgroup>
- <date>2010-07-25</date>
- <releaseinfo>4.5</releaseinfo>
+ <date>2023-11-25</date>
+ <releaseinfo>5.2</releaseinfo>
</chapterinfo>
<title>Search Transactions</title>
-<sect1 id="details.search.general">
-<title>General</title>
-
<para>
- The <guilabel>Search Transactions</guilabel> dialog searches your data based
- on criteria that you specify. You can access the dialog by going to
- the <guimenu>Edit</guimenu> menu and selecting
- <guimenuitem>Find transaction...</guimenuitem>.
+ You can use the <guilabel>Search transactions</guilabel> dialog to search your data
+ for transactions based on criteria that you specify. You can access the dialog by
+ selecting the <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Find
+ transaction...</guimenuitem></menuchoice> menu item, or typeing <keycombo
+ action="simul">&Ctrl; &Shift;<keycap>F</keycap></keycombo>..
</para>
<para>
- There are two main tabs in this dialog. The <quote>Criteria</quote> tab
- displays a number of sub-tabs for specifying the search criteria.
+ There are two main tabs in this dialog. The <guilabel>Criteria</guilabel> tab
+ displays a number of subtabs for specifying the search criteria. When the
+ <guibutton>Find</guibutton> button is pressed, the search is initiated and all
+ criteria that have been entered on any of the Criteria subtabs will be taken into
+ account.
</para>
<para>
- The results will be displayed under the <quote>Result</quote> tab after the
- search has completed. Below the list of results, &kmymoney; shows the number
- of transactions that met the search criteria. Double-clicking on an
- individual transaction in the result list will bring up the appropriate ledger
- and display the transaction.
-</para>
-
-<para>
- When the <guibutton>Find</guibutton> button is pressed, the search is
- initiated and all criteria that have been entered on any tab will be taken
- into account.
+ After the search has completed, the results will be displayed under the
+ <guilabel>Result</guilabel> tab. Below the list of results, &kmymoney; shows the
+ number of transactions that met the search criteria. Double-clicking on an
+ individual transaction in the result list will bring up the appropriate ledger with
+ that transaction selected.
</para>
<para>
The <guibutton>Reset</guibutton> button resets all of the fields on all of the
- criteria sub-tabs back to the defaults. This allows you to specify new search
+ criteria subtabs back to the defaults. This allows you to specify new search
criteria.
</para>
@@ -50,39 +46,36 @@
Transactions</guilabel> dialog box.
</para>
-</sect1>
-
-<sect1 id="details.search.criteria">
-<title>Search Criteria</title>
+<sect1 id="details.search.criteria"><title>Search Criteria</title>
<para>
- There are several sub-tabs under the main <quote>Criteria</quote> tab, each of
- which allows you to specify different types of search criteria. Below the
- area for specifying the criteria, &kmymoney; lists each of the different types
- of criteria that are currently specified for the search.
+ There are several subtabs under the main Criteria tab, each of which allows you to
+ specify a different type of search criteria. Below the area for specifying the
+ criteria, &kmymoney; lists each of the different types of criteria that are
+ currently specified for the search.
</para>
<sect2 id="details.search.text">
<title>Text</title>
<screenshot>
-<mediaobject>
-<imageobject>
-<imagedata fileref="find-text.png" format="PNG" />
-</imageobject>
-<textobject>
-<phrase>Search transactions Dialog, Text tab</phrase>
-</textobject>
-</mediaobject>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="find-text.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>Search transactions Dialog, Text tab</phrase>
+ </textobject>
+ </mediaobject>
</screenshot>
<para>
- This tab allows you to specify text to search for. There are also two check
- boxes that control how the text is used in the search.
+ This tab allows you to specify text to search for. There are also a drop-down
+ field and two check boxes that control how the text is used in the search.
</para>
<para>
- By default, this will match on simple substrings. For example:
+ By default, the search will match on simple substrings. For example:
</para>
<para>
@@ -99,10 +92,10 @@
</para>
<para>
- In the dropdown field next to the text field,
- select <guilabel>Contains</guilabel> if you want to find transactions that
- contain the text, or select <guilabel>Does not contain</guilabel> if you want
- to find transactions that do not contain the specified text.
+ In the dropdown field next to the text field, select <guilabel>Contains</guilabel>
+ if you want to find transactions that contain the text, or select <guilabel>Does
+ not contain</guilabel> if you want to find transactions that do not contain the
+ specified text.
</para>
<para>
@@ -112,26 +105,25 @@
</para>
<para>
- If you check the <guilabel>Treat Text as regular expression</guilabel> box,
- the text will be treated as a regular expression. For details on how to
- craft a regular expression, visit the &Qt; documentation about the
- <ulink url="https://doc.qt.io/qt-5/qregularexpression.html">QRegularExpression
+ If you check the <guilabel>Treat Text as regular expression</guilabel> box, the
+ text will be treated as a regular expression. For details on how to craft a
+ regular expression, visit the &Qt; documentation about the <ulink
+ url="https://doc.qt.io/qt-5/qregularexpression.html">QRegularExpression
class</ulink>.
</para>
</sect2>
-<sect2 id="details.search.account">
-<title>Account</title>
+<sect2 id="details.search.account"><title>Account</title>
<screenshot>
-<mediaobject>
-<imageobject>
-<imagedata fileref="find-account.png" format="PNG" />
-</imageobject>
-<textobject>
-<phrase>Search transactions Dialog, Account tab</phrase>
-</textobject>
-</mediaobject>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="find-account.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>Search transactions Dialog, Account tab</phrase>
+ </textobject>
+ </mediaobject>
</screenshot>
<para>
@@ -139,57 +131,56 @@
</para>
<para>
- Accounts are displayed in a tree format. Accounts that are marked for search
- are indicated with a checkbox. If you click the <guibutton>All</guibutton>
- button, all accounts are marked for searching. If you click the
- <guibutton>None</guibutton> button, no accounts will be marked for
- searching. Individual accounts can be marked or unmarked by clicking on the
- box next to the account name using the &LMB;. A complete hierarchy of accounts
- can be marked or unmarked by clicking on the box using the &RMB;.
+ Accounts are displayed in a tree format. Accounts that are marked for search are
+ indicated with a checkbox. If you click the <guibutton>All</guibutton> button, all
+ accounts are marked for searching. If you click the <guibutton>None</guibutton>
+ button, no accounts will be marked for searching. Individual accounts can be
+ marked or unmarked by clicking on the box next to the account name using the &LMB;.
+ A complete hierarchy of accounts can be marked or unmarked by clicking on the box
+ using the &RMB;.
</para>
</sect2>
-<sect2 id="details.search.date">
-<title>Date</title>
+<sect2 id="details.search.date"><title>Date</title>
<screenshot>
-<mediaobject>
-<imageobject>
-<imagedata fileref="find-date.png" format="PNG" />
-</imageobject>
-<textobject>
-<phrase>Search transactions Dialog, Date tab</phrase>
-</textobject>
-</mediaobject>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="find-date.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>Search transactions Dialog, Date tab</phrase>
+ </textobject>
+ </mediaobject>
</screenshot>
<para>
- This tab allows you to specify which dates should be searched.
+ This tab allows you to specify which dates should be searched. The date refers to
+ the post date of the transaction.
</para>
<para>
- The <quote>Range</quote> control provides a convenient way to set the From and
- To controls. The From and To controls can be manipulated individually. Dates
- can be entered manually. The controls will prevent you from entering
- non-existing dates. Date values can also be changed by clicking on the up and
- down arrows when a particular part of a date is highlighted. Clicking on the
- small calendar icon will bring up a calendar to easily select dates.
+ The <quote>Range</quote> dropdown provides a convenient way to set the From and To
+ date controls. The From and To controls can be manipulated individually. Dates
+ can be entered manually, and clicking the down arrow at the right of the field will
+ bring up a typical calendar widget to select the date. The controls will prevent
+ you from entering non-existing dates. Date values can also be changed by clicking
+ on the up and down arrows while the cursor in within a particular part of a date.
</para>
</sect2>
-<sect2 id="details.search.amount">
-<title>Amount</title>
+<sect2 id="details.search.amount"><title>Amount</title>
<screenshot>
-<mediaobject>
-<imageobject>
-<imagedata fileref="find-amount.png" format="PNG" />
-</imageobject>
-<textobject>
-<phrase>Search transactions Dialog, Amount tab</phrase>
-</textobject>
-</mediaobject>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="find-amount.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>Search transactions Dialog, Amount tab</phrase>
+ </textobject>
+ </mediaobject>
</screenshot>
<para>
@@ -197,24 +188,23 @@
</para>
<para>
- You can search for an exact amount or for a range of amounts. If you click on
- the calculator icon, a small on-screen calculator will pop up to assist you in
- entering a value.
+ You can search for an exact amount or for a range of amounts. If you click on the
+ calculator icon, a small on-screen calculator will pop up to assist you in entering
+ a value.
</para>
</sect2>
-<sect2 id="details.search.category">
-<title>Category</title>
+<sect2 id="details.search.category"><title>Category</title>
<screenshot>
-<mediaobject>
-<imageobject>
-<imagedata fileref="find-category.png" format="PNG" />
-</imageobject>
-<textobject>
-<phrase>Search transactions Dialog, Category tab</phrase>
-</textobject>
-</mediaobject>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="find-category.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>Search transactions Dialog, Category tab</phrase>
+ </textobject>
+ </mediaobject>
</screenshot>
<para>
@@ -222,123 +212,151 @@
</para>
<para>
- Categories are displayed in a tree format. Categories that are marked for
- search are indicated with a box. If you click the <guibutton>All</guibutton>
- button, all categories are marked for searching. If you click
- the <guibutton>None</guibutton> button, no categories will be marked for
- searching. If you click the <guibutton>Income</guibutton> button, income
- categories will be marked and expense categories will be unmarked. If you
- click the <guibutton>Expense</guibutton> button, income categories will be
- unmarked and expense categories will be marked.
+ Categories are displayed in a tree format, similar to Accounts. Categories that
+ are marked for search are indicated with a checkbox. If you click the
+ <guibutton>All</guibutton> button, all categories are marked for searching. If you
+ click the <guibutton>Income</guibutton> button, all income categories will be
+ marked and all expense categories will be unmarked. If you click the
+ <guibutton>Expense</guibutton> button, all income categories will be unmarked and
+ all expense categories will be marked. If you click the
+ <guibutton>None</guibutton> button, no categories will be marked for searching.
</para>
<para>
- Individual categories can be marked or unmarked by clicking on the box next to
- the category name using the &LMB;. A complete hierarchy of categories can be
+ Individual categories can be marked or unmarked by clicking on the checkbox next to
+ the category name using the &LMB;. A complete hierarchy of categories can be
marked or unmarked by clicking on the box using the &RMB;.
</para>
</sect2>
-<sect2 id="details.search.payee">
-<title>Payee</title>
+<sect2 id="details.search.tag"><title>Tag</title>
<screenshot>
-<mediaobject>
-<imageobject>
-<imagedata fileref="find-payee.png" format="PNG" />
-</imageobject>
-<textobject>
-<phrase>Search transactions Dialog, Payee tab</phrase>
-</textobject>
-</mediaobject>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="find-tag.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>Search transactions Dialog, Tag tab</phrase>
+ </textobject>
+ </mediaobject>
</screenshot>
<para>
- This tab allows you to specify which payees should be searched.
+ This tab allows you to specify which tags should be searched.
</para>
<para>
- Payees that are marked for search are indicated with a box. If you click
- the <guibutton>All</guibutton> button, all payees are marked for searching. If
- you click the <guibutton>None</guibutton> button, no payees will be marked for
- searching. Individual payees can be marked or unmarked by clicking on the box
+ Tags that are marked for search are indicated with a box. If you click the
+ <guibutton>Select all</guibutton> button, all tags are marked for searching. If you
+ click the <guibutton>Select none</guibutton> button, no tags will be marked for
+ searching. Individual tags can be marked or unmarked by clicking on the checkbox
next to the payee name.
</para>
<para>
- If you check the <guilabel>Select transactions without payees</guilabel> box,
- only transactions with no payee will be selected.
+ If you check the <guilabel>Select transactions without tags</guilabel> box, only
+ transactions with no tag will be selected.
</para>
+<para>
+ <!-- FIXME: need to mention known issues with searching on tags in splits -->
+</para>
</sect2>
-<sect2 id="details.search.details">
-<title>Details</title>
+<sect2 id="details.search.payee"><title>Payee</title>
+
+<screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="find-payee.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>Search transactions Dialog, Payee tab</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
<para>
- This tab allows you to specify various additional search criteria.
+ This tab allows you to specify which payees should be searched.
+</para>
+
+<para>
+ Payees that are marked for search are indicated with a box. If you click the
+ <guibutton>Select all</guibutton> button, all payees are marked for searching. If
+ you click the <guibutton>Select none</guibutton> button, no payees will be marked
+ for searching. Individual payees can be marked or unmarked by clicking on the box
+ next to the payee name.
</para>
+<para>
+ If you check the <guilabel>Select transactions without payees</guilabel> box,
+ only transactions with no payee will be selected.
+</para>
+</sect2>
+
+<sect2 id="details.search.details"><title>Details</title>
+
<screenshot>
-<mediaobject>
-<imageobject>
-<imagedata fileref="find-details.png" format="PNG" />
-</imageobject>
-<textobject>
-<phrase>Search transactions Dialog, Details tab</phrase>
-</textobject>
-</mediaobject>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="find-details.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>Search transactions Dialog, Details tab</phrase>
+ </textobject>
+ </mediaobject>
</screenshot>
<para>
-<itemizedlist>
- <title>Type can be one of the following:</title>
- <listitem><para>All Types</para></listitem>
- <listitem><para>Payments</para></listitem>
- <listitem><para>Deposits</para></listitem>
- <listitem><para>Transfers</para></listitem>
-</itemizedlist>
-
-<itemizedlist>
- <title>State can be one of the following:</title>
- <listitem><para>All states</para></listitem>
- <listitem><para>Not reconciled</para></listitem>
- <listitem><para>Cleared</para></listitem>
- <listitem><para>Reconciled</para></listitem>
-</itemizedlist>
+ This tab allows you to specify various additional search criteria.
+</para>
-<itemizedlist>
- <title>Validity can be one of the following:</title>
- <listitem><para>Any transaction</para></listitem>
- <listitem><para>Valid transaction</para></listitem>
- <listitem><para>Invalid transaction</para></listitem>
-</itemizedlist>
+<para>
+ <itemizedlist>
+ <title>Type can be one of the following:</title>
+ <listitem><para>All Types</para></listitem>
+ <listitem><para>Payments</para></listitem>
+ <listitem><para>Deposits</para></listitem>
+ <listitem><para>Transfers</para></listitem>
+ </itemizedlist>
+
+ <itemizedlist>
+ <title>State can be one of the following:</title>
+ <listitem><para>All states</para></listitem>
+ <listitem><para>Not reconciled</para></listitem>
+ <listitem><para>Cleared</para></listitem>
+ <listitem><para>Reconciled</para></listitem>
+ </itemizedlist>
+
+ <itemizedlist>
+ <title>Validity can be one of the following:</title>
+ <listitem><para>Any transaction</para></listitem>
+ <listitem><para>Valid transaction</para></listitem>
+ <listitem><para>Invalid transaction</para></listitem>
+ </itemizedlist>
</para>
<para>
You can search for a particular transaction number or search for a range of
transaction numbers.
</para>
-
</sect2>
</sect1>
-<sect1 id="details.search.results">
-<title>Search results</title>
+<sect1 id="details.search.results"><title>Search results</title>
<para>
- The <quote>Result</quote> tab displays the Date, Account, Details,
- Reconciliation status, Payment, and Deposit for each transaction
- that matches the search criteria you have entered. Right-clicking
- on the header row of the results list allows you to alter the sort
- order of the results.
+ The <guilabel>Result</guilabel> tab displays the Entry (entry date, optional,) Date
+ (posting date,) Account, Payee, Details (memo,) C (reconciliation status,)
+ Decrease, and Increast for each transaction that matches the search criteria you
+ have entered. Clicking the &RMB; on the header row of the results list allows you
+ to toggle the display of the optional columns.
</para>
<para>
- Double-clicking on a transaction will display the corresponding
- account ledger and focus on the selected transaction.
+ Double-clicking on a transaction will display the corresponding account ledger with
+ that transaction selected.
</para>
-
</sect1>
-
</chapter>
diff --git a/doc/details-settings.docbook b/doc/details-settings.docbook
index ab67b0f8d..88aab4ef2 100644
--- a/doc/details-settings.docbook
+++ b/doc/details-settings.docbook
@@ -6,35 +6,33 @@
<author>&Michael.Carpino; &Michael.Carpino.mail;</author>
<author> &Jack.H.Ostroff; &Jack.H.Ostroff.mail; </author>
</authorgroup>
- <date>2023-08-30</date>
+ <date>2023-11-25</date>
<releaseinfo>5.2.0</releaseinfo>
</chapterinfo>
<title>&kmymoney; Settings</title>
<para>
- The settings described below modify the behavior of &kmymoney;, allowing you
- to customize it to meet the needs of your unique financial affairs, and to
- modify its look and feel to match your personality. These settings can be
- changed through <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure
- &kmymoney;...</guimenuitem></menuchoice> menu item or by using the keyboard
- shortcut <keycombo action="simul">&Ctrl; &Shift;<keycap>,</keycap></keycombo>.
- In order for any changes to take effect the <guibutton>Apply</guibutton>
- button must be clicked.
+ The settings described below modify the behavior of &kmymoney;, allowing you to
+ customize it to meet the needs of your unique financial affairs, and to modify its
+ look and feel to match your personality. These settings can be changed through
+ the <menuchoice> <guimenu>Settings</guimenu> <guimenuitem>Configure
+ &kmymoney;...</guimenuitem> </menuchoice> menu item or by using the keyboard
+ shortcut <keycombo action="simul">&Ctrl; &Shift;<keycap>,</keycap></keycombo>. In
+ order for any changes to take effect the <guibutton>Apply</guibutton> button must
+ be clicked.
</para>
<para>
- On the left of the settings dialog is a list of icons and labels, each
- representing a particular area of the program. When you click on one of
- those icons, the right part of the dialog will display controls for
- configuring that area of the program, often divided into several tabs.
+ On the left of the <guilabel>Configure</guilabel> or settings dialog is a list of
+ icons and labels, each representing a particular area of the program. When you
+ click on one of those icons, the right part of the dialog will display controls
+ for configuring that area of the program, often divided into several tabs.
</para>
-<sect1 id="details.settings.general">
-<title>General</title>
+<sect1 id="details.settings.general"><title>General</title>
-<sect2 id="details.settings.general.global">
-<title>Global tab</title>
+<sect2 id="details.settings.general.global"><title>Global tab</title>
<variablelist>
<varlistentry>
diff --git a/doc/details-tags.docbook b/doc/details-tags.docbook
index 92d39a666..f6d07b87f 100644
--- a/doc/details-tags.docbook
+++ b/doc/details-tags.docbook
@@ -13,7 +13,7 @@
<para>
Tags provide an additional way for you to group and categorize transactions. They
- are often useful in <link linkend="details.search.general">searching for
+ are often useful in <link linkend="details.search">searching for
transactions</link> and for <link linkend="details.reports.avail">creating
reports</link>.
</para>
diff --git a/doc/find-tag.png b/doc/find-tag.png
new file mode 100644
index 000000000..6465d726d
Binary files /dev/null and b/doc/find-tag.png differ
More information about the kde-doc-english
mailing list