diff options
Diffstat (limited to 'doc')
150 files changed, 11089 insertions, 0 deletions
diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt new file mode 100644 index 0000000..314d65c --- /dev/null +++ b/doc/CMakeLists.txt @@ -0,0 +1,17 @@ +INCLUDE_DIRECTORIES( ${CMAKE_CURRENT_SOURCE_DIR} ${CMAKE_CURRENT_BINARY_DIR}) + +# Macro defined in FindMEINPROC.cmake handles building and installing +ADD_DOCS(kmymoney2 en) + +# Manpages we have to handle manually +SET(_in ${CMAKE_CURRENT_SOURCE_DIR}/en/kmymoney2.1) +SET(_out ${CMAKE_CURRENT_BINARY_DIR}/kmymoney2.1.gz) + +ADD_CUSTOM_COMMAND(OUTPUT ${_out} + COMMAND gzip + ARGS -9 -c -N ${_in} > ${_out} + DEPENDS ${_in}) +INSTALL(FILES ${_out} + DESTINATION ${MAN_INSTALL_DIR}/man1) +ADD_CUSTOM_TARGET(manpages ALL DEPENDS ${_out}) +ADD_DEPENDENCIES(documentation manpages) diff --git a/doc/Makefile.am b/doc/Makefile.am new file mode 100644 index 0000000..6063bd6 --- /dev/null +++ b/doc/Makefile.am @@ -0,0 +1,6 @@ +####### kdevelop will overwrite this part!!! (begin)########## + +SUBDIRS = en + +####### kdevelop will overwrite this part!!! (end)############ + diff --git a/doc/en/Makefile.am b/doc/en/Makefile.am new file mode 100644 index 0000000..e8c5bde --- /dev/null +++ b/doc/en/Makefile.am @@ -0,0 +1,160 @@ +KDE_OPTIONS = noautodist + +DOCBOOK_FILES = credits.docbook details-accounts.docbook details-categories.docbook details-files.docbook details-formats.docbook details-hbciofx.docbook details-impexp.docbook details-institutions.docbook details-integrity.docbook details-investments.docbook details-ledgers.docbook details-loans.docbook details-payees.docbook details-reconciliation.docbook details-reports.docbook details-schedules.docbook details-search.docbook details-settings.docbook details-transactions.docbook details-widgets.docbook firsttime.docbook index.docbook introduction.docbook otherdoc.docbook views-accounts.docbook views-categories.docbook views-home.docbook views-investments.docbook views-ledgers.docbook views-outbox.docbook views-payees.docbook views-schedules.docbook views-institutions.docbook views-reports.docbook whatsnew.docbook details-currencies.docbook reference.docbook details-database.docbook makemostof.docbook details-budgets.docbook details-forecast.docbook + +SCREENSHOT_FILES = accountdropdown.png accounts_view.png newacct.png accwiz1.png accwiz2.png accwiz3.png accwiz4.png accwiz5.png accwiz6.png accwiz7.png accwiz8.1.png accwiz8.2.png accwiz8.3.png accwiz8.4.png accwiz8.5.png accwiz9.png accwiz10.png calendarview.png categories.png categories_view.png categoryedit.png confirmenter.png default_prompt.png enterschedule.png finddlg.png home_view.png institutions_view.png investments_view.png kmt.png ledgers.png ledgers_view.png ledgerview-numbered.png mainwindow_numbered.png newfile.png newinst.png new.png newsched_numbered.png outbox_view.png payees_view.png payeeview.png qifopen.png reconcile.png reports_view.png schedcaltypes.png schedpopup.png schedule_view.png scheduleview.png tipofday.png transaction_find.png transactionform.png translist.png schedmonthday.png find-account.png find-amount.png find-category.png find-date.png find-details.png find-payee.png find-text.png payee_widget.png category_widget.png value_widget.png date_widget.png institution_view.png institution_options.png account_options.png account_edit.png payee_info.png payee_match.png payee_history.png split_transaction.png cleared_state.png transactionform-off.png ledger_more.png select_currency.png reconcile1.png reconcile2.png reconcile3.png reconcile4.png qif_report.png qifimportverify.png investment-transactionform.png investment-onlineupdate.png investment-currencywarning.png investment-exchangerateeditor.png gnucash-import_options.png gnucash-report.png gnucash-select_price_source.png currency_newpriceentry.png currency_priceeditor.png investments_summarytab.png qifimport-export.png qifimport-qifprofiledate.png qifimport-qifprofileeditor.png report_configuration-reporttab.png report_configuration-rowscolumns.png reports_view-all.png select_database.png budgets_view.png forecast_view.png newfile-2.png newfile-3.png newfile-4.png newfile-5.png newfile-6.png + +EXTRA_DIST = kmymoney2.1 $(DOCBOOK_FILES) + +MOSTLYCLEANFILES = index.cache.bz2 kmymoney2.1.gz index.xml *.aux *.tex *.log **.out *.pdf errorlog *.ps *.html online-manual.tar.bz2 + +BUILT_SOURCES = index.cache.bz2 kmymoney2.1.gz $(PDF_TARGET) + +CHARSET = +KDE_LANG = en +KDE_DOCS = kmymoney2 - $(DOCBOOK_FILES) $(SCREENSHOT_FILES) + +index.cache.bz2: $(DOCBOOK_FILES) $(KDE_XSL_STYLESHEET) $(SCREENSHOT_FILES) + if test -n "$(MEINPROC)"; then echo $(MEINPROC) --check --cache index.cache.bz2 --stylesheet $(KDE_XSL_STYLESHEET) $(srcdir)/index.docbook; $(MEINPROC) --check --cache index.cache.bz2 --stylesheet $(KDE_XSL_STYLESHEET) $(srcdir)/index.docbook; fi + +index.html: $(DOCBOOK_FILES) $(KDE_XSL_STYLESHEET) $(SCREENSHOT_FILES) + $(MEINPROC) --check --stylesheet `dirname $(KDE_XSL_STYLESHEET)`/kde-nochunk.xsl $(srcdir)/index.docbook --stdout | sed "s/ISO-8859-1/UTF-8/g" > index.html + +.PHONY: show preview get-files clear-files web +preview: index.html + +show: preview + konqueror index.html + +show-local-web: web + konqueror online-manual/index.html + +web: online-manual/index.xml + +online-manual/index.xml: $(DOCBOOK_FILES) $(SCREENSHOT_FILES) + if test -x $(abs_top_srcdir)/contrib/splitup-kde-chunk-online; then \ + rm -rf online-manual common; \ + mkdir online-manual; \ + mkdir common; \ + echo "Creating index.xml"; \ + $(MEINPROC) --check --stylesheet `dirname $(KDE_XSL_STYLESHEET)`/kde-chunk-online.xsl $(srcdir)/index.docbook -o online-manual/index.xml; \ + cd online-manual; \ + $(abs_top_srcdir)/contrib/splitup-kde-chunk-online; \ + cd ..; \ + make get-files; \ + for file in $(SCREENSHOT_FILES); do \ + cp $$file online-manual; \ + done; \ + make clear-files; \ + cp $(kde_libs_htmldir)/$(KDE_LANG)/common/* common; \ + fi; + +sf-username: + @if test -z $(SF_USER); then \ + echo "The environment variable SF_USER must be set to your"; \ + echo "SourceForge username and you must have write access"; \ + echo "to the project space before the upload will work."; \ + exit 1; \ + fi; + +web-upload: sf-username web ${PDF_TARGET} + if test -e common; then \ + echo "cd htdocs/common" > upload.batch; \ + echo "rm *" >> upload.batch; \ + echo lcd common >> upload.batch; \ + echo "mput *" >> upload.batch; \ + echo cd ../online-manual >> upload.batch; \ + echo "rm *" >> upload.batch; \ + echo lcd ../online-manual >> upload.batch; \ + echo "mput *.html" >> upload.batch; \ + echo "mput *.png" >> upload.batch; \ + if test "x$(PDF_TARGET)" != "x"; then \ + echo "lcd .." >> upload.batch; \ + echo "cd .." >> upload.batch; \ + echo "put $(PDF_TARGET)" >> upload.batch; \ + fi; \ + echo "Uploading manual files to web.sourceforge.net"; \ + sftp -b upload.batch $(SF_USER),kmymoney2@web.sourceforge.net; \ + rm -rf upload.batch; \ + fi; + +# if we're in a VPATH environment, we need to copy all files over +# to the build directory. Otherwise, we'll get into trouble. Of course +# we delete them afterwards. +get-files: + if test -n "$(VPATH)" ; then \ + if test x$(VPATH) != x.; then \ + for file in $(DOCBOOK_FILES); do \ + cp $(srcdir)/$$file .; \ + chmod +w $$file; \ + if test -n $(CHARSET); then \ + recode utf-8..$(CHARSET) $$file; \ + fi \ + done; \ + for file in $(SCREENSHOT_FILES); do \ + cp $(srcdir)/$$file .; \ + chmod +w $$file; \ + done; \ + fi \ + fi + +clear-files: + if test -n "$(VPATH)" ; then \ + if test x$(VPATH) != x.; then \ + for file in $(DOCBOOK_FILES) $(SCREENSHOT_FILES); do chmod +w $$file; rm $$file; done; \ + fi \ + fi + +if GENERATE_PDF +PDF_TARGET = kmymoney-user.pdf + +kmymoney-user.pdf: $(DOCBOOK_FILES) $(SCREENSHOT_FILES) + $(MAKE) get-files + $(MEINPROC) --check --stylesheet `dirname $(KDE_XSL_STYLESHEET)`/kde-nochunk.xsl $(srcdir)/index.docbook -o index.html; + recode utf8..latin1 index.html + html2ps -o kmymoney-user.ps -n index.html + ps2pdf kmymoney-user.ps kmymoney-user.pdf + rm index.html kmymoney-user.ps + $(MAKE) clear-files +endif + + + + +# The automatic KDE install installs some files, +# that we don't need, so we remove them immediately. +# Also install the man pages on this system +.PHONY: install-docs uninstall-docs + +install-data-hook: kmymoney2.1.gz install-docs + -rm -f $(DESTDIR)$(kde_htmldir)/$(KDE_LANG)/kmymoney2/kmymoney2.1 + $(mkinstalldirs) $(DESTDIR)$(mandir)/man1/ + $(INSTALL_DATA) kmymoney2.1.gz $(DESTDIR)$(mandir)/man1/kmymoney2.1.gz + +kmymoney2.1.gz: kmymoney2.1 + gzip -9 -c -N $(top_srcdir)/$(subdir)/kmymoney2.1 > kmymoney2.1.gz + +uninstall-hook: uninstall-docs + -rm -f $(DESTDIR)$(mandir)/man1/kmymoney2.1.gz + +# +# The following two rules are copied from an 'am_edit' generated +# version. Since we do not use the automatic generated version to +# avoid distribution of unwanted files, we add them here manually +# +install-docs: + $(mkinstalldirs) $(DESTDIR)$(kde_htmldir)/$(KDE_LANG)/kmymoney2 + @if test -f index.cache.bz2; then \ + echo $(INSTALL_DATA) index.cache.bz2 $(DESTDIR)$(kde_htmldir)/$(KDE_LANG)/kmymoney2/; \ + $(INSTALL_DATA) index.cache.bz2 $(DESTDIR)$(kde_htmldir)/$(KDE_LANG)/kmymoney2/; \ + elif test -f $(srcdir)/index.cache.bz2; then \ + echo $(INSTALL_DATA) $(srcdir)/index.cache.bz2 $(DESTDIR)$(kde_htmldir)/$(KDE_LANG)/kmymoney2/; \ + $(INSTALL_DATA) $(srcdir)/index.cache.bz2 $(DESTDIR)$(kde_htmldir)/$(KDE_LANG)/kmymoney2/; \ + fi + -rm -f $(DESTDIR)$(kde_htmldir)/$(KDE_LANG)/kmymoney2/common + $(LN_S) $(kde_libs_htmldir)/$(KDE_LANG)/common $(DESTDIR)$(kde_htmldir)/$(KDE_LANG)/kmymoney2/common + +uninstall-docs: + -rm -rf $(DESTDIR)$(kde_htmldir)/$(KDE_LANG)/kmymoney2 + + diff --git a/doc/en/account_edit.png b/doc/en/account_edit.png Binary files differnew file mode 100644 index 0000000..84eedc6 --- /dev/null +++ b/doc/en/account_edit.png diff --git a/doc/en/account_options.png b/doc/en/account_options.png Binary files differnew file mode 100644 index 0000000..539cad9 --- /dev/null +++ b/doc/en/account_options.png diff --git a/doc/en/accountdropdown.png b/doc/en/accountdropdown.png Binary files differnew file mode 100644 index 0000000..7f5117e --- /dev/null +++ b/doc/en/accountdropdown.png diff --git a/doc/en/accounts_view.png b/doc/en/accounts_view.png Binary files differnew file mode 100644 index 0000000..5e783de --- /dev/null +++ b/doc/en/accounts_view.png diff --git a/doc/en/accwiz1.png b/doc/en/accwiz1.png Binary files differnew file mode 100644 index 0000000..a409bf1 --- /dev/null +++ b/doc/en/accwiz1.png diff --git a/doc/en/accwiz10.png b/doc/en/accwiz10.png Binary files differnew file mode 100644 index 0000000..436e249 --- /dev/null +++ b/doc/en/accwiz10.png diff --git a/doc/en/accwiz2.png b/doc/en/accwiz2.png Binary files differnew file mode 100644 index 0000000..e649133 --- /dev/null +++ b/doc/en/accwiz2.png diff --git a/doc/en/accwiz3.png b/doc/en/accwiz3.png Binary files differnew file mode 100644 index 0000000..c90fc86 --- /dev/null +++ b/doc/en/accwiz3.png diff --git a/doc/en/accwiz4.png b/doc/en/accwiz4.png Binary files differnew file mode 100644 index 0000000..44dff8a --- /dev/null +++ b/doc/en/accwiz4.png diff --git a/doc/en/accwiz5.png b/doc/en/accwiz5.png Binary files differnew file mode 100644 index 0000000..86c09e2 --- /dev/null +++ b/doc/en/accwiz5.png diff --git a/doc/en/accwiz6.png b/doc/en/accwiz6.png Binary files differnew file mode 100644 index 0000000..6d2fa61 --- /dev/null +++ b/doc/en/accwiz6.png diff --git a/doc/en/accwiz7.png b/doc/en/accwiz7.png Binary files differnew file mode 100644 index 0000000..060e2e8 --- /dev/null +++ b/doc/en/accwiz7.png diff --git a/doc/en/accwiz8.1.png b/doc/en/accwiz8.1.png Binary files differnew file mode 100644 index 0000000..0044434 --- /dev/null +++ b/doc/en/accwiz8.1.png diff --git a/doc/en/accwiz8.2.png b/doc/en/accwiz8.2.png Binary files differnew file mode 100644 index 0000000..4d88f22 --- /dev/null +++ b/doc/en/accwiz8.2.png diff --git a/doc/en/accwiz8.3.png b/doc/en/accwiz8.3.png Binary files differnew file mode 100644 index 0000000..a717f44 --- /dev/null +++ b/doc/en/accwiz8.3.png diff --git a/doc/en/accwiz8.4.png b/doc/en/accwiz8.4.png Binary files differnew file mode 100644 index 0000000..d64d1e4 --- /dev/null +++ b/doc/en/accwiz8.4.png diff --git a/doc/en/accwiz8.5.png b/doc/en/accwiz8.5.png Binary files differnew file mode 100644 index 0000000..7475437 --- /dev/null +++ b/doc/en/accwiz8.5.png diff --git a/doc/en/accwiz9.png b/doc/en/accwiz9.png Binary files differnew file mode 100644 index 0000000..0eeb5db --- /dev/null +++ b/doc/en/accwiz9.png diff --git a/doc/en/budgets_view.png b/doc/en/budgets_view.png Binary files differnew file mode 100644 index 0000000..4330947 --- /dev/null +++ b/doc/en/budgets_view.png diff --git a/doc/en/calendarview.png b/doc/en/calendarview.png Binary files differnew file mode 100644 index 0000000..42af95b --- /dev/null +++ b/doc/en/calendarview.png diff --git a/doc/en/categories.png b/doc/en/categories.png Binary files differnew file mode 100644 index 0000000..bec37fd --- /dev/null +++ b/doc/en/categories.png diff --git a/doc/en/categories_view.png b/doc/en/categories_view.png Binary files differnew file mode 100644 index 0000000..6bcddd1 --- /dev/null +++ b/doc/en/categories_view.png diff --git a/doc/en/category_widget.png b/doc/en/category_widget.png Binary files differnew file mode 100644 index 0000000..e9b4a39 --- /dev/null +++ b/doc/en/category_widget.png diff --git a/doc/en/categoryedit.png b/doc/en/categoryedit.png Binary files differnew file mode 100644 index 0000000..3a0c5b1 --- /dev/null +++ b/doc/en/categoryedit.png diff --git a/doc/en/cleared_state.png b/doc/en/cleared_state.png Binary files differnew file mode 100644 index 0000000..9fa0e32 --- /dev/null +++ b/doc/en/cleared_state.png diff --git a/doc/en/confirmenter.png b/doc/en/confirmenter.png Binary files differnew file mode 100644 index 0000000..d3c9ece --- /dev/null +++ b/doc/en/confirmenter.png diff --git a/doc/en/credits.docbook b/doc/en/credits.docbook new file mode 100644 index 0000000..1bef155 --- /dev/null +++ b/doc/en/credits.docbook @@ -0,0 +1,179 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="credits"> +<chapterinfo> + <date>2009-08-10</date> + <releaseinfo>1.0</releaseinfo> +</chapterinfo> + +<title>Credits</title> + +<para> + Program Copyright © 2000, 2001, 2003, 2004, 2005, 2006, 2007, 2008, 2009 + The KMyMoney Development Team +</para> + +<para> + Documentation Copyright © 2000, 2001, 2003, 2004, 2005, 2006, 2007, 2008, + 2009 The KMyMoney Development Team +</para> + +<sect1 id="credits.original"> +<title>Original Author</title> + +<itemizedlist> + <listitem> + <formalpara> + <title>Michael Edwardes <mte@users.sourceforge.net></title> + <para> + Original idea, much intial source code. Project admin. + </para> + </formalpara> + </listitem> +</itemizedlist> +</sect1> + +<sect1 id="credits.active"> +<title>Active Developers</title> + +<itemizedlist> + <listitem> + <formalpara> + <title>Thomas Baumgart <ipwizard@users.sourceforge.net></title> + <para> + Release manager and de-facto Maintainer. Core Engine. Project Admin. + </para> + </formalpara> + </listitem> + + <listitem> + <formalpara> + <title>Tony Bloomfield <tonybloom@users.sourceforge.net></title> + <para>GnuCash Importer. Database support.</para> + </formalpara> + </listitem> + + <listitem> + <formalpara> + <title>Robert Wadley <robntina@users.sourceforge.net></title> + <para>Artist. Icons, splash screen, home view. Screen shots.</para> + </formalpara> + </listitem> + + <listitem> + <formalpara> + <title>Alvaro Soliverez <asoliverez@users.sourceforge.net></title> + <para>Forecast. Reports.</para> + </formalpara> + </listitem> + + <listitem> + <formalpara> + <title>Fernando Vilas <fvilas@users.sourceforge.net></title> + <para>Database support</para> + </formalpara> + </listitem> +</itemizedlist> + +</sect1> +<sect1 id="credits.past"> +<title>Developers of Previous Versions</title> + +<itemizedlist> + <listitem> + <formalpara> + <title>Ace Jones <acejones@users.sourceforge.net></title> + <para>Reports. OFX Import. Online Quotes. Documentation editor.</para> + </formalpara> + </listitem> + + <listitem> + <formalpara> + <title>Kevin Tambascio <ktambascio@users.sourceforge.net></title> + <para>Initial investment support</para> + </formalpara> + </listitem> + + <listitem> + <formalpara> + <title>Felix Rodriguez <frodriguez@users.sourceforge.net></title> + <para>Project admin</para> + </formalpara> + </listitem> + + <listitem> + <formalpara> + <title>John C <tacoturtle@users.sourceforge.net></title> + <para>Developer</para> + </formalpara> + </listitem> +</itemizedlist> +</sect1> + +<sect1 id="credits.special"> +<title>Special Thanks</title> + +<itemizedlist> + <listitem> + <formalpara> + <title>Javier Campos Morales <javi_c@users.sourceforge.net></title> + <para>Developer & Artist</para> + </formalpara> + </listitem> + + <listitem> + <formalpara> + <title>Laurent Montel <montel@kde.org></title> + <para>Patches</para> + </formalpara> + </listitem> + + <listitem> + <formalpara> + <title>Roger Lum <rogerlum@gmail.com></title> + <para>Documentation</para> + </formalpara> + </listitem> + + <listitem> + <formalpara> + <title>Darin Strait <darin.strait@ashdar-partners.com></title> + <para>Documentation</para> + </formalpara> + </listitem> + + <listitem> + <formalpara> + <title>Cristian Oneţ <onet.cristian@gmail.com></title> + <para>Patches and Plugins</para> + </formalpara> + </listitem> + + <listitem> + <formalpara> + <title>Allan Anderson <aganderson@ukonline.co.uk></title> + <para>Patches</para> + </formalpara> + </listitem> + + <listitem> + <formalpara> + <title>Colin Wright <cdwright@gwi.net></title> + <para>Patches and Documentation</para> + </formalpara> + </listitem> + + <listitem> + <formalpara> + <title>Jack Ostroff <ostroffjh@users.sourceforge.net></title> + <para>Documentation</para> + </formalpara> + </listitem> +</itemizedlist> + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> + +&underFDL; <!-- FDL: do not remove --> + +&underGPL; <!-- GPL License --> +</sect1> +</chapter> diff --git a/doc/en/currency_newpriceentry.png b/doc/en/currency_newpriceentry.png Binary files differnew file mode 100644 index 0000000..84af3c1 --- /dev/null +++ b/doc/en/currency_newpriceentry.png diff --git a/doc/en/currency_priceeditor.png b/doc/en/currency_priceeditor.png Binary files differnew file mode 100644 index 0000000..cd46ec9 --- /dev/null +++ b/doc/en/currency_priceeditor.png diff --git a/doc/en/date_widget.png b/doc/en/date_widget.png Binary files differnew file mode 100644 index 0000000..c811bd3 --- /dev/null +++ b/doc/en/date_widget.png diff --git a/doc/en/default_prompt.png b/doc/en/default_prompt.png Binary files differnew file mode 100644 index 0000000..6ae9168 --- /dev/null +++ b/doc/en/default_prompt.png diff --git a/doc/en/details-accounts.docbook b/doc/en/details-accounts.docbook new file mode 100644 index 0000000..a03811c --- /dev/null +++ b/doc/en/details-accounts.docbook @@ -0,0 +1,727 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="details.accounts"> +<chapterinfo> + <authorgroup> + <author> + <firstname>Michael</firstname> + <othername>T.</othername> + <surname>Edwardes</surname> + <affiliation> + <address><email>mte@users.sourceforge.net</email></address> + </affiliation> + </author> + <author> + <firstname>Roger</firstname> + <surname>Lum</surname> + <affiliation> + <address><email>rogerlum@gmail.com</email></address> + </affiliation> + </author> + </authorgroup> + <date>2009-08-10</date> + <releaseinfo>1.0</releaseinfo> +</chapterinfo> + +<title id="details.accounts.title">Accounts</title> + +<sect1 id="details.accounts.view"> +<title>The Accounts View</title> + +<para> + The Accounts View provides a summary of all the accounts. There are four + different account categories: Asset, Liability, Income, and Expense. Typical + asset accounts include bank accounts, cash, and investments, while typical + liability accounts include credit cards and loans. +</para> + +<para> + There are two ways to view the accounts: List or Icon view, which may be + selected by clicking on the appropriate tab at the top of the view. +</para> + +<para> + In the List view, the accounts are grouped under four headings: Asset, + Liability, Income, and Expense. List view shows the name and balance or value + of each account. Income and Expense list the categories that each transaction + is filed under, and provide similar functionality to the Categories + screen. The options and features involving Income and Expense accounts are + described in detail in the <link + linkend="details.categories">Categories</link> chapter. The rest of this + chapter will focus on Asset and Liability account functionality. +</para> + +<para> + In the Icon view, the Asset and Liability accounts are shown with icons + indicating the account type. &kappname; initially places the icons + alphabetically, but you can move the icons to any position you want, just by + dragging the icon with the mouse. Note, however, that just moving an icon + does not currently trigger &kappname; to think that any data has been changed. + This means that you need to make some other change, such as editing an account + or a transaction and saying OK (even without actually changing any data) so + &kappname; allows you to save the file. The saved file will include the new + icon positions. +</para> +</sect1> + +<sect1 id="details.accounts.create"> +<title>Creating an Account</title> + +<para> + <emphasis> + NOTE: 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 create a <link + linkend="firsttime-3">new file</link>. + </emphasis> +</para> + +<para> + To create a new account, you can either select + <menuchoice><guimenu>Account</guimenu><guimenuitem>New + account...</guimenuitem></menuchoice> from the menu or choose the + <guiicon><inlinemediaobject><imageobject><imagedata fileref="newacct.png" + format="PNG"/></imageobject><textobject> + <phrase>New</phrase></textobject></inlinemediaobject></guiicon> icon from the + toolbar. +</para> + +<para> + Alternatively, to create an account using the accounts view, click on the + Accounts icon in the view selector and then right click on the Asset tree icon + in the right hand view and select <guimenuitem>New account...</guimenuitem> + from the popup menu. The Asset tree holds all of your accounts that are an + asset. Assets, and all the other account types, are discussed in more detail + later in this manual. +</para> + +<sect2 id="details.accounts.create.institution"> +<title>The Institution (Bank) name</title> + +<para> + <screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="accwiz1.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Account Wizard</phrase> + </textobject> + </mediaobject> + </screenshot> +</para> + +<para> + The first step involves selecting an institution for the account. If this is + an account for an institution you have already created, you can select the + institution from the dropdown list. If you want to create a new institution, + click on the <guibutton>New Institution</guibutton> button. This will bring + up the New Institution Dialog, as described in the previous section. If this + is not a bank account, or if you do not want to use online banking, you do not + need to specify an institution. +</para> + +<para> + The Account Number and the <acronym><ulink + url="http://en.wikipedia.org/wiki/International_Bank_Account_Number">IBAN + (International Bank Account Number)</ulink></acronym> are not currently used + by &kappname;. These fields may be left blank and filled in at a later time; + they are only required for online banking. +</para> + +<para> + To proceed to the next step click on <guibutton>Next</guibutton>. +</para> +</sect2> + +<sect2 id="details.accounts.create.account"> +<title>Account</title> + +<para> + <screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="accwiz2.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Account Wizard</phrase> + </textobject> + </mediaobject> + </screenshot> +</para> + +<para> + This page is used to configure the type of account. +</para> + +<para> + First, enter a name for the account. This name will be used to identify it. +</para> + +<para> + Next, select the type of account from one of the types available from the + dropdown list: +</para> + +<variablelist> + <varlistentry> + <term>Checking</term> + <listitem> + <para> + A normal checking account, the type you get with any bank or credit union. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Savings</term> + <listitem> + <para> + A normal savings account, the type you get with any bank or credit union. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Credit Card</term> + <listitem> + <para> + An account to represent your credit card. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Cash</term> + <listitem> + <para> + A general purpose account, typically used for accounts not held at a + bank, such as the cash in your wallet. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Loan</term> + <listitem> + <para> + An account to manage a loan for money either borrowed or lent. With a + Loan account &kappname; automatically calculates interest payments to + help you track the remaining principal on the loan. Loans with no + interest might use the plain Asset or Liability type below, depending on + whether the money is lent or borrowed. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Investment</term> + <listitem> + <para> + An account to manage an investment such as stocks or investment funds. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Asset</term> + <listitem> + <para> + An account to manage an asset that does not fit in one of the above types. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Liability</term> + <listitem> + <para> + An account to manage a liability such as money you borrowed or a future + expense. If interest needs to be calculated, you might be better using + the Loan type above. + </para> + </listitem> + </varlistentry> +</variablelist> + +<para> + Select the currency to be used for the account from the dropdown list. +</para> + +<para> + Enter the date the account was opened or select it from the calendar using the + icon to the right. +</para> + +<para> + Enter the opening balance for the account. If this is an existing bank account + this information can be found on your statement. If it is a new account, the + opening balance can be left at zero. +</para> + +<para> + Selecting the <emphasis>Preferred Account</emphasis> check box will allow + preferred access in some dialogs and views of &kappname;. +</para> + +<para> + To proceed to the next step click on Next. +</para> +</sect2> + +<sect2> +<title>Credit Card Accounts</title> + +<para> + When creating a Credit Card account, you can optionally have &kappname; create + a <link linkend="details.schedules">scheduled transaction</link> for you. +</para> + +<para> + <screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="accwiz6.png" format="PNG" /> + </imageobject> + + <textobject> + <phrase>Account Wizard</phrase> + </textobject> + </mediaobject> + </screenshot> +</para> + +<para> + If you want such a transaction generated, make sure the tick box is checked + and enter the required information. +</para> + +<para> + Click on <guibutton>Next</guibutton> to continue. +</para> +</sect2> + +<sect2> +<title>Investment Accounts</title> + +<para> + For Investment accounts, you have the option to create an associated Brokerage + account. For more information see <link + linkend="details.investments">Investments</link> +</para> + +<para> + <screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="accwiz7.png" format="PNG" /> + </imageobject> + + <textobject> + <phrase>Account Wizard</phrase> + </textobject> + </mediaobject> + </screenshot> +</para> +</sect2> + +<sect2> +<title>Loan Accounts</title> + +<para> + Loan accounts are special accounts used to help you manage Loans with interest + and scheduled repayments. By providing &kappname; with information about the + loan, &kappname; can help you track interest payments and the remaining + principal of the loan. +</para> + +<para> + <screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="accwiz8.1.png" format="PNG" /> + </imageobject> + + <textobject> + <phrase>Account Wizard</phrase> + </textobject> + </mediaobject> + </screenshot> +</para> + +<para> + On the Details page you enter the general information about the loan. +</para> + +<para> + First, select whether you are borrowing or lending money. If you are + borrowing money the loan will be listed in Accounts under Liabilities. If you + are lending money the loan will be listed under Assets. +</para> + +<para> + Next, select the payee or payer of the loan. As always, if the name doesn't + yet exist in the Payees list, enter it here and &kappname; will create it for + you. +</para> + +<para> + The next three items are for handling Loans on which you've already made + payments. If you select Yes in the "Have you made/received any payments yet?" + item you can then select whether you want to record all payments or just those + from the beginning of the current year. If you want to record from the + beginning of the current year, you are than asked to input the current + balance. +</para> + +<para> + Then, select how often payments will be made and how often interest is + compounded. Compounding is where the interest is added to the amount owed on + the loan so that when the interest is next calculated there will be more + interest paid on the interest. It's common for interest to be compounded at + the same frequency that payments are made. +</para> + +<para>Next, enter the date the first recorded payment will be made. +</para> + +<para> + Finally, enter information about how the interest rate varies. If the loan is + fixed-rate there is nothing to do. If the rate varies, select Variable in + "Type of interest rate" and then enter the interval between interest rate + changes and the date the first change of interest rate is due: &kappname; will + ask you to update the interest rate when that date arrives. +</para> + +<para> + <screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="accwiz8.2.png" format="PNG" /> + </imageobject> + + <textobject> + <phrase>Account Wizard</phrase> + </textobject> + </mediaobject> + </screenshot> +</para> + +<para> + The Payments page is where you enter the payment and interest values for the + loan. +</para> + +<para> + First, select whether the interest rate is calculated when the payment is + received or when it becomes due. If you don't know, leave it on the default + value. +</para> + +<para> + Next, enter the following values: +</para> + +<variablelist> + <varlistentry> + <term>Loan amount</term> + <listitem> + <para> The amount of the loan.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Interest rate</term> + <listitem> + <para>The annual percentage interest rate of the loan.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Term</term> + <listitem> + <para> + The length of the loan. Enter a number and select either Months or + Years. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Payment (principal and interest)</term> + <listitem> + <para> + The amount paid for each loan payment. This is the total of the + principal and interest paid with each payment. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Balloon payment</term> + <listitem> + <para> + Additional final payment made at the end of the term to pay off the + remaining principal of the loan. For a repayment loan this is often + zero. For an interest-only loan this will be the same as the loan + amount. + </para> + </listitem> + </varlistentry> +</variablelist> + +<para> + Finally, use the <guibutton>Calculate</guibutton> button to check the values + you have entered. You must have entered either all or all but one of the + values listed above. If you omit two or more values the button is disabled + because it is not possible to check that the entered values are consistent: in + that case you will not be able to use the Loan account facility in &kappname; + and will instead have to use a Liability or Asset account to track the loan + manually. +</para> + +<para> + If you omit one value &kappname; will try to calculate it for you. If you + have entered all values &kappname; will check the values are consistent. + &kappname; will not adjust entered values other than the "Balloon payment", + which it may adjust slightly to deal with rounding. If the values are + inconsistent or &kappname; cannot calculate the omitted value &kappname; will + let you know so that you can correct any errors and repeat the calculation. +</para> + +<para> + Once the values are consistent the <guibutton>Next</guibutton> button is + enabled and you can advance to the next page. +</para> + +<para> + <screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="accwiz8.3.png" format="PNG" /> + </imageobject> + + <textobject> + <phrase>Account Wizard</phrase> + </textobject> + </mediaobject> + </screenshot> +</para> + +<para> + The Fees page is where you can enter any fees added to the loan payments. +</para> + +<para> + If there are any fees press the <guibutton>Additional Fees</guibutton> button. + The Transaction Split editor will be displayed for entry of the fees. Any + lines added here will be included in the payment schedule for the loan. When + you save the splits the Fees page will display the principal and interest + payment, the total additional fees and the total periodic payment. +</para> + +<para> + <screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="accwiz8.4.png" format="PNG" /> + </imageobject> + + <textobject> + <phrase>Account Wizard</phrase> + </textobject> + </mediaobject> + </screenshot> +</para> + +<para> + &kappname; will create a <link linkend="details.schedules">scheduled + transaction</link> for your loan. The Schedule page is where you enter the + remaining details needed to create the schedule. +</para> + +<para> + First enter the Category to which loan interest will be assigned. Then enter + the account from which the loan payment will be made. +</para> + +<para> + The page also displays the first payment date for which the Schedule will be + created. +</para> + +<para> + <screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="accwiz8.5.png" format="PNG" /> + </imageobject> + + <textobject> + <phrase>Account Wizard</phrase> + </textobject> + </mediaobject> + </screenshot> +</para> + +<para> + Optionally, &kappname; can create a transaction representing what was received + or paid when the loan was created. +</para> + +<para> + If you borrowed or lent cash select the account from which or to which the + loan amount was paid. +</para> + +<para> + If you borrowed money to purchase a car you can select or create an Asset + account to help you track the value of the new car. +</para> + +<para> + If you re-financed an existing Loan check the "Refinance existing loan" + checkbox, select the Loan account and &kappname; will create a transfer + transaction paying off the existing loan. +</para> + +<para> + If you don't want to create the payout transaction, check the "Do not create + transaction" checkbox. +</para> +</sect2> + +<sect2 id="details.accounts.create.parent"> +<title>Parent Account</title> + +<para> + <screenshot> + <screeninfo>Parent Account</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="accwiz10.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Account Wizard</phrase> + </textobject> + </mediaobject> + </screenshot> +</para> + +<para> + This is the penultimate step in creating a new account. A tree of accounts is + displayed. The tree will be of your Asset or Liability accounts, depending on + the type of account that is being created. +</para> + +<para> + Select the account you wish contain the new account. If you do not select a + parent account, the new account will be created at the top level. +</para> + +<para> + The Parent Account page is not currently shown for Loans because they cannot + be created as sub-accounts. Also, Investment accounts cannot contain other + accounts so they are not shown in the tree. +</para> +</sect2> + +<sect2> +<title>Review and save the account details</title> + +<para> + <screenshot> + <screeninfo>Review</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="accwiz9.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Account Wizard</phrase> + </textobject> + </mediaobject> + </screenshot> +</para> + +<para> + This is the final step in creating a new account. A summary of the information + entered is displayed. Review it, and if everything is OK press the Finish + button. Otherwise, either press the <guibutton>Back</guibutton> button to make + corrections or the Cancel button to abandon creating a new account. +</para> + +<para> + NOTE: The Type and Currency cannot at present be changed after the account is created. +</para> +</sect2> +</sect1> + +<sect1 id="details.accounts.viewing"> +<title>Opening / viewing accounts</title> + +<para> + To open an account in the Ledger view you can either click on the link to the + account from the Home view, or click on the <guiicon><inlinemediaobject> + <imageobject> <imagedata fileref="ledgers_view.png" /> </imageobject> + </inlinemediaobject>Ledgers</guiicon> icon in the view selector and select the + account in the drop down box at the top of the view. Alternatively, in the + <guiicon>Account</guiicon> view, either double-click the account entry or + right click and select <guimenuitem>Open ledger</guimenuitem>. +</para> +</sect1> + +<sect1 id="details.accounts.edit"> +<title id="details.accounts.edit.title">Editing Account Information</title> + +<para> + To edit a particular account, right-click that account and choose + <guimenuitem>Edit account...</guimenuitem>. A details window will pop-up. + This window allows you to change the name and start date of the account, + associated banking institution, and the parent account. Changing the parent + account is also possible in the main Accounts screen, by dragging the account + and dropping it on a different parent account. In this window, you can also + create a new banking institution and associate the account with that + institution. +</para> + +<para> + <screenshot> + <screeninfo>Edit an account</screeninfo> + + <mediaobject> + <imageobject> + <imagedata fileref="account_edit.png" format="PNG" /> + </imageobject> + + <textobject> + <phrase>Edit account information</phrase> + </textobject> + </mediaobject> + </screenshot> +</para> +</sect1> + +<sect1 id="details.accounts.delete"> +<title>Deleting accounts</title> + +<para> + To delete an account, first remove all the transactions from that account in + the ledger. Next, find the account in the accounts view and after right + clicking on the entry to show the popup menu select <guimenuitem>Delete + account...</guimenuitem> from the popup menu. +</para> + +<para> + If you are unable to delete an account which looks like it has no transactions + in it, check your filter. See <menuchoice> <guimenu>Settings</guimenu> + <guimenuitem>Configure KMyMoney</guimenuitem> + <guimenuitem>General</guimenuitem> <guimenuitem>Filter</guimenuitem> + </menuchoice>. Clear all filters. Set the start date to 1.1.1900 or so. +</para> + +<para> + There may be transactions in your ledger that are not shown, for example, if + you have inadvertently typed in the wrong year when making an entry so that an + entry remains outside the opening date of &kappname;. This appears beneath the + ledger page as remaining funds. +</para> +</sect1> +</chapter> diff --git a/doc/en/details-budgets.docbook b/doc/en/details-budgets.docbook new file mode 100644 index 0000000..d51deeb --- /dev/null +++ b/doc/en/details-budgets.docbook @@ -0,0 +1,406 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="details.budgets"> +<chapterinfo> + <authorgroup> + <author> + <surname>Colin Wright <cdwright@gwi.net></surname> + </author> + </authorgroup> + <date>2009-08-03</date> + <releaseinfo>1.0</releaseinfo> +</chapterinfo> + +<title id="details.budgets.title">Budgets</title> +<sect1 id="details.budgets.define"> +<title>What is a budget?</title> + +<para> + A budget is a categorized list of expected income and expenses for a period. +</para> + +<para> + The Budget facility of &kappname; allows you to create annual budgets. More + than one Budget can be created for any year. You set monthly Budget values + against any Income or Expense categories that you have defined. The values can + be set in three ways, depending on the Period: +</para> + +<variablelist> + <varlistentry> + <term>Monthly</term> + <listitem><para>(Default) specify a single value applied to every month in + the Budget</para></listitem> + </varlistentry> + + <varlistentry> + <term>Yearly</term> + <listitem><para>specify a single value to divide evenly across each month in + the Budget</para></listitem> + </varlistentry> + + <varlistentry> + <term>Individual</term> + <listitem><para>specify separate values for each month.</para> + <para>This is used for income and expenses spread irregularly through the + year.</para></listitem> + </varlistentry> +</variablelist> + +<para> + &kappname; provides a number of reports which compare actual income and + expenses against the entered Budgets. +</para> +</sect1> + +<sect1 id="details.budgets.create" > +<title>Your budgets</title> + +<para> + You can access your budgets by clicking the appropriate icon in the navigation + pane at the left hand side of your &kappname; window. +</para> + +<sect2> +<title>Creating, changing, and deleting budgets</title> + +<para> + This section of the Budgets window displays the list of Budgets contained in + the current file. If no Budget has yet been created the list will display a + single empty Budget called "Budget <year>" where <year> is the + current fiscal year. The list of Budgets has two columns: +</para> + +<variablelist> + <varlistentry> + <term>Name</term> + <listitem> + <para>Name of the Budget</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Year</term> + <listitem> + <para>Fiscal year of the Budget</para> + </listitem> + </varlistentry> +</variablelist> + +<para> + Values from the selected Budget are displayed to the right. To select a + different Budget you can click on the Budget in the list. Alternatively, when + the list has focus, you can select a different Budget using the up and down + keys. If you have made changes to a Budget and then select a different budget + &kappname; will ask you whether you want to discard the changes. +</para> + +<para> + There are five buttons above the list of Budgets. +</para> + +<variablelist> + <varlistentry> + <term>New</term> + <listitem> + <para>Create a new budget</para> + </listitem> + </varlistentry> + + <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 clicking on the name of + the selected Budget or double-clicking on the name of a different + Budget.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Delete</term> + <listitem> + <para>Delete the selected Budget</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Revert</term> + <listitem> + <para>Reverts the selected Budget to its last stored state.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Save</term> + <listitem> + <para>Accepts any unsaved changes to the selected Budget and + stores them.</para> + </listitem> + </varlistentry> +</variablelist> + +<para> + Additional options are available on a menu accessed by right-clicking on a + Budget. +</para> + +<variablelist> + <varlistentry> + <term>New Budget</term> + <listitem> + <para>Create a new, blank Budget.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Rename Budget</term> + <listitem> + <para>Rename the selected Budget.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Change budget year</term> + <listitem> + <para>Displays a window with a list of years to select a different budget + year.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Delete budget</term> + <listitem> + <para>Delete the selected Budget.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Copy budget</term> + <listitem> + <para>Creates a copy of the selected Budget. The new Budget has the name + "Copy of <budget>", where <budget> is the name of the copied + Budget.</para> + </listitem> + </varlistentry> +</variablelist> +</sect2> + +<sect2> +<title>Account List</title> + +<para> + The Account List displays the list of Income and Expense Categories. As in + other places in &kappname; the list is organized in a tree structure. The list + can be expanded or collapsed to show or hide Subcategories within a + Category. The Account List has a number of columns:</para> + +<variablelist> + <varlistentry> + <term>Account</term> + <listitem> + <para>Account name</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Type</term> + <listitem> + <para>Account Type (Income or Expense)</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Tax</term> + <listitem> + <para>Checked if a Category included in Tax Reports</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>VAT</term> + <listitem> + <para>Checked if a Category marked as a VAT Category</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Balance</term> + <listitem> + <para>Current balance of Account. Blank for Categories</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Value</term> + <listitem> + <para>Total yearly value in the Budget. If an Account has Subaccounts and + the Account's list of Subaccounts is collapsed the value displayed is + the sum of the values for the Account and all of its Subaccounts.</para> + </listitem> + </varlistentry> +</variablelist> + +<para> + The Account List can be filtered using "Hide unused Categories". In Budgets + this hides any Categories for which no value has been assigned to the Category + or any of its Subcategories. +</para> +</sect2> + +<sect2> +<title>Assignments</title> + +<para> + The Assignments area shows the value for the selected Account. +</para> + +<variablelist> + <varlistentry> + <term>Account</term> + <listitem> + <para>Displays the name of the selected Account. If the Account is a + Subaccount, the full name of the selected Account is displayed in the + Account:Subaccount format.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Total</term> + <listitem> + <para>Displays the total yearly value assigned to the Account</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Include subaccounts</term> + <listitem> + <para>In Reports show actual income or expenses in Subcategories belonging + to the Category against the Category instead of the Subcategory.</para> + + <para>If a Subcategory has a value defined in the Budget the income and + expenses are shown against the Subcategory.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Clear</term> + <listitem> + <para>The Clear button resets the budgeted account value or values to + zero.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Period</term> + <listitem> + <para>The Period radio buttons allow you to select the period for which + the value applies</para> + + <variablelist> + <varlistentry> + <term>Monthly</term> + <listitem> + <para>A single value is entered, specifying the amount per + month. This is the default setting.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Yearly</term> + <listitem> + <para>A single value is entered, specifying the amount per + year.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Individual</term> + <listitem> + <para>Values are specified for each Calendar month. This is used + where expense or income is spread irregularly through the + year.</para> + </listitem> + </varlistentry> + </variablelist> + + <para> + If a value is or values are already specified and the Period is changed + &kappname; will ask whether to use the current total yearly value to + assign the new values. + </para> + </listitem> + </varlistentry> +</variablelist> + +</sect2> + +<sect2> +<title>Update and Revert</title> + +<para> + For performance reasons, changes made to a Budget are not saved + immediately. Instead, they first have to be stored using the Update button and + then permanently saved using the &kappname; Save. +</para> + +<para> + When a Budget's values are first modified, the Update and Revert buttons are + enabled. Multiple changes can be made to the Budget. Pressing Update will + store the changes, disable the Update and Revert buttons and enable the + &kappname; Save. +</para> + +<para> + The &kappname; Save only saves changes that have been stored using the Update + button. Thus, if you have modified a Budget but not yet stored the changes + &kappname; Save will not affect the modified Budget and the Update and Revert + buttons remain enabled. +</para> + +<para> + Revert undoes any changes made to a Budget since the last Update and disables + the Update and Revert buttons. +</para> + +<para> + Changes stored using Update but not yet saved using &kappname; Save can only + be reverted by reloading the &kappname; file. +</para> +</sect2> +</sect1> + +<sect1 id="budget.details.reports"> +<title>Budget Reports</title> + +<para> + &kappname; provides a number of reports to compare actual income and expenses + against Budgets. These are listed in Reports under "Budgeting". There are two + types of Reports: +</para> + +<variablelist> + <varlistentry> + <term>Budget only</term> + <listitem><para>Reports displaying values from a Budget: Monthly Budget + Displays the monthly values from a Budget. Yearly Budget Displays the + monthly values from a Budget, with yearly total.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Compare Budget and Actual</term> + <listitem><para>Reports comparing values from a Budget to actual income and + expenses: Budget vs. Actual This Year Month-by-month comparison for the + current year so far, with total. Monthly Budget vs. Actual Month-by-month + comparison, defaulting to the current month. Yearly Budgeted vs. Actual + Month-by-month comparison for the whole of the current year, with + total. These reports provide a base from which custom reports can be + created by changing the date range and Budget. Of the Budget reports, only + the "Budget vs. Actual This Year" does not allow the Budget to be + changed.</para> + </listitem> + </varlistentry> +</variablelist> +</sect1> +</chapter> diff --git a/doc/en/details-categories.docbook b/doc/en/details-categories.docbook new file mode 100644 index 0000000..80f26ea --- /dev/null +++ b/doc/en/details-categories.docbook @@ -0,0 +1,153 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="details.categories"> +<chapterinfo> + <authorgroup> + <author> + <firstname>Roger</firstname> + <surname>Lum</surname> + <affiliation><address><email>rogerlum@gmail.com</email></address></affiliation> + </author> + </authorgroup> + <date>2009-06-04</date> + <releaseinfo>1.0</releaseinfo> +</chapterinfo> + +<title id="details.categories.title">Categories</title> + +<para> + The Categories screen provides a summary of all the existing categories under + which transactions are filed. The categories are split into income and + expense, and a balance is displayed for each category. +</para> + +<para> + <screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="categories.png" format="PNG" /> + </imageobject> + </mediaobject> + </screenshot> +</para> + +<sect1 id="details.categories.create"> +<title>Creating categories</title> + +<para> + To create a new category, either select <guimenu>Category</guimenu> + <guimenuitem>New category</guimenuitem> in the menu, or in the Categories + view, select a parent in the tree, right click and select the <guimenuitem>New + Category</guimenuitem> option. Either way will open the Create new categories + wizard. Enter the new category name, and select the currency if the default + shown is not correct. In the Hierarchy tab, ensure the required parent + account is selected. Finally, in the Tax tab, there is a check box to enable + VAT support, and a check box to include this category in certain tax related + reports. +</para> + +<para> + <screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="categoryedit.png" format="PNG" /> + </imageobject> + </mediaobject> + </screenshot> + </para> + +<para> + Enter the category name any notes and click on <guibutton>OK</guibutton> to + save the new category. To create a complete hierarchy of accounts, separate + the names by colons (:) as in <emphasis>Bills:Car:Gasoline</emphasis>. +</para> +</sect1> + +<sect1 id="details.categories.edit"> +<title id="details.categories.edit.title">Editing a Category</title> + +<para> + To edit a category, right-click on a category name, and choose + <guimenuitem>Edit category</guimenuitem>. A window comes up with three tabs: + General, Hierarchy and Tax. +</para> + +<para> + The General tab allows you to edit the name of the category and any notes you + entered when you created the category. +</para> + +<para> + The Hierarchy tab allows you to change the parent category. You can also + change the parent category from the main category page by dragging the + category to a different parent. +</para> + +<para> + The Tax tab allows you to assign or change VAT category, or alter the + automatic VAT assignment. It also allows you to toggle whether or not the + category is included in certain tax related reports. +</para> +</sect1> + +<sect1 id="details.categories.vat"> +<sect1info> + <author> + <firstname>Thomas</firstname> + <surname>Baumgart</surname> + <affiliation> + <address><email>ipwizard@users.sourceforge.net</email></address> + </affiliation> + </author> +</sect1info> + +<title>VAT Support</title> + +<para> + You can turn an expense/income category into a VAT category, which means that + it receives all the splits that actually make up the VAT payment towards the + government. You can also enter a specific percentage rate. entered. +</para> + +<para> + Categories can be assigned a VAT category, which allows KMyMoney to split a + transaction for a category into two parts, one for the category and one for + the VAT. Depending on the setting of the gross/net amount switch, the amount + you enter for the transaction is the gross or net amount. +</para> + +<para> + Example: In Germany, there are three VAT percentages (0%, 7%, and 19%). So I + have a main category "VAT paid" and three subcategories, one for each + percentage rate. I create these on both the income and the expense sides so + that I have eight categories in total. For the goods I buy, I select one of + the above mentioned categories as the "VAT category assignment". +</para> + +<para> + When I buy goods, I enter them into a transaction. Let's assume I have + selected the gross amount entry method, once I enter the category and amount, + KMyMoney will recognize that there's a VAT assignment and calculate the VAT + part, create a second split with the VAT account and VAT amount and reduce the + category amount. +</para> + +<para> + The same applies to income categories but the other way around. Hope that + makes sense. +</para> + +</sect1> + +<sect1 id="details.categories.delete"> +<title>Deleting categories</title> + +<para> + To delete a category, select it in the tree, right click to bring up the popup + menu, and select <guimenuitem>Delete</guimenuitem>. If there are any + transactions assigned to this category, a popup will allow you to move these + to another parent category. If you try to delete a parent category, a dialog + allows the choice of either having the sub-categories moved up one level or + alternatively having them all deleted at the same time. +</para> +</sect1> +</chapter> diff --git a/doc/en/details-currencies.docbook b/doc/en/details-currencies.docbook new file mode 100644 index 0000000..887de0f --- /dev/null +++ b/doc/en/details-currencies.docbook @@ -0,0 +1,150 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="details.currencies"> +<chapterinfo> + <authorgroup> + <author> + <firstname>Thomas</firstname> + <surname>Baumgart</surname> + <affiliation> + <address><email>ipwizard@users.sourceforge.net</email></address> + </affiliation> + </author> + </authorgroup> + <date>2009-05-05</date> + <releaseinfo>1.0</releaseinfo> +</chapterinfo> + +<title>Currencies</title> + +<para> + &kappname; supports the use of multiple currencies in different accounts. For + example, you can set up a bank account in Euro, another in British Pounds, and + still have your credit card account in US Dollars. +</para> + +<sect1 id="details.currencies.basecurrency"> +<title>Base currency</title> + +<para> + Once you create a &kappname; 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. +</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> +</para> +</sect1> + +<sect1 id="details.currencies.accountsetup"> +<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>. +</para> +</sect1> + +<sect1 id="details.currencies.transactions"> +<title>Entering transactions using different currencies</title> + +<para> + Whenever a transaction is entered that refers to more than one currency, the + exchange rate editor pops up and allows you to enter an exchange + rate. Initially, the current price available from the price database will be + used as exchange rate. See <link linkend="details.currencies.prices">Entering + exchange rates for currencies</link> for more information on how to provide + exchange rates manually and obtain online price information. +</para> + +<para> + Optionally, the exchange rate is saved in the price database once entered by + the user. +</para> +</sect1> + +<sect1 id="details.currencies.prices"> +<title>Exchange rates for currencies</title> + +<sect2> +<title>Entering prices manually</title> + +<para> + The price database editor allows you to enter exchange rates between + currencies or prices for investments. You can pull it up using the + <menuchoice><guimenu>Tools</guimenu><guimenuitem>Prices...</guimenuitem></menuchoice> + menu option. +</para> + +<para> + <screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="currency_priceeditor.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Currency Price Editor</phrase> + </textobject> + </mediaobject> + </screenshot> +</para> + +<para> + In &kappname; a <quote>Price</quote> is the price of one currency in terms of + a second currency. For example, as I write this, the price of 1 USD in terms + of 1 EUR is 0.83; that is, 1 USD costs 0.83 EUR. The first currency is the + one being bought or sold, and the second one is the currency used to buy or + sell it. +</para> + +<para> + When you press the <guibutton>New</guibutton> button, you get the New Price + Entry dialog. Enter the first currency (USD in the example above) in the + Security field. Enter the second currency (EUR in the example above) in the + Currency field. Enter the effective date of the price in the Date field. +</para> + +<para> + <screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="currency_newpriceentry.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>New Price Entry</phrase> + </textobject> + </mediaobject> + </screenshot> +</para> +</sect2> + +<sect2> +<title>Online currency updates</title> + +<para> + &kappname; will fetch currency conversions from the web. Once you have + entered a single price for a pair of currencies, the online quote feature will + always list that pair amongst its options. +</para> + +<para> + See the section on <link linkend="details.investments.onlinequotes">Online + Price Quotes</link> in the Investments chapter for more details. +</para> +</sect2> +</sect1> +</chapter> diff --git a/doc/en/details-database.docbook b/doc/en/details-database.docbook new file mode 100644 index 0000000..7c87293 --- /dev/null +++ b/doc/en/details-database.docbook @@ -0,0 +1,461 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="details.database"> +<chapterinfo> + <authorgroup> + <author> + <firstname>Tony</firstname> + <surname>Bloomfield</surname> + <affiliation> + <address><email></email></address> + </affiliation> + </author> + </authorgroup> + <date>2009-08-05</date> + <releaseinfo>1.0</releaseinfo> +</chapterinfo> +<title>Database</title> + +<sect1 id="details.database.usage"> +<title>Caution when using the database</title> + +<caution> + <para> + At the time of writing, the software described in this chapter is still in + an experimental stage, and loss of data is possible. Please ensure that you + have an alternative backup copy of your data before committing to database + usage. + </para> +</caution> + +<sect2> +<title>Introduction</title> +<para> + As of release 1.0, &kappname; allows you to hold your data in a relational + database. One of the advantages of using this industry-standard format is that + it may allow you to view your data using one of the graphic front ends such as + OpenOffice.org<trademark class="copyright"/>, perhaps in some format that + &kappname; currently doesn't provide. Also, a little knowledge of SQL + (Structured Query Language, the language used world-wide to access relational + databases) should enable you more easily to export data to an external + program, for example, a budgeting application.</para> <para/> +</sect2> + +<sect2><title>Preparation</title> + +<para> + To access the database, &kappname; uses the SQL module supplied by &Qt; + Software as part of their &Qt; programming system. This module supports a + number of different database systems through a collection of drivers. Among + the more popular open-source systems for which drivers are available are + MySQL<trademark class="registered"/>, SQLite, and PostgreSQL. The module also + supports the 'heavier', more industrial, systems such as Oracle<trademark + class="registered"/> and IBM DB2<trademark class="registered"/>. +</para> + +<para> + With the exception of SQLite, these systems use a client/server model, where + the 'client' software sits on 'your' machine, while the server lives on the + same machine as the database itself, which may be elsewhere on a network. Of + course, in the normal scenario for a personal finance application such as + &kappname;, 'your' machine acts as both client and server. Your first task + therefore, having decided which database system you wish to use, is to install + the client, and most probably server, software. +</para> + +<para> + In addition to the database software itself, you must also install the + corresponding &Qt; driver module. Most distributions will include driver + modules for the more popular databases. Otherwise, check with the <ulink + url="http://qt.nokia.com">&Qt; software web site</ulink> and search for + 'SQL drivers' +</para> + +<note> + <para> + SQLite does not operate on a client/server model; each database is held in a + regular file, local or remote, accessed using the normal methods supplied by + the underlying operating system. In this case, therefore, there is only one + software package to install. Also, some of the following information, + particularly that related to administration, may not apply to SQLite. + </para> + + <para> + Due to limitations in prior releases, only version 3 of SQLite is + supported. Unfortunately, the release of the &Qt; toolkit used by &kappname; + does not provide a driver for this version. However, an unofficial, + extensively tested, driver is available; if you wish to use SQLite, ask on + &devlist; for further information. + </para> +</note> +</sect2> + +<sect2> +<title>Administration</title> + +<para> + Looking after databases is a little more complex than dealing with regular + files. Each system has different methods for performing those necessary + administrative tasks such as creating databases, assigning permissions to + various users, producing backups, &etc;. Describing these tasks is outside the + scope of this manual, but all of the supported products provide comprehensive + reference documentation, and a quick search of the web will point you at many + tutorials on the subject. +</para> + +<sect3> +<title>Creating the database</title> + +<para> + Code has been included to create an initial database to hold your data if one + doesn't exist. However, it is strongly recommended that you pre-create a + database, because most of the products provide a number of options which may + be relevant. One that may be of particular importance to some would be the + designation of the character set (e.g., UTF-8) to be used for text + fields. +</para> + +<para> + At this time, you will also need to specify permissions for various users to + perform different operations on the database. In most systems, the user who + creates the database will be automatically assigned all permissions, but this + is an area in which the documentation should be consulted.</para> + +<para> + For your first use of the database, and occasionally at other times when the + database layout changes, you will need permission (also called privileges) to + create and alter tables and views (see next paragraph). There may be different + names for the permission/privilege in different systems, but something like + CREATE and ALTER should be commonplace. For normal running, you will need to + be able to read and write records; these are normally defined in SQL as + SELECT, INSERT, UPDATE, and DELETE permissions. +</para> +</sect3> + +<sect3> +<title>Creating Tables</title> + +<para> + On your first use, &kappname; will attempt to create the necessary table + structures. In order to achieve the maximum compatibility between various + database types, only a subset of common data types are used. There may + nevertheless be situations where a particular type is not supported, and in + this case, provision has been made to generate the SQL code necessary to + create tables. This code can then be modified as required and used to create + the tables outside of &kappname;. Should you find yourself in this situation, + help can usually be obtained from &devlist;. +</para> +</sect3> +</sect2> + +<sect2 id="details.database.selectdatabase"> +<title>Initialisation</title> + +<para> + Using &kappname;, open or import an existing data file, or create a new + one. Then select <guimenuitem>Save as Database</guimenuitem> from the + <guimenu>File</guimenu> menu. This will present the following dialog: +</para> + +<screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="select_database.png" format="PNG" /> + </imageobject> + </mediaobject> +</screenshot> + +<sect3> +<title>Database Type</title> + +<para> + This box lists all &Qt; SQL drivers installed on your system. Select the + driver for your database type. If the one you want is not in the list, you + need to install the appropriate driver. See your distribution documentation, + or visit the <ulink url="http://qt.nokia.com/" type="">&Qt; software web + site</ulink> and search for 'SQL drivers'. +</para> +</sect3> + +<sect3> +<title>Database name</title> +<para> + The default database name is KMyMoney, but you may choose some other name if + you like. SQLite has one database per file; selecting this driver will open + the standard 'Open File' dialog from which a file may be selected or + created. For some database types, &kappname; may not be able to create the + database, so it must be pre-created using the appropriate administrative + procedure. However, &kappname; will create all table structures where + necessary. +</para> +</sect3> + +<sect3><title>Host name</title> +<para> + For the average user, the default name of <quote>localhost</quote>, being the + machine you are currently using, is correct. For networked databases, enter + the connected host name. +</para> + +<note> + <para> + NOTE: For SQLite databases, the Host name, User name, and Password fields + are not relevant. The SQLite file must have the appropriate read/write + permissions set by the underlying file system to enable the appropriate + access for the currently logged-in user. + </para> +</note> +</sect3> + +<sect3> +<title>User name and password</title> +<para> + Check the permissions set up on your database, or contact the database + administrator, for the correct values to use here. The user name must be + capable of selecting, inserting, updating, and deleting records. If the user + name is the same as your login name, a password is not normally required. +</para> +</sect3> + +<sect3> +<title>Generate SQL</title> +<para> + This button will generate the CREATE TABLE commands and save them to a text + file, which may be edited if the in-built commands do not work for your + database system (see previous paragraph). +</para> +</sect3> +</sect2> + +<sect2> +<title>Accessing your data</title> + +<sect3> +<title>Table design</title> + +<para> + To access your data in &kappname;, use the <guimenuitem>Open + Database</guimenuitem> entry in the <guimenu>File</guimenu> menu. This will + open a dialog similar to the above. +</para> + +<para> + To access your data in other formats, you will need to know a little about how + it is held in relational databases. By far the easiest way to get a feel for + this is to open the database in a front-end such as OpenOffice.org. This + provides a list of the various tables which make up the database, and + enables you to see the layout of each of them. +</para> + +<para> + To extract data, e.g., into a spreadsheet or external file, it is almost + invariably necessary to select linked data from more than one table. This is + done by 'joining' the tables, using a field which is common to each. You can + find a lot more information about how this is done from the online database + tutorials mentioned above. The following table lists the fields used to define + these inter-table relationships. +</para> + +<informaltable> + <tgroup cols="3"> + <colspec colname="c1" colwidth="4.5cm"/> + <colspec colname="c2" colwidth="6.2cm"/> + <colspec colname="c3" colwidth="6.3cm"/> + <thead> + <row> + <entry valign="top"> + <para>Relationship</para> + </entry> + <entry valign="top"> + <para>Match</para> + </entry> + <entry valign="top"> + <para>With</para> + </entry> + </row> + </thead> + <tbody> + <row> + <entry valign="top"> + <para>Institutions and Accounts</para> + </entry> + <entry valign="top"> + <para>kmmInstitutions.id</para> + </entry> + <entry valign="top"> + <para>kmmAccounts.institutionId</para> + </entry> + </row> + <row> + <entry valign="top"> + <para>Accounts Parent/Child</para> + </entry> + <entry valign="top"> + <para>kmmAccounts.id</para> + </entry> + <entry valign="top"> + <para>kmmAccounts.parentId</para> + </entry> + </row> + <row> + <entry valign="top"> + <para>Transactions and Splits (see Note 1)</para> + </entry> + <entry valign="top"> + <para>kmmTransactions.id</para> + </entry> + <entry valign="top"> + <para>kmmSplits.transactionId</para> + </entry> + </row> + <row> + <entry valign="top"> + <para>Accounts and Splits</para> + </entry> + <entry valign="top"> + <para>kmmAccounts.id</para> + </entry> + <entry valign="top"> + <para>kmmSplits.accountId</para> + </entry> + </row> + <row> + <entry valign="top"> + <para>Payees and Splits</para> + </entry> + <entry valign="top"> + <para>kmmPayees.id</para> + </entry> + <entry valign="top"> + <para>kmmSplits.payeeId</para> + </entry> + </row> + <row> + <entry valign="top"> + <para>Schedules and Transactions</para> + </entry> + <entry valign="top"> + <para>kmmSchedules.id</para> + </entry> + <entry valign="top"> + <para>kmmTransactions.id</para> + </entry> + </row> + <row> + <entry valign="top"> + <para>Transactions and Currencies</para> + </entry> + <entry valign="top"> + <para>kmmTransactions.currencyId</para> + </entry> + <entry valign="top"> + <para>kmmCurrencies.ISOCode</para> + </entry> + </row> + <row> + <entry valign="top"> + <para>Accounts and Securities (see Note 2)</para> + </entry> + <entry valign="top"> + <para>kmmAccounts.currencyId</para> + </entry> + <entry valign="top"> + <para>kmmSecurities.id</para> + </entry> + </row> + <row> + <entry valign="top"> + <para>Securities and Prices</para> + </entry> + <entry valign="top"> + <para>kmmSecurities.id</para> + </entry> + <entry valign="top"> + <para>kmmPrices.fromId or kmmPrices.toId</para> + </entry> + </row> + <row> + <entry valign="top"> + <para>Currency Rates</para> + </entry> + <entry valign="top"> + <para>kmmCurrencies.ISOCode</para> + </entry> + <entry valign="top"> + <para>kmmPrices.fromId or kmmPrices.toId</para> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> + +<para> + Notes: +</para> + +<para> + 1 – txType = “N” for normal transactions, + “S” for scheduled transactions +</para> + +<para> +2 – if kmmAccounts.isStockAccount = “Y” +</para> +</sect3> + +<sect3> +<title>Field formats</title> + +<para> + Several of the data fields are held in an internal format which may not be + immediately useful to external programs. In these cases, the information has + been duplicated in both internal and external formats. +</para> + +<para> + Monetary amounts and share values are shown both in numerator/denominator + format, and, with a field name suffixed with 'Formatted', in the form as shown + on your screens. +</para> + +<para> + Similarly, some fields, such as account type appear both as a numeric code, + and in a field suffixed 'String' in the form and language of the application. +</para> +</sect3> + +<sect3> +<title>Updating your data</title> + +<para> + Having data in an industry standard format does give you the ability to modify + it outside the &kappname; application. DO NOT DO IT unless you really know + what you are doing, and always be certain to make a backup copy of your data + first. If you get it wrong, &kappname; may not be able to access your data, + and you could even end up losing it altogether. You have been warned! +</para> +</sect3> + +<sect3> +<title>Stored queries</title> + +<para> + Most database systems allow you to store commonly used queries and procedures, + and in some cases, these may be held as tables or other objects within your + database itself. As you will have guessed from the above, all the tables used + by &kappname; begin with the lowercase letters 'kmm'. This standard will be + maintained, and only tables beginning with these letters will be + updated. Thus, provided you avoid these in the naming of your queries etc., + you should not experience any problems. +</para> +</sect3> +</sect2> + +<sect2> +<title>Encryption</title> + +<para> + Encryption of data in your database is not currently supported. +</para> +</sect2> +</sect1> +</chapter> diff --git a/doc/en/details-files.docbook b/doc/en/details-files.docbook new file mode 100644 index 0000000..90a2630 --- /dev/null +++ b/doc/en/details-files.docbook @@ -0,0 +1,19 @@ +<chapter id="details.files"> +<title>KMyMoney Files</title> +<sect1 id="details.files.kmy"><title>Your .KMY data file</title> +<para> +All of your financial information that KMyMoney knows about is stored in a file ending in .KMY. You may have as many of these files as you like, each named differently. When you launch the program, it will automatically load the file you had open last time you exited. +</para> +</sect1> +<sect1 id="details.files.hackingkmy"><title>Hacking the .KMY data file</title> +<para>The .KMY file is a gzipped XML file. If you wish to learn about the structure of the file, you can gunzip it and load it in your favorite text editor.</para> +</sect1> +<sect1 id="details.files.anonymous"><title>Making an Anonymous data file</title> +<para>If you should encounter a bug, it's sometimes useful for the developers to have your data file in order to reproduce it and fix the problem. Obviously, this presents a problem because you do not want to send the developers your private financial details.</para> +<para>To solve this, KMM allows you to save an "anonymized" version of your data. This removes all personal information from the file, but keeps the structure intact.</para> + <para>To save a copy of your file in this way, open the File menu from the application menu bar, and choose "Save as...". For the file type, choose "Anonymous (.ANON.XML)". This will save off a copy of your data in anonymous form.</para> +<para>Next, you will need to verify that the problem still exists with your file in this form. Not all problems still occur with an anonymous file. Close your file, and load the anonymous file. Try the same actions that caused the problem initially. Hopefully the problem still happens.</para> +<para>If it does, you can now report the problem to the developer's list, and mention that you have anonymous file that reproduces the problem. When requested, send the anonymous file via private e-mail to whichever developer requests it.</para> +</sect1> +</chapter> + diff --git a/doc/en/details-forecast.docbook b/doc/en/details-forecast.docbook new file mode 100644 index 0000000..9b0d963 --- /dev/null +++ b/doc/en/details-forecast.docbook @@ -0,0 +1,290 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="details.forecast"> +<chapterinfo> + <authorgroup> + <author> + <surname>Colin Wright <cdwright@gwi.net></surname> + </author> + </authorgroup> + <date>2009-08-03</date> + <releaseinfo>1.0</releaseinfo> +</chapterinfo> + +<title id="details.forecast.title">Forecast</title> +<sect1 id="details.forecast.define"> +<title>What is a Forecast?</title> + +<para> + In &kappname;, a Forecast is a prediction of the balances of Accounts during a + specified future period of time.</para> + +<para> + Forecasts can be predicted using one of two methods. +</para> + +<variablelist> + <varlistentry> + <term>Scheduled and Future Transactions</term> + <listitem> + <para>&kappname; uses a combination of future transactions already entered + into the ledgers and the entries in the Schedule.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>History-based</term> + <listitem> + <para>&kappname; uses values from past transactions in the ledgers to + predict future transactions.</para> + </listitem> + </varlistentry> +</variablelist> + +<para> + The forecast method and forecast period can be set in the &kappname; Settings, + in the Forecast pane. +</para> + +<para> + &kappname; Forecast provides a summary, showing the predicted balances at + account cycle dates and the expected difference between the starting and + ending balances. The length of the account cycle can be set by the user. The + summary also displays messages about significant predicted changes to the + accounts during the forecast period. +</para> + +<para> + As well as the summary, &kappname; Forecast also allows you to view day-by-day + balances and view the minimum and maximum balances for each forecast account + cycle. +</para> + +<para> + By default the Forecast is created for 90-days, with 30-day account cycles + using Scheduled and Future Transactions. +</para> +</sect1> + +<sect1 id="details.forecast.view" > +<title>Viewing Forecasts</title> + +<para> + You can view a Forecast by clicking the appropriate icon in the navigation + pane at the left hand side of your &kappname; window. +</para> + +<para> + The Forecast window is split into three tabs +</para> + +<sect2> +<title>Summary Tab</title> + +<para> + The Summary tab is split vertically into two halves. +</para> + +<sect3> +<title>Account Summary</title> + +<para> + The Account Summary contains a grid displaying a row of information for each + Asset and Liability. +</para> + +<para> + The following columns are displayed: +</para> + +<variablelist> + <varlistentry> + <term>Account</term> + <listitem> + <para>The name of the Asset or Liability account</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Current Balance (Current)</term> + <listitem> + <para>The current balance of the account is displayed.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Account Cycle Balance</term> + <listitem> + <para>The Forecast period is split into account cycles. The default + account cycle length is 30 days, but can be set by the user.</para> + + <para>The first account cycle date is the first Forecast date. By default + this is the current date plus one account cycle, but can change + depending on the "Day of Month to start Forecast" setting.</para> + + <para>Remaining account cycle dates are determined by adding the account + cycle length to the previous account cycle date. This is continued + until the calculated account cycle date would be beyond the Forecast + period.</para> + + <para>For each account cycle date the predicted balance is + displayed.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Total Variation</term> + <listitem> + <para>The rightmost column displays the predicted difference in value + between the balances at the start and end of the forecast. If the + predicted end value of the account (in terms of net worth) is less than + the start value the whole row is highlighted in red.</para> + </listitem> + </varlistentry> +</variablelist> + +</sect3> + +<sect3> +<title>Key Summary Information</title> + +<para> + The bottom half of the Summary tab displays noteworthy information about + accounts. This includes: +</para> + +<variablelist> + <varlistentry> + <term>Assets below zero</term> + <listitem> + <para>A message is displayed for any asset for which the value starts or + will drop below zero during the forecast period.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Liabilities above zero</term> + <listitem> + <para>A message is displayed for any liability for which the value starts + or will rise above zero during the forecast period. Note that the value + of a liability is the negative of its ledger balance, since a positive + balance indicates money owed.</para> + </listitem> + </varlistentry> +</variablelist> +</sect3> +</sect2> + +<sect2> +<title>Details Tab</title> + +<para> + The Details tab contains a grid displaying a row of information for each Asset + and Liability. +</para> + +<variablelist> + <varlistentry> + <term>Account</term> + <listitem> + <para>The name of the Asset or Liability account</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Dates</term> + <listitem> + <para>For each date in the Forecast period a column displays the predicted + balance of the account on that date. The date columns are in ascending + order from left to right.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Total Variation</term> + <listitem> + <para>The rightmost column displays the predicted difference in value + between the balances at the start and end of the forecast. If the + predicted end value of the account (in terms of net worth) is less than + the start value the whole row is highlighted in red.</para> + </listitem> + </varlistentry> +</variablelist> +</sect2> + +<sect2> +<title>Advanced Tab</title> + +<para> + The Advanced tab contains a grid displaying a row of information for each + Asset and Liability. The information is split into columns as follows: +</para> + +<variablelist> + <varlistentry> + <term>Account</term> + <listitem> + <para>The name of the Asset or Liability account</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Minimum Account Cycle Balance</term> + <listitem> + <para>For each account cycle number <n> in the Forecast period + the following columns are displayed:</para> + + <variablelist> + <varlistentry> + <term>Minimum Balance (Min Bal <n>)</term> + <listitem> + <para>The minimum predicted balance during the account cycle</para> + </listitem> + </varlistentry> + <varlistentry> + <term>Minimum Balance Date (Min Date <n>)</term> + <listitem> + <para>The date on which the balance reaches its predicted + minimum.</para> + </listitem> + </varlistentry> + </variablelist> + </listitem> + </varlistentry> + + <varlistentry> + <term>Maximum Account Cycle Balance</term> + + <listitem> + <para>For each account cycle number <n> in the Forecast period + the following columns are displayed:</para> + + <variablelist> + <varlistentry> + <term>Maximum Balance (Max Bal <n>)</term> + <listitem> + <para>The maximum predicted balance during the account cycle</para> + </listitem> + </varlistentry> + <varlistentry> + <term>Maximum Balance Date (Max Date <n>)</term> + <listitem> + <para>The date on which the balance reaches its predicted + maximum.</para> + </listitem> + </varlistentry> + </variablelist> + </listitem> + </varlistentry> + + <varlistentry> + <term>Average</term> + + <listitem> + <para>The average balance of the account during the forecast period</para> + </listitem> + </varlistentry> +</variablelist> + +</sect2> +</sect1> +</chapter> diff --git a/doc/en/details-formats.docbook b/doc/en/details-formats.docbook new file mode 100644 index 0000000..a6fe07f --- /dev/null +++ b/doc/en/details-formats.docbook @@ -0,0 +1,185 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="details.formats"> +<chapterinfo> + <authorgroup> + <author> + <firstname>Thomas</firstname> + <surname>Baumgart</surname> + <affiliation> + <address><email>ipwizard@users.sourceforge.net</email></address> + </affiliation> + </author> + </authorgroup> + <date>2009-05-08</date> + <releaseinfo>1.0</releaseinfo> +</chapterinfo> + +<title>File Formats</title> + +<para> + This chapter describes the formats in which &kappname; stores its data in + permanent form on the user's storage device. In general, &kappname; stores its + information in form of an &XML; document. Depending on the actual format, this + &XML; document will be written + +<itemizedlist> + <listitem><para>as a <link linkend="details.formats.plain">plain text + file</link> encoded in UTF-8,</para></listitem> + + <listitem><para>as a <link linkend="details.formats.compressed">compressed + file</link> using GZIP compression,</para></listitem> + + <listitem><para>as an <link linkend="details.formats.encrypted">encrypted + file</link> using GPG encryption, or</para></listitem> + + <listitem><para>as an <link linkend="details.formats.anonymous">anonymous + plain text file</link> encoded in UTF-8 but with all your personal data + scrambled.</para></listitem> +</itemizedlist> +</para> + +<sect1 id="details.formats.plain"> +<title>Plain text file</title> +<para> + This is the most space consuming format supported, as no compression is + performed. It is not intended for normal use, and is provided to support + debugging purposes and the capability to modify the file manually. If you end + a filename in <literal role="extension">.xml</literal>, the file will be + stored in this format. + +<caution> + <para> + Manual modification of the file is not recommended to the normal user, and + should only be performed if the internal working of &kappname; is fully + understood or if instructions from the developers tell you what to do. Don't + blame the &kappname; developers if you screw up your data: You have been + warned! + </para> +</caution> +</para> +</sect1> + +<sect1 id="details.formats.compressed"> +<title>GZIP-compressed file</title> +<para> + This is the normal format used by &kappname; when you store a file with the + extension <literal role="extension">.kmy</literal>. +</para> + +<note> + <para> + If <link linkend="details.formats.encrypted">encryption</link> has been + selected, the file will be stored encrypted. + </para> +</note> + +<para> + If you want to look at the contents of a GZIP compressed file, rename it to a + filename ending in <literal role="extension">.gz</literal> (e.g., + rename <filename>myfinances.kmy</filename> + to <filename>myfinances.kmy.gz</filename>), then use <command>gunzip</command> + to uncompress the file and look at it. You don't have to compress it before + loading it into &kappname; the next time, because &kappname; can read the + uncompressed data as well. Nevertheless, if you save it thereafter, it will be + saved compressed again. Use + the <link linkend="details.formats.plain">.xml</link> extension to write it in + uncompressed format. +</para> +</sect1> + +<sect1 id="details.formats.encrypted"> +<title>GPG-encrypted file</title> +<para> + Using the GPG-encrypted file format is a very secure method of storing your + personal finance data on your storage device. When &kappname; has been + instructed through the settings dialog to store your data encrypted, it will + cipher the data using GPG and the key you provided before actually storing + it. When opening an encrypted file, you have to provide the passphrase + necessary to open your keyring. The encrypted file itself will be stored in + GPG's <emphasis>ASCII armored</emphasis> format. + <note> + <para> + When using GPG encryption, GPG also compresses the file, so no extra + compression is necessary. + </para> + </note> +</para> + +<sect2 id="details.formats.encrypted.gpgkeys"> +<title>GPG-Keys</title> +<para> + If you have not done so already for mail encryption, you need to generate a + key-pair in order to use the GPG encryption feature of + &kappname;. Also, <application>GPG</application> must be installed on your + system. +</para> + +<para> + The details about how to generate a key-pair and how to take care of it are + beyond the scope of this document. A Mini Howto on this subject can be found + at <ulink url="http://www.gnupg.org/documentation/howtos.en.html">http://www.gnupg.org/documentation/howtos.en.html</ulink>. +</para> +</sect2> + +<sect2 id="details.formats.encrypted.keysettings"> +<title>Setting the keys in &kappname;</title> +<para> + On the encryption page of the settings dialog, there is a drop down + list where you can select the key that should be used for encryption and + decryption. Additionally you can find a field where you can enter the + key-id of a key not in the listbox. You can use either the key-id, the + email address associated with this key, or any other valid GPG key + identification as the value for this field. When you enter the key-id, + &kappname; will check its validity and display a green LED icon in the + dialog if a key is found. + <caution> + <para> + Make sure you have both the public and the private key for this id. If you + do not own the private key for the id entered, you will not be able to + open the file again. + </para> + </caution> +</para> +</sect2> + +<sect2 id="details.formats.encrypted.recoverkey"> +<title>The &kappname; recover key</title> +<para> + Also on this page of the settings dialog you have the choice of selecting + supplemental encryption with the &kappname; recover key. This option is + available to you if that key is stored in your <application>GPG</application> + keyring. Selecting this option will allow you to recover your data even in the + case you lose your own private key. This is possible because the data is not + only encrypted for your own key, but also for the &kappname; recover key. This + key is only available to selected &kappname; developers (at the time of + writing only to the author). +</para> + +<para> + Under normal circumstances, you will open/save/close your file as usual. In + the abnormal case of loss of your key, you have the chance to contact one of + the developers who has access to the &kappname; recover key and request help + to recover your data. You may contact the developers via email to the + &kappname; developer mailing list at &devlist;. +</para> +</sect2> +</sect1> + +<sect1 id="details.formats.anonymous"> +<title>Anonymous file</title> +<para> + This format is not intended to be used for normal data storage. It is + supported in case of a problem as a method of supplying the &kappname; + development team with your file without disclosing any of your financial + data. If instructed by the developers, use the <guimenuitem>Save + as...</guimenuitem> menu item to store your data in anonymous format by + selecting <literal role="extension">.anon.xml</literal> as the file + extension. To verify that your problem still exists, reload this anonymized + file and try to duplicate your problem. If the problem is still present, send + the file to the developer mailing list at &devlist; for further + investigation. If the problem does not show ... well, I don't want to think + about this scenario right now. +</para> +</sect1> +</chapter> + diff --git a/doc/en/details-hbciofx.docbook b/doc/en/details-hbciofx.docbook new file mode 100644 index 0000000..72ac7fc --- /dev/null +++ b/doc/en/details-hbciofx.docbook @@ -0,0 +1,6 @@ +<chapter id="details.hbciofx"> +<title>Online Banking / HBCI & OFX - Under development - UNASSIGNED</title> +<para> +</para> +</chapter> + diff --git a/doc/en/details-impexp.docbook b/doc/en/details-impexp.docbook new file mode 100644 index 0000000..1dafbdd --- /dev/null +++ b/doc/en/details-impexp.docbook @@ -0,0 +1,1103 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="details.impexp"> +<chapterinfo> + <authorgroup> + <author> + <firstname>Ace</firstname> + <surname>Jones</surname> + <affiliation> + <address><email>acejones@users.sourceforge.net</email></address> + </affiliation> + </author> + </authorgroup> + <date>2009-07-30</date> + <releaseinfo>1.0</releaseinfo> +</chapterinfo> + +<title>Importing and Export</title> + +<sect1 id="details.impexp.gnucash"> +<sect1info> + <author> + <firstname>Tony</firstname> + <surname>Bloomfield</surname> + <affiliation> + <address><email>tonybloom@users.sourceforge.net</email></address> + </affiliation> + </author> +</sect1info> + +<title>GnuCash Importer</title> + +<sect2> +<title>GnuCash Files</title> + +<para> + The &kappname; GnuCash importer handles direct reading of standard (&XML;) + files as produced by GnuCash versions 1.8 and 2.0. The following are not + supported: +</para> + +<itemizedlist> + <listitem><para>import of database (Postgres) data</para></listitem> + <listitem><para>import of 'multi-book' files</para></listitem> + <listitem><para>import into an existing &kappname; file</para></listitem> + <listitem><para>import of small-business specific features (Employees, + Invoices, etc.)</para></listitem> + <listitem><para>export to GnuCash files.</para></listitem> +</itemizedlist> + +<para> + The import will probably only work correctly if presented with a valid + file. It is recommended that the GnuCash 'Check & Repair All' function (in + the Actions menu) be run before attempting to import. +</para> + +<para> + Files can be opened by specifying the file name on the command line + (<command>kmymoney <filepath></command>), or by means of the &kappname; + <menuchoice> + <shortcut><keycombo><keysym>Ctrl-O</keysym></keycombo></shortcut> + <guimenu>File</guimenu><guimenuitem>Open</guimenuitem> + </menuchoice> or + <menuchoice> + <guimenu>File</guimenu><guimenuitem>Import</guimenuitem> + </menuchoice> menu items. +</para> + +<para> + The similarity between the two products means that much day-to-day data can be + imported in a straightforward fashion. However, there are some areas where + differences arise, and various options are provided to deal with these. The + following sections will describe some of these differences; understanding them + should lead to a smoother importation. +</para> +</sect2> + +<sect2> +<title>Similarities, Differences, and Terminology</title> + +<sect3> +<title>Small Business Usage</title> + +<para> + It should be noted that &kappname; is a <emphasis>personal</emphasis> finance + manager, and as such, does not directly support any of the business features + of GnuCash, such as tax tables, payroll, and tracking of lots. Any Accounts + Payable or Receivable accounts found in a file will be imported as Liability + or Asset accounts respectively. +</para> +</sect3> + +<sect3> +<title>Accounts</title> + +<sect4> +<title>Account types</title> + +<para> + For both products, the highest level of structure in the file is the + account. &kappname; supports 5 main types of account: Asset, Liability, + Income, Expense and Equity, each of which may have various subtypes, e.g., + Checking, Credit Card, &etc;. &kappname; includes a 'standard' account for + each of these five types, and all other accounts are held subordinate to one + of these. &kappname; enforces more consistency (or less flexibility, depending + on your point of view) between account types than does GnuCash, and the + importer will correct any inconsistencies it detects. This may result in a + slightly different account structure, though this can, within reason, be + amended after the import is complete. +</para> +</sect4> + +<sect4> +<title>Categories</title> + +<para> + &kappname; uses the term Category to denote an account of an Income or Expense + type. Unlike GnuCash, these are not considered as 'ledger' accounts, and entry + of transactions folder into categories is not supported; allocations are made + during transaction entry into other account types. +</para> +</sect4> + +<sect4> +<title>Structure and Placeholders</title> + +<para> + GnuCash supports the use of Placeholder accounts. In effect, these are just + read-only accounts into which no transactions can be entered, but which + function in an analogous fashion to folders in a folder structure, as a + holder for other accounts. Though &kappname; does not support this feature as + such, it does provide a parent/child account relationship, so the importer + simulates placeholders by creating empty accounts. +</para> +</sect4> + +<sect4> +<title>Account Type map</title> + +<informaltable frame='all'> +<tgroup cols='2' align='left' colsep='1' rowsep='1'> +<thead> + <row> + <entry>GnuCash type</entry><entry>&kappname; type</entry> + </row> +</thead> +<tbody> + <row> + <entry>BANK</entry><entry>Checking</entry> + </row> + <row> + <entry>CHECKING</entry><entry>Checking</entry> + </row> + <row> + <entry>SAVINGS</entry><entry>Savings</entry> + </row> + <row> + <entry>ASSET</entry><entry>Asset</entry> + </row> + <row> + <entry>CASH</entry><entry>Cash</entry> + </row> + <row> + <entry>CURRENCY</entry><entry>Cash</entry> + </row> + <row> + <entry>MONEYMRKT</entry><entry>MoneyMarket</entry> + </row> + <row> + <entry>STOCK</entry><entry>Stock</entry> + </row> + <row> + <entry>MUTUAL</entry><entry>Stock</entry> + </row> + <row> + <entry>EQUITY</entry><entry>Equity</entry> + </row> + <row> + <entry>LIABILITY</entry><entry>Liability</entry> + </row> + <row> + <entry>CREDIT</entry><entry>CreditCard</entry> + </row> + <row> + <entry>INCOME</entry><entry>Income</entry> + </row> + <row> + <entry>EXPENSE</entry><entry>Expense</entry> + </row> + <row> + <entry>RECEIVABLE</entry><entry>Asset</entry> + </row> + <row> + <entry>PAYABLE</entry><entry>Liability</entry> + </row> +</tbody> +</tgroup> +</informaltable> +</sect4> +</sect3> + +<sect3> +<title>Transactions and Splits</title> + +<sect4> +<title>Balanced transactions</title> + +<para> + As with GnuCash, data is entered in the form of transactions, each generally + consisting of 2 or more split entries. In fact, valid GnuCash transactions + will always contain at least 2 splits, and to conform to GnuCash's + double-entry bookkeeping standard, these must be in monetary balance (i.e., + they must balance out to zero). &kappname; encourages, but does not enforce, + this standard, but any imported transaction which is not balanced will be + marked in the ledger view as having a problem. +</para> +</sect4> + +<sect4> +<title>Payees</title> + +<para> + &kappname; prefers that all transactions have a Payee (a generic term that + encompasses both payees and payers), and unlike GnuCash, a list of these + payees is maintained. Payee names are generated by the importer from the + GnuCash transaction's Description field. +</para> +</sect4> + +<sect4> +<title>Transfers</title> + +<para> + &kappname; uses the term Transfer to describe a transaction which does not + involve a Category, but only transfers money between Asset and/or Liability + accounts. +</para> +</sect4> + +<sect4> +<title>Reconcile</title> + +<para> + &kappname; provides an account reconciliation function similar to that of + GnuCash, and the corresponding transaction status will be imported. +</para> +</sect4> +</sect3> + +<sect3> +<title>Commodities</title> + +<para> + GnuCash uses the term Commodity to cover both currencies and non-currency + assets. These are treated separately in &kappname;. +</para> + +<sect4> +<title>Currencies</title> + +<para> + &kappname; has built-in support for all foreign + <link linkend="details.currencies">currency</link> types. &kappname; also + requires that the user specify a base currency, this being the default + currency for new accounts. The importer will attempt to determine the most + likely base currency, though this choice may be rejected in favour of an + alternative. +</para> + +<para> + (NOTE: &kappname; does not currently support accounts denominated in 'defunct' + currencies (except those replaced by the Euro). At present, it will be + necessary to remove any such accounts from your GnuCash file before + importing. We hope to improve on this situation in a future release.) +</para> +</sect4> + +<sect4 id="gncsecurities"> +<title>Securities and Investments</title> + +<para> + Non-currency assets (normally stocks and bonds) are called Securities by + &kappname;, and represent the main difference between the two products, in + that &kappname; requires any account denominated in a security to be + subordinate to an Investment Account. This is described in more detail in the + chapter on <link linkend="details.investments">Investments</link>. Though + users may have implemented such a relationship, GnuCash imposes no defined + structure on it, so the importer is unable to detect it and perform an + automatic conversion. Three options are therefore made available: +</para> + +<itemizedlist> + <listitem> + <para>Create a separate Investment account for each security, with the same + name as the security</para> + </listitem> + + <listitem> + <para>Create a single Investment account which will act as 'parent' for all + security accounts</para> + </listitem> + + <listitem> + <para>Create several Investment accounts, and assign securities to them as + directed by the user.</para> + </listitem> +</itemizedlist> + +<para> + It depends entirely on user requirements which of these options is relevant in + each situation, and in some cases, manual restructuring of accounts after + importation may be necessary. +</para> +</sect4> + +<sect4> +<title>Prices and currency rates</title> + +<para> + Security prices and currency exchange rates as displayed in the GnuCash Price + Editor will be imported. In addition, price and rate entries will be generated + from all transactions involving securities and multiple currencies. +</para> +</sect4> + +<sect4 id="details.impexp.gncquotes"> +<title>Online Quotes</title> + +<para> + For obtaining online price and currency rate quotations, GnuCash uses a + package called Finance::Quote. Recent versions of &kappname; contain support + for this package for obtaining stock quotes, and this will be used by default + when importing data. You may however elect to convert to the native method + used by &kappname; which is covered in more detail in + <link linkend="details.investments.onlinequotes">online quotes</link>. +</para> + +<para> + If you choose to do so, the following dialog will allow selection of a + 'native' &kappname; price source, or a user-defined source, for each account + for which online quotes are required. However, the stock (ticker) symbol will + be imported unchanged. Since this symbol will almost certainly be different in + the two packages, it will need to be manually edited after completion of the + import process. Future currency rate updates will not use Finance::Quote, and + will always use the native retrieval method. +</para> + +<para> + <screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="gnucash-select_price_source.png" format="PNG" /> + </imageobject> + </mediaobject> + </screenshot> +</para> +</sect4> +</sect3> + +<sect3 id="gncschedules"> +<title>Scheduled Transactions</title> + +<para> + &kappname; does not retain the separation made in GnuCash between template + transactions and their frequency of occurrence. Transaction data will be + duplicated if the same template is used in different schedules, but this is + not likely to be of great significance. +</para> + +<sect4> +<title>Schedule types</title> + +<para> + &kappname; classifies all schedules as one of three types, Bills, Deposits, or + Transfers. Since GnuCash does not make such a distinction, the importer + attempts to determine the classification from the accounts and direction of + money movements. It may be that in some cases incorrect assumptions are made, + and these will need manual correction. +</para> +</sect4> + +<sect4> +<title>Suspect Schedules</title> + +<para> + Some features of GnuCash scheduled transactions are not available in + &kappname;, so the importer tries in each case to reach a reasonable + compromise in converting the data. These transactions will be flagged as + suspect, and the user will be given the option of editing them directly during + the import process. Examples of situations which may cause this are: +</para> + +<itemizedlist> + <listitem> + <para>some frequency intervals supported in GnuCash are not currently + available in &kappname;</para> + </listitem> + + <listitem> + <para>&kappname; does not support the use of formulae and variables in + amount fields</para> + </listitem> + + <listitem> + <para>complex cases which have not yet been identified for import.</para> + </listitem> +</itemizedlist> + +<para> + Despite best efforts, it is possible that, due to the many options involved, a + scheduled transaction may cause a fatal error within &kappname;. If this sort + of problem seems to be occurring, the importer offers the option to drop all + suspect schedules. +</para> +</sect4> +</sect3> + +<sect3> +<title>Reports</title> + +<para> + &kappname; provides a comprehensive selection of configurable reports, + described in more detail in <link linkend="details.reports">Reports.</link> + These will not necessarily, however, match precisely those reports available + in GnuCash. +</para> +</sect3> +</sect2> + +<sect2> +<title>Selecting Importer Options</title> + +<para id="details.impexp.gncoptions"> + <screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="gnucash-import_options.png" format="PNG" /> + </imageobject> + </mediaobject> + </screenshot> +</para> + +<sect3> +<title>Investment Handling</title> + +<para> + See <link linkend="gncsecurities">"Securities and Investments"</link> above. +</para> +</sect3> + +<sect3> +<title>Online Quotes</title> + +<para> + Turn this off if you wish to use the native method for future online price + quotes. +</para> + +<para> + See <link linkend="details.impexp.gncquotes">"Online Quotes"</link> above. +</para> +</sect3> + +<sect3> +<title>Scheduled Transactions</title> + +<para> + See <link linkend="gncschedules">"Scheduled Transactions"</link> above. +</para> +</sect3> + +<sect3> +<title>Decoding Options</title> + +<para> + If your native language is written in letters or symbols which are different + from those used in the 'Latin' languages (i.e., generally Western European), + these are represented in a special fashion ('encoded') in your GnuCash file. + If these letters are not displayed correctly on your screen, then they must be + decoded. Currently, it is often not possible to detect accurately which form + of decoding must be used, so you may need to set this option and select an + entry from the list. In general, the first item in the list will be that + which is considered appropriate for your locale (i.e., the country and + language which was selected as native when your operating system was + installed), so this should be tried first. Since the import process does not + overwrite your GnuCash file, you are free to experiment with any of these + selections. +</para> +</sect3> + +<sect3> +<title>Transaction Notes option</title> + +<para> + Under some usage conditions, non-split GnuCash transactions may contain + residual, often incorrect, memo data which is not normally visible to the + user. When imported into &kappname; however, due to display differences, this + data can become visible. Often, these transactions will have a Notes field + describing the real purpose of the transaction. If this option is selected, + these notes, if present, will be used to override the extraneous memo data. +</para> +</sect3> + +<sect3> +<title>Debug Options</title> + +<para> + These need only be used in the event of import problems. If you have such + problems, you should also report them to the &kappname; developer list + &devlist;. Note that the traces produced by these options may contain data of + a confidential nature, and the Anonymize option should be used if they are to + be made publicly available. +</para> +</sect3> +</sect2> + +<sect2> +<title>Import Report</title> + +<para> + At the end of processing, the importer produces a report showing the number of + different entities processed, and any errors or anomalies encountered. This + report will be displayed on screen, and may be saved to a file for later + review. A full report may contain the following sections: +</para> + +<itemizedlist> + <listitem> + <para>Record counts</para> + </listitem> + + <listitem> + <para>Inconsistencies in account types and actions taken</para> + </listitem> + + <listitem> + <para>Details of suspect schedules</para> + </listitem> +</itemizedlist> + +<para> + <screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="gnucash-report.png" format="PNG" /> + </imageobject> + </mediaobject> + </screenshot> +</para> +</sect2> +</sect1> + +<sect1 id="details.impexp.qifimp"> +<sect1info> + <author> + <firstname>Thomas</firstname> + <surname>Baumgart</surname> + <affiliation> + <address><email>ipwizard@users.sourceforge.net</email></address> + </affiliation> + </author> +</sect1info> + +<title>QIF Importer</title> + +<sect2> +<title>QIF format considered harmful</title> + +<para> + Generally speaking, the QIF format should be avoided wherever possible. It is + a poor choice for transporting financial data. Among other things, QIF suffers + from these problems: +</para> + +<itemizedlist> + <listitem> + <para>Lack of standardized format: Different versions of the same program + will impart different meanings to the same element.</para> + </listitem> + + <listitem> + <para>Lack of transaction identifier: Because there is no ID number + associated with each transaction, matching duplicate transactions is + haphazard at best.</para> + </listitem> + + <listitem> + <para>Lack of expressiveness: The grammar is really simple, and cannot + portray the depth of financial information found in today's financial + environment.</para> + </listitem> +</itemizedlist> + +<para> + This is generally why Intuit stopped supporting QIF input at all with Quicken + 2005. If you have the option of getting data some other way, like OFX, always + choose that option. +</para> +</sect2> + +<sect2> +<title>How to import a QIF file</title> + +<para> + To import a QIF file, first ensure you have a valid &kappname; file open. + Then select <guimenuitem>Import</guimenuitem> <guimenuitem>QIF</guimenuitem> + from the <guimenu>File</guimenu> menu. +</para> + +<para> + <screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="qifopen.png" format="PNG" /> + </imageobject> + </mediaobject> + </screenshot> +</para> + +<para> + The resulting dialog prompts for the QIF filename allowing you to locate the + file by clicking on the <guibutton>Browse</guibutton> button. +</para> + +<para> + Also, &kappname; differentiates between the import of a bank statement file + and historic data exported from another application. The default is to import + a bank statement file. In case you are importing data from your previous personal + finance manager application select the appropriate option. +</para> + +<para> + In general the default QIF profile should work with your QIF data. In some + cases it might become necessary to use a modified QIF profile. See + the <link linkend="details.impexp.qifimp.profile">next section</link> for more + details on that subject. +</para> + +<para> + Click on <guibutton>Import</guibutton> to import the QIF file. +</para> + +<para> + &kappname; will start scanning the file to determine the formats used to + represent dates and numbers. In case it cannot determine a date format + unambiguously, &kappname; will ask the user to select one from the list of + possible date formats. +</para> + +<para> + Next, &kappname; imports the data and creates all necessary objects, such as + payee information, accounts and category records, and stock price information. + Wherever possible, existing transactions will be matched against the imported + information. A progress bar is shown and updated during the import process. +</para> + +<para> + In case &kappname; could not detect the name of the account to be imported, + the user will be asked to select the account into which the data should be + imported. If the account does not already exist in your file, a new account + can be created by clicking on <guibutton>Create</guibutton>. +</para> + +<para> + At the end of the import, &kappname; shows a statement import statistics + window. +</para> + +<para> +<screenshot> + <screeninfo>Statement statistics</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="qif_report.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Statement statistics</phrase> + </textobject> + </mediaobject> +</screenshot> +</para> + +<para> + After importing, all of the imported transactions will be shown with a yellow + background in the ledger view. In case &kappname; was able to match an + imported transaction with an already existing transaction, the background is + shown in light green. +</para> + +<para> + The next step is to verify the imported data and accept it. This is a general + process and also applies to imports from other sources. It is outlined in a + separate section of this document. +</para> + +<note> +<para> + The colors used to mark imported and matched transactions are customizable and + may be different in your environment. +</para> +</note> +</sect2> + +<!-- +<sect2> +<title>Accepting the imported transactions</title> +<para> + + When &kappname; has finished importing the QIF transactions the account will be shown with the imported transactions listed in Yellow. +</para> + +<para> +<screenshot> + <screeninfo>Imported transactions</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="qifimportverify.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Imported transactions</phrase> + </textobject> + </mediaobject> +</screenshot> +</para> + +<para> + Some of your transactions may be flashing red in the ledger. + This is because they need to be assigned a category. + The importer was not able to automatically assign a category based on your past transaction history. +</para> + +<para> + Transaction data can be edited or even deleted if needed. To edit a transaction simply double click on the entry or hit enter when the entry is highlighted. Once finished click on <guibutton>OK</guibutton> to accept the imported transactions or <guibutton>Cancel</guibutton> to remove the imported transactions. +</para> + +</sect2> + +<sect2><title>Importing Investments</title> + +<para> + Please note that if you are importing a file with investment transactions, those investments must first exist in your &kappname; file. + The trading symbol is used to match, so please ensure that the symbol in &kappname; is exactly the same as the one in the file you're importing. +</para> +</sect2> +--> + +<sect2 id="details.impexp.qifimp.profile"> +<title>Setting up a QIF profile</title> + +<para> + Because there is no universally standard format for a QIF file, different + vendors have taken liberties with the format, and introduced their own + nuances. The QIF Profile allows &kappname; to know about the peculiarities of + your file. To edit an existing QIF Profile, or to create a new one, press the + <quote>New</quote> button on the QIF Import dialog, near the profile selector. +</para> + +<para> + <screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="qifimport-qifprofileeditor.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>QIF Profile Editor</phrase> + </textobject> + </mediaobject> + </screenshot> +</para> + +<note> +<para> + Previous versions of &kappname; used to have a tab for date and amount + specifications. &kappname; now determines those settings by scanning the + file. If it cannot figure out all settings, it will interrogate the user + during import. +</para> +</note> +<!-- +<para> + The most commonly changed thing between QIF implementations is the date format. + So if this is the first time you're importing a QIF file, spend a few moments to figure out what format the dates are in, and set the QIF Profile accordingly. + See the discussion below on apostrophe format for more details. +</para> + +<para> + <screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="qifimport-qifprofiledate.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>QIF Profile Date</phrase> + </textobject> + </mediaobject> + </screenshot> +</para> + +</sect2> + +<sect2><title>Apostrophe format</title> + +<para> + Many common QIF writers use a 2-digit representation for the year. + This is ambiguous, because the importer cannot know which century the date belongs in. + To make things even more complicated, QIF files will often used an apostrophe as a year separator to indicate that the date belongs in the OTHER century from the default. +</para> +<para> + For example, if the default century is 1900-1999, the date 12/31/95 would mean 1995. The date 12/31'05 would mean 2005. +</para> +<para> + Because the QIF format is not standardized, it's impossible to know which century is desired. + This is why you have to explicitly state it in the QIF profile. + You do this by specifying which century is intended when an apostrophe is found. + In the example above, you would set the Apostrophe Format to "2000-2099", so dates with an apostrophe will be interpreted as being > year 2000. + In this case, dates without an apostrophe will be treated as being in the 1900's. +</para> +--> +</sect2> + +<sect2><title>Transaction matching</title> + +<para> + As noted previously, one of the major drawbacks of the QIF format is the lack + of a unique identifier for each transaction. Thus, if you import a QIF file + and some of the transactions are already in your ledger, you may get + duplicates. &kappname; attempts to get around this by looking for + transactions that look similar to those you already have. If it finds + something that looks like the same transaction, it will match the apparent + duplicate. +</para> + +<para> + This can be a problem if you have transactions that look too similar but are + actually different. In this case, you can unmatch those transactions later in + the ledger view. +</para> +</sect2> + +<sect2> +<title>Writing an import filter</title> + +<para> + Sometimes you may have data in a custom format, like comma-separated-values + (CSV), or something else unique to your situation. You can still import that + file into &kappname; using a QIF Import Filter. A filter is a custom program + you write which takes your special file as input, and produces a QIF file as + output. This can be a shell script, a perl script, a compiled program written + in C/C++, or anything else you can dream of, as long as the system can run it. +</para> + +<para> + To use it, edit your favorite QIF Profile, and select the Filter tab. Enter + the location of your filter program where prompted. Then, whenever you do a + QIF import using this profile, the file you select for importing will be run + through your filter first. +</para> + +<para> + A common problem is to convert a list of comma-separated-values into a QIF + file. This is a textbook case for the awk tool. Create a script called + csv2qif.awk, with the following two lines as contents: +</para> + +<programlisting> + BEGIN { FS=","; print "!Type:Bank" } + + { print "D"$1; print "T"$2; print "N"$3; print "P"$4; print "M"$5; print "^" } +</programlisting> + +<para> + Then, change the QIF keys (D,T,N,P,M) to match the order of your csv data. + Set the input filter to <userinput>awk -f csv2qif.awk</userinput>. +</para> + +<para> + Another problem sometimes arises in the encoding of QIF files. &kappname; + expects files to be UTF8 encoded. If your file is encoded in something else, + it can be useful to convert it to UTF8. For example to convert it from + iso-8859-1, you would set the input filter to <userinput>recode + iso-8859-1..utf-8</userinput>. +</para> + +</sect2> +<sect2> +<title>Special &kappname; QIF extensions</title> + +<para> + As already mentioned, one of the major drawbacks of the QIF format is the lack + of a unique identifier for each transaction. If you are writing your own QIF + file creator (or filter, as described above), you can overcome this problem. + &kappname; supports the '#' field. The importer will interpret this as a + unique transaction ID, and disregard the record if the transaction is already + in the system. +</para> +</sect2> +</sect1> + +<sect1 id="details.impexp.qifexp"> +<title>QIF Exporter</title> +<para> + To export one of your accounts to a QIF file, choose + the <guimenuitem>Export</guimenuitem> <guimenuitem>QIF</guimenuitem> from + the <guimenu>File</guimenu> menu. You will be prompted for which single + account to export, what file to export it to, and what QIF Profile to use. +</para> + +<note><para> + At the moment, QIF Exporter does not handle export of investments. +</para></note> + +<para> + <screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="qifimport-export.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>QIF Export</phrase> + </textobject> + </mediaobject> + </screenshot> +</para> +</sect1> + +<sect1 id="details.impexp.ofx"> +<sect1info> + <author> + <firstname>Ace</firstname> + <surname>Jones</surname> + <affiliation> + <address><email>acejones@users.sourceforge.net</email></address> + </affiliation> + </author> + <author> + <firstname>Thomas</firstname> + <surname>Baumgart</surname> + <affiliation> + <address><email>ipwizard@users.sourceforge.net</email></address> + </affiliation> + </author> +</sect1info> +<title>OFX Importer Plugin</title> + +<sect2> +<title>Getting the plugin</title> + +<para> + &kappname; will import OFX files painlessly. However, this functionality is + not built into the core program. You must obtain and install the OFX Importer + Plugin. Once that is installed, the command to import OFX files will + automatically show up under the <quote>File | Import</quote> menu. +</para> +<para> + Note that many prepackaged versions of &kappname; were built with the OFX + importer already included or available as a separate package. If the OFX + importer does not seem to be installed in your version, the first place to + check is in the same place you got your base &kappname; package. +</para> +<para> + If you have installed from RPM, the OFX Importer Plugin is contained within + the kmymoney-ofx RPM. It should be available from whatever source you got the + base &kappname; RPM. If you have built from sources, all you need to do is + have preferrably the libOFX 0.9 development headers and libraries installed + on your system. The &kappname; build process will detect these and compile + the plugin. libOFX 0.8.2 is supported as well, but some features are not + supported with this version of the library. +</para> +<para> + Should you run into trouble trying to compile &kappname;, and you are certain + you have the correct version of libOFX installed, please contact the + developers list &devlist; for assistance. Include a copy of your config.log + file, compressed first via gzip. +</para> +</sect2> + +<sect2> +<title>Importing an OFX file</title> + +<para> + The most basic way to import an OFX file is to choose the importer from the + menu bar. From the <guimenu>File</guimenu> menu, + choose <guimenuitem>Import</guimenuitem>, and + then <guimenuitem>OFX</guimenuitem>. If OFX does not show up under Import, + you do not have the OFX Importer Plugin installed correctly. Please see the + previous section. +</para> + +<para> + The first thing the importer will do is ask you into which account to import + the transactions. If there are transactions from multiple accounts in your + file, you will be asked this question multiple times. +</para> + +<para> + After importing, some of your transactions may be shown with an exclamation + mark on a yellow triangle in the ledger. This is because they need to be + assigned a category. The importer was not able to automatically assign a + category based on your past transaction history. You can edit each + transaction in the ledger to assign a category, and the mark will be removed. +</para> + +<para> + Please note that this section describes the <quote>native</quote> OFX + importer. OFX files may also be imported using the AqBanking Importer Plugin + if you have installed that. Note that the two importers do behave slightly + differently, and they are written and supported by two different developers. +</para> +</sect2> + +<sect2> +<title>Importing Investments</title> + +<para> + Please note that if you are importing a file with investment transactions, + those investments must first exist in your &kappname; file. The trading + symbol is used to match, so please ensure that the symbol in &kappname; is + exactly the same as the one in the file you're importing. +</para> +</sect2> + +<sect2 id="details.impexp.webconnect"> +<title>Web Connect</title> + +<para> + The easiest way to import an OFX file is to set up Web Connect. Visit your + bank's web site, and click on a link to download an OFX file. Your browser + should ask you what program you would like to use to open the program. Point + your browser to &kappname;. It will then import the downloaded OFX file into + the &kappname; file you most recently had open. You can also change the file + associations of your desktop environment, and have &kappname; open the OFX + file automatically for you. +</para> + +<para> + If you need to import the OFX file into some other &kappname; file, load up + that file in &kappname; first, and then visit your bank's web site. +</para> +</sect2> + +<sect2 id="details.impexp.ofxdirectconnect"> +<title>Direct Connect</title> + +<para> + OFX Direct Connect is now supported in &kappname;. This gives you the ability + to contact your bank directly to obtain statements. In the future, there will + be more help written, and this will be moved to its own section. +</para> + +<para> + To enable this feature, you must compile &kappname; with the + --enable-ofxbanking switch (now the default). +</para> + +<para> + Please be warned: Many banks require a separate signup, will give you a + separate password or PIN, and may even charge you a separate fee for this + service. No bank directly supports &kappname;. You will have to tell them + you want to bank directly from MS Money or Quicken. +</para> + +<para> + The first step is to configure each account for which you wish to download + statements. Go to the Accounts view, right click on the account you wish to + configure, and choose <quote>Map to online account...</quote>. In case more + than one online banking plugin is installed on your system you will be asked + which one to use. For the internal OFX method select KMyMoney OFX. A list of + banks will be downloaded from the Internet and a wizard will guide you through + choosing a bank, entering your username and password, and selecting an + account. Should you find that your bank is not listed, then it may still be + possible to use the manual option. Your bank may be able to provide the + required parameters, or you may have to do some research to find them. +</para> + +<para> + Once you have an account set up with online banking, go to the ledger for that + account. Then from the <quote>Account</quote> menu, choose <quote>Update + account...</quote>. This will connect to your bank, and download a statement + for the last 60 days. +</para> +</sect2> + +<sect2> +<title>Exporting an OFX file</title> + +<para> + It is not possible to export your data as an OFX file currently. If you are + interested to contribute in this area, please contact the libofx development + team for details. +</para> +</sect2> +</sect1> + +<sect1 id="details.impexp.plugins"> +<title>Writing Importer Plugins</title> + +<para> + &kappname; contains explicit support for importer plugins. If you have a + custom format, and you would like to write an importer plugin, we would value + your contribution. To do so, you'll need to compile the program from source. + Then use the OFX Importer Plugin as an example. +</para> +</sect1> +</chapter> diff --git a/doc/en/details-institutions.docbook b/doc/en/details-institutions.docbook new file mode 100644 index 0000000..fc3ee44 --- /dev/null +++ b/doc/en/details-institutions.docbook @@ -0,0 +1,146 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="details.institutions"> +<chapterinfo> + <authorgroup> + <author> + <firstname>Roger</firstname> + <surname>Lum</surname> + <affiliation> + <address><email>rogerlum@gmail.com</email></address> + </affiliation> + </author> + </authorgroup> + <date>2009-05-05</date> + <releaseinfo>1.0</releaseinfo> +</chapterinfo> + +<title id="details.institutions.title">Institutions</title> + +<para> + The Institutions screen provides a summary of all the accounts grouped under + their respective institutions. Asset accounts are symbolized with a black + arrow, and liability accounts are symbolized with a red arrow. +</para> + +<para> + The Institutions screen displays several columns, including the type of + account and the value of each account. It also shows the total value of all + accounts in each institution. +</para> + +<para> +<screenshot> + <screeninfo>institution view</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="institution_view.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>institution view</phrase> + </textobject> + </mediaobject> +</screenshot> +</para> + +<sect1 id="details.institutions.institution"> +<title>Institution Options</title> + +<para> + Right-clicking an institution name brings up an Institution Options sub-menu, + providing you with several choices. Selecting <guimenuitem>New + Institution...</guimenuitem> opens the New Institution Dialog, where you can + enter all the necessary information to create a new institution. Selecting + <guimenuitem>Edit Institution...</guimenuitem> brings up an editable window + with institution details such as name and address. Selecting + <guimenuitem>Delete Institution</guimenuitem> removes the entire institution + and all its associated accounts. Keep in mind that you will only be able to + delete an institution if you can delete all of its accounts, and you will only + be able to delete each associated account if it has no transactions and no + schedules refers to it. Selecting <guimenuitem>New account...</guimenuitem> + steps you through the new account process, which is described in more detail + in the next section. +</para> + +<para> +<screenshot> + <screeninfo>Institution options sub-menu</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="institution_options.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Institution options sub-menu</phrase> + </textobject> + </mediaobject> +</screenshot> +</para> + +<sect2 id="details.institutions.new"> +<title>New Institution</title> + +<para> + <screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="newinst.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>New Institution</phrase> + </textobject> + </mediaobject> + </screenshot> +</para> + +<para> + <emphasis> + NOTE: 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 create a <link + linkend="firsttime-3">new file</link>. + </emphasis> +</para> + +<para> + Only the name is required in the New Institution Dialog, all other fields are + optional. As with the personal information dialog, this data is not currently + used by &kappname;, but will be required by future releases for certain + features. In particular, the Routing Number and the <acronym><ulink + url="http://en.wikipedia.org/wiki/ISO_9362">BIC (Bank Identifier + Code)</ulink></acronym> will be required for online banking. +</para> +</sect2> +</sect1> + +<sect1 id="details.institutions.account"> +<title>Account Options</title> + +<para> + Right-clicking an account name brings up an Account Options sub-menu. + Selecting <guimenuitem>New account...</guimenuitem> steps you through the new + account process. Selecting <guimenuitem>Open Ledger</guimenuitem> brings you + directly to the Ledgers view or Investments view, depending on the account + type. Simply double-clicking an account name also opens the account. Selecting + <guimenuitem>Edit account</guimenuitem> brings up a window allowing you to + change an account's name, start date, associated banking institution, and + parent account. Deleting an account is only possible if there are no + transactions associated with that account. Selecting + <guimenuitem>Reconcile...</guimenuitem> opens up the Reconcile Wizard, which + steps you through the process of comparing your bank account statements to + your electronic entries. More details, as well as information about the other + options is presented in the appropriate sections of this manual. +</para> + +<para> +<screenshot> + <screeninfo>account options sub-menu</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="account_options.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>account options sub-menu</phrase> + </textobject> + </mediaobject> +</screenshot> +</para> +</sect1> +</chapter> diff --git a/doc/en/details-integrity.docbook b/doc/en/details-integrity.docbook new file mode 100644 index 0000000..048dcf7 --- /dev/null +++ b/doc/en/details-integrity.docbook @@ -0,0 +1,6 @@ +<chapter id="details.integrity"> +<title>Integrity Checks - Under development - UNASSIGNED</title> +<para> +</para> +</chapter> + diff --git a/doc/en/details-investments.docbook b/doc/en/details-investments.docbook new file mode 100644 index 0000000..e9cae48 --- /dev/null +++ b/doc/en/details-investments.docbook @@ -0,0 +1,623 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="details.investments"> +<chapterinfo> + <authorgroup> + <author> + <firstname>Ace</firstname> + <surname>Jones</surname> + <affiliation> + <address><email>acejones@users.sourceforge.net</email></address> + </affiliation> + </author> + </authorgroup> + <date>2009-06-14</date> + <releaseinfo>1.0</releaseinfo> +</chapterinfo> + +<title>Investments</title> + +<sect1 id="details.investments.overview"> +<title>Investments in &kappname;</title> + +<sect2> +<title>Investments</title> + +<para> + Investments are instruments for investing money that are traded on a market. + Stocks, bonds, and mutual funds are the most common investments; so they are + the ones supported most directly. Futures, commodities, options, and more + complex derivatives are also sometimes used, but &kappname; has no special + functionality for them. As long as they behave like a stock or a bond, they + can be tracked easily. +</para> +</sect2> + +<sect2> +<title>Base Currency</title> +<para> + Each investment has a Base Currency. This is the 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, and one on an Australian market would be in + Australian dollars. +</para> +</sect2> + +<sect2> +<title>Investment Accounts</title> +<para> + Investment Accounts hold a collection of investments. An Investment account + contains transactions, such as buys and sells, of those investments. All + transactions in an Investment account must relate to a specific investment. + There is no separate <quote>cash balance</quote> in an investment account. For + that, you need a Brokerage Account. +</para> +</sect2> + +<sect2> +<title>Brokerage Accounts</title> +<para> + An investment account often has an associated Brokerage Account. This is also + sometimes referred to as a <quote>Cash Account</quote>. Investment accounts + cannot contain cash transactions, like a transfer from your bank. When a + stock is sold, the proceeds are typically placed in the Brokerage Account. +</para> + +<para> + When you create an Investment Account, you have the option of creating an + associated Brokerage Account with it. +</para> + +</sect2> + +</sect1> + +<sect1 id="details.investments.investment"> +<title>Creating an Investment Account</title> + +<para> + The first step on the path to working with investments is to create an account + to hold your investments. Choose <menuchoice><guimenu>Account</guimenu> + <guimenuitem>New account...</guimenuitem></menuchoice> to begin the process of + adding a new account. Create an account as usual, making sure to choose + <quote>Investment</quote> as the type of account. +</para> + +<para> + To work with the new investment account, navigate to the + <guibutton>Investments</guibutton> view, and choose the account you have just + created from the <guilabel>Select Account</guilabel> dropdown box. +</para> +</sect1> + +<sect1 id="details.investments.securities"> +<title>Adding Investments to Your Account</title> + +<para> + To add individual Investments to your Investment Account, navigate to + the <guibutton>Investments</guibutton> view, and choose the account where the + investment is held from the <guilabel>Select Account</guilabel> drop-down box. +</para> + +<para> + Right-click the mouse in the empty space in the view. This brings up + the <guimenu>Investment Options</guimenu> context menu. Choose + <guimenuitem>New...</guimenuitem> from this menu. This launches the + <guilabel>New Investment Wizard</guilabel> which you use to create your new + Investment. +</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, whether + it's a stock, bond, etc. +</para> + +<para> + Next, the investment details page is presented. The following information is + entered on this page: +</para> + +<itemizedlist> + <listitem><para> Trading Symbol. The ticker symbol used to identify the + investment on whatever market it trades. &kappname; requires a trading + symbol for all investments; however some investments do not have symbols. + In this case, you will need to make up a symbol for it. + </para></listitem> + + <listitem><para> Full name. The friendly, readable name of the investment + you're creating, e.g., <quote>Advanced Micro Devices, Inc.</quote> This name is + also referred to as the security. + </para></listitem> + + <listitem><para> Fraction. The degree of precision to which your holdings are + measured. For example, in the US most mutual funds measure holdings to + three decimal places, so you would enter 1000 in this field. Stocks are + often measured to only whole units, so you could enter 1 for a stock like + this. + </para></listitem> + + <listitem><para> Trading market. Where the stock trades. This is an optional + field which is provided for your convenience. This information is not used + anywhere else in &kappname;. + </para></listitem> + + <listitem><para>Identification. An optional field to enter additional + identification information you might like to keep track of. Again, this + information is not used anywhere else. + </para></listitem> + + <listitem><para>Trading currency. The underlying currency in which this + investment trades on its market. + </para></listitem> + + <listitem><para> Price entry. Choose whether the price will be entered as an + individual price, or as the total for all shares. + </para></listitem> +</itemizedlist> + +<para> + If you are using Online Quotes, 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. For example, + Rubicon Limited on the New Zealand market should be entered as + <quote>RBC.NZ</quote>. +</para> + +<para> + Finally, you're presented with the Online Update screen. This is where you + tell &kappname; how you would like to update the prices of your investment. + The following items are set here: +</para> + +<itemizedlist> + <listitem> + <para> + Use Finance::Quote. This is an option for GnuCash users who are used to + this style of quotes. Most users can leave this unchecked. + </para> + </listitem> + + <listitem> + <para> + Online Source. The online source you'd like to use for this particular + investment. The most common choice is <quote>Yahoo</quote>. Try that + first, and if the investment cannot be found using this source, then + experiment with the others. + </para> + </listitem> + + <listitem> + <para> + Factor. A multiplier that should be applied to quotes retrieved for this + investment. This is most commonly needed for UK stocks where the price + quoted is in pence (1/100), and the stock is denominated in pounds. In + this case, enter 0,01 for the Factor. + </para> + </listitem> +</itemizedlist> +</sect2> +</sect1> + +<sect1 id="details.investments.edit"> +<title>Editing an Investment</title> + +<para> + The Investment view window lists your current holdings in this account, along + with their symbol, value, and price. Right-click the mouse on any of the + investments to bring up the <guimenu>Investment Options</guimenu> context + menu, where you have the option to add, edit, or delete individual investments + from this account. Also, you can update the price of your investments here + either manually or via their online source. In addition, it is possible to + close an empty account, or to reopen a closed account. +</para> +</sect1> + +<sect1 id="details.investments.ledger"> +<title>Investment Transactions</title> + +<para> + <screenshot> + <screeninfo>Investment Transaction Form</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="investment-transactionform.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Investment Transaction Form</phrase> + </textobject> + </mediaobject> + </screenshot> +</para> + +<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 are different, and vary depending on the + investment transaction type or activity. Investment transactions have some + additional elements: +</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 stock. The following activities are supported: +</para> + +<itemizedlist> + <listitem> + <para> + Buy/Sell. Use to record purchases or sales of individual investments. + This action requires an account to transfer the funds from/to. + </para> + </listitem> + + <listitem> + <para> + Dividend/Yield. Also known as a <quote>Cash Dividend</quote>, this action + is used for when you receive an interest or dividend disbursement from + your investment. This action requires an account to transfer the funds + from/to. + </para> + </listitem> + + <listitem> + <para> + Reinvest Dividend. This is a dividend where the proceeds are re-invested + back into the investment. + </para> + </listitem> + + <listitem> + <para> + Add/Remove Shares. A simple increase or decrease in your balance. 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. + </para> + </listitem> + + <listitem> + <para> + Split Shares. 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 + </para> + </listitem> +</itemizedlist> +</sect2> + +<sect2> +<title>Security</title> +<para> + Each investment transaction must be associated with an individual security, + which is here just another name for an investment. Choose the investment name + when adding or editing a transaction. The symbol will be displayed when + viewing it. +</para> +</sect2> + +<sect2> +<title>Account</title> +<para> + For any transactions which generate or require money, you must enter the + account where the money is transferred to/from. If your investment account + has an associated brokerage account, it's usually best to transfer the funds + there. This applies to funds for purchase or sale of the investment, as well + as for fees paid or interest or dividends earned. +</para> +</sect2> + +<sect2> +<title>Shares, Price & Total Amount</title> +<para> + For buy, sell, and cash dividend transactions, the number of shares, the price + per share, and the total amount of the transaction must be established. You + can enter any two of these, and &kappname; will calculate the third. It's + usually best to enter just the total amount and the number of shares, because + these are the known facts of the transaction. The price per share can be + calculated from these. +</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. +</para> +</sect2> + +<sect2> +<title>Interest</title> +<para> + This is how you enter an interest or dividend payment from an invenstment. 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> + +<sect1 id="details.investments.foreign"> +<title>Working With Foreign Investments</title> + +<para> + &kappname; supports multiple currencies and investments, and you may want to + combine the two. However, doing so requires extra care. As noted above, when + you added an investment, you had to specify its trading currency. This might + not be the same as your base currency, and it also might not be the same as + the account in which you hold the stock or the account where you transfer your + funds to/from for buys/sells. +</para> + +<para> + Consider a hypothetical case. Your base currency is USD. You have an + investment account in EUR, and a brokerage account also in EUR. In that + account, you hold shares of TietoEnator, which is traded in SEK. +</para> + +<para> + When you enter a buy transaction on this investment, use SEK as the currency. + So if you buy 100 shares at a price of SEK 248.00, for a total of SEK + 24,800.00, enter 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> +</para> + +<para> + When you finish the transaction, you will be prompted for a price update to + the investment account's currency, in this case, SEK -> EUR. Review the + documentation on <link linkend="details.currencies.prices">Entering Prices + Manually</link> for more information on the price dialog. +</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. +</para> +</sect1> + +<sect1 id="details.investments.prices"> +<title>Updating Prices</title> +<para> + There are two ways of updating the prices for your investments. You can + either enter the new price manually or have &kappname; 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. +</para> +</sect2> + +<sect2 id="details.investments.onlinequotes"> +<title>Online Price Quotes</title> +<para> + &kappname; has the ability to download the latest prices for your investments + and currencies via the web. +</para> + +<sect3> +<title>How Online Quotes Work</title> +<para> + At your request, &kappname; will fetch a page from the web that contains the + latest price for each item. By default, prices are fetched from + http://finance.yahoo.com, and are subject to the terms and conditions of that + site. +</para> + +<para> + The online quote lookup uses the investment's trading symbol to find the + price. Therefore, it's 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 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 http://finance.yahoo.com. +</para> +</sect3> + +<sect3> +<title>Assigning a Quote Source</title> + +<para> + In order to get online price quotes, you first have to enable it for each + investment 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 + recommended default source, and should work for most investments and all + currencies. +</para> + +<para> + To assign a quote source to an investment, navigate to the investment summary + view for the account in which the security is held. Edit the security by + right-clicking it and selecting <guimenuitem>Edit Investment + ...</guimenuitem>. In the Investment Detail Wizard, + click <guibutton>Next</guibutton> twice, for the Online Update section. In + the Online source dropdown box, select the online source. +</para> + +<para> + Versions of &kappname; 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 + <ulink url="http://finance-quote.sourceforge.net"> + http://finance-quote.sourceforge.net</ulink> for more information. +</para> +</sect3> + +<sect3> +<title>Adjusting a quote</title> + +<para> + Some online sources do not report the price in a base quantity (e.g., EUR) but + in a fraction (e.g., Cent). Using this information as 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 + 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. +</para> +</sect3> + +<sect3> +<title>Fetching Quotes</title> + +<para> + Typically, you will update the prices for all your investments and currencies + at once. Choose the <menuchoice><guimenu>Tools</guimenu><guimenuitem>Update + Stock and Currency Prices...</guimenuitem></menuchoice> menu option to bring + up the online price quotes dialog. Press <guibutton>Update All</guibutton> to + fetch quotes for all investments and currencies in your &kappname; file. +</para> + +<para> + <screenshot> + <screeninfo>Update Stock and Currency Prices</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="investment-onlineupdate.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Online Stock and Currency Price Update</phrase> + </textobject> + </mediaobject> + </screenshot> +</para> +</sect3> + +<sect3> +<title>Adding or Editing Quote Sources</title> + +<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. +</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 <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure + &kappname;</guimenuitem></menuchoice>. 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> + +<para> + The first thing to worry about in an online quote source is the URL. This is + the page that is fetched from the web. You will see a %1 in all sources, and + a %2 in currency sources. For investments, %1 is replaced by the trading + symbol. For currencies, %1 is replaced by the From currency, and %2 is + replaced by the To currency. This URL is then fetched, all HTML tags are + removed, and that stripped file is then sent to the page parser. +</para> + +<para> + Note that the URL can also be a file: URL, which the quote fetcher takes to + mean 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 + <quote>file:/path/to/getquote.sh %1</quote>. +</para> + +<para> + The page parser looks for a symbol, a date, and a price. Regular expressions + tell it how to extract those items from the page. Please review the + documentation for the <ulink + url="http://qt.nokia.com/doc/3.3/qregexp.html#1">QRegExp class</ulink> at + http://qt.nokia.com/doc/3.3/qregexp.html#1 for the exact makeup of the + regular expressions. There should be exactly one capture expression, + surrounded by parentheses, in each regexp. 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. +</para> +</sect3> +</sect2> +</sect1> + +<sect1 id="details.investments.unimplemented"> +<title>Unimplemented Features</title> +<para> + Certain common features that are normally found with investments are not yet + implemented in &kappname;. These include: Derivatives (options, futures, + etc), capital gains, and tax reporting for investments. +</para> +</sect1> +</chapter> diff --git a/doc/en/details-ledgers.docbook b/doc/en/details-ledgers.docbook new file mode 100644 index 0000000..18f2166 --- /dev/null +++ b/doc/en/details-ledgers.docbook @@ -0,0 +1,674 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="details.ledgers"> +<chapterinfo> + <authorgroup> + <author> + <firstname>Michael</firstname> + <othername>T.</othername> + <surname>Edwardes</surname> + <affiliation> + <address><email>mte@users.sourceforge.net</email></address> + </affiliation> + </author> + <author> + <firstname>Roger</firstname> + <surname>Lum</surname> + <affiliation> + <address><email>rogerlum@gmail.com</email></address> + </affiliation> + </author> + </authorgroup> + <date>2009-07-23</date> + <releaseinfo>1.0</releaseinfo> +</chapterinfo> + +<title>Ledgers</title> + +<sect1 id="details.ledgers.view"> +<title>The Ledger View</title> + +<para> + The Ledger view is where most of the functionality of &kappname; lies. This + view is for examining and entering transaction data in the various + accounts. The view is split into three main areas: the filter area, the + transaction list, and the input area. +</para> + +<para> + This view allows for several key actions: searching and viewing transactions, + entering new transactions, and editing or deleting existing + transactions. Other functionality includes modifying account details and + reconciling the account. +</para> + +<para> + <screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="ledgerview-numbered.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Ledger View</phrase> + </textobject> + </mediaobject> + </screenshot> +</para> + +<para> + The view has three elements: +</para> + +<itemizedlist> + <listitem><para>The filter area</para></listitem> + <listitem><para>The transaction list</para></listitem> + <listitem> + <para> + The transaction input form, which may or may not appear, depending upon + your configuration. + </para> + </listitem> +</itemizedlist> + +<sect2> +<title>The filter area</title> + +<para> + <screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="accountdropdown.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Filter area</phrase> + </textobject> + </mediaobject> + </screenshot> +</para> + +<para> + You can select an account via the account dropdown list at the top of the view + area. Note that depending upon the type of the account the <link + linkend="details.ledger.transactionform">transaction input form</link> at the + bottom of the view changes. +</para> + +<para> + To the right of the account dropdown list, are two additional fields. The + search box acts as a filter on the transactions that are shown in the list + view. Only transactions that include the text typed in the search box are + displayed. The text specified can be in any of the fields of the transaction. + The status field is a dropdown list. Only transactions of the type selected in + that dropdown are displayed. +</para> + +</sect2> + +<sect2> +<title>The transaction list</title> + +<para> + <screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="translist.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Transaction list</phrase> + </textobject> + </mediaobject> + </screenshot> +</para> + +<para> + After you have entered a transaction, it is displayed in the transaction list. + You can also change transaction properties or even create new transactions + directly in the list. In the transactions list, the default arrangement of + transactions is sorted by date with the most recent transaction on the bottom. + Clicking the Right Mouse Button on the header of the transaction list brings + up a dialog that allows you to change the sort order of the transactions. You + can change the default sort order in the <link + linkend="details.settings.register.sorting">Sorting tab</link> section of the + <link linkend="details.settings">&kappname; Settings</link> Chapter. +</para> +</sect2> + +<sect2> +<title>The transaction input form</title> + +<para> + The exact layout of the bottom area of the ledger view depends on your + configuration and the type of account being displayed. However, it generally + includes fields for all the details of a single transaction, as well as + buttons for various actions that can apply to a transaction. It is described + in more detail in the following sections. +</para> +</sect2> +</sect1> + +<sect1 id="details.ledger.transactions"> +<title>Entering Transactions</title> + +<para> + There are two methods of entering transactions into the ledger: using the + transaction input form and entering the data directly into the transaction + list. The transaction input form is displayed by default and this is the + method we will discuss first. +</para> + +<para> + The fields in the input area match the information fields in the transactions + list. Additional fields include the Memo field, for a more detailed + description of the transaction, and a Category selection. The Split button + allows you to split the transaction into multiple categories. +</para> +</sect1> + +<sect1 id="details.ledger.transactionform"> +<title>Using the transaction input form</title> + +<para> + <screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="transactionform.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Transaction Form</phrase> + </textobject> + </mediaobject> + </screenshot> +</para> + +<para> + The transaction input form at the bottom of the ledger view is the interface + for creating transactions. +</para> + +<para> + Depending upon the type or method of transaction you wish to enter there are + several tabs available on the transaction form. Click on the tab that best + describes your transaction (deposit, transfer, or withdrawal) and the form + will load several fields ready for your input. +</para> + +<para> + Please note that the actual transaction method is not used directly by + &kappname; but is purely for grouping/reporting purposes. +</para> + +<para> + If you are unsure which method to choose simply use Deposit for any money + going into the account, Withdrawal for money coming out of the account, and + Transfer for money moving from one account to another. The transaction + methods and the differences between them are discussed in more detail + elsewhere. +</para> + +<para> + Select the transaction method by clicking on one of the tabs. +</para> + +<sect2> +<title>The fields of a transaction</title> + +<para> + Enter the information using the following notes on the available fields. Note + that many fields have 'Auto Completion' turned on. That is, if you start + typing, &kappname; will offer alternatives matching the characters you have + entered so far. To select an entry click on it using the mouse or keyboard, + or if your entry is not listed keep typing to add the new value. The next + time you type the value in, &kappname; will find it for you after the first + few characters have been input. +</para> + +<sect3> +<title>The Payee</title> + +<para> + The Payee is who the money came from/to. If the payee is a new entry + &kappname; will ask if you wish to add this to the list of Payees. Any other + information related to a payee or payer, such as address details can be + updated in the Payees view later. +</para> +</sect3> + +<sect3> +<title>The Category</title> + +<para> + The Category associates a transaction with an income or expense category for + accounting and reporting purposes, and enables you to group certain + transactions. Type the name of the category into the required field. If you + have entered the category and it does not exist then &kappname; will ask if + you want to create a new one. +</para> + +<para> + If you wish to associate parts of the transaction with different categories, + &kappname; can let you do that. An example transaction might be a cash + machine withdrawal of 50 of which you use 10 on food, 20 on beer and 20 as + spare cash. The transaction will therefore be assigned three categories: + Food, Beer, and Cash. To do this, you need to use <link + linkend="details.ledgers.split">Split Transactions</link>, which is described + in more detail below. +</para> + +<para> + See the special <link linkend="reference.widgets">&kappname; fields</link> + section for more information on how to use this field. +</para> +</sect3> + +<sect3> +<title>The Memo</title> + +<para> + A multi-line memo can be entered if you wish to help you remember what the + transaction was for. +</para> +</sect3> + +<sect3> +<title>The Check Number</title> + +<para> + The check number can be entered if needed. Note that the check number can + always be visible if desired. This is configured in the Settings dialog. +</para> +</sect3> + +<sect3> +<title>The Date</title> + +<para> + The transaction's posting date must be entered to specify when the transaction + took place. See the special <link linkend="reference.widgets">&kappname; + fields</link> section for more information on how the date input field can be + used to make entering dates quicker and easier. +</para> +</sect3> + +<sect3> +<title>The Amount</title> + +<para> + Finally, enter the transaction amount into the required field. Note that a + simple calculator can be displayed, either by clicking the icon to the right + of the amount field, or by entering the % character into the field, or by + entering a formula, as in <emphasis>12 + 3</emphasis>. When entering the plus + sign, the calculator will be opened. +</para> + +<para> + When you are satisfied that all the fields have been filled in correctly, + click on <guibutton>Enter</guibutton>. If you accidentally press or click on + <guibutton>Enter</guibutton> before you have finished entering all the data, + click on <guibutton>Edit</guibutton> to resume entering the data. +</para> +</sect3> +</sect2> +</sect1> + +<sect1 id="details.ledger.direct"> +<title>Directly inputting transactions into the list</title> + +<para> + <screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="transactionform-off.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Direct Transaction Entry</phrase> + </textobject> + </mediaobject> + </screenshot> +</para> + +<para> + The second method of entering transactions into the ledger involves editing + the transaction list itself directly. +</para> + +<para> + To do this you must first let &kappname; know that you don't want to use the + transaction form by opening the settings dialog and unchecking the + <guilabel>Show transaction form</guilabel> option. +</para> + +<para> + This is performed by selecting <guimenu>Settings</guimenu> + <guimenuitem>Configure &kappname;</guimenuitem> from the menu bar and + selecting the <guiicon><inlinemediaobject><imageobject><imagedata + fileref="ledgers_view.png"/></imageobject></inlinemediaobject> + Register</guiicon> icon from the list on the left. The option to uncheck is + labeled <guilabel>Show transaction form</guilabel>. When finished click on + <guibutton>OK</guibutton> to be ready to directly enter transactions. +</para> + +<sect2> +<title>Starting the edit</title> + +<para> + To enter a new transaction into the register you can now either click on an + empty entry, press <keycombo action="simul">&Ctrl;&Insert;</keycombo>, or + click <guibutton>New</guibutton> at the foot of the window. The + <keycap>Up</keycap> and <keycap>Down</keycap> arrow keys let you navigate + through the list. After pressing <keycap>Enter</keycap> or double clicking on + an entry, the transaction list displays the fields required to enter the + transaction and waits for input. +</para> + +<para> + To move through the fields press the <keycap>Tab</keycap> key and when done + press <keycap>Enter</keycap> to save the changes or <keycap>Esc</keycap> to + cancel. +</para> + +<para> + In case the option <guilabel>Use Enter to move between fields</guilabel> is + selected, the <keycap>Enter</keycap> moves to the next field just as the + <keycap>TAB</keycap> key except for the last entry field where it stores the + data. +</para> + +<para> + Which method you use to enter transactions is up to you and is a matter of + personal preference. +</para> +</sect2> +</sect1> + +<sect1 id="details.ledgers.split"> +<title id="details.ledgers.split.title">Split Transactions</title> + +<para> + The Split transaction feature allows you to divide up a transaction into + multiple categories, representing, for example, the different items bought + with a single purchase at a store. +</para> + +<para> + To enter a split transaction, using either the transaction input form or the + transaction list, start a new transaction as normal, including entering the + total amount. Then, instead of selecting a category, click the + <guibutton>Split</guibutton> button. If you have already selected a category, + that becomes the first entry in the split editor screen. +</para> + +<para> + In the split editor screen, double-click an empty line to enter a new + sub-transaction or press <keycombo + action="simul">&Ctrl;&Insert;</keycombo>. Specify the category, add an + (optional) memo, and enter the amount. To save this part of the split, press + the green check mark under the category. To cancel, press the red cross. +</para> + +<para> + After entering a split, the bottom of the split editor shows how much of the + total transaction is still unassigned. After entering all the splits, press + the <guibutton>OK</guibutton> button to save the entire transaction. If there + is still an unassigned amount, you will be prompted to either return to + editing the splits, change the total transaction amount, or leave part of the + transaction unassigned. +</para> + +<para> + Note that the category field in the transaction input form or the transaction + list now displays <emphasis>Split transaction</emphasis>. +</para> + +<para> + <screenshot> + <screeninfo>Split transactions</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="split_transaction.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Split transaction</phrase> + </textobject> + </mediaobject> + </screenshot> +</para> + +</sect1> + +<sect1 id="details.ledger.edit"> +<title>Editing transactions</title> +<para> + To edit a transaction, select it in the list view and either click on + <guibutton>Edit</guibutton> in the transaction input form or right click on + the entry and select <guimenuitem>Edit</guimenuitem> from the popup menu. If + you are editing transactions directly in the list you can edit the transaction + simply by double clicking on an entry or by pressing <keycap>Enter</keycap> + when a transaction is highlighted. +</para> +</sect1> + +<sect1 id="details.ledger.delete"> +<title>Deleting transactions</title> + +<para> + To delete a transaction, select it in the list view, right click on the entry, + and select <guimenuitem>Delete</guimenuitem> from the popup menu when it + appears, or click <guibutton>Delete</guibutton> on the transaction form. +</para> +</sect1> + +<sect1 id="details.ledgers.match"> +<title id="details.ledgers.match.title">Matching Transactions</title> + +<para> + Generally, when importing transactions, either via QIF, OFX, or HBCI, KMyMoney + will automatically attempt to match them against existing transactions. To + allow for differences in the dates, there is a default setting of 4 days, + which may be changed in the settings - Register/Import. Any transactions so + matched will be highlighted in green. On completion of the import, you should + review these and either accept or unmatch them. +</para> + +<para> + If you should find that an imported transaction was not automatically matched + with an existing transaction when it should have matched, then it is possible + to match them manually. Note that there is a difference between manually + matching two transactions and simply deleting one of them, even though they + may appear to have the same effect. Specifically with OFX or HBCI, it is + important not to delete the imported transaction, because you will find that + the next time you import your transactions, the deleted transaction shows up + again. This is because modern import formats like OFX and HBCI use a + <quote>Transaction ID</quote> to identify transactions. When you delete the + imported transaction, the transaction ID goes with it, so the importer has no + way to know this transaction was already imported. +</para> + +<para> + The solution is to tell &kappname; that the transactions are the same, using + the manual matching interface. This allows you to match an imported + transaction with a hand-entered (non-imported) transaction. To do so, select + one of the transactions to be matched by clicking on it, then select the other + by left clicking on it while pressing the Ctrl key, and then select + <guimenuitem>Match</guimenuitem> from the context menu. This changes the + background color to a pale green. This will match and combine the two + transactions together. The values of both transactions must be the same for + the match to work, except that the dates may differ by the window specified in + the settings, as described above. If you are happy with the result, right + click the matched transaction, then select <guibutton>Accept</guibutton>. +</para> + +<para> + During import of online statements - either directly or by importing a + downloaded file - &kappname; performs matching as best as it can based on the + name of the payee and the amount of the transaction. In case of an invalid + match, a matched transaction can be unmatched. +</para> + +<note> + <para> + The matching interface will not allow you to match two transactions which + have both been imported. Likewise, it won't allow matching between two + transactions which have both been entered by hand. + </para> +</note> +</sect1> + +<sect1 id="details.ledgers.cleared"> +<title>Understanding the Cleared State</title> + +<para> + A transaction can have one of three states: non-reconciled, cleared (C), and + reconciled (R). When you enter a transaction, it has state + non-reconciled. Once the bank posts the transaction, the user can clear it + and thus transform it to state (C). When you receive a statement from the + bank, all cleared transactions should be on the statement. +</para> + +<para> + <screenshot> + <screeninfo>Understanding the cleared state</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="cleared_state.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>cleared state</phrase> + </textobject> + </mediaobject> + </screenshot> +</para> + +<para> + When you <link linkend="details.reconcile">reconcile your account</link>, you + actually mark the statements as cleared and check that the difference between + the beginning balance and the cleared transactions equals the ending balance + of the statement. When this is the case, you can 'finish reconciling' which + actually changes the state of all cleared transactions (C) to reconciled (R). +</para> + +<para> + If you try to edit a transaction with at least one split marked as reconciled + (R), you will be warned. +</para> + +<para> + A fourth state is defined (frozen (F)) but there's currently no way to set + it. It is reserved for future use. Nevertheless, if a transaction has at least + one split in state frozen it cannot be edited anymore. +</para> + +</sect1> + +<sect1 id="details.ledgers.settings"><title id="details.ledgers.settings.title">Changing Transaction Settings</title> + +<para> + There are several settings options that change the appearance and behaviour of + the ledger view in terms of transactions. These settings are found by + selecting <guimenu>Settings</guimenu> <guimenuitem>Configure + &kappname;</guimenuitem> from the menu bar, and selecting the + <guiicon><inlinemediaobject><imageobject><imagedata fileref="ledgers_view.png" /> + </imageobject></inlinemediaobject>Register</guiicon> icon from the list on the + left. +</para> + +<para> + Most of the settings are self explanatory. For clarity, several of the + settings are explained below. +</para> + +<itemizedlist> + <listitem> + <para> + Show transaction form (under the Display tab) - toggle to hide the + transaction input area at the bottom of this screen. Transactions can + still be entered directly into an empty line at the end of the transaction + list, through an automatic compact entry area. + </para> + </listitem> +</itemizedlist> + +<para> + These images show what direct transaction entry looks like compared to the + transaction form. +</para> + +<para>The transaction input form</para> + +<para> + <screenshot> + <screeninfo>The transaction form</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="transactionform.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Transaction form</phrase> + </textobject> + </mediaobject> + </screenshot> +</para> + +<para>Transactions entered directly</para> + +<para> + <screenshot> + <screeninfo>Transactions entered directly</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="transactionform-off.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Direct input</phrase> + </textobject> + </mediaobject> + </screenshot> +</para> + +<itemizedlist> + <listitem> + <para> + Keep changes when selecting a different transaction/split - by selecting + the next line in the transaction list or split editor, the changes are + kept, instead of the default behaviour where you have to push the green + check mark to save changes. + </para> + </listitem> +</itemizedlist> + +</sect1> + +<sect1 id="details.ledgers.other"> +<title id="details.ledgers.other.title">Other Functionality</title> + +<para> + Additional options are available from the <guimenu>Transaction + Options</guimenu> menu, accessed by right-clicking any transaction in the + list. +</para> + +<para> + <screenshot> + <screeninfo>The transaction options sub-menu</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="ledger_more.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Transaction options</phrase> + </textobject> + </mediaobject> + </screenshot> +</para> + +<para> + Options include jumping to the Payee's page, creating a schedule, and changing + the reconciled or cleared indication. +</para> + +<para> + To edit the account information from the ledger view, select + <guimenu>Account</guimenu> from the menu bar. From this menu, you can change + the account details, or bring up the Reconcile menu, which allows you to match + transactions against an official bank statement or credit card notice. +</para> +</sect1> +</chapter> diff --git a/doc/en/details-loans.docbook b/doc/en/details-loans.docbook new file mode 100644 index 0000000..d175e73 --- /dev/null +++ b/doc/en/details-loans.docbook @@ -0,0 +1,230 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="details.loans"> +<chapterinfo> + <authorgroup> + <author> + <firstname>Darin</firstname> + <surname>Strait</surname> + <affiliation> + <address><email>darin.strait@ashdar-partners.com</email></address> + </affiliation> + </author> + </authorgroup> +<date>2009-08-03</date> +<releaseinfo>1.0</releaseinfo> +</chapterinfo> + +<title>Loans</title> + +<sect1 id="details.loans.general"> +<title>Understanding Loans</title> + +<para> + This section provides an overview of how &kappname; handles loans. Loan + regulations and customs vary from locality to locality. For detailed + explanations of loans, as well as information on local regulations and + customs, please see other resources. +</para> + +<para> + A loan is an agreement under which a borrower receives money from a lender and + agrees to repay the money at some future date. &kappname; allows you to track + loans by which you, as borrower, borrow money from or, as lender, lend money + to someone else. Most individuals borrow more than they lend, so you will + generally be the borrower and a finance company will generally be the + lender. If you lend money to a family member or a friend, you can use + &kappname; to keep track of this loan as well. +</para> + +<para> + This guide will assume that you are borrowing from some sort of finance + company, but the topics discussed here apply equally well to loans that you + might make to a person. The main difference between borrowing and lending + money is that an expense category is used to keep track of interest when + borrowing money and an income category is used to keep track of interest when + lending money. +</para> + +<formalpara><title>Loan Principal</title> +<para> + The amount that is lent out is called the <quote>loan amount</quote> or + <quote>principal</quote>. +</para> +</formalpara> + +<formalpara><title>Term</title> +<para> + The period of a loan is called its <quote>term</quote> of the loan. At the end + of the term, the entirety of the principal will have been returned to the + borrower. Terms are generally expressed in weeks, months, or years. A term can + also be expressed by the number of payments. For example, a one year loan with + weekly repayments could be described as a one year loan or a loan with 52 + repayments. +</para> +</formalpara> + +<formalpara><title>Repayments</title> +<para> + The repayment of the principal to the lender is generally not done as a lump + sum. Instead, a series of repayments are made, each representing a portion of + the principal. Such repayments are sometimes known as <quote>amortization + payments</quote> and in &kappname; <quote>Amortization</quote> is defined as + the act of paying off a loan in installments. +</para> +</formalpara> + +<formalpara><title>Payment Frequency</title> +<para> + The frequency of installments is referred to as <quote>Payment + Frequency</quote> in &kappname;. Examples of period might be weekly, + bi-weekly, monthly, quarterly, or yearly. In the US, periodic payments are + most commonly made every month, therefore the loan's period is one month. +</para> +</formalpara> + +<formalpara><title>Interest Rate</title> +<para> + For the privilege of being able to use the money, the borrower will pay the + lender a fee called the <quote>interest</quote>, normally expressed as a + percentage of the amount of the principal over a defined period. Interest + rates can be fixed, where the interest rate does not change over the lifetime + of the loan, or variable, where the interest rate can change over + time. Typically, interest payments are included with each periodic repayment. +</para> +</formalpara> + +<formalpara><title>Periodic Repayments</title> +<para> + Since these repayments are generally made on some sort of scheduled basis, + such as weekly, monthly, quarterly, or yearly, they are referred to as + <quote>periodic repayments</quote>. The sum of all periodic repayments plus + the final repayment will add up to the loan principal plus the interest. +</para> +</formalpara> + +<formalpara><title>Fees</title> +<para> + There may be other fees besides interest that are required to be paid with + every installment. These are called <quote>recurring fees</quote>. Examples of + recurring fees include (but are not necessarily limited to): + +<!--would prefer itemized list not in para, but formalpara requires para--> +<itemizedlist> + <listitem> + <para> + <quote>Impound</quote> or <quote>escrow</quote> account + payments. (Payments of this sort are commonly used to hold funds to pay + annual or bi-annual property taxes.) + </para> + </listitem> + + <listitem><para>Mortgage insurance</para></listitem> + + <listitem><para>Disability insurance</para></listitem> + + <listitem><para>Loan account maintenance fees</para></listitem> +</itemizedlist> +</para> +</formalpara> + +<formalpara><title>Summary</title> +<para> + In summary, the borrower receives a lump sum from the lender at the start of + the loan. The borrower makes a periodic payment to the lender. The periodic + payment is the sum of the principal payment (which is used to pay down the + balance of the loan) plus the interest payment (which rewards the lender for + allowing the use of the money by the borrower) plus any recurring fees (which + cover any incidentals.) At the end of the loan, the borrower has paid back the + entire principal. +</para> +</formalpara> +</sect1> + +<sect1 id="details.loans.example"> +<title>Example</title> +<para> + For an example, you might borrow $25,000.00 for a new auto and agree to pay + the bank one payment each month for 60 months. The interest rate on the loan + might be 5.5%. +</para> + +<para> + In this scenario, the loan amount is $25,000.00. The term of the loan is 60 + months or 5 years. The term of the loan could also be described as 60 + payments since there will be one payment per month for 5 years. The repayment + frequency is one month since periodic repayments will be made once a + month. The periodic repayment, which is calculated by &kappname;, would be + $477.53. +</para> + +<para> + A <quote>loan schedule</quote> is a chart or table that shows the date that a + repayment should be made and the amount of each periodic repayment. Often, + these schedules break the periodic payment down into its constituent parts: + the principal repayment, the interest payment, and the recurring fees payment. +</para> +</sect1> + +<sect1 id="details.loans.creation"> +<title>Creating a New Loan</title> + +<para> + In &kappname;, a loan is a type of account. Therefore, to create a new loan, + you begin by selecting <menuchoice><guimenu>Account</guimenu><guimenuitem>New + Account</guimenuitem></menuchoice>. Continue by answering the questions that + the wizard poses to you. +</para> + +<para> + Optionally, a loan can be associated with a particular institution. If you are + borrowing from a mortgage company or a car loan company, you could create an + institution entry that describes this firm and associate the institution with + your loan. If you are borrowing from your Uncle Ted, there is no requirement + to set up an institution. +</para> +</sect1> + +<sect1 id="details.loans.extra-payments"> +<title>Making Extra Principle Repayments On Loans</title> + +<para> + If you would like to make an extra principal repayment, you can do so. + Simply <link linkend="details.ledger.transactions">enter a transaction</link> + using the ledger. This extra repayment of principal will be taken into + account for the interest calculation that happens for the next periodic + payment. +</para> + +<para> + Examples of extra principal payments include (but are not necessarily limited + to): +</para> + +<itemizedlist> + <listitem><para>Contributing an extra $50 a month</para></listitem> + + <listitem> + <para> + Doubling the periodic principal repayment for every period. (The principal + repayment can be found for any particular period by referring to the loan + schedule.) + </para> + </listitem> + + <listitem> + <para> + Making a 13th principal repayment every year. (This assumes a loan that is + repaid in monthly installments.) + </para> + </listitem> +</itemizedlist> + +<para> + Note: If you are doubling the principal repaid with every periodic payment, + you will need to recalculate the loan schedule for each installment. This will + allow there to be an accurate value for the required principal repayment with + each installment. +</para> +</sect1> +</chapter> + diff --git a/doc/en/details-payees.docbook b/doc/en/details-payees.docbook new file mode 100644 index 0000000..6e23438 --- /dev/null +++ b/doc/en/details-payees.docbook @@ -0,0 +1,241 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="details.payees"> +<chapterinfo> + <authorgroup> + <author> + <firstname>Roger</firstname> + <surname>Lum</surname> + <affiliation> + <address><email>rogerlum@gmail.com</email></address> + </affiliation> + </author> + <author> + <firstname>Ace</firstname> + <surname>Jones</surname> + <affiliation> + <address><email>acejones@users.sf.net</email></address> + </affiliation> + </author> + </authorgroup> + <date>2009-06-04</date> + <releaseinfo>1.0</releaseinfo> +</chapterinfo> + +<title id="details.payees.title">Payees</title> + +<para> + The Payees screen provides detailed information about all the payees and + payers involved in transactions. The Payees screen is split into two main + areas: a payees and payers list and a detail area. +</para> + +<para> + The Payees screen allows for viewing the transactions for the selected payee, + updating personal information associated with a particular payee or payer, and + specifying transaction matching criteria. +</para> + +<para> + <screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="payeeview.png" format="PNG" /> + </imageobject> + </mediaobject> + </screenshot> +</para> + +<sect1 id="details.payees.list"> +<title>Payees List</title> + +<para> + A list of payees and payers is on the left side of this screen. The payee list + is sorted alphabetically. To sort in reverse alphabetical order, click on the + Name title at the top of the list. +</para> + +<sect2> +<title>Adding a Payee or Payer</title> + +<para> + To add a payee or payer, right-click on any payee name and choose + <guimenuitem>New payee</guimenuitem>. This creates a new payee called + <quote>New Payee</quote>. Right-click on this payee and select + <guimenuitem>Rename payee</guimenuitem> to enter the name of the new payee or + payer. +</para> +</sect2> + +<sect2> +<title>Renaming a Payee or Payer</title> + +<para> + To rename a payee or payer, simply right-click on the name, select + <guimenuitem>Rename payee</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 Payee or Payer</title> + +<para> + To remove a payee or payer, right-click the name and select + <guimenuitem>Delete payee</guimenuitem>. If the payee has any transactions, + you will be presented with a dialog that allows you to reassign them to a + different payee, and also a check box to enable a deleted name to be added to + the new payee's matching list. +</para> +</sect2> + +</sect1> + +<sect1 id="details.payees.personalinformation"> +<title>Additional Payee Details</title> + +<sect2> +<title>Personal Information</title> + +<para> + To view and edit the personal information associated with a particular payee, + select the payee from the list and select the Address tab. To modify this + information, edit the detail area directly and press the Update button when + finished. +</para> + +<para> +<screenshot> + <screeninfo>The personal information tab</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="payee_info.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Personal information</phrase> + </textobject> + </mediaobject> +</screenshot> +</para> +</sect2> + +<sect2> +<title>Transaction Matching Settings</title> + +<sect3> +<title>Overview</title> + +<para> + &kappname; has the ability to automatically assign the proper payee to imported + transactions. This can be handy when importing transactions from your bank, + when the payee name has extra unnecessary characters, or worse, if the payee + names change. +</para> + +<para> + For example, let's say your monthly mortgage payment comes in from your bank + like this <quote>SUNTRUST BANK MAPLE VALLEY, GA 111506</quote> one month and + then <quote>SUNTRUST BANK MAPLE VALLEY, GA 121606</quote> the next month. You + would really like both of those transactions to be assigned simply to your + payee <quote>SunTrust</quote>. The transaction matching feature is for you! +</para> + +<para> +<screenshot> + <screeninfo>The payee matching tab</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="payee_match.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Payee matching details</phrase> + </textobject> + </mediaobject> +</screenshot> +</para> +</sect3> + +<sect3> +<title>Setting up</title> + +<para> + From the Matching tab, you can set the Transaction Matching Settings. You have + 3 major options: +</para> + +<itemizedlist> + <listitem> + <para> + No Matching. Disables the feature for this payee. This is the default + setting for all payees. + </para> + </listitem> + + <listitem> + <para> + Match on Payee Name. Enables the feature, and uses the payee name itself + as the Match Key + </para> + </listitem> + + <listitem> + <para> + Match on Key. Enables the feature, and allows you to enter one or more + Match Keys of your choosing. In general, entering a plain string will + work perfectly. However, the match keys are actually regular expressions, + so it is possible to match on more complicated patterns. + </para> + </listitem> +</itemizedlist> + +<para> + You can also choose whether you want to ignore the case of the Match Key. If + you choose this option, the Match Key <quote>SunTrust</quote> would match + <quote>SUNTRUST BANK</quote> or <quote>SunTrust Bank</quote>. +</para> +</sect3> + +<sect3> +<title>Importing Transactions</title> + +<para> + When you import transactions using the QIF import, or using a plugin such as + OFX or AqBanking, the Match Keys you have set will be considered. If the + Match Key for one of your payees is found anywhere in the payee of the + imported transaction, the corresponding payee from your list will be assigned + to that transaction. Thus, a Match Key of <quote>SunTrust</quote> will match + <quote>SUNTRUST BANK MAPLE VALLEY,GA</quote> or even + <quote>MORGENSUNTRUST&LOAN</quote>. So choose your Match Keys carefully. + <note><para> If a transaction payee matches more than one Match Key, the + behaviour is undefined. &kappname; will arbitrarily pick one of the matching + payees. </para></note> +</para> +</sect3> +</sect2> +</sect1> + +<sect1 id="details.payees.transactionhistory"> +<title>Viewing Transaction History</title> + +<para> + To view all transactions associated with a particular payee, select the payee + from the list and the Transaction tab in the detail area. Double-clicking a + particular transaction will bring you directly to that transaction in the + Ledgers screen. +</para> + +<para> +<screenshot> + <screeninfo>The transaction tab</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="payee_history.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Transaction history</phrase> + </textobject> + </mediaobject> +</screenshot> +</para> +</sect1> +</chapter> diff --git a/doc/en/details-reconciliation.docbook b/doc/en/details-reconciliation.docbook new file mode 100644 index 0000000..0f9d3f1 --- /dev/null +++ b/doc/en/details-reconciliation.docbook @@ -0,0 +1,188 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="details.reconcile"> +<chapterinfo> + <authorgroup> + <author> + <firstname>Michael</firstname> + <othername>T.</othername> + <surname>Edwardes</surname> + <affiliation> + <address><email>mte@users.sourceforge.net</email></address> + </affiliation> + </author> + </authorgroup> + <date>2009-07-28</date> + <releaseinfo>1.0</releaseinfo> +</chapterinfo> + +<title>Reconciliation</title> + +<sect1 id="details.reconcile.whatis"> +<title>What is reconciliation?</title> + +<para> + Reconciliation is the process of matching the transactions you have entered + into &kappname; with the transactions listed for that account by the + institution. This is most commonly done with the list of transactions in a + statement, be it a bank statement, credit card statement, loan statement, or + any other statement. It can also be done against an on-line listing of the + account, although this is less common. If any discrepancies are found, then + either you or the person who created the statement have made a mistake. +</para> + +<para> + To reconcile an account, choose your account from the drop down box and click + on the <guiicon><inlinemediaobject> <imageobject><imagedata + fileref="reconcile.png"/></imageobject> + </inlinemediaobject>Reconcile</guiicon> icon, select + <menuchoice><guimenu>Account</guimenu> + <guimenuitem>Reconcile...</guimenuitem></menuchoice> or use the key + combination Ctl+Shift+R. +</para> +</sect1> + +<sect1 id="details.reconcile.wizard"> +<title>The reconciliation wizard</title> +<para> + This will open the reconciliation wizard. The first page of the wizard + briefly describes the process you will follow. Click + on <guibutton>Next</guibutton> to actually start the wizard. +</para> + +<para> +<screenshot> + <screeninfo>Reconciliation wizard</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="reconcile1.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Reconciliation wizard</phrase> + </textobject> + </mediaobject> +</screenshot> +</para> + +<sect2 id="details.reconcile.wizard.statement"> +<title>Statement details</title> +<para> + The statement date, starting balance, and ending balance can be found in your + statement. Make sure that the figures match and click on + the <guibutton>Next</guibutton> button. If the figures do not match then + enter the figures as listed on your statement and click on + the <guibutton>Next</guibutton> button. +</para> + +<para> +<screenshot> + <screeninfo>Reconciliation wizard</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="reconcile2.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Reconciliation wizard</phrase> + </textobject> + </mediaobject> +</screenshot> +</para> + +</sect2> + +<sect2 id="details.reconcile.wizard.interest"> +<title>Interest</title> +<para> + If the statement reconciliation is on a bank account or any account with + interest and/or charges fees, then enter these values in the appropriate + fields. A category can be assigned for each of these amounts. +</para> + +<para> +<screenshot> + <screeninfo>Reconciliation wizard</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="reconcile3.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Reconciliation wizard</phrase> + </textobject> + </mediaobject> +</screenshot> + +<note> +<para> + The interest field is for interest you gained. If you have to pay interest, + e.g., for a credit card account, this has to be entered as a charge. +</para> +</note> +</para> + +<para> + Click on <guibutton>Finish</guibutton> to start matching your statement to + what you have entered. Note that this completes the Reconciliation Wizard, + but not the process of reconciliation. As described below, you still need to + clear transactions and then tell &kappname; that the account is reconciled. +</para> +</sect2> + +<sect2 id="details.reconcile.wizard.clearing"> +<title>Clearing transactions</title> +<para> + To mark a transaction as cleared, click on the C column in the list view. A + transaction is cleared when it matches the transaction on your statement. +</para> + +<para> + During the reconciliation, any transaction can be edited to make it match the + statement, and new transactions can be created as usual. +</para> + +<para> +<screenshot> + <screeninfo>Reconciliation wizard</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="reconcile4.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Reconciliation wizard</phrase> + </textobject> + </mediaobject> +</screenshot> +</para> +</sect2> + +<sect2 id="details.reconcile.complete"> +<title>Completing Reconciliation</title> + +<sect3 id="details.reconcile.finish"> +<title>Finishing Reconciliation</title> +<para> + The command frame (just below the transaction list area) displays the + statement amount and the cleared amount. When the difference is zero then the + account is reconciled and you can click the <guibutton>Finish</guibutton> + button. When you do this, &kappname; takes all the transactions which have + been marked as cleared and marks them as reconciled, and the C column changes + to 'R' to reflect the change. In addition, it saves the changes and + records that the account has been reconciled. +</para> +</sect3> + +<sect3 id="details.reconcile.postpone"> +<title>Postponing Reconciliation</title> +<para> + To postpone the reconciliation to a later time, click on + the <guibutton>Postpone</guibutton> button. Any edits you have made to any + transactions, such as marking them cleared, can still be saved before you + exit &kappname;, but you will have to run the reconciliation wizard again in + order to reconcile the account. If you exit &kappname; before clicking either + <guibutton>Finish</guibutton> or <guibutton>Postpone</guibutton>, it has the + same effect as clicking <guibutton>Postpone</guibutton>. +</para> +</sect3> +</sect2> +</sect1> + +</chapter> + diff --git a/doc/en/details-reports.docbook b/doc/en/details-reports.docbook new file mode 100644 index 0000000..e05ec01 --- /dev/null +++ b/doc/en/details-reports.docbook @@ -0,0 +1,456 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="details.reports"> +<chapterinfo> + <authorgroup> + <author> + <firstname>Ace</firstname> + <surname>Jones</surname> + <affiliation> + <address><email>acejones@users.sourceforge.net</email></address> + </affiliation> + </author> + </authorgroup> + <date>2009-07-28</date> + <releaseinfo>1.0</releaseinfo> +</chapterinfo> + +<title>Reports</title> + +<sect1 id="details.reports.avail"> +<title>Available Reports</title> + +<para> +<screenshot> + <screeninfo>Reports View</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="reports_view-all.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Reports View</phrase> + </textobject> + </mediaobject> +</screenshot> +</para> + +<para>@Rob: Pls update Screenshot to include new Charts section</para> + +<para> + The Reports View lists all available reports, grouped under the following + headings. +</para> + +<sect2> +<title>Income and Expenses</title> +<para> + The reports in this section show your income and expenses either for the + current month or for each month in the current year. Of course, the duration + of the overall report and the duration captured by each column can be + configured to your liking. Graphs and Pie Charts also may be produced. +</para> +</sect2> + +<sect2> +<title>Net Worth</title> +<para> + Here there are reports that describe your net worth, either at the current + moment, every month for the current year, or every year of your history. In + addition, there is a 7-day Cash Flow Forecast and a Net Worth Graph. There + are also reports to get the balances for all of your accounts at any given + point in time. +</para> +</sect2> + +<sect2> +<title>Transactions</title> +<para> + This section includes reports that list individual transactions. This is the + best way to print your account register for a specific period of time. The + transactions printed can be grouped together according to your liking by + choosing the appropriate report, such as: +<itemizedlist> + <listitem><para>By Account</para></listitem> + <listitem><para>By Category</para></listitem> + <listitem><para>By Month or Week</para></listitem> + <listitem><para>By Payee</para></listitem> +</itemizedlist> +</para> + +</sect2> + +<sect2> +<title>Cash Flow</title> +<para> + The Cash Flow report is similar to a Transaction report, but it displays all + cash-flow related transactions. +</para> +</sect2> + +<sect2> +<title>Investments</title> +<para> + These reports help you keep track of your investments. They only include + investment accounts. There are a variety of presentation filters and styles, + as shown in this partial list. +</para> +<itemizedlist> + <listitem><para>Investment Transactions: Similar to a Transactions report, + and includes the share price and quantities.</para></listitem> + <listitem><para>Investment Holdings by Account: Shows the current shares, + price, and value for each account.</para></listitem> + <listitem><para>Investment Holdings by Type: Same as the previous report, but + organizes the accounts by type (Stock, Mutual Fund, etc)</para></listitem> + <listitem><para>Investment Performance by Account: Shows the annualized + performance over any period of time. This performs a cash flow analysis of + all money coming into and going out of the account. As a result, this is a + very accurate picture of how well your investments are + doing.</para></listitem> + <listitem><para>Investment Performance by Type: Same as the previous report, + but organizes the accounts by type (Stock, Mutual Fund, + etc)</para></listitem> +</itemizedlist> + +<para> + There are also graphs for Investment Prices and Investment Worth. +</para> +</sect2> + +<sect2> +<title>Taxes</title> +<para> + The tax reports are just like the transactions reports, with the addition that + only Tax related categories are included. This allows you to flag certain + categories as being tax-related, and then get one big report at the end of the + year to see them all in one place. They may be listed either by Category or by + Payee, and for the last fiscal year. +</para> +</sect2> + +<sect2> +<title>Budgeting</title> +<para> + The budgeting reports are similar to net worth reports, but the reports can + display the budget for a given year, or even compare it to the actual income + and expenses for the same period. +</para> +</sect2> + +<sect2> +<title>Forecast</title> +<para> + The forecast reports are just like the net worth reports, but they use the + information to display forecast information. You can display the information + at various levels and for the timeframe of your choosing. +</para> +</sect2> + +<sect2> +<title>General Information</title> +<para> + These reports display non-transaction information about schedules, accounts, + and loans. +</para> +</sect2> + +<sect2> +<title>Charts</title> +<para> + If <link linkend="details.reports.charts">Charts</link> are enabled, this + section lists all the reports which are marked to display a graphical chart as + the default. They are also listed in one of the other sections, but they are + also aggregated here for your easy reference. +</para> +</sect2> + +<sect2> +<title>Favorites</title> +<para> + This section lists all the reports you have marked as a favorite in the report + configuration dialog. They are still listed in one of the other sections, but + they are also aggregated here for your easy reference. Favorite reports are + also included on the financial summary page for even easier reference. +</para> +</sect2> + +<sect2> +<title>Configuring Reports</title> +<para> + To access the report configuration dialog, bring up the report you wish to + configure, and press the <guibutton>Configure</guibutton> button at the top of + the report. +</para> +</sect2> + +</sect1> + +<sect1 id="details.reports.working"> +<title>Working With Reports</title> + +<para> + There are a number of actions you can take on each report. You can access + these by right-clicking the report name in the list of reports. Alternately, + once you have run a report, there are buttons across the top of the view to + invoke each of these: +</para> + +<itemizedlist> + <listitem><para>Chart: Only present if the report is capable of displaying a + chart. Clicking this option toggles between the report and the + chart.</para></listitem> + <listitem><para>Configure: Change the properties of this report. You can + customize the report to your liking and save it for future + use.</para></listitem> + <listitem><para>New: Create a new customized report based on the selected + report.</para></listitem> + <listitem><para>Copy: The report output can be copied to the clipboard to + paste them in another application, like a spreadsheet, for further + analysis.</para></listitem> + <listitem><para>Export: Reports can be saved in &HTML; or CSV + format.</para></listitem> + <listitem><para>Delete: Customized reports can be deleted. The default + reports that ship with KMyMoney cannot be deleted.</para></listitem> + <listitem><para>Close: Close the current report.</para></listitem> +</itemizedlist> +</sect1> + +<sect1 id="details.reports.config"> +<title>Configuring Reports</title> + +<sect2> +<title>Working with custom reports</title> +<para> + You can configure the default reports or create your own from them by + selecting 'New' and then configuring the new report. When you select + 'Configure' you will be presented with the Report Tab. Initially, it is named + the same as the old report with <quote>Custom</quote> added to the end. You + can change the name to whatever you want. You can even name your custom + reports the same as a default report, or the same as another custom + report. Also, you can always use the Comment field to further distinguish + reports. +</para> + +<para> + The Report Configuration dialog has a number of tabs across the top. Each tab + displays options for configuring different aspects of the report. +</para> + +</sect2> + +<sect2><title>Report Tab</title> +<para> + <screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="report_configuration-reporttab.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Report Configuration -Report</phrase> + </textobject> + </mediaobject> + </screenshot> +</para> + +<para> + On this tab, you set the basic properties of this report. +<itemizedlist> + <listitem><para>Report Name: Choose a name for this report.</para></listitem> + <listitem><para>Comment: Enter a comment to help you remember the details of + this report.</para></listitem> + <listitem><para>Convert values to base currency: Select this option to convert + all values in the report to your base currency. Leave it unchecked if you'd + like to see values in their original currency. If currencies are not + converted, then subtotals will not be shown.</para></listitem> + <listitem><para>Mark as favorite report: Check this to cause this report to + show up on the home page and in the group of <guilabel>Favorite + Reports</guilabel>.</para></listitem> +</itemizedlist> +</para> + +</sect2> + +<sect2 id="details.reports.config.rowscolumns"> +<title>Rows/Columns Tab</title> +<para> + On this tab, you configure how you would like the rows and columns to be selected + and organized. This tab presents different configuration options depending on + the style of report you have selected. +</para> + +<para> + <screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="report_configuration-rowscolumns.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Report Configuration -Rows and Columns</phrase> + </textobject> + </mediaobject> + </screenshot> +</para> + +<para>@Rob: Screenshot of rows/columns tab from an income/expense report</para> + +<para> + For income/expense and net worth reports: +<itemizedlist> + <listitem><para>Columns: Choose how large of a time period each column should + encompass</para></listitem> + <listitem><para>Rows: Choose what kind of accounts to display as the rows of + this report</para></listitem> + <listitem><para>Detail: Choose the level of detail required for this + report.</para></listitem> +</itemizedlist> +</para> + +<para>The following levels of detail are available: +<itemizedlist> + <listitem><para>All: Show every category or account.</para></listitem> + <listitem><para>Top-Level: Show only the highest-level categories or accounts, + and roll up the sums of the subordinates categories or accounts into those + values.</para></listitem> + <listitem><para>Groups: Show only the totals of the income, expenses, assets, + or liabilities.</para></listitem> + <listitem><para>Total: Show only the grand totals line.</para></listitem> +</itemizedlist> +</para> + +<para> + For transaction reports: +<itemizedlist> + <listitem><para>Organize by: Choose how to group the transactions in this + report</para></listitem> + <listitem><para>Show Columns: Choose which columns should be shown in the + report. The date and transaction amount are always shown.</para></listitem> + <listitem><para>Include only Tax Categories: Only show categories which have + been marked as tax-related.</para></listitem> + <listitem><para>Include only Investment Accounts: Only show transactions from + investment accounts.</para></listitem> + <listitem><para>Include only Loan Accounts: Only show transactions from loan + accounts.</para></listitem> +</itemizedlist> +</para> + +</sect2> + +<sect2> +<title>Chart Tab</title> +<para>@Rob: Screenshot of chart tab</para> + +<para> + This tab allows you to configure what the report should look like when it is + displayed as a chart. See the <link linkend="details.reports.charts">Graphs + & Charts</link> section for more explanation of the charting functions. +<itemizedlist> + <listitem><para>Chart Type: The visual format of chart + desired.</para></listitem> + <listitem><para>Show grid lines: Whether to print horizontal and vertical grid + lines on the chart.</para></listitem> + <listitem><para>Draw values on chart: Whether to print the data values on the + chart itself for chosen data points.</para></listitem> + <listitem><para>Show chart by default: Whether this report should first be + displayed as a chart when it's opened.</para></listitem> + <listitem><para>Line width: The width of data lines on the + chart.</para></listitem> +</itemizedlist> +</para> + +</sect2> + +<sect2> +<title>Other Tabs</title> +<para> + The other tabs in this dialog are the same as in the Search Transactions + interface. Please refer to + the <link linkend="details.search">documentation</link> on that interface for + details on the other tabs.</para> +</sect2> + +</sect1> + +<sect1 id="details.reports.charts"> +<title>Graphs & Charts</title> + +<sect2> +<title>Viewing as a Chart</title> + +<para> + Each report can be viewed in either textual form or graphical (chart) form. + The same report configuration parameters are used in either case. You can + easily jump back and forth between the textual and graphical forms by pressing + the <guibutton>Chart</guibutton> or <guibutton>Report</guibutton> buttons + along the top of the report view. +</para> + +<para> + Care should be taken to limit the amount of data you choose to display on a + chart. If you are not careful, using the same configuration for both textual + and graphical forms means it's possible to configure a chart to be visually + cluttered, unappealing, and uninformative. &kappname; will not force you to + keep your charts readable and useful! +</para> + +</sect2> + +<sect2> +<title>Available Chart Types</title> + +<sect3> +<title>Line Graph</title> +<para>@Rob: Screenshot of a simple line graph</para> + +<para> + A line graph is one of the most simple forms of a chart. There is one line + for each series. (Usually a series is a single account or category; see below + for more details on that.) The time periods stretch out along the bottom axis, + and the currency values are along the left. +</para> + +<para> + The detail level for each line is controlled in the <link + linkend="details.reports.config.rowscolumns">Rows/Columns</link> Tab of chart + configuration. If you choose the <quote>Top-Level</quote> detail level, there + will be one line for each of the top-most accounts or categories which show + the sum total of all underlying accounts or categories. If you choose + <quote>Groups</quote> it will instead show one line each for Income, Expenses, + Assets, or Liabilities, depending on the other settings. +</para> +</sect3> + +<sect3> +<title>Bar Graph</title> +<para>@Rob: Screenshot of a simple bar graph</para> + +<para> + The bar graph works exactly the same as the line graph, except there is one + bar for each series in each time slice. +</para> +</sect3> + +<sect3> +<title>Pie Chart</title> +<para>@Rob: Screenshot of a simple pie chart</para> + +<para> + The pie chart is the most simple chart available. It shows only one time + slice, as opposed to showing the values across time. This chart shows only + the totals column of whatever report is selected. If your report is + configured to NOT convert values to the base currency, there will be no totals + column, and therefore this report is not useful. +</para> +</sect3> + +<sect3> +<title>Ring Chart</title> +<para>@Rob: Screenshot of a simple ring chart</para> + +<para> + The ring chart is very similar to a pie chart, except there is one + <quote>ring</quote> for each time slice in the report. +</para> +</sect3> + +</sect2> + +</sect1> +</chapter> diff --git a/doc/en/details-schedules.docbook b/doc/en/details-schedules.docbook new file mode 100644 index 0000000..a5945d2 --- /dev/null +++ b/doc/en/details-schedules.docbook @@ -0,0 +1,460 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="details.schedules"> +<chapterinfo> + <authorgroup> + <author> + <firstname>Roger</firstname> + <surname>Lum</surname> + <affiliation> + <address><email>rogerlum@gmail.com</email></address> + </affiliation> + </author> + <author> + <firstname>Michael</firstname> + <othername>T.</othername> + <surname>Edwardes</surname> + <affiliation> + <address><email>mte@users.sourceforge.net</email></address> + </affiliation> + </author> + </authorgroup> + <date>2009-07-21</date> + <releaseinfo>1.0</releaseinfo> +</chapterinfo> + +<title>Schedules</title> + +<sect1 id="details.schedules.intro"> +<title>Introduction</title> + +<para> + <quote> + Schedules maintain information about transactions that occur one or more + times over a specified period of time. + </quote> +</para> + +<para> + Sometimes called a recurring transaction, a schedule provides a means to + record information about a transaction that happen on a regular basis. A + common schedule is your salary. Once a month, or maybe weekly, the company + you work for pays you for services rendered. This payment can happen in many + different ways, but each month or week you will receive a payment that needs + to be recorded. +</para> + +<para> + Because you know these payments are regularly made to you, you can create a + Schedule to record information about the payment and even create the + transaction for you when pay day arrives. +</para> + +<para> + Other types of schedules can also be recorded to reflect money coming in and + out of your accounts. Common expenses, such as utility bills or money + transfers, can be recorded with schedules, along with loan + repayments. Scheduling a payment can also provide a useful reminder that you + need to make a payment. +</para> + +<para> + A schedule consists of two main parts: the scheduling data and the transaction + data. The scheduling data records the occurrence of the schedule, i.e., when + the transaction is to be entered into the ledger and how. The transaction + data records the normal details about the transaction, and will be entered in + to the ledger as-is. +</para> +</sect1> + +<sect1 id="details.schedules.type"> +<title>Types of schedules</title> + +<para> + There are four different types of schedules in the current version of + &kappname;: +</para> + +<itemizedlist> + <listitem><para>Bills</para></listitem> + <listitem><para>Deposits</para></listitem> + <listitem><para>Loans</para></listitem> + <listitem><para>Transfers</para></listitem> +</itemizedlist> + +<sect2> +<title>Bills</title> + +<para> + A Bill Schedule is used for money going out of your account, such as a Gym + membership or a utility bill. +</para> +</sect2> + +<sect2> +<title>Deposits</title> + +<para> + A Deposit Schedule is for money coming into your account, such as a pay check. +</para> +</sect2> + +<sect2> +<title>Loans</title> + +<para> + A Loan Schedule is a special type of schedule and is created when dealing with + <link linkend="details.loans">Loan</link> accounts. +</para> +</sect2> + +<sect2> +<title>Transfers</title> + +<para> + A Transfer Schedule is used for money coming out of one account and going into + another, such as making a credit card payment from your checking account. +</para> +</sect2> + +</sect1> + +<sect1 id="details.schedules.view"> +<title>The schedule view</title> + +<para> + Open the schedule view by clicking on the <guiicon>Schedule + <inlinemediaobject><imageobject><imagedata + fileref="schedule_view.png"/></imageobject></inlinemediaobject></guiicon> icon in + the view selector. +</para> + +<para> + <screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="scheduleview.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Schedule View</phrase> + </textobject> + </mediaobject> + </screenshot> +</para> + +<para> + The schedule view consists of a view area with two tabs along with a + <guibutton>New Schedule</guibutton> button above it. The first tab + <guibutton>List View</guibutton> shows all schedules, grouped by type. The + second tab <guibutton>Calendar View</guibutton> is described in its own + section below. +</para> + +<para> + To create a new schedule click on the button. For Bill, Deposit, and Transfer + schedules, &kappname; will display the new schedule dialog. Loan schedules are + handled differently, and are described in the section on Loans. +</para> +</sect1> + +<sect1 id="details.schedules.new"> +<title>The new schedule dialog</title> +<para> + <screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="newsched_numbered.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>New Schedule</phrase> + </textobject> + </mediaobject> + </screenshot> +</para> + +<para> + A new dialog window is now shown, prompting for the schedule and transaction + data. The requested data includes the following: +</para> + +<orderedlist numeration="upperalpha"> + <listitem><para>Schedule Name</para></listitem> + <listitem><para>Next due date</para></listitem> + <listitem><para>Frequency</para></listitem> + <listitem><para>Payment method</para></listitem> + <listitem><para>Amount</para></listitem> + <listitem><para>Other transaction details</para></listitem> + <listitem><para>Schedule options</para></listitem> +</orderedlist> + +<sect2> +<title>Filling in the fields</title> + +<para> + Enter the name and the date of the next occurrence of this schedule into their + respective fields. The name is how the schedule will be shown in the list + view. Specify how often the schedule should occur, using the Frequency field + and drop down list. For example "every 6 weeks" or "every 3 months". If the + amount varies transaction to transaction make sure to check the + <guilabel>Estimate</guilabel> check box and you will be prompted for the + correct amount when it is entered into the ledger. Fill in all the + transaction fields as you would normally with the ledger view. +</para> +</sect2> + +<sect2> +<title>Modifying the schedule behavior</title> +<para> + At the bottom of the dialog are some optional fields that can modify how the + schedule behaves. If the schedule occurs on a weekend you can choose whether + to enter the transaction on the weekend day, the previous Friday, or the next + Monday. Typically this option is used to replicate some real world operation + such as a bank transaction. +</para> +</sect2> + +<sect2> +<title>Letting &kappname; enter the transaction into the register</title> + +<para> + To let &kappname; automatically enter the transaction for you when needed, + make sure that the check box labeled <guilabel>Enter this schedule into the + ledger automatically when it is due</guilabel> is checked. Otherwise, when + the transaction is due to be entered, &kappname; will open a dialog box asking + you to confirm that you want it to be entered. This behavior is configurable, + and more information can be found in the Settings section. +</para> +</sect2> + +<sect2> +<title>Letting &kappname; know when the schedule will finish</title> + +<para> + If you know how many transactions are left or when they are due to finish, + this information can be entered so the transactions are not entered + indefinitely. Check the appropriate check box and enter the appropriate + information. Only the date or the number of transactions remaining is needed + because the other can be calculated. +</para> + +<para> + When you have entered all the necessary information click on + <guibutton>OK</guibutton> to continue. +</para> +</sect2> + +</sect1> + +<sect1 id="details.schedules.edit"> +<title>Editing schedules</title> + +<para> + To edit a schedule simply select the entry in the list and right click to + bring up the context menu and select <guimenuitem>Edit</guimenuitem>. This + will bring up a dialog similar to the New Schedule dialog, where you can alter + the necessary data. +</para> +</sect1> + +<sect1 id="details.schedules.delete"> +<title>Deleting schedules</title> + +<para> + To delete a schedule simply select the entry in the list and right click to + bring up the context menu and select <guimenuitem>Delete</guimenuitem>. +</para> +</sect1> + +<sect1 id="details.schedules.calendar"> +<title>The calendar view</title> + +<para> + The calendar tab presents the schedules in a calendar format so it is easier + to see when they occur. To switch to the calendar view click on the + <guibutton>Calendar View</guibutton> tab. +</para> + +<para> + <screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="calendarview.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Calendar View</phrase> + </textobject> + </mediaobject> + </screenshot> +</para> + +<para> + The calendar type can be changed using the <guibutton>Select Style</guibutton> + button. Currently only two types exist: Week and Month. The monthly view is + the default, and is usually the most useful. Navigate through the dates using + the controls as you would with the date input control. +</para> + +<para> + On any day with scheduled transactions, the number of transactions scheduled + for that day is displayed on the calendar. +</para> + +<para> + <screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="schedmonthday.png" format="PNG" /> + </imageobject> + </mediaobject> + </screenshot> +</para> + +<para> + To view the schedule(s) that fall on that day, move the mouse cursor over the + highlight and a popup window will be displayed allowing you to view the + schedule summary. +</para> + +<para> + <screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="schedpopup.png" format="PNG" /> + </imageobject> + </mediaobject> + </screenshot> +</para> + +<para> + If more than one schedule falls on that day you can cycle through them using + the arrow buttons in the upper corners of the popup window. +</para> + +<para> + If you find that the display is cluttered with schedules and you only want to + view one type of schedule, then this is possible from the <guibutton>Select + Schedules</guibutton> dropdown. After clicking on this button the different + schedule types are listed and are checked by default +</para> + +<para> + <screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="schedcaltypes.png" format="PNG" /> + </imageobject> + </mediaobject> + </screenshot> +</para> + +<para> + To remove a type from the calendar view simply uncheck it in the list. +</para> + +</sect1> + +<sect1 id="details.schedules.entering"> +<title>Entering scheduled transactions</title> + +<para> + Entering a scheduled transaction means actually entering a transaction into + the appropriate ledger, using the details specified in the schedule. + Scheduled transactions can be entered in one of four different ways: +</para> + +<itemizedlist> + <listitem><para>Manually by right clicking on the list entry</para></listitem> + <listitem><para>Manually via the popup window in the calendar view</para></listitem> + <listitem> + <para> + &kappname; can enter them with or without your interaction upon startup + </para> + </listitem> + <listitem> + <para> + &kappname; can enter them with your interaction during online banking or + import of an electronic bank statement + </para> + </listitem> +</itemizedlist> + +<sect2> +<title>Manually entering scheduled transactions</title> + +<para> + You can enter a scheduled transaction manually by right clicking on the list + entry and selecting <guimenuitem>Enter</guimenuitem> from the popup menu or by + clicking on the <guibutton>Enter</guibutton> button on the popup window in the + calendar view. +</para> +</sect2> + +<sect2> +<title>Confirming the transaction to enter</title> + +<para> + After selecting either method the Enter Scheduled Transaction dialog window is + shown prompting you with the required information that was entered when you + created the schedule. +</para> + +<para> + <screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="enterschedule.png" format="PNG" /> + </imageobject> + </mediaobject> + </screenshot> +</para> + +<para> + This information can be changed, and the changes can be applied to just this + one instance of the schedule or to all subsequent transactions. After + checking that all the data is correct clicking on <guibutton>OK</guibutton> + will add the transaction to the ledger and update the next due date of the + schedule to the next occurence. If you have changed any of the transaction + data a further confirmation of what you changed will be displayed, giving you + a final chance to accept or reject the changes. +</para> + +<para> + <screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="confirmenter.png" format="PNG" /> + </imageobject> + </mediaobject> + </screenshot> +</para> + +<para> + Select what you want to do with the information presented and click + <guibutton>OK</guibutton> or <guibutton>Cancel</guibutton>. +</para> +</sect2> + +<sect2> +<title>Letting &kappname; enter the scheduled transaction(s) for you</title> + +<para> + Alternatively, &kappname; can check which schedules are due upon startup and + enter them for you if the appropriate option was checked when setting up the + schedule. +</para> + +<para> + If the option was not checked then &kappname; will open the previously + mentioned dialog and you can follow the steps mentioned there. &kappname; + will also open the dialog if the amount is an estimate so you can enter the + real amount. +</para> + +<para> + You can also opt to have &kappname; not check which transactions are scheduled + on startup by deselecting the option in the Settings dialog and any overdue + transaction or transactions due 'today' will be shown in the Home view for you + to enter manually. +</para> +</sect2> +</sect1> +</chapter> diff --git a/doc/en/details-search.docbook b/doc/en/details-search.docbook new file mode 100644 index 0000000..6783c57 --- /dev/null +++ b/doc/en/details-search.docbook @@ -0,0 +1,351 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="details.search"> +<chapterinfo> + <authorgroup> + <author> + <firstname>Darin</firstname> + <surname>Strait</surname> + <affiliation> + <address><email>darin.strait@ashdar-partners.com</email></address> + </affiliation> + </author> + </authorgroup> + <date>2009-08-05</date> + <releaseinfo>1.0</releaseinfo> +</chapterinfo> +<title>Search Transactions</title> + +<sect1 id="details.search.general"> +<title>General</title> + +<para> + The <guilabel>Search Transactions</guilabel> dialog searches your data based + on criteria that you specify. You can access the dialog by going to + the <guimenu>Edit</guimenu> menu and selecting + <guimenuitem>Find transactions...</guimenuitem>. +</para> + +<para> + There are two main tabs in this dialog. The <quote>Criteria</quote> tab + displays a number of sub-tabs for specifying the search critera. +</para> + +<para> + The results will be displayed under the <quote>Result</quote> tab after the + search has completed. Below the list of results, &kappname; shows the number + of transactions that met the search criteria. Double-clicking on an + individual transaction in the result list will bring up the appropriate ledger + and display the transaction. +</para> + +<para> + When the <guibutton>Find</guibutton> button is pressed, the search is + initiated and all criteria that have been entered on any tab will be taken + into account. +</para> + +<para> + The <guibutton>Reset</guibutton> button resets all of the fields on all of the + critera sub-tabs back to the defaults. This allows you to specify new search + criteria. +</para> + +<para> + The <guibutton>Close</guibutton> button closes the <guilabel>Search + Transactions</guilabel> dialog box. +</para> + +</sect1> + +<sect1 id="details.search.criteria"> +<title>Search Criteria</title> + +<para> + There are several sub-tabs under the main <quote>Criteria</quote> tab, each of + which allows you to specify different types of search criteria. Below the + area for specifying the criteria, &kappname; lists each of the different types + of criteria that are currently specified for the search. +</para> + +<sect2 id="details.search.text"> +<title>Text</title> + +<screenshot> +<mediaobject> +<imageobject> +<imagedata fileref="find-text.png" format="PNG" /> +</imageobject> +<textobject> +<phrase>Search transactions Dialog, Text tab</phrase> +</textobject> +</mediaobject> +</screenshot> + +<para> + This tab allows you to speicify text to search for. There are also two check + boxes that control how the text is used in the search. +</para> + +<para> + By default, this will match on simple substrings. For example: +</para> + +<para> +<itemizedlist> + <listitem> + <para><quote>Best</quote> will find <quote>Best Cakes, Inc.</quote></para> + </listitem> + <listitem> + <para> + <quote>est</quote> will also find <quote>Best Cakes, Inc.</quote> + </para> + </listitem> +</itemizedlist> +</para> + +<para> + In the dropdown field next to the text field, + select <guilabel>Contains</guilabel> if you want to find transactions that + contain the text, or select <guilabel>Does not contain</guilabel> if you want + to find transactions that do not contain the specified text. +</para> + +<para> + If you check the <guilabel>Case Sensitive</guilabel> box, the search will be + case sensitive. For example, <quote>best</quote> would not find <quote>Best + Cakes, Inc.</quote> if this option is set. +</para> + +<para> + If you check the <guilabel>Treat Text as regular expression</guilabel> box, + the text will be treated as a regular expresssion. For details on how to + craft a regular expression, visit the &Qt; documentation about the + <ulink url="http://qt.nokia.com/doc/3.3/qregexp.html#1">QRegExp + class</ulink>. +</para> +</sect2> + +<sect2 id="details.search.account"> +<title>Account</title> + +<screenshot> +<mediaobject> +<imageobject> +<imagedata fileref="find-account.png" format="PNG" /> +</imageobject> +<textobject> +<phrase>Search transactions Dialog, Account tab</phrase> +</textobject> +</mediaobject> +</screenshot> + +<para> + This tab allows you to specify the accounts that should be searched. +</para> + +<para> + Accounts are displayed in a tree format. Accounts that are marked for search + are indicated with a check box. If you click the <guibutton>All</guibutton> + button, all accounts are marked for searching. If you click the + <guibutton>None</guibutton> button, no accounts will be marked for + searching. Individual accounts can be marked or unmarked by clicking on the + box next to the account name using the left mouse button. A complete hierarchy + of accounts can be marked or unmarked by clicking on the box using the right + mouse button. +</para> +</sect2> + +<sect2 id="details.search.date"> +<title>Date</title> + +<screenshot> +<mediaobject> +<imageobject> +<imagedata fileref="find-date.png" format="PNG" /> +</imageobject> +<textobject> +<phrase>Search transactions Dialog, Date tab</phrase> +</textobject> +</mediaobject> +</screenshot> + +<para> + This tab allows you to specify which dates should be searched. +</para> + +<para> + The <quote>Range</quote> control provides a convenient way to set the From and + To controls. The From and To controls can be manipulated individually. Dates + can be entered manually. The controls will prevent you from entering + non-existing dates. Date values can also be changed by clicking on the up and + down arrows when a particular part of a date is highlighted. Clicking on the + small calendar icon will bring up a calendar to easily select dates. +</para> +</sect2> + + +<sect2 id="details.search.amount"> +<title>Amount</title> + +<screenshot> +<mediaobject> +<imageobject> +<imagedata fileref="find-amount.png" format="PNG" /> +</imageobject> +<textobject> +<phrase>Find Dialog, Amount tab</phrase> +</textobject> +</mediaobject> +</screenshot> + +<para> + This tab allows you to specify what amounts should be searched for. +</para> + +<para> + You can search for an exact amount or for a range of amounts. If you click on + the calculator icon, a small on-screen calculator will pop up to assist you in + entering a value. +</para> +</sect2> + +<sect2 id="details.search.category"> +<title>Category</title> + +<screenshot> +<mediaobject> +<imageobject> +<imagedata fileref="find-category.png" format="PNG" /> +</imageobject> +<textobject> +<phrase>Search transactions Dialog, Category tab</phrase> +</textobject> +</mediaobject> +</screenshot> + +<para> + This tab allows you to specify which categories should be searched. +</para> + +<para> + Categories are displayed in a tree format. Categories that are marked for + search are indicated with a box. If you click the <guibutton>All</guibutton> + button, all categories are marked for searching. If you click + the <guibutton>None</guibutton> button, no categories will be marked for + searching. If you click the <guibutton>Income</guibutton> button, income + categories will be marked and expense categories will be unmarked. If you + click the <guibutton>Expense</guibutton> button, income categories will be + unmarked and expense categories will be marked. +</para> + +<para> + Individual categories can be marked or unmarked by clicking on the box next to + the category name using the left mouse button. A complete hierarchy of + categories can be marked or unmarked by clicking on the box using the right + mouse button. +</para> +</sect2> + +<sect2 id="details.search.payee"> +<title>Payee</title> + +<screenshot> +<mediaobject> +<imageobject> +<imagedata fileref="find-payee.png" format="PNG" /> +</imageobject> +<textobject> +<phrase>Search transactions Dialog, Payee tab</phrase> +</textobject> +</mediaobject> +</screenshot> + +<para> + This tab allows you to specify which payees should be searched. +</para> + +<para> + Payees that are marked for search are indicated with a box. If you click + the <guibutton>All</guibutton> button, all payees are marked for searching. If + you click the <guibutton>None</guibutton> button, no payees will be marked for + searching. Individual payees can be marked or unmarked by clicking on the box + next to the payee name. +</para> + +<para> + If you check the <guilabel>Select transactions without payees</guilabel> box, + only transactions with no payee will be selected. +</para> + +</sect2> + +<sect2 id="details.search.details"> +<title>Details</title> + +<para> + This tab allows you to specify various additional search criteria. +</para> + +<screenshot> +<mediaobject> +<imageobject> +<imagedata fileref="find-details.png" format="PNG" /> +</imageobject> +<textobject> +<phrase>Search transactions Dialog, Details tab</phrase> +</textobject> +</mediaobject> +</screenshot> + +<para> +<itemizedlist> + <title>Type can be one of the following:</title> + <listitem><para>All Types</para></listitem> + <listitem><para>Payments</para></listitem> + <listitem><para>Deposits</para></listitem> + <listitem><para>Transfers</para></listitem> +</itemizedlist> + +<itemizedlist> + <title>State can be one of the following:</title> + <listitem><para>All states</para></listitem> + <listitem><para>Not reconciled</para></listitem> + <listitem><para>Cleared</para></listitem> + <listitem><para>Reconciled</para></listitem> +</itemizedlist> + +<itemizedlist> + <title>Validity can be one of the following:</title> + <listitem><para>Any transaction</para></listitem> + <listitem><para>Valid transaction</para></listitem> + <listitem><para>Invalid transaction</para></listitem> +</itemizedlist> +</para> + +<para> + You can search for a particular transaction number or search for a range of + transaction numbers. +</para> + +</sect2> +</sect1> + +<sect1 id="details.search.results"> +<title>Search results</title> + +<para> + The <quote>Result</quote> tab displays the Date, Account, Details, + Reconciliation status, Payment, and Deposit for each transaction + that matches the search criteria you have entered. Right clicking + on the header row of the results list allows you to alter the sort + order of the results. +</para> + +<para> + Double-clicking on a transaction will display the corresponding + account ledger and focus on the selected transaction. +</para> + +</sect1> + +</chapter> diff --git a/doc/en/details-settings.docbook b/doc/en/details-settings.docbook new file mode 100644 index 0000000..5be4966 --- /dev/null +++ b/doc/en/details-settings.docbook @@ -0,0 +1,705 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="details.settings"> +<chapterinfo> + <authorgroup> + <author> + <firstname>Roger</firstname> + <surname>Lum</surname> + <affiliation> + <address><email>rogerlum@gmail.com</email></address> + </affiliation> + </author> + </authorgroup> + <date>2009-08-03</date> + <releaseinfo>1.0</releaseinfo> +</chapterinfo> +<title id="details.settings.title">&kappname; Settings</title> + +<para> + The settings described below modify the behaviour of &kappname;. These + settings can be changed + through <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure + &kappname;...</guimenuitem></menuchoice>. +</para> + +<sect1 id="details.settings.general"> +<title id="details.settings.general.title">General</title> + +<sect2 id="details.settings.general.global"> +<title>Global options</title> + +<variablelist> + <varlistentry> + <term><guilabel>Startup</guilabel></term> + <listitem> + <para>Choose the initial view upon startup.</para> + <itemizedlist> + <listitem><para>Start with <link linkend="firsttime.mainwindow">home + page</link></para></listitem> + <listitem><para>Start with last selected page</para></listitem> + </itemizedlist> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Price Precision</guilabel></term> + <listitem> + <para>Enter how many digits of precision your prices will have after the + decimal point. For example, setting this to 2 will result in prices + like 35.18, where setting it to 4 might cause the same price to show + 35.1791</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Autosave periodically</guilabel></term> + <listitem> + <para>Check this box if you wish &kappname; to autosave your files + periodically. The default is 10 minutes.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Your fiscal year starts on</guilabel></term> + <listitem> + <para>Enter the starting day and month of your fiscal year</para> + </listitem> + </varlistentry> +</variablelist> +</sect2> + +<sect2 id="details.settings.general.views"> +<title>Views options</title> + +<variablelist> + <varlistentry> + <term><guilabel>Synchronize account selection of ledger and investment + view</guilabel></term> + <listitem> + <para>If this option is selected, selecting an account on the investments + view will change the account selection on the ledger view, and + viceversa.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Icon size of navigation bar</guilabel></term> + <listitem> + <para>Select the size of the icons of the left-side navigation bar.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Show titlebar on each page</guilabel></term> + <listitem> + <para>Whether the title of the current view should be displayed on each + page.</para> + </listitem> + </varlistentry> +</variablelist> +</sect2> + +<sect2 id="details.settings.general.filter"> +<title>Filter options</title> + +<variablelist> + <varlistentry> + <term><guilabel>Don't show unused categories</guilabel></term> + <listitem> + <para>Hide unused categories.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Don't show closed accounts</guilabel></term> + <listitem> + <para>Hide closed accounts.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Show equity accounts</guilabel></term> + <listitem> + <para>Equity accounts are normally hidden. Select this option to show + them.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Don't show finished schedules</guilabel></term> + <listitem> + <para>Hide finished schedules.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Don't show transaction prior to</guilabel></term> + <listitem> + <para>Hide transactions prior to the selected date.</para> + <para>Setting this option to January 1, 1900 is a good way to debug + date-related file import problems.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Don't show reconciled transactions</guilabel></term> + <listitem> + <para>Filter transactions by reconciliation state. Transactions that are + marked as <emphasis>Reconciled</emphasis> will not be shown.</para> + </listitem> + </varlistentry> +</variablelist> +</sect2> +</sect1> + +<sect1 id="details.settings.register"> +<title id="details.settings.register.title">Register</title> + +<para> + These options allow you to modify the behaviour of the transaction registers. +</para> + +<sect2 id="details.settings.register.display"><title>Display tab</title> + +<variablelist> + <varlistentry> + <term><guilabel>Show a grid in the register</guilabel></term> + <listitem> + <para>Show grid lines in the transaction register.</para> + </listitem> + </varlistentry> + + <varlistentry id="details.settings.register.lens"> + <term><guilabel>Use the ledger lens</guilabel></term> + <listitem> + <para>With this option enabled, the ledger will show all lines of detail + for the transaction you have currently selected, even if you have set + the <link linkend="reference.menus.settings.transactiondetail">Show + Transaction Detail</link> menu option turned off.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Show transaction form</guilabel></term> + <listitem> + <para>Show the <link linkend="details.ledger.transactionform">transaction + form</link> at the bottom of the transaction register for entering and + editing transactions. With this option turned off, you edit the + transaction within the register itself.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Always show a No. field</guilabel></term> + <listitem> + <para>Always have the number (<quote>No.</quote>) field when entering or + editing a transaction.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Show group header between transactions</guilabel></term> + <listitem> + <para>Display group headers in the register</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Show header for the previous and current fiscal + year </guilabel></term> + <listitem> + <para>Display group headers for the current and the previous fiscal + year</para> + </listitem> + </varlistentry> +</variablelist> +</sect2> + +<sect2 id="details.settings.register.sorting"> +<title>Sorting tab</title> +<sect3 id="details.settings.register.sorting.normal"> +<title>Normal view tab</title> + +<para> + Choose the sort order of the ledger while in the Normal view. +</para> +</sect3> + +<sect3 id="details.settings.register.sorting.reconciliation"> +<title>Reconciliation view tab</title> + +<para> + Choose the sort order of the ledger while in the Reconciliation view. +</para> +</sect3> + +<sect3 id="details.settings.register.sorting.search"> +<title>Search view tab</title> +<para> + Choose the sort order of the ledger while in the Search view. +</para> +</sect3> +</sect2> + +<sect2 id="details.settings.register.dataentry"> +<title>Data Entry tab</title> + +<variablelist> + <varlistentry> + <term><guilabel>Insert transaction type into No. field for new + transactions</guilabel></term> + <listitem> + <para>Automatically place the type of the transaction, e.g., Deposit, + Withdrawal, etc., in the No. field.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Auto increment check number</guilabel></term> + <listitem> + <para>Have the check number automatically increment whenever entering a + new check transaction.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Keep changes when selecting a different + transaction/split</guilabel></term> + <listitem> + <para>When enabled, selecting a different transaction or split will save + edits to the current transaction.</para> + <para>When disabled, selecting a different transaction will cancel them. + Instead, you must explicitly accept the changes.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Use Enter to move between fields</guilabel></term> + <listitem><para>When enabled, pressing Enter will change the focus to the + next field of the transaction form.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Match names from start</guilabel></term> + <listitem> + <para>Mark this option if you always want to match names e.g., for payees + from the start. If unset, any substring is matched</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Default reconciliation state</guilabel></term> + <listitem> + <para>Select the default reconciliation state for new + transactions.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Auto fill with previous transaction data</guilabel></term> + <listitem> + <para>Select the desired behavior for autofill or deactivate it</para> + <itemizedlist> + <listitem> + <para>No Autofill</para> + </listitem> + <listitem> + <para>Same transaction if amount differs less than X percent</para> + <para>When entering a new transaction with this option, &kappname; + will display a list of previous transaction for the payee and + account. If previous transactions differ in less than X percent, + they will be considered identical. If the percentage is 0, all + previous transactions for the payee and account will be + displayed. When selecting a transaction, all transactions details + except the date will be autofilled with those of the selected + transaction.</para> + </listitem> + <listitem> + <para>With previously most often used transaction for the payee</para> + <para>When entering a new transaction with this option enabled, + &kappname; will fill in all the transaction details based on the + previously most often used transaction with the selected + payee.</para> + </listitem> + </itemizedlist> + </listitem> + </varlistentry> +</variablelist> +</sect2> + +<sect2 id="details.settings.register.import"> +<title>Import tab</title> + +<variablelist> + <varlistentry> + <term><guilabel>Match transaction within days</guilabel></term> + <listitem> + <para>Search for matching transactions within the range of the imported + transaction +/- given days</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Ask for a new payee's default category</guilabel></term> + <listitem> + <para>Whenever a new payee is detected during an import, the user will be + asked for the default category for the payee.</para> + </listitem> + </varlistentry> +</variablelist> +</sect2> +</sect1> + +<sect1 id="details.settings.home"> +<title id="details.settings.home.title">Home</title> + +<para> + These options allow you to customize the appearance of the Home page by + choosing which entries to show on the Home page and the order in which they + appear. +</para> + +<variablelist> + <varlistentry> + <term><guilabel>Payments</guilabel></term> + <listitem> + <para>It shows the first 5 occurrences of your scheduled + transactions</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Preferred accounts</guilabel></term> + <listitem> + <para>It shows the balance and credit of your favorite accounts</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Payment accounts</guilabel></term> + <listitem> + <para>It shows the balance of your asset and liability accounts, except + for the investment accounts</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Favorite Reports</guilabel></term> + <listitem> + <para>It shows a list of your favorite reports</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Forecast</guilabel></term> + <listitem> + <para>It shows a forecast for your asset and liability Accounts</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Networth forecast</guilabel></term> + <listitem> + <para>It shows a chart of your forecast net worth for the next 90 + days</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Assets and Liabilities</guilabel></term> + <listitem> + <para>It shows the balance of all your assets and liabilities</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Budget</guilabel></term> + <listitem> + <para>It shows the budget items for the current month which have a + negative difference compared to the actual income or expense</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>CashFlow</guilabel></term> + <listitem> + <para>It shows an analysis of your cash flow for the current month</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Percentage of default font size</guilabel></term> + <listitem> + <para>Select the size of the font on the Home page</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Remember font size 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 from the Home page by using the mouse-wheel</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Show account limit information</guilabel></term> + <listitem> + <para>Shows the limit of the accounts on the Payment Accounts and + Preferred Accounts sections of the Home page</para> + </listitem> + </varlistentry> +</variablelist> +</sect1> + +<sect1 id="details.settings.schedules"> +<title id="details.settings.schedules.title">Schedules</title> + +<para> + These options allow you to modify the behaviour of + the <link linkend="details.schedules">scheduling features</link>. +</para> + +<sect2 id="details.settings.schedules.startupoptions"> +<title>Schedule startup options</title> + +<variablelist> + <varlistentry> + <term><guilabel>Check schedules upon startup</guilabel></term> + <listitem> + <para>Enables checking the schedule upon startup of &kappname;.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Enter transactions this number of days in + advance</guilabel></term> + <listitem><para>Specify how many days in advance should the scheduled + transactions be entered.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Number of days to preview schedules schedules in + ledger</guilabel></term> + <listitem> + <para>Specify how many days should the schedules show up in the + ledger.</para> + <para>The scheduled transactions will be listed in the ledger. You can + enter or skip the scheduled transactions by right-clicking on + them.</para> + </listitem> + </varlistentry> +</variablelist> +</sect2> +</sect1> + +<sect1 id="details.settings.encryption"> +<title id="details.settings.encryption.title">Encryption</title> + +<para> + These options allow you to modify the data encryption settings. +</para> + +<variablelist> + <varlistentry> + <term><guilabel>Use GPG</guilabel></term> + <listitem> + <para>Enables the use of GPG to encrypt data file. See the section + on <link linkend="details.formats.encrypted">GPG Encryption</link> for + more details.</para> + </listitem> + </varlistentry> +</variablelist> + +<sect2 id="details.settings.encryption.gpgencryption"> +<title>GPG Encryption</title> + +<variablelist> + <varlistentry> + <term><guilabel>Your key</guilabel></term> + <listitem> + <para>Enter the email address or the hexadecimal key id to use for data + encryption.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Additional keys</guilabel></term> + <listitem> + <para>Select additional keys to use for data encryption.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Also encrypt with kmymoney-recover key</guilabel></term> + <listitem> + <para>Encrypts data with the &kappname; recover key. Selecting this + option will allow core &kappname; developers to decrypt your data file + in case you lose your encryption key.</para> + </listitem> + </varlistentry> +</variablelist> +</sect2> +</sect1> + +<sect1 id="details.settings.colors"> +<title id="details.settings.colors.title">Colours</title> + +<para> + These options allow you to change colors within &kappname;. +</para> + +<sect2 id="details.settings.colors.foreground"> +<title>Foreground tab</title> + +<para> + Modify the foreground colors by clicking on the color button and opening a + color select palette. +</para> +</sect2> + +<sect2 id="details.settings.colors.background"> +<title>Background tab</title> + +<para> + Modify the background colors by clicking on the color button and opening a + color select palette. +</para> +</sect2> +</sect1> + +<sect1 id="details.settings.fonts"> +<title id="details.settings.fonts.title">Fonts</title> + +<para> + These options allow you to modify the fonts. +</para> + +<variablelist> + <varlistentry> + <term><guilabel>Use system fonts</guilabel></term> + <listitem> + <para>Select this to use system fonts. Deselecting this option allows you + to customize fonts.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Cell font</guilabel></term> + <listitem> + <para>Specify the custom font to use within each cell.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Header font</guilabel></term> + <listitem> + <para>Specify the custom font to use for the headers of each view.</para> + </listitem> + </varlistentry> +</variablelist> +</sect1> + +<sect1 id="details.settings.onlinequote"> +<title id="details.settings.onlinequote.title">Online Quotes</title> + +<para> + These settings modify how online quotes are retrieved from different online + sources. +</para> + +<para> + This tab allows you to change the online quote sources for &kappname;. + Generally speaking, this is an advanced feature, and should only be attempted + by the most technically adept users. +</para> + +<para> + For more details, please refer to to + the <link linkend="details.investments.onlinequotes">Online Price + Quotes</link> section. +</para> +</sect1> + +<sect1 id="details.settings.forecast"> +<title id="details.settings.forecast.title">Forecast</title> + +<para> + These options allow you to modify the forecast options. +</para> + +<variablelist> + <varlistentry> + <term><guilabel>Number of days to forecast</guilabel></term> + <listitem> + <para>Select how many days you want to forecast. The default is 90 + days</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Number of days of account cycle</guilabel></term> + <listitem> + <para>The normal number of days that your commonly-used accounts go + through an income-expense cycle. For example, if you receive your salary + on a monthly basis, you should select 30 days here.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Day of month to start forecast</guilabel></term> + <listitem> + <para>Select the day of the month when you want to start the + forecast. This would usually be the day when you receive your salary or + other income.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Forecast Method</guilabel></term> + <listitem> + <para>The forecast method to be used.</para> + <para>Scheduled and future transaction forecasts your balance based on the + information of your scheduled and future transactions.</para> + <para>History-based uses your past transactions to extrapolate a + forecast.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Number of cycles to use in forecast</guilabel></term> + <listitem> + <para>If using a history-based method, how many previous account cycles + should &kappname; use to calculate the forecast.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>History forecast method</guilabel></term> + <listitem> + <para>Select the method to use when calculating a forecast based on + historic information</para> + <para>Simple moving average averages your past transactions to calculate a + forecast.</para> + <para>Weighted moving average averages your past transactions, but it will + give more importance to the most recent transactions.</para> + <para>Linear regression uses a linear-regression formula based on your + past transactions to calculate the forecast</para> + </listitem> + </varlistentry> +</variablelist> +</sect1> + +<sect1 id="details.settings.plugins"> +<title id="details.settings.plugins.title">Plugins</title> + +<para> + These options allow you to modify the behavior of any installed + plugins. Currently, the only choice is to enable or disable the &kappname; + plugins you have installed. +</para> +</sect1> +</chapter> diff --git a/doc/en/details-transactions.docbook b/doc/en/details-transactions.docbook new file mode 100644 index 0000000..1c8a9a1 --- /dev/null +++ b/doc/en/details-transactions.docbook @@ -0,0 +1,6 @@ +<chapter id="details.transactions"> +<title>Transactions - Under development - Roger</title> +<para> +</para> +</chapter> + diff --git a/doc/en/details-widgets.docbook b/doc/en/details-widgets.docbook new file mode 100644 index 0000000..fae1595 --- /dev/null +++ b/doc/en/details-widgets.docbook @@ -0,0 +1,211 @@ +<?xml version="1.0" encoding="UTF-8"?> +<sect1 id="reference.widgets"> +<sect1info> + <author> + <firstname>Thomas</firstname> + <surname>Baumgart</surname> + <affiliation> + <address><email>ipwizard@users.sourceforge.net</email></address> + </affiliation> + </author> +</sect1info> + +<title>Widgets</title> + +<para> + &kappname; has some specific widgets not found in other applications. The + usage of these widgets is explained in this chapter. +</para> + +<sect2 id="reference.widgets.datepicker"> +<title>Date entry widget</title> + +<para> + Whenever &kappname; needs information about a specific date, e.g., the posting + date of a transaction or the opening date of an account, it offers the user + the <emphasis>date entry widget</emphasis>. This widget consists of three + fields and a button. The fields present the <emphasis>day</emphasis>, the + <emphasis>month</emphasis>, and the <emphasis>year</emphasis>, separated by + the date separator characters specified by your locale settings. The button - + if pressed - opens the <emphasis>datepicker</emphasis> widget. +</para> + +<para> +<screenshot> + <screeninfo>Tip of the Day</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="date_widget.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Date widget</phrase> + </textobject> + </mediaobject> +</screenshot> +</para> + +<para> + Within the date entry widget, the left/right cursor keys can be used to switch + between the <emphasis>day</emphasis>, the <emphasis>month</emphasis>, and the + <emphasis>year</emphasis> fields. Using the up/down cursor keys, the value of + the selected field can be incremented/decremented. The <keycap>+</keycap> and + <keycap>-</keycap> keys can be used to increment/decrement a single day. + Month and year boundaries are considered and incremented/decremented if + necessary. Pressing <keycap>t</keycap> will set the date to today's date. +</para> + +<para> + The date can also be changed using the mouse. Clicking on the + <emphasis>day</emphasis>, <emphasis>month</emphasis>, or + <emphasis>year</emphasis> field selects the field. The value can then be + incremented/decremented using the arrow buttons on the right of the + widget. They act exactly the same as the up/down key. +</para> + +<para> + The datepicker opens when the button to the right of the arrow buttons is + pressed. It shows four arrow buttons at the top, two on each side of the + currently selected month name and year. The leftmost buttons are used to + decrement the year and the month; the buttons to the right of the year are + used to increment the month and the year. The button to the very right closes + the datepicker. +</para> + +<para> + Beneath the buttons, the widget presents a calendar page for the selected + month. Clicking a day on the calendar selects that date, closes the + datepicker, and transfers the selected date into the <emphasis>day</emphasis>, + <emphasis>month</emphasis>, and <emphasis>year</emphasis> fields. +</para> + +<para> + At the bottom of the datepicker widget, there are a button, a text edit field, + and a combo box. Pressing the button selects today's date in the + datepicker. The text field can be used to enter a specific date. Pressing the + <keycap>RETURN</keycap> key shows that date in the datepicker widget. The + combo box allows the user to select a specific week, and continue to pick a + date from there. +</para> +</sect2> + +<sect2 id="reference.widgets.value"> +<title>Value entry</title> +<para> + The value entry widget consists of a text field (that accepts digits, + thousands separators, and decimal symbols) as well as a button to the + right. Use the digits to enter the value. Separate the fractional part by + entering the decimal separator for your locale. If you click on the button to + the right or press a key representing a numeric operation (e.g., +,-,/,* or %) + a little calculator will pop up and allow you to calculate the final value. +</para> + +<para> + Negative values can be entered by preceeding the value with a minus sign. In + case your locale is set to display negative numbers with parantheses around + the value, the value can also be enclosed in parenthesis in the value entry + widget. +</para> + +<para> +<screenshot> + <screeninfo>Tip of the Day</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="value_widget.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Value widget</phrase> + </textobject> + </mediaobject> +</screenshot> +</para> + +<para> + Use the calculator widget just like a normal calculator and once done leave + it by clicking on the '=' button or press the '=' key on your keyboard. +</para> +</sect2> + +<sect2 id="reference.widgets.payee"> +<title>Payee/Payer entry</title> + +<para> + When you are requested to enter a payee/payer for a transaction, you can start + entering the name by pressing keys on your keyboard. As long as matching + entries exist in the list of payees/payers maintained by &kappname; they will + be presented in a box beneath or above the text entry area. Using the mouse or + the up/down keys one can select a name from that list. Using the keyboard + additionally requires you to select the entry by pressing the RETURN key. +</para> + +<para> +<screenshot> + <screeninfo>Tip of the Day</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="payee_widget.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Payee widget</phrase> + </textobject> + </mediaobject> +</screenshot> +</para> + +<para> + If a name is entered that is not yet known to &kappname; you will be asked if + you want to create a new payee/payer record. If you do not wish to do so, + then the field will be blanked. Otherwise, the record will be created and + added to the list. +</para> + +<para> + Once the edit field contains characters, the list only shows those payees that + match the character sequence entered. Double-click on the arrow of the combo + box to show all payees in the list. +</para> + +</sect2> + +<sect2 id="reference.widgets.category"> +<title>Category/account entry</title> + +<para> + When you are requested to enter the name of a category or account, you can + start entering the name by pressing keys on your keyboard. As long as + matching entries exist in the list of categories/accounts known to &kappname; + they will be presented in a box beneath or above the text entry area. Using + the mouse or the up/down keys one can select a name from that list. Using the + keyboard additionally requires you to select the entry by pressing the RETURN + key. +</para> + +<para> +<screenshot> + <screeninfo>Tip of the Day</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="category_widget.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Category widget</phrase> + </textobject> + </mediaobject> +</screenshot> +</para> + +<para> + If a name is entered that is not yet known to &kappname; you will be asked if + you want to create a new category record. If you do not wish to do so, then + the field will be blanked. Otherwise, the record will be created and added to + the list. +</para> + +<para> + Once the edit field is filled with characters, the list only shows those + categories/accounts that match the character sequence entered. Double-click on + the arrow of the combo box to show the complete list. +</para> + +</sect2> +</sect1>
\ No newline at end of file diff --git a/doc/en/enterschedule.png b/doc/en/enterschedule.png Binary files differnew file mode 100644 index 0000000..5e98ab4 --- /dev/null +++ b/doc/en/enterschedule.png diff --git a/doc/en/find-account.png b/doc/en/find-account.png Binary files differnew file mode 100644 index 0000000..2222243 --- /dev/null +++ b/doc/en/find-account.png diff --git a/doc/en/find-amount.png b/doc/en/find-amount.png Binary files differnew file mode 100644 index 0000000..b07f6e0 --- /dev/null +++ b/doc/en/find-amount.png diff --git a/doc/en/find-category.png b/doc/en/find-category.png Binary files differnew file mode 100644 index 0000000..7d8ace2 --- /dev/null +++ b/doc/en/find-category.png diff --git a/doc/en/find-date.png b/doc/en/find-date.png Binary files differnew file mode 100644 index 0000000..a8fabc5 --- /dev/null +++ b/doc/en/find-date.png diff --git a/doc/en/find-details.png b/doc/en/find-details.png Binary files differnew file mode 100644 index 0000000..ac5de6e --- /dev/null +++ b/doc/en/find-details.png diff --git a/doc/en/find-payee.png b/doc/en/find-payee.png Binary files differnew file mode 100644 index 0000000..af8614b --- /dev/null +++ b/doc/en/find-payee.png diff --git a/doc/en/find-text.png b/doc/en/find-text.png Binary files differnew file mode 100644 index 0000000..7dedb89 --- /dev/null +++ b/doc/en/find-text.png diff --git a/doc/en/finddlg.png b/doc/en/finddlg.png Binary files differnew file mode 100644 index 0000000..b15e1e7 --- /dev/null +++ b/doc/en/finddlg.png diff --git a/doc/en/firsttime.docbook b/doc/en/firsttime.docbook new file mode 100644 index 0000000..df1f676 --- /dev/null +++ b/doc/en/firsttime.docbook @@ -0,0 +1,833 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="firsttime"> +<chapterinfo> + <authorgroup> + <author> + <firstname>Michael</firstname> + <othername>T.</othername> + <surname>Edwardes</surname> + <affiliation> + <address><email>mte@users.sourceforge.net</email></address> + </affiliation> + </author> + </authorgroup> + <date>2009-05-05</date> + <releaseinfo>1.0</releaseinfo> +</chapterinfo> + +<title>Using &kappname; for the first time</title> + +<sect1 id="firstime-1"> +<title>Running &kappname; for the first time</title> + +<para> + Once &kappname; has fully loaded two windows will be opened. The top window, + 'Tip of the Day' offers one of a series of important or useful pieces of + information about the application. + <screenshot> + <screeninfo>Tip of the Day</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="tipofday.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Tip of the Day</phrase> + </textobject> + </mediaobject> + </screenshot> +</para> + +<para> + You are recommended to quickly read through these tips by pressing on the + <guibutton>Previous</guibutton> and <guibutton>Next</guibutton> buttons at the + bottom of the window. +</para> + +<para> + Once you have read the tips the window can be closed; it will re-open each + time &kappname; is started. To stop this default behavior, uncheck the + appropriate option on the Tip of the Day window. +</para> + +<note> + <para> + Tips can be read at anytime by selecting <guimenuitem>Show tip of the + day</guimenuitem> from the <guimenu>Help</guimenu> menu within &kappname;. + </para> +</note> + +<para> + All tips have been extracted from the Frequently Asked Questions list (FAQ) + that provides more detailed help and can be found on the project <ulink + url="http://kmymoney2.sourceforge.net/faq.html">website</ulink> and in this + manual. +</para> + +<para> + Please click on <guibutton>Close</guibutton> to close the Tip of the Day + dialog. +</para> +</sect1> + +<sect1 id="firsttime.mainwindow"> +<title>The main window</title> + +<para> + <screenshot> + <screeninfo>The Main Window</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="mainwindow_numbered.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>The Main Window</phrase> + </textobject> + </mediaobject> + </screenshot> +</para> + +<para> + The &kappname; main window consists of four major parts +</para> + +<itemizedlist> + <listitem><para>A. The menu bar</para></listitem> + <listitem><para>B. The toolbar</para></listitem> + <listitem><para>C. The View selector</para></listitem> + <listitem><para>D. The view</para></listitem> +</itemizedlist> + +<para> + The menu and toolbars provide access to the features of &kappname; and allow + you to <link linkend="firsttime-3">Create</link> files or configure how + &kappname; operates. +</para> + +<para> + The view selector consists of at least eleven icons in the left side of the + main window, depending upon the software provided by your system. More icons + could be added by various plugins. By clicking on an icon, the view window on + the right hand side is loaded with the appropriate view of your financial + data. Each view provides a unique representation of your financial situation + and allows you to view or edit the information shown. +</para> + +<para> + The view selector contains the following icons +</para> + +<itemizedlist> + <listitem> + <para> + <guiicon> + <inlinemediaobject> + <imageobject> + <imagedata fileref="home_view.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Home View</phrase> + </textobject> + </inlinemediaobject> + </guiicon> + Home: A configurable overview of your current financial situation (or an + introduction page when no data file is open). + </para> + </listitem> + + <listitem> + <para> + <guiicon> + <inlinemediaobject> + <imageobject> + <imagedata fileref="institutions_view.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Institutions View</phrase> + </textobject> + </inlinemediaobject> + </guiicon> + Institutions: All of your institutions and accounts displayed in a + hierarchy. + </para> + </listitem> + + <listitem> + <para> + <guiicon> + <inlinemediaobject> + <imageobject> + <imagedata fileref="accounts_view.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Accounts View</phrase> + </textobject> + </inlinemediaobject> + </guiicon> + Accounts: All of your accounts displayed in a hierarchy. + </para> + </listitem> + + <listitem> + <para> + <guiicon> + <inlinemediaobject> + <imageobject> + <imagedata fileref="schedule_view.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Schedules View</phrase> + </textobject> + </inlinemediaobject> + </guiicon> + Schedules: Your recurring bills and deposits. + </para> + </listitem> + + <listitem> + <para> + <guiicon> + <inlinemediaobject> + <imageobject> + <imagedata fileref="categories_view.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Categories View</phrase> + </textobject> + </inlinemediaobject> + </guiicon> + Categories: Special accounts that provide a means for you to group + associated transactions. + </para> + </listitem> + + <listitem> + <para> + <guiicon> + <inlinemediaobject> + <imageobject> + <imagedata fileref="payees_view.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Payees View</phrase> + </textobject> + </inlinemediaobject> + </guiicon> + Payees: All Payees used by &kappname;. + </para> + </listitem> + + <listitem> + <para> + <guiicon> + <inlinemediaobject> + <imageobject> + <imagedata fileref="ledgers_view.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Ledgers View</phrase> + </textobject> + </inlinemediaobject> + </guiicon> + Ledgers: Your account transactions. + </para> + </listitem> + + <listitem> + <para> + <guiicon> + <inlinemediaobject> + <imageobject> + <imagedata fileref="investments_view.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Investments View</phrase> + </textobject> + </inlinemediaobject> + </guiicon> + Investments: Your portfolio summary. + </para> + </listitem> + + <listitem> + <para> + <guiicon> + <inlinemediaobject> + <imageobject> + <imagedata fileref="reports_view.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Reports View</phrase> + </textobject> + </inlinemediaobject> + </guiicon> + Reports: A collection of useful reports, providing alternate views of your + financial data. + </para> + </listitem> + + <listitem> + <para> + <guiicon> + <inlinemediaobject> + <imageobject> + <imagedata fileref="budgets_view.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Budgets View</phrase> + </textobject> + </inlinemediaobject> + </guiicon> + Budgets: Your budgets + </para> + </listitem> + + <listitem> + <para> + <guiicon> + <inlinemediaobject> + <imageobject> + <imagedata fileref="forecast_view.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Forecast View</phrase> + </textobject> + </inlinemediaobject> + </guiicon> + Forecast: This view provides a forecast of your accounts and categories + </para> + </listitem> + + <listitem> + <para> + <guiicon> + <inlinemediaobject> + <imageobject> + <imagedata fileref="outbox_view.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Outbox View</phrase> + </textobject> + </inlinemediaobject> + </guiicon> + Used by the online banking module to provide feedback on running + processes. This is a view provided by the KBanking plugin and may not be + present on your system. + </para> + </listitem> +</itemizedlist> +</sect1> + +<sect1 id="firsttime-3"> +<title>Creating a new file</title> + +<para> + &kappname; keeps all the data about your finances in a file. As was stated in + <link linkend="makingmostof.basicaccounting.personalaccounts">Defining the + accounts (personal records)</link>, you can keep more than one set of + accounts, but the data for each will be kept in a separate file, and + &kappname; can only have one file open at a time. See the chapter on <link + linkend="details.formats">File Formats</link> for more details about + &kappname;'s data files. +</para> + +<para> + To create a new file you can either select + <menuchoice><guimenu>File</guimenu><guimenuitem>New</guimenuitem></menuchoice> + from the menu or choose the <inlinemediaobject><imageobject><imagedata + fileref="new.png"/></imageobject><textobject><phrase>New</phrase></textobject></inlinemediaobject> + icon from the toolbar. +</para> + +<para> + &kappname; will then open the <quote>New File Setup Wizard</quote> which will + guide you through the process of creating the file. +</para> + +<para> + <screenshot> + <screeninfo>Personal Data Page</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="newfile.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Personal Data Page</phrase> + </textobject> + </mediaobject> + </screenshot> +</para> + +<para> + Since all fields are optional, you can use &kappname; without entering any + information now. Any information entered here is used only to personalize + your file. In the future, it may be used in some reports and for online + banking. If &kappname; requires any personal information in future releases + and finds none, you will be prompted to enter the relevant data then. +</para> + +<para> + Please enter your name and address or nothing and press + <guibutton>Next</guibutton>. +</para> + +<para> + In case you have an address for yourself stored in the KAddressbook, the + button <guibutton>Load from Addressbook</guibutton> is enabled and pressing it + imports all information into &kappname;. +</para> + +<para> + &kappname; 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 &kappname; based + upon your locale settings. +</para> + +<para> + <screenshot> + <screeninfo>Base currency selection Page</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="newfile-2.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Base currency selection page</phrase> + </textobject> + </mediaobject> + </screenshot> +</para> + +<para> + The following page allows you to create an initial account. For the typical + &kappname; user this is a checking account. +</para> + +<para> + <screenshot> + <screeninfo>Checking account creation Page</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="newfile-3.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Checking account creation page</phrase> + </textobject> + </mediaobject> + </screenshot> +</para> + +<para> + Enter the name of the account and a possible reference number assigned by the + institution managing the account. Enter the opening date of the account and + the opening balance of the account. For example, you want to use &kappname; + to manage all your finances as of 2008-01-01, then enter the balance of the + account at the beginning of this date. The number can possibly be obtained + from a paper statement. Also enter the name and routing number of the + institution, though this information is optional and only required for online + banking purposes. +</para> + +<para> + In case you don't want to setup an initial account, please uncheck the checkbox +</para> + +<para> + Once finished, press <guibutton>Next</guibutton> to proceed. +</para> + +<para> + <screenshot> + <screeninfo>Account template selection Page</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="newfile-4.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Account template selection page</phrase> + </textobject> + </mediaobject> + </screenshot> +</para> + + +<para> + Choose the appropriate country and account template(s). Multiple templates, + even from multiple countries can be selected using a combination of + <keycap>Ctrl</keycap> and <keycap>Shift</keycap> together with the left mouse + button. The account hierarchy to be setup will be shown in a preview part of + the wizard. In case you cannot find a template that suits your needs, don't + select a template. +</para> + +<para> + Once finished with the template selection press <guibutton>Next</guibutton> to + proceed. +</para> + +<para> + The next page of the wizard allows you to setup user preferences. Press + <guibutton>Next</guibutton> if you are done and want to proceed. +</para> + +<para> + <screenshot> + <screeninfo>Preference Page</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="newfile-5.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Preference page</phrase> + </textobject> + </mediaobject> + </screenshot> +</para> + +<para> + The last page of the wizard allows you to select the filename that will be + used to store your financial data. An initial filename will be constructed out + of your HOME folder and user name. In case the file exists, a warning will + be displayed which reminds you to select a name of a non-existing file. +</para> + +<para> + <screenshot> + <screeninfo>Filename selection Page</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="newfile-6.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Filename selection page</phrase> + </textobject> + </mediaobject> + </screenshot> +</para> + +<para> + Now you have entered all relevant information to create the file. Press + <guibutton>Finish</guibutton> and &kappname; will create the file for you and + open it. +</para> + +<!-- +<para>After &kappname; has finished loading the default accounts your financial +summary will be displayed. As you have defined no accounts to hold your +transactions this is currently empty.</para> +--> +</sect1> + +<sect1 id="firsttime-4"> +<title>Creating accounts</title> + +<para> + You can create an account in one of two ways both of which are described here: +</para> + +<variablelist> + <varlistentry> + <term>Using the menu</term> + <listitem> + <para> + To create an account using the menu select + <menuchoice><guimenu>Accounts</guimenu><guimenuitem>Add new + account</guimenuitem></menuchoice>. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Using the Accounts view</term> + <listitem> + <para> + To create an account using the accounts view click on the Accounts icon + in the view selector and then right click on the Asset tree icon in the + right hand view and select <guimenuitem>New account</guimenuitem> from + the popup menu. The Asset tree holds all of your accounts that are an + asset. Assets, and all the other account types, are discussed in more + detail later in this manual. + </para> + </listitem> + </varlistentry> +</variablelist> + +<tip> + <para> + Note that &kappname; uses the context menus a lot throughout the whole + application. If you find yourself stuck trying to figure out how to do + something, try right-clicking where you would expect to see a feature. + </para> +</tip> + +<para> + Creating a new account by either method opens the <emphasis>New Account + Wizard</emphasis>. This wizard will take you step by step through the process + of creating an account, gathering the required information at each step. To + navigate through the pages click on the <guibutton>Previous</guibutton> and + <guibutton>Next</guibutton> buttons. +</para> + +<para> + Create an account using either of the two previously mentioned methods to + continue. A full description of creating accounts can be found in the <link + linkend="details.accounts">Accounts</link> section. +</para> + +<para> + Now that one or more accounts exist in &kappname;, your account summary is + shown in the Home view. You can create transactions manually in the <link + linkend="details.ledgers">Ledgers</link> view, or set up automatic + transactions through the <link linkend="details.schedules">Schedules</link> + view. +</para> +</sect1> + +<sect1 id="firsttime.schedules"> +<title>Schedules</title> + +<para> + Sometimes called a recurring transaction, a <link + linkend="details.schedules">Schedule</link> is a transaction that occurs one + or more times over a certain period of time. A typical example is your pay + check that you receive every month or week. Rather than have to enter the + transaction details each time you get paid, you can instruct &kappname; to + create a schedule that will enter a transaction for you when you get paid. +</para> + +<para> + To maintain <link linkend="details.schedules">schedules</link> click on the + <guiicon><inlinemediaobject><imageobject><imagedata + fileref="schedule_view.png"/></imageobject></inlinemediaobject>Schedules</guiicon> + icon in the view selector. +</para> +</sect1> + +<sect1 id="firsttime.categories"> +<title>Categories</title> + +<para> + To maintain <link linkend="details.categories">categories</link> click on the + <guiicon><inlinemediaobject><imageobject><imagedata + fileref="categories_view.png"/></imageobject></inlinemediaobject>Categories</guiicon> + icon in the view selector. +</para> + +<para> + A full description of this topic can be found in the <link + linkend="details.categories">Categories</link> section. +</para> +</sect1> + +<sect1 id="firsttime.payees"> +<title>Payees</title> + +<para> + To maintain your list of payees click on the + <guiicon><inlinemediaobject><imageobject><imagedata + fileref="payees_view.png"/></imageobject></inlinemediaobject>Payees</guiicon> + icon in the view selector. +</para> + +<para> + A full description of this topic can be found in the <link + linkend="details.payees">Payees</link> section. +</para> +</sect1> + +<sect1 id="firsttime-import"> +<title>Quicken Interchange Format (QIF) Import</title> + +<para> + If you currently use a financial manager application, &kappname; can import an + account's transactions as long as they are in the Quicken Interchange Format + (QIF). Most financial programs can export this format and the different + applications methods of exporting QIF is not discussed here for brevity. +</para> + +<para> + A full description of this topic can be found in the <link + linkend="details.impexp.qifimp">QIF Import</link> section. +</para> +</sect1> + +<sect1 id="firsttime-find"> +<title>Searching for transactions</title> + +<para> + &kappname; provides a useful and powerful transaction search facility in the + form of the search dialog. +</para> + +<para> + The search dialog can be opened from the toolbar using the + <guiicon><inlinemediaobject><imageobject><imagedata + fileref="transaction_find.png"/></imageobject></inlinemediaobject>Find</guiicon> + icon or by selecting <guimenuitem>Find Transaction</guimenuitem> from the + <guimenu>Edit</guimenu> menu. +</para> + +<para> + A full description of this topic can be found in the <link + linkend="details.search">Search</link> section. +</para> + +</sect1> + +<sect1 id="firsttime-reconcile"> +<title>Reconciliation</title> + +<para> + At some point you will want to reconcile the transactions you have entered + with the transactions listed in a statement, be it a bank statement, credit + card statement, loan statement, or any other statement. Reconciliation + involves matching what you have entered with what the statement lists. If any + discrepancies are found then either you or the person who created the + statement have made a mistake. +</para> + +<para> + To reconcile an account, first select the account, either from + <guiicon>Accounts</guiicon> view or from <guiicon>Ledgers</guiicon> + view. Then, either click on the <guiicon>Reconcile</guiicon> icon on the + Toolbar, or select <guimenuitem>Reconcile</guimenuitem> from the + <guimenu>Account</guimenu> menu. +</para> + +<para> + A full description of this topic can be found in the <link + linkend="details.reconcile">Reconciliation</link> section. +</para> + +</sect1> + +<sect1 id="firsttime-backup"> +<title>Backing up</title> + +<para> + Now that you have created some accounts and entered transactions it's a good + idea to perform a backup. Because the file used by &kappname; is a standard + Unix file you can just copy the file to another location to back it up or use + the dialog provided by &kappname;. Using the dialog is the preferred method + because if &kappname; ever starts using other file formats, such as SQL, then + it would be much harder to copy the file manually. +</para> + +<para> + To backup your file through &kappname; Select + <guimenuitem>Backup</guimenuitem> from the <guimenu>File</guimenu> menu and + enter the folder where you wish the file to be copied to. If the folder + needs mounting first and you have the sufficient privileges then check the + tick box labeled <guilabel>Mount this directory before backing up</guilabel> + and click on <guibutton>OK</guibutton>. +</para> + +<para> + The file will be copied to the folder specified with the current date + appended to the filename so it is easy to see the date the file was backed up. +</para> +</sect1> + +<sect1 id="firsttime-contact"> +<title>Contacting the developers / Reporting Bugs</title> + +<sect2> +<title>Contacting the developers</title> + +<para> + You can contact the developers through their mailing list &devlist;. +</para> + +<para> + We're happy to hear about your experiences using &kappname;. +</para> +</sect2> + +<sect2> +<title>Reporting bugs</title> + +<para> + To report a bug please use the interface provided by &kappname; by selecting + <menuchoice><guimenu>Help</guimenu><guimenuitem>Report + Bug</guimenuitem></menuchoice> and filling in the required information. +</para> + +<sect3 id="firsttime.bugs.quality"> +<title>Writing High Quality Bug Reports</title> + +<para> + We encourage users to take extra time to write high-quality bug reports when + submitting them. This reduces wasted effort on all sides, as the reporter and + the developer who will fix it trade emails until this information is really + in place. +</para> + +<para> + Eli Goldberg wrote the canonical Bug-Writing Guideline, available at <ulink + url="http://issues.apache.org/bugwritinghelp.html">http://issues.apache.org/bugwritinghelp.html</ulink>. + Generally, you'll be well-served by following these guidelines: +</para> + +<formalpara><title>Include your system information</title> + <para> + The <menuchoice><guimenu>Help</guimenu><guimenuitem>Report + Bug</guimenuitem></menuchoice> menu choice will fill this in automatically, + but if you would prefer not to use this interface, we will need to know the + version of &kappname; you're running, the version of &kde;, the name and + version of your distribution, and the version of your kernel. + </para> +</formalpara> + +<formalpara><title>Include a backtrace for crashes</title> + <para> + The backtrace is often the single most useful piece of information in + solving crashes. + </para> +</formalpara> + +<formalpara><title>Try to reproduce it</title> + <para> + Let us know if you were able to do so. It's useful to know whether the bug + only happened once and you couldn't get it to happen again or happens every + time or happens sometimes but not others. + </para> +</formalpara> + +<formalpara><title>Include specific steps</title> + <para> + This is a bad bug report: <quote>I entered a transaction, and &kappname; + crashed.</quote> A much better bug report is: <quote>Using the transaction + form, I entered a new transaction in my Credit Card account. I selected the + Transfer tab, entered in an amount, then changed to the Deposit tab, and + back to the Transfer tab. When I returned to the Transfer tab, &kappname; + crashed. This bug is fully reproducible for me.</quote> + </para> +</formalpara> + +<formalpara><title>Tell us what you expected to happen</title> + <para> + In some cases, this is obvious, but in more subtle bugs, sometimes you'll + see a bug report where it is not obvious what the reporter expected to + happen. Always tell us what you think should have happened. + </para> +</formalpara> + +<formalpara><title>Consider running with debugging enabled</title> + <para> + By compiling a version configured with --enable-debug=full you can ensure + that the best possible backtraces are generated. If you encounter a crash, + run &kappname; again from within gdb, and reproduce the crash. When it + crashes, type <quote>bt</quote> to generate a backtrace. + </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 &kappname; 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> diff --git a/doc/en/forecast_view.png b/doc/en/forecast_view.png Binary files differnew file mode 100644 index 0000000..4dd5461 --- /dev/null +++ b/doc/en/forecast_view.png diff --git a/doc/en/gnucash-import_options.png b/doc/en/gnucash-import_options.png Binary files differnew file mode 100644 index 0000000..77d5dfc --- /dev/null +++ b/doc/en/gnucash-import_options.png diff --git a/doc/en/gnucash-report.png b/doc/en/gnucash-report.png Binary files differnew file mode 100644 index 0000000..763dbde --- /dev/null +++ b/doc/en/gnucash-report.png diff --git a/doc/en/gnucash-select_price_source.png b/doc/en/gnucash-select_price_source.png Binary files differnew file mode 100644 index 0000000..b82c3ee --- /dev/null +++ b/doc/en/gnucash-select_price_source.png diff --git a/doc/en/home_view.png b/doc/en/home_view.png Binary files differnew file mode 100644 index 0000000..c2bdcce --- /dev/null +++ b/doc/en/home_view.png diff --git a/doc/en/index.docbook b/doc/en/index.docbook new file mode 100644 index 0000000..1b85b63 --- /dev/null +++ b/doc/en/index.docbook @@ -0,0 +1,232 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!-- Define an entity for your application if it is not part of KDE + CVS --> + <!ENTITY kmyapplication "<application>KMyMoney</application>"> + <!ENTITY kappname "KMyMoney"><!-- replace kmyapplication here + do *not* replace kappname--> + <!ENTITY package "kde-module"><!-- kdebase, kdeadmin, etc. Leave + this unchanged if your + application is not maintained in KDE CVS --> + <!ENTITY % addindex "IGNORE"> + <!ENTITY % English "INCLUDE"> <!-- ONLY If you are writing non-English + original documentation, change + the language here --> + <!-- Do not define any other entities; instead, use the entities + from entities/general.entities and $LANG/user.entities. --> + <!ENTITY devlist "<email>kmymoney2-developer@lists.sourceforge.net</email>"> + <!ENTITY userlist "<email>kmymoney2-user@lists.sourceforge.net</email>"> + <!ENTITY Ctrl "<keycap>Ctrl</keycap>"> + <!ENTITY Insert "<keycap>Ins</keycap>"> + +<!-- the chapters --> + <!ENTITY introduction SYSTEM "introduction.docbook"> + <!ENTITY makemostof SYSTEM "makemostof.docbook"> + <!ENTITY firsttime SYSTEM "firsttime.docbook"> + <!ENTITY whatsnew SYSTEM "whatsnew.docbook"> + <!ENTITY details-institutions SYSTEM "details-institutions.docbook"> + <!ENTITY details-accounts SYSTEM "details-accounts.docbook"> + <!ENTITY details-loans SYSTEM "details-loans.docbook"> + <!ENTITY details-budgets SYSTEM "details-budgets.docbook"> + <!ENTITY details-forecast SYSTEM "details-forecast.docbook"> + <!ENTITY details-categories SYSTEM "details-categories.docbook"> + <!ENTITY details-payees SYSTEM "details-payees.docbook"> + <!ENTITY details-schedules SYSTEM "details-schedules.docbook"> + <!ENTITY details-ledgers SYSTEM "details-ledgers.docbook"> + <!ENTITY details-investments SYSTEM "details-investments.docbook"> + <!ENTITY details-currencies SYSTEM "details-currencies.docbook"> + <!ENTITY details-impexp SYSTEM "details-impexp.docbook"> + <!ENTITY details-reconciliation SYSTEM "details-reconciliation.docbook"> + <!ENTITY details-search SYSTEM "details-search.docbook"> + <!ENTITY details-reports SYSTEM "details-reports.docbook"> + <!ENTITY details-settings SYSTEM "details-settings.docbook"> + <!ENTITY details-widgets SYSTEM "details-widgets.docbook"> + <!ENTITY details-formats SYSTEM "details-formats.docbook"> + <!ENTITY details-database SYSTEM "details-database.docbook"> + <!ENTITY details-hbciofx SYSTEM "details-hbciofx.docbook"> + <!ENTITY reference SYSTEM "reference.docbook"> + <!ENTITY credits SYSTEM "credits.docbook"> +]> + +<book lang="&language;"> + +<bookinfo> +<title>The &kmyapplication; Handbook</title> +<subtitle>for &kappname; version 1.0</subtitle> + +<authorgroup> +<!-- This is just put in as an example. For real documentation, please + define a general entity in entities/contributor.entities, e.g. +<!ENTITY George.N.Ugnacious "<personname><firstname>George</firstname><othername>N.</othername><surname>Ugnacious</surname></personname>"> +<!ENTITY George.N.Ugnacious.mail "<email>gnu@kde.org</email>"> +and use `&George.N.Ugnacious; &George.N.Ugnacious.mail;' in the author element. + --> +<author> + <personname> + <firstname>Michael</firstname> + <othername>T.</othername> + <surname>Edwardes</surname> + </personname> + <email>mte@users.sourceforge.net</email> +</author> + +<author> + <personname> + <firstname>Thomas</firstname> + <surname>Baumgart</surname> + </personname> + <email>ipwizard@users.sourceforge.net</email> +</author> + +<author> + <personname> + <firstname>Ace</firstname> + <surname>Jones</surname> + </personname> + <email>acejones@users.sourceforge.net</email> +</author> + +<author> + <personname> + <firstname>Tony</firstname> + <surname>Bloomfield</surname> + </personname> + <email>tonybloom@users.sourceforge.net</email> +</author> + +<author> + <personname> + <firstname>Robert</firstname> + <surname>Wadley</surname> + </personname> + <email>robntina@users.sourceforge.net</email> +</author> + +<author> + <personname> + <firstname>Darin</firstname> + <surname>Strait</surname> + </personname> + <email>darin.strait@ashdar-partners.com</email> +</author> + +<author> + <personname> + <firstname>Roger</firstname> + <surname>Lum</surname> + </personname> + <email>rogerlum@gmail.com</email> +</author> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> + +</authorgroup> + +<copyright> +<year>2000</year> +<year>2001</year> +<year>2003</year> +<year>2004</year> +<year>2005</year> +<year>2006</year> +<year>2007</year> +<year>2008</year> +<year>2009</year> +<holder>The &kmyapplication; Development Team</holder> +</copyright> +<!-- Translators: put here the copyright notice of the translation --> +<!-- Put here the FDL notice. Read the explanation in fdl-notice.docbook + and in the FDL itself on how to use it. --> +<legalnotice>&FDLNotice;</legalnotice> + +<!-- Date and version information of the documentation +Don't forget to include this last date and this last revision number, we +need them for translation coordination ! +Please respect the format of the date (YYYY-MM-DD) and of the version +(V.MM.LL), it could be used by automation scripts. +Do NOT change these in the translation. --> + +<date>2009-08-10</date> +<releaseinfo>1.00.00</releaseinfo> + +<!-- Abstract about this handbook --> + +<abstract> +<para> + &kappname;, the personal finance manager for &kde;. +</para> + +<para> + This handbook describes &kappname; version 1.0. +</para> +</abstract> + +<!-- This is a set of Keywords for indexing by search engines. +Please at least include KDE, the KDE package it is in, the name + of your application, and a few relevant keywords. --> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KMyMoney2</keyword> +<keyword>KMyMoney</keyword> +<keyword>kmymoney2</keyword> +<keyword>kmymoney</keyword> +<keyword>finance</keyword> +<keyword>accounts</keyword> +<keyword>accounting</keyword> +<keyword>financial</keyword> +</keywordset> + +</bookinfo> + +<!-- The contents of the documentation begin here. Label +each chapter so with the id attribute. This is necessary for two reasons: it +allows you to easily reference the chapter from other chapters of your +document, and if there is no ID, the name of the generated HTML files will vary +from time to time making it hard to manage for maintainers and for the CVS +system. Any chapter labelled (OPTIONAL) may be left out at the author's +discretion. Other chapters should not be left out in order to maintain a +consistent documentation style across all KDE apps. --> + +<!-- + the main book +--> +&introduction; +&whatsnew; +&makemostof; +&firsttime; +&details-institutions; +&details-accounts; +&details-categories; +&details-payees; +&details-schedules; +&details-ledgers; +&details-investments; +&details-currencies; +&details-reconciliation; +&details-reports; +&details-impexp; +&details-loans; +&details-budgets; +&details-forecast; +&details-settings; +&details-search; +&details-formats; +&details-database; +&reference; +&credits; + +&documentation.index; +</book> +<!-- +Local Variables: +mode: xml +sgml-minimize-attributes:nil +sgml-general-insert-case:lower +sgml-indent-step:0 +sgml-indent-data:nil +End: + +vim:tabstop=2:shiftwidth=2:expandtab +kate: space-indent on; indent-width 2; tab-width 2; indent-mode none; +--> diff --git a/doc/en/institution_options.png b/doc/en/institution_options.png Binary files differnew file mode 100644 index 0000000..3736dad --- /dev/null +++ b/doc/en/institution_options.png diff --git a/doc/en/institution_view.png b/doc/en/institution_view.png Binary files differnew file mode 100644 index 0000000..01fe245 --- /dev/null +++ b/doc/en/institution_view.png diff --git a/doc/en/institutions_view.png b/doc/en/institutions_view.png Binary files differnew file mode 100644 index 0000000..73a97f1 --- /dev/null +++ b/doc/en/institutions_view.png diff --git a/doc/en/introduction.docbook b/doc/en/introduction.docbook new file mode 100644 index 0000000..2a72406 --- /dev/null +++ b/doc/en/introduction.docbook @@ -0,0 +1,72 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="introduction"> +<chapterinfo> + <date>2009-08-05</date> + <releaseinfo>1.0</releaseinfo> +</chapterinfo> + +<title>Introduction</title> + +<sect1 id="what-is-kmymoney"> +<title>What is &kappname;?</title> + +<para> + Put simply, &kappname; is a personal finance manager for &kde;. It enables + users of open source operating systems to keep careful track of their personal + finances by providing a broad array of financial features and tools. +</para> + +<para> + The principal goals of the project are: +</para> + +<itemizedlist> + <listitem> + <formalpara><title>Feature Parity</title> + <para> + &kappname; intends to provide all important features found in the + commercially-available personal finance managers. Although this release + is closer than ever to that goal, there is still work to be done. + </para> + </formalpara> + </listitem> + + <listitem> + <formalpara><title>Ease of Use.</title> + <para> + &kappname; strives to be the easiest open source personal finance + manager to use, especially for the non-technical user. + </para> + </formalpara> + </listitem> + + <listitem> + <formalpara><title>Correctness.</title> + <para> + Based on tried and tested double entry accounting principles &kappname; + ensures that your finances are kept in correct order. + </para> + </formalpara> + </listitem> +</itemizedlist> + +</sect1> + +<sect1 id="what-kmymoney-is-not"> +<title>What &kappname; is not</title> + +<para> + As a personal finance manager, &kappname; is not intended to scale to the + needs of an average business. However, it would be possible to create client + / supplier / document features through plugins. +</para> + +<para> + &kappname; is not simply a clone of the commercially-available personal + finance programs. Although many of the features present in &kappname; can be + found in other similar applications, &kappname; strives to present an + individual and unique view of your finances. +</para> + +</sect1> +</chapter> diff --git a/doc/en/investment-currencywarning.png b/doc/en/investment-currencywarning.png Binary files differnew file mode 100644 index 0000000..eb2eb38 --- /dev/null +++ b/doc/en/investment-currencywarning.png diff --git a/doc/en/investment-exchangerateeditor.png b/doc/en/investment-exchangerateeditor.png Binary files differnew file mode 100644 index 0000000..860e854 --- /dev/null +++ b/doc/en/investment-exchangerateeditor.png diff --git a/doc/en/investment-onlineupdate.png b/doc/en/investment-onlineupdate.png Binary files differnew file mode 100644 index 0000000..a5d7104 --- /dev/null +++ b/doc/en/investment-onlineupdate.png diff --git a/doc/en/investment-transactionform.png b/doc/en/investment-transactionform.png Binary files differnew file mode 100644 index 0000000..b145b55 --- /dev/null +++ b/doc/en/investment-transactionform.png diff --git a/doc/en/investments_summarytab.png b/doc/en/investments_summarytab.png Binary files differnew file mode 100644 index 0000000..8ae2603 --- /dev/null +++ b/doc/en/investments_summarytab.png diff --git a/doc/en/investments_view.png b/doc/en/investments_view.png Binary files differnew file mode 100644 index 0000000..72adf98 --- /dev/null +++ b/doc/en/investments_view.png diff --git a/doc/en/kmt.png b/doc/en/kmt.png Binary files differnew file mode 100644 index 0000000..10a9803 --- /dev/null +++ b/doc/en/kmt.png diff --git a/doc/en/kmymoney2.1 b/doc/en/kmymoney2.1 new file mode 100644 index 0000000..de4a4cc --- /dev/null +++ b/doc/en/kmymoney2.1 @@ -0,0 +1,277 @@ +.lf 1 ../info/kmymoney2.kmymoney2.1 +.TH KMYMONEY2 "1" "May 2003" "KDE" "KDE Application" +.SH NAME +KMyMoney \- the personal finances manager for KDE +.SH SYNOPSIS +.B kmymoney2 +[\fIQt-options\fR] [\fIKDE-options\fR] [\fIFile\fR] +.SH DESCRIPTION +This manual page documents briefly the +.B KMyMoney +KDE Application. +This manual page was written for the Debian GNU/Linux distribution +because the original program does not have a manual page. +.PP +.B KMyMoney +is the Personal Finance Manager for the KDE environment. +It provides the functions required to balance your checkbooks, +manage your personal loans and categorise your incomes and +expenses using a checkbook style graphical user interface. +.SH OPTIONS +.SS "Arguments:" +.TP +File +file to open +.SS "Generic options:" +.TP +\fB\-\-help\fR +Show help about options +.TP +\fB\-\-help\-qt\fR +Show Qt specific options +.TP +\fB\-\-help\-kde\fR +Show KDE specific options +.TP +\fB\-\-help\-all\fR +Show all options +.TP +\fB\-\-author\fR +Show author information +.TP +\fB\-v\fR, \fB\-\-version\fR +Show version information +.TP +\fB\-\-license\fR +Show license information +.TP +\fB\-\-\fR +End of options +.lf 1 ../../info//kdeqtoptions +.SS "KDE options" +.TP 12 +.BI \-\-caption \ caption +Use \fIcaption\fP as name in the titlebar. +.TP +.BI \-\-icon \ icon +Use \fIicon\fP as the application icon. \fIicon\fP is the name of the +icon, which can either be an absolute filename path, or otherwise the +icon is sought for in places according to the normal KDE rules. +.TP +.BI \-\-miniicon \ icon +Use \fIicon\fP as the icon in the titlebar. \fIicon\fP is the filename +of the icon, according to the same rules as for the \-\-icon parameter. +.TP +.BI \-\-config \ filename +Use an alternative configuration file, instead of the default, which +is normally located in +.I /usr/share/config +or in +.RB $ KDEHOME\fI/share/config +.TP +.BI \-\-dcopserver \ server +Set the address of the DCOP server to attach to. +.TP +.B \-\-nocrashhandler +Disable crash handler, to get core dumps. This option has the same +effect as definiting the environment variable KDE_DEBUG. +.TP +.B \-\-waitforwm +Waits for a WM_NET compatible windowmanager. +.TP +.BI \-\-style \ style +sets the application GUI style. +.TP +.BI \-\-geometry \ geometry +sets the client geometry of the main widget. +The geometry parameter follows the normal X convention for geometry, +which is on the form: +.RS +.IP +[\fIwidth\fBx\fIheight\fR][{\fB+-\fR}\fIxpos\fR{\fB+-\fR}\fIypos\fR] +.P +Where \fIwidth\fR and \fIheight\fR gives the desired minimum width and +height, of the main application window. Both in pixels. A value of 0 +specifies the default size. The optional \fIxpos\fR and \fIypos\fR +specifies the x,y-position that which is desired for the application +window. Specifying negative values for x or y implies that the x or y +position is to be measured from the left or bottom screen edge, +instead of as in the normal case, with positive values, from the left +and top edges. +.RE +.SS "Qt options" +.TP 12 +.BI \-\-display \ displayname +Use the X-server display \fIdisplayname\fP. +.TP +.BI \-\-session \ sessionId +Restore the application for the given \fIsessionId\fP. +.TP +.B \-\-cmap +Causes the application to install a private color +map on an 8-bit display. +.TP +.BI \-\-ncols \ count +Limits the number of colors allocated in the color +cube on an 8-bit display, if the application is +using the QApplication::ManyColor color +specification. +.TP +.B \-\-nograb +Tells Qt to never grab the mouse or the keyboard. +.TP +.B \-\-dograb +Running under a debugger can cause an implicit +.B \-nograb\fR, use \fB\-dograb\fR to override. +.TP +.B \-\-sync +switches to synchronous mode for debugging. +.TP +.BI "\-\-fn\fR, \fP\-\-font" \ fontname +Defines the default application font. The \fIfontname\fP should be in +the X logical font name description format XLFD. For a full description of +the format see +.I /usr/X11R6/lib/X11/doc/xlfd.TXT +Note that the application might override the font specified with +its own font. +.TP +.BI "-\-bg\fR, \fB\-\-background" \ color +Sets the default background color and an +application palette (light and dark shades are +calculated). +.TP +.BI "\-\-fg\fR, \fB\-\-foreground" \ color +Sets the default foreground color. +.TP +.BI \-\-btn\fR, \fB\-\-button \ color +Sets the default button color. +.TP +.BI \-\-name \ name +Sets the application name. +.TP +.BI \-\-title \ title +Sets the application title. This option might, or might not appear +in the title bar caption, depending on the application. To change the caption, use the +.B \-\-caption +option instead. +.TP +.B \-\-visual TrueColor +Forces the application to use a TrueColor visual on +an 8-bit display. +.TP +.BI \-\-inputstyle \ inputstyle +Sets XIM (X Input Method) input style. Possible +values are +.BR onthespot ", " overthespot ", " offthespot and root . +.TP +.BI \-\-im " XIM-server" +Set XIM server. +.TP +.B \-\-noxim +Disable XIM. +.TP +.B \-\-reverse +Mirror reverses the whole layout of widgets. This means that menus +will go in the opposite direction, the scroll bar will be on the +opposite side, etc. For a normal western layout that means that menus +and tool bars will go from the right edge to the left, the vertical +scroll bar will be on the left side and so on. + +.lf 48 ../info/kmymoney2.kmymoney2.1 +.SH ENVIRONMENT +.lf 1 ../../info//kdeenviron +.SS "standard KDE environment variables" +.IP KDE_LANG +Language locale setting to use. This option makes it possible to set +another language environment for a program than what is the default. The +correct language pack for this language has to be installed for this option +to work. The default language when there is none set is en_US. When +deciding upon a language, the following resources are looked up, in +order: KDE_LANG, configuration file, LC_CTYPE, LC_MESSAGES, LC_ALL, +LANG. +.IP KDE_UTF8_FILENAMES +Assume that all filenames are in UTF-8 format regardless of the +current language setting. Otherwise the filename format is defined by +the language. +.IP KDE_MULTIHEAD +If this variable has the value +.B true +multihead multiple display mode is enabled. The KDE display will be +shared over more than one screen. +.IP DISPLAY +Specifies the X display to run KDE on. +.IP KDESYCOCA +Specifies and alternative path for the +.I ksycoca +KDE system configuration cache file. +The default path is +/tmp/kde-$USER/ksycoca +.IP DCOPSERVER +Specifies an alternative path for the DCOP server file. The default +file is +$HOME/.DCOPserver_\fIhostname\fP_\fIdisplayname\fP +.IP SESSION_MANAGER +The session manager to use. This option is set automatically by KDE +and is a network path to the session manager socket. +.IP HOME +Path to the home directory for the current user. +.IP KDEHOME +The KDE per-user setting directory. Default if not specified is +.I $HOME/.kde +.lf 50 ../info/kmymoney2.kmymoney2.1 +.SH AUTHOR +.B KMyMoney +was written by +.PP +.nh +.ad l +Michael Edwardes <mte@users.sourceforge.net>, +.br +Felix Rodriguez <frodriguez@users.sourceforge.net>, +.br +John C <tacoturtle@users.sourceforge.net>, +.br +Thomas Baumgart <ipwizard@users.sourceforge.net>, +.br +Kevin Tambascio <ktambascio@users.sourceforge.net> and +.br +Arni Ingimundarson <arniing@users.sourceforge.net>. +.PP +.hy +Please use +.IP +.nh +.B http://sourceforge.net/tracker/?group_id=4708 +.hy +.PP +to report bugs and post support or feature requests. +.br +.B Do not mail the authors directly. +.PP +This manual page was prepared by +.nh +.ad l +Karolina Lindqvist <pgd\-karolinali@algonet.se> +.hy +for the Debian GNU/Linux system (but may be used by others) and +has been enhanced by +.nh +.ad l +Thomas Baumgart <ipwizard@users.sourceforge.net> +.hy +to reflect the latest changes in development. +.SH "SEE ALSO" +The full documentation for +.B KMyMoney +is maintained as a docbook manual. If the +.B khelpcenter +program is properly installed at your site, the command +.IP +.B khelpcenter help:/kmymoney2 +.PP +should give you access to the complete manual. +.P +Alternatively the manual can be browsed in +.B konqueror +giving it the URL +.B help:/kmymoney2 diff --git a/doc/en/ledger_more.png b/doc/en/ledger_more.png Binary files differnew file mode 100644 index 0000000..f869db4 --- /dev/null +++ b/doc/en/ledger_more.png diff --git a/doc/en/ledgers.png b/doc/en/ledgers.png Binary files differnew file mode 100644 index 0000000..f1b189b --- /dev/null +++ b/doc/en/ledgers.png diff --git a/doc/en/ledgers_view.png b/doc/en/ledgers_view.png Binary files differnew file mode 100644 index 0000000..8236097 --- /dev/null +++ b/doc/en/ledgers_view.png diff --git a/doc/en/ledgerview-numbered.png b/doc/en/ledgerview-numbered.png Binary files differnew file mode 100644 index 0000000..1085b3f --- /dev/null +++ b/doc/en/ledgerview-numbered.png diff --git a/doc/en/mainwindow_numbered.png b/doc/en/mainwindow_numbered.png Binary files differnew file mode 100644 index 0000000..1c63d66 --- /dev/null +++ b/doc/en/mainwindow_numbered.png diff --git a/doc/en/makemostof.docbook b/doc/en/makemostof.docbook new file mode 100644 index 0000000..fb4e0df --- /dev/null +++ b/doc/en/makemostof.docbook @@ -0,0 +1,361 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="makingmostof"> +<chapterinfo> + <authorgroup> + <author> + <firstname>Joe</firstname> + <surname>(joe1011010)</surname> + <affiliation> + <address><email>joe1011010_km@users.sourceforge.net</email></address> + </affiliation> + </author> + </authorgroup> + <date>2009-05-05</date> + <releaseinfo>1.0</releaseinfo> +</chapterinfo> + +<title>Making the most of &kappname;</title> + +<para> + Whilst you could go ahead, clicking some buttons and filling in some data, + after a time, you could decide you have done it wrong and start again, even if + you did read the documentation on each part of &kappname;. +</para> + +<para> + You will get a more effective system if you spend a little time planning how + you are going to use &kappname;, so follow the steps given here. +</para> + +<sect1 id="makingmostof.basicaccounting"> +<title>Basic Accounting</title> + +<para> + Imagine your money as balls, or beans, and to stop them rolling around you + keep them in a box, or pot. Accounting, or Book Keeping, is the process of + counting the beans in the pot, or several pots. +</para> + +<para> + You have some money in the pot marked <quote>Cash</quote>. You buy some goods, + so you take some beans out of the cash pot and place them into another pot + marked <quote>Supplier</quote>. The supplier gives you some goods in exchange + for the cash, so you take the beans out of the pot marked + <quote>Supplier</quote> and put them in the pot marked <quote>Goods</quote>. +</para> +<para> + The goods have a value (the price you paid) so you still have the same amount + of beans, some representing cash and some representing goods. +</para> +<para> + In this case you have two movements of beans, or transactions. Each + transaction needs two entries, one to take beans out and one to put beans + in. This is called <quote>double entry book keeping</quote> or <quote>double + entry accounting</quote>. The recording of the transactions is done in a + <quote>Ledger</quote>; each pot is known as an <quote>Account</quote> or + <quote>Ledger code</quote>. +</para> + +<para> + Now you take some goods and give them to a customer, who gives you some cash + in exchange. The goods were worth some beans and, hopefully, the customer has + given us more beans than that, so making a profit. To over simplify, the beans + from the Goods pot come back as Cash, but we can split that as the <quote>Cost + of Goods sold</quote> and <quote>Profit</quote>. This transaction has three + entries; one side of the <quote>double entry</quote> has been split. +</para> + +<para> + This will be covered properly in setting up accounts for Businesses. +</para> + +<sect2 id="makingmostof.basicaccounting.personalaccounts"> +<title>Defining the accounts (personal records)</title> + +<para> + Most accounts, or pots, above represent a measure of our + <quote>Worth</quote>. The cash and goods represent our <quote>Assets</quote>; + so does what we are owed if our customers have not yet given us the money. The + money we owe, say if we had not paid our suppliers, are our + <quote>Liabilities</quote>. These accounts are transferable to Cash and have a + value. +</para> + +<para> + Any pots that cannot be valued are <quote>Income</quote> or + <quote>Expense</quote>, such as an unpaid phone bill that would be an expense + as we have already made the calls. Although these do not have a value, it is + useful to monitor how much is in each. +</para> + +<para> + In some cases a supplier is a <quote>Liability</quote>, in others it is an + <quote>Expense</quote>. This is something we need to consider and decide for + each case. Similarly, you may set up a loan as a Liability, particularly if + you transfer the money into your bank account, but it could be an Expense if + it was to buy some furniture. +</para> + +<para> + Consider how you want to analyze your income and expenses. This will decide how you set them up. +</para> + +<para> + Finally, consider if you want everything in one set of accounts, or two or + more. This may depend on the legal framework or just how you want to analyze + things. Each set of accounts would be handled separately. +</para> +</sect2> + +<sect2 id="makingmostof.basicaccounting.businessaccounts"> +<title>Defining the accounts (business records)</title> + +<para> + This is similar to setting up for personal use, but needs to follow legal + guidelines. We do not discuss them here, but you should be aware of what these + are. +</para> +</sect2> +</sect1> + +<sect1 id="makingmostof.mapping"> +<title>Mapping your finances to &kappname;</title> + +<para> + So, collect up your papers and see the following sections for each item in + &kappname;. +</para> + +<sect2 id="makingmostof.mapping.accounts"> +<title>Accounts</title> + +<para> + These hold a value. Transactions are created against one or more accounts. +</para> + +<sect3 id="makingmostof.mapping.accounts.asset"> +<title>Accounts - Asset</title> + +<para> + These are the accounts which hold your money and possessions that you wish to + monitor. The following types are available: +</para> + +<variablelist> + <varlistentry> + <term>Checking</term> + <listitem> + <para> + Standard bank checking account. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Savings</term> + <listitem> + <para> + Standard bank savings account. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Cash</term> + <listitem> + <para> + Money in your hand or wallet. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Loan</term> + <listitem> + <para> + Loans you make to someone else. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Investment</term> + <listitem> + <para> + Money you invest. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Asset</term> + <listitem> + <para> + Property, collections, etc. + </para> + </listitem> + </varlistentry> +</variablelist> +</sect3> + +<sect3 id="makingmostof.mapping.accounts.liability"> +<title>Accounts - Liability</title> + +<para> + These are the accounts which represent your debts and money owed that you wish + to monitor. The following types are available: +</para> + +<variablelist> + <varlistentry> + <term>Credit card</term> + <listitem> + <para> + Standard credit card account. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Loan</term> + <listitem> + <para> + Loans made to you, mortgages, etc. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Liability</term> + <listitem> + <para> + Anything else you owe that is not a loan. + </para> + </listitem> + </varlistentry> +</variablelist> +</sect3> +</sect2> + +<sect2 id="makingmostof.mapping.institutions"> +<title>Institutions</title> + +<para> + These are completely optional and can be used to group accounts, and show a + total value for all accounts in each group. +</para> +</sect2> + +<sect2 id="makingmostof.mapping.categories"> +<title>Categories</title> + +<para> + These represent non-managed income and expense accounts that do not have a + value. The total value of transactions is shown against each category. A + category or transfer account is required for each transaction. +</para> +</sect2> + +<sect2 id="makingmostof.mapping.subcategories"> +<title>Sub-Categories</title> + +<para> + Categories can be split into sub-categories, but the sub-category totals are + not included in the higher level category total. +</para> +</sect2> + +<sect2 id="makingmostof.mapping.payees"> +<title>Payees</title> + +<para> + These are optional for transactions. They are required for Scheduled + transactions. A transaction history, with category, is shown against each + payee. +</para> +</sect2> + +<sect2 id="makingmostof.mapping.schedules"> +<title>Scheduled transactions</title> + +<para> + Where regular transactions occur, these can be set up against a + Schedule. Transactions are created from a schedule; any that are overdue can + be seen on the home page. +</para> +</sect2> +</sect1> + +<sect1 id="makingmostof.usefultips"> +<title>Useful Tips</title> + +<para> + Unless you keep you money under the floorboards, you probably make use of one + or more institutions where you have accounts which may be in credit or + debit. In order to familiarise yourself with the way &kappname; works, choose + an account you want to track of with &kappname; and select File>New in order + to set up an account file. +</para> + +<para> + If you have used another personal finance manager, you may be able to import + the data from it into &kappname;. +</para> + +<para> + If you have some regular receipts into or outgoings from this account, go to + Payee and enter the names of both the payers and the payees involved; then go + to Schedule and fill in a New Schedule for each transaction. If you haven't + entered the payee or payer, &kappname; will offer you the opportunity to do + this in the middle of entering the schedule. +</para> + +<para> + To add other new transactions go to Ledgers; you can add new payees and + categories in the middle of a transaction or by going to Payees or Categories + before entering the transaction. +</para> + +<para> + You will probably find that the default Categories do not exactly match your + needs; you can easily delete ones you know you are never going to need and add + others that you need. But when you are entering a transaction, you only have + to type a few letters of a category and &kappname; will offer you a drop down + list of the matching categories from which to choose. +</para> + +<para> + You can add different accounts managed by different institutions; the + preferred one will show when you open &kappname; but you can quickly switch to + any of the others. +</para> + +<para> + When you make a payment, &kappname; will work out what the next cheque number + should be; delete this if you are not making a cheque payment or edit it if + the first cheque you enter is not cheque number 1. Alternatively, it is + possible to switch off auto-increment of cheque numbers. +</para> + +<para> + Every so often you may get statements of your account from the institutions + you use; you can reconcile your &kappname; accounts against these statements + so that you have an accurate statement of the current state of your finances. +</para> + +<para> + If you go to Reports, you will find several default reports; to customise + these, open one similar to the sort you perfer and then select 'New' (not + 'Copy'); you can then customise this to your needs and mark it as a preferred + report if you wish. +</para> + +<para> + Though &kappname; is not intended for use in a business context, if you are + running a business on your own and so do not need payroll functions, you will + probably find that &kappname; is sufficiently customisable to meet your needs + particularly as it comes with budgeting and forecasting features and you can + export your customised reports via CSV into other applications. +</para> +</sect1> +</chapter> diff --git a/doc/en/new.png b/doc/en/new.png Binary files differnew file mode 100644 index 0000000..004ca03 --- /dev/null +++ b/doc/en/new.png diff --git a/doc/en/newacct.png b/doc/en/newacct.png Binary files differnew file mode 100644 index 0000000..d0af91e --- /dev/null +++ b/doc/en/newacct.png diff --git a/doc/en/newfile-2.png b/doc/en/newfile-2.png Binary files differnew file mode 100644 index 0000000..0f38922 --- /dev/null +++ b/doc/en/newfile-2.png diff --git a/doc/en/newfile-3.png b/doc/en/newfile-3.png Binary files differnew file mode 100644 index 0000000..72f68e1 --- /dev/null +++ b/doc/en/newfile-3.png diff --git a/doc/en/newfile-4.png b/doc/en/newfile-4.png Binary files differnew file mode 100644 index 0000000..586f42b --- /dev/null +++ b/doc/en/newfile-4.png diff --git a/doc/en/newfile-5.png b/doc/en/newfile-5.png Binary files differnew file mode 100644 index 0000000..48ae36b --- /dev/null +++ b/doc/en/newfile-5.png diff --git a/doc/en/newfile-6.png b/doc/en/newfile-6.png Binary files differnew file mode 100644 index 0000000..d8c311e --- /dev/null +++ b/doc/en/newfile-6.png diff --git a/doc/en/newfile.png b/doc/en/newfile.png Binary files differnew file mode 100644 index 0000000..bd2966e --- /dev/null +++ b/doc/en/newfile.png diff --git a/doc/en/newinst.png b/doc/en/newinst.png Binary files differnew file mode 100644 index 0000000..40c5286 --- /dev/null +++ b/doc/en/newinst.png diff --git a/doc/en/newsched_numbered.png b/doc/en/newsched_numbered.png Binary files differnew file mode 100644 index 0000000..814988b --- /dev/null +++ b/doc/en/newsched_numbered.png diff --git a/doc/en/otherdoc.docbook b/doc/en/otherdoc.docbook new file mode 100644 index 0000000..d3672fe --- /dev/null +++ b/doc/en/otherdoc.docbook @@ -0,0 +1,6 @@ +<chapter id="otherdoc"> +<title>Other Documentation - Under development - MTE</title> +<para>(This section can be removed if not completed in time) (Ace) +</para> +</chapter> + diff --git a/doc/en/outbox_view.png b/doc/en/outbox_view.png Binary files differnew file mode 100644 index 0000000..4aa8fc3 --- /dev/null +++ b/doc/en/outbox_view.png diff --git a/doc/en/payee_history.png b/doc/en/payee_history.png Binary files differnew file mode 100644 index 0000000..df1af63 --- /dev/null +++ b/doc/en/payee_history.png diff --git a/doc/en/payee_info.png b/doc/en/payee_info.png Binary files differnew file mode 100644 index 0000000..23e7c42 --- /dev/null +++ b/doc/en/payee_info.png diff --git a/doc/en/payee_match.png b/doc/en/payee_match.png Binary files differnew file mode 100644 index 0000000..369b710 --- /dev/null +++ b/doc/en/payee_match.png diff --git a/doc/en/payee_widget.png b/doc/en/payee_widget.png Binary files differnew file mode 100644 index 0000000..93ac111 --- /dev/null +++ b/doc/en/payee_widget.png diff --git a/doc/en/payees_view.png b/doc/en/payees_view.png Binary files differnew file mode 100644 index 0000000..f8fd357 --- /dev/null +++ b/doc/en/payees_view.png diff --git a/doc/en/payeeview.png b/doc/en/payeeview.png Binary files differnew file mode 100644 index 0000000..5b86399 --- /dev/null +++ b/doc/en/payeeview.png diff --git a/doc/en/qif_report.png b/doc/en/qif_report.png Binary files differnew file mode 100644 index 0000000..37bd55c --- /dev/null +++ b/doc/en/qif_report.png diff --git a/doc/en/qifimport-export.png b/doc/en/qifimport-export.png Binary files differnew file mode 100644 index 0000000..24173a8 --- /dev/null +++ b/doc/en/qifimport-export.png diff --git a/doc/en/qifimport-qifprofiledate.png b/doc/en/qifimport-qifprofiledate.png Binary files differnew file mode 100644 index 0000000..c0f6156 --- /dev/null +++ b/doc/en/qifimport-qifprofiledate.png diff --git a/doc/en/qifimport-qifprofileeditor.png b/doc/en/qifimport-qifprofileeditor.png Binary files differnew file mode 100644 index 0000000..961d15d --- /dev/null +++ b/doc/en/qifimport-qifprofileeditor.png diff --git a/doc/en/qifimportverify.png b/doc/en/qifimportverify.png Binary files differnew file mode 100644 index 0000000..5dd9829 --- /dev/null +++ b/doc/en/qifimportverify.png diff --git a/doc/en/qifopen.png b/doc/en/qifopen.png Binary files differnew file mode 100644 index 0000000..b1b7b3b --- /dev/null +++ b/doc/en/qifopen.png diff --git a/doc/en/reconcile.png b/doc/en/reconcile.png Binary files differnew file mode 100644 index 0000000..ab173cd --- /dev/null +++ b/doc/en/reconcile.png diff --git a/doc/en/reconcile1.png b/doc/en/reconcile1.png Binary files differnew file mode 100644 index 0000000..0b8a130 --- /dev/null +++ b/doc/en/reconcile1.png diff --git a/doc/en/reconcile2.png b/doc/en/reconcile2.png Binary files differnew file mode 100644 index 0000000..ce4e850 --- /dev/null +++ b/doc/en/reconcile2.png diff --git a/doc/en/reconcile3.png b/doc/en/reconcile3.png Binary files differnew file mode 100644 index 0000000..3638c7b --- /dev/null +++ b/doc/en/reconcile3.png diff --git a/doc/en/reconcile4.png b/doc/en/reconcile4.png Binary files differnew file mode 100644 index 0000000..b6bb603 --- /dev/null +++ b/doc/en/reconcile4.png diff --git a/doc/en/reference.docbook b/doc/en/reference.docbook new file mode 100644 index 0000000..ebbe52f --- /dev/null +++ b/doc/en/reference.docbook @@ -0,0 +1,919 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="reference"> +<chapterinfo> + <date>2009-08-10</date> + <releaseinfo>1.0</releaseinfo> +</chapterinfo> + +<title>Reference</title> + +<sect1 id="reference.menus"> +<sect1info> + <author> + <firstname>Roger</firstname> + <surname>Lum</surname> + <affiliation> + <address><email>rogerlum@gmail.com</email></address> + </affiliation> + </author> +</sect1info> +<title>Menus</title> + +<para> + Below is a complete list of the menu selections in &kappname;, with a very + brief description of what each one does. Note that many of these menu choices + will be unavailable, or grayed out, depending on the current display or state + of the application. For example, you are not able to edit an account unless + you have an account selected or displayed in the current view. +</para> + +<sect2 id="reference.menus.file"> +<title>File Menu</title> + +<variablelist> + <varlistentry> + <term><menuchoice> + <shortcut> + <keycombo><keycap>Ctrl</keycap><keycap>n</keycap></keycombo> + </shortcut> + <guimenu>File</guimenu><guimenuitem>New</guimenuitem> + </menuchoice></term> + <listitem> + <para><action> Creates a new empty &kappname; data file. Only one + &kappname; file can be open at once, so this will close your current file + first, if one is open. </action></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><menuchoice> + <shortcut> + <keycombo><keycap>Ctrl</keycap><keycap>o</keycap></keycombo> + </shortcut> + <guimenu>File</guimenu><guimenuitem>Open</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Opens an existing &kappname; data file.</action></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><menuchoice> + <guimenu>File</guimenu> + <guimenuitem>Open Recent</guimenuitem> + <guimenuitem>...</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Allows quick access to recently opened + files.</action></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><menuchoice> + <guimenu>File</guimenu><guimenuitem>Open Database...</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Opens an existing database.</action></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><menuchoice> + <shortcut> + <keycombo><keycap>Ctrl</keycap><keycap>s</keycap></keycombo> + </shortcut> + <guimenu>File</guimenu><guimenuitem>Save</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Saves the currently open file.</action></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><menuchoice> + <guimenu>File</guimenu><guimenuitem>Save As...</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Saves the currently open file with a different + filename.</action></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><menuchoice> + <guimenu>File</guimenu><guimenuitem>Save As Database...</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Saves the currently open file in a <link + linkend="details.database">Database</link>.</action></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><menuchoice> + <guimenu>File</guimenu> + <guimenuitem>Import</guimenuitem> + <guimenuitem>...</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Imports financial data from other file types, such as QIF + and Gnucash, or a template file of accounts and categories that can be + used in setting up new accounts.</action></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><menuchoice> + <guimenu>File</guimenu> + <guimenuitem>Export</guimenuitem> + <guimenuitem>...</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Exports the current file as a different file type, such as + QIF, or exports a list of your accounts and categories as an template. + </action></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><menuchoice> + <shortcut> + <keycombo><keycap>Ctrl</keycap><keycap>p</keycap></keycombo> + </shortcut> + <guimenu>File</guimenu><guimenuitem>Print</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Prints the current file.</action></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><menuchoice> + <guimenu>File</guimenu><guimenuitem>Backup</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Saves a backup the current file.</action></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><menuchoice> + <guimenu>File</guimenu><guimenuitem>Personal Data</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Allows to edit personal data.</action></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><menuchoice> + <guimenu>File</guimenu><guimenuitem>File information</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Displays information about the currently open &kappname; + file.</action></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><menuchoice> + <shortcut> + <keycombo><keycap>Ctrl</keycap><keycap>w</keycap></keycombo> + </shortcut> + <guimenu>File</guimenu><guimenuitem>Close</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Closes the current file.</action></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><menuchoice> + <shortcut> + <keycombo><keycap>Ctrl</keycap><keycap>q</keycap></keycombo> + </shortcut> + <guimenu>File</guimenu><guimenuitem>Quit</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Quit &kappname;</action></para> + </listitem> + </varlistentry> +</variablelist> +</sect2> + +<sect2 id="reference.menus.edit"> +<title>Edit Menu</title> + +<variablelist> + <varlistentry> + <term><menuchoice> + <shortcut> + <keycombo><keycap>Ctrl</keycap><keycap>f</keycap></keycombo> + </shortcut> + <guimenu>Edit</guimenu><guimenuitem>Find transactions...</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Search transactions.</action></para> + </listitem> + </varlistentry> +</variablelist> +</sect2> + +<sect2 id="reference.menus.view"> +<title>View Menu</title> + +<variablelist> + <varlistentry id="reference.menus.settings.transactiondetail"> + <term><menuchoice> + <shortcut> + <keycombo><keycap>Ctrl</keycap><keycap>t</keycap></keycombo> + </shortcut> + <guimenu>Settings</guimenu> + <guimenuitem>Show Transaction Detail</guimenuitem> + </menuchoice></term> + <listitem> + <para><action> + Shows transaction details in the <link + linkend="details.ledgers">Ledger</link> view. With this option turned + on, all lines of the transaction will be shown in the ledger. When it + is turned off, only one line will be shown. + </action></para> + <para> + If you only want to see details for the currently selected transaction, + but only one line for the others, you can turn on the <link + linkend="details.settings.register.lens">Ledger Lens</link>. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><menuchoice> + <shortcut> + <keycombo><keycap>Ctrl</keycap><keycap>r</keycap></keycombo> + </shortcut> + <guimenu>View</guimenu> + <guimenuitem>Hide reconciled transactions</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Hides reconciled transactions on the + register.</action></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><menuchoice> + <shortcut> + <keycombo><keycap>Ctrl</keycap><keycap>u</keycap></keycombo> + </shortcut> + <guimenu>View</guimenu> + <guimenuitem>Hide unused categories</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Hides unused categories on the views.</action></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><menuchoice> + <shortcut> + <keycombo> + <keycap>Ctrl</keycap><keycap>Shift</keycap><keycap>a</keycap> + </keycombo> + </shortcut> + <guimenu>View</guimenu><guimenuitem>Show all accounts</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Shows all accounts on the views.</action></para> + </listitem> + </varlistentry> +</variablelist> +</sect2> + +<sect2 id="reference.menus.institution"> +<title>Institution Menu</title> + +<variablelist> + <varlistentry> + <term><menuchoice> + <guimenu>Institution</guimenu> + <guimenuitem>Add new institution...</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Add a new institution.</action></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><menuchoice> + <guimenu>Institution</guimenu> + <guimenuitem>Edit institution...</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Edit an institution.</action></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><menuchoice> + <guimenu>Institution</guimenu> + <guimenuitem>Delete institution...</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Delete an institution.</action></para> + </listitem> + </varlistentry> +</variablelist> +</sect2> + +<sect2 id="reference.menus.account"> +<title>Account Menu</title> + +<variablelist> + <varlistentry> + <term><menuchoice> + <guimenu>Account</guimenu> + <guimenuitem>New account...</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Adds a new account.</action></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><menuchoice> + <guimenu>Account</guimenu><guimenuitem>Edit account...</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Edits an account.</action></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><menuchoice> + <guimenu>Account</guimenu><guimenuitem>Delete account...</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Deletes an account.</action></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><menuchoice> + <guimenu>Account</guimenu><guimenuitem>Open ledger</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Displays the ledger view of an account.</action></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><menuchoice> + <shortcut> + <keycombo> + <keycap>Ctrl</keycap><keycap>Shift</keycap><keycap>r</keycap> + </keycombo> + </shortcut> + <guimenu>Account</guimenu><guimenuitem>Reconcile...</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Reconciles an account through the reconciliation + wizard.</action></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><menuchoice> + <guimenu>Account</guimenu><guimenuitem>Postpone</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Postpones reconciliation of an account.</action></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><menuchoice> + <guimenu>Account</guimenu><guimenuitem>Finish</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Finishes reconciliation of an account.</action></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><menuchoice> + <guimenu>Account</guimenu><guimenuitem>Transaction report</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Opens a transaction report of an account.</action></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><menuchoice> + <guimenu>Account</guimenu><guimenuitem>Close account</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Closes an account.</action></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><menuchoice> + <guimenu>Account</guimenu><guimenuitem>Reopen account</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Reopens an account, if closed.</action></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><menuchoice> + <guimenu>Account</guimenu><guimenuitem>Unmap account</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Unmaps an online account.</action></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><menuchoice> + <guimenu>Account</guimenu><guimenuitem>Map to online account</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Maps an account to an online account.</action></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><menuchoice> + <guimenu>Account</guimenu><guimenuitem>Update account...</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Imports transactions from online banking for an + account</action></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><menuchoice> + <guimenu>Account</guimenu> + <guimenuitem>Update all accounts...</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Import transactions from online banking for all + accounts.</action></para> + </listitem> + </varlistentry> +</variablelist> +</sect2> + +<sect2 id="reference.menus.category"> +<title>Category Menu</title> + +<variablelist> + <varlistentry> + <term><menuchoice> + <guimenu>Category</guimenu><guimenuitem>New category...</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Adds a new category.</action></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><menuchoice> + <guimenu>Category</guimenu><guimenuitem>Edit category...</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Edits a category.</action></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><menuchoice> + <guimenu>Category</guimenu><guimenuitem>Delete category...</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Deletes a category.</action></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><menuchoice> + <guimenu>Category</guimenu><guimenuitem>Open ledger</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Displays the ledger view of a category.</action></para> + </listitem> + </varlistentry> +</variablelist> +</sect2> + +<sect2 id="reference.menus.transaction"> +<title>Transaction Menu</title> + +<variablelist> + <varlistentry> + <term><menuchoice> + <shortcut> + <keycombo><keycap>Ctrl</keycap><keycap>Insert</keycap></keycombo> + </shortcut> + <guimenu>Transaction</guimenu><guimenuitem>New</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Adds a new transaction.</action></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><menuchoice> + <guimenu>Transaction</guimenu><guimenuitem>Edit</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Edits a transaction.</action></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><menuchoice> + <guimenu>Transaction</guimenu><guimenuitem>Edit splits</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Edits the splits of a transaction.</action></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><menuchoice> + <guimenu>Transaction</guimenu><guimenuitem>Delete</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Deletes a transaction.</action></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><menuchoice> + <guimenu>Transaction</guimenu><guimenuitem>Duplicate</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Duplicates a transaction.</action></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><menuchoice> + <guimenu>Transaction</guimenu> + <guimenuitem>Mark transaction as ...</guimenuitem> + <guimenuitem>Not Reconciled</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Changes a transaction to Not Reconciled + status.</action></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><menuchoice> + <shortcut> + <keycombo> + <keycap>Ctrl</keycap><keycap>Shift</keycap><keycap>Space</keycap> + </keycombo> + </shortcut> + <guimenu>Transaction</guimenu> + <guimenuitem>Mark transaction as ...</guimenuitem> + <guimenuitem>Cleared</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Changes a transaction to Cleared status.</action></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><menuchoice> + <shortcut> + <keycombo> + <keycap>Alt</keycap><keycap>Ctrl</keycap><keycap>Space</keycap> + </keycombo> + </shortcut> + <guimenu>Transaction</guimenu> + <guimenuitem>Mark transaction as ...</guimenuitem> + <guimenuitem>Reconciled</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Changes a transaction to Reconciled status.</action></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><menuchoice> + <guimenu>Transaction</guimenu><guimenuitem>Go to account</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Displays the other account of a transaction.</action></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><menuchoice> + <guimenu>Transaction</guimenu><guimenuitem>Go to payee</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Displays the Payee view and focuses on the payee of the + selected transaction.</action></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><menuchoice> + <guimenu>Transaction</guimenu> + <guimenuitem>Create scheduled transaction...</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Creates a new scheduled transaction.</action></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><menuchoice> + <guimenu>Transaction</guimenu><guimenuitem>Match</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Matches imported transactions.</action></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><menuchoice> + <guimenu>Transaction</guimenu><guimenuitem>Unatch</guimenuitem> + </menuchoice></term> + <listitem> + <para> + <action>Unmatches a transactions that &kappname; has proposed + as a match of imported transactions.</action> Note that this + menu choice is only present if a matched transaction exists. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><menuchoice> + <guimenu>Transaction</guimenu><guimenuitem>Accept</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Accepts a proposed merge of imported + transactions.</action></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><menuchoice> + <shortcut> + <keycombo><keycap>Ctrl</keycap><keycap>a</keycap></keycombo> + </shortcut> + <guimenu>Transaction</guimenu><guimenuitem>Select all</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Selects all transactions on the register.</action></para> + </listitem> + </varlistentry> +</variablelist> +</sect2> + +<sect2 id="reference.menus.tools"> +<title>Tools Menu</title> + +<variablelist> + <varlistentry> + <term><menuchoice> + <guimenu>Tools</guimenu><guimenuitem>QIF Profile Editor...</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Modifies the QIF profile used to import or export QIF + files.</action></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><menuchoice> + <guimenu>Tools</guimenu><guimenuitem>Securities...</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Lists all the current securities, with the ability to edit + each one.</action></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><menuchoice> + <guimenu>Tools</guimenu><guimenuitem>Currencies...</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Lists the currencies known to &kappname;.</action></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><menuchoice> + <guimenu>Tools</guimenu><guimenuitem>Prices...</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Lists stock and currency prices.</action></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><menuchoice> + <guimenu>Tools</guimenu> + <guimenuitem>Update Stock and Currency prices...</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Updates stock and currency prices from online sources using + the <link linkend="details.investments.onlinequotes">Online Price + Quotes</link> feature.</action></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><menuchoice> + <guimenu>Tools</guimenu><guimenuitem>Consistency Check</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Runs a check on your file and tries to fix any problem it + finds, if possible.</action></para> + <para>Make a backup of your file before running this option.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><menuchoice> + <guimenu>Tools</guimenu><guimenuitem>Performance-Check</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Runs a performance test on your file and displays the + results.</action></para> + </listitem> + </varlistentry> +</variablelist> +</sect2> + +<sect2 id="reference.menus.settings"> +<title>Settings Menu</title> + +<variablelist> + <varlistentry> + <term><menuchoice> + <guimenu>Settings</guimenu><guimenuitem>Hide/Show Toolbar</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Toggles the toolbar on or off.</action></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><menuchoice> + <guimenu>Settings</guimenu><guimenuitem>Hide/Show Statusbar</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Toggles the bottom status bar on or off.</action></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><menuchoice> + <guimenu>Settings</guimenu><guimenuitem>Enable all messages</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Re-enables any messages you may have turned off by checking + <guimenuitem>Don't tell me about this again</guimenuitem> in a dialog + box.</action></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><menuchoice> + <guimenu>Settings</guimenu> + <guimenuitem>&kde; Language Settings...</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Allows to change many locale based settings.</action></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><menuchoice> + <guimenu>Settings</guimenu> + <guimenuitem>Configure Shortcuts...</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Configures custom shortcuts.</action></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><menuchoice> + <guimenu>Settings</guimenu> + <guimenuitem>Configure Toolbars...</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Customizes &kappname; toolbars.</action></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><menuchoice> + <guimenu>Settings</guimenu> + <guimenuitem>Configure &kappname;...</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Configures <link linkend="details.settings">&kappname; + settings</link>.</action></para> + </listitem> + </varlistentry> +</variablelist> +</sect2> + +<sect2 id="reference.menus.help"> +<title>Help Menu</title> + +<variablelist> + <varlistentry> + <term><menuchoice> + <shortcut><keycombo><keycap>F1</keycap></keycombo></shortcut> + <guimenu>Help</guimenu><guimenuitem>&kappname; Handbook</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Accesses the &kappname; Handbook.</action></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><menuchoice> + <shortcut> + <keycombo><keycap>Shift</keycap><keycap>F1</keycap></keycombo> + </shortcut> + <guimenu>Help</guimenu><guimenuitem>What's This?</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Activates the "What's This?" cursor for pop-up + help.</action></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><menuchoice> + <guimenu>Help</guimenu><guimenuitem>Show tip of the day</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Shows tip of the day.</action></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><menuchoice> + <guimenu>Help</guimenu><guimenuitem>Report Bug...</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Reports a found bug. Please refer to the section on <link + linkend="firsttime.bugs.quality">Writing High Quality Bug Reports</link> + for guidance on how to write the most useful bug + reports.</action></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><menuchoice> + <guimenu>Help</guimenu> + <guimenuitem>Switch application language...</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Selects the language used in &kappname;</action></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><menuchoice> + <guimenu>Help</guimenu><guimenuitem>About &kappname;</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Shows About &kappname; information, including the version + number and the credits.</action></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><menuchoice> + <guimenu>Help</guimenu><guimenuitem>About &kde;</guimenuitem> + </menuchoice></term> + <listitem> + <para><action>Shows &kde; information.</action></para> + </listitem> + </varlistentry> +</variablelist> +</sect2> +</sect1> + +&details-widgets; + +</chapter> diff --git a/doc/en/report_configuration-reporttab.png b/doc/en/report_configuration-reporttab.png Binary files differnew file mode 100644 index 0000000..5fe4711 --- /dev/null +++ b/doc/en/report_configuration-reporttab.png diff --git a/doc/en/report_configuration-rowscolumns.png b/doc/en/report_configuration-rowscolumns.png Binary files differnew file mode 100644 index 0000000..71aadfa --- /dev/null +++ b/doc/en/report_configuration-rowscolumns.png diff --git a/doc/en/reports_view-all.png b/doc/en/reports_view-all.png Binary files differnew file mode 100644 index 0000000..85733c1 --- /dev/null +++ b/doc/en/reports_view-all.png diff --git a/doc/en/reports_view.png b/doc/en/reports_view.png Binary files differnew file mode 100644 index 0000000..b9e7ca7 --- /dev/null +++ b/doc/en/reports_view.png diff --git a/doc/en/schedcaltypes.png b/doc/en/schedcaltypes.png Binary files differnew file mode 100644 index 0000000..ae04a07 --- /dev/null +++ b/doc/en/schedcaltypes.png diff --git a/doc/en/schedmonthday.png b/doc/en/schedmonthday.png Binary files differnew file mode 100644 index 0000000..3700a04 --- /dev/null +++ b/doc/en/schedmonthday.png diff --git a/doc/en/schedpopup.png b/doc/en/schedpopup.png Binary files differnew file mode 100644 index 0000000..9b6c4f5 --- /dev/null +++ b/doc/en/schedpopup.png diff --git a/doc/en/schedule_view.png b/doc/en/schedule_view.png Binary files differnew file mode 100644 index 0000000..91e7021 --- /dev/null +++ b/doc/en/schedule_view.png diff --git a/doc/en/scheduleview.png b/doc/en/scheduleview.png Binary files differnew file mode 100644 index 0000000..f59506b --- /dev/null +++ b/doc/en/scheduleview.png diff --git a/doc/en/select_currency.png b/doc/en/select_currency.png Binary files differnew file mode 100644 index 0000000..801da8a --- /dev/null +++ b/doc/en/select_currency.png diff --git a/doc/en/select_database.png b/doc/en/select_database.png Binary files differnew file mode 100644 index 0000000..5499a72 --- /dev/null +++ b/doc/en/select_database.png diff --git a/doc/en/split_transaction.png b/doc/en/split_transaction.png Binary files differnew file mode 100644 index 0000000..b8b0c4f --- /dev/null +++ b/doc/en/split_transaction.png diff --git a/doc/en/tipofday.png b/doc/en/tipofday.png Binary files differnew file mode 100644 index 0000000..a23609b --- /dev/null +++ b/doc/en/tipofday.png diff --git a/doc/en/transaction_find.png b/doc/en/transaction_find.png Binary files differnew file mode 100644 index 0000000..51fb7f0 --- /dev/null +++ b/doc/en/transaction_find.png diff --git a/doc/en/transactionform-off.png b/doc/en/transactionform-off.png Binary files differnew file mode 100644 index 0000000..eea530c --- /dev/null +++ b/doc/en/transactionform-off.png diff --git a/doc/en/transactionform.png b/doc/en/transactionform.png Binary files differnew file mode 100644 index 0000000..47835b3 --- /dev/null +++ b/doc/en/transactionform.png diff --git a/doc/en/translist.png b/doc/en/translist.png Binary files differnew file mode 100644 index 0000000..e8fe34c --- /dev/null +++ b/doc/en/translist.png diff --git a/doc/en/value_widget.png b/doc/en/value_widget.png Binary files differnew file mode 100644 index 0000000..d1edb19 --- /dev/null +++ b/doc/en/value_widget.png diff --git a/doc/en/views-accounts.docbook b/doc/en/views-accounts.docbook new file mode 100644 index 0000000..aceb92e --- /dev/null +++ b/doc/en/views-accounts.docbook @@ -0,0 +1,6 @@ +<chapter id="view.accounts"> +<title>Accounts View - Under development - MTE</title> +<para> +</para> +</chapter> + diff --git a/doc/en/views-categories.docbook b/doc/en/views-categories.docbook new file mode 100644 index 0000000..0005d72 --- /dev/null +++ b/doc/en/views-categories.docbook @@ -0,0 +1,6 @@ +<chapter id="view.categories"> +<title>Categories View - Under development - MTE</title> +<para> +</para> +</chapter> + diff --git a/doc/en/views-home.docbook b/doc/en/views-home.docbook new file mode 100644 index 0000000..a2976e6 --- /dev/null +++ b/doc/en/views-home.docbook @@ -0,0 +1,6 @@ +<chapter id="views.home"> +<title>Home View - Under development - MTE</title> +<para> +</para> +</chapter> + diff --git a/doc/en/views-institutions.docbook b/doc/en/views-institutions.docbook new file mode 100644 index 0000000..796548c --- /dev/null +++ b/doc/en/views-institutions.docbook @@ -0,0 +1,5 @@ +<chapter id="views.institutions"> +<title>Institutions View - Under development - UNASSIGNED</title> +<para> +</para> +</chapter> diff --git a/doc/en/views-investments.docbook b/doc/en/views-investments.docbook new file mode 100644 index 0000000..176cc72 --- /dev/null +++ b/doc/en/views-investments.docbook @@ -0,0 +1,5 @@ +<chapter id="views.investments"> +<title>Investment View - Under development - UNASSIGNED</title> +<para> +</para> +</chapter> diff --git a/doc/en/views-ledgers.docbook b/doc/en/views-ledgers.docbook new file mode 100644 index 0000000..5bad0bd --- /dev/null +++ b/doc/en/views-ledgers.docbook @@ -0,0 +1,6 @@ +<chapter id="views.ledger"> +<title>Ledger Views - Under development - Roger Lum</title> +<para> +</para> +</chapter> + diff --git a/doc/en/views-outbox.docbook b/doc/en/views-outbox.docbook new file mode 100644 index 0000000..2a68383 --- /dev/null +++ b/doc/en/views-outbox.docbook @@ -0,0 +1,7 @@ +<!-- is not port of 0.8 +<chapter id="views.outbox"> +<title>Outbox - Under development - UNASSIGNED</title> +<para> +</para> +</chapter> +--> diff --git a/doc/en/views-payees.docbook b/doc/en/views-payees.docbook new file mode 100644 index 0000000..814d3fc --- /dev/null +++ b/doc/en/views-payees.docbook @@ -0,0 +1,6 @@ +<chapter id="views.payees"> +<title>Payees View - Under development - Roger Lum</title> +<para> +</para> +</chapter> + diff --git a/doc/en/views-reports.docbook b/doc/en/views-reports.docbook new file mode 100644 index 0000000..9f4da6b --- /dev/null +++ b/doc/en/views-reports.docbook @@ -0,0 +1,5 @@ +<chapter id="views.reports"> +<title>Reports View - Under development - Marce Villarino</title> +<para> +</para> +</chapter>
\ No newline at end of file diff --git a/doc/en/views-schedules.docbook b/doc/en/views-schedules.docbook new file mode 100644 index 0000000..942f13c --- /dev/null +++ b/doc/en/views-schedules.docbook @@ -0,0 +1,105 @@ +<?xml version="1.0" encoding="ISO-8859-1" ?> +<chapter id="views.schedule"> +<title>Schedule View - Under development - MTE</title> + +<sect1 id="views.schedule.overview"><title>Overview</title> +<para> + <screenshot> + <screeninfo>Schedule View</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="scheduleview.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Schedule View</phrase> + </textobject> + </mediaobject> + </screenshot> +</para> +<para> + Some intro to the view +</para> + +<sect2 id="views.schedule.overview.creating"><title>The New Schedule button</title> +<para> +</para> +</sect2> + +<sect2 id="views.schedule.overview.filter"><title>The Account Filter</title> +<para> +</para> +</sect2> + +<sect2 id="views.schedule.overview.views"><title>The List View and the Calendar View</title> +<para> +</para> +</sect2> +</sect1> + + +<sect1 id="views.schedule.listtab"><title>The List View</title> +<para> +</para> + +<sect2 id="views.schedule.listtab.groups"><title>The Schedule groups</title> +<para> +</para> +</sect2> + +<sect2 id="views.schedule.listtab.columns"><title>The list columns</title> +<para> +</para> +</sect2> +</sect1> + + +<sect1 id="views.schedule.calendartab"><title>The Calendar Tab</title> +<para> +</para> + +<sect2 id="views.schedule.calendartab.nav"><title>Date Navigation</title> +<para> +</para> +</sect2> + +<sect2 id="views.schedule.calendartab.type"><title>Calendar types</title> +<para> +</para> +</sect2> + +<sect2 id="views.schedule.calendartab.schedule"><title>Schedule types</title> +<para> +</para> +</sect2> +</sect1> + +<sect1 id="views.schedule.create"><title>Creating schedules</title> +<para> +</para> +</sect1> + +<sect1 id="views.schedule.edit"><title>Editing schedules</title> +<para> +</para> +</sect1> + +<sect1 id="views.schedule.enter"><title>Entering schedules</title> +<para> +</para> + +<sect2 id="views.schedule.manualenter"><title>Manually entering schedules</title> +<para> +</para> +</sect2> + +<sect2 id="views.schedule.autoenter"><title>Letting &kappname; enter the schedules</title> +<para> +</para> +</sect2> +</sect1> + +<sect1 id="views.schedule.delete"><title>Deleting schedules</title> +<para> +</para> +</sect1> +</chapter> diff --git a/doc/en/whatsnew.docbook b/doc/en/whatsnew.docbook new file mode 100644 index 0000000..71093e1 --- /dev/null +++ b/doc/en/whatsnew.docbook @@ -0,0 +1,73 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="whatsnew"> +<title>What's new in this release</title> + +<para> + We have been working hard to make this release better and easier to use in + every way. We have added a lot of new features to this version and have also + made quite a few improvements. We are confident you will like what you see. +</para> + +<para> + Here are some of the new features found in this release: +</para> + +<itemizedlist> + <listitem> + <para> + <link linkend="firsttime.mainwindow">An improved look and feel - including + a new icon set</link> + </para> + </listitem> + + <listitem> + <para> + <link linkend="details.reports">Reports</link> + </para> + </listitem> + + <listitem> + <para> + <link linkend="details.reports.charts">Charts</link> + </para> + </listitem> + + <listitem> + <para> + <link linkend="details.forecast">Forecast</link> + </para> + </listitem> + + <listitem> + <para> + <link linkend="details.budgets">Budgets</link> + </para> + </listitem> + + <listitem> + <para> + <link linkend="details.schedules.intro">More flexible schedules</link> + </para> + </listitem> + + <listitem> + <para> + <link linkend="details.database.usage">Database support</link> + </para> + </listitem> + + <listitem> + <para> + <link linkend="details.impexp">Improved import features</link> + </para> + </listitem> + + <listitem> + <para> + <link linkend="details.formats.encrypted">Improved PGP support</link> + </para> + </listitem> +</itemizedlist> + +</chapter> + |
