SiSU - Manual,
Ralph Amissah

  1

What is SiSU?

  2

Extracts from man 8 sisu

  1927

43. Post Installation Setup

43. Post Installation Setup

  1928

43.1 Post Installation Setup - Quick start

  1929

After installation of sisu-complete, move to the document samples directory,

  1930

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

  1931

[this is not where you would normally work but provides sample documents for testing, you may prefer instead to copy the contents of that directory to a local directory before proceeding]

  1932

and in that directory, initialise the output directory with the command

  1933

sisu -CC

  1934

then run:

  1935

sisu -1 free_as_in_freedom.rms_and_free_software.sam_williams.sst

  1936

or the same:

  1937

sisu -NhwpoabxXyv free_as_in_freedom.rms_and_free_software.sam_williams.sst

  1938

look at output results, see the "sisu_manifest" page created for the document

  1939

for an overview of your current sisu setup, type:

  1940

sisu --help env

  1941

or

  1942

sisu -V

  1943

To generate a document from a remote url accessible location move to a writable directory, (create a work directory and cd into it) as the file will be downloaded there and e.g.

  1944

sisu -1 <http://www.jus.uio.no/sisu/gpl3.fsf/gpl3.fsf.sst>

  1945

sisu -3 <http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/free_culture.lawrence_lessig.sst>

  1946

examine source document, vim has syntax highlighting support

  1947

gvim free_as_in_freedom.rms_and_free_software.sam_williams.sst

  1948

additional markup samples in

  1949

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

  1950

it should also be possible to run sisu against sisupods (prepared zip files, created by running the command sisu -S [filename]), whether stored locally or remotely.

  1951

sisu -3 <http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/sisupod.zip>

  1952

there is a security issue associated with the running of document skins that are not your own, so these are turned of by default, and the use of the following command, which switches on the associated skin is not recommended:

  1953

sisu -3 --trust <http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/sisupod.zip>

  1954

For help

  1955

man sisu

  1956

sisu --help

  1957

sisu --help env for the way sisu "sees/maps" your system

  1958

sisu --help commands for list of commands and so on

  1959

43.2 Document markup directory

  1960

Perhaps the easiest way to begin is to create a directory for sisu marked up documents within your home directory, and copy the file structure (and document samples) provided in the document sample directory:

  1961

mkdir ~/sisu_test

  1962

cd ~/sisu_test

  1963

cp -a /usr/share/doc/sisu/sisu_markup_samples/dfsg/* ~/sisu_test/.

  1964

Tip: the markup syntax examples may be of interest

  1965

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

  1966

Tip:

  1967

sisu -U [sisu markup filename]

  1968

should printout the different possible outputs and where sisu would place them.

  1969

Tip: if you want to toggle ansi color add

  1970

c

  1971

to your flags.

  1972

43.2.1 Configuration files

  1973

SiSU configuration file search path is:

  1974

./_sisu/sisurc.yaml

  1975

~/.sisu/sisurc.yaml

  1976

/etc/sisu/sisurc.yaml

  1977

.\"%% Debian Installation Note

  1978

43.2.2 Debian INSTALLATION Note

  1979

It is best you see

  1980

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

  1981

for up the most up to date information.

  1982

notes taken from the Debian control file (end edited), gives an idea of additional packages that SiSU can make use of if available, (the use/requirement of some of which are interdependent for specific actions by SiSU):

  1983

Package: sisu

  1984

SiSU is a lightweight markup based, command line oriented, document structuring, publishing and search framework for document collections.

  1985

With minimal preparation of a plain-text, (UTF-8) file, using its native markup syntax in your text editor of choice, SiSU can generate various document formats (most of which share a common object numbering system for locating content), including plain text, HTML, XHTML, XML, OpenDocument text (ODF:ODT), LaTeX, PDF files, and populate an SQL database with objects (roughly paragraph-sized chunks) so searches may be performed and matches returned with that degree of granularity: your search criteria is met by these documents and at these locations within each document. Object numbering is particularly suitable for "published" works (finalized texts as opposed to works that are frequently changed or updated) for which it provides a fixed means of reference of content. Document outputs also share semantic meta-data provided.

  1986

SiSU also provides concordance files, document content certificates and manifests of generated output.

  1987

A vim syntax highlighting file and an ftplugin with folds for sisu markup is provided, as are syntax highlighting files for kate, kwrite, gedit and diakonos. Vim 7 includes syntax highlighting for SiSU.

  1988

man pages, and interactive help are provided.

  1989

Dependencies for various features are taken care of in sisu related packages. The package sisu-complete installs the whole of SiSU.

  1990

Additional document markup samples are provided in the package sisu-markup-samples which is found in the non-free archive the licenses for the substantive content of the marked up documents provided is that provided by the author or original publisher.

  1991

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

  1992

43.2.3 Document Resource Configuration

  1993

sisu resource configuration information is obtained from sources (where they exist):

  1994

~/.sisu/sisurc.yaml

  1995

/etc/sisu/[sisu version]/sisurc.yaml

  1996

sisu program defaults

  1997

43.2.4 Skins

  1998

Skins default document appearance may be modified using skins contained in sub-directories located at the following paths:

  1999

./_sisu/skin

  2000

~/.sisu/skin

  2001

/etc/sisu/skin

  2002

more specifically, the following locations (or their /etc/sisu equivalent) should be used:

  2003

~/.sisu/skin/doc

  2004

skins for individual documents;

  2005

~/.sisu/skin/dir

  2006

skins for directories of matching names;

  2007

~/.sisu/skin/site

  2008

site-wide skin modifying the site-wide appearance of documents.

  2009

Usually all skin files are placed in the document skin directory:

  2010

~/.sisu/skin/doc

  2011

with softlinks being made to the skins contained there from other skin directories as required.

  2012

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!