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
|
<?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.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:08 +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 - Quickstart, installation and use
</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 - Quickstart, installation and use,<br /> Ralph Amissah
</text>
<ocn>1</ocn>
</object>
<object id="2">
<text class="h2">
Quickstart - SiSU installation and use
</text>
<ocn>2</ocn>
</object>
<object id="3">
<text class="h4">
1. Quickstart - Getting Started Howto
</text>
<ocn>3</ocn>
</object>
<object id="4">
<text class="h5">
1.1 Installation
</text>
<ocn>4</ocn>
</object>
<object id="5">
<text class="norm">
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.
</text>
<ocn>5</ocn>
</object>
<object id="6">
<text class="h6">
1.1.1 Debian Installation
</text>
<ocn>6</ocn>
</object>
<object id="7">
<text class="norm">
<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:
</text>
<ocn>7</ocn>
</object>
<object id="8">
<ocn>8</ocn>
<text class="code">
   aptitude update<br />   aptitude install sisu-complete    
</text>
</object>
<object id="9">
<text class="norm">
The following /etc/apt/sources.list setting permits the download of
additional markup samples:
</text>
<ocn>9</ocn>
</object>
<object id="10">
<ocn>10</ocn>
<text class="code">
   #/etc/apt/sources.list<br /><br />   deb http://ftp.fi.debian.org/debian/ unstable main non-free contrib<br />   deb-src http://ftp.fi.debian.org/debian/ unstable main non-free contrib<br />   d    
</text>
</object>
<object id="11">
<text class="norm">
The aptitude commands become:
</text>
<ocn>11</ocn>
</object>
<object id="12">
<ocn>12</ocn>
<text class="code">
   aptitude update<br />   aptitude install sisu-complete sisu-markup-samples    
</text>
</object>
<object id="13">
<text class="norm">
If there are newer versions of <b>SiSU</b> upstream of the
<b>Debian</b> archives, they will be available by adding the following
to your /etc/apt/sources.list
</text>
<ocn>13</ocn>
</object>
<object id="14">
<ocn>14</ocn>
<text class="code">
   #/etc/apt/sources.list<br /><br />   deb http://www.jus.uio.no/sisu/archive unstable main non-free<br />   deb-src http://www.jus.uio.no/sisu/archive unstable main non-free    
</text>
</object>
<object id="15">
<text class="norm">
repeat the aptitude commands
</text>
<ocn>15</ocn>
</object>
<object id="16">
<ocn>16</ocn>
<text class="code">
   aptitude update<br />   aptitude install sisu-complete sisu-markup-samples    
</text>
</object>
<object id="17">
<text class="norm">
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.
</text>
<ocn>17</ocn>
</object>
<object id="18">
<text class="h6">
1.1.2 RPM Installation
</text>
<ocn>18</ocn>
</object>
<object id="19">
<text class="norm">
RPMs are provided though untested, they are prepared by running alien
against the source package, and against the debs.
</text>
<ocn>19</ocn>
</object>
<object id="20">
<text class="norm">
They may be downloaded from:
</text>
<ocn>20</ocn>
</object>
<object id="21">
<text class="indent1">
<<link xmlns:xlink="http://www.w3.org/1999/xlink"
xlink:type="simple"
xlink:href="http://www.jus.uio.no/sisu/SiSU/download.html#rpm">http://www.jus.uio.no/sisu/SiSU/download.html#rpm</link>>
</text>
<ocn>21</ocn>
</object>
<object id="22">
<text class="norm">
as root type:
</text>
<ocn>22</ocn>
</object>
<object id="23">
<text class="indent1">
rpm -i [rpm package name]
</text>
<ocn>23</ocn>
</object>
<object id="24">
<text class="h6">
1.1.3 Installation from source
</text>
<ocn>24</ocn>
</object>
<object id="25">
<text class="norm">
To install <b>SiSU</b> from source check information at:
</text>
<ocn>25</ocn>
</object>
<object id="26">
<text class="indent1">
<<link xmlns:xlink="http://www.w3.org/1999/xlink"
xlink:type="simple"
xlink:href="http://www.jus.uio.no/sisu/SiSU/download.html#current">http://www.jus.uio.no/sisu/SiSU/download.html#current</link>>
</text>
<ocn>26</ocn>
</object>
<object id="27">
<text class="indent_bullet">
download the source package
</text>
<ocn>27</ocn>
</object>
<object id="28">
<text class="indent_bullet">
Unpack the source
</text>
<ocn>28</ocn>
</object>
<object id="29">
<text class="norm">
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:
</text>
<ocn>29</ocn>
</object>
<object id="30">
<text class="norm">
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)<en>1</en> or converting LaTeX to pdf.
</text>
<endnote notenumber="1">
1. There is nothing to stop MySQL support being added in future.
</endnote>
<ocn>30</ocn>
</object>
<object id="31">
<text class="norm">
<b>setup.rb</b>
</text>
<ocn>31</ocn>
</object>
<object id="32">
<text class="norm">
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:
</text>
<ocn>32</ocn>
</object>
<object id="33">
<ocn>33</ocn>
<text class="code">
   ruby setup.rb config <br />   ruby setup.rb setup <br />   #[and as root:]<br />   ruby setup.rb install    
