Difference between revisions of "GnuCash"

From GnuCash
Jump to: navigation, search
(→‎3. party tools: new)
m (→‎Other Development Notes: Link to coder tools for info on profilers)
 
(57 intermediate revisions by 4 users not shown)
Line 1: Line 1:
−
__NOTOC__
+
<!-- Translators: Add your language to this table. -->
−
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.
+
{| 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.
 +
|}
  
−
== Translation ==
+
== Installation ==
 +
GnuCash has versions that run on '''Windows''', '''{{Mac}}''', and many different flavors of '''Linux''' and '''BSD'''.
  
−
(Parts of) this wiki have been translated into other languages or contain information for one specific language only. These are the index pages for these language dependent sections:
+
Installation instructions for the different operating systems under which GnuCash operates are included at [[Installation]].
  
−
* [[de/GnuCash]] Deutsche Wiki-Seiten, im Entstehen (German pages, work in progress)
+
== Getting Help ==
−
* [[pt/GnuCash]] Sítio Wiki em Português, em andamento. (Portuguese Wiki site, work in progress)
+
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.
  
−
== Documentation ==
+
== Available Documentation ==
−
* The [[Glossary]] explains some often used terms.
+
=== Documentation for Users ===
−
* The [[FAQ|GnuCash FAQ]] contains the collection of all frequently asked questions about GnuCash, including administration, accounting, and glossary questions.
 
