Next: 5.4.2 Example BrokerQuery.cf customization
Up: 5.4 Customizing the Broker's
Previous: Defined Variables
Below is a partial list of definitions. A complete list can be
found in the BrokerQuery.cf file. Only definitions likely to be
customized are described here.
-
<Timeout>
Timeout value for BrokerQuery.pl.cgi. If the broker doesn't respond
within this time, BrokerQuery.pl.cgi will exit.
-
<ResultHeader>
The first part of the result page. Should probably contain the HTML
<TITLE>
element and the user query string
-
<ResultTrailer>
The last part of the result page. The default has URL references to the
broker home page and the Harvest project home page.
-
<ResultSetBegin>
This is output just before looping over all the matched objects.
-
<ResultSetEnd>
This is output just after ending the loop over matched objects.
-
<PrintObject>
This definition prints out a matched
object. It should probably include the variables $url, $cs_url,
$desc, and $opaque.
-
<EndBrokerResults>
Printed between <ResultSetEnd>
and
<ResultTrailer>
if the query was successful. Should probably include a
count of matched objects and/or matched lines.
-
<FailBrokerResults>
Similar to <EndBrokerResults>
but
prints if the broker returns an error in response to the query.
-
<ObjectNumPrintf>
A printf format string for the object number ( $objectnum).
-
<TruncateWarning>
Prints a warning message if the result set was truncated at the maximum
number of matched lines.
These following definitions are somewhat different because they are evaluated
as Perl instructions rather than strings.
-
<MatchedLineSub>
Evaluated for every matched line returned by the broker. Can be used to
indent matched lines or to remove the leading ``Matched line'' and attribute
name strings.
-
<InitFunction>
Evaluated near the beginning of the BrokerQuery.pl.cgi program. Can be
used to set up special variables or read data files.
-
<PerObjectFunction>
Evaluated for each object just before <PrintObject>
is called.
Next: 5.4.2 Example BrokerQuery.cf customization
Up: 5.4 Customizing the Broker's
Previous: Defined Variables
Darren Hardy
Mon Apr 3 15:22:37 MDT 1995