qof_book_merge

'Query Object Framework: Design and direction.'

Neil Williams

Copyright © 2004-2005 Neil Williams

The GNU GENERAL PUBLIC LICENSE Version 2, June 1991

This documentation is part of QOF.

QOF is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

The GNU General Public Licence.

Table of Contents

Preface: Dependencies

1. QOF dependencies.

2. GnuCash dependencies.

2.1. GnuCash for Gnome2: gnucash-gnome2-dev
2.2. Building GnuCash

1. Introduction

1.1. Terms and definitions.

1.1.1. QOF: Query Object Framework .
1.1.2. Pilot-QOF: Querying Palm databases as objects.
1.1.3. QOF-gen: QOF Object Generator.
1.1.4. Data Freedom: Liberate your data from the application.
1.1.5. What's a QofBook?
1.1.6. QSF - QOF Serialization Format.

1.2. Other versions of this documentation.

2. Background

3. Source Documentation

3.1. Doxygen Documentation.

3.1.1. qof_book_merge Doxygen documentation.
3.1.2. QSF Doxygen documentation.
3.1.3. QOF Doxygen documentation.
3.1.4. GnuCash Doxygen documentation.
3.1.5. GnuCash Gnome2 port Doxygen documentation.

3.2. Other general documentation

3.2.1. Gnucash Design documentation
3.2.2. GnuCash Tutorial and Concepts Guide
3.2.3. GnuCash Help Manual
3.2.4. KVP Values used By GnuCash

3.3. qof_book_merge Source Code

3.4. QSF Source code

3.4.1. QSF and qof_book_merge tarballs

4. Creating GnuCash Invoices using a Palm PDA

4.1. Beginnings

4.2. Getting into GnuCash / QOF

4.2.1. Why the GnuCash File QofBackend needs changing
4.2.2. Tips on debugging within GnuCash

4.3. Building QOF onto pilot-link

4.3.1. Converting existing objects to QOF

4.4. Pilot-QOF

4.4.1. What does QOF have to do with pilot-link, or vice versa?
4.4.2.
4.4.3. Generating new objects

5. QSF - QOF Serialization Format.

5.1. What is QSF?

5.1.1. Features of QSF
5.1.2. Requirements of QSF
5.1.3. Validation of QSF.
5.1.4. QSF examples

5.2. Mapping QSF objects between QOF applications

5.2.1. The QSF Map file
5.2.2. Relating the map to the QSF objects

5.3. Writing new QSF maps

6. Merging QofBook's

6.1. Preparing the rule set

6.2. Draft of a rule set framework.

6.3. Design of the merge

6.3.1. Example programs for qof_book_merge

6.4. Using qof_book_merge with new and existing QOF objects

6.5. Known problems

6.6. Design improvements

7. Data Mining and freedom of access.

7.1. Data mining within QOF
7.2. Data Freedom within QOF

List of Tables
6-1. Struct members (Engine) without set_fcn, get_fcn pairs
6-2. Struct members (Business) without set_fcn, get_fcn pairs
6-3. Struct members (Engine) with resolved issues.
6-4. Struct members (Business) with resolved issues.

		Next
		Preface: Dependencies