Difference between revisions of "GnuCash"

From GnuCash
Jump to: navigation, search
(Topics: simplify, phrase-ify.)
m (Other Development Notes: Link to coder tools for info on profilers)
 
(156 intermediate revisions by 9 users not shown)
Line 1: Line 1:
__NOTOC__
+
<!-- Translators: Add your language to this table. -->
 +
{| class="wikitable" style="margin: auto;"
 +
! scope="row"|Languages
 +
| [[de/{{PAGENAME}}|Deutsch]]
 +
| [[es/{{PAGENAME}}|Español]]
 +
| [[fr/{{PAGENAME}}|Français]]
 +
| [[He/גנוקאש|עִברִית]]
 +
| [[pt/{{PAGENAME}}|Português]]
 +
| [[Zh-hans/{{PAGENAME}}|简体中文]]
 +
|}
 +
<!-- Translators: enable the following line after adjusting the language code
 +
[[Category:De|GnuCash]]
 +
BTW, you should insert this category in every translated page.
 +
It is also an excellent idea to add a disclaimer "This page is work in progress." until it is finished.
 +
-->
 +
GnuCash is the leading [{{URL:GPL}} GPL'ed] Desktop Financial Manager Application. Appropriate for personal and small business use, it is meant to be easy to use and full of features.
 +
{| class="wikitable" style="margin: auto;"
 +
| There is no registration required to read this wiki or [{{URL:www}}/download.phtml download] and [[#Installation|install GnuCash]], only to edit this wiki.
 +
|}
  
GnuCash is the leading GPL'ed Desktop Financial Manager Application.  Appropriate for personal and small business use, it is meant to be easy to use and full of features.
+
== Installation ==
 +
GnuCash has versions that run on '''Windows''', '''{{Mac}}''', and many different flavors of '''Linux''' and '''BSD'''.  
  
== FAQ ==
+
Installation instructions for the different operating systems under which GnuCash operates are included at [[Installation]].
  
* The [[FAQ|GnuCash FAQ]] contains the collection of all frequently asked questions about GnuCash, including administration, accounting, and glossary questions.
+
== Getting Help ==
 +
If you have trouble using GnuCash, and the various documentation sources haven't helped you--or if you want to give some feedback, you can get help in several ways. See [[Getting Help]] for these options.
  
== Topics ==
+
== Available Documentation ==
 +
=== Documentation for Users ===
  
* [[Subversion]] access.
+
==== Primary Instructional Documents ====
* [[Bugzilla]] bug data base.
+
GnuCash offers two primary instructional documents:
* Gnome2 [[PortingStatus]] and [[KnownGnome2Problems]]
+
* [{{URL:docs:manual}} '''Manual'''] - the reference for details of operating specific GnuCash menus, dialogs, and windows
* Requested enhancements:
+
* [{{URL:docs:guide}} '''Guide'''] - a concise ''introduction'' to double-entry accounting and ''tutorials'' on using GnuCash to perform a variety of accounting tasks. It is highly recommended that new users read at least the '''Getting Started''' section of the ''Guide''.
** [[WishList]] is an edited list
+
These documents are accessible via the <code>Help</code> menu in the program, probably requiring Linux users to install an additional package called something like <q>gnucash-docs</q> using their package manager, or from the [{{URL:www}}/docs.phtml Documentation page] on our ''website'' which also links the following variants:
** [[Budgets]] lists the discussion about budgeting features
+
* '''Translations''' of the
* How to get involved in [[Development]]
+
:'''Manual''' are available in ''German'', ''Italian'', ''Japanese'', and ''Portuguese'', and the
* How to edit and improve the [[Translation]]s
+
:'''Guide''' is also available in ''simplified Chinese''.
* [[Roadmap]]
+
:The translations are not always recent and sometimes incomplete, but easier to understand from non-English users.
 +
* '''Other Formats''' consist of PDF, ePub, and mobi, or read html documents online
 +
* '''Nightly Builds''' contain the work in progress from the git repository for the stable branch
  
Some of the contents of these pages will eventually be merged into the [http://www.gnucash.org/docs/v1.8/C/gnucash-help/help.html GnuCash help documentation].
+
==== GnuCash wiki ====
 +
This wiki includes extensive information regarding all aspects of GnuCash, contributed by the developers and users of GnuCash. Information in the wiki covers a broad variety of topics, and includes detailed technical information, as well as information that applies to specific use cases. Of particular interest on the wiki are:
 +
* The [[FAQ|GnuCash FAQ]], which contains a collection of frequently asked questions about GnuCash, including administration, accounting, and glossary questions
 +
* [[Using GnuCash]], which collects real life experiences using GnuCash. You may find (user) solutions here that are not covered by the documentation.
  
Still confused?  Visit the homepage at [http://www.gnucash.org gnucash.org]. Search the mail archives at:
+
==== Third Party Documentation ====
 +
Third Party Documentation in Several Languages can be found in [[Documentation]].
  
* [https://lists.gnucash.org/mailman/listinfo/gnucash-devel gnucash-devel]
+
=== Documentation for Developers ===
* [https://lists.gnucash.org/mailman/listinfo/gnucash-user gnucash-user]
+
The '''Application programming interface''' (API) is intended for people who want to use the GnuCash engine <code>libgnucash</code> in their own project:
* [https://lists.gnucash.org/mailman/listinfo/gnucash-de gnucash-de]
+
:;[{{URL:docs:API}} stable] branch: is daily generated from the sources using [[Doxygen]].
 +
:;[{{URL:docs:API|FUTURE}} future] branch: will lead to the next mayor release. It will be activated after the first commit on that branch.
  
==Upgrade from 1.8.9 to 1.8.10 and HBCI online banking support==
+
[[Using the API]] shows how to use it.
  
With the version change from 1.8.9 to 1.8.10, GnuCash also changed the underlying library for HBCI online banking support. Instead of the OpenHBCI library previously used, GnuCash now uses the AqBanking library. Therefore you need to change several things when upgrading your GnuCash version and using HBCI. You need to install the following libraries, in this order:
+
In addition it may be handy sometimes to have an overview of which parts of the gnucash code depend on which other parts. [[Dependency Graphs]] explains how to generate a dependency graph for this purpose.
  
# [http://sourceforge.net/projects/gwenhywfar gwenhywfar] at least version 1.16.0
+
== Getting involved in the GnuCash project ==
# optional for chip cards: [http://sourceforge.net/projects/libchipcard libchipcard] at least version 1.9.13
+
The GnuCash Project is a volunteer-driven organization. We need your help to ensure that GnuCash survives and grows, and we need your help to help others.  
# [http://sourceforge.net/projects/aqbanking aqbanking] at least version 1.3.0
 
  
(This description is valid for aqbanking-1.3.0 and later. aqbanking-1.3.0 is a large package which replaces the previously separate packages aqhbci, aqhbci-qt-tools, and aqhbci-plugin-ddvcard. These are all now in aqbanking.)
+
There are many ways to contribute your knowledge and experience. Before you dig in, you may want to check out the [{{URL:www}} GnuCash website] for the [{{URL:www}}news.phtml latest news].
  
Then you need to start the HBCI setup. The new library AqBanking will be able to import all your existing security media (chip cards, key files) and also import your settings from these media. Therefore you need to start the HBCI setup druid, click "start HBCI setup" (which will launch an external setup program), select "Import existing medium", select the appropriate medium (chip card or key file of type OpenHBCI), click "Import data from medium" and enter the last missing data entries (probably the bank server address), and then finish the HBCI setup. From this point onwards GnuCash should already know your HBCI accounts and the respective GnuCash accounts, so that you can continue to use your online banking features.
+
;Note: This part of the wiki is intended to become the main repository of GnuCash developer documentation. Some formerly static pages have been moved here from the [{{URL:www}} GnuCash website], but the move is not yet complete. Some remaining static pages may be out of date. Wherever a wiki article disagrees with a static web page on the Website, the wiki article here is more likely to be correct.
  
==Help Wanted==
+
Here are a number of ways to get involved.
  
The GnuCash Project is a volunteer-driven organization. We need your help to survive and grow, to help others and to help the Project.
+
=== Mailing Lists ===
 +
Subscribing to the mailing lists, and asking and answering questions there, is an excellent way to begin contributing the the success of GnuCash. See [[Mailing Lists]] for more.
  
* [http://slashdot.org/article.pl?sid=03/08/11/200212 Slashdot discussion].
+
=== Filing Bugs and Enhancement Requests ===
* How you can help: [[Development]]
+
Occasionally, GnuCash will not work the way it was designed to work--or you have an idea for making GnuCash better. Improvements and fixes can be submitted using the [[Bugzilla]] bug tracker; more general suggestions can be made via the  [{{URL:UV}} Uservoice] pages.
* Edited list of requested enhancements: [[WishList]]
+
 
 +
=== Improving the Documentation ===
 +
* [[Documentation Update Instructions]]. This page describes the process to change both the GnuCash <q>Tutorial and Concepts Guide</q> and the Manual.
 +
 
 +
=== Localization ===
 +
* [[Translation|Translations]] gives an overview of this process.
 +
* How to adjust or create new [[Account Hierarchy Template]]s.
 +
 
 +
=== Developing the Application Code ===
 +
==== Policy ====
 +
* Our [[Development Process]]
 +
* [[CodingStandard | Coding Standards]]
 +
* [[Testing]]
 +
 
 +
==== Procedures ====
 +
* [[Git]] access
 +
* [[Building]] GnuCash from source code.
 +
* Some notes about the [[GnuCash XML format]] for the XML Backend.
 +
* The schema for the [[SQL]] Backend.
 +
* [[Adding Preferences]]: How to add new preferences.
 +
* Creating [[Custom Reports]]
 +
* [[Python Bindings]]
 +
 
 +
==== Other Development Notes ====
 +
* Reminders for the [[Project Administration]]
 +
* Mentions of other potentially useful [[Coder Tools]] (mostly profilers)
 +
 
 +
==== Future developments ====
 +
* Our [[Release Schedule]]
 +
* Future [[Roadmap]]
 +
 
 +
==== Historical Information ====
 +
* Outdated [[WishList]]
 +
* [[Budget History]]
 +
* [[Credit Notes]]
 +
* [[Old discussions]] about enhancement requests that have been implemented.
 +
* Discussion about the [[License]]
 +
* Special events
 +
** There was a [[Bounty Program]] in June / July 2013
 +
** [[GSoC]] Google Summer of Code

Latest revision as of 19:40, 29 May 2024

Languages Deutsch Español Français עִברִית Português 简体中文

GnuCash is the leading GPL'ed Desktop Financial Manager Application. Appropriate for personal and small business use, it is meant to be easy to use and full of features.

There is no registration required to read this wiki or download and install GnuCash, only to edit this wiki.

Installation

GnuCash has versions that run on Windows, macOS, and many different flavors of Linux and BSD.

Installation instructions for the different operating systems under which GnuCash operates are included at Installation.

Getting Help

If you have trouble using GnuCash, and the various documentation sources haven't helped you--or if you want to give some feedback, you can get help in several ways. See Getting Help for these options.

Available Documentation

Documentation for Users

Primary Instructional Documents

GnuCash offers two primary instructional documents:

  • Manual - the reference for details of operating specific GnuCash menus, dialogs, and windows
  • Guide - a concise introduction to double-entry accounting and tutorials on using GnuCash to perform a variety of accounting tasks. It is highly recommended that new users read at least the Getting Started section of the Guide.

These documents are accessible via the Help menu in the program, probably requiring Linux users to install an additional package called something like gnucash-docs using their package manager, or from the Documentation page on our website which also links the following variants:

  • Translations of the
Manual are available in German, Italian, Japanese, and Portuguese, and the
Guide is also available in simplified Chinese.
The translations are not always recent and sometimes incomplete, but easier to understand from non-English users.
  • Other Formats consist of PDF, ePub, and mobi, or read html documents online
  • Nightly Builds contain the work in progress from the git repository for the stable branch

GnuCash wiki

This wiki includes extensive information regarding all aspects of GnuCash, contributed by the developers and users of GnuCash. Information in the wiki covers a broad variety of topics, and includes detailed technical information, as well as information that applies to specific use cases. Of particular interest on the wiki are:

  • The GnuCash FAQ, which contains a collection of frequently asked questions about GnuCash, including administration, accounting, and glossary questions
  • Using GnuCash, which collects real life experiences using GnuCash. You may find (user) solutions here that are not covered by the documentation.

Third Party Documentation

Third Party Documentation in Several Languages can be found in Documentation.

Documentation for Developers

The Application programming interface (API) is intended for people who want to use the GnuCash engine libgnucash in their own project:

stable branch
is daily generated from the sources using Doxygen.
future branch
will lead to the next mayor release. It will be activated after the first commit on that branch.

Using the API shows how to use it.

In addition it may be handy sometimes to have an overview of which parts of the gnucash code depend on which other parts. Dependency Graphs explains how to generate a dependency graph for this purpose.

Getting involved in the GnuCash project

The GnuCash Project is a volunteer-driven organization. We need your help to ensure that GnuCash survives and grows, and we need your help to help others.

There are many ways to contribute your knowledge and experience. Before you dig in, you may want to check out the GnuCash website for the latest news.

Note
This part of the wiki is intended to become the main repository of GnuCash developer documentation. Some formerly static pages have been moved here from the GnuCash website, but the move is not yet complete. Some remaining static pages may be out of date. Wherever a wiki article disagrees with a static web page on the Website, the wiki article here is more likely to be correct.

Here are a number of ways to get involved.

Mailing Lists

Subscribing to the mailing lists, and asking and answering questions there, is an excellent way to begin contributing the the success of GnuCash. See Mailing Lists for more.

Filing Bugs and Enhancement Requests

Occasionally, GnuCash will not work the way it was designed to work--or you have an idea for making GnuCash better. Improvements and fixes can be submitted using the Bugzilla bug tracker; more general suggestions can be made via the Uservoice pages.

Improving the Documentation

Localization

Developing the Application Code

Policy

Procedures

Other Development Notes

Future developments

Historical Information