aboutsummaryrefslogtreecommitdiffhomepage
path: root/data/doc/manuals_generated/sisu_manual/sisu_search/sax.xml
blob: 5e8ba4d5b4fb760c99ccb365efd5edc04f689c67 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<?xml-stylesheet type="text/css" href="../_sisu/css/sax.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:05 +0100 2007
     * SiSU http://www.jus.uio.no/sisu
-->

<document>
<head>
	<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">
	<ocn>1</ocn>
	<text class="h1">
		SiSU - SiSU information Structuring Universe - Search [0.58],<br />
Ralph Amissah
	</text>
</object>
<object id="2">
	<ocn>2</ocn>
	<text class="h2">
		SiSU Search
	</text>
</object>
<object id="3">
	<ocn>3</ocn>
	<text class="h4">
		1. SiSU Search - Introduction 
	</text>
</object>
<object id="4">
	<ocn>4</ocn>
	<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>
</object>
<object id="5">
	<ocn>5</ocn>
	<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>
</object>
<object id="6">
	<ocn>6</ocn>
	<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>
</object>
<object id="7">
	<ocn>7</ocn>
	<text class="h4">
		2. SQL 
	</text>
</object>
<object id="8">
	<ocn>8</ocn>
	<text class="h5">
		2.1 populating SQL type databases
	</text>
</object>
<object id="9">
	<ocn>9</ocn>
	<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">
		<number>1</number>
		<note>
			&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;
		</note>
	</endnote>
	<endnote notenumber="2">
		<number>2</number>
		<note>
			&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;
		</note>
	</endnote>
</object>
<object id="10">
	<ocn>10</ocn>
	<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>
</object>
<object id="11">
	<ocn>11</ocn>
	<text class="indent_bullet1">
		 one containing semantic (and other) headers, including, title,
author, subject, (the Dublin Core...);
	</text>
</object>
<object id="12">
	<ocn>12</ocn>
	<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>
</object>
<object id="13">
	<ocn>13</ocn>
	<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>
</object>
<object id="14">
	<ocn>14</ocn>
	<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>
</object>
<object id="15">
	<ocn>15</ocn>
	<text class="norm">
		There is of course the possibility to add further structures.
	</text>
</object>
<object id="16">
	<ocn>16</ocn>
	<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>
</object>
<object id="17">
	<ocn>17</ocn>
	<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>
</object>
<object id="18">
	<ocn>18</ocn>
	<text class="h4">
		3. Postgresql 
	</text>
</object>
<object id="19">
	<ocn>19</ocn>
	<text class="h5">
		3.1 Name
	</text>
</object>
<object id="20">
	<ocn>20</ocn>
	<text class="norm">
		<b>SiSU</b> - Structured information, Serialized Units - a document
publishing system, postgresql dependency package
	</text>
</object>
<object id="21">
	<ocn>21</ocn>
	<text class="h5">
		3.2 Description
	</text>
</object>
<object id="22">
	<ocn>22</ocn>
	<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>
</object>
<object id="23">
	<ocn>23</ocn>
	<text class="h5">
		3.3 Synopsis
	</text>
</object>
<object id="24">
	<ocn>24</ocn>
	<text class="indent1">
		 sisu -D [instruction] [filename/wildcard if required]
	</text>
</object>
<object id="25">
	<ocn>25</ocn>
	<text class="indent1">
		 sisu -D --pg --[instruction] [filename/wildcard if required]
	</text>
</object>
<object id="26">
	<ocn>26</ocn>
	<text class="h5">
		3.4 Commands
	</text>
</object>
<object id="27">
	<ocn>27</ocn>
	<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>
</object>
<object id="28">
	<ocn>28</ocn>
	<text class="norm">
		<b>-D or --pgsql</b> may be used interchangeably.
	</text>
</object>
<object id="29">
	<ocn>29</ocn>
	<text class="h6">
		3.4.1 create and destroy database
	</text>
</object>
<object id="30">
	<ocn>30</ocn>
	<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>
</object>
<object id="31">
	<ocn>31</ocn>
	<text class="norm">
		<b>sisu -D --createdb</b><br /> creates database where no database
existed before
	</text>
</object>
<object id="32">
	<ocn>32</ocn>
	<text class="norm">
		<b>sisu -D --create</b><br /> creates database tables where no database
tables existed before
	</text>
</object>
<object id="33">
	<ocn>33</ocn>
	<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>
</object>
<object id="34">
	<ocn>34</ocn>
	<text class="norm">
		<b>sisu -D --recreate</b><br /> destroys existing database and builds a
new empty database structure
	</text>
</object>
<object id="35">
	<ocn>35</ocn>
	<text class="h6">
		3.4.2 import and remove documents
	</text>
</object>
<object id="36">
	<ocn>36</ocn>
	<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>
</object>
<object id="37">
	<ocn>37</ocn>
	<text class="norm">
		<b>sisu -D --update -v [filename/wildcard]</b><br /> updates file
contents in database
	</text>
</object>
<object id="38">
	<ocn>38</ocn>
	<text class="norm">
		<b>sisu -D --remove -v [filename/wildcard]</b><br /> removes specified
