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
|
% SiSU 0.57
@title: SiSU
@subtitle: FAQ - Frequently Asked/Answered Questions
@creator: Ralph Amissah
@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: 2006-09-06
@date.available: 2006-09-06
@date.issued: 2006-09-06
@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/
% @rcs: $Id$
:A~? @title @creator
1~faq FAQ - Frequently Asked/Answered Questions
2~ Why are urls produced with the -v (and -u) flag that point to a web server on port 8081 ?
Try the following rune:
_* sisu -W
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.
2~ I cannot find my output, where is it?
The following should provide help on output paths:
_* sisu --help env
_* sisu -V [same as the previous command]
_* sisu --help directory
_* sisu --help path
_* sisu -U [filename]
_* man sisu
2~ I do not get any pdf output, why?
SiSU produces LaTeX and pdflatex is run against that to generate pdf files.
If you use Debian the following will install the required dependencies
_* aptitude install sisu-pdf
the following packages are required: tetex-bin, tetex-extra, latex-ucs
2~ Where is the latex (or some other interim) output?
Try adding -M (for maintenance) to your command flags, e.g.:
_* sisu -HpMv [filename]
this should result in the interim processing output being retained, and information being provided on where to find it.
_* sisu --help directory
_* sisu --help path
should also provide some relevant information as to where it is placed.
2~ Why isn't SiSU markup XML
I worked with text and (though I find XML immensely valuable) disliked noise
... better to sidestep the question and say:
SiSU currently "understands" three XML input representations - or more accurately, converts from three forms of XML to native SiSU 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 SiSU VERSION CONVERSION
_1 sisu --to-sax [filename/wildcard]
_1 sisu --to-dom [filename/wildcard]
_1 sisu --to-node [filename/wildcard]
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 SiSU markup].
_1 sisu --from-xml2sst [filename/wildcard]
2~ LaTeX claims to be a document preparation system for high-quality typesetting. Can the same be said about SiSU?
% what are some similarities and differences between LaTex and SiSU?
SiSU is not really about type-setting.
LaTeX is the ultimate computer instruction type-setting language for paper based publication.
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.
SiSU 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.
SiSU 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 SiSU 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.
% SiSU is a lightweight document abstraction, meta-(structure and markup) syntax designed to make use of a minimal amount of preparation detail that can be used across very different ways of representing documents
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.
Where there are large document sets, it provides consistency in appearance in each output format for the documents.
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 SiSU tries to achieve this from minimal markup.
2~ How do I create GIN or GiST index in Postgresql for use in SiSU
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:
"I have tsearch2 slides which introduces tsearch2
http://www.sai.msu.su/~megera/wiki/tsearch2slides
FTS in PostgreSQL is provided by tsearch2, which should works without
any indices (GiST or GIN) ! Indices provide performance, not functionality.
In your example I'd do ( simple way, just for demo):
!_ 0.
compile, install tsearch2 and load tsearch2 into your database
_1 cd contrib/tsearch2; make&&make&&install&&make installcheck; psql DB < tsearch2.sql
!_ 1.
Add column fts, which holds tsvector
_1 alter table documents add column fts tsvector;
!_ 2.
Fill fts column
_1 update document set fts = to_tsvector(clean);
!_ 3.
create index - just for performance !
_1 create index fts_gin_idx on document using gin(fts);
!_ 4.
Run vacuum
_1 vacuum analyze document;
That's all.
Now you can search:
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;
2~ Where is version 1.0?
SiSU 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.
The feature set for html,~{ html w3c compliance has been largely met. }~ LaTeX/pdf and opendocument is in place.
XML, and plaintext are in order.
html and LaTeX/pdf may be regarded as reference copy outputs
With regard to the populating of sql databases (postgresql and sqlite), there is a bit to be done.
We are still almost there.
|
