0.5.2/doc/uguide-en.html

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">

<head>
<meta http-equiv="Content-Language" content="en" />
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta name="author" content="Mikio Hirabayashi" />
<meta name="keywords" content="Hyper Estraier, Estraier, full-text search, API" />
<meta name="description" content="User's Guide of Hyper Estraier" />
<link rel="contents" href="./" />
<link rel="alternate" href="uguide-ja.html" hreflang="ja" title="the Japanese version" />
<link rel="stylesheet" href="common.css" />
<link rel="icon" href="icon16.png" />
<link rev="made" href="mailto:mikio@users.sourceforge.net" />
<title>User's Guide of Hyper Estraier Version 1</title>
</head>

<body>

<h1>User's Guide</h1>

<div class="note">Copyright (C) 2004-2005 Mikio Hirabayashi</div>
<div class="note">Last Update: Tue, 07 Jun 2005 06:17:00 +0900</div>
<div class="navi">[<a href="uguide-ja.html" hreflang="ja">Japanese</a>] [<a href="index.html">HOME</a>]</div>

<hr />

<h2 id="tableofcontents">Table of Contents</h2>

<ol>
<li><a href="#introduction">Introduction</a></li>
<li><a href="#attributes">Attributes</a></li>
<li><a href="#formats">File Formats</a></li>
<li><a href="#searchcond">Search Conditions</a></li>
<li><a href="#estcmd">Administration Command</a></li>
<li><a href="#estseek">CGI Script for Search</a></li>
</ol>

<hr />

<h2 id="introduction">Introduction</h2>

<p>This document describes detail of how to use applications of Hyper Estraier.  If you have never read <a href="intro-en.html">the introduction document</a>, please read it beforehand.</p>

<p>Hyper Estraier is a full-text search system using index database.  So, before search, it is needed to prepare an index into which target documents have been registered.  Hyper Estraier provides the administration command `estcmd' and the CGI script `estsearch.cgi' for search.  The former is used in order to administrate the index by command line interface.  The latter is used in order to search the index for documents with a web browser.</p>

<p>estcmd can handle various file formats and features various operations to administrate index.  How to use it is described in this document.</p>

<p>Hyper Estraier supports such various methods for search as combining some search phrase and search with attributes of documents.  Moreover, it is possible to customize presentation according to the configuration of estseek.cgi.  How to do it is described in this document.</p>

<hr />

<h2 id="attributes">Attributes</h2>

<p>Not only information of the body text but also such attributes as the title, the modification date, and so on can be added to documents handled by Hyper Estraier.  Attributes are used for such various purposes as search with attributes and determination of difference updating.</p>

<h3>Attribute Name</h3>