document from postgresql database.
	</text>
</object>
<object id="39">
	<ocn>39</ocn>
	<text class="h4">
		4. Sqlite 
	</text>
</object>
<object id="40">
	<ocn>40</ocn>
	<text class="h5">
		4.1 Name
	</text>
</object>
<object id="41">
	<ocn>41</ocn>
	<text class="norm">
		<b>SiSU</b> - Structured information, Serialized Units - a document
publishing system.
	</text>
</object>
<object id="42">
	<ocn>42</ocn>
	<text class="h5">
		4.2 Description
	</text>
</object>
<object id="43">
	<ocn>43</ocn>
	<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>
</object>
<object id="44">
	<ocn>44</ocn>
	<text class="h5">
		4.3 Synopsis
	</text>
</object>
<object id="45">
	<ocn>45</ocn>
	<text class="indent1">
		 sisu -d [instruction] [filename/wildcard if required]
	</text>
</object>
<object id="46">
	<ocn>46</ocn>
	<text class="indent1">
		 sisu -d --(sqlite|pg) --[instruction] [filename/wildcard if
required]
	</text>
</object>
<object id="47">
	<ocn>47</ocn>
	<text class="h5">
		4.4 Commands
	</text>
</object>
<object id="48">
	<ocn>48</ocn>
	<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>
</object>
<object id="49">
	<ocn>49</ocn>
	<text class="norm">
		<b>-d or --sqlite</b> may be used interchangeably.
	</text>
</object>
<object id="50">
	<ocn>50</ocn>
	<text class="h6">
		4.4.1 create and destroy database
	</text>
</object>
<object id="51">
	<ocn>51</ocn>
	<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>
</object>
<object id="52">
	<ocn>52</ocn>
	<text class="norm">
		<b>sisu -d --createdb</b><br /> creates database where no database
existed before
	</text>
</object>
<object id="53">
	<ocn>53</ocn>
	<text class="norm">
		<b>sisu -d --create</b><br /> creates database tables where no database
tables existed before
	</text>
</object>
<object id="54">
	<ocn>54</ocn>
	<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>
</object>
<object id="55">
	<ocn>55</ocn>
	<text class="norm">
		<b>sisu -d --recreate</b><br /> destroys existing database and builds a
new empty database structure
	</text>
</object>
<object id="56">
	<ocn>56</ocn>
	<text class="h6">
		4.4.2 import and remove documents
	</text>
</object>
<object id="57">
	<ocn>57</ocn>
	<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>
</object>
<object id="58">
	<ocn>58</ocn>
	<text class="norm">
		<b>sisu -d --update -v [filename/wildcard]</b><br /> updates file
contents in database
	</text>
</object>
<object id="59">
	<ocn>59</ocn>
	<text class="norm">
		<b>sisu -d --remove -v [filename/wildcard]</b><br /> removes specified
document from sqlite database.
	</text>
</object>
<object id="60">
	<ocn>60</ocn>
	<text class="h4">
		5. Introduction 
	</text>
</object>
<object id="61">
	<ocn>61</ocn>
	<text class="h5">
		5.1 Search - database frontend sample, utilising database and SiSU
features, including object citation numbering (backend currently
PostgreSQL) 
	</text>
