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
|
<!-- manual page source format generated by PolyglotMan v3.2, -->
<!-- available at http://polyglotman.sourceforge.net/ -->
<html>
<head>
<title>"sisu_quickstart"("1") manual page</title>
</head>
<body bgcolor='white'>
<a href='#toc'>Table of Contents</a><p>
SISU - SISU INFORMATION STRUCTURING UNIVERSE / STRUCTURED INFORMATION, SERIALIZED
UNITS - QUICKSTART, INSTALLATION AND USE, RALPH AMISSAH
<p> QUICKSTART - SISU
INSTALLATION AND USE
<p> 1. QUICKSTART - GETTING STARTED HOWTO
<p> 1.1 INSTALLATION
<p> Installation is currently most straightforward and tested on the <b>Debian</b>
platform, as there are packages for the installation of sisu and all requirements
for what it does.
<p> 1.1.1 DEBIAN INSTALLATION
<p> <b>SiSU</b> is available directly
from the <b>Debian</b> Sid and testing archives (and possibly Ubuntu), assuming
your /etc/apt/sources.list is set accordingly:
<p>
<p> <br>
<pre> aptitude update
aptitude install sisu-complete
</pre>
<p> The following /etc/apt/sources.list setting permits the download of additional
markup samples:
<p>
<p> <br>
<pre> #/etc/apt/sources.list
deb http://ftp.fi.debian.org/debian/ unstable main non-free contrib
deb-src http://ftp.fi.debian.org/debian/ unstable main non-free contrib
d
</pre>
<p> The aptitude commands become:
<p>
<p> <br>
<pre> aptitude update
aptitude install sisu-complete sisu-markup-samples
</pre>
<p> If there are newer versions of <b>SiSU</b> upstream of the <b>Debian</b> archives,
<p>they will be available by adding the following to your /etc/apt/sources.list
<p>
<p> <br>
<pre> #/etc/apt/sources.list
deb http://www.jus.uio.no/sisu/archive unstable main non-free
deb-src http://www.jus.uio.no/sisu/archive unstable main non-free
</pre>
<p> repeat the aptitude commands
<p>
<p> <br>
<pre> aptitude update
aptitude install sisu-complete sisu-markup-samples
</pre>
<p> Note however that it is not necessary to install sisu-complete if not
all components of sisu are to be used. Installing just the package sisu
will provide basic functionality.
<p> 1.1.2 RPM INSTALLATION
<p> RPMs are provided
though untested, they are prepared by running alien against the source
package, and against the debs.
<p> They may be downloaded from:
<p> <<a href='http://www.jus.uio.no/sisu/SiSU/download.html#rpm'>http://www.jus.uio.no/sisu/SiSU/download.html#rpm</a>
><br>
<p> as root type:
<p> rpm -i [rpm package name]<br>
<p> 1.1.3 INSTALLATION FROM SOURCE
<p> To install <b>SiSU</b> from source check information
at:
<p> <<a href='http://www.jus.uio.no/sisu/SiSU/download.html#current'>http://www.jus.uio.no/sisu/SiSU/download.html#current</a>
><br>
<p> * download the source package
<p> * Unpack the source
<p> Two alternative
modes of installation from source are provided, setup.rb (by Minero Aoki)
and a rant(by Stefan Lang) built install file, in either case: the first
steps are the same, download and unpack the source file:
<p> For basic use
<b>SiSU</b> is only dependent on the programming language in which it is written
<b>Ruby</b> , and <b>SiSU</b> will be able to generate html, various XMLs, including
ODF (and will also produce LaTeX). Dependencies required for further actions,
though it relies on the installation of additional dependencies which the
source tarball does not take care of, for things like using a database
(postgresql or sqlite)[^1] or converting LaTeX to pdf.
<p> <b>setup.rb</b>
<p> This is
a standard ruby installer, using setup.rb is a three step process. In the
root directory of the unpacked <b>SiSU</b> as root type:
<p>
<p> <br>
<pre> ruby setup.rb config
ruby setup.rb setup
#[and as root:]
ruby setup.rb install
</pre>
<p> further information on setup.rb is available from:
<p> <<a href='http://i.loveruby.net/en/projects/setup/'>http://i.loveruby.net/en/projects/setup/</a>
><br>
<p> <<a href='http://i.loveruby.net/en/projects/setup/doc/usage.html'>http://i.loveruby.net/en/projects/setup/doc/usage.html</a>
><br>
<p> <b></b>
<p> The root directory of the unpacked <b>SiSU</b> as root type:
<p> ruby install
base<br>
<p> or for a more complete installation:
<p> ruby install<br>
<p> or
<p> ruby install base<br>
<p> This makes use of Rant (by Stefan Lang) and the provided Rantfile. It
has been configured to do post installation setup setup configuration and
generation of first test file. Note however, that additional external package
dependencies, such as tetex-extra are not taken care of for you.
<p> Further
<p>information on
<p> <<a href='http://make.rubyforge.org/'>http://make.rubyforge.org/</a>
><br>
<p> <<a href='http://rubyforge.org/frs/?group_id=615'>http://rubyforge.org/frs/?group_id=615</a>
><br>
<p> For a list of alternative actions you may type:
<p> ruby install help<br>
<p> ruby install -T<br>
<p> 1.2 TESTING SISU, GENERATING OUTPUT
<p> To check which version of sisu is
installed:
<p> sisu -v
<p> Depending on your mode of installation one or a number
of markup sample files may be found either in the directory:
<p>
<p> or
<p>
<p> change directory to the appropriate one:
<p> cd /usr/share/doc/sisu/sisu_markup_samples/dfsg
<p> 1.2.1 BASIC TEXT, PLAINTEXT, HTML, XML, ODF
<p> Having moved to the directory
that contains the markup samples (see instructions above if necessary),
<p>choose a file and run sisu against it
<p> sisu -NhwoabxXyv free_as_in_freedom.rms_and_free_software.sam_williams.sst
<p> this will generate html including a concordance file, opendocument text
format, plaintext, XHTML and various forms of XML, and OpenDocument text
<p> 1.2.2 LATEX / PDF
<p> Assuming a LaTeX engine such as tetex or texlive is
installed with the required modules (done automatically on selection of
sisu-pdf in <b>Debian</b> )
<p> Having moved to the directory that contains the markup
samples (see instructions above if necessary), choose a file and run sisu
<p>against it
<p> sisu -pv free_as_in_freedom.rms_and_free_software.sam_williams.sst
<p> sisu -3 free_as_in_freedom.rms_and_free_software.sam_williams.sst
<p> should
generate most available output formats: html including a concordance file,
opendocument text format, plaintext, XHTML and various forms of XML, and
<p>OpenDocument text and pdf
<p> 1.2.3 RELATIONAL DATABASE - POSTGRESQL, SQLITE
<p> Relational databases need some setting up - you must have permission to
create the database and write to it when you run sisu.
<p> Assuming you have
<p>the database installed and the requisite permissions
<p> sisu --sqlite --recreate
<p> sisu --sqlite -v --import free_as_in_freedom.rms_and_free_software.sam_williams.sst
<p> sisu --pgsql --recreate
<p> sisu --pgsql -v --import free_as_in_freedom.rms_and_free_software.sam_williams.sst
<p> 1.3 GETTING HELP
<p> 1.3.1 THE MAN PAGES
<p> Type:
<p> man sisu<br>
<p> The man pages are also available online, though not always kept as up
to date as within the package itself:
<p> * sisu.1 <<a href='http://www.jus.uio.no/sisu/man/sisu.1'>http://www.jus.uio.no/sisu/man/sisu.1</a>
>
[^2]
<p> * sisu.8 <<a href='http://www.jus.uio.no/sisu/man/sisu.8'>http://www.jus.uio.no/sisu/man/sisu.8</a>
> [^3]
<p> * man directory <<a href='http://www.jus.uio.no/sisu/man'>http://www.jus.uio.no/sisu/man</a>
>
[^4]
<p> 1.3.2 BUILT IN HELP
<p> sisu --help
<p> sisu --help --env
<p> sisu --help --commands
<p> sisu --help --markup
<p> 1.3.3 THE HOME PAGE
<p> <<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a>
>
<p> <<a href='http://www.jus.uio.no/sisu/SiSU'>http://www.jus.uio.no/sisu/SiSU</a>
>
<p> 1.4 MARKUP SAMPLES
<p> A number of markup samples (along with output) are
available off:
<p> <<a href='http://www.jus.uio.no/sisu/SiSU/2.html'>http://www.jus.uio.no/sisu/SiSU/2.html</a>
>
<p> Additional markup
samples are packaged separately in the file:
<p> <b>*</b>
<p> On <b>Debian</b> they are available
in non-free[^5] to include them it is necessary to include non-free in your
/etc/apt/source.list or obtain them from the sisu home site.
<p> DOCUMENT INFORMATION
(METADATA)
<p> METADATA
<p> Document Manifest @ <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_quickstart/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_quickstart/sisu_manifest.html</a>
>
<p> <b>Dublin Core</b> (DC)
<p> <i>DC</i> tags included with this document are provided here.
<p> DC Title: <i>SiSU</i> - SiSU information Structuring Universe / Structured information,
Serialized Units - Quickstart, installation and use
<p> DC Creator: <i>Ralph</i>
<p>Amissah
<p> DC Rights: <i>Copyright</i> (C) Ralph Amissah 2007, part of SiSU documentation,
<p>License GPL 3
<p> DC Type: <i>information</i>
<p> DC Date created: <i>2006-09-06</i>
<p> DC Date
available: <i>2006-09-06</i>
<p> DC Date issued: <i>2006-09-06</i>
<p> DC Date modified: <i>2007-09-16</i>
<p> DC Date: <i>2007-09-16</i>
<p> <b>Version Information</b>
<p> Sourcefile: <i>sisu_quickstart.sst</i>
<p> Filetype: <i>SiSU</i> text 0.57
<p> Sourcefile Digest, MD5(sisu_quickstart.sst)=
<p><i>05a047fd659fbbeaa3cdb982b5911bcd</i>
<p> Skin_Digest: MD5(/home/ralph/grotto/theatre/dbld/sisu-dev/sisu/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/skin/doc/skin_sisu_manual.rb)=
<p><i>20fc43cf3eb6590bc3399a1aef65c5a9</i>
<p> <b>Generated</b>
<p> Document (metaverse) last
generated: <i>Sun</i> Sep 23 01:14:00 +0100 2007
<p> Generated by: <i>SiSU</i> <i>0.58.3</i> of
2007w36/4 (2007-09-06)
<p> Ruby version: <i>ruby</i> 1.8.6 (2007-06-07 patchlevel 36)
[i486-linux]
<p>
<ol>
<b>.</b><li>There is nothing to stop MySQL support being added in future.
</li><b>.</b><li><<a href='http://www.jus.uio.no/sisu/man/sisu.1'>http://www.jus.uio.no/sisu/man/sisu.1</a>
> </li><b>.</b><li><<a href='http://www.jus.uio.no/sisu/man/sisu.8'>http://www.jus.uio.no/sisu/man/sisu.8</a>
> </li><b>.</b><li><<a href='http://www.jus.uio.no/sisu/man'>http://www.jus.uio.no/sisu/man</a>
>
</li><b>.</b><li>the <b>Debian</b> Free Software guidelines require that everything distributed
within <b>Debian</b> can be changed - and the documents are authors’ works that
while freely distributable are not freely changeable.
<p> </dd>
<dt>Other versions of
this document: </dt>
<dd></dd>
<dt>manifest: <<a href='http://www.jus.uio.no/sisu/sisu_quickstart/sisu_manifest.html'><a href='http://www.jus.uio.no/sisu/sisu_quickstart/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_quickstart/sisu_manifest.html</a>
</a>
>
</dt>
<dd></dd>
<dt>html: <<a href='http://www.jus.uio.no/sisu/sisu_quickstart/toc.html'><a href='http://www.jus.uio.no/sisu/sisu_quickstart/toc.html'>http://www.jus.uio.no/sisu/sisu_quickstart/toc.html</a>
</a>
> </dt>
<dd></dd>
<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_quickstart/portrait.pdf'><a href='http://www.jus.uio.no/sisu/sisu_quickstart/portrait.pdf'>http://www.jus.uio.no/sisu/sisu_quickstart/portrait.pdf</a>
</a>
>
</dt>
<dd></dd>
<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_quickstart/landscape.pdf'><a href='http://www.jus.uio.no/sisu/sisu_quickstart/landscape.pdf'>http://www.jus.uio.no/sisu/sisu_quickstart/landscape.pdf</a>
</a>
> </dt>
<dd> </dd>
<dt>at: <<a href='http://www.jus.uio.no/sisu'><a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a>
</a>
>
</dt>
<dd></dd>
<dt>* Generated by: SiSU 0.58.3 of 2007w36/4 (2007-09-06) </dt>
<dd></dd>
<dt>* Ruby version: ruby
1.8.6 (2007-06-07 patchlevel 36) [i486-linux] </dt>
<dd></dd>
<dt>* Last Generated on: Sun Sep 23
01:14:06 +0100 2007 </dt>
<dd></dd>
<dt>* SiSU <a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a>
</dt>
<dd></dd>
</dl>
<p>
</body>
</html>
|