<p>Any attribute has a name.  As the name can be determined arbitrarily, some names are reserved for being used as system attributes.  Names of system attributes begin with `@'.  There are the following system attributes.</p>

<ul>
<li><kbd>@id</kbd> : the ID number determined automatically when the document is registered.</li>
<li><kbd>@uri</kbd> : the location of a document which any document should have.</li>
<li><kbd>@cdate</kbd> : the creation date.</li>
<li><kbd>@mdate</kbd> : the modification date.</li>
<li><kbd>@title</kbd> : the title used as a headline in the search result.</li>
<li><kbd>@author</kbd> : the author.</li>
<li><kbd>@type</kbd> : the media type.</li>
<li><kbd>@lang</kbd> : the language.</li>
<li><kbd>@size</kbd> : the size.</li>
</ul>

<p>The other attributes except for system attributes are called user-defined attributes.  They can be defined by document draft said later.  Meta attributes in HTML and headers of MIME are also treated as user-defined attributes.</p>

<h3>Attribute Type</h3>

<p>There are two data types for attributes; string and number.  Data of the string type are arbitrary strings.  There are such operations as full matching, forward matching, backward matching, partial matching.  Data of the number type are numbers or date information.  A string of the number type is converted into the number and calculated according to the following formats.  If the format is for date, the value is computed based on the UNIX epoch (1 Jan 1970).</p>

<ul>
<li>If all characters are digits, it is computed as a decimal number.</li>
<li>If it begins with "0x", it is computed as a hexadecimal number.</li>
<li>If it conforms to W3CDTF (e.g. 1978-02-11T18:05:32+09:00), it is computed as a date.</li>
<li>If it conforms to RFC822 (e.g. Sat, 11 Feb 1978 18:05:32 +0900), it is computed as a date.</li>
<li>If it is in YYYY/MM/DD format (e.g. 1978/02/11 18:05:32), it is computed as a date.</li>
<li>Else, it is computed as -1.</li>
</ul>

<p>The data type is not determined when registration.  It is determined when search.  Length of the value of an attribute is not limited.</p>

<p>Attributes and the body text of a document should be expressed in UTF-8 encoding.  If another encoding is used, it should be converted into UTF-8.  By the way, estcmd detect the encoding automatically if it is not clearly specified.</p>

<p>estcmd defines the URI attribute begins with "file://" for each document.  However, if a document defines its own URI, it comes first.  The path on the local file system is defined as an attribute whose name is "_lpath".</p>

<hr />

<h2 id="formats">File Formats</h2>

<p>estcmd handles four file formats.  This section describes how the four are processed.</p>

<h3>Plain Text</h3>

<p>A document of plain-text is composed of strings with no structure.  By default, files whose names end with ".txt", ".text", or ".asc" are treated as plain-text.</p>

<ul>
<li>The character encoding is detected automatically.</li>
<li>"text/plain" is recorded as the "@type" attribute.</li>
<li>The file size is recorded as the "@size" attribute.</li>
</ul>

<h3>HTML</h3>

<p>As we all know, a document of HTML is used as a hyper-text on the Web.  By default, files whose names end with ".html", ".htm", "xhtml", or ".xht" are treated as HTML.</p>

<ul>
<li>The character encoding is detected automatically.  But, if the encoding is specified by a "meta" attribute, it comes first.</li>
<li>If there is a "title" attribute, its content is recorded as the "@title" attribute.</li>
<li>If the "name" attribute of a "meta" element specifies "author", the value of the "content" attribute is recorded as the "@author" element.</li>
<li>"text/html" is recorded as the "@type" attribute.</li>
<li>The file size is recorded as the "@size" attribute.</li>
<li>If the "name" or the "http-equiv" is specified in a "meta" element, the value of the "content" attribute is recorded as an attribute whose name is converted from the value of them into lower cases.</li>
<li>The value of the attribute "@title" is treated as a hidden text.</li>
</ul>

<h3>MIME (e-mail)</h3>

<p>MIME is used for communication by e-mail based on RFC822 and so on.  By default, files whose names end with ".eml", ".mime", "mht", or ".mhtml" are treated as HTML.</p>

<ul>
<li>The character encoding is detected automatically.  But, if the encoding is specified by the "Content-Type" header, it comes first.</li>
<li>If the "Subject" header is, the value is recorded as the "@title" attribute.</li>
<li>If the "From" header is, the value is recorded as the "@author" attribute.</li>
<li>If the "Date" header is, the value is recorded as the "@cdate" attribute and the "@mdate" attribute.</li>
<li>"message/rfc822" is recorded as the "@type" attribute.</li>
<li>The file size is recorded as the "@size" attribute.</li>
<li>The value of each header is recorded as an attribute whose name is converted from the header name into lower cases.</li>
<li>The value of the attribute "@title" is treated as a hidden text.</li>
</ul>

<p>If the content of each part of multipart is "text/plain", "text/html", or "message/rfc822", the content is treated as a part of the body text so that web archive can be supported.</p>

<h3>Document Draft</h3>

<p>Document draft is a original format of Hyper Estraier.  It is possible to handle various formats in the integrative way by using document draft as intermediate format.  By default, files whose names end with ".est" are treated as document draft.</p>

<p>Though format of document draft is similar to RFC822, detail points differ.  The delimiter for headers is not ":" but "=".  Moreover, no space character is needed after "=".  The following is an example data to handle a MIDI document.</p>

<pre>@uri=http://www.music-estraier.com/mididb/t/tw/twinkle.kar
@title=Twinkle Twinkle Little Star
@author=Jane Taylor
@cdate=2004-11-01T23:11:18+09:00
@mdate=2005-03-21T08:07:45+09:00
category=chorus,dance

Twinkle, twinkle, little star,
How I wonder what you are.
Up above the world so high,
Like a diamond in the sky.
Twinkle, twinkle, little star,
How I wonder what you are!
        Twinkle Twinkle Little Star
        Jane Taylor
</pre>

<p>The following specifications are required for document draft.</p>

<ul>
<li>It is composed of valid UTF-8 strings.</li>
<li>Line feeds are one of UNIX style (LF) or DOS style (CR+LF).</li>
<li>There are the attribute section and the text section and they are separated by the first empty line.</li>
<li>Each line in the attribute section specifies an attribute.  The name and the value is separated by the first "=".</li>
<li>Each line in the text section specifies a sentence of the body text.  If a line begins with a tab character, the line is treated as a hidden text.</li>
</ul>

<p>A hidden text is the same as normal text except not displayed in the snippet of the result.  It is useful to search with some attributes.</p>

<hr />

<h2 id="searchcond">Search Conditions</h2>

<p>Two kinds of search conditions are supported.  One is for full-text search and the other is for attribute search.  If both are specified at the same time, documents corresponding to the both are searched for.  Moreover, usual format and simplified format are supported for full-text search condition.</p>

<h3>Full-text Search Conditions</h3>

<p>The purpose of full-text search is to search for documents including some specified words.  For example, if you search for documents including a word "computer", specify "computer" in the search phrase as it is.</p>

<p>You can specify two or more words.  For example, if you specify "United Nations", documents including "united" followed by "nations" are searched for.  In case of simplified form, specify the following.</p>

<pre>"united nations"
</pre>

<p>Intersection operation is supported by the "AND" operator.  For example, if you specify "internet AND security", documents including both of "internet" and "security" are searched for.  In case of simplified form, specify the following.</p>

<pre>internet security
</pre>

<p>Difference operation is supported by the "ANDNOT" operator.  For example, if you specify "hacker ANDNOT cracker", documents including "hacker" but not including "cracker" are searched for.  In case of simplified form, specify the following.</p>

<pre>hacker ! cracker
</pre>

<p>Union operation is supported by the "OR" operator.  For example, if you specify "proxy OR firewall", documents including one or both of "proxy" and "firewall" are searched for.  In case of simplified form, specify the following.</p>

<pre>proxy | firewall
</pre>

<p>Note that the priority of "OR" is higher than ones of "AND" and "ANDNOT".  For example, if you specify "F1 OR F-1 OR Formula One AND Champion OR Victory", documents including one or both of "f1", "f-1", and "formula one", and including one or both of "champion" and "victory".  In case of simplified form, specify the following.</p>

<pre>F1 | F-1 | "Formula One" Champion | Victory
</pre>

<p>Search words are case insensitive.  However, operators are case sensitive.  If you want to search for documents including "AND", specify "and" instead.</p>

<h3>Attribute Search Conditions</h3>

<p>The purpose of attribute search is to search for documents whose attributes are corresponding to the specified expression.  An expression of attribute search is composed of an attribute name, an operator, and a value.  They are separated with space characters.  For example, if you specify "@title STRINC IMPORTANT", documents whose title includes "IMPORTANT".  The following operators for attribute search are supported.</p>

<ul>
<li>STREQ : is equal to the string</li>
<li>STRNE : is not equal to the string</li>
<li>STRINC : includes the string</li>
<li>STRBW : begins with the string</li>
<li>STREW : ends with the string</li>
<li>NUMEQ : is equal to the number</li>
<li>NUMNE : is not equal to the number</li>
<li>NUMLT : is less than the number</li>
<li>NUMLE : is less than or equal to the number or date</li>
<li>NUMGT : is greater than the number</li>
<li>NUMGE : is greater than or equal to the number or date</li>
</ul>

<p>If an operator is leaded by "!", the meaning is inverted.  If an operator is leaded by "I", case of the value is ignored.</p>

<h3>Order of the Result</h3>

<p>You can specify the order of the result by an expression.  An ordering expression is composed of an attribute name and an operator.  For example, if you specify "@size NUMA", documents in the result are in ascending order of the size.  The following operators for ordering are supported.</p>

<ul>
<li>STRA : ascending by string</li>
<li>STRD : descending by string</li>
<li>NUMA : ascending by number or date</li>
<li>NUMD : descending by number or date</li>
</ul>

<p>By default, the order of the result is descending by score.  The score is calculated by the number of specified words in each document.</p>

<hr />

<h2 id="estcmd">Administration Command</h2>

<p>This section describes specification of estcmd.  estcmd can do not only indexing but also search.</p>

<h3>Synopsis and Description</h3>

<p>estcmd is an aggregation of sub commands.  The name of a sub command is specified by the first argument.  Other arguments are parsed according to each sub command.  The argument <var>db</var> specifies the path of an index.</p>

<dl>
<dt><kbd>estcmd put [-cl] <var>db</var> [<var>file</var>]</kbd></dt>
<dd>Register a document of document draft to an index.</dd>
<dd><var>file</var> specifies a target file.  If it is omitted, the standard input is read.</dd>
<dd>If -cl is specifed, regions of a overwritten document are cleaned up.</dd>
</dl>

<dl>
<dt><kbd>estcmd out [-cl] <var>db</var> <var>expr</var></kbd></dt>
<dd>Remove information of a document from an index.</dd>
<dd><var>expr</var> specifies the ID number or the URI of a document.</dd>
<dd>If -cl is specifed, regions of the document are cleaned up.</dd>
</dl>

<dl>
<dt><kbd>estcmd get <var>db</var> <var>expr</var> [<var>attr</var>]</kbd></dt>
<dd>Output document draft of a document in an index.</dd>
<dd><var>expr</var> specifies the ID number or the URI of a document.</dd>
<dd>If <var>attr</var> is specified, only the value of the attribute is output.</dd>
</dl>

<dl>
<dt><kbd>estcmd list <var>db</var></kbd></dt>
<dd>Output a list of all document in an index.</dd>
</dl>

<dl>
<dt><kbd>estcmd uriid <var>db</var> <var>uri</var></kbd></dt>
<dd>Output the ID number of a document specified by URI.</dd>
<dd><var>uri</var> specifies the URI of a document.</dd>
</dl>

<dl>
<dt><kbd>estcmd meta <var>db</var> [<var>name</var> [<var>value</var>]]</kbd></dt>
<dd>Handle meta data.</dd>
<dd><var>name</var> specifies the name of a piece of meta data.  If it is omitted, a list of all names is output.</dd>
<dd><var>value</var> specifies the value of the meta data to be recorded.  If it is omitted, the current value is output.  If it is an empty string, the meta data is removed.</dd>
</dl>


<dl>
<dt><kbd>estcmd inform <var>db</var></kbd></dt>
<dd>Output the number of documents and the number of unique words in an index.</dd>
</dl>

<dl>
<dt><kbd>estcmd optimize [-onp] [-ond] <var>db</var></kbd></dt>
<dd>Optimize an index and clean up dispensable regions.</dd>
<dd>If -onp is specified, it is omitted to clean up dispensable regions.</dd>
<dd>If -ond is specified, it is omitted to optimize the database files.</dd>
</dl>

<dl>
<dt><kbd>estcmd search [-ic <var>enc</var>] [-vu|-va|-vf|-vs|-vh|-vx|-dd] [-gs|-gf|-ga] [-ni] [-sf] [-hs] [-attr <var>expr</var>] [-ord <var>expr</var>] [-max <var>num</var>] [-sim <var>id</var>] <var>db</var> [<var>phrase</var>]</kbd></dt>
<dd>Search an index for documents.</dd>
<dd><var>phrase</var> specifies the search phrase.</dd>
<dd>-ic specifies the input encoding.  By default, it is UTF-8.</dd>
<dd>If -vu is specified, TSV of ID number and URI are output.</dd>
<dd>If -va is specified, multipart format including attributes is output.</dd>
<dd>If -vf is specified, multipart format including document draft is output.</dd>
<dd>If -vs is specified, multipart format including attributes and snippets is output.</dd>
<dd>If -vh is specified, human readable format including attributes and snippets is output.</dd>
<dd>If -vx is specified, XML including including attributes and snippets is output.</dd>
<dd>If -dd is specified, document draft data are dumped and saved into separated files.</dd>
<dd>If -gs is specified, every key of N-gram is checked.  By default, it is alternately.</dd>
<dd>If -gf is specified, keys of N-gram are checked every three.</dd>
<dd>If -ga is specified, keys of N-gram are checked every four.</dd>
<dd>If -ni is specified, TF-IDF tuning is omitted.</dd>
<dd>If -sf is specified, the phrase is treated as a simplefied form.</dd>
<dd>If -hs is specified, score information is output as a hint.</dd>
<dd>-attr specifies an attribute search condition.  This option can be specified multiple times.</dd>
<dd>-ord specifies the order expression.  By default, it is descending by score.</dd>
<dd>-max specifies the maximum number of shown documents.  Negative means unlimited.  By default, it is 10.</dd>
<dd>-sim specifies the ID number of the seed document for similarity search.</dd>
</dl>

<dl>
<dt><kbd>estcmd gather [-cl] [-fe|-ft|-fh|-fm] [-fx <var>sufs</var> <var>cmd</var>] [-fz] [-fo] [-ic <var>enc</var>] [-il <var>lang</var>] [-pc <var>enc</var>] [-pf] [-apn] [-sd] [-cm] [-cs <var>num</var>] <var>db</var> [<var>file</var>|<var>dir</var>]</kbd></dt>
<dd>Scan the local file system and register documents into an index.</dd>
<dd>If the third argument is the name of a file, a list of paths of target documents are read from it.  If it is "-", the standard input is specified.</dd>
<dd>If the third argument is the name of a directory.  All files under the directory are treated as target documents.</dd>
<dd>If -cl is specified, regions of overwritten documents are cleaned up.</dd>
<dd>If -fe is specified, target files are treated as document draft.  By default, the format is detected by the suffix of each document.</dd>
<dd>If -ft is specified, target files are treated as plain text.</dd>
<dd>If -fh is specified, target files are treated as HTML.</dd>
<dd>If -fm is specified, target files are treated as MIME.</dd>
<dd>If -fx is specified, target files with the specified suffixes are processed by the specified outer command.  If the command is leaded by "T@", the output of the command is treated as plain text.  If the command is leaded by "H@", the output of the command is treated as HTML.  If the command is leaded by "M@", the output of the command is treated as MIME.  Else, the output is treated as document draft.  This option can be specified multiple times.</dd>
<dd>If -fz is specified, documents which do not corresponding to the condition of -fx are ignored.</dd>
<dd>If -fo is specifies, target files are not read.</dd>
<dd>-ic specifies the input encoding.  By default, it is detected automatically.</dd>
<dd>-il specifies the preferred input language.  By default, English is preferred.</dd>
<dd>-pc specifies the encoding of file paths.  By default, it is ISO-8859-1.</dd>
<dd>If -pf is specified, the full path is recorded as an attribute instead of the file name.</dd>
<dd>If -apn is specified, N-gram analysis is performed against Europian text also.</dd>
<dd>If -sd is specified, the creation date and the modification date of each file is recorded as attributes.</dd>
<dd>If -cm is specified, documents whose modification date has never changed are ignored.</dd>
<dd>-cs specifies the size of cache memory by mega bytes.  By default, it is 64Mb.</dd>
</dl>

<dl>
<dt><kbd>estcmd purge [-cl] [-fc] <var>db</var> [<var>prefix</var>]</kbd></dt>
<dd>Purge information of documents which do not exist on the file system.</dd>
<dd>If <var>prefix</var> is specified, only documents whose URIs are begins with it.</dd>
<dd>If -cl is specified, regions of the deleted documents are cleaned up.</dd>
<dd>If -fc is specified, information of all target documents are deleted.</dd>
</dl>

<dl>
<dt><kbd>estcmd extkeys [-fc] [-ni] [-kn <var>num</var>] <var>db</var> [<var>prefix</var>]</kbd></dt>
<dd>Create a database of keywords extracted from documents.</dd>
<dd>If <var>prefix</var> is specified, only documents whose URIs are begins with it.</dd>
<dd>If -fc is specified, all target documents are processed whichever they have existing records or not.</dd>
<dd>If -ni is specified, TF-IDF tuning is omitted.</dd>
<dd>-kn specifies the number of keywords to be extracted.</dd>
</dl>

<dl>
<dt><kbd>estcmd draft [-ft|-fh|-fm] [-ic <var>enc</var>] [-il <var>lang</var>] [<var>file</var>]</kbd></dt>
<dd>For test and debug.</dd>
</dl>

<dl>
<dt><kbd>estcmd break [-ic <var>enc</var>] [-il <var>lang</var>] [-apn] [-wt] [<var>file</var>]</kbd></dt>
<dd>For test and debug.</dd>
</dl>

<dl>
<dt><kbd>estcmd randput [-ren|-rla|-reu|-ror|-rjp|-rch] [-cs num] <var>db</var> <var>dnum</var></kbd></dt>
<dd>For test and debug.</dd>
</dl>

<dl>
<dt><kbd>estcmd wicked <var>db</var> <var>dnum</var></kbd></dt>
<dd>For test and debug.</dd>
</dl>

<dl>
<dt><kbd>estcmd regression <var>db</var></kbd></dt>
<dd>For test and debug.</dd>
</dl>

<dl>
<dt><kbd>estcmd version</kbd></dt>
<dd>Show the version information.</dd>
</dl>

<p>All sub commands return 0 if the operation is success, else return 1.  As for put, out, gather, purge, randput, wicked, and regression, they finish with closing the database when they catch the signal 1 (SIGHUP), 2 (SIGINT), 3 (SIGQUIT), 13 (SIGPIPE), or 15 (SIGTERM).</p>

<p>The encoding name specified by -ic option should be such name registered to IETF as UTF-8, ISO-8859-1, and so on.  The language name specified by -il option should be one of "en" (English), "ja" (Japanese, "zh" (Chinese), "ko" (Korean).</p>

<p>An outer command specified by -fx option of gather receives the path of the target document by the first argument and the path for output by the second argument.  The original path of the target document is given as the value of the environment variable `ESTORIGFILE'.</p>

