aboutsummaryrefslogtreecommitdiffhomepage
path: root/data/doc/manuals_generated/sisu_manual/sisu_search/scroll.xhtml
diff options
context:
space:
mode:
authorRalph Amissah <ralph@amissah.com>2007-09-23 05:16:21 +0100
committerRalph Amissah <ralph@amissah.com>2007-09-23 05:16:21 +0100
commit50d45c6deb0afd2e4222d2e33a45487a9d1fa676 (patch)
tree100c62d678f009139999bf77c26c81653a721eeb /data/doc/manuals_generated/sisu_manual/sisu_search/scroll.xhtml
parentsisu-0.58.3 + md5s (diff)
primarily todo with sisu documentation, changelog reproduced below:
* start documenting sisu using sisu * sisu markup source files in data/doc/sisu/sisu_markup_samples/sisu_manual/ /usr/share/doc/sisu/sisu_markup_samples/sisu_manual/ * default output [sisu -3] in data/doc/manuals_generated/sisu_manual/ /usr/share/doc/manuals_generated/sisu_manual/ (adds substantially to the size of sisu package!) * help related edits * manpage, work on ability to generate manpages, improved * param, exclude footnote mark count when occurs within code block * plaintext changes made * shared_txt, line wrap visited * file:// link option introduced (in addition to existing https?:// and ftp://) a bit arbitrarily, diff here, [double check changes in sysenv and hub] * minor adjustments * html url match refinement * css added tiny_center * plaintext * endnotes fix * footnote adjustment to make more easily distinguishable from substantive text * flag -a only [flags -A -e -E dropped] controlled by modifiers --unix/msdos --footnote/endnote * defaults, homepage * renamed homepage (instead of index) implications for modifying skins, which need likewise to have any homepage entry renamed * added link to sisu_manual in homepage * css the css for the default homepage is renamed homepage.css (instead of index.css) [consider removing this and relying on html.css] * ruby version < ruby1.9 * place stop on installation and working with for now [ruby String.strip broken in ruby 1.9.0 (2007-09-10 patchlevel 0) [i486-linux], 2007-09-18:38/2] * debian/control restrict use to ruby > 1.8.4 and ruby < 1.9 * debian * debian/control restrict use to ruby > 1.8.4 and ruby < 1.9 * sisu-doc new sub-package for sisu documentation debian/control and sisu-doc.install
Diffstat (limited to 'data/doc/manuals_generated/sisu_manual/sisu_search/scroll.xhtml')
-rw-r--r--data/doc/manuals_generated/sisu_manual/sisu_search/scroll.xhtml905
1 files changed, 905 insertions, 0 deletions
diff --git a/data/doc/manuals_generated/sisu_manual/sisu_search/scroll.xhtml b/data/doc/manuals_generated/sisu_manual/sisu_search/scroll.xhtml
new file mode 100644
index 00000000..9dd7445f
--- /dev/null
+++ b/data/doc/manuals_generated/sisu_manual/sisu_search/scroll.xhtml
@@ -0,0 +1,905 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<?xml-stylesheet type="text/css" href="../_sisu/css/xhtml.css"?>
+<!-- Document processing information:
+ * Generated by: SiSU 0.59.0 of 2007w38/0 (2007-09-23)
+ * Ruby version: ruby 1.8.6 (2007-06-07 patchlevel 36) [i486-linux]
+ *
+ * Last Generated on: Sun Sep 23 04:12:21 +0100 2007
+ * SiSU http://www.jus.uio.no/sisu
+-->
+
+<document>
+<head>
+ <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
+ <meta>Title:</meta>
+ <title class="dc">
+ SiSU - SiSU information Structuring Universe - Search [0.58]
+ </title>
+ <br />
+ <meta>Creator:</meta>
+ <creator class="dc">
+ Ralph Amissah
+ </creator>
+ <br />
+ <meta>Rights:</meta>
+ <rights class="dc">
+ Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3
+ </rights>
+ <br />
+ <meta>Type:</meta>
+ <type class="dc">
+ information
+ </type>
+ <br />
+ <meta>Subject:</meta>
+ <subject class="dc">
+ ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search
+ </subject>
+ <br />
+ <meta>Date created:</meta>
+ <date_created class="extra">
+ 2002-08-28
+ </date_created>
+ <br />
+ <meta>Date issued:</meta>
+ <date_issued class="extra">
+ 2002-08-28
+ </date_issued>
+ <br />
+ <meta>Date available:</meta>
+ <date_available class="extra">
+ 2002-08-28
+ </date_available>
+ <br />
+ <meta>Date modified:</meta>
+ <date_modified class="extra">
+ 2007-09-16
+ </date_modified>
+ <br />
+ <meta>Date:</meta>
+ <date class="dc">
+ 2007-09-16
+ </date>
+ <br />
+</head>
+<body>
+<object id="1">
+ <text class="h1">
+ SiSU - SiSU information Structuring Universe - Search [0.58],<br />
+Ralph Amissah
+ </text>
+ <ocn>1</ocn>
+</object>
+<object id="2">
+ <text class="h2">
+ SiSU Search
+ </text>
+ <ocn>2</ocn>
+</object>
+<object id="3">
+ <text class="h4">
+ 1. SiSU Search - Introduction
+ </text>
+ <ocn>3</ocn>
+</object>
+<object id="4">
+ <text class="norm">
+ <b>SiSU</b> output can easily and conveniently be indexed by a number
+of standalone indexing tools, such as Lucene, Hyperestraier.
+ </text>
+ <ocn>4</ocn>
+</object>
+<object id="5">
+ <text class="norm">
+ Because the document structure of sites created is clearly defined, and
+the text object citation system is available hypothetically at least,
+for all forms of output, it is possible to search the sql database, and
+either read results from that database, or just as simply map the
+results to the html output, which has richer text markup.
+ </text>
+ <ocn>5</ocn>
+</object>
+<object id="6">
+ <text class="norm">
+ In addition to this <b>SiSU</b> has the ability to populate a
+relational sql type database with documents at an object level, with
+objects numbers that are shared across different output types, which
+make them searchable with that degree of granularity. Basically, your
+match criteria is met by these documents and at these locations within
+each document, which can be viewed within the database directly or in
+various output formats.
+ </text>
+ <ocn>6</ocn>
+</object>
+<object id="7">
+ <text class="h4">
+ 2. SQL
+ </text>
+ <ocn>7</ocn>
+</object>
+<object id="8">
+ <text class="h5">
+ 2.1 populating SQL type databases
+ </text>
+ <ocn>8</ocn>
+</object>
+<object id="9">
+ <text class="norm">
+ <b>SiSU</b> feeds sisu markupd documents into sql type databases
+PostgreSQL<en>1</en> and/or SQLite<en>2</en> database together with
+information related to document structure.
+ </text>
+ <endnote notenumber="1">
+ 1. &lt;<link xmlns:xlink="http://www.w3.org/1999/xlink"
+xlink:type="simple"
+xlink:href="http://www.postgresql.org/">http://www.postgresql.org/</link>&gt;
+<br /> &lt;<link xmlns:xlink="http://www.w3.org/1999/xlink"
+xlink:type="simple"
+xlink:href="http://advocacy.postgresql.org/">http://advocacy.postgresql.org/</link>&gt;
+<br /> &lt;<link xmlns:xlink="http://www.w3.org/1999/xlink"
+xlink:type="simple"
+xlink:href="http://en.wikipedia.org/wiki/Postgresql">http://en.wikipedia.org/wiki/Postgresql</link>&gt;
+ </endnote>
+ <endnote notenumber="2">
+ 2. &lt;<link xmlns:xlink="http://www.w3.org/1999/xlink"
+xlink:type="simple"
+xlink:href="http://www.hwaci.com/sw/sqlite/">http://www.hwaci.com/sw/sqlite/</link>&gt;
+<br /> &lt;<link xmlns:xlink="http://www.w3.org/1999/xlink"
+xlink:type="simple"
+xlink:href="http://en.wikipedia.org/wiki/Sqlite">http://en.wikipedia.org/wiki/Sqlite</link>&gt;
+ </endnote>
+ <ocn>9</ocn>
+</object>
+<object id="10">
+ <text class="norm">
+ This is one of the more interesting output forms, as all the structural
+data of the documents are retained (though can be ignored by the user
+of the database should they so choose). All site texts/documents are
+(currently) streamed to four tables:
+ </text>
+ <ocn>10</ocn>
+</object>
+<object id="11">
+ <text class="indent_bullet1">
+ one containing semantic (and other) headers, including, title,
+author, subject, (the Dublin Core...);
+ </text>
+ <ocn>11</ocn>
+</object>
+<object id="12">
+ <text class="indent_bullet1">
+ another the substantive texts by individual "paragraph" (or
+object) - along with structural information, each paragraph being
+identifiable by its paragraph number (if it has one which almost all of
+them do), and the substantive text of each paragraph quite naturally
+being searchable (both in formatted and clean text versions for
+searching); and
+ </text>
+ <ocn>12</ocn>
+</object>
+<object id="13">
+ <text class="indent_bullet1">
+ a third containing endnotes cross-referenced back to the
+paragraph from which they are referenced (both in formatted and clean
+text versions for searching).
+ </text>
+ <ocn>13</ocn>
+</object>
+<object id="14">
+ <text class="indent_bullet1">
+ a fourth table with a one to one relation with the headers table
+contains full text versions of output, eg. pdf, html, xml, and ascii.
+ </text>
+ <ocn>14</ocn>
+</object>
+<object id="15">
+ <text class="norm">
+ There is of course the possibility to add further structures.
+ </text>
+ <ocn>15</ocn>
+</object>
+<object id="16">
+ <text class="norm">
+ At this level <b>SiSU</b> loads a relational database with documents
+chunked into objects, their smallest logical structurally constituent
+parts, as text objects, with their object citation number and all other
+structural information needed to construct the document. Text is stored
+(at this text object level) with and without elementary markup tagging,
+the stripped version being so as to facilitate ease of searching.
+ </text>
+ <ocn>16</ocn>
+</object>
+<object id="17">
+ <text class="norm">
+ Being able to search a relational database at an object level with the
+<b>SiSU</b> citation system is an effective way of locating content
+generated by <b>SiSU</b>. As individual text objects of a document
+stored (and indexed) together with object numbers, and all versions of
+the document have the same numbering, complex searches can be tailored
+to return just the locations of the search results relevant for all
+available output formats, with live links to the precise locations in
+the database or in html/xml documents; or, the structural information
+provided makes it possible to search the full contents of the database
+and have headings in which search content appears, or to search only
+headings etc. (as the Dublin Core is incorporated it is easy to make
+use of that as well).
+ </text>
+ <ocn>17</ocn>
+</object>
+<object id="18">
+ <text class="h4">
+ 3. Postgresql
+ </text>
+ <ocn>18</ocn>
+</object>
+<object id="19">
+ <text class="h5">
+ 3.1 Name
+ </text>
+ <ocn>19</ocn>
+</object>
+<object id="20">
+ <text class="norm">
+ <b>SiSU</b> - Structured information, Serialized Units - a document
+publishing system, postgresql dependency package
+ </text>
+ <ocn>20</ocn>
+</object>
+<object id="21">
+ <text class="h5">
+ 3.2 Description
+ </text>
+ <ocn>21</ocn>
+</object>
+<object id="22">
+ <text class="norm">
+ Information related to using postgresql with sisu (and related to the
+sisu_postgresql dependency package, which is a dummy package to install
+dependencies needed for <b>SiSU</b> to populate a postgresql database,
+this being part of <b>SiSU</b> - man sisu).
+ </text>
+ <ocn>22</ocn>
+</object>
+<object id="23">
+ <text class="h5">
+ 3.3 Synopsis
+ </text>
+ <ocn>23</ocn>
+</object>
+<object id="24">
+ <text class="indent1">
+ sisu -D [instruction] [filename/wildcard if required]
+ </text>
+ <ocn>24</ocn>
+</object>
+<object id="25">
+ <text class="indent1">
+ sisu -D --pg --[instruction] [filename/wildcard if required]
+ </text>
+ <ocn>25</ocn>
+</object>
+<object id="26">
+ <text class="h5">
+ 3.4 Commands
+ </text>
+ <ocn>26</ocn>
+</object>
+<object id="27">
+ <text class="norm">
+ Mappings to two databases are provided by default, postgresql and
+sqlite, the same commands are used within sisu to construct and
+populate databases however -d (lowercase) denotes sqlite and -D
+(uppercase) denotes postgresql, alternatively --sqlite or --pgsql may
+be used
+ </text>
+ <ocn>27</ocn>
+</object>
+<object id="28">
+ <text class="norm">
+ <b>-D or --pgsql</b> may be used interchangeably.
+ </text>
+ <ocn>28</ocn>
+</object>
+<object id="29">
+ <text class="h6">
+ 3.4.1 create and destroy database
+ </text>
+ <ocn>29</ocn>
+</object>
+<object id="30">
+ <text class="norm">
+ <b>--pgsql --createall</b><br /> initial step, creates required
+relations (tables, indexes) in existing (postgresql) database (a
+database should be created manually and given the same name as working
+directory, as requested) (rb.dbi)
+ </text>
+ <ocn>30</ocn>
+</object>
+<object id="31">
+ <text class="norm">
+ <b>sisu -D --createdb</b><br /> creates database where no database
+existed before
+ </text>
+ <ocn>31</ocn>
+</object>
+<object id="32">
+ <text class="norm">
+ <b>sisu -D --create</b><br /> creates database tables where no database
+tables existed before
+ </text>
+ <ocn>32</ocn>
+</object>
+<object id="33">
+ <text class="norm">
+ <b>sisu -D --Dropall</b><br /> destroys database (including all its
+content)! kills data and drops tables, indexes and database associated
+with a given directory (and directories of the same name).
+ </text>
+ <ocn>33</ocn>
+</object>
+<object id="34">
+ <text class="norm">
+ <b>sisu -D --recreate</b><br /> destroys existing database and builds a
+new empty database structure
+ </text>
+ <ocn>34</ocn>
+</object>
+<object id="35">
+ <text class="h6">
+ 3.4.2 import and remove documents
+ </text>
+ <ocn>35</ocn>
+</object>
+<object id="36">
+ <text class="norm">
+ <b>sisu -D --import -v [filename/wildcard]</b><br /> populates database
+with the contents of the file. Imports documents(s) specified to a
+postgresql database (at an object level).
+ </text>
+ <ocn>36</ocn>
+</object>
+<object id="37">
+ <text class="norm">
+ <b>sisu -D --update -v [filename/wildcard]</b><br /> updates file
+contents in database
+ </text>
+ <ocn>37</ocn>
+</object>
+<object id="38">
+ <text class="norm">
+ <b>sisu -D --remove -v [filename/wildcard]</b><br /> removes specified
+document from postgresql database.
+ </text>
+ <ocn>38</ocn>
+</object>
+<object id="39">
+ <text class="h4">
+ 4. Sqlite
+ </text>
+ <ocn>39</ocn>
+</object>
+<object id="40">
+ <text class="h5">
+ 4.1 Name
+ </text>
+ <ocn>40</ocn>
+</object>
+<object id="41">
+ <text class="norm">
+ <b>SiSU</b> - Structured information, Serialized Units - a document
+publishing system.
+ </text>
+ <ocn>41</ocn>
+</object>
+<object id="42">
+ <text class="h5">
+ 4.2 Description
+ </text>
+ <ocn>42</ocn>
+</object>
+<object id="43">
+ <text class="norm">
+ Information related to using sqlite with sisu (and related to the
+sisu_sqlite dependency package, which is a dummy package to install
+dependencies needed for <b>SiSU</b> to populate an sqlite database,
+this being part of <b>SiSU</b> - man sisu).
+ </text>
+ <ocn>43</ocn>
+</object>
+<object id="44">
+ <text class="h5">
+ 4.3 Synopsis
+ </text>
+ <ocn>44</ocn>
+</object>
+<object id="45">
+ <text class="indent1">
+ sisu -d [instruction] [filename/wildcard if required]
+ </text>
+ <ocn>45</ocn>
+</object>
+<object id="46">
+ <text class="indent1">
+ sisu -d --(sqlite|pg) --[instruction] [filename/wildcard if
+required]
+ </text>
+ <ocn>46</ocn>
+</object>
+<object id="47">
+ <text class="h5">
+ 4.4 Commands
+ </text>
+ <ocn>47</ocn>
+</object>
+<object id="48">
+ <text class="norm">
+ Mappings to two databases are provided by default, postgresql and
+sqlite, the same commands are used within sisu to construct and
+populate databases however -d (lowercase) denotes sqlite and -D
+(uppercase) denotes postgresql, alternatively --sqlite or --pgsql may
+be used
+ </text>
+ <ocn>48</ocn>
+</object>
+<object id="49">
+ <text class="norm">
+ <b>-d or --sqlite</b> may be used interchangeably.
+ </text>
+ <ocn>49</ocn>
+</object>
+<object id="50">
+ <text class="h6">
+ 4.4.1 create and destroy database
+ </text>
+ <ocn>50</ocn>
+</object>
+<object id="51">
+ <text class="norm">
+ <b>--sqlite --createall</b><br /> initial step, creates required
+relations (tables, indexes) in existing (sqlite) database (a database
+should be created manually and given the same name as working
+directory, as requested) (rb.dbi)
+ </text>
+ <ocn>51</ocn>
+</object>
+<object id="52">
+ <text class="norm">
+ <b>sisu -d --createdb</b><br /> creates database where no database
+existed before
+ </text>
+ <ocn>52</ocn>
+</object>
+<object id="53">
+ <text class="norm">
+ <b>sisu -d --create</b><br /> creates database tables where no database
+tables existed before
+ </text>
+ <ocn>53</ocn>
+</object>
+<object id="54">
+ <text class="norm">
+ <b>sisu -d --dropall</b><br /> destroys database (including all its
+content)! kills data and drops tables, indexes and database associated
+with a given directory (and directories of the same name).
+ </text>
+ <ocn>54</ocn>
+</object>
+<object id="55">
+ <text class="norm">
+ <b>sisu -d --recreate</b><br /> destroys existing database and builds a
+new empty database structure
+ </text>
+ <ocn>55</ocn>
+</object>
+<object id="56">
+ <text class="h6">
+ 4.4.2 import and remove documents
+ </text>
+ <ocn>56</ocn>
+</object>
+<object id="57">
+ <text class="norm">
+ <b>sisu -d --import -v [filename/wildcard]</b><br /> populates database
+with the contents of the file. Imports documents(s) specified to an
+sqlite database (at an object level).
+ </text>
+ <ocn>57</ocn>
+</object>
+<object id="58">
+ <text class="norm">
+ <b>sisu -d --update -v [filename/wildcard]</b><br /> updates file
+contents in database
+ </text>
+ <ocn>58</ocn>
+</object>
+<object id="59">
+ <text class="norm">
+ <b>sisu -d --remove -v [filename/wildcard]</b><br /> removes specified
+document from sqlite database.
+ </text>
+ <ocn>59</ocn>
+</object>
+<object id="60">
+ <text class="h4">
+ 5. Introduction
+ </text>
+ <ocn>60</ocn>
+</object>
+<object id="61">
+ <text class="h5">
+ 5.1 Search - database frontend sample, utilising database and SiSU
+features, including object citation numbering (backend currently
+PostgreSQL)
+ </text>
+ <ocn>61</ocn>
+</object>
+<object id="62">
+ <text class="norm">
+ <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:type="simple"
+xlink:href="http://search.sisudoc.org"> Sample search frontend </link>
+<en>3</en> A small database and sample query front-end (search from)
+that makes use of the citation system, <u>object citation numbering</u>
+to demonstrates functionality.<en>4</en>
+ </text>
+ <endnote notenumber="3">
+ 3. &lt;<link xmlns:xlink="http://www.w3.org/1999/xlink"
+xlink:type="simple"
+xlink:href="http://search.sisudoc.org">http://search.sisudoc.org</link>&gt;
+ </endnote>
+ <endnote notenumber="4">
+ 4. (which could be extended further with current back-end). As regards
+scaling of the database, it is as scalable as the database (here
+Postgresql) and hardware allow.
+ </endnote>
+ <ocn>62</ocn>
+</object>
+<object id="63">
+ <text class="norm">
+ <b>SiSU</b> can provide information on which documents are matched and
+at what locations within each document the matches are found. These
+results are relevant across all outputs using object citation
+numbering, which includes html, XML, LaTeX, PDF and indeed the SQL
+database. You can then refer to one of the other outputs or in the SQL
+database expand the text within the matched objects (paragraphs) in the
+documents matched.
+ </text>
+ <ocn>63</ocn>
+</object>
+<object id="64">
+ <text class="norm">
+ Note you may set results either for documents matched and object number
+locations within each matched document meeting the search criteria; or
+display the names of the documents matched along with the objects
+(paragraphs) that meet the search criteria.<en>5</en>
+ </text>
+ <endnote notenumber="5">
+ 5. of this feature when demonstrated to an IBM software innovations
+evaluator in 2004 he said to paraphrase: this could be of interest to
+us. We have large document management systems, you can search hundreds
+of thousands of documents and we can tell you which documents meet your
+search criteria, but there is no way we can tell you without opening
+each document where within each your matches are found.
+ </endnote>
+ <ocn>64</ocn>
+</object>
+<object id="65">
+ <text class="norm">
+ <b>sisu -F --webserv-webrick</b><br /> builds a cgi web search frontend
+for the database created
+ </text>
+ <ocn>65</ocn>
+</object>
+<object id="66">
+ <text class="norm">
+ The following is feedback on the setup on a machine provided by the
+help command:
+ </text>
+ <ocn>66</ocn>
+</object>
+<object id="67">
+ <text class="indent1">
+ sisu --help sql
+ </text>
+ <ocn>67</ocn>
+</object>
+<object id="68">
+ <ocn>68</ocn>
+ <text class="code">
+ &#160;&#160; &nbsp;&nbsp;Postgresql<br />&#160;&#160; &nbsp;&nbsp;&nbsp;&nbsp;user:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; ralph<br />&#160;&#160; &nbsp;&nbsp;&nbsp;&nbsp;current db set:&nbsp;&nbsp; SiSU_sisu<br />&#160;&#160; &nbsp;&nbsp;&nbsp;&nbsp;port:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 5432<br />&#160;&#160; &nbsp;&nbsp;&nbsp;&nbsp;dbi connect:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;DBI:Pg:database=SiSU_sisu;port=5432<br /><br />&#160;&#160; &nbsp;&nbsp;sqlite<br />&#160;&#160; &nbsp;&nbsp;&nbsp;&nbsp;current db set:&nbsp;&nbsp; /home/ralph/sisu_www/sisu/sisu_sqlite.db<br />&#160;&#160; &nbsp;&nbsp;&nbsp;&nbsp;dbi connect&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; DBI:SQLite:/home/ralph/sisu_www/sisu/sisu_sqlite.db&#160;&#160;&#160;&#160;
+ </text>
+</object>
+<object id="69">
+ <text class="norm">
+ Note on databases built
+ </text>
+ <ocn>69</ocn>
+</object>
+<object id="70">
+ <text class="norm">
+ By default, [unless otherwise specified] databases are built on a
+directory basis, from collections of documents within that directory.
+The name of the directory you choose to work from is used as the
+database name, i.e. if you are working in a directory called
+/home/ralph/ebook the database SiSU_ebook is used. [otherwise a manual
+mapping for the collection is necessary]
+ </text>
+ <ocn>70</ocn>
+</object>
+<object id="71">
+ <text class="h5">
+ 5.2 Search Form
+ </text>
+ <ocn>71</ocn>
+</object>
+<object id="72">
+ <text class="norm">
+ <b>sisu -F</b><br /> generates a sample search form, which must be
+copied to the web-server cgi directory
+ </text>
+ <ocn>72</ocn>
+</object>
+<object id="73">
+ <text class="norm">
+ <b>sisu -F --webserv-webrick</b><br /> generates a sample search form
+for use with the webrick server, which must be copied to the web-server
+cgi directory
+ </text>
+ <ocn>73</ocn>
+</object>
+<object id="74">
+ <text class="norm">
+ <b>sisu -Fv</b><br /> as above, and provides some information on
+setting up hyperestraier
+ </text>
+ <ocn>74</ocn>
+</object>
+<object id="75">
+ <text class="norm">
+ <b>sisu -W</b><br /> starts the webrick server which should be
+available wherever sisu is properly installed
+ </text>
+ <ocn>75</ocn>
+</object>
+<object id="76">
+ <text class="norm">
+ The generated search form must be copied manually to the webserver
+directory as instructed
+ </text>
+ <ocn>76</ocn>
+</object>
+<object id="77">
+ <text class="h4">
+ 6. Hyperestraier
+ </text>
+ <ocn>77</ocn>
+</object>
+<object id="78">
+ <text class="norm">
+ See the documentation for hyperestraier:
+ </text>
+ <ocn>78</ocn>
+</object>
+<object id="79">
+ <text class="indent1">
+ &lt;<link xmlns:xlink="http://www.w3.org/1999/xlink"
+xlink:type="simple"
+xlink:href="http://hyperestraier.sourceforge.net/">http://hyperestraier.sourceforge.net/</link>&gt;
+ </text>
+ <ocn>79</ocn>
+</object>
+<object id="80">
+ <text class="indent1">
+ /usr/share/doc/hyperestraier/index.html
+ </text>
+ <ocn>80</ocn>
+</object>
+<object id="81">
+ <text class="indent1">
+ man estcmd
+ </text>
+ <ocn>81</ocn>
+</object>
+<object id="82">
+ <text class="norm">
+ on sisu_hyperestraier:
+ </text>
+ <ocn>82</ocn>
+</object>
+<object id="83">
+ <text class="indent1">
+ man sisu_hyperestraier
+ </text>
+ <ocn>83</ocn>
+</object>
+<object id="84">
+ <text class="indent1">
+ /usr/share/doc/sisu/sisu_markup/sisu_hyperestraier/index.html
+ </text>
+ <ocn>84</ocn>
+</object>
+<object id="85">
+ <text class="norm">
+ NOTE: the examples that follow assume that sisu output is placed in the
+directory /home/ralph/sisu_www
+ </text>
+ <ocn>85</ocn>
+</object>
+<object id="86">
+ <text class="norm">
+ (A) to generate the index within the webserver directory to be indexed:
+ </text>
+ <ocn>86</ocn>
+</object>
+<object id="87">
+ <text class="indent1">
+ estcmd gather -sd [index name] [directory path to index]
+ </text>
+ <ocn>87</ocn>
+</object>
+<object id="88">
+ <text class="norm">
+ the following are examples that will need to be tailored according to
+your needs:
+ </text>
+ <ocn>88</ocn>
+</object>
+<object id="89">
+ <text class="indent1">
+ cd /home/ralph/sisu_www
+ </text>
+ <ocn>89</ocn>
+</object>
+<object id="90">
+ <text class="indent1">
+ estcmd gather -sd casket /home/ralph/sisu_www
+ </text>
+ <ocn>90</ocn>
+</object>
+<object id="91">
+ <text class="norm">
+ you may use the 'find' command together with 'egrep' to limit indexing
+to particular document collection directories within the web server
+directory:
+ </text>
+ <ocn>91</ocn>
+</object>
+<object id="92">
+ <text class="indent1">
+ find /home/ralph/sisu_www -type f | egrep
+'/home/ralph/sisu_www/sisu/.+?.html$' |estcmd gather -sd casket -
+ </text>
+ <ocn>92</ocn>
+</object>
+<object id="93">
+ <text class="norm">
+ Check which directories in the webserver/output directory
+(&#126;/sisu_www or elsewhere depending on configuration) you wish to
+include in the search index.
+ </text>
+ <ocn>93</ocn>
+</object>
+<object id="94">
+ <text class="norm">
+ As sisu duplicates output in multiple file formats, it it is probably
+preferable to limit the estraier index to html output, and as it may
+also be desirable to exclude files 'plain.txt', 'toc.html' and
+'concordance.html', as these duplicate information held in other html
+output e.g.
+ </text>
+ <ocn>94</ocn>
+</object>
+<object id="95">
+ <text class="indent1">
+ find /home/ralph/sisu_www -type f | egrep
+'/sisu_www/(sisu|bookmarks)/.+?.html$' | egrep -v
+'(doc|concordance).html$' |estcmd gather -sd casket -
+ </text>
+ <ocn>95</ocn>
+</object>
+<object id="96">
+ <text class="norm">
+ from your current document preparation/markup directory, you would
+construct a rune along the following lines:
+ </text>
+ <ocn>96</ocn>
+</object>
+<object id="97">
+ <text class="indent1">
+ find /home/ralph/sisu_www -type f | egrep
+'/home/ralph/sisu_www/([specify first directory for inclusion]|[specify
+second directory for inclusion]|[another directory for inclusion?
+...])/.+?.html$' | egrep -v '(doc|concordance).html$' |estcmd gather
+-sd /home/ralph/sisu_www/casket -
+ </text>
+ <ocn>97</ocn>
+</object>
+<object id="98">
+ <text class="norm">
+ (B) to set up the search form
+ </text>
+ <ocn>98</ocn>
+</object>
+<object id="99">
+ <text class="norm">
+ (i) copy estseek.cgi to your cgi directory and set file permissions to
+755:
+ </text>
+ <ocn>99</ocn>
+</object>
+<object id="100">
+ <text class="indent1">
+ sudo cp -vi /usr/lib/estraier/estseek.cgi /usr/lib/cgi-bin
+ </text>
+ <ocn>100</ocn>
+</object>
+<object id="101">
+ <text class="indent1">
+ sudo chmod -v 755 /usr/lib/cgi-bin/estseek.cgi
+ </text>
+ <ocn>101</ocn>
+</object>
+<object id="102">
+ <text class="indent1">
+ sudo cp -v /usr/share/hyperestraier/estseek.* /usr/lib/cgi-bin
+ </text>
+ <ocn>102</ocn>
+</object>
+<object id="103">
+ <text class="indent1">
+ [see estraier documentation for paths]
+ </text>
+ <ocn>103</ocn>
+</object>
+<object id="104">
+ <text class="norm">
+ (ii) edit estseek.conf, with attention to the lines starting
+'indexname:' and 'replace:':
+ </text>
+ <ocn>104</ocn>
+</object>
+<object id="105">
+ <text class="indent1">
+ indexname: /home/ralph/sisu_www/casket
+ </text>
+ <ocn>105</ocn>
+</object>
+<object id="106">
+ <text class="indent1">
+ replace: ^file:///home/ralph/sisu_www{{!}}http://localhost
+ </text>
+ <ocn>106</ocn>
+</object>
+<object id="107">
+ <text class="indent1">
+ replace: /index.html?${{!}}/
+ </text>
+ <ocn>107</ocn>
+</object>
+<object id="108">
+ <text class="norm">
+ (C) to test using webrick, start webrick:
+ </text>
+ <ocn>108</ocn>
+</object>
+<object id="109">
+ <text class="indent1">
+ sisu -W
+ </text>
+ <ocn>109</ocn>
+</object>
+<object id="110">
+ <text class="norm">
+ and try open the url: &lt;<link
+xmlns:xlink="http://www.w3.org/1999/xlink" xlink:type="simple"
+xlink:href="http://localhost:8081/cgi-bin/estseek.cgi">http://localhost:8081/cgi-bin/estseek.cgi</link>&gt;
+ </text>
+ <ocn>110</ocn>
+</object>
+<object id="0">
+ <text class="h4">
+ Endnotes
+ </text>
+ <ocn>0</ocn>
+</object>
+</body>
+</document>