Concept Guide

From GnuCash
Revision as of 19:00, 18 December 2015 by Mechtilde (talk | contribs) (→‎Updating the concept guide)
Jump to: navigation, search

Introduction

The GnuCash Tutorial and Concept Guide is intended to be a document where the main concepts behind GnuCash are explained and where every feature of the software is illustrated with step-by-step examples. To put it another way, think of the Guide as the official GnuCash ‘definitive guide’ technical manual in the style of O’Reilly’s guides.

Descriptions of the GUI, commands, options, toolbar buttons etc. must go into the GnuCash Help Manual (the best would be to have a note in the Concept Guide that illustrates an option and a link to the corresponding description in the manual).

This page is just a temporary page to keep track of the progress of the concept guide, as well as what needs to be done with it. Please feel free to add to it, with various thoughts and comments. Especially in things that needs to be clearer, or items that are missing etc. If you need detailed instructions on how the documentation update workflow is, you could read this guide.

Review

Please read through the Tutorial and Concepts Guide in the Nightly Documentation Builds section of the documentation page and indicate on this wiki any areas that you think need to be reworked, modified, deleted, added, or left unchanged.

We can use this wiki page to discuss what should be in the guide, and which examples. Later on, we can use the gnucash-devel list to send out the raw text for quick reviews

Areas that need work

To better follow the GDP rules, it's adviced to substitute the construction for menu item with the -&gt symbol by using a markup like this: <menuchoice><guimenu>File</guimenu><guisubmenu>Import...</guisubmenu><guimenuitem>Import QIF</guimenuitem></menuchoice>.

In most part of the doumentation the "Forward" button in assistants is erroneously referred to as "Next".

The "druid" word is deprecated. So if you encounter it, substitute it with "assistant"

The following items have missing text in the existing guide, or just need more work

Ready for release

The following chapters have been review/modified and are ready for release

Ready for review

The following chapters have been modified and are ready for review

  • 2. Basics (ready for review on dev-list here)

Ongoing work

GnuCash Tutorial and Concepts Guide

This document title duplicates the title of the official GnuCash software documentation that currently exists [1] as part of the information available to current and new users of the GnuCash double-entry accounting freeware product.

However, the official document as it exists currently covers features only through version 2.2.[2] The current stable version is 2.2.9 [2], and that is soon to be updated and replaced by the pending version 2.4.

Because the introduction of new features has exceeded the pace at which the documentation has been able to keep current, this page is intended to be a repository for new feature descriptions and instructions how-to-use those features. The intent is to provide easy access for gnucash users to review the proposed documentation with the end result of stamping it approved or identifying shortcomings that need update and correction.

Once that process has resulted in the content reaching a stable point, that portion of the new documentation will be moved into the official GnuCash Tutorial and Concepts Guide.

Since the official Guide is organized by chapters, all entries on this page will reference the place in the current official documentation that is intended as its ultimate destination.

Once integrated into the guide, the content here will be removed and a stub left indicating the date of integration into the official Guide.

Chapter: The Basics

Updating the screenshots referred in the "ch_basics.xml" file

Chapter: Other Assets

Content has been added into the official GnuCash repository as of revision 19618.

Remaining work

The chapters below have not been modified/checked since the 1.8 series.

General

  • Add screenshots for the budget chapter

Personal

Business

Appendix

  • A. Migration Guide
  • B. Frequent Asked Questions (we need to update with the valid FQA)

Thoughts and comments

  • Reports -
    • Add a sub chapter in each chapter regarding to Reports valid to current chapter
    • Add a separate chapter with an overview of the current reports
  • Make examples with separate accounts for each stocks/brokearage income/expense, so we can track each stocks costs
  • Ensure the account structure and names follow the default convention (Change "Starting Values" to "Opening Balances" for instance)
  • One datafile per chapter, and the chapter has to explain how to create the datafile with all its entries.
  • If you have multiple bank accounts with one bank the following should be an example?
    • Asset:Bank:CitiBank:Saving
    • Asset:Bank:CitiBank:ATM
  • Multiple currencies
    • the business features are all currently single-currency reference
    • Equity:Opening Balance:USD
    • Equity:Opening Balance:AUD
    • Income:Saving:CitiBank:Interest (where CitiBank is all in USD)
    • Expenses:Bank:CitiBank:Interest (where CitiBank is all in USD)
    • Expenses:Bank:CitiBank:Charges (where CitiBank is all in USD)
    • Income:Saving:Boom:Interest:HKD (boom has one USD and one HKD account)
    • Income:Saving:Boom:Interest:USD (boom has one USD and one HKD account)
  • Investments
    • Verify Capital Gains/Dividens in reports. Details
    • When you create a commodity, you should also directly create the Dividend account
    • How to Add / Remove shares
    • How to move shares between brokerage accounts.
    • How to do imediate re-invest dividend
    • How to buy shares with NON-Default currency
      • Current workaround: Buy the shares from the BANK account, and right click on the stock purchase row and select "Edit Exchange Rate"
