FSLog
This is of use to FrameScript developers only. It provides a simple way to create hyperlinked log files. The link text can be whatever you want, and the link destination is a paragraph in any FrameMaker document. Use it to point out the exact locations of errors or significant passages in your documents.
FrameMaker ships with a plugin for creating book error logs, with hyperlinks to paragraphs in the FrameMaker source documents. This plugin can be used for more than just reporting errors in book generation, but it cannot be called easily from FrameScript.
FSLog provides a simple pass-through plugin that accepts FrameScript-style object definitions and converts them to a format suitable for the FrameMaker BookErrorLog plugin.
Installation
To install, create a new directory under the FrameMaker plugins directory and copy the file there. For example, if FrameMaker is installed in
C:\Program Files\Adobe\FrameMaker7.0\
then copy FSLog.dll to a new directory named
C:\Program Files\Adobe\FrameMaker7.0\fminit\Plugins\FSLog
Alternatively, just copy the DLL into the Plugins directory. When you restart FrameMaker, the plugin registers itself with FrameMaker automatically.
Download FSLog.dll (81 Kbytes).
It has been tested with FrameMaker 7.0 for Windows and FrameScript 2.1, but should work with FrameMaker 6.0 as well.
Using FSLog
Call FSLog using the FrameScript CallClient command. Pass a string message that contains the book id (optional), paragraph id, and the text to be written to the log. To force the message to string format, prepend an empty string ('') to the beginning. For example,
CallClient FrameClient('FSLog') Message('' + vMyBook + vMyPgf + 'This is the hyperlink text.')
CallClient FrameClient('FSLog') Message('' + vMyPgf + 'This is the hyperlink text.')
You can call the plugin repeatedly, to add more entries to the log.
In theory, you should be able to link to objects other than paragraphs, but the BookErrorLog plugin supplied with FrameMaker does not handle them properly.
Feedback
If you try it, please share your comments. That's a fair trade. You get a free FrameMaker utility, and we get your opinion about it. While you're at it, feel free to suggest ideas for other FrameMaker utilities.
We will never use your email address for any sort of mass mailing. You will receive an acknowledgement of your email, written by a real person. In any case, thank you for your feedback.