</text>
</object>
<object id="34">
<text class="norm">
further information on setup.rb is available from:
</text>
<ocn>34</ocn>
</object>
<object id="35">
<text class="indent1">
<<link xmlns:xlink="http://www.w3.org/1999/xlink"
xlink:type="simple"
xlink:href="http://i.loveruby.net/en/projects/setup/">http://i.loveruby.net/en/projects/setup/</link>>
</text>
<ocn>35</ocn>
</object>
<object id="36">
<text class="indent1">
<<link xmlns:xlink="http://www.w3.org/1999/xlink"
xlink:type="simple"
xlink:href="http://i.loveruby.net/en/projects/setup/doc/usage.html">http://i.loveruby.net/en/projects/setup/doc/usage.html</link>>
</text>
<ocn>36</ocn>
</object>
<object id="37">
<text class="norm">
<b>"install"</b>
</text>
<ocn>37</ocn>
</object>
<object id="38">
<text class="norm">
The "install" file provided is an installer prepared using "rant". In
the root directory of the unpacked <b>SiSU</b> as root type:
</text>
<ocn>38</ocn>
</object>
<object id="39">
<text class="indent1">
ruby install base
</text>
<ocn>39</ocn>
</object>
<object id="40">
<text class="norm">
or for a more complete installation:
</text>
<ocn>40</ocn>
</object>
<object id="41">
<text class="indent1">
ruby install
</text>
<ocn>41</ocn>
</object>
<object id="42">
<text class="norm">
or
</text>
<ocn>42</ocn>
</object>
<object id="43">
<text class="indent1">
ruby install base
</text>
<ocn>43</ocn>
</object>
<object id="44">
<text class="norm">
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.
</text>
<ocn>44</ocn>
</object>
<object id="45">
<text class="norm">
Further information on "rant" is available from:
</text>
<ocn>45</ocn>
</object>
<object id="46">
<text class="indent1">
<<link xmlns:xlink="http://www.w3.org/1999/xlink"
xlink:type="simple"
xlink:href="http://make.rubyforge.org/">http://make.rubyforge.org/</link>>
</text>
<ocn>46</ocn>
</object>
<object id="47">
<text class="indent1">
<<link xmlns:xlink="http://www.w3.org/1999/xlink"
xlink:type="simple"
xlink:href="http://rubyforge.org/frs/?group_id=615">http://rubyforge.org/frs/?group_id=615</link>>
</text>
<ocn>47</ocn>
</object>
<object id="48">
<text class="norm">
For a list of alternative actions you may type:
</text>
<ocn>48</ocn>
</object>
<object id="49">
<text class="indent1">
ruby install help
</text>
<ocn>49</ocn>
</object>
<object id="50">
<text class="indent1">
ruby install -T
</text>
<ocn>50</ocn>
</object>
<object id="51">
<text class="h5">
1.2 Testing SiSU, generating output
</text>
<ocn>51</ocn>
</object>
<object id="52">
<text class="norm">
To check which version of sisu is installed:
</text>
<ocn>52</ocn>
</object>
<object id="53">
<text class="norm">
sisu -v
</text>
<ocn>53</ocn>
</object>
<object id="54">
<text class="norm">
Depending on your mode of installation one or a number of markup sample
files may be found either in the directory:
</text>
<ocn>54</ocn>
</object>
<object id="55">
<text class="norm">
...
</text>
<ocn>55</ocn>
</object>
<object id="56">
<text class="norm">
or
</text>
<ocn>56</ocn>
</object>
<object id="57">
<text class="norm">
...
</text>
<ocn>57</ocn>
</object>
<object id="58">
<text class="norm">
change directory to the appropriate one:
</text>
<ocn>58</ocn>
</object>
<object id="59">
<text class="norm">
cd /usr/share/doc/sisu/sisu_markup_samples/dfsg
</text>
<ocn>59</ocn>
</object>
<object id="60">
<text class="h6">
1.2.1 basic text, plaintext, html, XML, ODF
</text>
<ocn>60</ocn>
</object>
<object id="61">
<text class="norm">
Having moved to the directory that contains the markup samples (see
instructions above if necessary), choose a file and run sisu against it
</text>
<ocn>61</ocn>
</object>
<object id="62">
<text class="norm">
sisu -NhwoabxXyv
free_as_in_freedom.rms_and_free_software.sam_williams.sst
</text>
<ocn>62</ocn>
</object>
<object id="63">
<text class="norm">
this will generate html including a concordance file, opendocument text
format, plaintext, XHTML and various forms of XML, and OpenDocument
text
</text>
<ocn>63</ocn>
</object>
<object id="64">
<text class="h6">
1.2.2 LaTeX / pdf
</text>
<ocn>64</ocn>
</object>
<object id="65">
<text class="norm">
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>)
</text>
<ocn>65</ocn>
</object>
<object id="66">
<text class="norm">
Having moved to the directory that contains the markup samples (see
instructions above if necessary), choose a file and run sisu against it
</text>
<ocn>66</ocn>
</object>
<object id="67">
<text class="norm">
sisu -pv free_as_in_freedom.rms_and_free_software.sam_williams.sst
</text>
<ocn>67</ocn>
</object>
<object id="68">
<text class="norm">
sisu -3 free_as_in_freedom.rms_and_free_software.sam_williams.sst
</text>
<ocn>68</ocn>
</object>
<object id="69">
<text class="norm">
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
</text>
<ocn>69</ocn>
</object>
<object id="70">
<text class="h6">
1.2.3 relational database - postgresql, sqlite
</text>
<ocn>70</ocn>
</object>
<object id="71">
<text class="norm">
Relational databases need some setting up - you must have permission to
create the database and write to it when you run sisu.
</text>
<ocn>71</ocn>
</object>
<object id="72">
<text class="norm">
Assuming you have the database installed and the requisite permissions
</text>
<ocn>72</ocn>
</object>
<object id="73">
<text class="norm">
sisu --sqlite --recreate
</text>
<ocn>73</ocn>
</object>
<object id="74">
<text class="norm">
sisu --sqlite -v --import
free_as_in_freedom.rms_and_free_software.sam_williams.sst
</text>
<ocn>74</ocn>
</object>
<object id="75">
<text class="norm">
sisu --pgsql --recreate
</text>
<ocn>75</ocn>
</object>
<object id="76">
<text class="norm">
sisu --pgsql -v --import
free_as_in_freedom.rms_and_free_software.sam_williams.sst
</text>
<ocn>76</ocn>
</object>
<object id="77">
<text class="h5">
1.3 Getting Help
</text>
<ocn>77</ocn>
</object>
<object id="78">
<text class="h6">
1.3.1 The man pages
</text>
<ocn>78</ocn>
</object>
<object id="79">
<text class="norm">
Type:
</text>
<ocn>79</ocn>
</object>
<object id="80">
<text class="indent1">
man sisu
</text>
<ocn>80</ocn>
</object>
<object id="81">
<text class="norm">
The man pages are also available online, though not always kept as up
to date as within the package itself:
</text>
<ocn>81</ocn>
</object>
<object id="82">
<text class="indent_bullet">
<link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:type="simple"
xlink:href="http://www.jus.uio.no/sisu/man/sisu.1"> sisu.1 </link>
<en>2</en>
</text>
<endnote notenumber="2">
2. <<link xmlns:xlink="http://www.w3.org/1999/xlink"
xlink:type="simple"
xlink:href="http://www.jus.uio.no/sisu/man/sisu.1">http://www.jus.uio.no/sisu/man/sisu.1</link>>
</endnote>
<ocn>82</ocn>
</object>
<object id="83">
<text class="indent_bullet">
<link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:type="simple"
xlink:href="http://www.jus.uio.no/sisu/man/sisu.8"> sisu.8 </link>
<en>3</en>
</text>
<endnote notenumber="3">
3. <<link xmlns:xlink="http://www.w3.org/1999/xlink"
xlink:type="simple"
xlink:href="http://www.jus.uio.no/sisu/man/sisu.8">http://www.jus.uio.no/sisu/man/sisu.8</link>>
</endnote>
<ocn>83</ocn>
</object>
<object id="84">
<text class="indent_bullet">
<link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:type="simple"
xlink:href="http://www.jus.uio.no/sisu/man"> man directory </link>
<en>4</en>
</text>
<endnote notenumber="4">
4. <<link xmlns:xlink="http://www.w3.org/1999/xlink"
xlink:type="simple"
xlink:href="http://www.jus.uio.no/sisu/man">http://www.jus.uio.no/sisu/man</link>>
</endnote>
<ocn>84</ocn>
</object>
<object id="85">
<text class="h6">
1.3.2 Built in help
</text>
<ocn>85</ocn>
</object>
<object id="86">
<text class="norm">
sisu --help
</text>
<ocn>86</ocn>
</object>
<object id="87">
<text class="norm">
sisu --help --env
</text>
<ocn>87</ocn>
</object>
<object id="88">
<text class="norm">
sisu --help --commands
</text>
<ocn>88</ocn>
</object>
<object id="89">
<text class="norm">
sisu --help --markup
</text>
<ocn>89</ocn>
</object>
<object id="90">
<text class="h6">
1.3.3 The home page
</text>
<ocn>90</ocn>
</object>
<object id="91">
<text class="norm">
<<link xmlns:xlink="http://www.w3.org/1999/xlink"
xlink:type="simple"
xlink:href="http://www.jus.uio.no/sisu">http://www.jus.uio.no/sisu</link>>
</text>
<ocn>91</ocn>
</object>
<object id="92">
<text class="norm">
<<link xmlns:xlink="http://www.w3.org/1999/xlink"
xlink:type="simple"
xlink:href="http://www.jus.uio.no/sisu/SiSU">http://www.jus.uio.no/sisu/SiSU</link>>
</text>
<ocn>92</ocn>
</object>
<object id="93">
<text class="h5">
1.4 Markup Samples
</text>
<ocn>93</ocn>
</object>
<object id="94">
<text class="norm">
A number of markup samples (along with output) are available off:
</text>
<ocn>94</ocn>
</object>
<object id="95">
<text class="norm">
<<link xmlns:xlink="http://www.w3.org/1999/xlink"
xlink:type="simple"
xlink:href="http://www.jus.uio.no/sisu/SiSU/2.html">http://www.jus.uio.no/sisu/SiSU/2.html</link>>
</text>
<ocn>95</ocn>
</object>
<object id="96">
<text class="norm">
Additional markup samples are packaged separately in the file:
</text>
<ocn>96</ocn>
</object>
<object id="97">
<text class="norm">
<b>*</b>
</text>
<ocn>97</ocn>
</object>
<object id="98">
<text class="norm">
On <b>Debian</b> they are available in non-free<en>5</en> to include
them it is necessary to include non-free in your /etc/apt/source.list
or obtain them from the sisu home site.
</text>
<endnote notenumber="5">
5. 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.
</endnote>
<ocn>98</ocn>
</object>
<object id="0">
<text class="h4">
Endnotes
</text>
<ocn>0</ocn>
</object>
</body>
</document>
|
