s.htm(5) ASPseek user's guide s.htm(5)
NAME
s.htm - template and configuration for s.cgi
SYNOPSIS
/usr/local/aspseek/etc/s.htm
DESCRIPTION
s.htm acts both as a configuration file and as a HTML tem-
plate for s.cgi(1). It looks like HTML file, and is
divided into sections. s.cgi(1) takes some sections,
makes meta variables substitution in them, and outputs the
resulting HTML.
Section is a piece of s.htm file that is started with line
and ends with line .
Section consists of HTML formatted text containing meta
variables. Meta variable is one or two letters preceded
by $ sign (example: $DX). Meta variable names are case-
sensitive. s.cgi(1) substitutes meta variables with cor-
responding string.
Special ``variables'' section
This is a special section in which you define various con-
figuration parameters in the form "Parameter value".
Unlike all the other sections, it starts with the string
. The contents of this sec-
tion is never included in s.cgi(1) output.
The following parameters are defined here.
DaemonAddress xxx.xxx.xxx.xxx[:nnn]
Defines the IP address (xxx.xxx.xxx.xxx) and port
(nnn) of search daemon searchd(1). If port is not
set, ASPseek's default port is used.
You should put at least one DaemonAddress. You can
put several DaemonAddress lines; in this case
s.cgi(1) will connect to all searchd(1) daemons,
retrieve results from all of it, and show merged
results.
Note that you can't give DNS names (like
www.myhost.com) as an argument to DaemonAddress,
only numeric IP addresses are allowed here. This is
done because name lookup needed in case of DNS name
will slow down s.cgi(1) considerably.
MaxExcerpts num
Defines the maximum number of excerpts that are
shown in results.
MaxExcerptLen num
Defines the maximum length (in characters) of each
excerpt string.
PagesPerScreen num
Defines the maximum number of links to other search
result pages to be shown if there are many results
found.
ResultsPerPage num
Defines how many results will be shown on one page.
Note that this value is overwritten by PS cookie if
set, and ps parameter to s.cgi(1). Less value makes
search results page to appear faster, so don't set
it too high.
Clones no
If this line is present, clones detecting and show-
ing is disabled.
You can also redefine error messages that are used in
cases s.cgi(1) encounters an error. The following error
messages are used.
ER_STOPWORDS string
Displayed if only stopwords are used in query.
ER_EXTRASYMBOL string
Displayed if some extra symbols were found at the
end of query.
ER_EMPTYQUERY string
Displayed if the query is empty.
ER_TOOSHORT string
Displayed if the pattern is used, and not enough
characters are provided in it. See also the
description of MinFixedPatternLength parameter in
searchd.conf(5).
ER_NOQUOTED string
Displayed if unmatched quote was found.
ER_NOPARENTHESIS string
Displayed if unmatched parenthesis was found.
ER_NOSEARCHD string
Displayed if s.cgi(1) was unable to connect to
searchd(1).
META VARIABLES
Meta variables described here are not position-dependent,
that is to say they can be used in any template sections.
Variables that can be used only in some sections described
in the TEMPLATE SECTIONS below.
$$ This is actually not a meta variable, but a way to
include $ sign to s.cgi(1) output. So, if you want
to put a $ in template, write it as $$.
$AV ASPseek version (like 1.2.10).
$P String "&tmpl=" concatenated with value of tmpl
parameter of s.cgi(1), URL-escaped, or empty string
if there was no tmpl parameter given.
$c Current value of cs (charset) parameter of
s.cgi(1). Works only in Unicode version.
$f Number of first document displayed on this page.
$fm Current value of fm (word forms) parameter of
s.cgi(1).
$ps Current value of ps (results per page) parameter of
s.cgi(1).
$s Current value of s (sorting type) parameter of
s.cgi(1). Can be either rate or date.
$np Current value of np (page number) parameter of
s.cgi(1).
$gr Current value of gr (grouping by site) parameter of
s.cgi(1). Can be either on or off.
$ad Current value of ad ("account distance") parameter
of s.cgi(1). Can be either on or off.
$bd Current value of bd (search in body) parameter of
s.cgi(1). Can be either on or off.
$ds Current value of ds (search in description) parame-
ter of s.cgi(1). Can be either on or off.
$kw Current value of kw (search in keywords) parameter
of s.cgi(1). Can be either on or off.
$tl Current value of tl (search in title) parameter of
s.cgi(1). Can be either on or off.
$CC Template section cached if document is text/html or
text/plain, or template section textversion if doc-
ument was converted from other format.
$DB Document size in kilobytes.
$DC Document Content-type (like text/html).
$DD Document description (taken from META DESCRIPTION
tag).
$DE URL-escaped document URL. Useful for building
"cached link".
$DK Document keywords (taken from META KEYWORDS tag).
$DM Document Last-Modified date.
$DN Document number (in order of appearance).
$DS Document size in bytes.
$DT Document title.
$DR Document rating (as calculated by ASPseek).
$DU Document URL, unescaped.
$DX Document text. If excerpts are enabled and found,
several excerpts from URL content, otherwise the
first couple of lines, to give an idea of what the
document is about.
$DZ Contents of template section sizeb if document size
is less than 1024, otherwise contents of template
section sizek.
$l Number of last document displayed on this page.
$t Total number of documents found.
Search statistics
$W Information about the number of word forms found.
For example, if query was where first number is the
URL count and second number is the total count).
You can use $W only in restop section.
$Y Total time spent to perform query.
The following meta variables gets substituted by corre-
sponding template sections, if some conditions are met.
$w Contents of inres template section if more than one
result is found. inres template section should
define either checkbox "Search within results" or
link to "search within results" page.
$V Contents of navigator template section, if more
than one page of results are found, otherwise
empty.
$M
$Mn Contents of moreurls template section, if grouping
by sites is enabled and more than n results are
found from the site, where n is number following
$M, usually 2. If n is not specified, it is set to
1.
$R Contents of ressites section, if more that one site
is found; otherwise contents of resurls section.
Navigator is a piece of HTML code used for presenting
links to other search result pages. The following vari-
ables are used.
$NL Contents of navleft section, if current page > 0,
otherwise contents of navleft0 section.
$NB Contents of navbar1 template section, repeated
pages per screen times. For page number equal to
current, contents of navbar0 section is printed
instead.
$NR Contents of navright section, if this page is not
last one, otherwise contents of navright0 section.
$NH URL of the another results page, used as a value
for "... and so on. Here in this
section you also provide search form.
The following meta variables are used:
$Q HTML-escaped search query.
$QF URL-escaped search query, concatenated with
previous query if search was made within results).
$q The same as $QF if it is encountered in one of res*
section, otherwise HTML-escaped search query, con-
catenated with previous query if search was made
within results).
$A Argument for FORM ACTION tag with host name and
protocol (example: http://www.aspseek.com/cgi-
bin/s.cgi).
Example:
ASPseek: $Q
bottom This section is always comes last in every page. So
you should provide all the closing tags which have
their counterparts in top section. Although it is
not obligatory to place this section at the end of
template file, but doing so will help you to view
your template as an ordinary HTML file in a browser
to get the idea how it is looks like.
Example:
restop This section is included just before the search
results. It's not a bad idea to provide some common
search results in this section. You can do so by
using the following meta variables: $f, $l, $t, $W.
Example:
Matches $f-$l of total $t
Search took $Y seconds.
$W
res
res2 These sections are used for displaying various
information about every found document. res is used
to display first document for each found site or
for all documents is only 1 site is found (or
grouping by sites is off). res2 is used to display
second document for each site if more than 1 site
is found.
The following meta variables are used: $D* (where * is any
character), $CC, $CL.
Example:
moreurls
This section is displayed when more than 1 or 2
URLs is found on particular site (and grouping by
sites is on). It is displayed in result just
instead of $M2, $M1 or $M meta variables. The fol-
lowing parameters are used in this section:
$SS URL of home page of site of found document.
$SH URL to get more results from this site.
$SC Total number of documents found on this site.
ressites
This section is displayed in case more than one
site is found. See description of $R.
Example:
Displaying sites $f-$l of total $t found.
resurls
This section is displayed in case only one site is
found. See description of $R.
Example:
Displaying documents $f-$l of total $t found on site $SS.
Excerpts and cached copy highlighting
It is very convenient for user to have query words high-
lighted in search result excerpt and in cached copy. This
is done using several sections.
hiopen
hiclose
Used to to highlight the words in "cached" copy.
Contents of these sections are printed before and
after the found word.
hiexopen
hiexclose
Used in displaying excerpts, works the same was as
hiopen and hiclose.
exopen
exclose
Contents of this sections are displayed just before
and after each excerpt found.
hicolors
Each line of this section should contain value of
color for each search term. Value of color is taken
from line with number equal to N mod C, where N is
the search term sequential number and C is the
total number of lines in this section.
The following meta variables are used:
$H String value of color to highlight, taken from
"hicolors" templates section.
Below is an example of highlighting-related sections.
...
...
ffff66
ff66ff
66ffff
ff6666
6666ff
66ff66
Clones
Clones are HTML documents with the same contents. ASPseek
found such documents by comparing calculated MD5 check-
sums.
The following meta variables are used:
$CL List of clones.
Cached pages
The following section names are used to customize the
appearance of "cached" pages (e.g. the pages with page
contents stored in ASPseek's database).
cachetop
This section is included first on every "cached"
page. The following meta variables can be used:
$DU.
Displaying error messages
The following template sections are used to display vari-
ous error messages.
notfound
As its name implies, this section is displayed in
case when no documents are found. You usually give
a little message saying that and maybe some hints
how to make search less restrictive.
Below is an example of notfound section:
Sorry, but search hasn't returned results.
Try to produce less restrictive search query,
or check words spelling.
error This section is displayed in case some internal
error occurred while searching. See the list of
errors in description of variables section. Use
the $E meta variable to print error message text.
Example of error section:
An error occurred.
$E
queryerror
This section is displayed in case if query contains
error like unmatched quote or parenthesis. You
should use $E meta variable here.
Example of error section:
Error in query: $E
$E
complexPhrase
This section is displayed in case if boolean
expression is used inside phrase. Intended just to
warn user, and probably give some hints.
complexExpression
This section is displayed in case if boolean
expression is used in query. Intended just to warn
user, and probably give some hints.
Including a file into template
include filename
If line is encountered,
then ASPseek starts loading template definitions
from file, specified by filename, then resumes pro-
cessing of current file. Example of use: if two or
more template definitions differ only in top and
bottom sections, then create one file with sections
other than top and bottom, then create two differ-
ent files with top and bottom sections.
Special OPTION SELECTED substitutions
In order to save the value for option user selected across
the different search result pages, the following "selected
magic" hack is used. s.cgi(1) scans the template for all
of