BookXRefs File

The BookXRefs file is an INI-format file that lets you define one or more xref groups. The xref definitions in these groups can be imported into all of the files in a book using the Import XRef Definitions command. The BookXRefs file is named <bookname>-BookXRefs.INI (where <bookname> is the name of the book file without the extension).

You can create the BookXRefs file manually, or you can use the Generate BookXRefs File command to create one based on the existing xrefs in one of the files in the book. For a quick overview of the BookXRefs file, see Set up a simple BookXRefs file (one group, three xref definitions).

The BookXRefs file has two required sections (General and Groups) and one or more user-definable sections to define xref groups. The General section has 6 valid parameters.

[General] 
AltBookXRefsFile= 
DeleteXrefCode= 
RenameXRefChar= 
ReplaceXRefChar= 
EditorType=0 
NoLog=0

The BookXRefs file can point to an alternate location for the group and xref lists. This can be helpful if you are working with a group of people and you want to be able to maintain the xref definitions in one location. Just set the AltBookXRefsFile parameter to point to the common network location for the BookXRefs file, and all of your books will pull the xref definitions from the same list. For an example of referencing an alternate file, see Reference a common BookXRefs file.

Note: You must use the front slash as a directory separator with the AltBookXRefsFile parameter. For more information, see Known Limitations.

The Groups section has a Count parameter and one or more sequentially numbered parameters. The Count parameter specifies the number of numbered parameters. The numbered parameters specify individual xref groups.

[Groups] 
Count=2 
1=Group1 
2=Group2

BookXRefs provides the ability to merge multiple groups (perhaps to define one or more groups as shared or common). By creating a new section named "<groupname>:MERGE", when you import the <groupname> group, it will first load the groups defined in the "merge" section. For an example of merging groups, see Set up a shared group that is included in two other groups.

[Group1:MERGE] 
Count=2 
1=CommonGroup1 
2=CommonGroup2