~johanvdw/osgeo-fdo/trunk

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
FDO and Provider API Documentation README
=========================================

This ReadMe contains information about the documentation included with 
this release. The FDO and Provider API documentation is created from the 
FDO and Provider Open Source header files. The documentation is produced 
as HTML, thus requires a browser to view.

After extracting the FDO OpenSource files, extract the FDO OpenSource 
documentation to <Your FDO OpenSource Location>\OpenSource\Fdo\Docs using 
either gunzip/tar or Winzip.

       On Linux or Windows, use the gunzip and tar utilities as follows:

            gunzip fdodocs-3.4.0.tar.gz
            tar -xvf fdodocs-3.4.0.tar

       - or -

       On Windows, use the Winzip utility as follows:

            WINZIP32.EXE fdodocs-3.4.0.tar.gz

For example, once the documentation is extracted, it is located here:

C:\OpenSource_FDO\Fdo\Docs\

The following API Reference Help is provided with this release:

 - Feature Data Objects API --> \HTML\FDO_API\index.html
 - FDO Managed Wrapper API  --> \HTML\FDO_API_managed\index.html
 - FDO Provider for SDF     --> \HTML\Providers\SDF\index.html
 - FDO Provider for SHP     --> \HTML\Providers\SHP\index.html

** OPTIONAL: The FDO build process allows it's documentation to be 
regenerated. If this is required, see OpenSourceBuild_README.txt.

NOTES:
- Navigation, Contents, and Index are available within the HTML frames.
- Image maps of class hierarchy diagrams provide direct links to the class topics.
- The Index can be opened to Find (CTRL-F) specific classes etc.
- Compiled Help (.chm) versions *of the same content* are included for Windows users

2006-02-01
<end>