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
|
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<?xml-stylesheet type="text/css" href="../_sisu/css/dom.css"?>
<!-- Document processing information:
* Generated by: SiSU 0.59.1 of 2007w39/2 (2007-09-25)
* Ruby version: ruby 1.8.6 (2007-06-07 patchlevel 36) [i486-linux]
*
* Last Generated on: Tue Sep 25 02:53:57 +0100 2007
* SiSU http://www.jus.uio.no/sisu
-->
<document>
<head>
<header>
<meta>Title:</meta>
<title>
SiSU - FAQ - Frequently Asked/Answered Questions
</title>
</header>
<header>
<meta>Creator:</meta>
<creator>
Ralph Amissah
</creator>
</header>
<header>
<meta>Rights:</meta>
<rights>
Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3
</rights>
</header>
<header>
<meta>Type:</meta>
<type>
information
</type>
</header>
<header>
<meta>Subject:</meta>
<subject>
ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search
</subject>
</header>
<header>
<meta>Date created:</meta>
<date_created>
2006-09-06
</date_created>
</header>
<header>
<meta>Date available:</meta>
<date_available>
2006-09-06
</date_available>
</header>
<header>
<meta>Date issued:</meta>
<date_issued>
2006-09-06
</date_issued>
</header>
<header>
<meta>Date modified:</meta>
<date_modified>
2007-09-16
</date_modified>
</header>
<header>
<meta>Date:</meta>
<date>
2007-09-16
</date>
</header>
</head>
<body>
<heading1>
<heading>
<object id="1">
<ocn>1</ocn>
<text>SiSU - FAQ - Frequently Asked/Answered Questions,<br /> Ralph Amissah</text>
</object>
</heading>
<contents1>
<heading>
<object id="2">
<ocn>2</ocn>
<nametag>faq</nametag>
<text>1. FAQ - Frequently Asked/Answered Questions </text>
</object>
</heading>
<content>
</content>
<contents2>
<heading>
<object id="3">
<ocn>3</ocn>
<nametag>1.1</nametag>
<text>1.1 Why are urls produced with the -v (and -u) flag that point to a web server on port 8081?</text>
</object>
</heading>
<content>
<object id="4">
<ocn>4</ocn>
<text class="norm">Try the following rune:</text>
</object>
<object id="5">
<ocn>5</ocn>
<text class="indent_bullet"> sisu -W</text>
</object>
<object id="6">
<ocn>6</ocn>
<text class="norm">This should start the ruby webserver. It should be done after having produced some output as it scans the output directory for what to serve.</text>
</object>
</content>
</contents2>
<contents2>
<heading>
<object id="7">
<ocn>7</ocn>
<nametag>1.2</nametag>
<text>1.2 I cannot find my output, where is it?</text>
</object>
</heading>
<content>
<object id="8">
<ocn>8</ocn>
<text class="norm">The following should provide help on output paths:</text>
</object>
<object id="9">
<ocn>9</ocn>
<text class="indent_bullet"> sisu --help env</text>
</object>
<object id="10">
<ocn>10</ocn>
<text class="indent_bullet"> sisu -V [same as the previous command]</text>
</object>
<object id="11">
<ocn>11</ocn>
<text class="indent_bullet"> sisu --help directory</text>
</object>
<object id="12">
<ocn>12</ocn>
<text class="indent_bullet"> sisu --help path</text>
</object>
<object id="13">
<ocn>13</ocn>
<text class="indent_bullet"> sisu -U [filename]</text>
</object>
<object id="14">
<ocn>14</ocn>
<text class="indent_bullet"> man sisu</text>
</object>
</content>
</contents2>
<contents2>
<heading>
<object id="15">
<ocn>15</ocn>
<nametag>1.3</nametag>
<text>1.3 I do not get any pdf output, why?</text>
</object>
</heading>
<content>
<object id="16">
<ocn>16</ocn>
<text class="norm"><b>SiSU</b> produces LaTeX and pdflatex is run against that to generate pdf files.</text>
</object>
<object id="17">
<ocn>17</ocn>
<text class="norm">If you use <b>Debian</b> the following will install the required dependencies</text>
</object>
<object id="18">
<ocn>18</ocn>
<text class="indent_bullet"> aptitude install sisu-pdf</text>
</object>
<object id="19">
<ocn>19</ocn>
<text class="norm">the following packages are required: tetex-bin, tetex-extra, latex-ucs</text>
</object>
</content>
</contents2>
<contents2>
<heading>
<object id="20">
<ocn>20</ocn>
<nametag>1.4</nametag>
<text>1.4 Where is the latex (or some other interim) output?</text>
</object>
</heading>
<content>
<object id="21">
<ocn>21</ocn>
<text class="norm">Try adding -M (for maintenance) to your command flags, e.g.:</text>
</object>
<object id="22">
<ocn>22</ocn>
<text class="indent_bullet"> sisu -HpMv [filename]</text>
</object>
<object id="23">
<ocn>23</ocn>
<text class="norm">this should result in the interim processing output being retained, and information being provided on where to find it.</text>
</object>
<object id="24">
<ocn>24</ocn>
<text class="indent_bullet"> sisu --help directory</text>
</object>
<object id="25">
<ocn>25</ocn>
<text class="indent_bullet"> sisu --help path</text>
</object>
<object id="26">
<ocn>26</ocn>
<text class="norm">should also provide some relevant information as to where it is placed.</text>
</object>
</content>
</contents2>
<contents2>
<heading>
<object id="27">
<ocn>27</ocn>
<nametag>1.5</nametag>
<text>1.5 Why isn't SiSU markup XML</text>
</object>
</heading>
<content>
<object id="28">
<ocn>28</ocn>
<text class="norm">I worked with text and (though I find XML immensely valuable) disliked noise ... better to sidestep the question and say:</text>
</object>
<object id="29">
<ocn>29</ocn>
<text class="norm"><b>SiSU</b> currently "understands" three XML input representations - or more accurately, converts from three forms of XML to native <b>SiSU</b> markup for processing. The three types correspond to SAX (structure described), DOM (structure embedded, whole document must be read before structure is correctly discernable) and node based (a tree) forms of XML document structure representation. Problem is I use them very seldom and check that all is as it should be with them seldom, so I would not be surprised if something breaks there, but as far as I know they are working. I will check and add an XML markup help page before the next release. There already is a bit of information in the man page under the title <b>SiSU</b> VERSION CONVERSION</text>
</object>
<object id="30">
<ocn>30</ocn>
<text class="indent1"> sisu --to-sax [filename/wildcard]</text>
</object>
<object id="31">
<ocn>31</ocn>
<text class="indent1"> sisu --to-dom [filename/wildcard]</text>
</object>
<object id="32">
<ocn>32</ocn>
<text class="indent1"> sisu --to-node [filename/wildcard]</text>
</object>
<object id="33">
<ocn>33</ocn>
<text class="norm">The XML should be well formed... must check, but lacks sensible headers. Suggestions welcome as to what to make of them. [For the present time I am satisfied that I can convert (both ways) between 3 forms of XML representation and <b>SiSU</b> markup].</text>
</object>
<object id="34">
<ocn>34</ocn>
<text class="indent1"> sisu --from-xml2sst [filename/wildcard]</text>
</object>
</content>
</contents2>
<contents2>
<heading>
<object id="35">
<ocn>35</ocn>
<nametag>1.6</nametag>
<text>1.6 LaTeX claims to be a document preparation system for high-quality typesetting. Can the same be said about SiSU?</text>
</object>
</heading>
<content>
<object id="36">
<ocn>36</ocn>
<text class="norm"><b>SiSU</b> is not really about type-setting.</text>
</object>
<object id="37">
<ocn>37</ocn>
<text class="norm">LaTeX is the ultimate computer instruction type-setting language for paper based publication.</text>
</object>
<object id="38">
<ocn>38</ocn>
<text class="norm">LaTeX is able to control just about everything that happens on page and pixel, position letters kerning, space variation between characters, words, paragraphs etc. formula.</text>
</object>
<object id="39">
<ocn>39</ocn>
<text class="norm"><b>SiSU</b> is not really about type-setting at all. It is about a lightweight markup instruction that provides enough information for an abstraction of the documents structure and objects, from which different forms of representation of the document can be generated.</text>
</object>
<object id="40">
<ocn>40</ocn>
<text class="norm"><b>SiSU</b> with very little markup instruction is able to produce relatively high quality pdf by virtue of being able to generate usable default LaTeX; it produces "quality" html by generating the html directly; likewise it populates an SQL database in a useful way with the document in object sized chunks and its meta-data. But <b>SiSU</b> works on an abstraction of the document's structure and content and custom builds suitable uniform output. The html for browser viewing and pdf for paper viewing/publishing are rather different things with different needs for layout - as indeed is what is needed to store information in a database in searchable objects.</text>
</object>
<object id="41">
<ocn>41</ocn>
<text class="norm">The pdfs or html produced for example by open office based on open document format and other office/word processor suits usually attempt to have similar looking outputs - your document rendered in html looks much the same, or in pdf... sisu is less this way, it seeks to have a starting point with as little information about appearance as possible, and to come up with the best possible appearance for each output that can be derived based on this minimal information.</text>
</object>
<object id="42">
<ocn>42</ocn>
<text class="norm">Where there are large document sets, it provides consistency in appearance in each output format for the documents.</text>
</object>
<object id="43">
<ocn>43</ocn>
<text class="norm">The excuse for going this way is, it is a waste of time to think much about appearance when working on substantive content, it is the substantive content that is relevant, not the way it looks beyond the basic informational tags - and yet you want to be able to take advantage of as many useful different ways of representing documents as are available, and for various types of output to to be/look as good as it can for each medium/format in which it is presented, (with different mediums having different focuses) and <b>SiSU</b> tries to achieve this from minimal markup.</text>
</object>
</content>
</contents2>
<contents2>
<heading>
<object id="44">
<ocn>44</ocn>
<nametag>1.7</nametag>
<text>1.7 How do I create GIN or GiST index in Postgresql for use in SiSU</text>
</object>
</heading>
<content>
<object id="45">
<ocn>45</ocn>
<text class="norm">This at present needs to be done "manually" and it is probably necessary to alter the sample search form. The following is a helpful response from one of the contributors of GiN to Postgresql Oleg Bartunov 2006-12-06:</text>
</object>
<object id="46">
<ocn>46</ocn>
<text class="norm">"I have tsearch2 slides which introduces tsearch2 <<link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:type="simple" xlink:href="http://www.sai.msu.su/~megera/wiki/tsearch2slides">http://www.sai.msu.su/~megera/wiki/tsearch2slides</link>></text>
</object>
<object id="47">
<ocn>47</ocn>
<text class="norm">FTS in PostgreSQL is provided by tsearch2, which should works without any indices (GiST or GIN) ! Indices provide performance, not functionality.</text>
</object>
<object id="48">
<ocn>48</ocn>
<text class="norm">In your example I'd do ( simple way, just for demo):</text>
</object>
<object id="49">
<ocn>49</ocn>
<text class="norm"><b>0.</b> compile, install tsearch2 and load tsearch2 into your database</text>
</object>
<object id="50">
<ocn>50</ocn>
<text class="indent1"> cd contrib/tsearch2; make&&make&&install&&make installcheck; psql DB < tsearch2.sql</text>
</object>
<object id="51">
<ocn>51</ocn>
<text class="norm"><b>1.</b> Add column fts, which holds tsvector</text>
</object>
<object id="52">
<ocn>52</ocn>
<text class="indent1"> alter table documents add column fts tsvector;</text>
</object>
<object id="53">
<ocn>53</ocn>
<text class="norm"><b>2.</b> Fill fts column</text>
</object>
<object id="54">
<ocn>54</ocn>
<text class="indent1"> update document set fts = to_tsvector(clean);</text>
</object>
<object id="55">
<ocn>55</ocn>
<text class="norm"><b>3.</b> create index - just for performance !</text>
</object>
<object id="56">
<ocn>56</ocn>
<text class="indent1"> create index fts_gin_idx on document using gin(fts);</text>
</object>
<object id="57">
<ocn>57</ocn>
<text class="norm"><b>4.</b> Run vacuum</text>
</object>
<object id="58">
<ocn>58</ocn>
<text class="indent1"> vacuum analyze document;</text>
</object>
<object id="59">
<ocn>59</ocn>
<text class="norm">That's all.</text>
</object>
<object id="60">
<ocn>60</ocn>
<text class="norm">Now you can search:</text>
</object>
<object id="61">
<ocn>61</ocn>
<text class="norm">select lid, metadata_tid, rank_cd(fts, q,2)as rank from document, plainto_tsquery('markup syntax') q where q @@ fts order by rank desc limit 10;</text>
</object>
</content>
</contents2>
<contents2>
<heading>
<object id="62">
<ocn>62</ocn>
<nametag>1.8</nametag>
<text>1.8 Where is version 1.0?</text>
</object>
</heading>
<content>
<object id="63">
<ocn>63</ocn>
<text class="norm"><b>SiSU</b> works pretty well as it is supposed to. Version 1.0 will have the current markup, and directory structure. At this point it is largely a matter of choice as to when the name change is made.</text>
</object>
<object id="64">
<ocn>64</ocn>
<text class="norm">The feature set for html,<endnote><number>1</number><note>html w3c compliance has been largely met.</note></endnote> LaTeX/pdf and opendocument is in place. XML, and plaintext are in order.</text>
</object>
<object id="65">
<ocn>65</ocn>
<text class="norm">html and LaTeX/pdf may be regarded as reference copy outputs</text>
</object>
<object id="66">
<ocn>66</ocn>
<text class="norm">With regard to the populating of sql databases (postgresql and sqlite), there is a bit to be done.</text>
</object>
<object id="67">
<ocn>67</ocn>
<text class="norm">We are still almost there.</text>
</object>
</content>
</contents2>
</contents1>
<contents1>
<heading>
<object id="0">
<ocn>0</ocn>
<nametag>endnotes</nametag>
<text>Endnotes</text>
</object>
</heading>
<content>
</content>
</contents1>
</heading1>
</body>
</document>
|
