Difference between revisions of "GnuCash/sandbox"

From GnuCash
Jump to: navigation, search
(replace most of page by content copied in from proposal by David T elsewhere)
(Translating the Documentation: Remove link to obsolete Translation Status.)
 
(19 intermediate revisions by 3 users not shown)
Line 1: Line 1:
__NOTOC__
+
{{ThisIsASandbox}}
 
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 [[#Installation|download and install GnuCash]], only to edit this wiki.  
 
|}
 
|}
  
== Translation ==
+
== Installation ==
 +
GnuCash has versions that run on Windows, Mac OS X, and many different flavors of Linux.
  
(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 ==
* [[es/GnuCash]]  (Spanish pages, 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.
* [[pt/GnuCash]] Sítio Wiki em Português, em andamento. (Portuguese Wiki site, work in progress)
 
  
xxx
 
 
== Available Documentation ==
 
== Available Documentation ==
 
=== Official GnuCash Documentation ===
 
=== Official GnuCash Documentation ===
Line 20: Line 18:
 
* [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.
For the latest documentation (i.e., unstable releases of the documentation), or to get documentation for other languages or earlier releases, see the [http://www.gnucash.org/docs.phtml Documentation] page on the GnuCash.org website.
+
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.
  
 
=== GnuCash Wikis ===  
 
=== GnuCash Wikis ===  
Line 35: Line 33:
  
 
=== The Wiki Glossary ===
 
=== The Wiki Glossary ===
The [[Glossary|Wiki Glossary]] explains some often used terms, with additional terms useful for developers, documentation writers, and translators.
+
The GnuCash Tutorial and Concepts Guide includes a comprehensive Glossary.  
 
 
=== More Specific Topics ===
 
Here is a section of helpful tips on specific aspects of the use and functionality of GnuCash.
 
* "Normal" Usage
 
**[[Keyboard Shortcuts]]
 
** Using [[Scheduled Transactions]]
 
** Online Banking: [[Setting up OFXDirectConnect in GnuCash 2]] and [[AqBanking]] (FinTS/HBCI)
 
** [[Trading Accounts]] (New since 2.3.8/2.4.0)
 
* Scripting and Programming:
 
** How to create some [[Custom Reports]]
 
** [[Python Bindings]]
 
** Notes about the [[C API]]
 
** The [http://cvs.gnucash.org/docs/HEAD/ GnuCash API]
 
* Error Seaching:
 
** [[Logging]] messages and filtering detail.
 
** Getting a [[Stack Trace]]
 
 
 
=== External Documentation Resources ===
 
These resources are one created by users of GnuCash. They may be useful.
 
* [[GnuCash Quick Start Guide For Business Users]].
 
* Also, business users might be interested in a book by PacktPub, UK: GnuCash 2.4 Small Business Accounting, by Ashok Ramachandran
 
* [[Documentation|List to external international documentation]] and a somewhat outdated list of [http://www.gnucash.org/docs.phtml available online documentation]
 
 
 
== Installation ==
 
Installation instructions for the different operating systems under which GnuCash operates are included below.
 
=== 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]]
 
  
=== Windows ===
+
Additionally, the [[Glossary|Wiki Glossary]] includes more terms useful for developers, documentation writers, and translators.
* [[Windows|Microsoft Windows]]: GnuCash runs on Windows. Download the binary package from [http://sourceforge.net/project/showfiles.php?group_id=192 sourceforge.net].
 
  
=== Mac OS X ===
+
== Getting involved in the GnuCash project ==
* GnuCash runs on Mac OS X. Download the binary package from [http://sourceforge.net/project/showfiles.php?group_id=192 sourceforge.net].
+
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.
* For compiling GnuCash on Mac OS X, see [[MacOSXInstallation]] and specific [[MacOSX/Quartz]] tips
 
  
=== Other Operating Systems ===
+
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.
* [[FreeBSD]]
 
* [[Solaris]]
 
  
== Support Options ==
+
'''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.
If you read the relevant parts of the pages above and are still stuck with a problem or only wish to give some feedback, you can contact us in several ways.
 
  
=== Current discussions ===
+
Here are a number of ways to get involved.
==== Mailing Lists ====
 
Most users will probably contact the GnuCash user community through the appropriate language user mailing list (gnucash-user, gnucash-de, gnucash-nl, gnucash-it, gnucash-es, gnucash-fr, gnucash-br).
 
Additional information can be found at [[Mailing Lists]].
 
==== IRC Chat ====
 
Some users may wish to use [[IRC| IRC chat]], usually in english, as the quickest way to get answers.
 
 
 
=== External support pages ===
 
These external support sites have subsections related to GnuCash. They are not maintained by the GnuCash team, so there is no guarantee on the correctness of the information you will find here.
 
* [http://money.stackexchange.com/questions/tagged/gnucash Stack Exchange] includes a forum on money with "gnucash" tagged questions.
 
 
 
=== Feature requests and bug tracking ===
 
* [[Bugzilla]]. GnuCash's bug database for error reports and enhancement requests.
 
* [http://gnucash.uservoice.com Uservoice Forum]. For more general feature requests.
 
In addition, there is an old [[WishList]] on this wiki that users can consult. While this list is not maintained or monitored, users can see some of the things that have been requested in the past.
 
 
 
=== Third party tools ===
 
Several users have [[published tools]] to work with GnuCash.
 
 
 
== Developing for GnuCash ==
 
You may want to check out the [http://www.gnucash.org GnuCash website] for the latest news.
 
 
 
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.
 
 
 
=== Getting involved in the project ===
 
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 are many ways to contribute your knowledge and experience. Contributing to GnuCash identifies a number of ways to get involved. Below are general ways.
 
  
 
=== Mailing Lists ===
 
=== Mailing Lists ===
Line 116: Line 50:
  
 
=== 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  [http://gnucash.uservoice.com Uservoice] pages.
  
 
=== Developing the Documentation ===
 
=== Developing the Documentation ===
Line 123: Line 57:
  
 
=== Translating the Documentation ===
 
=== Translating the Documentation ===
* [[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.
  
 
=== Developing the Application Code ===
 
=== Developing the Application Code ===
Line 134: Line 68:
 
* [[Git]] access
 
* [[Git]] access
 
* [[Building]] GnuCash from source code.
 
* [[Building]] GnuCash from source code.
* Notes about the Graphical User Interface aka [[GUI]]
+
* Creating [[Custom Reports]]
 +
* [[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.
 
* Some notes about the [[GnuCash XML format]] for the XML Backend.
 
* The schema for the [[SQL]] Backend.
 
* The schema for the [[SQL]] Backend.
Line 141: Line 78:
 
* How to improve or add new [[Account Hierarchy Template]]s.
 
* How to improve or add new [[Account Hierarchy Template]]s.
 
* Reminders for the [[Project Administration]]
 
* Reminders for the [[Project Administration]]
* Special events
 
** There was a [[Bounty Program]] in June / July 2013
 
** [[GSoC]] Google Summer of Code
 
  
 
==== 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]]
** [[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
 +
** There was a [[Bounty Program]] in June / July 2013
 +
** [[GSoC]] Google Summer of Code

Latest revision as of 21:31, 25 September 2022

This is a "sandbox" page which is a draft version of the main page to which it is a subpage. If/when the version here is better than the main page, it can be copied in its entirety (except for this message) into the main page. Discussion should mainly take place in email lists and/or at the Talk page of the main page.

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, Mac OS X, and many different flavors of Linux.

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

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.

GnuCash Wikis

(Parts of) this wiki have been translated into other languages or contain information for one specific language only.

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.

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

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

Translating the Documentation

Developing the Application Code

Policy

Procedures

Other Development Notes

Future developments

Historical Information