Difference between revisions of "GnuCash"

From GnuCash
Jump to: navigation, search
(Home page rewritten by David T.)
m (→‎Other Development Notes: Link to coder tools for info on profilers)
 
(40 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
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.
+
<!-- Translators: Add your language to this table. -->
 
{| 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.  
+
! 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.  
 
|}
 
|}
  
 
== 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''', '''{{Mac}}''', 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 28:
  
 
== Available Documentation ==
 
== Available Documentation ==
−
=== Official GnuCash Documentation ===
+
=== Documentation for Users ===
−
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
+
==== Primary Instructional Documents ====
−
* [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.
+
GnuCash offers two primary instructional documents:  
−
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.
+
* [{{URL:docs:manual}} '''Manual'''] - the reference for details of operating specific GnuCash menus, dialogs, and windows
 +
* [{{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''.
 +
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:
 +
* '''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 Wikis ===  
+
==== GnuCash wiki ====
−
(Parts of) this wiki have been translated into other languages or contain information for one specific language only.  
+
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:
−
* [[de/GnuCash|The German Wiki]] de/GnuCash Deutsche Wiki-Seiten, im Entstehen.
+
* The [[FAQ|GnuCash FAQ]], which contains a collection of frequently asked questions about GnuCash, including administration, accounting, and glossary questions
−
* [[es/GnuCash|The Spanish Wiki]] es/GnuCash Wiki español.
+
* [[Using GnuCash]], which collects real life experiences using GnuCash. You may find (user) solutions here that are not covered by the documentation.
−
* [[pt/GnuCash|The Portugese Wiki]] pt/GnuCash Sítio Wiki em Português, em andamento.
 
  
−
=== The GnuCash FAQ ===
+
==== Third Party Documentation ====
−
The [[FAQ|GnuCash FAQ]] contains the collection of frequently asked questions about GnuCash, including administration, accounting, and glossary questions.
+
Third Party Documentation in Several Languages can be found in [[Documentation]].
  
−
=== Using GnuCash ===
+
=== Documentation for Developers ===
−
[[Using GnuCash]] collects real life experiences using GnuCash. You may find (user) solutions here that are not covered by the documentation.
+
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.
  
−
=== The Wiki Glossary ===
+
[[Using the API]] shows how to use it.
−
The GnuCash Tutorial and Concepts Guide includes a comprehensive Glossary.  
 
  
−
Additionally, the [[Glossary|Wiki Glossary]] includes more terms useful for developers, documentation writers, and translators.
+
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 ==
 
== 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.  
 
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 [http://www.gnucash.org GnuCash website] for the latest news.
+
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].
  
−
'''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.
+
;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.
  
 
Here are a number of ways to get involved.
 
Here are a number of ways to get involved.
Line 49: Line 72:
  
 
=== Filing Bugs and Enhancement Requests ===
 
=== 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.
+
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.
  
−
=== 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 <q>Tutorial and Concepts Guide</q> and the 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.
 +
* How to adjust or create new [[Account Hierarchy Template]]s.
  
 
=== Developing the Application Code ===
 
=== Developing the Application Code ===
Line 67: Line 90:
 
* [[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]]
 +
* Mentions of other potentially useful [[Coder Tools]] (mostly profilers)
  
 
==== Future developments ====
 
==== Future developments ====
Line 87: Line 109:
 
* [[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
 
* Special events
 
** There was a [[Bounty Program]] in June / July 2013
 
** There was a [[Bounty Program]] in June / July 2013
 
** [[GSoC]] Google Summer of Code
 
** [[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://code.gnucash.org/wiki/index.php?title=GnuCash&oldid=22143"