SiSU - Manual,
Ralph Amissah

  1

What is SiSU?

  2

Installation

  1206

36. Quickstart - Getting Started Howto

36. Quickstart - Getting Started Howto

  1368

36.1 Installation

  1369

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.

  1370

36.1.1 Debian Installation

  1371

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

  1372

    aptitude update
    aptitude install sisu-complete

  1373

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

  1374

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

  1375

The aptitude commands become:

  1376

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

  1377

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

  1378

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

  1379

repeat the aptitude commands

  1380

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

  1381

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.

  1382

36.1.2 RPM Installation

  1383

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

  1384

They may be downloaded from:

  1385

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

  1386

as root type:

  1387

rpm -i [rpm package name]

  1388

36.1.3 Installation from source

  1389

To install SiSU from source check information at:

  1390

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

  1391

  1392

  1393

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:

  1394

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.

  1395

setup.rb

  1396

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:

  1397

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

  1398

further information on setup.rb is available from:

  1399

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

  1400

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

  1401

"install"

  1402

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

  1403

ruby install base

  1404

or for a more complete installation:

  1405

ruby install

  1406

or

  1407

ruby install base

  1408

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.

  1409

Further information on "rant" is available from:

  1410

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

  1411

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

  1412

For a list of alternative actions you may type:

  1413

ruby install help

  1414

ruby install -T

  1415

36.2 Testing SiSU, generating output

  1416

To check which version of sisu is installed:

  1417

sisu -v

  1418

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

  1419

...

  1420

or

  1421

...

  1422

change directory to the appropriate one:

  1423

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

  1424

36.2.1 basic text, plaintext, html, XML, ODF

  1425

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

  1426

sisu -NhwoabxXyv free_as_in_freedom.rms_and_free_software.sam_williams.sst

  1427

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

  1428

36.2.2 LaTeX / pdf

  1429

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

  1430

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

  1431

sisu -pv free_as_in_freedom.rms_and_free_software.sam_williams.sst

  1432

sisu -3 free_as_in_freedom.rms_and_free_software.sam_williams.sst

  1433

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

  1434

36.2.3 relational database - postgresql, sqlite

  1435

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

  1436

Assuming you have the database installed and the requisite permissions

  1437

sisu --sqlite --recreate

  1438

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

  1439

sisu --pgsql --recreate

  1440

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

  1441

36.3 Getting Help

  1442

36.3.1 The man pages

  1443

Type:

  1444

man sisu

  1445

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

  1446

  1447

  1448

  1449

36.3.2 Built in help

  1450

sisu --help

  1451

sisu --help --env

  1452

sisu --help --commands

  1453

sisu --help --markup

  1454

36.3.3 The home page

  1455

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

  1456

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

  1457

36.4 Markup Samples

  1458

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

  1459

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

  1460

Additional markup samples are packaged separately in the file:

  1461

*

  1462

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.

  1463

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

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

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

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

 ^98. 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.

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!