The
following items are known limitations of this tool:
- (This limitation only applies to FrameMaker versions
prior to FM8.) When writing to a text file, FrameMaker writes
high-ASCII characters (those with a decimal ASCII value above 127)
in a way that is not understood by external text editors. Therefore,
when writing a BookXRefs file
that is to be used by an external editor, a transformation is applied
so the characters are written correctly. When writing to a BookXRefs file that is to be used
by the internal editor, no transformation is applied. Because of
this, you should carefully choose the Text Editor Type option of
the Generate BookXRefs File command.
For more information, see Selecting the Text Editor Type.
- The “internal editor” can only handle files of up to 30KB in
size. If you need to edit a BookXRefs file
larger than that you should use the external text editor option.
The internal editor will display the contents of larger files but
you will be unable to save any edits made to files that are over
30K when opened. (Keeping in mind the high-ASCII issue listed above.)
For information about using an external editor, see Edit BookXRefs File.
- Use of backslashes in the BookXRefs file
may not work as desired. If you need a backslash in the resulting xref definition,
you must enter two backslashes; a single backslash may end up “escaping”
the character that follows it, resulting in an incorrect xref. (Note that if you
want to use “special” characters in the BookXRefs file,
you’ll use the single backslash, for details, see Using special characters in the BookXRefs file.)
- You should use the front slash as a directory separator in the
AltBookXRefsFile parameter.
These will be converted into backslashes when passed to the operating
system.
- XRef names
defined in a BookXRefs file
are limited in length to 255 characters (it appears that FrameMaker
will accept longer names, but why?). Accordingly, the length of
a xref definition is
limited to 255 characters (which is also the maximum length allowed
by FrameMaker).
- To prevent FM files from being saved incorrectly, BookXRefs will not process files
(with the Import and Delete commands) that have errors such as missing
fonts or graphics. If you want to process files that have these
errors, you must open them before running the BookXRefs command. BookXRefs will generate
a BookXRefs INI file
using files with errors since the files are not saved after opening.