</object>
<object id="62">
	<ocn>62</ocn>
	<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">
		<number>3</number>
		<note>
			&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;
		</note>
	</endnote>
	<endnote notenumber="4">
		<number>4</number>
		<note>
			(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.
		</note>
	</endnote>
</object>
<object id="63">
	<ocn>63</ocn>
	<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>
</object>
<object id="64">
	<ocn>64</ocn>
	<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">
		<number>5</number>
		<note>
			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.
		</note>
	</endnote>
</object>
<object id="65">
	<ocn>65</ocn>
	<text class="norm">
		<b>sisu -F --webserv-webrick</b><br /> builds a cgi web search frontend
for the database created
	</text>
</object>
<object id="66">
	<ocn>66</ocn>
	<text class="norm">
		The following is feedback on the setup on a machine provided by the
help command:
	</text>
</object>
<object id="67">
	<ocn>67</ocn>
	<text class="indent1">
		 sisu --help sql
	</text>
</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">
	<ocn>69</ocn>
	<text class="norm">
		Note on databases built
	</text>
</object>
<object id="70">
	<ocn>70</ocn>
	<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>
</object>
<object id="71">
	<ocn>71</ocn>
	<text class="h5">
		5.2 Search Form
	</text>
</object>
<object id="72">
	<ocn>72</ocn>
	<text class="norm">
		<b>sisu -F</b><br /> generates a sample search form, which must be
copied to the web-server cgi directory
	</text>
</object>
<object id="73">
	<ocn>73</ocn>
	<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>
</object>
<object id="74">
	<ocn>74</ocn>
	<text class="norm">
		<b>sisu -Fv</b><br /> as above, and provides some information on
setting up hyperestraier
	</text>
</object>
<object id="75">
	<ocn>75</ocn>
	<text class="norm">
		<b>sisu -W</b><br /> starts the webrick server which should be
available wherever sisu is properly installed
	</text>
</object>
<object id="76">
	<ocn>76</ocn>
	<text class="norm">
		The generated search form must be copied manually to the webserver
directory as instructed
	</text>
</object>
<object id="77">
	<ocn>77</ocn>
	<text class="h4">
		6. Hyperestraier 
	</text>
</object>
<object id="78">
	<ocn>78</ocn>
	<text class="norm">
		See the documentation for hyperestraier:
	</text>
</object>
<object id="79">
	<ocn>79</ocn>
	<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>
</object>
<object id="80">
	<ocn>80</ocn>
	<text class="indent1">
		 /usr/share/doc/hyperestraier/index.html
	</text>
</object>
<object id="81">
	<ocn>81</ocn>
	<text class="indent1">
		 man estcmd
	</text>
</object>
<object id="82">
	<ocn>82</ocn>
	<text class="norm">
		on sisu_hyperestraier:
	</text>
</object>
<object id="83">
	<ocn>83</ocn>
	<text class="indent1">
		 man sisu_hyperestraier
	</text>
</object>
<object id="84">
	<ocn>84</ocn>
	<text class="indent1">
		 /usr/share/doc/sisu/sisu_markup/sisu_hyperestraier/index.html
	</text>
</object>
<object id="85">
	<ocn>85</ocn>
	<text class="norm">
		NOTE: the examples that follow assume that sisu output is placed in the
directory /home/ralph/sisu_www
	</text>
</object>
<object id="86">
	<ocn>86</ocn>
	<text class="norm">
		(A) to generate the index within the webserver directory to be indexed:
	</text>
</object>
<object id="87">
	<ocn>87</ocn>
	<text class="indent1">
		 estcmd gather -sd [index name] [directory path to index]
	</text>
</object>
<object id="88">
	<ocn>88</ocn>
	<text class="norm">
		the following are examples that will need to be tailored according to
your needs:
	</text>
</object>
<object id="89">
	<ocn>89</ocn>
	<text class="indent1">
		 cd /home/ralph/sisu_www
	</text>
</object>
<object id="90">
	<ocn>90</ocn>
	<text class="indent1">
		 estcmd gather -sd casket /home/ralph/sisu_www
	</text>
</object>
<object id="91">
	<ocn>91</ocn>
	<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>
</object>
<object id="92">
	<ocn>92</ocn>
	<text class="indent1">
		 find /home/ralph/sisu_www -type f | egrep
'/home/ralph/sisu_www/sisu/.+?.html$' |estcmd gather -sd casket -
	</text>
</object>
<object id="93">
	<ocn>93</ocn>
	<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>
</object>
<object id="94">
	<ocn>94</ocn>
	<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>
</object>
<object id="95">
	<ocn>95</ocn>
	<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>
</object>
<object id="96">
	<ocn>96</ocn>
	<text class="norm">
		from your current document preparation/markup directory, you would
construct a rune along the following lines:
	</text>
</object>
<object id="97">
	<ocn>97</ocn>
	<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>
</object>
<object id="98">
	<ocn>98</ocn>
	<text class="norm">
		(B) to set up the search form
	</text>
</object>
<object id="99">
	<ocn>99</ocn>
	<text class="norm">
		(i) copy estseek.cgi to your cgi directory and set file permissions to
755:
	</text>
</object>
<object id="100">
	<ocn>100</ocn>
	<text class="indent1">
		 sudo cp -vi /usr/lib/estraier/estseek.cgi /usr/lib/cgi-bin
	</text>
</object>
<object id="101">
	<ocn>101</ocn>
	<text class="indent1">
		 sudo chmod -v 755 /usr/lib/cgi-bin/estseek.cgi
	</text>
</object>
<object id="102">
	<ocn>102</ocn>
	<text class="indent1">
		 sudo cp -v /usr/share/hyperestraier/estseek.* /usr/lib/cgi-bin
	</text>
</object>
<object id="103">
	<ocn>103</ocn>
	<text class="indent1">
		 [see estraier documentation for paths]
	</text>
</object>
<object id="104">
	<ocn>104</ocn>
	<text class="norm">
		(ii) edit estseek.conf, with attention to the lines starting
'indexname:' and 'replace:':
	</text>
</object>
<object id="105">
	<ocn>105</ocn>
	<text class="indent1">
		 indexname: /home/ralph/sisu_www/casket
	</text>
</object>
<object id="106">
	<ocn>106</ocn>
	<text class="indent1">
		 replace: ^file:///home/ralph/sisu_www{{!}}http://localhost
	</text>
</object>
<object id="107">
	<ocn>107</ocn>
	<text class="indent1">
		 replace: /index.html?${{!}}/
	</text>
</object>
<object id="108">
	<ocn>108</ocn>
	<text class="norm">
		(C) to test using webrick, start webrick:
	</text>
</object>
<object id="109">
	<ocn>109</ocn>
	<text class="indent1">
		 sisu -W
	</text>
</object>
<object id="110">
	<ocn>110</ocn>
	<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>
</object>
<object id="0">
	<ocn>0</ocn>
	<text class="h4">
		Endnotes
	</text>
</object>
</body>
</document>