APIClients

The [APIClients] section lists FDK clients (plug-ins) to start when FrameMaker starts. Each client description must be on a separate line.

Descriptions for clients that are not filters use the following format:

clientName=ClientType, description, path, mode

Argument	Specify
clientName	The plug-in name
ClientType	The client type—valid types for non-filter clients are Standard, TakeControl, and DocReport
description	A string describing the FDK client
path	The path of the client’s DLL file—can be an absolute path, or relative to the install directory
mode	Which mode of FrameMaker is valid for this client—can be one of makers, structured, or all

For example, the Mailer client setting looks like:

Mailer=Standard, Send Mail API Client, fminit\mailer.dll,all

Clients that are filters use the following format:

clientName=ClientType, [facet, format_ID, vendor_id, display_name, ] description, path, mode, extension

Argument	Specify
clientName	The filter name
ClientType	The filter type—one of FileToFileTextImport, FileToFileGFXImport, or ExportFilter
facet	The format of the original file—For graphic files, FrameMaker saves this facet along with the filtered representation of the graphic
format_id	The dot-extension of the file that identifies its format—for example, .rtf, .bmp, or .cgm
vendor_id	A four-character maximum string that identifies the vendor
display_name	The name to display in dialog boxes when the user chooses the filter
description	A string to describe the filter
path	The path of the filter’s DLL file—can be an absolute path, or relative to the install directory
mode	Which mode of FrameMaker is valid for this filter—can be one of makers, structured, or all

For example, the RTF filter client setting looks like:

RTF=TextImport, RTF, RTF, FAPI, RTF, Rich Text Format (RTF) Import, filters\rtfimprt.dll, all, ^.rtf

To create a client, you need the Frame Developer’s Kit (FDK) for Windows®. If you are installing an FDK client, follow instructions provided with the client to add its startup information to the initialization file. You can also load API clients simply by placing them in the Plugins folder and then starting FrameMaker.