Difference between revisions of "GnuCash"

From GnuCash
Jump to: navigation, search
(Home page rewritten by David T.)
(Developing the Documentation: -> Improving ... (developing sounds so high-flown))
(11 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
{| class="wikitable" style="margin: auto;"
 +
! 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.
 
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;"
 
{| 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.  
+
| There is no registration required to read this wiki or [http://www.gnucash.org/download.phtml download] and [[#Installation|install GnuCash]], only to edit this wiki.  
 
|}
 
|}
  
 
== Installation ==
 
== Installation ==
GnuCash has versions that run on Windows, Mac OS X, and many different flavors of Linux.  
+
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]].
 
Installation instructions for the different operating systems under which GnuCash operates are included at [[Installation]].
Line 13: Line 19:
  
 
== Available Documentation ==
 
== Available Documentation ==
=== Official GnuCash Documentation ===
+
=== User Documentation ===
 +
==== Official GnuCash Documentation ====
 
GnuCash offers two major pieces of 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=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.
 
* [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 [http://www.gnucash.org/docs.phtml Documentation page on the gnucash.org ''website''] also contains this documents in
 +
* '''other languages:''' de, it, ja, pt;
 +
* '''other formats:''' ''PDF'', ''ePub'' or ''mobi''; as well as
 +
* '''other releases:''' nightly (unstable),  previous and earlier stable releases.
  
=== GnuCash Wikis ===  
+
==== The Glossary ====
(Parts of) this wiki have been translated into other languages or contain information for one specific language only.  
+
Above GnuCash ''Tutorial and Concepts Guide'' includes a comprehensive Glossary: [https://www.gnucash.org/docs/v{{MainVersion}}/C/gnucash-guide/gnc-gloss.html Released] or [https://code.gnucash.org/docs/C/gnucash-guide/gnc-gloss.html Maintainer] version.
* [[de/GnuCash|The German Wiki]] de/GnuCash Deutsche Wiki-Seiten, im Entstehen.
 
* [[es/GnuCash|The Spanish Wiki]] es/GnuCash Wiki español.
 
* [[pt/GnuCash|The Portugese Wiki]] pt/GnuCash Sítio Wiki em Português, em andamento.
 
  
=== The GnuCash FAQ ===
+
Additionally, the [[Glossary|Wiki Glossary]] includes more terms useful for developers, documentation writers, and translators.
 +
 
 +
==== The GnuCash FAQ ====
 
The [[FAQ|GnuCash FAQ]] contains the collection of frequently asked questions about GnuCash, including administration, accounting, and glossary questions.
 
The [[FAQ|GnuCash FAQ]] contains the collection of frequently asked questions about GnuCash, including administration, accounting, and glossary questions.
  
=== Using GnuCash ===
+
==== Using GnuCash ====
 
[[Using GnuCash]] collects real life experiences using GnuCash. You may find (user) solutions here that are not covered by the documentation.
 
[[Using GnuCash]] collects real life experiences using GnuCash. You may find (user) solutions here that are not covered by the documentation.
  
=== The Wiki Glossary ===
+
=== Developer Documentation ===
The GnuCash Tutorial and Concepts Guide includes a comprehensive Glossary.  
+
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]].
  
Additionally, the [[Glossary|Wiki Glossary]] includes more terms useful for developers, documentation writers, and translators.
+
[[Using the API]] shows how to use it.
  
 
== Getting involved in the GnuCash project ==
 
== Getting involved in the GnuCash project ==
Line 51: Line 62:
 
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.
 
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.
  
=== Developing the Documentation ===
+
=== Improving the Documentation ===
 
* [[Documentation Update Instructions]]. This page describes the process to change both the GnuCash Tutorial and Concepts Guide and the Help Manual.
 
* [[Documentation Update Instructions]]. This page describes the process to change both the GnuCash Tutorial and Concepts Guide and the Help Manual.
* [http://svn.gnucash.org/docs/HEAD/|Doxygen Documentation]. The Doxygen source documentation system and its  [[Doxygen|wiki page]].
 
  
=== Translating the Documentation ===
+
=== Localization ===
* [[Translation|Translations]] gives an overview of this process, but please keep an eye on the [[Translation Status]]
+
* [[Translation|Translations]] gives an overview of this process, but please keep an eye on the [[Translation Status]].
 +
* How to adjust or create new [[Account Hierarchy Template]]s.
  
 
=== Developing the Application Code ===
 
=== Developing the Application Code ===
Line 67: Line 78:
 
* [[Git]] access
 
* [[Git]] access
 
* [[Building]] GnuCash from source code.
 
* [[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]]
 
* Creating [[Custom Reports]]
 
* [[Python Bindings]]
 
* [[Python Bindings]]
* Notes about the [[C API]]
 
* The [http://cvs.gnucash.org/docs/HEAD/ GnuCash API]
 
* Some notes about the [[GnuCash XML format]] for the XML Backend.
 
* The schema for the [[SQL]] Backend.
 
  
 
==== Other Development Notes ====
 
==== Other Development Notes ====
* How to improve or add new [[Account Hierarchy Template]]s.
 
 
* Reminders for the [[Project Administration]]
 
* Reminders for the [[Project Administration]]
  

Revision as of 16:47, 6 May 2018

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 this documents in

  • other languages: de, it, ja, pt;
  • other formats: PDF, ePub or mobi; as well as
  • other releases: nightly (unstable), previous and earlier stable releases.

The Glossary

Above 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.

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.

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.

Improving the Documentation

Localization

Developing the Application Code

Policy

Procedures

Other Development Notes

Future developments

Historical Information