FoX documentation.

All in one page

Separate pages

Introduction

This document is the primary documentation for FoX, the Fortan/XML library. See below for other sources of documentation. It consists of:

Reference information on versions, standards compliance, and licensing.

Information about how to get up and running with FoX and how to use FoX in an existing project.

Finally, there is full API reference documentation.

Other documentation

This documentation is largely reference in nature. For new users it is best to start elsewhere:

iFaX workshops

Two workshops, entitled iFaX (Integrating Fortran and XML) have been run teaching the use of FoX, one in January 2007, and one in January 2008. The full documentation and lectures from these may be found at:

• iFaX I
• iFaX II

Tutorials

Out of the above workshops, some tutorial material has been written, focussing on different use cases. Currently two are available:

• SAX input
• DOM input

There is also tutorial information on the use of WKML here.

API documentation

• FoX has seven sets of publically exported interfaces. These are documented here:

COMMON interfaces

• FoX_common
• FoX_utils

OUTPUT interfaces

• FoX_wxml
• FoX_wcml
• FoX_wkml

INPUT interface

• FoX_sax
• FoX_dom

These documents describe all publically usable APIs.

Worked examples of the use of some of these APIs may be found in the examples/ subdirectory, and tutorial-style documentaion is available from the links above.

Other things

• Hints for debugging

• Further information