<h3>Examples</h3>

<p>The following is to register mail files of mh format.</p>

<pre>find /home/mikio/Mail -type f | egrep 'inbox/(business|friends)/[0-9]+$' |
  estcmd gather -cl -fm -cm casket -
</pre>

<p>The following is to register MS-Office files.  estfxmsotohtml requires wvWare and xlhtml.</p>

<pre>PATH=$PATH:/usr/local/share/hyperestraier/filter ; export PATH
estcmd gather -cl -fx ".doc,.xls,.ppt" "H@estfxmsotohtml" -fz -sd -cm casket .
</pre>

<p>The following is to register PDF files.  estfxpdftohtml requires pdftotext.</p>

<pre>PATH=$PATH:/usr/local/share/hyperestraier/filter ; export PATH
estcmd gather -cl -fx ".pdf" "H@estfxpdftohtml" -fz -sd -cm casket .
</pre>

<p>The following is to output the search result as XML.</p>

<pre>estcmd search -vx -max 8 casket 'socket AND shutdown'
</pre>

<hr />

<h2 id="estseek">CGI Script for Search</h2>

<p>This section describes specification of estseek.cgi.  The subject matter is to write configuration files.</p>

<h3>Composition</h3>

<p>estseek.cgi needs three configuration files; the prime configuration file, the template file, and the top page file.  Their default names are `estseek.cgi', `estseek.tmpl', and `estseek.top'.</p>

