Git commit 890c335393bd9a347d44c91dceccbdb7a8aff036 by Jack Ostroff. Committed on 06/02/2024 at 01:31. Pushed by ostroffjh into branch 'Handbook-5.2'.
More work on Setting chapter and other cleanup M +2 -0 README-CONTRIBUTORS D +- -- doc/accessories-calculator.png M +31 -42 doc/details-budgets.docbook M +50 -15 doc/details-impexp-csv.docbook M +20 -17 doc/details-impexp-woob.docbook M +1 -2 doc/details-ledgers.docbook M +7 -6 doc/details-loans.docbook M +105 -96 doc/details-settings.docbook A +63 -0 doc/icon-accessories-calculator.svg A +13 -0 doc/icon-dialog-cancel.svg R +0 -0 doc/icon-dialog-close.svg [from: doc/dialog-close.svg - 100% similarity] A +13 -0 doc/icon-dialog-ok.svg A +13 -0 doc/icon-edit-undo.svg A +13 -0 doc/icon-gtk-floppy.svg A +13 -0 doc/icon-mail-receive.svg A +13 -0 doc/icon-zoom-in.svg A +13 -0 doc/icon-zoom-out.svg M +- -- doc/transaction_find.png https://invent.kde.org/office/kmymoney/-/commit/890c335393bd9a347d44c91dceccbdb7a8aff036 diff --git a/README-CONTRIBUTORS b/README-CONTRIBUTORS index b8533d7140..c290a42217 100644 --- a/README-CONTRIBUTORS +++ b/README-CONTRIBUTORS @@ -320,6 +320,8 @@ multiple places. - Should there be a note about the relation between aqbanking, kbanking, and hbci? +- Budget View has buttons labelled Upd and Res. Should these be expanded to Update and Reset? + This is a list of potential enhancements I came up with while reviewing the handbook, but have not yet posted either as wishlist bugs, entries to any Issue on invent, or elsewhere. diff --git a/doc/accessories-calculator.png b/doc/accessories-calculator.png deleted file mode 100644 index 1b1dd1e44d..0000000000 Binary files a/doc/accessories-calculator.png and /dev/null differ diff --git a/doc/details-budgets.docbook b/doc/details-budgets.docbook index 73266cce85..a7b7777113 100644 --- a/doc/details-budgets.docbook +++ b/doc/details-budgets.docbook @@ -61,14 +61,12 @@ </para> <para> - There are two major sections to the Budgets View. These are described in more - detail below. On the left, the main section displays the list of budgets you have - created. Above that are buttons for creating, renaming, and deleting budgets. On - the right, there are three sections. At the top is the Accounts List. <!-- FIXME: - should this really be Categoreis List? --> At the bottom is a display of the - amounts assigned to the budget for the category selected in the Accounts List - above. Between those two areas are some additional controls for managing the - budget. + Thee are two major sections in the Budgets View. On the left, there is a list of + budgets you have created. Above that are buttons for creating, renaming, and + deleting budgets. On the right, there are three sections. At the top is the + Categories List. At the bottom is a display of the amounts assigned to the budget + selected on the left for the category selected in the Categories List above. + Between those two areas are some additional controls for managing the budget. </para> <sect2><title>Viewing, creating, renaming, and deleting budgets</title> @@ -125,11 +123,9 @@ <varlistentry> <term>Rename</term> <listitem> - <para>Edit the name of the selected Budget.</para> - <para> - You can also edit the name of a Budget by double-clicking on the name of a - Budget in the list. + Edit the name of the selected Budget. You can also edit the name of a Budget + by double-clicking on the name of a Budget in the list. </para> </listitem> </varlistentry> @@ -192,13 +188,13 @@ </variablelist> </sect2> -<sect2><title>Account List</title> +<sect2><title>Categories List</title> <para> - The Accounts List displays the list of Income and Expense Categories. (Remember, + The Categories List displays the list of Income and Expense Accounts. (Remember, within &kmymoney;, categories are treated as a special type of account.) As in other places in &kmymoney;, the list is organized in a tree structure. The list can be expanded or collapsed to show or hide Subcategories within a Category. The - Accounts List has a number of columns: + Categories List has a number of columns: </para> <para> @@ -250,22 +246,28 @@ </varlistentry> </variablelist> -<!-- FIXME: It would be nice to include the actual button icons here to confirm - which buttons are referred to. --> <para> - Below the Accounts List are several controls. The <guibutton>Update</guibutton> and - <guibutton>Revert</guibutton> buttons are described further below. The - <guibutton>collapse</guibutton> and <guibutton>expand</guibutton> buttons collapse - or expand the entire Accounts List. + Below the Categories List are several controls. The <guiicon> <inlinemediaobject> + <imageobject> <imagedata fileref="icon-gtk-floppy.svg" format="SVG"/> + </imageobject> </inlinemediaobject> </guiicon> <guibutton>Upd</guibutton> (Update) + and <guiicon> <inlinemediaobject> <imageobject> <imagedata + fileref="icon-edit-undo.svg" format="SVG"/> </imageobject> </inlinemediaobject> + </guiicon> <guibutton>Res</guibutton> (Reset) buttons are described further below. + The <guiicon> <inlinemediaobject> <imageobject> <imagedata + fileref="icon-zoom-out.svg" format="SVG"/> </imageobject> + </inlinemediaobject></guiicon> collapse and <guiicon> <inlinemediaobject> + <imageobject> <imagedata fileref="icon-zoom-in.svg" format="SVG"/> </imageobject> + </inlinemediaobject></guiicon> expand buttons collapse or expand the entire + Categories List. </para> <para> - The Accounts List can be filtered in two ways. Checking the <guilabel>Hide unused - budget categories</guilabel> checkbox hides any Categories for which no value has - been assigned to the Category or any of its Subcategories in the selected budget. - To the right of this, is an unlabelled text box. Only categories which include - whatever is typed in this box are listed, but their parent categories are also - listed. + The Categories List can be filtered in two ways. Checking the <guilabel>Hide + unused budget categories</guilabel> checkbox hides any Categories for which no + value has been assigned to the Category or any of its Subcategories in the selected + budget. To the right of this, is an unlabelled text box. Only categories which + include whatever is typed in this box are listed, but their parent categories are + also listed. </para> <para> @@ -278,7 +280,7 @@ <sect2><title>Assignments</title> <para> - The Assignments area shows the values for the Category selected in the Accounts + The Assignments area shows the values for the Category selected in the Categories List. </para> @@ -315,7 +317,7 @@ </para> <para> - If the Category selected in the Accounts List has its Subcategories + If the Category selected in the Categories List has its Subcategories collapsed, although its Total Value will show the sum of the Total Values for all its Subcategories, the amounts in the Assignments area may still show 0, unless this box has been checked or an amount has explicitly been assigned to @@ -388,14 +390,6 @@ </sect2> <sect2><title>Update and Revert</title> -<!-- FIXME: confirm there reslly is a Save button. I don't see one, but it might not - appear until you actually have a budget and hit Update. --> -<para> - For performance reasons, changes made to a Budget are not saved immediately. - Instead, they must first be stored using the <guibutton>Update</guibutton> button - and then permanently saved using the <guibutton>Save</guibutton> button. -</para> - <para> When a Budget's values are first modified, the <guibutton>Update</guibutton> and <guibutton>Revert</guibutton> buttons are enabled. Multiple changes can be made to @@ -415,11 +409,6 @@ Revert undoes any changes made to a Budget since the last Update and disables the <guibutton>Update</guibutton> and <guibutton>Revert</guibutton> buttons. </para> - -<para> - Changes stored using <guibutton>Update</guibutton> but not yet saved using - <guibutton>Save</guibutton> can only be reverted by reloading the &kmymoney; file. -</para> </sect2> </sect1> diff --git a/doc/details-impexp-csv.docbook b/doc/details-impexp-csv.docbook index aba2a661ea..f71655741b 100644 --- a/doc/details-impexp-csv.docbook +++ b/doc/details-impexp-csv.docbook @@ -260,19 +260,6 @@ not, you will be prompted for that information. </para> -<!-- FIXME: where does this actually belong? --> -<formalpara><title>Date format</title> -<para> - This needs to be set according to the order of year, month, and day in the dates in - the file. If the plugin finds data incompatible with this setting, it will - complain when you try to import. However, if the setting is wrong, but it produce - invalid results not detected (such as data with no days higher than 12, so month - and day could be switched) you will simply get incorrect data, because the plugin - cannot know you made a mistake. In this case, the error will be obvious in the - ledger after import. -</para> -</formalpara> - <para> When you are ready, click on <guilabel>Next</guilabel> to advance the wizard to the next step. @@ -380,6 +367,54 @@ </para> </sect4> +<sect4><title>CSV Import Wizard: Format</title> +<para> + The next page of the wizart still shows the data to be imported on the top, but the + lower section provides three dropdowns. The initial values are set by &kmymoney; + based on examining the actual data. +</para> + +<screenshot> + <screeninfo>csv import wizard: investment</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="csvImporter_4.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>csv import wizard: investment</phrase> + </textobject> + </mediaobject> +</screenshot> + +<para> + The <guilabel>Decimal Symbol</guilabel> defaults to <quote>auto,</quote> which + usually produces the correct results. If not, you can explicitly specify the + <quote>dot</quote> or <quote>comma.</quote> +</para> + +<para> + The <guilabel>Thousands Symbol</guilabel> is set automatically, and the field may + be disabled if it will not affect the results. +</para> + +<para> + This needs to be set according to the order of year, month, and day in the dates in + the file. If the plugin finds data incompatible with this setting, it will + complain when you try to import. However, if the setting is wrong, but it produce + invalid results not detected (such as data with no days higher than 12, so month + and day could be switched) you will simply get incorrect data, because the plugin + cannot know you made a mistake. In this case, the error will be obvious in the + ledger after import. +</para> + +<para> + The <guilabel>Date format</guilabel> specifies the order of day, month, and year, + and is also set automatically. However, in some cases, such as data with no day + higher than 12, you will notice the problem after the import. In such cases, you + will need to repeat the import, and choose the actual order of the date components. +</para> +</sect4> + <sect4><title>CSV Import Wizard: Investment</title> <para> This page is similar to the <guilabel>Banking</guilabel> page, although it @@ -436,11 +471,11 @@ box. Note that on this page, this is the only field to explicitly include "column" in the label, to emphasize that it is for the fee column, not for any actual fee. + <!-- FIXME: what are the Fee rate and Minimal Fee fields for? What do the Clear + Fee and Calculate Fee buttons do, and when is the latter enabled? --> </para> </listitem> -<!-- FIXME: what does the Calucaltae Fee button do, and when is it activated? --> - <listitem> <para> Below the column selectors are two areas for the security identity. Depending diff --git a/doc/details-impexp-woob.docbook b/doc/details-impexp-woob.docbook index 2eda04b042..b16b7f6da3 100644 --- a/doc/details-impexp-woob.docbook +++ b/doc/details-impexp-woob.docbook @@ -17,31 +17,34 @@ otherwise do not offer support for any other financial protocol that &kmymoney; handles. </para> - +</sect2> + +<sect2><title>Installing Woob</title> <note> <para> - &kmymoney; currently requires that you install Woob independently. Refer to the - further sections for details. + &kmymoney; currently requires that you install Woob independently. See below for + details. </para> </note> -</sect2> - -<sect2><title>Installing Woob</title> + <para> - You need to install Python 3 first before continuing. All major &Linux; - distribuitons package Python, and you should use that version, if possible. - Otherwise, you can download a package for your system from the <ulink - url="https://www.python.org/downloads/";>official Python website</ulink>. + Some &Linux; distributions package Woob, and that is the preferred method of + installation, if it is available. If not, you need to install a recent version of + Python 3 first before continuing. All major &Linux; distribuitons package Python, + and you should use that version, if possible. Otherwise, you can download a + package for your system from the <ulink + url="https://www.python.org/downloads/";>official Python website</ulink>. The exact + minimum version of Python required by Woob can be found on the <ulink + url="https://woob.tech/install/";>Woob website</ulink>. </para> <para> - With Python 3 installed, you should now be able to easily download and install - required Woob modules. Please refer to the instructions on the <ulink - url="https://woob.tech/install/";>Woob website</ulink>. When it runs, &kmymoney; - checks for the presence of Woob, and loads the plugin if it is found. See the - section on <link linkend="details.settings.plugins">Plugins</link> in the chapter - on <link linkend="details.settings">Settings</link> for more information on - confirming that the woob plugin is loaded. + With Python 3 installed, you should now be able to easily download and install the + required Woob modules. Please refer to the instructions on the Woob website. When + &kmymoney; runs, it checks for the presence of Woob, and loads the plugin if Woob + is found. See the <link linkend="details.settings.plugins">Plugins</link> section + in the <link linkend="details.settings">Settings</link> chapter for more + information on confirming that the woob plugin is loaded. </para> </sect2> diff --git a/doc/details-ledgers.docbook b/doc/details-ledgers.docbook index fd40611323..645876a9f1 100644 --- a/doc/details-ledgers.docbook +++ b/doc/details-ledgers.docbook @@ -692,7 +692,7 @@ <screeninfo>Match transaction dialog</screeninfo> <mediaobject> <imageobject> - <imagedata fileref="match_transaction.png" format="PNG" /><!-- FIXME: need pic --> + <imagedata fileref="match_transaction.png" format="PNG" /> </imageobject> <textobject> <phrase>Match transaction dialog</phrase> @@ -701,7 +701,6 @@ </screenshot> <para> - <!-- FIXME: get above screenshot --> Since the value is the only field in the two transaction which must absolutely be the same, the value of other fields may differ. When you select <guilabel>Match</guilabel>, you will see a <guilabel>Match Transactions</guilabel> diff --git a/doc/details-loans.docbook b/doc/details-loans.docbook index 651a443454..e6efd68f54 100644 --- a/doc/details-loans.docbook +++ b/doc/details-loans.docbook @@ -13,6 +13,7 @@ <sect1 id="details.loans.general"><title>Understanding Loans</title> <note> <para> + <!-- FIXME need decision on expanding about principal --> I am looking for user feedback on whether to expand this section to discuss the variation of principal and interest payments to attain a fixed recurring payment. It is mentioned in the section on actually creating a loan in &kmymoney; but it @@ -164,13 +165,13 @@ </sect1> <sect1 id="details.loans.creation"><title>Creating a New Loan</title> -<!-- FIXME: this section should really be expanded with screenshots of the new loan - wizard and more detailed explanation of the various entry fields. In - particular, it needs an explanation of how fixed payments are calculated by - adjusting the amount of principal and interest of each payment, sometimes - resulting in a final payment different from the others. --> +<!-- FIXME: this section needs expanding and screenshots of the new loan wizard and + more detailed explanation of the various entry fields. In particular, it needs + an explanation of how fixed payments are calculated by adjusting the amount of + principal and interest of each payment, sometimes resulting in a final payment + different from the others. --> <para> - In &kmymoney;, a loan is a type of account. Therefore, to create a new loan, you + In &kmymoney;, a loan is a type of account. Therefore, to create a new loan, you begin by selecting the <menuchoice><guimenu>Account</guimenu><guimenuitem>New Account</guimenuitem></menuchoice> menu item. Continue by answering the questions that the wizard poses to you. diff --git a/doc/details-settings.docbook b/doc/details-settings.docbook index bd74eb2cbd..a21f27fdc2 100644 --- a/doc/details-settings.docbook +++ b/doc/details-settings.docbook @@ -101,28 +101,30 @@ This setting does not directly affect the operation of &kmymoney;, but provides a convenient way to launch any external utility, such as an advanced calculator. The first step is to enter the full path to your chosen program - in the <guilabel>Calculator</guilabel> text box. There are then two ways to - launch the program. + in the <guilabel>Calculator</guilabel> text box. </para> <para> - First, you can use <menuchoice> <guimenu>Settings</guimenu> - <guimenuitem>Configure Toolbars...</guimenuitem> </menuchoice> menu item to - place the <guilabel>Calculator</guilabel> icon on the Toolbar. Then, when + There is currently no direct menu item to launch the calculator, or whatever + external program you have set. There are then two ways to launch the program. + </para> + + <para> + First, you can use <guimenu>Settings</guimenu> <guimenuitem>Configure + Toolbars...</guimenuitem> menu item to place the <guiicon> + <inlinemediaobject> <imageobject> <imagedata + fileref="icon-accessories-calculator.svg" format="SVG"/> </imageobject> + </inlinemediaobject> </guiicon> Calculator icon on the Toolbar. Then, when you click that icon on the Toolbar, &kmymoney; will launch the selected application. </para> - <!-- FIXME: need to find and use the toolbar icon for the calculator. --> <para> - Second, you can use <menuchoice> <guimenu>Settings</guimenu> - <guimenuitem>Configure Shortcuts...</guimenuitem> </menuchoice> menu item to - set a custom keyboard shortcut. (The entry is under &kmymoney;/Calculator in - that list.) You can then use that shortcut to launch the application. + Second, you can use <guimenu>Settings</guimenu> <guimenuitem>Configure + Shortcuts...</guimenuitem> menu item to set a custom keyboard shortcut. (The + entry is under &kmymoney;/Calculator in that list.) You can then use that + shortcut to launch the application. </para> - <!-- FIXME it is not currently possible to launch the calculator from some menu - item. I have filed a wishlist, and when implemented, it should be - described here, probably as the first choice. --> </listitem> </varlistentry> </variablelist> @@ -158,14 +160,13 @@ <term><guilabel>Type of the &kmymoney; view</guilabel></term> <listitem> <para> - You can select one of three general layouts for &kmymoney; to use. If you - select <guilabel>List</guilabel> or <guilabel>Tree</guilabel> view, the icons - and their labels will be located at the left side of the window. The List - view displays larger icons while the Tree view has smaller icons. The - <guilabel>Tabbed</guilabel> view locates the icons and labels across the top - of the window. - <!-- FIXME: needs better wording to show that this controls the layout of the - Vew Selector area where you select which View to display. --> + This lets you select one of three layouts for the View Selector, where you + choose Selecting <guilabel>List</guilabel> or <guilabel>Tree</guilabel> view, + the icons and their labels will be located at the left side of the window. + The List view displays larger icons above the name of each view, while the + Tree view has smaller icons to the left of the names. The + <guilabel>Tabbed</guilabel> view locates the icons and labels in tabs across + the top of the window. </para> </listitem> </varlistentry> @@ -329,8 +330,9 @@ </sect1> <sect1 id="details.settings.home"><title>Home</title> -<!-- FIXME: sect2 should only be used for tabs. I'm too lazy to convert this to a - variablelist now, which would require subsuming the lower one to paras. --> +<!-- FIXME: For consistency, <sect2> should only be used for tabs. I'm too lazy to + convert this to a variablelist now, which would require subsuming the lower + levels to paras. --> <sect2><title>Home page display sections</title> <screenshot> @@ -350,38 +352,38 @@ linkend="firsttime.mainwindow">Home View</link> (also called the Home Page or Main Window) by choosing which information to display there and the order in which it appears. Selected sections can be reordered by clicking the respective - <guibutton>Up</guibutton> or <guibutton>Down</guibutton> button. Some sections may + <guibutton>Up</guibutton> or <guibutton>Down</guibutton> button. A section may not appear, even if the appropriate entry is checked, if it would be empty. </para> -<!-- FIXME: Many of these sections need a <link> to the doc section actually - describing the content. --> <variablelist> <varlistentry> <term><guilabel>Assets and Liabilities</guilabel></term> <listitem> <para> - This will display two lists of accounts which are open, assets on the left - and liabilities on the right. This and the other account lists on the Home - Page are sorted in alphabetical order, unless otherwise noted. + This will display a listo of asset accountss on the left and liability + accounts on the right. These and the other account lists on the Home Page + are sorted in alphabetical order, unless otherwise noted. Normally, only + open accounts will be listed, unless <link + linkend="reference.menus.view">Show all accounts</link> has been selected. </para> <para> - For this and the other account lists which can be shown on the Home View, the - display will include the account name, date last reconcilied, and current - balance. In addition, there may be other columns specific to that type of - report, and in some cases, as configured <link - linkend="details.settings.home.acctinfo">elsewhere</link>. + For this and the other account lists on the Home View, the display will + include the account name, date last reconcilied, and current balance. In + addition, there may be other columns displayed, as configured in the + <guilabel>Account information display</guilabel> Lower on this window. </para> </listitem> </varlistentry> <varlistentry> - <term><guilabel>scheduled payments</guilabel></term> + <term><guilabel>Scheduled payments</guilabel></term> <listitem> <para> - This will display upcoming occurrences of Scheduled transactions, - distinguishing Overdue payments from Future payments. It shows the date, + This will display upcoming occurrences of <link + linkend="details.schedules">Scheduled transactions</link>, distinguishing + those which are overdue, due today, or due in the future. It shows the date, schedule name, account, and amount of the payment, and the account balance after the payment. By default, it will show up to six transaction. If six are displayed, there is a link you can select to show more, up to 30 days in @@ -394,9 +396,9 @@ <term><guilabel>Preferred accounts</guilabel></term> <listitem> <para> - This will display the accounts that are identified as Preferred accounts - in the <menuchoice> <guimenu>Account</guimenu> <guimenuitem>Edit account... - </guimenuitem> </menuchoice> Configuration dialog. + This will display the accounts that are identified as Preferred accounts in + the <guimenu>Account</guimenu> <guimenuitem>Edit account...</guimenuitem> + Configuration dialog. </para> </listitem> </varlistentry> @@ -417,7 +419,7 @@ <para> This will display a list of all reports that have been identified as a favorite in the <link linkend="details.reports.config">Configuration - dialog</link> of the Report. The list ordered chronologically by when each + dialog</link> of the Report. The list is in the order of the date when each report became a favorite. </para> </listitem> @@ -429,29 +431,30 @@ <para> This will display a forecast for asset and liability accounts, similar to the <link linkend="details.forecast.summary">Summary Tab</link> of the Forecast - View. - Details of the display can be controlled with the <link + View. Details of the display can be controlled with the <link linkend="details.forecast.configure">Forecast Configuration</link> dialog. </para> - <!-- FIXME What are the real criteria for inclusion in this (and these other) list(s). - JHO: is this question still open? --> </listitem> </varlistentry> <varlistentry> <term><guilabel>Net worth forecast</guilabel></term> <listitem> - <para>This will display chart of your forecast net worth for the next 90 - days.</para> + <para> + This will display a chart of your forecast net worth for the next 90 days. + </para> </listitem> </varlistentry> <varlistentry> <term><guilabel>Budget</guilabel></term> <listitem> - <para>This will display a current month summary and overruns for any defined - budget(s). If no budget is defined, it will display no budget or overruns, with - the actual current month spending.</para> + <para> + This will display a current month summary and overruns for any <link + linkend="details.budgets">defined budget(s)</link>. If no budget is defined, + it will display no budget or overruns, with the actual current month + spending. + </para> </listitem> </varlistentry> @@ -469,8 +472,10 @@ <varlistentry> <term><guilabel>Zoom factor:</guilabel></term> <listitem> - <para>This option allows for the selection of the font size as a percentage to - fit the Home View based on the user preference.</para> + <para> + This option allows for the selection of the font size as a percentage to fit + the Home View based on the user preference. + </para> </listitem> </varlistentry> @@ -478,8 +483,10 @@ <term><guilabel>Remember zoom factor when leaving the program if manually changed with mouse-wheel</guilabel></term> <listitem> - <para>Selecting this will save your font size preference if you have changed it - on the Home page by using the mouse-wheel.</para> + <para> + Selecting this will save your font size preference if you have changed it on + the Home page by using the mouse-wheel. + </para> </listitem> </varlistentry> </variablelist> @@ -488,45 +495,59 @@ <sect2 id="details.settings.home.acctinfo"><title>Account information display</title> <para> These options allow you to customize what information is included in any list of - accounts. + accounts on the Home View. </para> <variablelist> <varlistentry> <term><guilabel>Show account limit information</guilabel></term> <listitem> - <para>Displays the account limit as set in the Account Edit dialog. It affects - any list which includes Payment accounts.</para> + <para> + Displays the account limit as set in the <link + linkend="details.accounts.edit">Account Edit</link> dialog. + </para> </listitem> </varlistentry> <varlistentry> <term><guilabel>Show balance-status of mapped online accounts</guilabel></term> <listitem> - <para>Shows the balance-status of mapped accounts, symbolized by an icon in the - columns preceding the account name. A green checkmark indicates the online - balance and local balance are the same. A mailbox with a green arrow indicates - that the local file has transactions newer than the most recent online update. - This alerts the user to start an online-update. A red warning sign indicates a - mismatch between the local file and online-balance.</para> - <!-- Note: the colors might be different depending on the selected theme - --> + <para> + Shows the balance status of mapped accounts, and accounts which have had + transactions imported. The status is symbolized by an icon in the column + preceding the account name. Note that the colors described here may be + different than displayed for you, depending on the display theme selected. A + <guiicon> <inlinemediaobject> <imageobject> <imagedata + fileref="icon-dialog-ok.svg" format="SVG"/> </imageobject> + </inlinemediaobject> </guiicon> green checkmark indicates the online balance + and local balance are the same. A <guiicon> <inlinemediaobject> + <imageobject> <imagedata fileref="icon-dialog-cancel.svg" format="SVG"/> + </imageobject> </inlinemediaobject> </guiicon> red warning sign indicates a + mismatch between the local file and online-balance. A <guiicon> + <inlinemediaobject> <imageobject> <imagedata fileref="icon-mail-receive.svg" + format="SVG"/> </imageobject> </inlinemediaobject> </guiicon> mailbox with a + green arrow indicates that the local file has transactions newer than the + most recent online update. This alerts the user to perform an online-update. + </para> </listitem> </varlistentry> <varlistentry> <term><guilabel>Show number of not marked transactions per account [!M]</guilabel></term> <listitem> - <para>Inserts an additional column next to the account name, showing the number - of not marked transactions in the account.</para> + <para> + Inserts a column after the account name, showing the number of not marked + transactions in the account. + </para> </listitem> </varlistentry> <varlistentry> <term><guilabel>Show number of cleared transactions per account [C]</guilabel></term> <listitem> - <para>Inserts an additional column showing the number of cleared transactions - for the account.</para> + <para> + Inserts a column showing the number of cleared transactions for the account. + </para> </listitem> </varlistentry> @@ -534,17 +555,20 @@ <term><guilabel>Show number of not reconciled (not marked + cleared) transactions per account [!R]</guilabel></term> <listitem> - <para>Inserts an additional column showing the number of not reconciled - transactions for the account, &ie;, the sum of all not marked and cleared - transactions.</para> + <para> + Inserts a column showing the number of not reconciled transactions for the + account, &ie;, the sum of all not marked and cleared transactions. + </para> </listitem> </varlistentry> <varlistentry> <term><guilabel>Show date of last reconciliation</guilabel></term> <listitem> - <para>Inserts an additional column showing the last reconciliation date for the - account.</para> + <para> + Inserts an additional column showing the last reconciliation date for the + account. + </para> </listitem> </varlistentry> </variablelist> @@ -622,9 +646,6 @@ <formalpara><title>Show all split details in ledger</title> <para> Selecting this option shows more details about split transactions. - <!-- FIXMNE: might this be related to now showing all categories in a split - transaction instead of just "split transaction" (or whatever it used to - show?)--> </para> </formalpara> </listitem> @@ -667,19 +688,6 @@ </formalpara> </listitem> </varlistentry> - - <!-- Is this still somewhere else??? - <varlistentry> - <term><guilabel>Always show a No. field</guilabel></term> - <listitem> - <para> - Always display the number (<quote>No.</quote>) field when entering or - editing a transaction. With this enabled you'll be able to check numbers - entered in this field for checking accounts. - </para> - </listitem> - </varlistentry> - --> </variablelist> </sect2> @@ -939,12 +947,13 @@ </variablelist> </sect2> -<sect2><title></title> +<sect2><title> </title> <!-- FIXME: This is a good example of problems with the current mix of sect and - variablelist, as this sect with no title gives no spacing between the previous - and this list entry, so it looks like they belong together. I consider using - literallayout a bad solution. I'm open to suggestions on how to deal with this. - Not using sect2 for boxes might help. --> + variablelist, as this sect with no title gives inadequate spacing between the + previous and this list entry, even with , so it looks like they belong + together. I consider using literallayout a bad solution. I'm open to + suggestions on how to deal with this. Not using sect2 for boxes might help, + but would be a lot of effort. --> <literallayout> </literallayout> <variablelist> @@ -1216,7 +1225,7 @@ </sect2> <sect2><title>iCalendar</title> -<!-- FIXME: isn't this mentioned anywhere else? --> +<!-- FIXME: This isn't mentioned anywhere else. SHould it be? --> <para> &kmymoney; is capable of exporting a file inb then <quote>iCalendar</quote> format, so you can import your scheduled transactions into &korganizer;, or another diff --git a/doc/icon-accessories-calculator.svg b/doc/icon-accessories-calculator.svg new file mode 100644 index 0000000000..13213fc609 --- /dev/null +++ b/doc/icon-accessories-calculator.svg @@ -0,0 +1,63 @@ +<svg width="48" xmlns="http://www.w3.org/2000/svg"; height="48" xmlns:xlink="http://www.w3.org/1999/xlink";> + <defs> + <linearGradient id="a" y1="543.8" y2="503.8" x2="0" gradientUnits="userSpaceOnUse" gradientTransform="matrix(1.125 0 0 1-51.07 0)"> + <stop stop-color="#2a2c2f"/> + <stop offset="1" stop-color="#424649"/> + </linearGradient> + <linearGradient id="b" y1="540.92" y2="522.55" x2="0" gradientUnits="userSpaceOnUse" gradientTransform="matrix(1 0 0 1.14286 0-77.4)"> + <stop stop-color="#197cf1"/> + <stop offset="1" stop-color="#05a0eb"/> + </linearGradient> + <linearGradient id="c" y1="542.8" y2="533.8" gradientUnits="userSpaceOnUse" x2="0" gradientTransform="translate(0-28)"> + <stop stop-color="#bcb4a1"/> + <stop offset="1" stop-color="#c5bfad"/> + </linearGradient> + <linearGradient id="d" y1="540.8" y2="531.8" gradientUnits="userSpaceOnUse" x2="0"> + <stop stop-color="#1e1f21"/> + <stop offset="1" stop-color="#242628"/> + </linearGradient> + <linearGradient xlink:href="#d" id="e" y1="528.8" y2="519.8" gradientUnits="userSpaceOnUse" x2="0"/> + <linearGradient id="f" y1="20" x1="32" y2="30" x2="42" gradientUnits="userSpaceOnUse"> + <stop stop-color="#383e51"/> + <stop offset="1" stop-color="#655c6f" stop-opacity="0"/> + </linearGradient> + <linearGradient xlink:href="#f" id="g" y1="531.8" x1="404.57" y2="543.8" x2="416.57" gradientUnits="userSpaceOnUse" gradientTransform="translate(-384.57-499.8)"/> + <linearGradient xlink:href="#f" id="h" y1="531.8" x1="404.57" y2="543.8" gradientUnits="userSpaceOnUse" x2="416.57" gradientTransform="translate(0-12)"/> + <linearGradient xlink:href="#f" id="i" y1="531.8" x1="404.57" y2="543.8" gradientUnits="userSpaceOnUse" x2="416.57" gradientTransform="translate(-12-12)"/> + <linearGradient xlink:href="#f" id="j" y1="531.8" x1="404.57" y2="543.8" gradientUnits="userSpaceOnUse" x2="416.57" gradientTransform="translate(-12)"/> + </defs> + <g transform="translate(-384.57-499.8)"> + <rect width="36" x="390.57" y="503.8" fill="url(#a)" rx="0" height="40"/> + <g fill-rule="evenodd"> + <path opacity=".2" fill="url(#h)" d="m413.57 519.8l-9 9 3 3h18z"/> + <path opacity=".2" fill="url(#i)" d="m401.57 519.8l-9 9 3 3h18z"/> + <path opacity=".2" fill="url(#j)" d="m401.57 531.8l-9 9 3 3h18z"/> + <path opacity=".2" fill="url(#g)" d="m29 32l-9 9 3 3h18z" transform="translate(384.57 499.8)"/> + </g> + <rect width="36" x="390.57" y="542.8" fill="#1c1e20" height="1"/> + <path opacity=".2" fill="url(#f)" fill-rule="evenodd" d="m40 20l-8 21 3 3h7v-22z" transform="translate(384.57 499.8)"/> + <rect width="8" x="416.57" y="519.8" fill="url(#b)" rx="0" height="21"/> + <rect width="32" x="392.57" y="505.8" fill="url(#c)" height="9"/> + <path fill="#ffffff" d="m418.57 534.8v1h4v-1zm0 2v1h4v-1z"/> + <g fill="#383432"> + <rect width="3" x="418.57" y="506.8" height="1"/> + <rect width="1" x="421.57" y="507.8" height="5"/> + <rect width="3" x="418.57" y="512.8" height="1"/> + <rect width="1" x="417.57" y="507.8" height="5"/> + </g> + <rect width="9" x="392.57" y="531.8" fill="url(#d)" rx="0" height="9"/> + <g fill="url(#e)"> + <rect width="9" x="392.57" y="519.8" rx="0" height="9"/> + <rect width="9" x="404.57" y="519.8" rx="0" height="9"/> + </g> + <rect width="9" x="404.57" y="531.8" fill="url(#d)" rx="0" height="9"/> + <g fill="#ffffff"> + <path d="m12 22v2h-2v1h2v2h1v-2h2v-1h-2v-2z" transform="translate(384.57 499.8)"/> + <rect width="1" x="523.8" y="-411.57" rx="0" height="5" transform="rotate(90)"/> + <g transform="translate(384.57 499.8)"> + <path d="M12.5 34A.5 .5 0 0 0 12 34.5 .5 .5 0 0 0 12.5 35 .5 .5 0 0 0 13 34.5 .5 .5 0 0 0 12.5 34M10 36V37H15V36zM12.5 38A.5 .5 0 0 0 12 38.5 .5 .5 0 0 0 12.5 39 .5 .5 0 0 0 13 38.5 .5 .5 0 0 0 12.5 38"/> + <path d="m22.707 34l-.707.707 1.793 1.793-1.793 1.793.707.707 1.793-1.793 1.793 1.793.707-.707-1.793-1.793 1.793-1.793-.707-.707-1.793 1.793z"/> + </g> + </g> + </g> +</svg> diff --git a/doc/icon-dialog-cancel.svg b/doc/icon-dialog-cancel.svg new file mode 100644 index 0000000000..f06ae1f013 --- /dev/null +++ b/doc/icon-dialog-cancel.svg @@ -0,0 +1,13 @@ +<svg xmlns="http://www.w3.org/2000/svg"; viewBox="0 0 16 16"> + <defs id="defs3051"> + <style type="text/css" id="current-color-scheme"> + .ColorScheme-Text { + color:#232629; + } + </style> + </defs> + <path style="fill:currentColor;fill-opacity:1;stroke:none" + d="M 8 2 C 4.6862928 2 2 4.6862997 2 8 C 2 11.3137 4.6862928 14 8 14 C 11.313707 14 14 11.3137 14 8 C 14 4.6862997 11.313707 2 8 2 z M 8 3 C 10.761424 3 13 5.2385763 13 8 C 13 9.199635 12.548037 10.263384 11.84375 11.125 L 4.875 4.15625 C 5.7366165 3.4519627 6.8003651 3 8 3 z M 4.15625 4.875 L 11.125 11.84375 C 10.263384 12.548037 9.199635 13 8 13 C 5.2385763 13 3 10.761424 3 8 C 3 6.8003651 3.4519627 5.7366165 4.15625 4.875 z " + class="ColorScheme-Text" + /> +</svg> diff --git a/doc/dialog-close.svg b/doc/icon-dialog-close.svg similarity index 100% rename from doc/dialog-close.svg rename to doc/icon-dialog-close.svg diff --git a/doc/icon-dialog-ok.svg b/doc/icon-dialog-ok.svg new file mode 100644 index 0000000000..f7480c0771 --- /dev/null +++ b/doc/icon-dialog-ok.svg @@ -0,0 +1,13 @@ +<svg xmlns="http://www.w3.org/2000/svg"; viewBox="0 0 16 16"> + <defs id="defs3051"> + <style type="text/css" id="current-color-scheme"> + .ColorScheme-Text { + color:#232629; + } + </style> + </defs> + <path style="fill:currentColor;fill-opacity:1;stroke:none" + d="M 13.273438 3.5 L 5.6367188 11.060547 L 2.7265625 8.1796875 L 2 8.9003906 L 4.9082031 11.779297 L 5.6367188 12.5 L 6.7265625 11.419922 L 14 4.2207031 L 13.273438 3.5 z " + class="ColorScheme-Text" + /> +</svg> diff --git a/doc/icon-edit-undo.svg b/doc/icon-edit-undo.svg new file mode 100644 index 0000000000..14546aa288 --- /dev/null +++ b/doc/icon-edit-undo.svg @@ -0,0 +1,13 @@ +<svg xmlns="http://www.w3.org/2000/svg"; viewBox="0 0 16 16"> + <defs id="defs3051"> + <style type="text/css" id="current-color-scheme"> + .ColorScheme-Text { + color:#232629; + } + </style> + </defs> + <path style="fill:currentColor;fill-opacity:1;stroke:none" + d="M 6.5 2 L 3.21875 5.28125 L 3 5.5 L 3.21875 5.71875 L 6.5 9 L 7.21875 8.28125 L 4.90625 6 L 6 6 L 7.1875 6 L 8 6 L 8.5 6 C 10.432998 6 12 7.5669984 12 9.5 C 12 11.433002 10.432998 13 8.5 13 L 8 13 L 7 13 L 7 14 L 8 14 L 8.5 14 C 10.985283 14 13 11.985252 13 9.5 C 13 7.0147479 10.985283 5 8.5 5 L 8 5 L 7.1875 5 L 6 5 L 4.90625 5 L 7.21875 2.71875 L 6.5 2 z " + class="ColorScheme-Text" + /> +</svg> diff --git a/doc/icon-gtk-floppy.svg b/doc/icon-gtk-floppy.svg new file mode 100644 index 0000000000..cd2db5adb0 --- /dev/null +++ b/doc/icon-gtk-floppy.svg @@ -0,0 +1,13 @@ +<svg xmlns="http://www.w3.org/2000/svg"; viewBox="0 0 16 16"> + <defs id="defs3051"> + <style type="text/css" id="current-color-scheme"> + .ColorScheme-Text { + color:#232629; + } + </style> + </defs> + <path style="fill:currentColor;fill-opacity:1;stroke:none" + d="M 2 2 L 2 14 L 3 14 L 4 14 L 10 14 L 11 14 L 12 14 L 14 14 L 14 4.28125 L 11.71875 2 L 11.6875 2 L 11 2 L 4 2 L 3 2 L 2 2 z M 3 3 L 4 3 L 5 3 L 5 6 L 5 7 L 11 7 L 11 6 L 11 3 L 11.28125 3 L 13 4.71875 L 13 5 L 13 13 L 12 13 L 12 9 L 11 9 L 5 9 L 3.96875 9 L 3.96875 13 L 3 13 L 3 3 z M 6 3 L 7.90625 3 L 7.90625 6 L 6 6 L 6 3 z M 5 10 L 6 10 L 10 10 L 11 10 L 11 13 L 10 13 L 6 13 L 5 13 L 5 10 z " + class="ColorScheme-Text" + /> +</svg> diff --git a/doc/icon-mail-receive.svg b/doc/icon-mail-receive.svg new file mode 100644 index 0000000000..03cf2adb35 --- /dev/null +++ b/doc/icon-mail-receive.svg @@ -0,0 +1,13 @@ +<svg xmlns="http://www.w3.org/2000/svg"; viewBox="0 0 16 16"> + <defs id="defs3051"> + <style type="text/css" id="current-color-scheme"> + .ColorScheme-Text { + color:#232629; + } + </style> + </defs> + <path style="fill:currentColor;fill-opacity:1;stroke:none" + d="M 7 2 L 7 7 L 9 7 L 9 2 L 7 2 z M 5 5 L 2.0332031 11 L 2 11 L 2 14 L 14 14 L 14 11 L 13.966797 11 L 11 5 L 10.021484 5 L 10.021484 6 L 10.423828 6 L 12.945312 11 L 11 11 L 10 12 L 9 12 L 7 12 L 6 12 L 5 11 L 3.0546875 11 L 5.5761719 6 L 5.9785156 6 L 5.9785156 5 L 5 5 z M 6.0253906 7 L 5.3105469 7.734375 L 8.0078125 10.5 L 10.697266 7.7441406 L 9.9804688 7.0097656 L 8.0078125 9.0332031 L 6.0253906 7 z " + class="ColorScheme-Text" + /> +</svg> diff --git a/doc/icon-zoom-in.svg b/doc/icon-zoom-in.svg new file mode 100644 index 0000000000..273b68b6a9 --- /dev/null +++ b/doc/icon-zoom-in.svg @@ -0,0 +1,13 @@ +<svg xmlns="http://www.w3.org/2000/svg"; viewBox="0 0 16 16"> + <defs id="defs3051"> + <style type="text/css" id="current-color-scheme"> + .ColorScheme-Text { + color:#232629; + } + </style> + </defs> + <path style="fill:currentColor;fill-opacity:1;stroke:none" + d="M 2 2 L 2 3 L 2 4 L 3 4 L 3 3 L 4 3 L 4 2 L 3 2 L 2 2 z M 7 2 L 7 3 L 9 3 L 9 2 L 7 2 z M 12 2 L 12 3 L 13 3 L 13 4 L 14 4 L 14 3 L 14 2 L 13 2 L 12 2 z M 8 4 L 8 5 L 10.292969 5 L 7 8.2929688 L 7.7070312 9 L 11 5.7070312 L 11 8 L 12 8 L 12 4 L 11 4 L 8 4 z M 2 7 L 2 9 L 3 9 L 3 7 L 2 7 z M 13 7 L 13 9 L 14 9 L 14 7 L 13 7 z M 2 10 L 2 14 L 6 14 L 6 10 L 2 10 z M 3 11 L 5 11 L 5 13 L 3 13 L 3 11 z M 13 12 L 13 13 L 12 13 L 12 14 L 13 14 L 14 14 L 14 12 L 13 12 z M 7 13 L 7 14 L 9 14 L 9 13 L 7 13 z " + class="ColorScheme-Text" + /> +</svg> diff --git a/doc/icon-zoom-out.svg b/doc/icon-zoom-out.svg new file mode 100644 index 0000000000..3a940dedb6 --- /dev/null +++ b/doc/icon-zoom-out.svg @@ -0,0 +1,13 @@ +<svg xmlns="http://www.w3.org/2000/svg"; viewBox="0 0 16 16"> + <defs id="defs3051"> + <style type="text/css" id="current-color-scheme"> + .ColorScheme-Text { + color:#232629; + } + </style> + </defs> + <path style="fill:currentColor;fill-opacity:1;stroke:none" + d="M 2 2 L 2 3 L 2 4 L 2 7 L 2 9 L 3 9 L 3 7 L 3 4 L 3 3 L 4 3 L 7 3 L 9 3 L 12 3 L 13 3 L 13 4 L 13 7 L 13 9 L 13 12 L 13 13 L 12 13 L 9 13 L 7 13 L 7 14 L 9 14 L 12 14 L 13 14 L 14 14 L 14 12 L 14 9 L 14 7 L 14 4 L 14 3 L 14 2 L 13 2 L 12 2 L 9 2 L 7 2 L 4 2 L 3 2 L 2 2 z M 11.292969 4 L 8 7.2929688 L 8 5 L 7 5 L 7 9 L 8 9 L 11 9 L 11 8 L 8.7070312 8 L 12 4.7070312 L 11.292969 4 z M 2 10 L 2 14 L 6 14 L 6 10 L 2 10 z M 3 11 L 5 11 L 5 13 L 3 13 L 3 11 z " + class="ColorScheme-Text" + /> +</svg> diff --git a/doc/transaction_find.png b/doc/transaction_find.png index 0edc8cd12b..92646c0c14 100644 Binary files a/doc/transaction_find.png and b/doc/transaction_find.png differ
