htmlfloathook
htmlfloathook
Function prototype:
hook=(floatnum, fclassname, floattype, src_oid, a_oid, div_oid))
Synopsis
Use with:
add_hook(hookname, func)
remove_hook(hookname, func)
where hookname is htmlfloathook.
Arbortext Editor calls this hook when it encounters a float while converting a document to HTML. The hook passes the float's arguments (described below) to the associated function func.
Arguments
• floatnum is an integer unique to each float, in order of the float's anchor, such that the first float encountered in the in the document is 1, the next 2, and so on.
• fclassname is a string which is the floatloc floatid from the FOSI, or in the case of footnotes, it is the string __footnote.
• floattype is an integer representing the floatloc floattyp from the FOSI where 0 means once, 1 means atpgbrk, 2 means atcolbrk, and 3 means multiref.
• src_oid is the oid in the SGML or XML document which caused the float per the FOSI. This makes it possible to customize behavior based on which element floated (e.g., a graphic or a table) or based on one of its attribute values, its context, etc.
• a_oid is the oid of the a element which is inserted into the output virtual document (vdoc). It is the responsibility of the ACL code to assign an href to this element which points to the float, and to insert whatever content is to be used for the hot spot.
• div_oid is the oid of the div element which is placed around all of the content for a given float in the output vdoc. Unless the float is to be left inline, the function called by the hook should select and cut this oid and its content, and paste or write it elsewhere.