path: root/data/doc/manuals_generated/sisu_manual/sisu_quickstart/sisu_quickstart.sst

% SiSU 0.57

@title: SiSU

@subtitle: 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

@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/2.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/

:A~? @title @creator

:B~? Quickstart - SiSU installation and use

1~ Quickstart - Getting Started Howto

2~ 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.

3~ 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:

code{

  aptitude update
  aptitude install sisu-complete

}code

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

code{

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

}code

The aptitude commands become:

code{

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

}code

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

code{

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

}code

repeat the aptitude commands

code{

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

}code

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.

3~ 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:

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

as root type:

_1 rpm -i [rpm package name]

3~ Installation from source

To install SiSU from source check information at:

_1 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)~{ There is nothing to stop MySQL support being added in future. }~ or converting LaTeX to pdf.

!_ 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:

code{

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

}code

further information on setup.rb is available from:

_1 http://i.loveruby.net/en/projects/setup/

_1 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:

_1 ruby install base

or for a more complete installation:

_1 ruby install

or

_1 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:

_1 http://make.rubyforge.org/

_1 http://rubyforge.org/frs/?group_id=615

For a list of alternative actions you may type:

_1 ruby install help

_1 ruby install -T

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

3~ 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

3~ 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

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

2~ Getting Help

3~ The man pages

Type:

_1 man sisu

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

_* {~^ sisu.1 }http://www.jus.uio.no/sisu/man/sisu.1

_* {~^ sisu.8 }http://www.jus.uio.no/sisu/man/sisu.8

_* {~^ man directory }http://www.jus.uio.no/sisu/man

3~ Built in help

sisu --help

sisu --help --env

sisu --help --commands

sisu --help --markup

3~ The home page

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

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

2~ 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~{ 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. }~ to include them it is necessary to include non-free in your /etc/apt/source.list or obtain them from the sisu home site.