[office/kmymoney/Handbook-5.2] doc: more FIXME fixes
Jack Ostroff
null at kde.org
Tue Feb 6 01:31:41 GMT 2024
Git commit 6f58fb5f1dca7b4c4044123891a65a50b274b8c9 by Jack Ostroff.
Committed on 28/01/2024 at 01:11.
Pushed by ostroffjh into branch 'Handbook-5.2'.
more FIXME fixes
M +66 -52 doc/details-investments.docbook
M +12 -10 doc/details-ledgers.docbook
A +- -- doc/investments_new_details.png
A +- -- doc/investments_new_type.png
A +10 -0 doc/tag-delete.svg
https://invent.kde.org/office/kmymoney/-/commit/6f58fb5f1dca7b4c4044123891a65a50b274b8c9
diff --git a/doc/details-investments.docbook b/doc/details-investments.docbook
index a9c4318ed7..d968419bd0 100644
--- a/doc/details-investments.docbook
+++ b/doc/details-investments.docbook
@@ -13,18 +13,19 @@
<sect1 id="details.investments.overview"><title>Investments in &kmymoney;</title>
<para>
- In very general terms, an investment is any allocation of money with the
- expectation of a future benefit. &kmymoney;'s Investment accounts are designed for
- one particular type of investment: securities. A security investment (or just a
- security) is an instrument for investing money that is traded on a market with the
- intention of a profitable return in the form of either appreciation in value,
- income such as interest or dividends, or a combination of both. Stocks and mutual
- funds are the most common securities; and they are the ones specifically supported
- within &kmymoney;. Bonds have a different financial structure, but can usually be
- handled by &kmymoney;. Futures, commodities, options, and more complex investment
- instruments like derivatives are other types of investments, but &kmymoney; has no
- special functionality for them. As long an investment has similar characteristics
- to a stock or mutual fund, it can be tracked.
+ In very general terms, an <emphasis>investment</emphasis> is any allocation of
+ money with the expectation of a future benefit. &kmymoney;'s Investment accounts
+ are designed for one particular type of investment: securities. A security
+ investment (or just a security) is an instrument for investing money that is traded
+ on a market with the intention of a profitable return in the form of either
+ appreciation in value, income such as interest or dividends, or a combination of
+ both. Stocks and mutual funds are the most common securities; and they are the
+ ones specifically supported within &kmymoney;. Bonds have a different financial
+ structure, but can usually be handled by &kmymoney;. Futures, commodities,
+ options, and more complex investment instruments like derivatives are other types
+ of investments, but &kmymoney; has no special functionality for them. As long an
+ investment has similar characteristics to a stock or mutual fund, it can be
+ tracked.
</para>
<sect2><title>Investment Accounts</title>
@@ -116,11 +117,13 @@
</para>
<para>
- At the top of the list of equities is the <guilabel>Select Account:</guilabel> dropdown,
- where you can select the investment account for which you want to see the specific
- investments. If you are looking at an investment account in the Legders View, and then switch
- to the Investments View, that account will already be selected. <!-- FIXME: refer to the
- setting about forcing that coordination, -->
+ At the top of the list of equities is the <guilabel>Select Account:</guilabel>
+ dropdown, where you can select the investment account for which you want to see the
+ specific investments. If you have checked <link
+ linkend="details.settings.general.views">Synchronize account selection of ledger
+ and investment view</link> in the configuration dialog, then if you are looking at
+ an investment account in the Legders View, and then switch to the Investments View,
+ that account will already be selected.
</para>
<para>
@@ -312,20 +315,6 @@
<guilabel>Select Account</guilabel> dropdown.
</para>
-<screenshot>
- <screeninfo>new investment wizard</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="investments_summarytab.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>new investment wizard</phrase>
- </textobject>
- </mediaobject>
-</screenshot>
-<!-- FIXME: the above shot is of the equities tab. Replace with shot(s) of the new
- investment dialog. -->
-
<para>
Right-click in any empty space in the view. This brings up the <guimenu>Investment
Options</guimenu> context menu. Choose <guimenuitem>New
@@ -334,18 +323,43 @@
</para>
<sect2 id="details.investments.newinvestmentwizard"><title>New Investment Wizard</title>
+
<para>
- The first thing you'll be asked to enter is the type of investment. The currently
- available values are Stock, Bond, and Mutual Fund. If your investment is not
- strictly one of these types, it is ok to mislabel here, as the type is not
+ The first thing you will be asked to enter is the type of investment. The
+ currently available values are Stock, Bond, and Mutual Fund. If your investment is
+ not strictly one of these types, it is ok to mislabel here, as the type is not
currently used to restrict or control what you can do with the investment.
</para>
+<screenshot>
+ <screeninfo>new investment wizard type</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="investments_new_type.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>new investment wizard type</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
+
<para>
Next, the investment details page is presented. The following information is
entered on this page:
</para>
+<screenshot>
+ <screeninfo>new investment wizard details</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="investments_new_details.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>new investment wizard details</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
+
<itemizedlist>
<listitem>
<para>
@@ -357,12 +371,12 @@
</para>
<para>
- If you plan to use Online Quotes <!--FIXME: use real link --> to retrieve
- prices for this investment, ensure that the symbol exactly matches the symbol
- used by your quote source. Yahoo covers most of the world's markets, and
- requires a suffix on the end of symbols outside the US, to specify the country
- or market. For example, Rubicon Limited on the New Zealand market should be
- entered as <quote>RBC.NZ</quote>.
+ If you plan to use <link linkend="details.investments.onlinequotes">Online
+ Quotes</link> to retrieve prices for this investment, ensure that the symbol
+ exactly matches the symbol used by your quote source. Yahoo covers most of the
+ world's markets, and requires a suffix on the end of symbols outside the US, to
+ specify the country or market. For example, Rubicon Limited on the New Zealand
+ market should be entered as <quote>RBC.NZ</quote>.
</para>
</listitem>
@@ -417,11 +431,11 @@
<listitem>
<para>
- Price entry. This is a dropdown which specifies when you enter or edit a buy
- or sell transaction for this investment, whether you follow the default which
- is specied in a main configuration item <!-- FIXME: where - put linke? -->, or
- want to explicitly enter either the price per share or the total for all
- shares.
+ Price entry. When you enter or edit a buy or sell transaction for this
+ investment, this dropdown indicates whether you want to explicitly enter either
+ the price per share or the total for all shares or to follow the default, which
+ is specied in a main configuration item
+
</para>
</listitem>
@@ -490,10 +504,10 @@
</itemizedlist>
</sect2>
-<sect2 id="details.investments.reuse"><title>Using a Security in more than one Investment Account</title>
-<note>
+<sect2><title>Using a Security in more than one Investment Account</title>
+<note><title>Caution</title>
<para>
- It is possible to own shares of the same security in differentmore than one
+ It is possible to own shares of the same security in more than one
investment account, such as a regular investment account and also a retirement
account. If you follow the instructions above, you will have that security show
up in both accounts, but &kmymoney; will actually treat them as if each of the
@@ -507,8 +521,8 @@
<para>
When you add a security to an investment account, and that investment already
exists in another investment account, you need to be careful if you want to reuse
- it rather than creating a new, duplicate entry. When you see the <guilabel>New
- Investment Wizard</guilabel>, after selecting the type of investment and clicking
+ it rather than creating a new, duplicate entry. In the <guilabel>New Investment
+ Wizard</guilabel>, after selecting the type of investment and clicking
<guibutton>Next</guibutton>, you need to be sure the <guilabel>Full Name</guilabel>
field is empty before entering the <guilabel>Trading Symbol</guilabel>. Then, when
you hit <keycap>Tab</keycap>, if &kmymoney; already has a security using that
@@ -933,8 +947,8 @@
options, and futures. In addition, when you sell a security, &kmymoney; does not
know which specific shares you are selling, &ie;, the oldest or the most recently
purchased, so it cannot calculate return on investment. Finally, it has no direct
- knowledge about any country's specific tax reporting requirements, but these can
- usually be handled by marking as Tax related all the categories you use for
+ knowledge about any country's specific tax reporting requirements, although these
+ can usually be handled by marking as Tax related all the categories you use for
transactions which might have tax consequences.
</para>
diff --git a/doc/details-ledgers.docbook b/doc/details-ledgers.docbook
index ef79f4dbc7..16ffdf157e 100644
--- a/doc/details-ledgers.docbook
+++ b/doc/details-ledgers.docbook
@@ -260,9 +260,9 @@
<para>
<guilabel>Erroneous</guilabel> selects transactions where &kmymoney; has detected
- some problem. Most commonly, this is an <link
- linkend="details.ledgers.split">unbalanced transaction</link>, which is often the
- case for imported transactions.
+ some problem. Most commonly, thrsr str an <link
+ linkend="details.ledgers.split">unbalanced transactiond</link>, which is often the
+ case for imported transactions where a category was not assigned..
</para>
<para>
@@ -518,17 +518,19 @@
moving into or out of a sigle account. Most of the time, a transaction contains
exactly two splits, one for the account the money is coming from and the other for
the account the money is going to. The term <quote>Split Transaction</quote> is
- used when one side of the transaction is further divided into more than one split.
- This is most commonly done when money moves in or out of a typical bank account,
- but is allocated to more than one category.
+ used when there are actually three or more splits, when one side of the transaction
+ is further divided into more than one split. This is most commonly done when money
+ moves in or out of a typical bank account, but is allocated to more than one
+ category.
</para>
<para>
- In almost all cases, if a transaction has only one split, it is said to be
- <quote>unbalanced</quote> meaning that money is coming from somewhere, but not
+ If a transaction has only one split, it is almost always said to be
+ <quote>unbalanced,</quote> meaning that money is coming from somewhere, but not
going anywhere (or vice versa.) Such transactions are typically flagged by being
- displayed in red in the Ledger. The only valid transactions with a single split
- occurs in Investment Accounts: Add, Remove, or Split shares.
+ displayed in red in the Ledger. Valid transactions with a single split are usually
+ in Investment Accounts: Add, Remove, or Split shares. The other case is where the
+ amount of the transaction is 0, which banks somtimes produce.
</para>
<para>
diff --git a/doc/investments_new_details.png b/doc/investments_new_details.png
new file mode 100644
index 0000000000..7bd84b3444
Binary files /dev/null and b/doc/investments_new_details.png differ
diff --git a/doc/investments_new_type.png b/doc/investments_new_type.png
new file mode 100644
index 0000000000..c7bd5d262d
Binary files /dev/null and b/doc/investments_new_type.png differ
diff --git a/doc/tag-delete.svg b/doc/tag-delete.svg
new file mode 100644
index 0000000000..f9ec5b692a
--- /dev/null
+++ b/doc/tag-delete.svg
@@ -0,0 +1,10 @@
+<svg version="1.1" viewBox="0 0 16 16" xmlns="http://www.w3.org/2000/svg">
+ <style id="current-color-scheme" type="text/css">.ColorScheme-Text {
+ color:#232629;
+ }
+ .ColorScheme-NegativeText {
+ color:#da4453;
+ }</style>
+ <path class="ColorScheme-Text" d="m8 2-5.96875 0.03125-0.03125 5.96875 6 5.539062v-5.539062h5.539062zm-2.5 2c0.8284271 0 1.5 0.6715728 1.5 1.5s-0.6715729 1.5-1.5 1.5-1.5-0.6715728-1.5-1.5 0.6715729-1.5 1.5-1.5z" fill="currentColor"/>
+ <path class="ColorScheme-NegativeText" d="M 9.707031,9 9,9.707031 10.792969,11.5 9,13.292969 9.707031,14 11.5,12.207031 13.292969,14 14,13.292969 12.207031,11.5 14,9.707031 13.292969,9 11.5,10.792969 Z" fill="currentColor"/>
+</svg>
More information about the kde-doc-english
mailing list