Difference between revisions of "GnuCash/sandbox"

From GnuCash
Jump to: navigation, search
(copy-paste current content of main GnuCash page to here (except remove link to packtpub for Ramachandran book, disallowed by spam filter))
 
(replace most of page by content copied in from proposal by David T elsewhere)
Line 14: Line 14:
 
* [[pt/GnuCash]] Sítio Wiki em Português, em andamento. (Portuguese Wiki site, work in progress)
 
* [[pt/GnuCash]] Sítio Wiki em Português, em andamento. (Portuguese Wiki site, work in progress)
  
−
== Documentation ==
+
xxx
−
* The [[Glossary]] explains some often used terms.
+
== Available Documentation ==
−
* The [[FAQ|GnuCash FAQ]] contains the collection of all frequently asked questions about GnuCash, including administration, accounting, and glossary questions.
+
=== Official GnuCash Documentation ===
−
* Read the online copy of the [http://www.gnucash.org/docs/ released documentation] or the [http://code.gnucash.org/docs/ most recent, unstable versions]. It is highly recommended to read at least the first chapters of the guide.
+
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.
 +
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.
 +
 
 +
=== GnuCash Wikis ===  
 +
(Parts of) this wiki have been translated into other languages or contain information for one specific language only.
 +
* [[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 ===
 +
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 [[Glossary|Wiki Glossary]] explains some often used terms, with additional terms useful for developers, documentation writers, and translators.
 +
 
 +
=== 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]
 
* [[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: [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:
 
−
** "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]]
 
−
** OS specific:
 
−
*** [[MacOSXReadme| Mac OS X Release Notes]]
 
  
−
=== Installation ===
+
== Installation ==
−
OS/Distro specific annotations:
+
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 ===
 +
* [[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 ===
 +
* GnuCash runs on Mac OS X. Download the binary package from [http://sourceforge.net/project/showfiles.php?group_id=192 sourceforge.net].
 +
* For compiling GnuCash on Mac OS X, see [[MacOSXInstallation]] and specific [[MacOSX/Quartz]] tips
 +
 
 +
=== Other Operating Systems ===
 
* [[FreeBSD]]
 
* [[FreeBSD]]
−
* all flavours of [[MacOSXInstallation]] and specific [[MacOSX/Quartz]] tips
 
−
* 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]]
 
* [[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].
 
  
−
== Support ==
+
== Support Options ==
 +
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 ===
 +
==== 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.
  
−
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:
+
=== 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.
  
−
=== Current discussion ===
+
=== Feature requests and bug tracking ===
−
# [[IRC]] chat, usually in english, is the quickest way;
+
* [[Bugzilla]]. GnuCash's bug database for error reports and enhancement requests.
−
# a bunch of [[Mailing Lists]] for discussions in different languages;
+
* [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 ===
 
=== Third party tools ===
−
Several users [[published tools]] to work with Gnucash.
+
Several users have [[published tools]] to work with GnuCash.
  
−
=== External support pages ===
+
== Developing for GnuCash ==
−
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.
+
You may want to check out the [http://www.gnucash.org GnuCash website] for the latest news.
  
−
# [http://money.stackexchange.com/questions/tagged/gnucash Stack Exchange forum on money (with "gnucash" tagged questions)]
+
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.
  
−
=== Feature request and bug tracking ===
+
=== Getting involved in the project ===
−
# [[Bugzilla]] bug database for error reports and enhancement requests;
+
The GnuCash Project is a volunteer-driven organization. We need your help to survive and grow, to help others and to help the Project.
−
# [http://gnucash.uservoice.com "Uservoice" Feature Request Forum].
+
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.
  
−
This will also influence the
+
=== 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.
  
−
== Further Development ==
+
=== 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.
  
−
You may also want to check out http://www.gnucash.org/ for the latest news.
+
=== Developing the Documentation ===
 +
* [[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]].
  
−
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.
+
=== Translating the Documentation ===
 +
* [[Translation|Translations]] gives an overview of this process, but please keep an eye on the [[Translation Status]]
  
−
=== Getting involved in the project ===
+
=== Developing the Application Code ===
−
 
+
==== Policy ====
−
==== Permanent valid ====
+
* Our [[Development Process]]
−
* How to get involved in [[Contributing to GnuCash]] - not only for programmers ...
+
* [[CodingStandard | Coding Standards]]
−
* [[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.
+
* [[Testing]]
−
* How to edit and improve the [[Translation]]s, but please keep an eye on the [[Translation Status]].
 
−
* How to improve or add new [[Account Hierarchy Template]]s.
 
−
* Reminders for the [[Project Administration]]
 
−
 
 
−
==== Special events ====
 
−
* There was a [[Bounty Program]] in June / July 2013
 
−
* [[GSoC]] Google Summer of Code
 
  
−
=== Current Source Code ===
+
==== Procedures ====
−
==== Informative ====
 
 
* [[Git]] access
 
* [[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]].
 
 
* Notes about the Graphical User Interface aka [[GUI]]
 
* Notes about the Graphical User Interface aka [[GUI]]
 
* 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.
−
==== Policy ====
 
−
* Our [[Development Process]]
 
−
* [[CodingStandard | Coding Standards]]
 
−
* [[Testing]]
 
  
−
=== Future developments ===
+
==== Other Development Notes ====
 +
* How to improve or add new [[Account Hierarchy Template]]s.
 +
* Reminders for the [[Project Administration]]
 +
* Special events
 +
** There was a [[Bounty Program]] in June / July 2013
 +
** [[GSoC]] Google Summer of Code
 +
 
 +
==== Future developments ====
 
* Our [[Release Schedule]]
 
* Our [[Release Schedule]]
 
* Future [[Roadmap]]
 
* Future [[Roadmap]]
Line 118: Line 156:
 
** [[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]]
−
----
 
−
The GnuCash Project is a volunteer-driven organization. We need your help to survive and grow, to help others and to help the Project.
 

Revision as of 16:20, 29 May 2017

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.

Translation

(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:

  • de/GnuCash Deutsche Wiki-Seiten, im Entstehen (German pages, work in progress)
  • es/GnuCash (Spanish pages, work in progress)
  • pt/GnuCash Sítio Wiki em Português, em andamento. (Portuguese Wiki site, work in progress)

xxx

Available Documentation

Official GnuCash Documentation

GnuCash offers two major pieces of documentation:

For the latest documentation (i.e., unstable releases of the documentation), or to get documentation for other languages or earlier releases, see the Documentation page on the GnuCash.org website.

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 Wiki Glossary explains some often used terms, with additional terms useful for developers, documentation writers, and translators.

More Specific Topics

Here is a section of helpful tips on specific aspects of the use and functionality of GnuCash.

External Documentation Resources

These resources are one created by users of GnuCash. They may be useful.

Installation

Installation instructions for the different operating systems under which GnuCash operates are included below.

Linux

Windows

Mac OS X

Other Operating Systems

Support Options

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

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

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

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 [1] pages.

Developing the Documentation

Translating the Documentation

Developing the Application Code

Policy

Procedures

  • Git access
  • Building GnuCash from source code.
  • Notes about the Graphical User Interface aka GUI
  • Some notes about the GnuCash XML format for the XML Backend.
  • The schema for the SQL Backend.

Other Development Notes

Future developments

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