[kde-doc-english] [kmymoney] doc: Add initial documentation for the tags feature.
Cristian Oneț
onet.cristian at gmail.com
Sat Aug 23 13:14:05 UTC 2014
Git commit fb824e2bf5e1ea9d81e0ccee34284b9e189bd6f7 by Cristian Oneț.
Committed on 23/08/2014 at 13:08.
Pushed by conet into branch 'master'.
Add initial documentation for the tags feature.
Also updated the what's new section.
A +103 -0 doc/details-tags.docbook
M +6 -3 doc/index.docbook
A +- -- doc/tag_details.png
A +- -- doc/tags.png
M +33 -32 doc/whatsnew.docbook
http://commits.kde.org/kmymoney/fb824e2bf5e1ea9d81e0ccee34284b9e189bd6f7
diff --git a/doc/details-tags.docbook b/doc/details-tags.docbook
new file mode 100644
index 0000000..cc7463d
--- /dev/null
+++ b/doc/details-tags.docbook
@@ -0,0 +1,103 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<chapter id="details.tags">
+<chapterinfo>
+ <authorgroup>
+ <author>&Cristian.Onet; &Cristian.Onet.mail;</author>
+ </authorgroup>
+ <date>2014-08-23</date>
+ <releaseinfo>4.7</releaseinfo>
+</chapterinfo>
+
+<title id="details.tags.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.
+</para>
+
+<para>
+ The Tags screen allows for viewing the transactions for the selected tag and
+ updating the tag's details.
+</para>
+
+
+<para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="tags.png" format="PNG" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+</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.
+</para>
+
+<sect2>
+<title>Adding a Tag</title>
+
+<para>
+ To add a tag, 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.
+</para>
+</sect2>
+
+<sect2>
+<title>Renaming a Tag</title>
+
+<para>
+ To rename a tag, simply right-click on the name, select
+ <guimenuitem>Rename tag</guimenuitem> and the name becomes
+ editable. Changing the name will affect the name in all the transactions in
+ which it appears.
+</para>
+</sect2>
+
+<sect2>
+<title>Deleting a Tag</title>
+
+<para>
+ To remove a tag, right-click the name and select
+ <guimenuitem>Delete tag</guimenuitem>. If the tag has any transactions,
+ you will be presented with a dialog that allows you to reassign them to a
+ different tag.
+</para>
+</sect2>
+
+</sect1>
+
+<sect1 id="details.tags.details">
+<title>Tag Details</title>
+
+<para>
+ To view and edit the information associated with a particular tag,
+ select the tag from the list and select the Details tab. To modify this
+ information, edit the detail area directly and press the Update button when
+ finished.
+</para>
+
+<para>
+<screenshot>
+ <screeninfo>The tag details tab</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="tag_details.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>Tag details</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
+</para>
+</sect1>
+
+</chapter>
diff --git a/doc/index.docbook b/doc/index.docbook
index 3eb941c..19295cf 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -18,9 +18,9 @@
<!ENTITY userlist "<email>kmymoney at kde.org</email>">
<!ENTITY olduserlist "<email>kmymoney2-user at lists.sourceforge.net</email>">
- <!-- the following author entities have been added to contributor.entities in 4.5 branch and trunk of svn
+ <!-- the following author entities have been added to contributor.entities in 4.5 branch and trunk of svn
they can be removed from this file once they are present in the kdelibs minimum version required by &kappname; -->
-
+
<!ENTITY Michael.T.Edwardes "<personname><firstname>Michael</firstname><othername>T.</othername><surname>Edwardes</surname></personname>">
<!ENTITY Michael.T.Edwardes.mail "<email>mte at users.sourceforge.net</email>">
@@ -57,7 +57,7 @@
<!ENTITY Cristian.Onet "<personname><firstname>Cristian</firstname><surname>Oneț</surname></personname>">
<!ENTITY Cristian.Onet.mail "<email>onet.cristian at gmail.com</email>">
- <!-- the following author entity has been added to contributor.entities in trunk and probably 4.6 branch of svn
+ <!-- the following author entity has been added to contributor.entities in trunk and probably 4.6 branch of svn
it can be removed from this file once it is present in the kdelibs minimum version required by &kappname; -->
<!ENTITY Allan.Anderson "<personname><firstname>Allan</firstname><surname>Anderson</surname></personname>">
@@ -98,6 +98,7 @@
<!ENTITY details-budgets SYSTEM "details-budgets.docbook">
<!ENTITY details-forecast SYSTEM "details-forecast.docbook">
<!ENTITY details-categories SYSTEM "details-categories.docbook">
+ <!ENTITY details-tags SYSTEM "details-tags.docbook">
<!ENTITY details-payees SYSTEM "details-payees.docbook">
<!ENTITY details-schedules SYSTEM "details-schedules.docbook">
<!ENTITY details-ledgers SYSTEM "details-ledgers.docbook">
@@ -154,6 +155,7 @@ and use `&George.N.Ugnacious; &George.N.Ugnacious.mail;' in the author element.
<year>2009</year>
<year>2010</year>
<year>2011</year>
+<year>2014</year>
<holder>The &kappname; Development Team</holder>
</copyright>
<!-- Translators: put here the copyright notice of the translation -->
@@ -221,6 +223,7 @@ consistent documentation style across all KDE apps. -->
&details-institutions;
&details-accounts;
&details-categories;
+&details-tags;
&details-payees;
&details-schedules;
&details-ledgers;
diff --git a/doc/tag_details.png b/doc/tag_details.png
new file mode 100644
index 0000000..f1d6188
Binary files /dev/null and b/doc/tag_details.png differ
diff --git a/doc/tags.png b/doc/tags.png
new file mode 100644
index 0000000..7060527
Binary files /dev/null and b/doc/tags.png differ
diff --git a/doc/whatsnew.docbook b/doc/whatsnew.docbook
index 3fe1057..a1513a0 100644
--- a/doc/whatsnew.docbook
+++ b/doc/whatsnew.docbook
@@ -14,65 +14,66 @@
</para>
<para>
- This is the second full release of &kappname; for KDE4. Many of the
- performance issues noticed with the 4.5 release have been resolved. The user
- interface has been further improved, and over 100 bugs have been eliminated.
-</para>
-
-<para>
Here are some of the new features found in this release:
</para>
<itemizedlist>
<listitem>
<para>
- <link linkend="firsttime.mainwindow">Runs natively on KDE4</link> and on
- all operating systems supported by KDE, with many improvements especially
- for the &MacOS; X and &Windows; platforms.
+ Transaction tags were added. This was long requested feature and allows an improved categorization of transaction.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Better performance of the user interface. Performance in general has been improved by fixing performance issues spotted using a profiler.
</para>
- </listitem>
+ </listitem>
<listitem>
<para>
- Better performance of the user interface. Performance in general has been
- improved, addressing the degradation that was introduced with the
- migration to KDE4.
+ Proper input methods support was added. &kappname; can now be safely used with languages that need input methods for easier use.
</para>
</listitem>
-
+
<listitem>
<para>
- Documentation and translations have been further improved.
+ Added a frozen column to improve visualizing forecast details. This way the account name won't be shifted out of the view when horizontally scrolling the forecast details.
</para>
- </listitem>
-
+ </listitem>
+
+ <listitem>
+ <para>
+ The application icons were improved.
+ </para>
+ </listitem>
+
<listitem>
<para>
Many improvements in the importing and online banking modules, including:
</para>
- </listitem>
+ </listitem>
<listitem>
<itemizedlist>
<listitem>
- <para>
- There is a new plugin to import csv files
- </para>
- </listitem>
+ <para>
+ The homepage can show accounts online banking status.
+ </para>
+ </listitem>
<listitem>
- <para>
- The payee name can now be based on either the PAYEEID, NAME, or MEMO
- field when importing a transaction via OFX direct connect
- </para>
+ <para>
+ OFX plugin now allows custom application version.
+ </para>
</listitem>
- </itemizedlist>
- </listitem>
- <listitem>
- <para>
- Improvements have been made to the database back end.
- </para>
+ <listitem>
+ <para>
+ There is a new plugin to export csv files.
+ </para>
+ </listitem>
+ </itemizedlist>
</listitem>
</itemizedlist>
More information about the kde-doc-english
mailing list