[office/kmymoney] doc: Update currencies and tags chapters of handbook for 5.0
Thomas Baumgart
null at kde.org
Fri May 29 15:39:25 BST 2020
Git commit d2d353546d5e65b6019c89dd2e1ceb36e0896d1a by Thomas Baumgart, on behalf of Jack Ostroff.
Committed on 29/05/2020 at 14:39.
Pushed by tbaumgart into branch 'master'.
Update currencies and tags chapters of handbook for 5.0
M +15 -11 doc/details-currencies.docbook
M +32 -20 doc/details-tags.docbook
M +2 -2 doc/whatsnew.docbook
https://invent.kde.org/office/kmymoney/commit/d2d353546d5e65b6019c89dd2e1ceb36e0896d1a
diff --git a/doc/details-currencies.docbook b/doc/details-currencies.docbook
index 4a6bc1268..1c4140a9b 100644
--- a/doc/details-currencies.docbook
+++ b/doc/details-currencies.docbook
@@ -3,9 +3,10 @@
<chapterinfo>
<authorgroup>
<author> &Thomas.Baumgart; &Thomas.Baumgart.mail; </author>
+ <author>&Michael.Carpino; &Michael.Carpino.mail;</author>
</authorgroup>
- <date>2014-08-30</date>
- <releaseinfo>4.7.01</releaseinfo>
+ <date>2020-02-20</date>
+ <releaseinfo>5.0.8</releaseinfo>
</chapterinfo>
<title>Currencies</title>
@@ -20,11 +21,12 @@
<title>Base currency</title>
<para>
- Once you create a &kmymoney; file, you will be asked for the base currency. The
- base currency is the one that all income and expense categories use and that
- reports will be based on. Usually, the base currency is the currency you use
- in your country. If not otherwise selected, new accounts will use this
- currency as the default.
+ 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 setup 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.
</para>
<para>
@@ -71,10 +73,11 @@
<title>Account setup</title>
<para>
- If you create a new account you have the option to specify the currency in
- which it will be managed. The ledger for the account will then show all values
- in the selected currency. The new account wizard defaults this setting to the
- <link linkend="details.currencies.basecurrency">base currency</link>.
+ When you create a new account, you specify the currency in which it will be
+ managed. The New Account wizard defaults this setting to the <link
+ linkend="details.currencies.basecurrency">base currency</link>. If you
+ require a different currency, you need to select it during this initial setup.
+ The ledger for the account will then show all values in the selected currency.
</para>
</sect1>
@@ -167,3 +170,4 @@
</sect2>
</sect1>
</chapter>
+
diff --git a/doc/details-tags.docbook b/doc/details-tags.docbook
index 263747468..caf3289d8 100644
--- a/doc/details-tags.docbook
+++ b/doc/details-tags.docbook
@@ -3,25 +3,32 @@
<chapterinfo>
<authorgroup>
<author>&Cristian.Onet; &Cristian.Onet.mail;</author>
+ <author>&Michael.Carpino; &Michael.Carpino.mail;</author>
</authorgroup>
- <date>2014-08-30</date>
- <releaseinfo>4.7.01</releaseinfo>
+ <date>2020-02-06</date>
+ <releaseinfo>5.0.8</releaseinfo>
</chapterinfo>
<title>Tags</title>
<para>
- The Tags screen provides detailed information about all the tags which are
- applied to transactions. The Tags screen is split into two main
- areas: a tags list and a detail area.
+ The Tags View provides information about all the tags that have been added by
+ the user. The Tags screen is split into two main areas: a list of tags and a
+ detail area, which has two tabs: Transactions and Details. The
+ <guilabel>Transactions</guilabel> tab displays all the transactions associated
+ with the tag. The <guilabel>Details</guilabel> tab includes a user defined
+ color, as well as Notes, which are not used elsewhere. Note that if you
+ change the color, which is used in the symbol displayed before the tag name in
+ any associated transactions, you need to click the check button at the lower
+ right of the Details area for it to be saved.
</para>
<sect1 id="details.tags.list">
<title>Tags List</title>
<para>
- A list of tags is on the left side of this screen. The tags list
- is sorted alphabetically.
+ A list of all tags, sorted alphabetically, is displayed on the left side of
+ this screen.
<screenshot>
<mediaobject>
@@ -35,12 +42,15 @@
<sect2>
<title>Adding a Tag</title>
<para>
- To add a tag, either click on the Add tag icon
- <guiicon><inlinemediaobject><imageobject><imagedata
+ Creating a tag can be done by 1 of 3 different ways. First you can click on the
+ Add tag icon <guiicon><inlinemediaobject><imageobject><imagedata
fileref="list-add.png"/></imageobject></inlinemediaobject></guiicon> or
right-click on any tag and choose <guimenuitem>New tag</guimenuitem>. This
creates a new tag called <quote>New tag</quote>. Right-click on this tag and
select <guimenuitem>Rename tag</guimenuitem> to enter the name of the new tag.
+ Finally you can add a new tag directly into the ledger page or within a split
+ transaction by typing the name of the tag in the tag field. &kmymoney; will
+ ask if you want to add this tag and after selecting yes it will be added.
</para>
</sect2>
@@ -68,10 +78,10 @@
<note>
<para>
- As Tags have just been introduced to &kmymoney; in version 4.7, none of the
- methods for importing data are able to import tags. It is understood that
- this is an important feature, and each import method is likely to introduce
- it in an upcoming release.
+ As Tags were only introduced to &kmymoney; in version 4.7, none of the methods
+ for importing data are able to import tags. It is understood that this is an
+ important feature, and each import method is likely to introduce it in an
+ upcoming release.
</para>
</note>
</sect2>
@@ -125,22 +135,24 @@
</listitem>
<listitem>
<para>
- To modify the notes associated with the tag, just edit the text in the
- box.
+ Clicking the <guilabel>Closed</guilabel> checkbox will not alter any
+ transactions already associated with the tag, but it will prevent
+ assigning the tag to any additional transactions.
</para>
</listitem>
<listitem>
<para>
- Clicking the <guilabel>Closed</guilabel> checkbox will not alter any
- transactions already associated with the tag, but it will prevent
- assigning the tag to any additional transactions.
+ To modify the notes associated with the tag, just edit the text in the
+ box.
</para>
</listitem>
</itemizedlist>
<para>
- When you are done, don't forget to click the <guiicon>Update</guiicon> button, although you will
- be prompted if you leave the dialog without having done so.
+ When you are done, don't forget to click the <guiicon>Update</guiicon> button,
+ at the lower right of the window, although you will be prompted if you leave
+ the dialog without having done so.
</para>
</sect2>
</sect1>
</chapter>
+
diff --git a/doc/whatsnew.docbook b/doc/whatsnew.docbook
index ffa3e27e4..756724afa 100644
--- a/doc/whatsnew.docbook
+++ b/doc/whatsnew.docbook
@@ -82,6 +82,8 @@
<member><link linkend="firsttime">Using &kmymoney; for the first time</link></member>
<member><link linkend="details.institutions">Institutions</link></member>
<member><link linkend="details.accounts">Accounts</link></member>
+ <member><link linkend="details.categories">Categories</link></member>
+ <member><link linkend="details.tags">Tags</link></member>
<member><link linkend="details.payees">Payees</link></member>
<member><link linkend="details.reconcile">Schedules</link></member>
<member><link linkend="details.ledgers">Ledgers</link></member>
@@ -93,8 +95,6 @@
</entry>
<entry valign="top">
<simplelist>
- <member><link linkend="details.categories">Categories</link></member>
- <member><link linkend="details.tags">Tags</link></member>
<member><link linkend="details.currencies">Currencies</link></member>
<member><link linkend="details.reconcile">Reconciliation</link></member>
<member><link linkend="details.reports">Reports</link></member>
More information about the kde-doc-english
mailing list