Default currency AUD (not HKD)
Commodity Stock_1
Assets:Banks:Boom:HKD
Assets:Brokerage Accounts:Boom:Stock_1
Expenses:Investments:Commission:Boom_HKD
Income:Investments:Dividend:Boom_HKD:Stock_1
Open Assets:Banks:Boom:HKD account
Buy Stocks 
                Assets:Banks:Boom:HKD                                   Withdrawal 10,000
                Expenses:Investments:Commission:Boom_HKD    Deposit 500
                Assets:Brokerage Accounts:Boom:Stock_1      Deposit 9,500
Right click on the last row, and select "Edit Exchange Data"
In the following pop up window, enter the actual number of stocks in the last entry box 
 (not the default entry box)
  • Assets
    • Personal loan to a friend (Assets:Money owed to you:<Friends name>)
    • Depreciation of private assets like Car and other items (house, horse etc)
  • QIF Import
    • Migrating from Quicken/Money
      • I think we need to come with more details on this area? (expand on 2.7. Importing QIF Files, and Appendix A)
    • Ensure that the numbers in the QIF file do not contain " " (http://bugzilla.gnome.org/show_bug.cgi?id=121443)
    • Sample of QIF file, and links to more samples

Updating the concept guide

Please co-ordinate and inform of your intentions on gnucash-devel as well as on this wiki.

  1. Have a read of the Gnome documentation documents.
    1. http://library.gnome.org/devel/gdp-handbook/stable/
    2. http://library.gnome.org/devel/gdp-style-guide/stable/
  2. Ensure you have the latest copy from git
 git pull --rebase
  1. Update the Wiki, Move the chapter to Ongoing work
  2. Add revision and your name to the authors block. See sample below
 <!--
      (Do not remove this comment block.)
  Version: 1.9.x
  Last modified: April 16th 2006
  Version: 1.8.4
  Last modified: April 10th 2004
  Maintainers: 
               Chris Lyttle <chris@wilddev.net>
  Author:
  		Jon Lapham <lapham@extracta.com.br>
  	Updated	Bengt Thuree <bengt@thuree.com>
  Originally written by Carol Champagne.
  Translators:
               (translators put your name and email here)
-->
  1. Modify the xml file, and check the result with yelp
    • I am using scite as my editor, a plain editor like gedit, but it can "compress" the various tag pairs. Or use emacs with docbook extension
    • yelp gnucash-guide.xml
    • The XMLmind XML editor for Windows is free for personal use, and works fine. It also validates as well as clean up the XML code.
      • www.xmlmind.com/xmleditor
  2. For screenshots
    • Ensure you are using the default Gnome theme (ClearLooks)
    • Make the screenshots as small as possible
    • Use GIMP to take the screen shots (Aquire with delay)
    • Use Gimp --> Image --> Scale to ensure the width is max 510 pixels.
    • Save screenshot as a png file.
    • Ensure you are using the standard C locale. LANG=C ./gnucash
  3. Spell Check the document.
  4. Clean up docbook tags
    • xmllint --valid --noout gnucash-guide.xml
    • yelp gnucash-guide.xml
    • xmlto -o /tmp txt gnucash-guide.xml
  5. Commit your changes and prepare a patch:
    • If you've created a new file, add it to the index:
      git add path/to/new/file
    • Commit
      git commit
    • Write a nice commit message explaining your changes.
    • Unless you have commit privileges at the master repository, make a patch:
      git format-patch master
    • Patches may be emailed to gnucash-devel@gnucash.org or attached to bugs in Bugzilla. The latter is preferred, as patches on the mailing list may be missed or forgotten.
Retrieved from "https://wiki.gnucash.org/wiki/index.php?title=Concept_Guide&oldid=11938"