SiSU

Quickstart, installation and use

Ralph Amissah

SiSU - Quickstart, installation and use,
Ralph Amissah

  1

Quickstart - SiSU installation and use

  2

1. Quickstart - Getting Started Howto

  3

1.1 Installation

  4

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.

  5

1.1.1 Debian Installation

  6

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

  7

    aptitude update
    aptitude install sisu-complete

  8

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

  9

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

  10

The aptitude commands become:

  11

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

  12

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

  13

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

  14

repeat the aptitude commands

  15

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

  16

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.

  17

1.1.2 RPM Installation

  18

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

  19

They may be downloaded from:

  20

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

  21

as root type:

  22

rpm -i [rpm package name]

  23

1.1.3 Installation from source

  24

To install SiSU from source check information at:

  25

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

  26

  27

  28

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:

  29

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)  ¹  or converting LaTeX to pdf.

  30

setup.rb

  31

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:

  32

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

  33

further information on setup.rb is available from:

  34

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

  35

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

  36

"install"

  37

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

  38

ruby install base

  39

or for a more complete installation:

  40

ruby install

  41

or

  42

ruby install base

  43

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.

  44

Further information on "rant" is available from:

  45

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

  46

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

  47

For a list of alternative actions you may type:

  48

ruby install help

  49

ruby install -T

  50

1.2 Testing SiSU, generating output

  51

To check which version of sisu is installed:

  52

sisu -v

  53

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

  54

...

  55

or

  56

...

  57

change directory to the appropriate one:

  58

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

  59

1.2.1 basic text, plaintext, html, XML, ODF

  60

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

  61

sisu -NhwoabxXyv free_as_in_freedom.rms_and_free_software.sam_williams.sst

  62

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

  63

1.2.2 LaTeX / pdf

  64

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

  65

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

  66

sisu -pv free_as_in_freedom.rms_and_free_software.sam_williams.sst

  67

sisu -3 free_as_in_freedom.rms_and_free_software.sam_williams.sst

  68

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

  69

1.2.3 relational database - postgresql, sqlite

  70

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

  71

Assuming you have the database installed and the requisite permissions

  72

sisu --sqlite --recreate

  73

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

  74

sisu --pgsql --recreate

  75

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

  76

1.3 Getting Help

  77

1.3.1 The man pages

  78

Type:

  79

man sisu

  80

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

  81

  82

  83

  84

1.3.2 Built in help

  85

sisu --help

  86

sisu --help --env

  87

sisu --help --commands

  88

sisu --help --markup

  89

1.3.3 The home page

  90

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

  91

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

  92

1.4 Markup Samples

  93

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

  94

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

  95

Additional markup samples are packaged separately in the file:

  96

*

  97

On Debian they are available in non-free  ⁵  to include them it is necessary to include non-free in your /etc/apt/source.list or obtain them from the sisu home site.

  98

Endnotes

  0

 ^1. There is nothing to stop MySQL support being added in future.

 ^2. <http://www.jus.uio.no/sisu/man/sisu.1>

 ^3. <http://www.jus.uio.no/sisu/man/sisu.8>

 ^4. <http://www.jus.uio.no/sisu/man>

 ^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)

  0

<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/builds/sisu/sisu/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/skin/doc/skin_sisu_manual.rb)= 20fc43cf3eb6590bc3399a1aef65c5a9

Generated

Document (metaverse) last generated: Tue Sep 25 02:53:52 +0100 2007

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]

Output generated by SiSU 0.59.1 2007-09-25 (2007w39/2)
SiSU Copyright ^© Ralph Amissah 1997, current 2007. All Rights Reserved.
SiSU is software for document structuring, publishing and search,
www.jus.uio.no/sisu and www.sisudoc.org
w3 since October 3 1993 ralph@amissah.com

SiSU using:
Standard SiSU markup syntax,
Standard SiSU meta-markup syntax, and the
Standard SiSU object citation numbering and system, (object/text positioning system)
Copyright ^© Ralph Amissah 1997, current 2007. All Rights Reserved.

SiSU is released under GPLv3 or later, <http://www.gnu.org/licenses/gpl.html>

SiSU, developed using Ruby on Debian/Gnu/Linux software infrastructure, with the usual GPL (or OSS) suspects.
Better - "performance, reliability, scalability, security & total cost of ownership" [not to mention flexibility & choice] use of and adherence to open standards (where practical and fair) and it is software libre.
Get With the Future Way Better!