Normalizes all references in the files of a FM book file.
Use this function to rebuild and correct all references
(xrefs, links, conrefs, and image references) after aggregating
loose DITA topics into “chapter” files. Call this function using
the “FixBookRefs” parameter to update the active book, or pass the bookIdOrName value
(as a string) after this parameter to update a specific book. In order
to properly update the references in the book, the fm-ditabook/@href
attribute must be set to the map’s path and file name. You can set
this attribute before calling FixBookRefs, or you can pass this
value as the mapFile parameter.
F_ApiCallClient("ditafmx", "FixBookRefs [[|bookIdOrName] |mapFile]");
- The id or path and file name of the book to process. The book
must be open. You must use double backslashes as the directory delimiter
when specifying the book file name. Optional; if not provided the
“active” book is used, must be provided if mapFile is
- The path and file name of the DITA map from
which the book was generated. You must use double backslashes as
the directory delimiter when specifying the DITA map file name.
Optional; if not provided the fm-ditabook/@href attribute must be
set to the value of the map’s path and file name before calling FixBookRefs.
If this parameter is used, the bookIdOrName parameter
Note: This DITA-FMx API function
is only available when the “FMx-Auto” addon is installed. For information
on this DITA-FMx addon, please contact Leximation.
- Failure. Unable to update the specified book. It is also possible
that DITA-FMx is not available for calls. Verify that DITA-FMx is
registered in the maker.ini file using the
client name of “ditafmx”.
- Failure. bookIdOrName is not a structured
- Failure. No non-generated files in book.
- Successfully updated the specified book (this is the id of the