Edit BookVars File

This command opens the BookVars file for editing. If the BookVars file does not exist, a default file is created. For information about the format of a BookVars file, see BookVars File. The file opens in the editor type specified when you originally created the BookVars file with the Generate BookVars File command; the internal editor (a FrameMaker dialog box), or an external editor (Notepad by default).



Generally, when editing a BookVars file, you will focus on the sections that define the variable groups. Each entry is made up of a variable name and definition. This is represented in the BookVars file as the following:

VARNAME=VAR DEFINITION

Where, VARNAME is the variable name and VAR DEFINITION is the definition. After generating a BookVars file, all exported variable will appear in this format. If you change the definition of a variable, then import that variable group into the book (with the Import Variables command), the new definition will replace the old one. If you add a new entry (variable name and definition) this variable will be added to the files when imported into the book. Removing an entry (both name and definition) will have no effect on the files when imported into the book. This means that you can delete all variable entries from the BookVars file that you want to remain as they are. To delete variables from files in a book, use the DeleteVarCode parameter as described in the BookVars File topic.

For your convenience, the definitions in each variable group are split into two sections, one for user variables and the other for system variables. This separation is purely for your ease in organizing. Feel free to delete any or all of the variables from this section as needed. When generating a BookVars file, you can choose to include the system variables, the user variables, or both.

Starting in version 2.00, BookVars allows you to include a variable definition within another variable definition. Use the syntax “<$VAR[VARNAME]>” to include a variable definition in the VAR DEFINITION portion of the BookVars file. The VARNAME portion should be replaced with the actual variable format name. Of course, this comes with limitations. The included variable definition will be the value as it exists at the time of processing. If your BookVars file changes the value of the included variable definition after you specify the inclusion, it’ll represent the old value. Use this feature carefully.

FM 5, 6, 7 WARNING: Once you select the editor type, you should not change it by editing the BookVars file. Editing a BookVars file with an external editor that was intended to be edited with the internal editor will cause any high-ASCII characters to be corrupted. The same goes for editing a file with the internal editor that was intended to be edited with an external editor. For more information on choosing the appropriate text editor, see Selecting the Text Editor Type. For other limitations, see Known Limitations.