gnucash-docs master: Multiple changes pushed
John Ralls
jralls at code.gnucash.org
Tue Jun 23 20:10:33 EDT 2020
Updated via https://github.com/Gnucash/gnucash-docs/commit/a2e8bfa4 (commit)
via https://github.com/Gnucash/gnucash-docs/commit/dec5654d (commit)
via https://github.com/Gnucash/gnucash-docs/commit/59a7340a (commit)
via https://github.com/Gnucash/gnucash-docs/commit/c0cc284c (commit)
via https://github.com/Gnucash/gnucash-docs/commit/2b3050d7 (commit)
from https://github.com/Gnucash/gnucash-docs/commit/425817d2 (commit)
commit a2e8bfa407c379c0c6ce6f56a01b2ec059e69a92
Author: John Ralls <jralls at ceridwen.us>
Date: Tue Jun 23 17:10:25 2020 -0700
New section in help: Associating and External File with a Transaction.
diff --git a/help/C/Help_ch_Transactions.xml b/help/C/Help_ch_Transactions.xml
index ed4abe2..ce08c1b 100644
--- a/help/C/Help_ch_Transactions.xml
+++ b/help/C/Help_ch_Transactions.xml
@@ -295,7 +295,17 @@ Author:
</sect2>
</sect1>
-
+ <sect1 id="trans-assoc">
+ <title>Associating an External File with a Transaction.</title>
+ <para>Some users find it helpful to associate external files or URLs, perhaps images of store reciepts, cancelled checks, or vendor invoices, with their transactions. &app; provides a facility for doing just that.</para>
+ <para>Select a transaction in the <guilabel>Register</guilabel> and right-click it to present the <guimenu>Context Menu</guimenu> and select <guimenuitem>Update Association for Transaction</guimenuitem>. You will be presented with the <guilabel>Change a Transaction Association</guilabel> dialog. At the top is a radio button with two choices <guilabel>File Association</guilabel> and <guilabel>Location Association</guilabel>. If there's an item associated then the radio button will have the appropriate selection. At the bottom, 3 buttons: <guilabel>Remove</guilabel>, <guilabel>Cancel</guilabel>, and <guilabel>OK</guilabel>. <guilabel>Remove</guilabel> will remove the current association and close the dialog box; the other two do the usual actions.</para>
+ <para>If the <guilabel>File Association</guilabel> radio button is selected the control beneath it is a file chooser button. It will display the name of the selected file if there is one or <giulabel>None</giulabel> if there isn't. Clicking the button will bring up a file chooser dialog from which one may select the file to associate.</para>
+ <para>If the <guilabel>Location Association</guilabel> radio button is selected there is a text entry beneath it in which you may type a URL.</para>
+ <para>When you have finished click the <guilabel>OK</guilabel> button to confirm your choice or the <guilabel>Cancel</guilabel> button to dismiss the dialog without making a change.</para>
+ <para><guimenuitem>Open Association for Transaction</guimenuitem> is enabled if there is a file or URL associated with the selected transaction. Selecting it will open a file in the operating system's default viewer for the file type and a URL in the default browser</para>
+ <para><guimenuitem>Remove Association from Transaction</guimenuitem> is enabled if there is a file or URL associated with the selected transaction and does exactly what you'd expect.</para>
+ <para>When the <guilabel>Register</guilabel> is in <guilabel>Double Line</guilabel> mode the cell underneath the <guilabel>Reconciliation</guilabel> cell is the <guilabel>Association</guilabel> cell and displays a paperclip symbol if there is a file associated with the transaction and a chain-link symbol if there is a URL associated with it as long as those symbols are supported by the current font for the cell. Hovering over the cell will display the file path or URL in a tooltip and clicking in it will open the file or URL as the <guimenuitem>Open Transaction</guimenuitem> context menu item would.</para>
+ </sect1>
<sect1 id="trans-multi-enter">
<title>Multiple Split Transactions</title>
commit dec5654d2ebc48b823840e0ae07d139d0a246d39
Author: John Ralls <jralls at ceridwen.us>
Date: Tue Jun 23 15:41:17 2020 -0700
Rewrite the New Accounts Hierarch Setup section.
Originally motivated by need to document the new locale selector.
diff --git a/guide/C/ch_basics.xml b/guide/C/ch_basics.xml
index 2d65cb4..a0a7721 100644
--- a/guide/C/ch_basics.xml
+++ b/guide/C/ch_basics.xml
@@ -403,9 +403,8 @@
to create a set of &app; accounts. It will
appear if you choose <guibutton>Create a new set of accounts</guibutton>
in the <guilabel>Welcome to &appname;!</guilabel> menu, or when you select
- <menuchoice><guimenu>File</guimenu><guimenuitem>New</guimenuitem></menuchoice>.</para>
- <para>This assistant will create a new blank &app; file and
- guide you through the creation of a <emphasis>Chart of Accounts</emphasis>. There are several
+ <menuchoice><guimenu>File</guimenu><guimenuitem>New</guimenuitem></menuchoice>. You may also use it to add a section of accounts to an existing book from the <guilabel>Accounts</guilabel> page by selecting <guimenu>Action</guimenu>><guimenuitem>New Account Hierarchy...</guimenuitem>.</para>
+ <para>This assistant will guide you through the creation of a <emphasis>Chart of Accounts</emphasis>. There are several
steps in the assistant, which are outlined below.</para>
<orderedlist>
@@ -413,76 +412,30 @@
<para>The first screen briefly describes what this assistant does. </para>
</listitem>
<listitem>
- <para><guilabel>New Book Options</guilabel> allows you to set different attributes
- for your file that affect the file as a whole. This screen has four tabs:
+ <para><guilabel>New Book Options</guilabel> Appears only when creating a new book. Here you set various book attributes. This page has four tabs:
Accounts, Budgeting, Business, and Counters. These items are explained elsewhere in
- the Guide, and can be changed at a later point.</para>
+ the Guide, and can be changed at any time from <guimenu>File</guimenu>><guimenuitem>Properties</guimenuitem>.</para>
</listitem>
<listitem>
- <para><guilabel>Choose Currency</guilabel> sets the default currency for new accounts.
- This is based on the computer locale settings, and can be modified later in the
- <guilabel>Accounts</guilabel> tab under <guilabel>Preferences</guilabel>
- (see <xref linkend="configuring-preferences-accounts"/>).</para>
+ <para><guilabel>Choose Currency</guilabel> sets the hidden root account currency and the default currency for new accounts. The offered default is based on the computer locale settings. Choose this carefully: Not only does it set the default currency for creating new accounts, it is the "Home" currency for the book and becomes the default currency for all stock pricing and foriegn currency exchange rates. While it can be changed by rerunning the <guilabel>New Account Hierarchy Setup</guilabel> Assistant from the <guimenu>Action</guimenu> menu, doing so after you've created transactions is risky.</para>
</listitem>
<listitem>
- <para><guilabel>Choose accounts to create</guilabel> allows you to create
- an initial set of accounts. These can be edited as needed afterward.
- The screen is divided into three parts.</para>
- <itemizedlist>
- <listitem>
- <para>The left upper portion has a list of
- <guilabel>Categories</guilabel> for commonly used hierarchies of
- accounts. Select from this list the types of accounts you wish to
- use. You can select as many of the categories of accounts as you
- wish.</para>
- </listitem>
- <listitem>
- <para>The left lower section has a <guilabel>Category
- Description</guilabel> that displays a detailed description of the
- category currently highlighted.</para>
- </listitem>
- <listitem>
- <para>The right side has a list of the <guilabel>Accounts</guilabel>
- that will be created from a selected category. Note that the accounts
- listed here are <emphasis>only</emphasis> the selected category; your
- final data file will include <emphasis>all</emphasis> of the accounts
- for all of the selected Categories.</para>
- </listitem>
- </itemizedlist>
+ <para><guilabel>Choose accounts to create</guilabel> provides a variety of accounting categories that may be added to the book. There are two main panels: On the left the list of categories with a selection check box next to each one and on the right the accounts that will be added by the highlighted category.</para>
+ <para> Above the <guilabel>Categories</guilabel> list you'll find two list-buttons, one for language code and the other for country code. The initial selection is again based on your computer's locale settings. You may select any language and country combination that suits your needs.</para>
+ <note>The <guilabel>New Account Hierarchy Setup</guilabel> Assistant can't process selections from more than one locale at a time, so if you need to select segments from multiple locales—perhaps because the categories for your primary locale are intended to extend those of another country—you'll need to run the assistant more than once from the <guimenu>Action</guimenu> menu.</note>
</listitem>
<listitem>
- <para><guilabel>Setup selected accounts</guilabel> lists all the accounts you
- selected on <guilabel>Choose accounts to create</guilabel>, and allows you to
- enter opening balances and to designate <emphasis>Placeholder</emphasis> accounts.</para>
- <note>
- <para>Equity accounts do not have opening balances, so the
- opening balance value for this kind of account
- is locked and set to zero.</para>
- </note>
- <note id="placeholder-acct">
- <para><emphasis>Placeholder</emphasis> accounts are used to create a hierarchy of accounts and
- normally do not have transactions or opening balances.</para>
- </note>
+ <para><guilabel>Setup selected accounts</guilabel> presents the accounts from the categories you selected on <guilabel>Choose accounts to create</guilabel> in a non-collapsible tree view with four or five columns depending on whether or not you're creating a new book:
<itemizedlist>
- <listitem>
- <para>The left side of the screen has a list of <guilabel>Account
- Names</guilabel>. Select an account by "clicking" once in the
- <guilabel>Account Names</guilabel> column with the account highlighted. This will open
- the account name for changes.</para>
- </listitem>
- <listitem>
- <para>The right side of the screen has a check-box to make an
- account a <guilabel>Placeholder</guilabel> and a box to add the
- <guilabel>Opening Balance</guilabel> for the selected account. Again
- a single click in the <guilabel>Opening Balance</guilabel> or
- <guilabel>Placeholder</guilabel> column will
- open the field for changes.</para>
- </listitem>
- </itemizedlist>
+ <listitem><guilabel>Account Name</guilabel>. This is editable, just click in it or select the row and press <keycap>Enter</keycap>.</listitem>
+ <listitem><guilabel>Type</guilabel> Not editable. This is the type of the account.</listitem>
+ <listitem><guilabel>Placeholder</guilabel> accounts (accounts that are intended only to collect sub-accounts and not to have transactions themselves). You may change this by checking to make an account a placeholder or unchecking to make it a regular account.</listitem>
+ <listitem><guilabel>Opening Balances</guilabel>can accept a value for new non-placeholder accounts that are not of type <emphasis>Equity</emphasis>, as existing accounts already have balances, placeholder accounts can't have transactions, and Equity can't have an opening balance.<note><guilabel>Opening Balance</guilabel>entry isn't obvious until you click in it. You must move out of the entry by clicking somewhere or by pressing <keycap>Tab</keycap> or <keycap>Enter</keycap> before clicking <guilabel>Next</guilabel> or your entry will be discarded.</note></listitem>
+ <listitem><guilabel>Use Existing</guilabel> appears only when you've started the <guilabel>New Account Hierarchy Setup</guilabel> Assistant from the <guimenu>Action</guimenu> menu. It indicates whether an account already exists. It's not editable. </listitem>
+ </itemizedlist></para>
</listitem>
<listitem>
- <para><guilabel>Finish account setup</guilabel> is the last screen and
- gives you a final option to cancel the process.</para>
+ <para><guilabel>Finish account setup</guilabel> is the last screen and gives you a final option to cancel the process, back up to change something, or apply to confirm your choices. If you're creating a new book, gnucash will present a dialog to select a backend and either a file to save it or database server, database name, and credentials to create a MySQL or Postgresql database if GnuCash was built with those features and you have the necesaary dependencies installed.</para>
<warning>
<para>If you choose to cancel, any selections you have made up to
this point will be lost.</para>
commit 59a7340a911a5b67ee885a0b54e1da40f51eeeff
Author: John Ralls <jralls at ceridwen.us>
Date: Tue Jun 23 13:18:59 2020 -0700
Document setting register column width layout.
diff --git a/guide/C/ch_txns.xml b/guide/C/ch_txns.xml
index 972521f..01c2e55 100644
--- a/guide/C/ch_txns.xml
+++ b/guide/C/ch_txns.xml
@@ -164,8 +164,26 @@
Transaction Journal mode.</para></caption>
</mediaobject>
</screenshot>
-
- </sect3>
+ </sect3>
+ <sect3 id="txns-columnwidths1">
+ <title>Setting Column Widths</title>
+ <para>As with most spreadsheet-like displays the columns in the register can be resized by left-clicking and dragging the dividers in the header. The divider to the <emphasis>right</emphasis>of the column header controls the width of that column. In &app; the <guilabel>Description</guilabel> and <guilabel>Memo</guilabel> columns autosize to fit the register into the window so dragging those columns' dividers to the left will shrink the column but it will snap back when you release it. Dragging them to the right will widen the display and put a scrollbar at the bottom of the window, but that will persist only while the register is open. If you close it and reopen it or quit &app; the register will again fill the space exactly.</para>
+ <note>Many new users have trouble resizing the <guilabel>Balance</guilabel> column, in particular making it larger. Just drag its right-hand border out of the window to grow it. Be careful, though, as there's another column called rate whose width is set to 1 pixel to hide it (it's for internal use). Approach the divider from the left side and click as soon as the cursor changes to a double-headed arrow.</note>
+ <para>Other columns width settings are saved and will be restored when the register is closed and reopened.</para>
+ <para>If the register for an account doesn't have a saved layout its column widths will be set with default values calculated from predicted content sizes. One may override the default by setting up a register to one's liking and then selecting <guimenu>View</guimenu>><guimenuitem>Use as Default Layout for this Register Group</guimenuitem>. <emphasis>Register Group</emphasis> in this case refers to the displayed columns; the groups are:</para>
+ <itemizedlist>
+ <listitem><para><emphasis>Currency:</emphasis> Ledgers that display amount in debit and credit columns.</para></listitem>
+ <listitem><para><emphasis>APAR:</emphasis> Accounts Payable and Accounts Receivable accounts.</para></listitem>
+ <listitem><para><emphasis>Stock:</emphasis> Ledgers that display amount in a single column with additional columns for Price and Value, the last in Debit and Credit columns.</para></listitem>
+ <listitem><para><emphasis>Journal:</emphasis> Ledgers displaying transactions from multiple accounts where all accounts would be displayed with a Currency type ledger.</para></listitem>
+ <listitem><para><emphasis>Portfolio:</emphasis> Ledgers displaying transactions from multiple accounts where one or more accounts would be displayed with a Stock type ledger.</para></listitem>
+ <listitem><para><emphasis>Customer:</emphasis> Ledgers embedded in invoices.</para></listitem>
+ <listitem><para><emphasis>Employee:</emphasis> Ledgers embedded in expense vouchers.</para></listitem>
+ <listitem><para><emphasis>Vendor:</emphasis> Ledgers embedded in bills.</para></listitem>
+ </itemizedlist>
+ <para>To remove a custom default and use the calculated values for unspeciallized accounts select <guimenu>View</guimenu>><guimenuitem>Reset Default Layout for this Register Group</guimenuitem>.</para>
+ <note>The customized register used to set the Register Group Default will remain customized, so it will not be affected if a different account's register is used to set a different layout or if the Register Group Defaults are reset.</note>
+ </sect3>
<sect3 id="txns-shortcuts1">
<title>Using Entry Shortcuts</title>
commit c0cc284c620a8db4b0e4703abf4ff4406495c5ff
Merge: 425817d 2b3050d
Author: John Ralls <jralls at ceridwen.us>
Date: Tue Jun 23 11:43:41 2020 -0700
Merge branch 'maint'
commit 2b3050d776b6ff2c2e15e41cf521aca18ff5e43f
Author: John Ralls <jralls at ceridwen.us>
Date: Tue Jun 23 11:43:17 2020 -0700
Fix obsolete guide cross-reference.
diff --git a/help/C/Help_ch_GUIMenus.xml b/help/C/Help_ch_GUIMenus.xml
index 84c107f..9276e22 100644
--- a/help/C/Help_ch_GUIMenus.xml
+++ b/help/C/Help_ch_GUIMenus.xml
@@ -3,7 +3,7 @@
<!--
(Do not remove this comment block.)
- Version: 3.5
+ Version: 3.11
Last modified: March 29th 2018
modified: November 18th 2010
modified: December 7th 2009
@@ -2056,7 +2056,7 @@
<tip>
<para>Appearance of the Account Register Display is highly customizable
(see <ulink
-url="https://www.gnucash.org/docs/v&series-stable;/C/gnucash-guide/txns-register-oview.html#txns-regstyle1">
+url="https://www.gnucash.org/docs/v&series-stable;/C/gnucash-guide/chapter_txns.html#txns-regstyle1">
Tutorial and Concepts Guide, Choosing a Register Style</ulink>).
</para>
</tip>
@@ -2550,7 +2550,7 @@ url="https://www.gnucash.org/docs/v&series-stable;/C/gnucash-guide/txns-register
<entry namest="c2" nameend="c3">
<para>Radio button to select register display mode. See <ulink
-url="https://www.gnucash.org/docs/v&series-stable;/C/gnucash-guide/txns-register-oview.html#txns-regstyle1">
+url="https://www.gnucash.org/docs/v&series-stable;/C/gnucash-guide/chapter_txns.html#txns-regstyle1">
Tutorial and Concepts Guide, Choosing a Register Style</ulink>.
</para>
</entry>
Summary of changes:
guide/C/ch_basics.xml | 79 +++++++++--------------------------------
guide/C/ch_txns.xml | 22 ++++++++++--
help/C/Help_ch_GUIMenus.xml | 6 ++--
help/C/Help_ch_Transactions.xml | 12 ++++++-
4 files changed, 50 insertions(+), 69 deletions(-)
More information about the gnucash-changes
mailing list