Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Choosing a Register Style #319

Open
wants to merge 1 commit into
base: stable
Choose a base branch
from
Open

Choosing a Register Style #319

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 15 additions & 30 deletions C/guide/ch_txns.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,42 +82,27 @@
<title>Choosing a Register Style</title>

<para>&app; offers several options for viewing your registers. The default style is <guilabel>Basic
Ledger</guilabel> mode, which displays only the summary of splits affecting the current
Ledger</guilabel>, which displays only the total of splits affecting the current
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's only a total if we are dealing with a 1-to-many split, even there it's the 1 you are seeing. Or this could be a many-to-many split, in which case it's certainly not a total, it's just a split amount. So I think it's better to simply say:
which displays only the amount of the split affecting the current ledger.
I know there is more to it with the transfer account being shown (or "split transaction" if there are more than 2 splits) but that's just more info than needed here I think.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also maybe we should say register instead of ledger. It seems the 2 are used but I see register used below as well.

account. This is the style that most closely resembles other popular personal financial
packages. You can choose a different register style from the <menuchoice>
<guimenu>View</guimenu>
</menuchoice> menu. There are two other view modes:
</menuchoice> menu.
</para>

<itemizedlist>
<listitem>
<para><menuchoice>
<guimenu>View</guimenu><guimenuitem>Auto-Split Ledger</guimenuitem>
</menuchoice> style expands the current transaction automatically. As you highlight a new transaction in the
register, the transaction automatically expands to show all splits.
</para>
</listitem>

<listitem>
<para><menuchoice>
<guimenu>View</guimenu><guimenuitem>Transaction Journal</guimenuitem>
</menuchoice> style shows all splits for all transactions in the register, which is more like an accounting
journal.
</para>
</listitem>
</itemizedlist>

<para>All styles permit you to view your data in either single-line or double-line format. Select <menuchoice>
<para>All styles allow transaction data to be viewed in either single-line or double-line format. Select <menuchoice>
<guimenu>View</guimenu> <guimenuitem>Double Line</guimenuitem>
</menuchoice>, and you will see your transaction line expand to two register lines. Double-line mode will also
display the transaction-level Notes field.
</para>

<para>Below are screenshots that demonstrate how the Basic Ledger and Transaction Journal views differ.
</para>

<para>For this example, let&rsquo;s assume that you have purchased 3 pair of Jeans for $1,000, and have
recorded the purchase as a split transaction with each pair entered on a separate split.
</menuchoice>, and you will see your transaction line expand to two register lines. Double-line mode will
display more transaction-level fields like Notes.
</para>

<para>More detail can also be shown for each split. Select <menuchoice>
<guimenu>View</guimenu><guimenuitem>Transaction Journal</guimenuitem>
</menuchoice> style shows all splits for all transactions in the register, which is more like an
accounting journal. <menuchoice>
<guimenu>View</guimenu><guimenuitem>Auto-Split Ledger</guimenuitem>
</menuchoice> style is a combination of the two. The style is like the Basic Ledger but as you
highlight a new transaction in the register, the transaction automatically expands to show all
splits in the same format as the Transaction Journal.
</para>

<para>The below screenshots illustrate the different view modes.
Expand Down