Git commit 0aa204a1a4457b355de40cc130450e94b07e6ef5 by Jack Ostroff. Committed on 26/09/2023 at 01:40. Pushed by ostroffjh into branch 'Handbook-5.2'.
various additions, mostly to investments and currencies docbooks M +15 -2 README-CONTRIBUTORS A +- -- doc/currency_dialog1.png M +1 -1 doc/details-accounts.docbook M +96 -32 doc/details-currencies.docbook M +1 -1 doc/details-institutions.docbook M +143 -144 doc/details-investments.docbook M +99 -90 doc/firsttime.docbook https://invent.kde.org/office/kmymoney/-/commit/0aa204a1a4457b355de40cc130450e94b07e6ef5 diff --git a/README-CONTRIBUTORS b/README-CONTRIBUTORS index 2bb6dc602..da0eadd9d 100644 --- a/README-CONTRIBUTORS +++ b/README-CONTRIBUTORS @@ -55,10 +55,11 @@ This is in the order pulled in from index.docbook, with brief note on state of u prelim update complete <!ENTITY details-investments SYSTEM "details-investments.docbook"> - prelim update begun + prelim update complete <!ENTITY details-currencies SYSTEM "details-currencies.docbook"> - + prelim update begun + <!ENTITY details-reconciliation SYSTEM "details-reconciliation.docbook"> <!ENTITY details-reports SYSTEM "details-reports.docbook"> @@ -214,6 +215,18 @@ multiple places. - Can you really not match two non-imported transactions? If so, then the date always comes from the imported transaction. +- The Security dropdown and column in an Investment ledger shows only the name of the + security. Should it also show the symbol? (The manual used to say it did.) + +- Manual says KMM can download the latest prices from the web. Should we just + specify "current" prices? Although there is a date field for price fetch, it is + ignored. How do we want to deal with this? + +- online quote page parser, date field order. Did we recently have a case where it + needed to be altered due to field separators in the date? It shouldn't, so am I + mis-remembering, or was there a problem? + +- ---------------- diff --git a/doc/currency_dialog1.png b/doc/currency_dialog1.png new file mode 100644 index 000000000..3f0e2719b Binary files /dev/null and b/doc/currency_dialog1.png differ diff --git a/doc/details-accounts.docbook b/doc/details-accounts.docbook index b8e1e3ead..3f268985c 100644 --- a/doc/details-accounts.docbook +++ b/doc/details-accounts.docbook @@ -182,7 +182,7 @@ <note><para> You must have a file open before you can create a new account. If you do not have an existing file, you will need to <link - linkend="firsttime.3">create one</link>. + linkend="firsttime.newfile">create one</link>. </para></note> <para> diff --git a/doc/details-currencies.docbook b/doc/details-currencies.docbook index d40bde825..8621ea698 100644 --- a/doc/details-currencies.docbook +++ b/doc/details-currencies.docbook @@ -4,63 +4,127 @@ <authorgroup> <author> &Thomas.Baumgart; &Thomas.Baumgart.mail; </author> <author>&Michael.Carpino; &Michael.Carpino.mail;</author> + <author> &Jack.H.Ostroff; &Jack.H.Ostroff.mail; </author> </authorgroup> - <date>2020-02-20</date> - <releaseinfo>5.0.8</releaseinfo> + <date>2023-09-20</date> + <releaseinfo>5.2.0</releaseinfo> </chapterinfo> <title>Currencies</title> <para> - &kmymoney; supports the use of multiple currencies in different accounts. For - example, you can set up a bank account in Euros, another in British Pounds, and - still have your credit card account in US Dollars. + &kmymoney; supports the use of multiple currencies in different accounts. For + example, you can set up a savings account in Euros, a checking account in British + Pounds, and still have your credit card account in US Dollars. </para> <sect1 id="details.currencies.basecurrency"> <title>Base currency</title> <para> - During the initial &kmymoney; New File Setup, you will be asked to select the - base currency. Usually, the base currency is the currency you use in your - country. The base currency is the one that all income and expense categories - use and that reports will be based on. When you set up a new account &kmymoney; - will automatically default to the base currency. If your account requires you - to use a different currency, you can change it during the New Account Setup. + During the initial &kmymoney; <link linkend="firsttime.newfile"> New File + Setup</link>, you are asked to select the base currency. Usually, the base + currency is the currency you use in your home country. The base currency is the + one that all income and expense categories use and that reports will be based on. + When you set up a new account, &kmymoney; will automatically default to the base + currency. If your account requires you to use a different currency, you can change + it during the <link linkend="details.accounts.create.account">New Account + Setup</link>. </para> <para> - <screenshot> - <screeninfo>The select currency dialog</screeninfo> - <mediaobject> - <imageobject> - <imagedata fileref="select_currency.png" format="PNG" /> - </imageobject> - <textobject> - <phrase>select currency</phrase> - </textobject> - </mediaobject> - </screenshot> + &kmymoney; is released with a list of all currencies known at the time, and that is + the list from which you chose the default currency when you created your data file. + The <guilabel>Currencies</guilabel> dialog is where you manage the list of + currencies used in your data file. To display this dialog, select the + <menuchoice><guimenu>Tools</guimenu><guimenuitem>Currencies...</guimenuitem></menuchoice> + menu item. +</para> + +<sect2 id="details.currencies.addcurrency"> +<title>Adding a currency to your data file</title> + +<para> + <screenshot> + <screeninfo>The currency dialog</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="currency_dialog1.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>show used currencies</phrase> + </textobject> + </mediaobject> + </screenshot> +</para> + +<para> + For a newly created data file, the Currencies dialog will show only the currency + you chose as the default currency. If you want to use a different currency for a + new account, you must first add that currenc. By clicking the + <guibutton>Add</guibutton> button, you will be presented with the same list of + currencies from which you chose the default currency. You can either scroll + through the list, or use the search box at the top to find the currency you wish to + use. Click on that currency, and click <guibutton>OK</guibutton>. The Currencies + dialog will then include that currency in the list displayed, and you can now use + that currency when creating a new account. </para> +</sect2> <sect2 id="details.currencies.newcurrency"> <title>Adding a new currency</title> <para> - Although it does not happen often, sometimes a new currency is introduced. - This can be a new virtual currency, such as Bitcoin, or a change introduced by - a country for financial policy reasons. While any such currency will be added - to the next version of &kmymoney; it is possible to add it manually, in case + <screenshot> + <screeninfo>The select currency dialog</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="select_currency.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>select currency</phrase> + </textobject> + </mediaobject> + </screenshot> +</para> + +<para> + Although it does not happen often, sometimes a new currency is introduced. This + can be a new virtual currency, such as Bitcoin, or a change introduced by a country + for financial policy reasons. While any such currency will be added to the next + version of &kmymoney;, it is possible to add it to your data file manually, in case you have a need to begin using it immediately. </para> <para> - To manually add a currency, select the - <menuchoice><guimenu>Tools</guimenu><guimenuitem>Currencies...</guimenuitem></menuchoice> - menu item to display the <guilabel>Currencies</guilabel> dialog, as shown - above. Right-click on any existing currency and select <guimenuitem>New - currency</guimenuitem> from the <guimenu>Currency Options</guimenu> context menu. - Enter the official code for the currency and click <guilabel>OK</guilabel>. The + To manually add a currency, bring up the Currencies dialog, as shown above. + Right-click on any existing currency and select <guimenuitem>New + currency</guimenuitem> from the <guimenu>Currency Options</guimenu> context menu, + or click the <guibutton>New</guibutton> button. This will bring up the + <guilabel>Currency editor</guilabel>. +</para> + +<para> + Replace with the currency editor + <screenshot> + <screeninfo>The Currency editor</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="select_currency.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>add new currency or edit currency dedtails</phrase> + </textobject> + </mediaobject> + </screenshot> +</para> + +<para> + The Currency editor has some similarities to the dialog for editing details of securities +</para> + +<para> + Enter the official ISO code for the currency and click <guilabel>OK</guilabel>. The currency will be created with the name <quote>New Currency</quote>. To change the name, either press <keycap>F2</keycap> or right-click and select <guimenuitem>Rename currency</guimenuitem>. diff --git a/doc/details-institutions.docbook b/doc/details-institutions.docbook index 6bc73935e..7c65dee65 100644 --- a/doc/details-institutions.docbook +++ b/doc/details-institutions.docbook @@ -168,7 +168,7 @@ <note><para> You must have a file open before you can create a new institution. If you do not have an existing file, you will need to <link - linkend="firsttime.3">create one</link>. + linkend="firsttime.newfile">create one</link>. </para></note> <para> diff --git a/doc/details-investments.docbook b/doc/details-investments.docbook index 55dfe5310..2a7d379fb 100644 --- a/doc/details-investments.docbook +++ b/doc/details-investments.docbook @@ -83,8 +83,8 @@ currency in which it is traded. When a price quote is entered for an investment, the currency of the value given is always its base currency. A stock on the NYSE (New York Stock Exchange) would be in US dollars (USD), and one on an Australian - market would be in Australian dollars (AUD). The Base currency for a security does - not need to be the same as the default currency for the Investment account holding + market would be in Australian dollars (AUD). The base currency for a security does + not need to be the same as the base currency for the Investment account holding that security. </para> </sect2> @@ -587,30 +587,19 @@ </screenshot> </para> -<!-- XXX --> - <para> - Investment transactions are entered and edited in the - <link linkend="details.ledgers">Ledger</link> view, as with other kinds of - accounts. However, the fields will appear different, and vary depending on the - transaction type or activity. Investment transactions have some additional - elements: + Investment transactions are entered and edited in the <link + linkend="details.ledgers">Ledgers</link> view, as with transactions in other types + of accounts. However, the fields shown will be different, and vary depending on + the activity or transaction type. Investment transactions have some additional + elements, described below. </para> -<itemizedlist> - <listitem><para>Activity</para></listitem> - <listitem><para>Security</para></listitem> - <listitem><para>Account</para></listitem> - <listitem><para>Shares, Price, & Total Amount</para></listitem> - <listitem><para>Fees</para></listitem> - <listitem><para>Interest category</para></listitem> -</itemizedlist> - <sect2> <title>Activity</title> <para> - The Activity for an investment transaction describes what action is happening - to the security. The following activities are supported: + The Activity for an investment transaction describes what type of action is + happening to the security. The following activities are supported: </para> <variablelist> @@ -618,55 +607,57 @@ <term>Buy/Sell</term> <listitem> <para> - Use to record purchases or sales of individual securities. This action + Use to record the purchase or sale of an individual security. This action requires an account to transfer the funds from/to, which defaults to the - Brokerage account, if one has been created. + Brokerage account, if one has been defined for this Investment account. </para> </listitem> </varlistentry> <varlistentry> - <term>Dividend/Yield</term> + <term>Dividend/Yield/Interest Income</term> <listitem> <para> - Also known as a <quote>Cash Dividend</quote>, this action is used when you - receive an interest or dividend disbursement from your security. This action - also requires an account to transfer the funds to. + Also known as a <quote>Cash Dividend,</quote> this action is used when you + receive an interest or dividend disbursement of cash from your security. This + action also requires an account to transfer the funds to. The three terms are + used interchangeably. </para> </listitem> </varlistentry> <varlistentry> - <term>Reinvest Dividend</term> + <term>Reinvest dividend</term> <listitem> <para> - Reinvest Dividend. This is a dividend where the proceeds are used to purchase - additional shares of the security. + This is a dividend where the proceeds are used to purchase additional shares of + the security. </para> </listitem> </varlistentry> <varlistentry> - <term>Add/Remove Shares</term> + <term>Add/Remove shares</term> <listitem> <para> A simple increase or decrease in the number of shares you own. This should be used very rarely, because it's uncommon for shares to just show up in your - account (or disappear) unless it's a purchase or a sale. One use of these - activities is for some situations &kmymoney; does not natively handle, such as - the exchange of some number of shares of a security for a different number of - shares of a different class of the same security. + account (or to disappear) unless it's a purchase, sale, or dividend + reinvestment. One use of these activities is for some situations &kmymoney; + does not natively handle, such as the exchange of some number of shares of a + security for a different number of shares of a different security or different + class of the same security. </para> </listitem> </varlistentry> <varlistentry> - <term>Split Shares</term> + <term>Split shares</term> <listitem> <para> - This is used when the stock is split. Enter the ratio of the split in - the <quote>Split Ratio</quote> field. For example, in a 3:2 split, enter 1.5. - Reverse splits, where the ration is less than one, such as 2:3, although + This is used when the stock is split. Enter the ratio of the split in the + <quote>Split Ratio</quote> field. For example, in a 3:2 split, enter 1.5. + Reverse splits, where the ratio is less than one, such as 2:3, although uncommon, are also allowed. </para> </listitem> @@ -677,9 +668,9 @@ <sect2> <title>Security</title> <para> - Each investment transaction must be associated with an individual security. Choose - the security name when adding or editing a transaction. The symbol will be - displayed when viewing it. + Each investment transaction must be associated with an individual security. The + dropdown shows all securities you own in the current Investment account - select + the one for this transaction. </para> </sect2> @@ -703,33 +694,31 @@ enter just the total amount and the number of shares, because these are the known facts of the transaction. &kmymoney; will automatically calculate the price per share. Note that there is only one entry field for the price, and it will be - labeled - <quote>Transaction amount</quote> or <quote>Price/share</quote> depending on the - setting of the <guilabel>Price entry</guilabel> option when the account - was <link linkend="details.investments.newinvestmentwizard">set up</link>. + labeled <quote>Transaction amount</quote> or <quote>Price/share</quote> depending + on the setting of the <guilabel>Price entry</guilabel> option when the account was + <link linkend="details.investments.newinvestmentwizard">set up</link>. </para> </sect2> <sect2> <title>Fees</title> <para> - With many investment transactions you can include the fees (or commission) you - paid the broker. If you enter a category for the fee, then a field will be - shown to the right where you can enter the amount of the fee. If you need to - enter more than one fee for the transaction, you can use - the <link linkend="details.ledgers.split">Split Transactions</link> feature. - In this case, when you complete entering all the splits, the total amount of - the fees will be shown to the right. + With many investment transactions you can include the fees (or commission) you paid + the broker. If you enter a category for the fee, then a field will be shown to the + right where you can enter the amount of the fee. If you need to enter more than + one fee for the transaction, you can use the <link + linkend="details.ledgers.split">Split Transactions</link> feature. In this case, + when you complete entering all the splits, the total amount of the fees will be + shown to the right. </para> </sect2> <sect2> <title>Interest</title> <para> - This is how you enter an interest or dividend payment from a security. As - with fees, if you enter a category, then a field will be shown to the right - where you can enter the amount. You can also use the split transaction - feature, if required. + This is how you enter an interest or dividend payment from a security. As with + fees, if you enter a category, then a field will be shown to the right where you + can enter the amount. You can also use the split transaction feature, if required. </para> </sect2> </sect1> @@ -738,13 +727,13 @@ <title>Working With Foreign Investments</title> <para> - &kmymoney; supports multiple currencies and securities, and you may want to combine - the two. However, doing so requires extra care to assure accurate records. As - noted above, when you add a security, you must specify its trading currency. This - might not be the same as the base currency for your &kmymoney; file, and it also - might not be the same as the default currency for the investment account in which - you hold the stock or the account where you transfer your funds to/from for - buys/sells. + &kmymoney; supports multiple currencies, and there are situations where this can be + very useful, if not essential. However, doing so requires extra care to assure + accurate records. As noted above, when you add a security, you must specify its + trading currency. This might not be the same as the base currency for your + &kmymoney; file, and it also might not be the same as the base currency for the + investment account in which you hold the security or for the account where you + transfer your funds to/from for buys/sells/dividends. </para> <para> @@ -759,37 +748,23 @@ these values in the transaction. </para> -<para> - <screenshot> - <screeninfo>Currency Warning</screeninfo> - <mediaobject> - <imageobject> - <imagedata fileref="investment-currencywarning.png" format="PNG" /> - </imageobject> - <textobject> - <phrase>Currency Warning</phrase> - </textobject> - </mediaobject> - </screenshot> -</para> - <para> When you choose the brokerage account to fund the transfer, you'll be warned that it's in a different currency. </para> <para> - <screenshot> - <screeninfo>Exchange Rate Editor</screeninfo> - <mediaobject> - <imageobject> - <imagedata fileref="investment-exchangerateeditor.png" format="PNG" /> - </imageobject> - <textobject> - <phrase>Exchange Rate Editor</phrase> - </textobject> - </mediaobject> - </screenshot> + <screenshot> + <screeninfo>Currency Warning</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="investment-currencywarning.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Currency Warning</phrase> + </textobject> + </mediaobject> + </screenshot> </para> <para> @@ -799,6 +774,20 @@ Manually</link> for more information on the price dialog. </para> +<para> + <screenshot> + <screeninfo>Exchange Rate Editor</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="investment-exchangerateeditor.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Exchange Rate Editor</phrase> + </textobject> + </mediaobject> + </screenshot> +</para> + <para> If you then switch over to the brokerage account, you will see the transaction as EUR 2,254.54, assuming an exchange rate is 11.0000 SEK/EUR. @@ -806,20 +795,19 @@ </sect1> <sect1 id="details.investments.prices"> -<title>Updating Prices</title> +<title>Updating Security Prices</title> <para> - There are two ways of updating the prices for your investments. You can - either enter the price manually or have &kmymoney; fetch it from the web. + There are two ways of updating the prices for your investments. You can either + enter the price manually or have &kmymoney; fetch it from the web. </para> <sect2> <title>Manual Price Updates</title> <para> - You can enter prices for your investments using the same - <link linkend="details.currencies.prices">Price Editor</link> as used for - currencies. + You can enter prices for your investments using the same <link + linkend="details.currencies.prices">Price Editor</link> as used for currencies. </para> </sect2> @@ -833,24 +821,25 @@ <sect3> <title>How Online Quotes Work</title> <para> - At your request, &kmymoney; will fetch a page from the web that contains the - latest price for each security. By default, prices are fetched from - <ulink url="https://finance.yahoo.com";>finance.yahoo.com</ulink>, and are - subject to the terms and conditions of that site. + At your request, &kmymoney; will fetch a page from the web that contains the latest + price for each security. By default, prices are fetched from <ulink + url="https://finance.yahoo.com";>finance.yahoo.com</ulink>, and are subject to the + terms and conditions of that site. </para> <para> The online quote lookup uses the security's trading symbol to find the price. Therefore, it is important to set the symbol correctly. Yahoo supports stocks from - most major world markets, so it's usually just a matter of finding the correct + most major world markets, so it is usually just a matter of finding the correct symbol. For example, TietoEnator trades on the Stockholm Stock Exchange market, and its Yahoo symbol is TIEN.ST. </para> <para> - To find the trading symbol for a security supported by Yahoo, use the - <quote>Symbol Lookup</quote> feature - at <ulink url="https://finance.yahoo.com";>finance.yahoo.com</ulink>. + To find the trading symbol for a security supported by Yahoo, use the <quote>Symbol + Lookup</quote> feature at <ulink + url="https://finance.yahoo.com";>finance.yahoo.com</ulink>. You should have set the + trading symbol when initially entering the security into &kmymoney;. </para> </sect3> @@ -858,10 +847,10 @@ <title>Assigning a Quote Source</title> <para> - In order to get online price quotes, you first have to enable it for each - security or currency you want updated, by setting a <quote>Online Quote - Source</quote>. This is the name of the service from which the quote should - be fetched. &kmymoney; ships with several sources to choose from. Yahoo is the + In order to get online price quotes, you first have to enable the feature for each + security or currency you want updated, by setting an <quote>Online Quote + Source</quote>. This is the name of the service from which the quote should be + fetched. &kmymoney; ships with several sources to choose from. Yahoo is the recommended default source, and should work for most investments and all currencies. </para> @@ -876,12 +865,12 @@ </para> <para> - Versions of &kmymoney; starting with 0.9 contain support for the Finance::Quote - package for obtaining online quotes. This is intended primarily as a convenience - for those users converting from the &gnucash; finance package, which uses it as its - native method. If you do select this option, you should see a different list of - sources, those supported by Finance::Quote. If the list is empty, it suggests that - the package is not properly installed. See their web site at + Versions of &kmymoney; starting with 0.9 contain support for the Perl + Finance::Quote package for obtaining online quotes. This is intended primarily as + a convenience for those users converting from the &gnucash; finance package, which + uses it as its native method. If you do select this option, you should see a + different list of sources, those supported by Finance::Quote. If the list is empty, + it suggests that the package is not properly installed. See their web site at <ulink url="http://finance-quote.sourceforge.net";> http://finance-quote.sourceforge.net</ulink> for more information. </para> @@ -891,20 +880,20 @@ <title>Adjusting a quote</title> <para> - Some online sources do not report the price in a base quantity (⪚, EUR) but - in a fraction (⪚, Cent). Using this information as price will produce wrong + Some online sources do not report the price in a base quantity (⪚, EUR) but in a + fraction (⪚, Cent). Using this information for a price will produce wrong values for your investments. </para> <para> If this is the case for your online source, you can use the - <guilabel>Factor</guilabel> field to enter an adjusting factor. For the above + <guilabel>Factor</guilabel> field to enter an adjusting factor. For the above mentioned example the factor would be 0.01. </para> <para> - The <guilabel>Factor</guilabel> field is only available if a - <guibutton>Quote Source</guibutton> has been selected. + The <guilabel>Factor</guilabel> field is only available if a <guibutton>Quote + Source</guibutton> has been selected. </para> </sect3> @@ -915,23 +904,23 @@ Typically, you will update the prices for all your securities and currencies as a single operation. Choose the <menuchoice><guimenu>Tools</guimenu><guimenuitem>Update Stock and Currency - Prices...</guimenuitem></menuchoice> menu item to bring up the online price - quotes dialog. Press <guibutton>Update All</guibutton> to fetch quotes for all - securities and currencies in your &kmymoney; file. + Prices...</guimenuitem></menuchoice> menu item to bring up the online price quotes + dialog. Press <guibutton>Update All</guibutton> to fetch quotes for all securities + and currencies in your &kmymoney; file. </para> <para> - <screenshot> - <screeninfo>Update Stock and Currency Prices</screeninfo> - <mediaobject> - <imageobject> + <screenshot> + <screeninfo>Update Stock and Currency Prices</screeninfo> + <mediaobject> + <imageobject> <imagedata fileref="investment-onlineupdate.png" format="PNG" /> - </imageobject> - <textobject> + </imageobject> + <textobject> <phrase>Online Stock and Currency Price Update</phrase> - </textobject> - </mediaobject> - </screenshot> + </textobject> + </mediaobject> + </screenshot> </para> </sect3> @@ -941,20 +930,22 @@ <para> Adding or editing quote sources is not recommended for anyone but the most technical user. You should feel comfortable reading HTML and writing complex - regular expressions. If this doesn't sound like you, we recommend writing to the - developer's list if none of the quote sources work for you. Ideally, please point - us to a web page where these quotes can be obtained. Additionally you can consult - with members of the KDE Community Forum for &kmymoney; as they may already have a - solution available for your needs. + regular expressions. If this doesn't sound like you, please use one of the <link + linkend="firsttime.contact">suggested support channels</link> if you are having + problems with a particular source or if none of the quote sources work for you. If + looking for a source for prices for a security not found by one of the existing + sources, ideally, please point us to a web page where these prices can be obtained. + Additionally you can consult with members of the KDE Community Forum for &kmymoney; + as they may already have a solution available for your needs. </para> <para> If you do feel up to the challenge, here's how it works. The quote sources are - contained in the settings dialog. Choose the + contained in the settings dialog. Choose the <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure - &kmymoney;</guimenuitem></menuchoice> menu item. From there, choose the <guilabel>Online - Quotes</guilabel> section. You can choose an existing source to edit, or create a - new one. When you are done with your changes, be sure to press + &kmymoney;</guimenuitem></menuchoice> menu item. From there, choose the + <guilabel>Online Quotes</guilabel> section. You can choose an existing source to + edit, or create a new one. When you are done with your changes, be sure to press the <guibutton>Update</guibutton> button before exiting the dialog. Your changes are not saved by default. </para> @@ -971,9 +962,9 @@ <para> Note that the URL can also be a file: URL, which the quote fetcher takes to be the path to an executable script. It will pass any command-line arguments to it that - you have specified, and feed the stdout to the page parser. For example, you might - have a script called getquote.sh that contains custom quote logic, taking the - symbol as a single parameter. Your URL would be + you have specified, and feed the stdout of that script to the page parser. For + example, you might have a script called getquote.sh that contains custom quote + logic, taking the symbol as a single parameter. Your URL would be <quote>file:/path/to/getquote.sh %1</quote>. </para> @@ -985,9 +976,9 @@ should be exactly one capture expression, surrounded by parentheses, in each regexp field. The date format further tells the date parser the order of year, month, and day. This date format should always be in the form "%x %x %x". where x is y, m, or - d. The date parser is very smart. <quote>%m %d %y</quote> will - parse <quote>December 31st, 2005</quote> as easily as <quote>12/31/05</quote>. Two - digit years are interpreted as being in the range of 1950-2049. + d. The date parser is very smart. <quote>%m %d %y</quote> will parse + <quote>December 31st, 2005</quote> as easily as <quote>12/31/05</quote>. Two digit + years are interpreted as being in the range of 1950-2049. </para> </sect3> </sect2> @@ -1006,5 +997,13 @@ usually be handled by marking as Tax related all the categories you use for transactions which might have tax consequences. </para> + +<para> + The &kmymoney; development team is aware of these and additional issues, and has + been collecting requirements and notes for an eventual major re-write of how the + program handles investments. When that process begins (there is not current + schedule) there will be an opportunity for users to provide input on any additional + needs and desires in this area. +</para> </sect1> </chapter> diff --git a/doc/firsttime.docbook b/doc/firsttime.docbook index c7db417f2..998475cc1 100644 --- a/doc/firsttime.docbook +++ b/doc/firsttime.docbook @@ -30,17 +30,17 @@ <title>The main window</title> <para> - <screenshot> - <screeninfo>The Main Window</screeninfo> - <mediaobject> - <imageobject> + <screenshot> + <screeninfo>The Main Window</screeninfo> + <mediaobject> + <imageobject> <imagedata fileref="mainwindow_numbered.png" format="PNG" /> - </imageobject> - <textobject> + </imageobject> + <textobject> <phrase>The Main Window</phrase> - </textobject> - </mediaobject> - </screenshot> + </textobject> + </mediaobject> + </screenshot> </para> <para> @@ -56,7 +56,7 @@ <para> The menu and toolbars provide access to the features of &kmymoney; and allow you to - <link linkend="firsttime.3">Create a new data file,</link> open an existing data + <link linkend="firsttime.newfile">Create a new data file,</link> open an existing data file, or configure how &kmymoney; operates. The toolbar can be configured to show icons for the operations you use most frequently. <!-- FIXME: pointer to wherever this is described. --> @@ -296,7 +296,7 @@ </para> </sect1> -<sect1 id="firsttime.3"> +<sect1 id="firsttime.newfile"> <title>Creating a new file</title> <para> @@ -311,18 +311,20 @@ <para> In addition to that data file with all the financial data for that set of accounts, - &kmymoney; uses additional files to store data regarding configuration and display - preferences. The exact location of these files depends on your specific Operating - System or Distribution. <!-- FIXME: we need a section on OS specific issues. --> + &kmymoney; uses additional files to store data regarding configuration settings and + display preferences. The exact location of these files depends on your specific + Operating System or Distribution. + <!-- FIXME: we need a section on OS specific issues. --> </para> <para> - To create a new file you can either select - <menuchoice><guimenu>File</guimenu><guimenuitem>New</guimenuitem></menuchoice> - menu item or choose the <guiicon><inlinemediaobject><imageobject><imagedata - fileref="new.png" format="PNG"/></imageobject></inlinemediaobject></guiicon> new - icon from the toolbar. In addition, if the main welcome page is displayed, - you can also select the first link: "Get started and setup accounts." + To create a new file you can either select the + <menuchoice><guimenu>File</guimenu><guimenuitem>New</guimenuitem></menuchoice> menu + item or choose the <guiicon><inlinemediaobject><imageobject><imagedata + fileref="new.png" format="PNG"/></imageobject></inlinemediaobject></guiicon> + <guilabel>new</guilabel> icon from the toolbar. In addition, if the main welcome + page is displayed, you can also select the first link: <quote>Get started and setup + accounts.</quote> </para> <para> @@ -331,29 +333,26 @@ </para> <para> - <screenshot> - <screeninfo>Personal Data Page</screeninfo> - <mediaobject> - <imageobject> + <screenshot> + <screeninfo>Personal Data Page</screeninfo> + <mediaobject> + <imageobject> <imagedata fileref="newfile.png" format="PNG" /> - </imageobject> - <textobject> + </imageobject> + <textobject> <phrase>Personal Data Page</phrase> - </textobject> - </mediaobject> - </screenshot> -</para> - -<para> - Any information entered here is used only to personalize your file. All these - fields are optional, so you can use &kmymoney; without entering any information - now. In the future, this information may be used in some reports and for online - banking. If &kmymoney; requires any personal information in future releases and - finds none, you will be prompted to enter the relevant data then. + </textobject> + </mediaobject> + </screenshot> </para> <para> - Once you have completed entering data, press <guibutton>Next</guibutton>. + Any information entered hereon the <guilabel>Personal Data</guilabel> page is used + only to personalize your file. All these fields are optional, so you can use + &kmymoney; without entering any information now. In the future, this information + may be used in some reports and for online banking. If &kmymoney; requires any + personal information in future releases and finds none, you will be prompted to + enter the relevant data then. </para> <para> @@ -362,6 +361,10 @@ imports all information into &kmymoney;. </para> +<para> + Once you have completed entering data, press <guibutton>Next</guibutton>. +</para> + <para> If you need to change any of this information in the future, you can access this form with the <menuchoice><guimenu>File</guimenu><guimenuitem>Personal @@ -371,23 +374,23 @@ <para> &kmymoney; supports multiple currencies. To set your base currency (the currency you use day to day and which will be used for your reports,) select the appropriate - entry from the list provided and press <guibutton>Next</guibutton>. A default will - be selected from &kmymoney; based upon your locale settings. You can choose a - different currency, if appropriate for you situation. + entry from the list provided and press <guibutton>Next</guibutton>. A default will + be selected based upon your locale settings, but you can easily choose a different + currency, if appropriate for you situation. </para> <para> - <screenshot> - <screeninfo>Base currency selection Page</screeninfo> - <mediaobject> - <imageobject> + <screenshot> + <screeninfo>Base currency selection Page</screeninfo> + <mediaobject> + <imageobject> <imagedata fileref="newfile-2.png" format="PNG" /> - </imageobject> - <textobject> + </imageobject> + <textobject> <phrase>Base currency selection page</phrase> - </textobject> - </mediaobject> - </screenshot> + </textobject> + </mediaobject> + </screenshot> </para> <para> @@ -401,17 +404,17 @@ </para> <para> - <screenshot> - <screeninfo>Checking account creation Page</screeninfo> - <mediaobject> - <imageobject> + <screenshot> + <screeninfo>Checking account creation Page</screeninfo> + <mediaobject> + <imageobject> <imagedata fileref="newfile-3.png" format="PNG" /> - </imageobject> - <textobject> + </imageobject> + <textobject> <phrase>Checking account creation page</phrase> - </textobject> - </mediaobject> - </screenshot> + </textobject> + </mediaobject> + </screenshot> </para> <para> @@ -437,17 +440,17 @@ </para> <para> - <screenshot> - <screeninfo>Account template selection Page</screeninfo> - <mediaobject> - <imageobject> + <screenshot> + <screeninfo>Account template selection Page</screeninfo> + <mediaobject> + <imageobject> <imagedata fileref="newfile-4.png" format="PNG" /> - </imageobject> - <textobject> + </imageobject> + <textobject> <phrase>Account template selection page</phrase> - </textobject> - </mediaobject> - </screenshot> + </textobject> + </mediaobject> + </screenshot> </para> @@ -467,17 +470,17 @@ </para> <para> - <screenshot> - <screeninfo>Preference Page</screeninfo> - <mediaobject> - <imageobject> + <screenshot> + <screeninfo>Preference Page</screeninfo> + <mediaobject> + <imageobject> <imagedata fileref="newfile-6.png" format="PNG" /> - </imageobject> - <textobject> + </imageobject> + <textobject> <phrase>Preference page</phrase> - </textobject> - </mediaobject> - </screenshot> + </textobject> + </mediaobject> + </screenshot> </para> <para> @@ -491,17 +494,17 @@ is the wrong shot. --> <para> - <screenshot> - <screeninfo>Filename selection Page</screeninfo> - <mediaobject> - <imageobject> + <screenshot> + <screeninfo>Filename selection Page</screeninfo> + <mediaobject> + <imageobject> <imagedata fileref="newfile-6.png" format="PNG" /> - </imageobject> - <textobject> + </imageobject> + <textobject> <phrase>Filename selection page</phrase> - </textobject> - </mediaobject> - </screenshot> + </textobject> + </mediaobject> + </screenshot> </para> <para> @@ -1025,7 +1028,13 @@ </para> </formalpara> -<para> Running this way is a bit more difficult, so we don't expect all users to do -this. However, if you're interested in helping &kmymoney; become as stable as -possible, this is the best way to do it short of finding the bug in the code and -sending in a patch. </para> </sect3> </sect2> </sect1> </chapter> +<para> + Running this way is a bit more difficult, so we don't expect all users to do this. + However, if you're interested in helping &kmymoney; become as stable as possible, + this is the best way to do it short of finding the bug in the code and sending in a + patch. +</para> +</sect3> +</sect2> +</sect1> +</chapter>
