SSServer and Subject Search Server are trademarks of Kryloff Technologies, Inc.
SSServer is a powerful search tool that automates the retrieval and selection of all the useful information available on your Web Site. SSServer allows to:
The general search procedure is as follows:
Below is an example form to be included in one or several HTML documents on your Web server. You may copy and paste this form into a temporary HTML document, then modify or translate its contents into another language (the form layout has been simplified).
Search phrase: | |
The rest of the FORM elements given below are optional; the default
values are shown on the form and can be changed by modifying the
configuration file "ssserver.ini": | |
Use search method: | Subject Search (smart fuzzy) Literal Search (exact) |
Report to you with: | selections from the most relevant pages |
Display selections as: | |
Each selection contains: | characters |
Show plain text only in each selection | |
Extract no more than: | quotations from the same document (relevant if the Subject Search method is selected) |
Include quotes with the relevancy: | (%) or higher (Subject Search only) |
Search for: | (Literal Search only) |
Case sensitiveness: | (Literal Search only) |
|
Here's this search form contents in HTML format (unnecessary tags excluded):
<!-- To be included within the <body> tag of your HTML files --> <FORM ACTION="cgi-bin/ssserver" METHOD="POST"> <INPUT TYPE="HIDDEN" NAME="CONFIG" VALUE="ssserver.ini"> Search on this site is provided by <a href="http://www.kryltech.com">Kryloff Technologies, Inc.</a> <!-- You cannot remove the link to Kryloff Technologies, Inc. --> Search phrase: <INPUT TYPE="TEXT" NAME="QUERY" SIZE="72" MAXLENGTH="255" VALUE=""> The rest of the FORM elements given below are optional; the default values are shown on the form and can be changed by modifying the configuration file "ssserver.ini". Use search method: <INPUT TYPE="RADIO" NAME="METHOD" VALUE="FUZZY" CHECKED>Subject Search (smart fuzzy) <INPUT TYPE="RADIO" NAME="METHOD" VALUE="EXACT">Literal Search (exact) Report to you with: <SELECT NAME="QUOTES"> <OPTION>10 <OPTION SELECTED>25 <OPTION>50 <OPTION>100 <OPTION>250 <OPTION>500 <OPTION>1000 </SELECT> selections from the most relevant pages Display selections as: <SELECT NAME="REPORTWITH"> <OPTION VALUE="Q" SELECTED>Quotations from original pages <OPTION VALUE="B">Beginning of each page found <OPTION VALUE="DQ">Page summary or quotations <OPTION VALUE="DB">Page summary or beginning </SELECT> Each selection contains: <SELECT NAME="QUOTESIZE"> <OPTION>100 <OPTION>500 <OPTION SELECTED>1000 <OPTION>2500 <OPTION>5000 </SELECT> characters <INPUT TYPE="CHECKBOX" NAME="PLAINTEXT" VALUE="YES">Show plain text only in each selection Extract no more than: <SELECT NAME="QUOTESPERDOC"> <OPTION>1 <OPTION>2 <OPTION>3 <OPTION>4 <OPTION SELECTED>5 <OPTION>6 <OPTION>7 <OPTION>8 <OPTION>9 <OPTION>10 <OPTION>11 <OPTION>12 <OPTION>13 <OPTION>14 <OPTION>15 </SELECT> quotations from the same document (relevant if the Subject Search method is selected) Include quotes with the relevancy: <SELECT NAME="RELEVANCY"> <OPTION>10 <OPTION>20 <OPTION>30 <OPTION SELECTED>40 <OPTION>50 <OPTION>60 <OPTION>70 <OPTION>80 <OPTION>90 <OPTION>100 </SELECT> (%) or higher (Subject Search only) Search for: <SELECT NAME="TERMS"> <OPTION VALUE="ANY">for any term <OPTION VALUE="ALL" SELECTED>for all terms <OPTION VALUE="PHRASE">as a phrase </SELECT> (Literal Search only) Case sensitiveness: <SELECT NAME="CASE"> <OPTION VALUE="INSENSITIVE" SELECTED>case insensitive <OPTION VALUE="SENSITIVE">case sensitive </SELECT> (Literal Search only) <INPUT TYPE="SUBMIT" NAME="SEARCH" VALUE="Search"> <INPUT TYPE="SUBMIT" NAME="SITEMAP" VALUE="Site Map"> <INPUT TYPE="SUBMIT" NAME="HELP" VALUE="Help"> </FORM> |
SSServer processes query strings posted on the application by a remote browser when the user presses any of the SUBMIT buttons on the search query form. The query string should contain all or any of the following parameters:
QUERY=<query string>
CONFIG=<configuration file name>
SUBJECTLAYOUT=<report template file name used when the
user selects Subject Search>
LITERALLAYOUT=<report template file name used when the user
selects Literal Search>
SITEMAPLAYOUT=<template file name used for displaying the site map>
LANGUAGE=<language dictionary file name>
FILELIST=<name of the file, which lists files/directories to be searched>
HELPFILE=<name of the End-User Help file>
WARNINGS=<YES or NO>
FILEEXTENSIONS=<list of file extensions to be processed by SSServer>
EXCLUDEFILEEXTENSIONS=<list of file extensions to be skipped by SSServer>
SITEROOTURL=<your Web server's Internet address>
WORKDIR=<directory in which SSServer keeps temporary and work files>
ACTION=<action>
QUOTES=<number of quotes to generate>
QUOTESIZE=<quotation size>
QUOTESPERDOC=<max. number of quotes that can be extracted from the same file>
METHOD=<search method>
RELEVANCY=<relevancy in the range 0-100>
TERMS=<Literal Search option>
CASE=<Literal Search option>
REPORTWITH=<Q, B, DQ or DB>
SUBJECTREPORTWITH=<Q, B, DQ or DB>
LITERALREPORTWITH=<Q, B, DQ or DB>
ALLOWSITEMAP=<YES or NO>
PLAINTEXT=<YES or NO>
The description of each of the parameters follows:
This file contains all or any of the query string parameters (except for the CONFIG option, again: recursion is not allowed). Each parameter occupies one line. Example:
FILELIST=filelist.txt SUBJECTLAYOUT=layout_s.htm LITERALLAYOUT=layout_l.htm LANGUAGE=English.ssl HELPFILE=help.htm SITEROOTURL=http://www.mycompany.com WORKDIR=workdir\ ALLOWSITEMAP=NO |
It is not usually necessary to include such parameters as QUOTES or ACTION because they are primarily selected by site visitors. However, if you have simplified the Search Query form and some of the options are not now selectable by users, the default values for them may be set in the configuration file. For example: the statement METHOD=FUZZY in the configuration file instructs SSServer to use the Subject Search Method.
The default value for the CONFIG parameter is not defined, e.g.
SSServer does not look for or read configuration files automatically.
This means that in order to reassign the default values for query string
parameters, your search query form should contain a reference to the
configuration file; this reference should be present as the very first and
invisible statement in the search query form. For example:
<INPUT TYPE="HIDDEN" NAME="CONFIG" VALUE="ssserver.ini">
Basically, configuration file is used to define search string parameters that are common to all queries and cannot be changed by site visitors. For example, if a number of pages on your server are in Latin, and you want your visitors to be able to search in this language, the configuration file for the corresponding Search in Latin form should contain the statement: "LANGUAGE=Latin.ssl". Apart from assigning the defaults, you may use configuration files to prevent visitors from obtaining your site map. Just include the statement "ALLOWSITEMAP=No" in it.
The SUBJECTLAYOUT parameter affects the layout of those reports only, which are built when the user selects Subject Search; for building reports when the Literal Search method is selected, SSServer uses the LITERALLAYOUT parameter, and for displaying Site Maps used is SITEMAPLAYOUT. When SSServer finishes processing a query and needs to display the resulting report, it first reads the layout file whose name is specified by the corresponding parameter. It is supposed that the layout file contains a number of macro instructions, which SSServer finds out, "understands", and replaces with its findings. Finally, SSServer passes the resulting report file onto the user. So, the layout files are used as report templates and therefore, they should be correct HTML files with all required HTML tags, such as <HTML> and <BODY>. The default values for SUBJECTLAYOUT, LITERALLAYOUT, SITEMAPLAYOUT are layout_s.htm, layout_l.htm, and sitemap.htm, respectively. The file path of these files is relative to the ssserverdata subdirectory of the directory in which SSServer has been installed.
Note: the Header, Footer, and the Template options, which were originally implemented in SSServer 1.0, are now obsolete: the implementation of layout files gives much more flexibility to make SSServer reports fit into the overall design of your site.
In the examples below macro instructions are painted in blue; follow this link to obtain the full list of macro instructions
that SSServer supports.Example file ssserverdata/layout_s.htm:
<html> <head> <title>SSServer(TM) Search Results</title> <!-- the STYLE tag below is placed here to minimize space occupied by quotations; you may remove it if it does not match the style that you use in other documents on your site. --> <STYLE TYPE="TEXT/CSS"><!-- H1,H2,H3 {font-size:14pt; margin:0pt} H4,H5,H6,P {margin:0pt} UL,OL,DL {margin-top:0pt; margin-bottom:0pt} --></STYLE> <!-- the STYLE tag below controls the colors of the actual phrases matched --> <STYLE TYPE="TEXT/CSS"><!-- FONT.highlight {color:#FF0000; background:#FFFFCC} --></STYLE> </head> <body BGCOLOR="#FFFFFF" LINK="#0000FF" ALINK="#FF0000" VLINK="#990099" TOPMARGIN=2 LEFTMARGIN=4 MARGINHEIGHT=2 MARGINWIDTH=4> <TABLE WIDTH="100%" BORDER=0 CELLSPACING=0 CELLPADDING=0><TR><TD BGCOLOR="#336699"> <TABLE WIDTH="100%" BORDER=0 CELLSPACING=1 CELLPADDING=2> <TR><TD BGCOLOR="#FFFFCC">SSServer search results for: <FONT COLOR="0000FF"><B>%SearchPhrase%</B></FONT> <BR>Processed: <B>%NumFiles%</B> files in %Language% and selected <B>%NumQuotes%</B> quotations which exceeded the <B>%MinRelevancy%</B> relevancy.<BR> The actual phrases matched are <FONT COLOR="#FF0000" CLASS="highlight">shown in red</FONT> below.</TD></TR> <TR> <TD BGCOLOR="#FFFFCC"> <TABLE WIDTH="100%" CELLSPACING=2 CELLPADDING=0 BORDER=0> <TR> <TD COLSPAN="3" ALIGN="CENTER"><FONT SIZE="-1">SSServer is a trademark of <A HREF="http://www.kryltech.com">Kryloff Technologies, Inc.</A></FONT></TD> <TD ALIGN="RIGHT" VALIGN="BOTTOM"><FONT SIZE="-1">%SearchDate%</FONT></TD> </TR> </TABLE> </TD> </TR> </TABLE> </TD></TR></TABLE><BR> %QuoteBegin% <TABLE WIDTH="100%" BORDER=0 CELLSPACING=0 CELLPADDING=0><TR><TD BGCOLOR="#336699"> <TABLE WIDTH="100%" BORDER=0 CELLSPACING=1 CELLPADDING=2><TR><TD> <FONT COLOR="#FFFFFF"><B>%QuoteOrder%.</B></FONT></TD> <TD BGCOLOR="#AADDFF" WIDTH="100%"><B>%QuoteTitle%</B></TD><TD> <FONT COLOR="#FFFFFF">Relevancy <B>%QuoteRelevancy%%</B></FONT></TD></TR></TABLE> </TD></TR></TABLE> %QuoteText% %QuoteEnd% <!-- New Search form --> <table width=100% border=0 cellpadding=0 cellspacing=0> <tr> <td><font size=0> <font></td> </tr> <tr> <td bgcolor="#336699"> <table width=100% border=0 cellpadding=2 cellspacing=1> <tr> <td align="center"> <font face="Verdana,Arial,Helvetica" color="#ffffff"><b>New Search</b></font> </td> </tr> <tr> <td bgcolor="#ffffcc"> <table width=100% border=0 cellpadding=6 cellspacing=0> <tr> <form action="ssserver" method="POST"> <td align="center" nowrap> <input type="hidden" name="config" value="ssserver.ini"> <table border=0> <TR><TD> Search for: </TD><TD><INPUT TYPE="TEXT" NAME="QUERY" SIZE="60" MAXLENGTH="255" VALUE=""></TD> </TR><TR><TD> Report to you with: </TD><TD> <SELECT NAME="QUOTES"> <OPTION>10 <OPTION SELECTED>25 <OPTION>50 <OPTION>100 <OPTION>250 <OPTION>500 <OPTION>1000 </SELECT> selections from the most relevant pages </TD></TR><TR><TD> Display selections as: </TD><TD> <SELECT NAME="REPORTWITH"> <OPTION VALUE="Q" SELECTED>Quotations from original pages <OPTION VALUE="B">Beginning of each page found <OPTION VALUE="DQ">Page summary or quotations <OPTION VALUE="DB">Page summary or beginning </SELECT> </TD></TR><TR><TD> Each selection contains: </TD><TD> <SELECT NAME="QUOTESIZE"> <OPTION>100 <OPTION>500 <OPTION SELECTED>1000 <OPTION>2500 <OPTION>5000 </SELECT> characters </TD></TR><TR><TD> Extract no more than: </TD><TD> <SELECT NAME="QUOTESPERDOC"> <OPTION>1 <OPTION>2 <OPTION>3 <OPTION>4 <OPTION SELECTED>5 <OPTION>6 <OPTION>7 <OPTION>8 <OPTION>9 <OPTION>10 <OPTION>11 <OPTION>12 <OPTION>13 <OPTION>14 <OPTION>15 </SELECT> quotations per a page </TD></TR><TR><TD> </TD><TD> <INPUT TYPE="CHECKBOX" NAME="PLAINTEXT" VALUE="YES">Show plain text only in each selection </TD></TR><TR><TD COLSPAN="2"><HR></TD></TR><TR><TD> Apply search method </TD><TD><INPUT TYPE="RADIO" NAME="METHOD" VALUE="FUZZY" CHECKED> Subject Search (smart fuzzy) with <SELECT NAME="RELEVANCY"> <OPTION>10 <OPTION>20 <OPTION>30 <OPTION SELECTED>40 <OPTION>50 <OPTION>60 <OPTION>70 <OPTION>80 <OPTION>90 <OPTION>100 </SELECT> % of relevancy <HR> <INPUT TYPE="RADIO" NAME="METHOD" VALUE="EXACT">Literal Search (exact) <SELECT NAME="TERMS"> <OPTION VALUE="ANY">for any term <OPTION VALUE="ALL" SELECTED>for all terms <OPTION VALUE="PHRASE">as a phrase </SELECT> <SELECT NAME="CASE"> <OPTION VALUE="INSENSITIVE" SELECTED>case insensitive <OPTION VALUE="SENSITIVE">case sensitive </SELECT> </TD> </tr><tr><td colspan=2> <table width=100% cellspacing=3 cellpadding=0><tr><td align="left"> <INPUT TYPE="SUBMIT" NAME="SEARCH" VALUE="Search"></td><td align="center"> <INPUT TYPE="SUBMIT" NAME="HELP" VALUE="Help"></td><td align="right"> <INPUT TYPE="SUBMIT" NAME="SITEMAP" VALUE="Site Map"></td></tr></table> </td></tr></table> </td> </form> </tr> </table> </td> </tr> </table> </td> </tr> <tr> <td><font size=0> <font></td> </tr> </table> <TABLE WIDTH="100%" BORDER=0 CELLSPACING=0 CELLPADDING=0><TR><TD BGCOLOR="#336699"> <TABLE WIDTH="100%" BORDER=0 CELLSPACING=1 CELLPADDING=2><TR> <TD ALIGN="CENTER" BGCOLOR="#FFFFCC"><FONT SIZE="-1"> The search results have been provided by %KryloffLink%</FONT></TD></TR> </TABLE></TD></TR></TABLE> </body> </html> |
Example file ssserverdata/layout_l.htm:
<html> <head> <title>SSServer(TM) Search Results</title> <!-- the STYLE tag below is placed here to minimize space occupied by quotations; you may remove it if it does not match the style that you use in other documents on your site. --> <STYLE TYPE="TEXT/CSS"><!-- H1,H2,H3 {font-size:14pt; margin:0pt} H4,H5,H6,P {margin:0pt} UL,OL,DL {margin-top:0pt; margin-bottom:0pt} --></STYLE> <!-- the STYLE tag below controls the colors of the actual phrases matched --> <STYLE TYPE="TEXT/CSS"><!-- FONT.highlight {color:#FF0000; background:#FFFFCC} --></STYLE> </head> <body BGCOLOR="#FFFFFF" LINK="#0000FF" ALINK="#FF0000" VLINK="#990099" TOPMARGIN=2 LEFTMARGIN=4 MARGINHEIGHT=2 MARGINWIDTH=4> <TABLE WIDTH="100%" BORDER=0 CELLSPACING=0 CELLPADDING=0><TR><TD BGCOLOR="#336699"> <TABLE WIDTH="100%" BORDER=0 CELLSPACING=1 CELLPADDING=2> <TR><TD BGCOLOR="#FFFFCC">SSServer search results for: <FONT COLOR="0000FF"><B>%SearchPhrase%</B></FONT> <BR>Scanned: <B>%NumFiles%</B> files in %Language% and selected <B>%NumQuotes%</B> files of <B>%QueryQuotes% </B> requested.<BR> The search conditions are: <B>Literal</B> search; <B>%TermsAsString%</B>; <B>%CaseAsString%</B>.<BR> The first occurrences of the search terms are <FONT COLOR="#FF0000" CLASS="highlight">shown in red</FONT> below.</TD></TR> <TR> <TD BGCOLOR="#FFFFCC"> <TABLE WIDTH="100%" CELLSPACING=2 CELLPADDING=0 BORDER=0> <TR> <TD COLSPAN="3" ALIGN="CENTER"><FONT SIZE="-1">SSServer is a trademark of <A HREF="http://www.kryltech.com">Kryloff Technologies, Inc.</A></FONT></TD> <TD ALIGN="RIGHT" VALIGN="BOTTOM"><FONT SIZE="-1">%SearchDate%</FONT></TD> </TR> </TABLE> </TD> </TR> </TABLE> </TD></TR></TABLE><BR> %QuoteBegin% <TABLE WIDTH="100%" BORDER=0 CELLSPACING=0 CELLPADDING=0><TR><TD BGCOLOR="#336699"> <TABLE WIDTH="100%" BORDER=0 CELLSPACING=1 CELLPADDING=2><TR><TD> <FONT COLOR="#FFFFFF"><B>%QuoteOrder%.</B></FONT></TD> <TD BGCOLOR="#AADDFF" WIDTH="100%"><B>%QuoteTitle%</B></TD></TR></TABLE> </TD></TR></TABLE> %QuoteText% %QuoteEnd% <!-- New Search form --> <table width=100% border=0 cellpadding=0 cellspacing=0> <tr> <td><font size=0> <font></td> </tr> <tr> <td bgcolor="#336699"> <table width=100% border=0 cellpadding=2 cellspacing=1> <tr> <td align="center"> <font face="Verdana,Arial,Helvetica" color="#ffffff"><b>New Search</b></font> </td> </tr> <tr> <td bgcolor="#ffffcc"> <table width=100% border=0 cellpadding=6 cellspacing=0> <tr> <form action="ssserver" method="POST"> <td align="center" nowrap> <input type="hidden" name="config" value="ssserver.ini"> <table border=0> <TR><TD> Search for: </TD><TD><INPUT TYPE="TEXT" NAME="QUERY" SIZE="60" MAXLENGTH="255" VALUE=""></TD> </TR><TR><TD> Report to you with: </TD><TD> <SELECT NAME="QUOTES"> <OPTION>10 <OPTION SELECTED>25 <OPTION>50 <OPTION>100 <OPTION>250 <OPTION>500 <OPTION>1000 </SELECT> selections from the most relevant pages </TD></TR><TR><TD> Display selections as: </TD><TD> <SELECT NAME="REPORTWITH"> <OPTION VALUE="Q" SELECTED>Quotations from original pages <OPTION VALUE="B">Beginning of each page found <OPTION VALUE="DQ">Page summary or quotations <OPTION VALUE="DB">Page summary or beginning </SELECT> </TD></TR><TR><TD> Each selection contains: </TD><TD> <SELECT NAME="QUOTESIZE"> <OPTION>100 <OPTION>500 <OPTION SELECTED>1000 <OPTION>2500 <OPTION>5000 </SELECT> characters </TD></TR><TR><TD> Extract no more than: </TD><TD> <SELECT NAME="QUOTESPERDOC"> <OPTION>1 <OPTION>2 <OPTION>3 <OPTION>4 <OPTION SELECTED>5 <OPTION>6 <OPTION>7 <OPTION>8 <OPTION>9 <OPTION>10 <OPTION>11 <OPTION>12 <OPTION>13 <OPTION>14 <OPTION>15 </SELECT> quotations per a page </TD></TR><TR><TD> </TD><TD> <INPUT TYPE="CHECKBOX" NAME="PLAINTEXT" VALUE="YES">Show plain text only in each selection </TD></TR><TR><TD COLSPAN="2"><HR></TD></TR><TR><TD> Apply search method </TD><TD><INPUT TYPE="RADIO" NAME="METHOD" VALUE="FUZZY">Subject Search (smart fuzzy) with <SELECT NAME="RELEVANCY"> <OPTION>10 <OPTION>20 <OPTION>30 <OPTION SELECTED>40 <OPTION>50 <OPTION>60 <OPTION>70 <OPTION>80 <OPTION>90 <OPTION>100 </SELECT> % of relevancy <HR> <INPUT TYPE="RADIO" NAME="METHOD" VALUE="EXACT" CHECKED>Literal Search (exact) <SELECT NAME="TERMS"> <OPTION VALUE="ANY">for any term <OPTION VALUE="ALL" SELECTED>for all terms <OPTION VALUE="PHRASE">as a phrase </SELECT> <SELECT NAME="CASE"> <OPTION VALUE="INSENSITIVE" SELECTED>case insensitive <OPTION VALUE="SENSITIVE">case sensitive </SELECT> </TD> </tr><tr><td colspan=2> <table width=100% cellspacing=3 cellpadding=0><tr><td align="left"> <INPUT TYPE="SUBMIT" NAME="SEARCH" VALUE="Search"></td><td align="center"> <INPUT TYPE="SUBMIT" NAME="HELP" VALUE="Help"></td><td align="right"> <INPUT TYPE="SUBMIT" NAME="SITEMAP" VALUE="Site Map"></td></tr></table> </td></tr></table> </td> </form> </tr> </table> </td> </tr> </table> </td> </tr> <tr> <td><font size=0> <font></td> </tr> </table> <TABLE WIDTH="100%" BORDER=0 CELLSPACING=0 CELLPADDING=0><TR><TD BGCOLOR="#336699"> <TABLE WIDTH="100%" BORDER=0 CELLSPACING=1 CELLPADDING=2><TR> <TD ALIGN="CENTER" BGCOLOR="#FFFFCC"><FONT SIZE="-1"> The search results have been provided by %KryloffLink%</FONT></TD></TR> </TABLE></TD></TR></TABLE> </body> </html> |
Example file ssserverdata/sitemap.htm:
<HTML> <HEAD> <TITLE>SSServer(TM) Report - Map of %QuerySiteRootURL%</TITLE> </HEAD> <BODY BGCOLOR="#FFFFFF" LINK="#0000FF" ALINK="#FF0000" VLINK="#990099" TOPMARGIN=2 LEFTMARGIN=4 MARGINHEIGHT=2> <TABLE WIDTH="100%" BORDER=0 CELLSPACING=0 CELLPADDING=0><TR><TD BGCOLOR="#336699"> <TABLE WIDTH="100%" BORDER=0 CELLSPACING=1 CELLPADDING=2> <TR><TD BGCOLOR="#FFFFCC"><B><CENTER> Site map of %QuerySiteRootURL% provided by SSServer</CENTER></B></TD></TR> <TR><TD BGCOLOR="#FFFFCC"><TABLE WIDTH="100%" CELLSPACING=2 CELLPADDING=0 BORDER=0> <TR><TD WIDTH="70%" ALIGN="CENTER"><FONT SIZE=-1><B>SSServer</B> is a trademark of <A HREF="http://www.kryltech.com">Kryloff Technologies, Inc.</A></FONT></TD> <TD ALIGN="RIGHT" VALIGN="BOTTOM">%SearchDate%</TD></TR></TABLE> </TD></TR></TABLE></TD></TR></TABLE> <!-- Variable v4 shows if browser supports expandable site maps --> <SCRIPT LANGUAGE="JavaScript1.2"><!-- if(v4)document.write('<TABLE WIDTH=100% BORDER=0> <FORM><TR><TD WIDTH=50% ALIGN="center"> <INPUT TYPE="BUTTON" VALUE="Expand All Branches" onClick="showAll(document,false);arrange()"></TD> <TD ALIGN="center"><INPUT TYPE="BUTTON" VALUE="Collapse All Branches" onClick="hideAll(document,0);arrange()"></TD></TR></FORM></TABLE>');//--> </SCRIPT> %SiteMap% <BR><TABLE WIDTH="100%" BORDER=0 CELLSPACING=0 CELLPADDING=0> <TR><TD BGCOLOR="#336699"><TABLE WIDTH="100%" BORDER=0 CELLSPACING=1 CELLPADDING=2> <TR><TD ALIGN="CENTER" BGCOLOR="#FFFFCC"><FONT SIZE=-1>The search results are provided by %KryloffLink%</FONT> </TD></TR></TABLE> </TD></TR></TABLE> </BODY> </HTML> |
When SSServer builds a report, it first scans the corresponding layout file and substitutes the actual query parameters for all macro instructions in the layout file, then the resulting file is passed onto the user. It is not obligatory to include all the macros in each layout file. For example, if you do not want your visitors to know how many pages are stored on your Web server, edit your layout files and remove the macro instruction %NumFiles%.
%SearchPhrase% stands for the user search query;
%NumFiles% specifies the total number of pages accessed while executing a query;
%Language% specifies the language of the user search phrase;
%NumQuotes% specifies the number of quotations found by SSServer
and included into the final report (Subject Search method) or
the number of pages selected during the search (Literal Search);
%MinRelevancy% is the minimum percentage of relevancy
specified by user or set in the configuration file (relevant to
the Subject Search only);
%SearchDate% specifies the current date;
%QuoteBegin% is a special macros. It points out a
position in the report file where SSServer should place
its selections (quotations, page descriptions or headers). The %QuoteBegin% macros must
be paired with %QuoteEnd% in each layout file where
it is present;
the sector of the layout file between %QuoteBegin% and
%QuoteEnd% is scanned for macro instructions for each
selection found by SSServer;
%QuoteOrder% is the number of a hit included into
the final report;
%QuoteTitle% specifies the title of the page selected
by SSServer;
%QuoteRelevancy% specifies the percentage of relevancy
that SSServer assigns to a given quotation (relevant to
the Subject Search method only);
%QuoteText% stands for the text of SSServer's selection,
e.g. a quotation, page description or its beginning;
%QuoteEnd% is a special macro instruction to be used
only with %QuoteBegin%. A pair of these macros specify
the sector of the report file where SSServer should place its
selections;
%TermsAsString% is only relevant when the user selects
Literal Search.
It can be either "for any term", "for all terms"
or "as a phrase";
%CaseAsString% is only relevant when the user selects
Literal Search. Can be either "case sensitive"
or "case insensitive";
%QueryQuotes% is replaced with the value of the
Quotes parameter;
%QueryQuoteSize% is replaced with the value of the
QuoteSize parameter;
%QueryQuotesPerDoc% is replaced with the value of the
QuotesPerDoc parameter;
%QueryMethod% is either "FUZZY" or "EXACT" depending
on the search method being used;
%QueryRelevancy% specifies the value of the
Relevancy parameter;
%QueryTerms% is relevant to literal searches only; can be either
"ANY", "ALL", or "PHRASE";
%QueryCase% is relevant to literal searches only; it is either
"SENSITIVE" or "INSENSITIVE";
%QueryLanguage% specifies the value of the
Language parameter;
%QueryFilelist% specifies the value of the
Filelist parameter. As a rule,
you should use this macros only for debugging;
%QuerySubjectLayout% is replaced with the
SubjectLayout parameter.
Implemented to help you debug and fine-tune your copy of
SSServer;
%QueryLiteralLayout% specifies the value of the
LiteralLayout parameter. To be
used for debugging purposes only;
%QuerySiteRootURL% is the value of
the SiteRootURL parameter;
%QueryWorkdir% stands for the value of the
Workdir parameter. You may use it
while tuning your copy of SSServer;
%QueryConfig% stands for the Config parameter,
use it to customize SSServer reports to your requirements;
%QueryReportWith% is the value of the ReportWith
parameter;
%QueryPlainText% specifies the value of the
PlainText parameter;
%SiteMap%; this macro instruction is replaced with the
actual map of your site which is presented as a tree.
This macro instruction can be used only in the template file
which name is specified by the
SITEMAPLAYOUT parameter;
%KryloffLink% is replaced with a link to
Kryloff
Technologies' Web site as follows:
"<!--*--><A HREF="http://www.kryltech.com/">Kryloff
Technologies, Inc.</A><!--*-->".
According to our License Agreement, you are obliged to include
a link to Kryloff Technologies to your search form and all
reports that SSServer produces.
Important: Your visitors should enter questions in the language of your
Web site documents and also in the same encoding if your language
allows using different coding tables. You should keep in mind that SSServer
does not translate questions into English nor does it perform encoding of any
sort. If your Web page contains documents in more than one language, you may
create several search forms for each group as is described in the section
Frequently Asked Questions, question 11.
See also: Multi-language
support in Kryloff Technologies' products.
FILE=<local file name> URL=<Internet address of this file> or DIR=<name of a local directory> URL=<Internet address of this directory> or TREE=<name of a local directory> URL=<Internet address of this directory>
Each pair points out a local file or a directory on your Web server and a URL that corresponds to the file or directory. The "FILE=" instruction instructs SSServer to process one file; The "DIR=" instruction causes processing all files in a given directory without subdirectories; finally, the "TREE=" instruction makes SSServer recursively process all files in a given directory including all subdirectories.
Example file filelist.txt:
Dir=/usr/local/www/data URL=http://www.kryltech.com/ Tree=/usr/local/www/data/download URL=http://www.kryltech.com/download/ File=/usr/local/www/data/samples/getid.htm URL=http://www.kryltech.com/samples/getid.htm |
While executing the instructions "Dir=" or "Tree=", SSServer appends local file names to their directory's Internet address (URL) to obtain the URL's of each file within the directory. Duplicated files are being removed, e.g. SSServer does not process the same file twice or more even if the corresponding file list directly or indirectly specifies the same file many times.
See also: The options FILEEXTENSIONS and EXCLUDEFILEEXTENSIONS.
See also: The parameter EXCLUDEFILEEXTENSIONS
See also: The parameter FILEEXTENSIONS
For example, when ssserver detects the "SEARCH=something" substring in the query string, it searches for data.
SSServer supports two types of searches: Subject Search and Literal Search. Developed by Kryloff Technologies, Inc., the Subject Search method is the intelligent and the most powerful way of information retrieval. The core Subject Search technique is also used in the rest of Kryloff Technologies' products known as Subject Search Suite. This method accepts natural language enquiries and is used by default, so it is unlikely that you would need to change it.
In addition to Subject Search, SSServer supports the traditional Literal Search approach. Visitors can use this method while looking for digits, number, names, etc. Using this method, SSServer extracts quotations "as is". Unlike to the Subject Search approach, if a user is looking for "John Griffiths" on your pages, Literal Search method does not select "Jon Griffit". This feature can be also quite useful in a number of cases, so it is recommended that you allow visitors to use both search methods: do not remove the corresponding radio-buttons from the search query form unless your documents do not have enough space.
The REPORTWITH parameter affects the type of SSServer selections
regardless of the search method: it is
applicable to the Subject Search as well as to the Literal Search methods.
The default value for this option is not defined.
Two additional options, SUBJECTREPORTWITH and LITERALREPORTWITH
have been implemented to allow you differentiate the type of SSServer
selections for a particular search method. Thus, the SUBJECTREPORTWITH
parameter affects those reports only that are built using the Subject Search
method; LITERALREPORTWITH instructs SSServer to display a particular
sort of selections when it performs literal searches. By default,
SUBJECTREPORTWITH=Q and LITERALREPORTWITH=DQ, e.g. SSServer
quotes documents while applying the Subject Search method, and displays
page descriptions when Literal Search is selected.
It is recommended that you include the options SUBJECTREPORTWITH and LITERALREPORTWITH into SSServer's configuration file; the option REPORTWITH can be used by your site visitors as it is shown in the example Search Form above (see the "Display selections as" field).
Afrikaans Arabic (Windows encoding) Bulgarian Catalan Chinese (Traditional Big5 encoding) Chinese (Simplified GB2312 encoding) Czech Danish Dutch (standard and Belgian) English (all dialects) Estonian Finnish French (all dialects) German (all dialects) Greek (standard) Greek (Latin encoding) Hebrew Hungarian Icelandic Indonesian Irish Italian (standard and Swiss) Japanese (Shift-JIS encoding) Japanese (EUC encoding) Korean (EUC encoding) Latin Latvian Lithuanian Norwegian (Bokmal and Nynorsk) Polish Portuguese (standard and Brazilian) Romanian Russian (Windows encoding) Russian (KOI-8 encoding) Slovak Spanish (all dialects) Swedish Turkish |
Since Kryloff Technologies is constantly improving its Muli-Language Support, it is recommended that you visit our Muli-Language Support Page to obtain additional languages dictionaries if your language is not yet listed above.
Even in the case when your Web site is hosted on a remote computer and you do not have permission to add the package to the system, you can still properly install and use SSServer. Obviously, the best and the easiest way is to ask your Web administrator to do it. But, if you have remote access to your Web server (typically, via FTP), you can do it yourself! Just extract the original SSServer archive into a temporary directory on your "home" PC, which may be running any operating system.
Then locate SSServer files in the www/cgi-bin subdirectory and upload them to your Web server (including the ssserverdata subdirectory). Make sure that the Web server application can execute files from the directory in which you have uploaded the SSServer files. Upon completing these steps, you may use your web browser to run SSServer configuration utility sssconf located in the ssserverdata subdirectory. Finally, when configuring SSServer is finished, your visitors will be able to use the search form and search your site!
SSServer v1.1 is able to search files written in Hyper-Text Markup language as well as standard ASCII text files. File names do not obligatory have to end up with ".HTM", ".HTML" or ".TXT" extension: the application automatically detects the type of each file it processes.
Despite the fact that SSServer does not internally support other file types, you may still make it process files written under ANY data storage format such as Rich Text Format (.RTF), Portable Data Format (.PDF), etc. For each "external" file you may create a corresponding text file containing just the textual information of the original one. Then, edit the SSServer File List (usually, it is the file ssserverdata\filelist.txt), and replace the local "external" file name with the name of its textual copy. After these changes, SSServer will search for queries in text files while supply its findings with the references to the original ones!
Example: say your Web site contains the file ExternalFile.RTF in Rich Text Format and you want SSServer to search in it as well. Do the following:
... FILE=ExternalFile.RTF URL=http://www.mysiteurl.com/ExternalFile.RTF ... |
... FILE=ExternalFile.TXT URL=http://www.mysiteurl.com/ExternalFile.RTF ... |
This "trick" makes SSServer search the file ExternalFile.TXT and extract quotations from it but then include the link to the original file http://www.mysiteurl.com/ExternalFile.RTF in the resulting reports!
To create text files, you may use our GetText utility available for free downloading at http://www.kryltech.com/freestf.htm
SSServer functions under the following environment:
Windows version:
Linux version:
FreeBSD version:
All versions:
SSServer automatically builds file indexes (or deletes them if required) in its working directory. If some of your documents have been modified, SSServer automatically rebuilds the corresponding index files. The only case you should be careful of is the situation when you delete documents from your Web server. If, having deleted some document, you do not also delete the corresponding "FILE=" statement in the file list, SSServer starts generating a warning message "Error reading file XXX" in each report.
Important: To prevent your visitors from seeing error messages, it is strongly recommended that you issue at least one query right after deleting any files or modifying SSServer configuration files (filelist.txt, ssserver.ini or template.txt). If you do not see any error messages in the report, all changes have been done correctly and your visitors will not see any error or warning messages either. See also: The WARNINGS option.
If you issue a query for the very first time, it may take a while as
none of your documents have been indexed yet. All subsequent searches are
done much faster. Index files occupy approximately as much space as the
original documents, so make sure that there is enough disk space
on the drive in which SSServer keeps temporary files.
See also: The WORKDIR option.
Other possible SSServer messages are described in section: Troubleshooting and Frequently Asked Questions: Instruction for Web Masters
Developer (manufacturer) is Kryloff Technologies, Inc.