<p>The name of the prime configuration file is determined by changeing the suffix of the CGI script to ".conf".  If you change the name of `estseek.cgi' to `estsearch.cgi', `estsearch.conf' is read.  Names of the template file and the top page file is described in the prime configuration file.  So, you can install some sets of search scripts in one directory.</p>

<p>As `estseek.cgi' is installed as `/usr/local/libexec/estseek.cgi', copy it to a directory for CGI scripts.  Moreover, as samples of configurations are installed in `/usr/local/share/hyperestraier/', copy and modify them.</p>

<h3>Prime Configuration File</h3>

<p>The prime configuration file is composed of lines and the name of an variable and the value separated by `:' are in each line.  By default, the following configuration is there.</p>

<pre>indexname: casket
tmplfile: estseek.tmpl
topfile: estseek.top
logfile:
lprefix: file:///home/mikio/public_html/
gprefix: http://localhost/
gsuffix:
dirindex: index.html
replace: //localhost/{{!}}//127.0.0.1/
replace: //127.0.0.1:80/{{!}}//127.0.0.1/
perpage: 10,20,30,40,50,100
attrselect: false
showscore: false
extattr: author|Author
extattr: from|From
extattr: to|To
extattr: cc|Cc
extattr: date|Date
snipwwidth: 480
sniphwidth: 96
snipawidth: 96
condgstep: 2
dotfidf: true
smplphrase: true
candetail: true
smlrvnum: 0
spcache:
</pre>

<p>Means of each variable is the following.</p>

<ul>
<li><kbd>indexname</kbd> : specifies the name of the index.</li>
<li><kbd>tmplfile</kbd> : specifies the path of the template file.</li>
<li><kbd>topfile</kbd> : specifies the path the top page file.</li>
<li><kbd>logfile</kbd> : specifies the path of the log file.</li>
<li><kbd>lprefix</kbd> : specifies the prefix of the local URI of each document.</li>
<li><kbd>gprefix</kbd> : specifies the prefix of the global URI of each document.</li>
<li><kbd>gsuffix</kbd> : specifies the suffix added to the global URI of each document.</li>
<li><kbd>dirindex</kbd> : specifies the name of the directory index file.</li>
<li><kbd>replace</kbd> : specifies an expression to replace the URI of each document.  Before string and after string are separated by "{{!}}".  This can be more than once.</li>
<li><kbd>perpage</kbd> : specifies the numbers of shown pages in a page.</li>
<li><kbd>attrselect</kbd> : specifies whether to use select boxes for attribute conditions.</li>
<li><kbd>attrselect</kbd> : specifies whether to show scores.</li>
<li><kbd>extattr</kbd> : specifies an attribute to be shown.  The name and the label are separated by "|".  This can be more than once.</li>
<li><kbd>snipwwidth</kbd> : specifies whole width of the snippet of each shown document.</li>
<li><kbd>sniphwidth</kbd> : specifies width of strings picked up from the beginning of the text.</li>
<li><kbd>snipawidth</kbd> : specifies width of strings picked up around each highlighted word.</li>
<li><kbd>condgstep</kbd> : specifies accuracy of N-gram checking.  "1" is to check every key.  "2" is to check keys of N-gram are checked every two.  "3" is every three.  "4" is every four.</li>
<li><kbd>dotfidf</kbd> : specifies whether to do TF-IDF score tuning.  "true" or "false".</li>
<li><kbd>smplphrase</kbd> : specifies whether to use simplefied search phrase.  "true" or "false".</li>
<li><kbd>candetail</kbd> : specifies whether to enable detail display of a document.  "true" or "false".</li>
<li><kbd>smlrvnum</kbd> : specifies the number of the number of keywords for similarity search.  If it is less than 1, similarity search is disabled.</li>
<li><kbd>spcache</kbd> : specifies the name of an attribute of the special cache.</li>
</ul>

<h3>Template File</h3>

<p>The template file is to determine appearance of the page.  It describes HTML and the data is shown as it is.  However, "&lt;!--ESTFORM--&gt;" is replaced by the form to input search conditions.  "&lt;!--ESTRESULT--&gt;" is replaced by the search result.  "&lt;!--ESTINFO--&gt;" is replaced by information of the index.</p>

<h3>Top Page File</h3>

<p>When a user access the CGI script first or if no configuration is input, the content of the top page file is displayed instead of the search result.  By default, usage of the CGI script is described there.</p>

<h3>Search Form</h3>

<p>If you want set the search form in another page, write the following HTML.</p>

<pre>&lt;form method="get" action="estseek.cgi"&gt;
&lt;div&gt;
&lt;input type="text" name="phrase" value="" size="32" /&gt;
&lt;input type="submit" value="Search" /&gt;
&lt;input type="hidden" name="enc" value="UTF-8" /&gt;
&lt;/div&gt;
&lt;/form&gt;
</pre>

<p>Change "estseek.cgi" to the URI of setseek.cgi.  Change "UTF-8" to the encoding name of the page.</p>

<hr />

</body>

</html>

<!-- END OF FILE -->