SII

Installing Table Conversion API

This chapter explains how to install the Table Conversion API. You should be familiar with FrameMaker installation and general UNIX system administration before attempting to install the API. The following products must already be installed on your system:

    1 Unload installation materials. Normally installation materials are received on a variety of media (i.e. diskette or tape) in tar format.

    This will create 6 new directories: distr/, src/, prj/, inc/, fminit/, and docs/.

    distr/

    contains sample documents and test files to be used to verify proper installation.


    src/
    contains source code.


    prj/
    primary Make file and other files used to start installation process.


    inc/
    header files.


    fminit/
    sample FrameMaker initialization directory.


    docs/
    FrameMaker documents making up this manual.

    The rest of these instructions assume you are in the prj directory when you issue any commands.

    2 Determine type of installation you are going to use.

    3 Tailor Make file. There are several items in the make file that may need to be changed.

    1. Location where Frame is installed. Edit the line:

      F_DIR=/usr/frame4

      to look like:

      F_DIR = frame_dir

      where frame_dir is the directory where Frame is installed on your system.

    2. Location of Frame developer's kit (fdk) libraries. Edit the line:

      L_DIR = $(F_DIR)/fdk/lib/sunxm.os.sparc

      to look like:

      L_DIR = lib_location

      where lib_location is the location of the fdk libraries on your system.

    3. Location of fdk include files. Change the line:

      INCL = -I$(F_DIR)/fdk/include -I../inc

      to look like:

      INCL = incl_location -I../inc

      where incl_location is the location of the fdk include files on your system.

    4. The following lines may need to be changed to meet local processing requirements:

      LD-FLAGS = -L$(L_DIR) -lfapi -lfde -ll

      CC=gcc

      LEX=flex

    4 Build product by entering the command:

    make

If installation is successful up to this point, there will be a new file created in the prj/ directory called tabinsert.fa.

    5 Decide where you are going to install production version of API and related files. These are commonly used locations which are recommended by FrameMaker:

Although these locations are recommended by FrameMaker, users often establish other locations for the following reasons:

    6 Copy appropriate files to final installation locations.

    1. Copy tabinsert.fa to appropriate executable directory.

      Example: If you are using the recommended location for executable files, then you would enter:

      cp tabinsert.fa $FMHOME/bin

    2. Copy sample tabinsert.ini to API resources directory.

      Example: If you are using the recommended location for the API resources directory, you would enter:

      cp ../distr/tabinsert.ini $FMHOME/fminit/usenglish/APIArea/resources

    7 Modify API client file with an appropriate text editor. If you keep the API client file in the Frame home directory, this would be the file: $FMHOME/fminit/usenglish/APIArea/apiclients. Insert the following lines at the end of the file.

    <APIclient

    <Name Table_Inserter>

    <Directory client_dir>

    <CommandLine executable_dir/tabinsert.fa>

    <Products Maker>

    <RPCVersion 1>

    where you replace client_dir with the location of tabinsert.ini, such as $FMHOME/fminit/usenglish/APIArea/resources and you replace executable_dir with the location of the executable files, such as $FMHOME/bin.

    8 Change the description for Marker Type 24 to Table Pointer. This is done by editing the file $FMHOME/fminit/resources/maker. Change the line

    Maker*marker . 24: Type 24

to look like:

Maker*marker . 24: Table Caption

    9 Verify that installation has been successful.

    If API is properly installed, the following table will appear:
    • External Graphics
    Figure 0-1. Sample table test2.caps.

If for some reason you need to test the program after the initialization file has been modified, you should add the following lines to your initialization file before running this test:

Figure 0-3. Sample table initialization file parameters

Post-Installation Activities

Successful use of the Table API requires some tailoring of the initialization file tabinsert.ini and your document templates as necessary to suit your needs. This is described in detail in Chapter 3. ``Preparing Information for Table API''.

Contents of DISTR directory

There are several sample documents and test files in the DISTR directory that will also be helpful:

DATAPAGE.TEMPLATE

This is a sample Frame Maker document containing several sample formats in the reference pages, including the ones necessary to insert the sample tables.

test2.caps

Sample ASCII text file with examples of all types of character formatting using markup symbols.

chvqga.rdelay

Sample ASCII text file, using actual data and giving an example of straddling.

tabinsert.ini

Sample initialization file. Contains parameters necessary to insert sample tables into sample document. See Appendix B. ``Sample Initialization file''.

Table Inserter API: Contents Introduction Invoking the API Preparing Information Error Messages Sample Initialization File How API uses Markers
[ Frame API's | SII Home Page | Contact Us ]