SII

Installation and Maintainence

This document describes the installation and maintenance of the Paragraph Utilization Audit API.

Setting up the configuration file

It is necessary to complete this set up procedure in order to provide information for this API to function properly. The output of the program relies on the information put in here. Whether you want exception tables to be generated as a separate document or not is necessary information to put in for output generation.

This file is created as a plain text file using any text editor.

The file ``authtags.ini'' must contain a list of authorized paragraph tags. The first line of this file should be:

Generate_Exception=Y or N
This is a yes/no indicator that is necessary if exception tables (overrides and unauthorized tag usage) are to be generated or not.

If you want the API to generate exception tables, enter Y.

If you do NOT want the API to generate exception tables, enter N.For more information on exception tables see API Output.
You then type to following lines in order to generate the list of authorized paragraph tags:

-Start_Paragraph_Tags-
This will marks the start of the list of authorized paragraph tag list.

Paragraph tag names
These are the actual tag names entered one per line.

-EOF-
This is the last line to type in order to end the program.
This should be a comprehensive list of all the paragraph formats you want to allow in your document.

Be careful if there are going to be many instances of unauthorized paragraphs in the document, especially when exception reports are generated since this may cause memory to run out, even on small documents.If you are uncertain about the amount of unauthorized paragraphs that exist you should first run the documents in statistical mode and figure out how many exceptions there are. If there are a lot you should only run a small number of documents at a time.

An example of an authtags.ini file and list of authorized paragraph tags is shown in Figure 1.

Generate_Exception=Y
-Start_Paragraph_Tags-
0body
0body_compact
0caution_body
3ul3n-emdash
4body
4body_compact
4ul3c-emdash_compact
4ul3n-emdash
AnchorLine
AnchorTop
approval
bookhead
cc-cell_center
cl-cell_left
cr-cell_right
date
figurecaption
footnote1
footnote_normal
footnotenormal
Logo
NewPage
NotePage
product_name
table_head_right
CircuitDescription
-EOF-

Figure 1 Example authtags.ini file

Installation Procedures

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. Installation materials may be received on a variety of media (i.e. diskette or tape) in tar format. Normally the software is in the form of a compressed tar file which is received over the Internet using ftp.

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

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

    3. Build product by entering the command:

    make

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

    4. Decide where you are going to install production version of API and related files.

    5. Copy appropriate files to final installation locations.

    6. 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: /afs/btv/data/memory/fminit/usenglish/APIArea/apiclients. Insert the following lines at the end of the file.

    <APIclient

    <Name Table_Inserter>

    /afs/btv/data/memory/fminit/usenglish/APIArea/resources>

    <Directory client_dir>

    /afs/btv/data/memory/bin/para

    <CommandLine executable_dir/tabinsert.fa>

    <Products Maker>

    <RPCVersion 1>

    7. Verify that installation has been successful.

Operational Notes


Paragraph Utilization API: Introduction
[ Frame API's | SII Home Page | Contact Us ]