summaryrefslogtreecommitdiffstats
path: root/doc/en/details-institutions.docbook
diff options
context:
space:
mode:
Diffstat (limited to 'doc/en/details-institutions.docbook')
-rw-r--r--doc/en/details-institutions.docbook146
1 files changed, 146 insertions, 0 deletions
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>