There are some equates which are pre-defined as void but whose definition can be overwritten by the user. These equates are called at specific points during generation of the output (mostly before and after text bodies) and allow additional processing to be carried out at these stages. For most of these predefined equates if a value is returned that value will be written to the output stream with the text body. This allows the equates surrounding text bodies to write values to the output without relying on a system variable and another equate within the text body. These equates are always called (the text body equates are only called if the text body itself is being written to the output stream) but have no affect unless redefined to something other than void.
eq_init is called before any output is generated. Can be
usefully used to enable tracing, disable the banner message, or replace the
banner message with something else.
eq_pre_header is called before writing a header text body.
eq_pre_footer is called before writing a footer text body.
eq_pre_page01 is called before writing a page 1 text body.
eq_pre_pagenn is called before writing a page N text body.
eq_pre_banner is called before writing a banner text body.
eq_pre_record is called before writing a record text body.
eq_pre_block is called before writing a block text body.
eq_post_header is called after writing a header text body.
eq_post_footer is called after writing a footer text body.
eq_post_page01 is called after writing a page 1 text body.
eq_post_pagenn is called after writing a page N text body.
eq_post_banner is called after writing a banner text body.
eq_post_record is called after writing a record text body.
eq_post_block is called after writing a block text body.
eq_exit is called at the very end of processing just before
the output file is closed.
The exact call order of these is given in
section Processing Sequence on the processing sequence.
These can be redefined just like any other equate. However
eq_texinit cannot use any database operations (since
it is called before any databases have been loaded) or write to the output
file (since this won't have been opened).
The following equates are deprecated by the above and shoult not be used:
eq_texinit, eq_pretexheader,
eq_pretexfooter, eq_pretexpage01,
eq_pretexpagenn, eq_pretexbanner,
eq_pretexrecord, eq_pretexblock,
eq_psttexheader, eq_psttexfooter,
eq_psttexpage01, eq_psttexpagenn,
eq_psttexbanner, eq_psttexrecord,
eq_psttexblock, eq_texexit.
Go to the first, previous, next, last section, table of contents.