Difference between revisions of "GnuCash"

From GnuCash
Jump to: navigation, search
(Current discussion and bug tracking: http://gnucash.uservoice.com)
(Getting involved in the GnuCash project: "Translating the Documentation" -> Localization; move "Account Hierarchy Templates" there)
(34 intermediate revisions by 4 users not shown)
Line 1: Line 1:
__NOTOC__
+
{| class="wikitable" style="margin: auto;"
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.
+
! scope="row"|Languages
 +
| [[de/GnuCash|Deutsch]]
 +
| [[es/GnuCash|Español]]
 +
| [[pt/GnuCash|Português]]
 +
|}
 +
GnuCash is the leading [http://www.gnu.org/licenses/ 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 [[#Installation|download and install GnuCash]], only to edit this wiki.
 +
|}
  
== Translation ==
+
== 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 ==
 +
=== User Documentation ===
 +
==== Official GnuCash Documentation ====
 +
GnuCash offers two major pieces of documentation:
 +
* [http://www.gnucash.org/viewdoc.phtml?doc=help The Help Manual] - a quick reference manual for specific tasks, and
 +
* [http://www.gnucash.org/viewdoc.phtml?doc=guide The Tutorial and Concepts Guide] - an in-depth guide to the concepts. It is highly recommended to read at least the first chapters of the guide.
 +
The [http://www.gnucash.org/docs.phtml Documentation] page on the GnuCash.org website also contains the latest, unstable, releases of the documentation, documentation for other languages, documentation for  earlier releases, and documentation in PDF, ePub or mobi formats.
 +
 
 +
==== The GnuCash FAQ ====
 +
The [[FAQ|GnuCash FAQ]] contains the collection of frequently asked questions about GnuCash, including administration, accounting, and glossary questions.
 +
 
 +
==== Using GnuCash ====
 +
[[Using GnuCash]] collects real life experiences using GnuCash. You may find (user) solutions here that are not covered by the documentation.
 +
 
 +
==== The Wiki Glossary ====
 +
The GnuCash Tutorial and Concepts Guide includes a comprehensive Glossary: [https://www.gnucash.org/docs/v2.6/C/gnucash-guide/gnc-gloss.html Released] or [https://code.gnucash.org/docs/C/gnucash-guide/gnc-gloss.html Maintainer] version.
 +
 
 +
Additionally, the [[Glossary|Wiki Glossary]] includes more terms useful for developers, documentation writers, and translators.
 +
 
 +
=== Developer Documentation ===
 +
The Application programming interface (API) for people who want to use the gnucash engine in their own project:
 +
* [http://code.gnucash.org/docs/MAINT maint], the stable branch and
 +
* [http://code.gnucash.org/docs/MASTER master], the new feature branch, which are daily generated from the sources using [[Doxygen]].
  
(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:
+
[[Using the API]] shows how to use it.
  
* [[de/GnuCash]] Deutsche Wiki-Seiten, im Entstehen (German pages, work in progress)
+
== Getting involved in the GnuCash project ==
* [[pt/GnuCash]] Sítio Wiki em Português, em andamento. (Portuguese Wiki site, work in progress)
+
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.  
  
== Documentation ==
+
There are many ways to contribute your knowledge and experience. Before you dig in, you may want to check out the [http://www.gnucash.org GnuCash website] for the latest news.
* The [[FAQ|GnuCash FAQ]] contains the collection of all frequently asked questions about GnuCash, including administration, accounting, and glossary questions.
 
* Online copy of the [http://www.gnucash.org/docs/v2.2/C/gnucash-help/help.html GnuCash-2.2.x help documentation]
 
* [[Documentation|List to external international documentation]] and a somewhat outdated list of [http://www.gnucash.org/docs.phtml available online documentation]
 
* [[Using GnuCash]] collects real life experiences with GnuCash. You may find (user) solutions here that are not covered by the documentation.
 
* 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] and [[Python Bindings]]
 
* Getting a [[Stack Trace]]
 
* [[Logging]] messages and filtering detail.
 
  
== Installation ==
+
'''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 [http://www.gnucash.org 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.
OS/Distro specific annotations:
 
* [[FreeBSD]]
 
* [[MacOSXInstallation]] and [[MacOSX/Quartz]]
 
* Linux
 
** [[Debian]], [http://packages.debian.org/search?suite=default&section=all&arch=any&searchon=names&keywords=gnucash Debian packages]
 
** [[Gentoo]]
 
** [[Mandriva]]
 
** [[RedHat]]: FC5, RHEL4, CentOS4.3, RHEL5 / SL5.
 
** [[SuSE]]
 
** [[Slackware]]
 
** [[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].
 
  
 +
Here are a number of ways to get involved.
  
== Development ==
+
=== 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.
  
You may also want to check out http://www.gnucash.org/ for the latest news.
+
=== 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  [http://gnucash.uservoice.com Uservoice] pages.
  
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.
+
=== Developing the Documentation ===
 +
* [[Documentation Update Instructions]]. This page describes the process to change both the GnuCash Tutorial and Concepts Guide and the Help Manual.
  
=== Current discussion and bug tracking ===
+
=== Localization ===
* [[Mailing Lists]] and [[IRC]] chat
+
* [[Translation|Translations]] gives an overview of this process, but please keep an eye on the [[Translation Status]].
* [[Bugzilla]] bug database
+
* How to adjust or create new [[Account Hierarchy Template]]s.
* [http://gnucash.uservoice.com "Uservoice" Feature Request Forum]
 
  
=== Current Source Code ===
+
=== Developing the Application Code ===
* [[Subversion]] access
+
==== Policy ====
 
* Our [[Development Process]]
 
* Our [[Development Process]]
 +
* [[CodingStandard | Coding Standards]]
 +
* [[Testing]]
 +
 +
==== Procedures ====
 +
* [[Git]] access
 
* [[Building]] GnuCash from source code.
 
* [[Building]] GnuCash from source code.
* The [http://svn.gnucash.org/docs/HEAD/ Doxygen] source documentation system and its  [[Doxygen|wiki page]].
+
* Creating [[Custom Reports]]
 +
* [[Python Bindings]]
 +
* Some notes about the [[GnuCash XML format]] for the XML Backend.
 +
* The schema for the [[SQL]] Backend.
  
=== Getting involved in the project ===
+
==== Other Development Notes ====
* How to get involved in [[Development]] - not only for programmers ...
 
* [[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]].
 
 
* Reminders for the [[Project Administration]]
 
* Reminders for the [[Project Administration]]
  
=== 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]]
 
* [[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]]
+
* [[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

Revision as of 00:37, 28 July 2017

Languages Deutsch Español 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

User Documentation

Official GnuCash Documentation

GnuCash offers two major pieces of documentation:

The Documentation page on the GnuCash.org website also contains the latest, unstable, releases of the documentation, documentation for other languages, documentation for earlier releases, and documentation in PDF, ePub or mobi formats.

The GnuCash FAQ

The GnuCash FAQ contains the collection of frequently asked questions about GnuCash, including administration, accounting, and glossary questions.

Using GnuCash

Using GnuCash collects real life experiences using GnuCash. You may find (user) solutions here that are not covered by the documentation.

The Wiki Glossary

The GnuCash Tutorial and Concepts Guide includes a comprehensive Glossary: Released or Maintainer version.

Additionally, the Wiki Glossary includes more terms useful for developers, documentation writers, and translators.

Developer Documentation

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

  • maint, the stable branch and
  • master, the new feature branch, which are daily generated from the sources using Doxygen.

Using the API shows how to use it.

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.

Developing the Documentation

Localization

Developing the Application Code

Policy

Procedures

Other Development Notes

Future developments

Historical Information