FrameMaker APIs

---

SII APIs always include the following:

• Source Code
• Complete documentation (in FrameMaker format)
• Ninety day warranty included in price
• Maintenance available after initial 90 day warranty

1. Program to audit paragraph format utilization. API is installed as report type API. The report is divided into three parts. The first produces paragraph utilization statistics as follows:

    
     Paragraph Tag     Catalogue     Authorized     Total Times     Times Used
                         (Y/N)         (Y/N)            Used        w/Overrides
   
     xxxxxxxxxxxx          x             x            9999999         9999999
   
   

   The second part lists the location of paragraphs with format overrides as follows:

     Paragraph Tag     Document Name     Page Number
   
     xxxxxxxxxxxx      xxxxxxxxxxxx           99
   

   The third part lists the location of paragraphs that were not contained in a user provided list of authorized paragraph tags as follows:

     Paragraph Tag     Document Name     Page Number
   
     xxxxxxxxxxxx      xxxxxxxxxxxx           99
   

   Program can be run at document or book level. Program can also run in batch mode at document or book level. List of authorized paragraphs is supplied in an INI file. INI file also has a flag to indicate whether to produce exception reports.

2. Need API to import ASCII text files based upon marker inserted into the document. API is used to import sample program into a manual from the latest versions prepared by the programmers for the system being documented. Formatting is limited to the following items:
   • Program selects paragraphs to format the item based on the longest line in the input file. Each line in the input file needs to fit in one line in the FramMaker document. The INI file contains information to make the paragraph tag selcetion based on largest input line.
   • Program replaces all spaces with HardSpaces.
   • Program places a hard return at the end of each input line.

3. API to freeze pagination in all documents in a book file. API runs in batch or from Book Menu.

4. API to selectively copy varaiable values from a template file to all documents in a book. API runs in batch from Book Menu. API does the following steps:
   • Program copies User Variables only. System Variables are not changed.
   • Program optionally deletes any user variables not contained in the new template.

5. API to turn show/hide settings on/off at the book level. API runs in batch or from Book Menu.

6. API to generate a list of changed pages. Changed pages are identified by the fact that the change date of each page is equal to or greater than a date entered by the user. Report looks as follow:

     Document Name     Change Date     Page Number
     
     xxxxxxxxxxxx       99/99/99           99.9
   

7. API to print changed pages. Changed pages are identified by the fact that the change date of each page is equal to or greater than a date entered by the user, API runs in batch or from the Book Menu.

8. API to compare a document to a baseline document and list any discrepancies. The baseline document only contains certain paragraphs (basically an outline). Only paragraphs of the types contained in the outline document are compared. The outline document covers the whole book. Where the API may be asked to only check a particular document. As such the program must be able to find a starting point from which to begin comparing the baseline document. A report of discrepancies should be produced. API runs at the book or document level and is capable of running in batch mode.

9. API which automatically updates portions of document text from a repository of text fragments. These fragments are also used to generate online help files and other noin-FrameMaker documentation. Repository allows a writer to prepare one edition of given text fragment (such as a description of customer number) and have that item updated in all documents in which it appears. Repository is maintained as an Oracle database. Text reformatting occurs as a part of included item.

10. API to automatically update certain canned text in documents (i.e., copyright notices, safety notices, disclaimers) with the latest edition of these items. In this case the canned text is maintained in other FrameMaker documents set up sepcifically for this purpose.

11. API to automatically create index markers for all occurrences a list of words to be indexed.

12. API to automatically create hypertext links between all occurances of glossary terms and their glossary definitions contained in the glossary of a book.

1. A document distribution system which once a document has been approved for distribution automatically produces a standalone version of the document, loads a copy of the document to a fax server, loads a copy of the document for the Word Wide Web, and includes the document at the appropriate point in a larger book.

   This is all done from a single set of menus where the user indicates that the document is released for distribution. The system is so sophiscated that the postscript file produced for the stand alone documents is forward to an off-site printer along with a work request to get the document printed.

2. A system which prepares books for electronic publishing on CD ROM and World Wide Web. This includes automatically scanning the documents for items which will not publish well electronically and altering these items as required. All graphics are also converted to a format more suitable for electronic publishing.

[ Home Page | Download Postscript | Custom API ]