BookXRefs

BookXRefs is a FrameMaker plugin developed for FrameMaker 5.5 and above, and can be used with both structured and unstructured files. The BookXRefs commands let you define a set of xref definitions that are associated with a book file, then update all files in the book with those definitions. You can also define multiple xref definition groups and easily switch between those groups (handy for creating different versions of the same documents, or for use with multiple languages). The BookXRefs file is just a simple INI file that is created in the same folder as the book file. This file is named <bookname>-BookXRefs.INI and can be edited with any text editor. You can also use the BookXRefs file to delete specific xref definitions from documents. For information about the format of a BookXRefs file and how to create one, see the BookXRefs File topic.

Important: Because these commands can make global and irreversible changes to your files, be sure to have backups of all files being processed. For the current list of known limitations (or bugs), see Known Limitations.

Contact <tools AT leximation DOT com> with comments and questions.

Book Menu Commands

The following commands are only available when a FrameMaker book file has the focus.

Generate BookXRefs File: Creates a new BookXRefs file based on the xref definitions in the selected file(s).; More info...
Update BookXRefs File: Updates an existing BookXRefs file based on the xrefs defined in the selected file(s). Lets you update an existing xref group or add a new group.; More info...
Edit BookXRefs File: Allows you to edit the BookXRefs file to manually modify the xref definitions.; More info...
Import XRef Definitions: Opens each file in the book and imports the xref definitions in the BookXRefs file. This can be used to update existing xref definitions, add new xref definitions, or delete and rename specific xref definitions.; More info...
Delete All XRef Definitions: Deletes all of the xref definitions in all of the files in the book. Note that any xrefs in use in the files will be converted to text.
Delete Unused XRef Definitions: Deletes all of the unreferenced xref definitions in all of the files in the book.
Open Last Log File: Opens the log file generated by the last Import or Delete command. Each time you run one of these commands the previous log file is overwritten.

Document Menu Commands

All BookXRefs document menu commands switch to the current document's parent book (if that book is open) before continuing.

The Pubs-Tools Menu

Each tool you install adds a submenu to the Pubs-Tools menu which is available on the FrameMaker menu bar. In addition to the tool’s commands, the submenu provides access to the tool’s online Help and “About” information.

To activate a tool, choose Pubs-Tools > BookXRefs > Enter Authorization Code. You can get a 30-day trial authorization code from leximation.com or when you purchase a tool, you will receive a permanent authorization code which is good for all minor updates to the version you purchased.

Use the Pubs-Tools > Check for Updates command to check for updates to all FrameMaker Pubs-Tools that you have installed.

Visit www.leximation.com/tools/ for information on the latest tools from Leximation.

The Leximation, Inc. End-User License Agreement is available at www.leximation.com/eula/.