% SiSU insert 0.58

@title: SiSU

@subtitle: Hyperestraier Search

@creator: Amissah, Ralph

@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3

@type: information

@subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search

@date.created: 2002-08-28

@date.issued: 2002-08-28

@date.available: 2002-08-28

@date.modified: 2007-09-16

@date: 2007-09-16

@level: new=C; break=1; num_top=1

@skin: skin_sisu_manual

@bold: /Gnu|Debian|Ruby|SiSU/

@links: { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/
{ Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html
{ SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU
{ SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/
{ SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/
{ SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html
{ SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html
{ SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html
{ SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/
{ SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/

:A~? @title @creator

:B~? SiSU Search - Hyperestraier

:C~? Search

1~search_hyperestraier Hyperestraier

See the documentation for hyperestraier:

_1 http://hyperestraier.sourceforge.net/

_1 /usr/share/doc/hyperestraier/index.html

_1 man estcmd

on sisu_hyperestraier:

_1 man sisu_hyperestraier

_1 /usr/share/doc/sisu/sisu_markup/sisu_hyperestraier/index.html

NOTE: the examples that follow assume that sisu output is placed in the directory /home/ralph/sisu_www

(A) to generate the index within the webserver directory to be indexed:

_1 estcmd gather -sd [index name] [directory path to index]

the following are examples that will need to be tailored according to your needs:

_1 cd /home/ralph/sisu_www

_1 estcmd gather -sd casket /home/ralph/sisu_www

you may use the 'find' command together with 'egrep' to limit indexing to particular document collection directories within the web server directory:

_1 find /home/ralph/sisu_www -type f | egrep '/home/ralph/sisu_www/sisu/.+?.html$' |estcmd gather -sd casket -

Check which directories in the webserver/output directory (~/sisu_www or elsewhere depending on configuration) you wish to include in the search index.

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.

_1 find /home/ralph/sisu_www -type f | egrep '/sisu_www/(sisu|bookmarks)/.+?.html$' | egrep -v '(doc|concordance).html$' |estcmd gather -sd casket -

from your current document preparation/markup directory, you would construct a rune along the following lines:

_1 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 -

(B) to set up the search form

(i) copy estseek.cgi to your cgi directory and set file permissions to 755:

_1 sudo cp -vi /usr/lib/estraier/estseek.cgi /usr/lib/cgi-bin

_1 sudo chmod -v 755 /usr/lib/cgi-bin/estseek.cgi

_1 sudo cp -v /usr/share/hyperestraier/estseek.* /usr/lib/cgi-bin

_1 [see estraier documentation for paths]

(ii) edit estseek.conf, with attention to the lines starting 'indexname:' and 'replace:':

_1 indexname: /home/ralph/sisu_www/casket

_1 replace: ^file:///home/ralph/sisu_www{{!}}http://localhost

_1 replace: /index.html?${{!}}/

(C) to test using webrick, start webrick:

_1 sisu -W

and try open the url: http://localhost:8081/cgi-bin/estseek.cgi