aboutsummaryrefslogtreecommitdiffhomepage
path: root/data/doc/manuals_generated/sisu_manual/sisu_quickstart/plain.txt
blob: dd8873ef39f539461e64cf353dff9a33f27568d4 (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
SISU - QUICKSTART, INSTALLATION AND USE,
RALPH AMISSAH
*******************************************************

QUICKSTART - SISU INSTALLATION AND USE
======================================

1. QUICKSTART - GETTING STARTED HOWTO
-------------------------------------

1.1 INSTALLATION
................

Installation is currently most straightforward and tested on the *Debian*
platform, as there are packages for the installation of sisu and all
requirements for what it does.


1.1.1 DEBIAN INSTALLATION
.........................

*SiSU* is available directly from the *Debian* Sid and testing archives (and
possibly Ubuntu), assuming your /etc/apt/sources.list is set accordingly:



    aptitude update
    aptitude install sisu-complete

The following /etc/apt/sources.list setting permits the download of additional
markup samples:



  #/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

The aptitude commands become:



    aptitude update
    aptitude install sisu-complete sisu-markup-samples

If there are newer versions of *SiSU* upstream of the *Debian* archives, they
will be available by adding the following to your /etc/apt/sources.list



  #/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

repeat the aptitude commands



    aptitude update
    aptitude install sisu-complete sisu-markup-samples

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.


1.1.2 RPM INSTALLATION
......................

RPMs are provided though untested, they are prepared by running alien against
the source package, and against the debs.


They may be downloaded from:


  <http://www.jus.uio.no/sisu/SiSU/download.html#rpm>


as root type:


  rpm -i [rpm package name]


1.1.3 INSTALLATION FROM SOURCE
..............................

To install *SiSU* from source check information at:


  <http://www.jus.uio.no/sisu/SiSU/download.html#current>


* download the source package


* Unpack the source


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:


For basic use *SiSU* is only dependent on the programming language in which it
is written *Ruby*, and *SiSU* 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.


- [1]: There is nothing to stop MySQL support being added in future.

*setup.rb*


This is a standard ruby installer, using setup.rb is a three step process. In
the root directory of the unpacked *SiSU* as root type:



      ruby setup.rb config
      ruby setup.rb setup
      #[and as root:]
      ruby setup.rb install

further information on setup.rb is available from:


  <http://i.loveruby.net/en/projects/setup/>


  <http://i.loveruby.net/en/projects/setup/doc/usage.html>


*"install"*


The "install" file provided is an installer prepared using "rant". In the root
directory of the unpacked *SiSU* as root type:


  ruby install base


or for a more complete installation:


  ruby install


or


  ruby install base


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.


Further information on "rant" is available from:


  <http://make.rubyforge.org/>


  <http://rubyforge.org/frs/?group_id=615>


For a list of alternative actions you may type:


  ruby install help


  ruby install -T


1.2 TESTING SISU, GENERATING OUTPUT
...................................

To check which version of sisu is installed:


sisu -v


Depending on your mode of installation one or a number of markup sample files
may be found either in the directory:


...


or


...


change directory to the appropriate one:


cd /usr/share/doc/sisu/sisu_markup_samples/dfsg


1.2.1 BASIC TEXT, PLAINTEXT, HTML, XML, ODF
...........................................

Having moved to the directory that contains the markup samples (see
instructions above if necessary), choose a file and run sisu against it


sisu -NhwoabxXyv free_as_in_freedom.rms_and_free_software.sam_williams.sst


this will generate html including a concordance file, opendocument text format,
plaintext, XHTML and various forms of XML, and OpenDocument text


1.2.2 LATEX / PDF
.................

Assuming a LaTeX engine such as tetex or texlive is installed with the required
modules (done automatically on selection of sisu-pdf in *Debian*)


Having moved to the directory that contains the markup samples (see
instructions above if necessary), choose a file and run sisu against it


sisu -pv free_as_in_freedom.rms_and_free_software.sam_williams.sst


sisu -3 free_as_in_freedom.rms_and_free_software.sam_williams.sst


should generate most available output formats: html including a concordance
file, opendocument text format, plaintext, XHTML and various forms of XML, and
OpenDocument text and pdf


1.2.3 RELATIONAL DATABASE - POSTGRESQL, SQLITE
..............................................

Relational databases need some setting up - you must have permission to create
the database and write to it when you run sisu.


Assuming you have the database installed and the requisite permissions


sisu --sqlite --recreate


sisu --sqlite -v --import
free_as_in_freedom.rms_and_free_software.sam_williams.sst


sisu --pgsql --recreate


sisu --pgsql -v --import
free_as_in_freedom.rms_and_free_software.sam_williams.sst


1.3 GETTING HELP
................

1.3.1 THE MAN PAGES
...................

Type:


  man sisu


The man pages are also available online, though not always kept as up to date
as within the package itself:


* sisu.1 [link:] <http://www.jus.uio.no/sisu/man/sisu.1> [^2]


- [2]: <http://www.jus.uio.no/sisu/man/sisu.1>

* sisu.8 [link:] <http://www.jus.uio.no/sisu/man/sisu.8> [^3]


- [3]: <http://www.jus.uio.no/sisu/man/sisu.8>

* man directory [link:] <http://www.jus.uio.no/sisu/man> [^4]


- [4]: <http://www.jus.uio.no/sisu/man>

1.3.2 BUILT IN HELP
...................

sisu --help


sisu --help --env


sisu --help --commands


sisu --help --markup


1.3.3 THE HOME PAGE
...................

<http://www.jus.uio.no/sisu>


<http://www.jus.uio.no/sisu/SiSU>


1.4 MARKUP SAMPLES
..................

A number of markup samples (along with output) are available off:


<http://www.jus.uio.no/sisu/SiSU/2.html>


Additional markup samples are packaged separately in the file:


***


On *Debian* 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.


- [5]: the *Debian* Free Software guidelines require that everything distributed
 within *Debian* can be changed - and the documents are authors' works that
 while freely distributable are not freely changeable.

DOCUMENT INFORMATION (METADATA)
*******************************

METADATA
--------

Document Manifest @
<http://www.jus.uio.no/sisu/sisu_manual/sisu_quickstart/sisu_manifest.html>


*Dublin Core* (DC)


/DC tags included with this document are provided here./


DC Title: _SiSU - Quickstart, installation and use_


DC Creator: _Ralph Amissah_


DC Rights: _Copyright (C) Ralph Amissah 2007, part of SiSU documentation,
License GPL 3_


DC Type: _information_


DC Date created: _2006-09-06_


DC Date available: _2006-09-06_


DC Date issued: _2006-09-06_


DC Date modified: _2007-09-16_


DC Date: _2007-09-16_


*Version Information*


Sourcefile: _sisu_quickstart.sst_


Filetype: _SiSU text 0.57_


Sourcefile Digest, MD5(sisu_quickstart.sst)= _e76db98ca0d8c2bfe526dad55622fa7a_


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)=
_20fc43cf3eb6590bc3399a1aef65c5a9_


*Generated*


Document (metaverse) last generated: _Mon Sep 24 15:34:06 +0100 2007_


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]_



==============================================================================

	title:  SiSU - Quickstart, installation and use

	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





==============================================================================
nil

Other versions of this document:
manifest:
   http://www.jus.uio.no/sisu/sisu_quickstart/sisu_manifest.html
html:
   http://www.jus.uio.no/sisu/sisu_quickstart/toc.html
pdf:
   http://www.jus.uio.no/sisu/sisu_quickstart/portrait.pdf
   http://www.jus.uio.no/sisu/sisu_quickstart/landscape.pdf
plaintext (plain text):
   http://www.jus.uio.no/sisu/sisu_quickstart/plain.txt
at:
   http://www.jus.uio.no/sisu
* 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: Mon Sep 24 15:34:07 +0100 2007
* SiSU http://www.jus.uio.no/sisu