−
* Read the online copy of the [http://www.gnucash.org/docs/ released documentation] and the [http://svn.gnucash.org/docs/ most recent, unstable SVN versions].
 
−
* [[Documentation|List to external international documentation]] and a somewhat outdated list of [http://www.gnucash.org/docs.phtml available online documentation]
 
−
* [[GnuCash Quick Start Guide For Business Users]]. Also, business users might be interested in a book by PacktPub, UK: [http://link.packtpub.com/6FDDUr GnuCash 2.4 Small Business Accounting, by Ashok Ramachandran]
 
−
* [[Using GnuCash]] collects real life experiences with GnuCash. You may find (user) solutions here that are not covered by the documentation.
 
−
* Some more specific topics:
 
−
** Using [[Scheduled Transactions]]
 
−
** [[Keyboard Shortcuts]]
 
−
** Online Banking: [[Setting up OFXDirectConnect in GnuCash 2]] and [[AqBanking]] (FinTS/HBCI)
 
−
** How to create some [[Custom Reports]]
 
−
** The [http://cvs.gnucash.org/docs/HEAD/ GnuCash API] (see also [[C API]]) and [[Python Bindings]]
 
−
** Getting a [[Stack Trace]]
 
−
** [[Logging]] messages and filtering detail.
 
−
** [[MacOSXReadme| Mac OS X Release Notes]]
 
  
−
=== Installation ===
+
==== Primary Instructional Documents ====
−
OS/Distro specific annotations:
+
GnuCash offers two primary instructional documents:  
−
* [[FreeBSD]]
+
* [{{URL:docs:manual}} '''Manual'''] - the reference for details of operating specific GnuCash menus, dialogs, and windows
−
* [[MacOSXInstallation]] and [[MacOSX/Quartz]]
+
* [{{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''.
−
* Linux
+
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:
−
** [[Debian]], [http://packages.debian.org/search?suite=default&section=all&arch=any&searchon=names&keywords=gnucash Debian packages]
+
* '''Translations''' of the
−
** [[Gentoo]]
+
:'''Manual''' are available in ''German'', ''Italian'', ''Japanese'', and ''Portuguese'', and the
−
** [[Mandriva]]
+
:'''Guide''' is also available in ''simplified Chinese''.
−
** [[RedHat]]: FC5, RHEL4, CentOS4.3, RHEL5 / SL5.
+
:The translations are not always recent and sometimes incomplete, but easier to understand from non-English users.
−
** [[SuSE]]
+
* '''Other Formats''' consist of PDF, ePub, and mobi, or read html documents online
−
** [[Slackware]]
+
* '''Nightly Builds''' contain the work in progress from the git repository for the stable branch
−
** [[Ubuntu]]
 
−
* [[Solaris]]
 
−
* [[Windows|Microsoft Windows]]: GnuCash runs on Windows as well. Download the binary package from [http://sourceforge.net/project/showfiles.php?group_id=192 sourceforge.net].
 
  
 +
==== 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.
  
−
== Support ==
+
==== Third Party Documentation ====
 +
Third Party Documentation in Several Languages can be found in [[Documentation]].
  
−
If you read the relevant parts of the pages above and still stuck with a problem or only wish to give some feedback, you can contact us in several ways:
+
=== Documentation for Developers ===
 +
The '''Application programming interface''' (API) is intended for people who want to use the GnuCash engine <code>libgnucash</code> in their own project:
 +
:;[{{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.
  
−
=== Current discussion ===
+
[[Using the API]] shows how to use it.
−
# [[IRC]] chat, usually in english, is the quickest way;
 
−
# a bunch of [[Mailing Lists]] for discussions in different languages;
 
  
−
=== 3. party tools ===
+
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.
−
Several users [[published tools]] to work with Gnucash.
 
  
−
=== Feature request and bug tracking ===
+
== Getting involved in the GnuCash project ==
−
# [[Bugzilla]] bug database for error reports and enhancement requests;
+
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://gnucash.uservoice.com "Uservoice" Feature Request Forum].
 
  
−
This will also influence the
+
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].
  
−
== Further Development ==
+
;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.
  
−
You may also want to check out http://www.gnucash.org/ for the latest news.
+
Here are a number of ways to get involved.
  
−
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 Website http://www.gnucash.org, 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.
+
=== 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.
  
−
=== Getting involved in the project ===
+
=== Filing Bugs and Enhancement Requests ===
−
* How to get involved in [[Development]] - not only for programmers ...
+
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.
−
* [[Documentation Update Instructions]] describe the process to change both the GnuCash "Guide"  and the GnuCash "Help" manuals as well as any other parts of GnuCash documentation.
+
 
−
* How to edit and improve the [[Translation]]s, but please keep an eye on the [[Translation Status]].
+
=== Improving the Documentation ===
−
* How to improve or add new [[Account Hierarchy Template]]s.
+
* [[Documentation Update Instructions]]. This page describes the process to change both the GnuCash <q>Tutorial and Concepts Guide</q> and the Manual.
−
* Reminders for the [[Project Administration]]
+
 
−
* [[GSoC]] Google Summer of Code
+
=== Localization ===
 +
* [[Translation|Translations]] gives an overview of this process.
 +
* How to adjust or create new [[Account Hierarchy Template]]s.
  
−
=== Current Source Code ===
+
=== Developing the Application Code ===
−
* [[Subversion]] access
+
==== Policy ====
 
* Our [[Development Process]]
 
* Our [[Development Process]]
−
* [[Building]] GnuCash from source code.
 
−
* The [http://svn.gnucash.org/docs/HEAD/ Doxygen] source documentation system and its  [[Doxygen|wiki page]].
 
 
* [[CodingStandard | Coding Standards]]
 
* [[CodingStandard | Coding Standards]]
 
* [[Testing]]
 
* [[Testing]]
 +
 +
==== Procedures ====
 +
* [[Git]] access
 +
* [[Building]] GnuCash from source code.
 
* Some notes about the [[GnuCash XML format]] for the XML Backend.
 
* Some notes about the [[GnuCash XML format]] for the XML Backend.
 
* The schema for the [[SQL]] 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 ===
+
==== Future developments ====
 
* Our [[Release Schedule]]
 
* Our [[Release Schedule]]
 
* Future [[Roadmap]]
 
* Future [[Roadmap]]
−
* A general edited list of requested enhancements: [[WishList]]
+
 
−
* Particular enhancements:
+
==== Historical Information ====
−
** [[Concept Guide]]
+
* Outdated [[WishList]]
−
** [[Budgets]]
+
* [[Budget History]]
−
** [[Clickable Reports UI]]
+
* [[Credit Notes]]
−
** [[Credit Notes]]
 
 
* [[Old discussions]] about enhancement requests that have been implemented.
 
* [[Old discussions]] about enhancement requests that have been implemented.
−
** [[Upgrade from 1.8.9 to 1.8.10 and HBCI online banking support]]
 
 
* Discussion about the [[License]]
 
* Discussion about the [[License]]
−
----
+
* Special events
−
The GnuCash Project is a volunteer-driven organization. We need your help to survive and grow, to help others and to help the Project.
+
** 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

Retrieved from "https://wiki.gnucash.org/wiki/index.php?title=GnuCash&oldid=22143"