<?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.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>
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta>Title:</meta>
<title class="dc">
SiSU - FAQ - Frequently Asked/Answered Questions
</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">
2006-09-06
</date_created>
<br />
<meta>Date available:</meta>
<date_available class="extra">
2006-09-06
</date_available>
<br />
<meta>Date issued:</meta>
<date_issued class="extra">
2006-09-06
</date_issued>
<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 - FAQ - Frequently Asked/Answered Questions,<br /> Ralph Amissah
</text>
<ocn>1</ocn>
</object>
<object id="2">
<text class="h4">
1. FAQ - Frequently Asked/Answered Questions
</text>
<ocn>2</ocn>
</object>
<object id="3">
<text class="h5">
1.1 Why are urls produced with the -v (and -u) flag that point to a web
server on port 8081?
</text>
<ocn>3</ocn>
</object>
<object id="4">
<text class="norm">
Try the following rune:
</text>
<ocn>4</ocn>
</object>
<object id="5">
<text class="indent_bullet">
sisu -W
</text>
<ocn>5</ocn>
</object>
<object id="6">
<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>
<ocn>6</ocn>
</object>
<object id="7">
<text class="h5">
1.2 I cannot find my output, where is it?
</text>
<ocn>7</ocn>
</object>
<object id="8">
<text class="norm">
The following should provide help on output paths:
</text>
<ocn>8</ocn>
</object>
<object id="9">
<text class="indent_bullet">
sisu --help env
</text>
<ocn>9</ocn>
</object>
<object id="10">
<text class="indent_bullet">
sisu -V [same as the previous command]
</text>
<ocn>10</ocn>
</object>
<object id="11">
<text class="indent_bullet">
sisu --help directory
</text>
<ocn>11</ocn>
</object>
<object id="12">
<text class="indent_bullet">
sisu --help path
</text>
<ocn>12</ocn>
</object>
<object id="13">
<text class="indent_bullet">
sisu -U [filename]
</text>
<ocn>13</ocn>
</object>
<object id="14">
<text class="indent_bullet">
man sisu
</text>
<ocn>14</ocn>
</object>
<object id="15">
<text class="h5">
1.3 I do not get any pdf output, why?
</text>
<ocn>15</ocn>
</object>
<object id="16">
<text class="norm">
<b>SiSU</b> produces LaTeX and pdflatex is run against that to generate
pdf files.
</text>
<ocn>16</ocn>
</object>
<object id="17">
<text class="norm">
If you use <b>Debian</b> the following will install the required
dependencies
</text>
<ocn>17</ocn>
</object>
<object id="18">
<text class="indent_bullet">
aptitude install sisu-pdf
</text>
<ocn>18</ocn>
</object>
<object id="19">
<text class="norm">
the following packages are required: tetex-bin, tetex-extra, latex-ucs
</text>
<ocn>19</ocn>
</object>
<object id="20">
<text class="h5">
1.4 Where is the latex (or some other interim) output?
</text>
<ocn>20</ocn>
</object>
<object id="21">
<text class="norm">
Try adding -M (for maintenance) to your command flags, e.g.:
</text>
<ocn>21</ocn>
</object>
<object id="22">
<text class="indent_bullet">
sisu -HpMv [filename]
</text>
<ocn>22</ocn>
</object>
<object id="23">
<text class="norm">
this should result in the interim processing output being retained, and
information being provided on where to find it.
</text>
<ocn>23</ocn>
</object>
<object id="24">
<text class="indent_bullet">
sisu --help directory
</text>
<ocn>24</ocn>
</object>
<object id="25">
<text class="indent_bullet">
sisu --help path
</text>
<ocn>25</ocn>
</object>
<object id="26">
<text class="norm">
should also provide some relevant information as to where it is placed.
</text>
<ocn>26</ocn>
</object>
<object id="27">
<text class="h5">
1.5 Why isn't SiSU markup XML
</text>
<ocn>27</ocn>
</object>
<object id="28">
<text class="norm">
I worked with text and (though I find XML immensely valuable) disliked
noise ... better to sidestep the question and say:
</text>
<ocn>28</ocn>
</object>
<object id="29">
<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>
<ocn>29</ocn>
</object>
<object id="30">
<text class="indent1">
sisu --to-sax [filename/wildcard]
</text>
<ocn>30</ocn>
</object>
<object id="31">
<text class="indent1">
sisu --to-dom [filename/wildcard]
</text>
<ocn>31</ocn>
</object>
<object id="32">
<text class="indent1">
sisu --to-node [filename/wildcard]
</text>
<ocn>32</ocn>
</object>
<object id="33">
<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>
<ocn>33</ocn>
</object>
<object id="34">
<text class="indent1">
sisu --from-xml2sst [filename/wildcard]
</text>
<ocn>34</ocn>
</object>
<object id="35">
<text class="h5">
1.6 LaTeX claims to be a document preparation system for high-quality
typesetting. Can the same be said about SiSU?
</text>
<ocn>35</ocn>
</object>
<object id="36">
<text class="norm">
<b>SiSU</b> is not really about type-setting.
</text>
<ocn>36</ocn>
</object>
<object id="37">
<text class="norm">
LaTeX is the ultimate computer instruction type-setting language for
paper based publication.
</text>
<ocn>37</ocn>
</object>
<object id="38">
<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>
<ocn>38</ocn>
</object>
<object id="39">
<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>
<ocn>39</ocn>
</object>
<object id="40">
<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>
<ocn>40</ocn>
</object>
<object id="41">
<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>
<ocn>41</ocn>
</object>
<object id="42">
<text class="norm">
Where there are large document sets, it provides consistency in
appearance in each output format for the documents.
</text>
<ocn>42</ocn>
</object>
<object id="43">
<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>
<ocn>43</ocn>
</object>
<object id="44">
<text class="h5">
1.7 How do I create GIN or GiST index in Postgresql for use in SiSU
</text>
<ocn>44</ocn>
</object>
<object id="45">
<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>
<ocn>45</ocn>
</object>
<object id="46">
<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>
<ocn>46</ocn>
</object>
<object id="47">
<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>
<ocn>47</ocn>
</object>
<object id="48">
<text class="norm">
In your example I'd do ( simple way, just for demo):
</text>
<ocn>48</ocn>
</object>
<object id="49">
<text class="norm">
<b>0.</b> compile, install tsearch2 and load tsearch2 into your
database
</text>
<ocn>49</ocn>
</object>
<object id="50">
<text class="indent1">
cd contrib/tsearch2;
make&&make&&install&&make installcheck; psql DB
< tsearch2.sql
</text>
<ocn>50</ocn>
</object>
<object id="51">
<text class="norm">
<b>1.</b> Add column fts, which holds tsvector
</text>
<ocn>51</ocn>
</object>
<object id="52">
<text class="indent1">
alter table documents add column fts tsvector;
</text>
<ocn>52</ocn>
</object>
<object id="53">
<text class="norm">
<b>2.</b> Fill fts column
</text>
<ocn>53</ocn>
</object>
<object id="54">
<text class="indent1">
update document set fts = to_tsvector(clean);
</text>
<ocn>54</ocn>
</object>
<object id="55">
<text class="norm">
<b>3.</b> create index - just for performance !
</text>
<ocn>55</ocn>
</object>
<object id="56">
<text class="indent1">
create index fts_gin_idx on document using gin(fts);
</text>
<ocn>56</ocn>
</object>
<object id="57">
<text class="norm">
<b>4.</b> Run vacuum
</text>
<ocn>57</ocn>
</object>
<object id="58">
<text class="indent1">
vacuum analyze document;
</text>
<ocn>58</ocn>
</object>
<object id="59">
<text class="norm">
That's all.
</text>
<ocn>59</ocn>
</object>
<object id="60">
<text class="norm">
Now you can search:
</text>
<ocn>60</ocn>
</object>
<object id="61">
<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>
<ocn>61</ocn>
</object>
<object id="62">
<text class="h5">
1.8 Where is version 1.0?
</text>
<ocn>62</ocn>
</object>
<object id="63">
<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>
<ocn>63</ocn>
</object>
<object id="64">
<text class="norm">
The feature set for html,<en>1</en> LaTeX/pdf and opendocument is in
place. XML, and plaintext are in order.
</text>
<endnote notenumber="1">
1. html w3c compliance has been largely met.
</endnote>
<ocn>64</ocn>
</object>
<object id="65">
<text class="norm">
html and LaTeX/pdf may be regarded as reference copy outputs
</text>
<ocn>65</ocn>
</object>
<object id="66">
<text class="norm">
With regard to the populating of sql databases (postgresql and sqlite),
there is a bit to be done.
</text>
<ocn>66</ocn>
</object>
<object id="67">
<text class="norm">
We are still almost there.
</text>
<ocn>67</ocn>
</object>
<object id="0">
<text class="h4">
Endnotes
</text>
<ocn>0</ocn>
</object>
</body>
</document>