Estron design and developers reference

0.7.0

This is the developer and design manual for Estron - Data With Integration. It should always be up to date since it is generated directly from the source files using Doxygen.

The 'estron' name.

http://www.cs.cf.ac.uk/fun/welsh/LexiconForms.html

'estron' is a Welsh word meaning 'foreign, strange, alien, exotic, outlandish' and this project uses the meaning 'foreign' or 'alien' to denote the conversion of data from unknown formats into usable formats.

Note that the DWI design is fundamentally "declarative"; i.e. it works like a declarative language. The nature of the interface is declared in the XML file. The "estron" interpreter reads in this static file, sets up structures that correspond to the XML declaration. Then the evaluator goes into the main loop, and signals and events make everything happens according to the pre-determined definitions in the XML file. There is no run-time interpretation. There is no 'just-in-time' compilation. It just runs along the fixed paths, where each path had been pre-defined in the XML file, and each run-through is initiated by the user clicking or typing in the GUI.

Other QOF-related content:
http://www.linux.codehelp.co.uk/

Hacking on this documentation

There is the beginning of a style guide for documenting under Useful tips for doxygen in C files.

Feel free to start documenting or playing with doxygen configuration. This main page can be found in doc/estron_main_page.c .

This main page is just an introduction to doxygen markup, see the Doxygen manual for the full command set.

Licence for this documentation.

The copyright licensing notice below applies to this text.

Copyright © 2005-2008 Neil Williams

Permission is granted to copy, distribute, and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts, and with no Back-Cover Texts. A copy of this license is available at http://qof.alioth.debian.org/copying.txt or installed alongside this documentation in the "copyright" file.


Generated on Tue Apr 29 21:27:53 2008 for estron by  doxygen 1.5.5