Arbortext Command Language > Hooks > includeflattenhook
  
includeflattenhook
includeflattenhook
Function prototype:
hook (dobj)
Synopsis
Use with:
add_hook(hookname, func)
remove_hook(hookname, func)
where hookname is includeflattenhook.
This hook will be called when flattening XML inclusions in a document. The hook will be called each time the process encounters an XML inclusion.
Argument
dobj is the document object representing the inclusion to be flattened.
If the hook returns -1, that inclusion will not be flattened, but will be left displayed inline. Any other return value will result in the inclusion being flattened.