"sisu_howto"("1") manual page

SISU - TECHNICAL, HOWTO, RALPH AMISSAH

SISU SOME TECHNICAL INFORMATION

HOWTO

1. GETTING HELP

An online manual of sorts should be available at:

The manual pages provided with SiSU are also available online, and there is an interactive help, which is being superseded by the man page, and possibly some document which contains this component.

1.1 SISU

If SiSU is installed on your system usual man commands should be available, try:

man sisu

The SiSU man pages can be viewed online at:[^1]

An online version of the sisu man page is available here:

* various sisu man pages <http://www.jus.uio.no/sisu/man/ > [^2]

* sisu.1 <http://www.jus.uio.no/sisu/man/sisu.1.html > [^3]

* sisu.8 <http://www.jus.uio.no/sisu/man/sisu.8.html > [^4]

* sisu_examples.1 <http://www.jus.uio.no/sisu/man/sisu_examples.1.html > [^5]

* sisu_webrick.1 <http://www.jus.uio.no/sisu/man/sisu_webrick.1.html > [^6]

1.2

SISU BUILT-IN HELP

sisu --help

sisu --help [subject]

sisu --help env [for feedback on the way your system is
setup with regard to sisu]

sisu -V [same as above command]

sisu --help commands

sisu --help markup

1.3 COMMAND LINE WITH FLAGS - BATCH PROCESSING

Running sisu (alone without any flags, filenames or wildcards) brings up the interactive help, as does any sisu command that is not recognised.

In the data directory run sisu -mh filename or wildcard eg. cisg.sst documents.

2. SETUP, INITIALISATION

2.1 INITIALISE OUTPUT DIRECTORY

Images, css files for a document directory are copied to their respective locations in the output directory.

while within your document markup/preparation directory, issue the following

command

sisu -CC

2.1.1 USE OF SEARCH FUNCTIONALITY, AN EXAMPLE USING SQLITE

SiSU can populate PostgreSQL and Sqlite databases and provides a sample search form for querying these databases.

This note provides an example to get you started and

will use sqlite

It is necessary to:

(1) make sure the required dependencies

have been installed

(2) have a directory with sisu markup samples that

is writable

(3) use sisu to create a database

(4) use sisu tp populate

a database

(5) use sisu to start the webrick (httpd) server

(6) use

sisu to create a search form

(7) copy the search form to the cgi directory

(8) open up the form in your browser

(9) query the database using the

search form

(1) make sure the required dependencies have been installed

if you use Debian , the following command will install the required dependencies

aptitude install sisu-sqlite

(2) have a directory with sisu markup samples

that is writable

ideally copy the sisu-examples directory to your home directory (because the directory in which you run this example should be writable)

cp -rv /usr/share/sisu-examples/sample/document_samples_sisu_markup ~/.

(3) use sisu to create an sqlite database

within the sisu-examples

directory

sisu -dv createall

(4) use sisu tp populate a database with

some text

within the sisu-examples directory

sisu -div free_*.sst

sisu -dv import free_*.sst debian_constitution_v1.2.sst debian_social_contract_v1.1.sst

gpl2.fsf.sst

(5) use sisu to start the webrick (httpd) server (if it has not already been started):

sisu -W

(6) use sisu to create a search form (for use with the webrick server, and your sample documents)

within the

sisu-examples directory

sisu -F webrick

#here i run into a problem, you are working from a read only #directory..., not my usual mode of operation,

to complete the example #the following is necessary sudo touch sisu_sqlite.cgi

sisu_pgsql.cgi sudo -P chown $USER sisu_sqlite.cgi sisu_pgsql.cgi

#now this should be possible: sisu -F webrick

(7) copy the search form to the cgi

directory

the string should be provided as output from the previous command

sudo cp -vi /usr/share/sisu-examples/sample/document_samples_sisu_markup/sisu_sqlite.cgi

/usr/lib/cgi-bin

sudo chmod -v 755 /usr/lib/cgi-bin/sisu_sqlite.cgi

(8)

open up the form in your browser and query it

url:

<http://localhost:8081/cgi-bin/sisu_sqlite.cgi >

or as instructed by command sisu -F webrick

(9) query the database using

the search form

if there are other options in the dropdown menu select

document_samples_sisu_markup

and search for some text, e.g.:

aim OR

project

* selecting the index radio button gives an index of results

using the object numbers

* selecting the text radio button gives the

content of the matched paragraphs with the match highlighted

(10) to

start again with a new database

to start from scratch you can drop the

database with the command

sisu -dv dropall

and go to step 3

to get

to step 3 in one step with a single command

sisu -dv recreate

continue

subsequent steps

2.2 MISC

2.2.1 URL FOR OUTPUT FILES -U -U

sisu -uv[and other flags] [filename/wildcard]

sisu -Uv [filename/wildcard]

2.2.2 TOGGLE SCREEN COLOR

sisu -cv[and processing flags] [filename/wildcard]

2.2.3 VERBOSE MODE

sisu -v[and processing flags] [filename/wildcard]

sisu -V[and processing flags] [filename/wildcard]

2.2.4 QUIET MODE

sisu -q[and processing flags] [filename/wildcard]

2.2.5 MAINTENANCE MODE INTERMEDIATE FILES KEPT -M

sisu -Mv[and other flags] [filename/wildcard]

2.2.6 START THE WEBRICK SERVER

sisu -W

2.3 REMOTE PLACEMENT OF OUTPUT

configuration is necessary

scp

sisu -vr[and processing flags] [filename/wildcard]

rsync

sisu -vR[and processing flags] [filename/wildcard]

3. CONFIGURATION FILES

Sample provided, on untarring the source tarball:

conf/sisu/sisurc.yaml

and on installation under:

/etc/sisu/sisurc.yaml

The following paths are searched:

./_sisu/sisurc.yaml

~/.sisu/sisurc.yaml

./etc/sisu/sisurc.yaml

4. MARKUP

See sample markup provided on

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

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

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

in particular for each of the document output samples provided, the source document is

provided as well

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

on untarring the source tarball:

data/sisu-examples/sample/document_samples_sisu_markup/

or the same once source is installed (or sisu-examples) under:

/usr/share/sisu-examples/sample/document_samples_sisu_markup/

Some notes are contained within the man page, man sisu and within sisu

help via the commands sisu help markup and sisu help headers

SiSU is for literary and legal text, also for some social science material. In particular it does not do formula, and is not particularly suited to technical documentation. Despite the latter caveat, some notes will be provided here and added to over time:

4.1 HEADERS

Headers @headername: provide information related to the document, this may relate to

1. how it is to be processed, such as whether headings are to be numbered, what skin is to be used and markup instructions, such as the document structure, or words to be made bold

within the document

2. semantic information about the document including

the dublin core

4.2 FONT FACE

Defaults are set. You may change the face to: bold, italics, underscore, strikethrough, ...

4.2.1 BOLD

@bold: [list of words that should be made bold within or document]

bold line

bold line

bold word or sentence

!{ bold word or sentence }!

*{ bold word or sentence }*

boldword or boldword

*boldword* or !boldword!

4.2.2 ITALICS

@italics: [list of words that should be italicised within

italicise word or sentence

/{ italicise word or sentence }/

italicisedword

/italicisedword/

4.2.3 UNDERSCORE

underscore word or sentence

_{ underscore word or sentence }_

underscoreword

4.2.4 STRIKETHROUGH

<del> strikethrough word or sentence </del>

-{ strikethrough word or sentence }-

<del>strikeword</del>

-strikeword-

4.3 ENDNOTES

There are two forms of markup for endnotes,

they cannot be mixed within the same document

here[^7]

1. preferred endnote

markup

here~{ this is an endnote }~

2. alternative markup equivalent,

kept because it is possible to search and replace to get markup in existing

texts such as Project Gutenberg

here~^

^~ this is an endote

4.4 LINKS

SiSU <http://sisudoc.org >

{ SiSU }http://sisudoc.org

sisu.png 120x39 <http://sisudoc.org >

{sisu.png }http://sisudoc.org

[ tux.png ]

{ tux.png 64x80 }image

SiSU <http://sisudoc.org > [^8]

{ SiSU }http://sisudoc.org

is equivalent to:

{ SiSU }http://sisudoc.org ~{ <http://sisudoc.org > }~

the same can be done with an image:

sisu.png 120x39

{ sisu.png SiSU }http://sisudoc.org

4.5 NUMBER TITLES

Set with the header @markup:

4.6 LINE OPERATIONS

Line Operations (marker placed at start of line)

!_ bold line

bold

line

_1 indent paragraph one level

indent paragraph one level

_2 indent paragraph two steps

indent paragraph two steps

_* bullet paragraph

* bullet paragraph

# number paragraph (see headers for numbering document headings)

1. number paragraph (see headers for numbering document headings)

_# number paragraph level 2 (see headers for numbering document headings)

a. number paragraph level 2 (see headers for numbering document headings)

4.7 TABLES

Table markup sample

table{~h c3; 26; 32; 32;

This is a table, column1

this would become row one of column two

column three of row one is here

column one row 2

column two of row two

column three of row two, and so on

column one row three

and so on

here

}table

Alternative

form of table markup

  {t~h}
       |Mon|Tue|Wed|Thu|Fri|Sat|Sun
  0    | * | * | * | * | * | * | *
  1    | * | * | * | * |   |   |
  2    | - | * | * | * | * | * |
  3    | - | * | * | * | * | * | *
  4    | - |   |   | * | * | * |
  5    | * | * | * | * | * | * | *

4.8 GROUPED TEXT

    5.times { puts ’Ruby’ }

code{

    5.times { puts ’Ruby’ }

}code

A Limerick

There was a young lady from Clyde,

who ate a green apple and died,

but the apple fermented inside the lamented,

and made cider inside her inside.

poem{

There was a young lady from Clyde,

who ate a green apple and died,

but the apple fermented inside the lamented,

and made cider inside her inside.

}poem

4.9 COMPOSITE DOCUMENT

To import another document, the master document or importing document should be named filename.r3 (r for require)

<< { filename.sst }

<< { filename.ssi }

5. CHANGE APPEARANCE

5.1 SKINS

Skins appearance, including such things as the url for the home page on which the material will be published, information on the credit band, and for html documents colours and icons used in navigation bars. Skins are ruby files which permit changing of the default values set within the program for SiSU output.

There are a few examples provided, on untarring the source tarball:

conf/sisu/skin/doc/

data/sisu-examples/sample/document_samples_sisu_markup/_sisu/skin/doc

and on installation under:

/etc/sisu/skin/doc/

/usr/share/sisu-examples/sample/document_samples_sisu_markup/_sisu/skin/doc

The following paths are searched:

./_sisu/skin

~/.sisu/skin

/etc/sisu/skin

Skins under the searched paths in a per document directory, a per directory directory, or a site directory, named:

doc [may be specified individually in each document]

dir [used if identifier part of name matches markup directory name]

site

It is usual to place all skins in the document directory, with symbolic links as required from dir or site directories.

5.2 CSS

The appearance of html and XML related output can be changed for an ouput collection directory by prepareing and placing a new css file in one of the sisu css directories searched in the sisu configuration path. These are located at:

_./_sisu/css

~/.sisu/css

and

/etc/sisu/css

The contents of the first directory found in the search path are copied to the corresponding sisu output directory with the commnd:

sisu -CC

The SiSU standard css files for SiSU output are:

dom.css html.css html_tables.css

index.css sax.css xhtml.css

A document may specify its own/bespoke css file using the css header.

@css:

[expand]

EXTRACTS FROM THE README

6. README

SiSU 0.55 2007w27/6 2007-07-07

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

Description

SiSU is lightweight markup based document creation and publishing framework that is controlled from the command line. Prepare documents for SiSU using your text editor of choice, then use SiSU to generate various output document formats.

With minimal preparation of a plain-text (UTF-8) file using its native markup-syntax, SiSU produces: plain-text, HTML, XHTML, XML, ODF:ODT (Opendocument), LaTeX, PDF, and populates an SQL database (PostgreSQL or SQLite) in paragraph sized chunks so that document searches are done at

this

Outputs share a common citation numbering system, and any semantic meta-data provided about the document.

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

SiSU takes advantage of well established open standard ways of representing text, and provides a bridge to take advantage of the strengths of each, while remaining simple. SiSU implements across document formats a from a humanities, law, and possibly social sciences rather than technical or scientific writing] ... focus is primarily on content and data integrity rather than appearance, (though outputs in the various formats are respectable).

A vim syntax highlighting file and an ftplugin with folds for sisu markup is provided. Vim 7 includes syntax highlighting for SiSU

man pages, and interactive help are provided.

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

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.

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

SiSU - simple information structuring universe, is a publishing tool, document generation and management, (and search enabling) tool primarily for literary, academic and legal published works.

SiSU can be used for Internet, Intranet, local filesystem or cd publishing.

SiSU can be used directly off the filesystem, or from a database.

SiSU ’s scalability, is be dependent on your hardware, and filesystem (in my case Reiserfs), and/or database Postgresql.

Amongst it’s characteristics are:

* simple mnemonoic markup style,

* the ability to produce multiple output formats, including html, structured XML, LaTeX, pdf (via LaTeX), stream to a relational database whilst retaining document structure - Postgresql and Sqlite,

* that all share a common citation system (a simple idea from which much good), possibly most exciting, the following: if fed into a relational database (as it can be automatically), the document set is searchable, with results displayed at a paragraph level, or the possibility of an indexed display of documents in which the match is found together with a hyperlinked listing for each of each paragraph in which the match is found. In any event citations using this system (with or without the relational database) are relevant for all output formats.

* it is command line driven, and can be set up on

a remote server

* Documents are marked up in SiSU syntax in your favourite editor. SiSU syntax may be regarded as a type of smart ascii - which in its basic form is simpler than the most elementary html. There is currently a syntax highlighter, and folding for Vim. Syntax highlighters for other editors are welcome.

Input files should be UTF-8

Once set up it is simple to use.

6.1 ONLINE INFORMATION, PLACES TO LOOK

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

Download Sources:

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

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

6.2 INSTALLATION

NB. Platform is Unix / Linux.

6.2.1 DEBIAN

If you use Debian use the Debian packages, check the information at:

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

(A) SiSU is available directly off the Debian archives for Sid and testing. It should necessary only to run as root:

aptitude update

aptitude install sisu-complete

(B) 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

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

[the non-free line is for document markup samples, for which the substantive text is provided under the author or which original publisher’s license and which in most cases will

Then as root run:

aptitude update

aptitude install sisu-complete

6.2.2 RPM

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

They may be downloaded from:

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

6.2.3 SOURCE PACKAGE .TGZ

Otherwise to install SiSU from source, check information at:

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

alternative modes of installation from source are provided, setup.rb (by Minero Aoki), rake (by Jim Weirich) built install file, rant (by Stefan Lang) built install file,

Ruby is the essential dependency for the basic

operation of SiSU

1. Download the latest source (information available) from:

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

2. Unpack the source

Note however, that additional external package dependencies, such as texlive or postgresql should you desire to use it are not taken care of for you.

6.2.4 TO USE SETUP.RB

this is a three step process, in the root directory of the unpacked SiSU as root type:

ruby setup.rb config

ruby setup.rb setup

as root:

ruby setup.rb install

further information:

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

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

6.2.5 TO USE INSTALL (PRAPARED WITH

Rake must be installed on your system:

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

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

in the root directory of the unpacked SiSU as root type:

rake

rake base

This makes use of Rake (by Jim Weirich) and the provided Rakefile

For a list of alternative actions you may type:

rake help

rake -T

6.2.6 TO USE INSTALL (PRAPARED WITH

(you may use the instructions above for rake substituting rant if rant is installed on your system, or you may use an independent installer created using rant as follows:)

in the root directory of the unpacked SiSU as root type:

ruby ./sisu-install

ruby ./sisu-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:

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

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

For a list of alternative actions you may type:

ruby ./sisu-install help

ruby ./sisu-install -T

6.3 DEPENDENCIES

Once installed see ’man 8 sisu’ for some information on additional programs that sisu makes use of, and that you may need or wish to install. (this will depend on such factors as whether you want to generate pdf, whether you will be using SiSU with or without a database, ...) ’man sisu_markup-samples’ may also be of interest if the sisu-markup-samples package has also been installed.

The information in man 8 may not be most up to date, and it is possible that more useful information can be gleaned from the following 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 ).

The following is from the debian/control file of sisu-0.58.2, which amongst other things provides the dependencies of sisu within Debian

  Package: sisu
  Architecture: all
  Depends: ruby (>= 1.8.2), libwebrick-ruby, unzip, zip
  Conflicts: vim-sisu, sisu-vim, sisu-remote
  Replaces: vim-sisu, sisu-vim
  Recommends: sisu-pdf, sisu-sqlite, sisu-postgresql, librmagick-ruby, trang,
  tidy, librexml-ruby, openssl, rsync, openssh-client | lsh-client, keychain,
  hyperestraier, kdissert, vim-addon-manager
  Suggests: rcs | cvs, lv, texinfo, pinfo
  Package: sisu-complete
  Depends: ruby (>= 1.8.4), sisu, sisu-pdf, sisu-postgresql, sisu-sqlite
  Recommends: hyperestraier
  Package: sisu-pdf
  Architecture: all
  Depends: sisu, texlive-latex-base, texlive-fonts-recommended,
  texlive-latex-recommended, texlive-latex-extra
  Suggests: evince, xpdf
  Package: sisu-postgresql
  Depends: sisu, postgresql-8.1, libdbi-ruby, libdbm-ruby, libdbd-pg-ruby
  Suggests: pgaccess, libdbd-pgsql, postgresql-contrib-8.1
  Package: sisu-sqlite
  Depends: sisu, sqlite, libdbi-ruby, libdbm-ruby, libdbd-sqlite-ruby
  Suggests: libdbd-sqlite
  Package: sisu-markup-samples
  Depends: sisu

  Source: sisu
  Section: text
  Priority: optional
  Maintainer: Ralph Amissah <ralph@amissah.com>
  Build-Depends: debhelper (>= 5)
  Standards-Version: 3.7.2
  Package: sisu
  Architecture: all
  Depends: ruby (>= 1.8.2), libwebrick-ruby, unzip, zip
  Conflicts: vim-sisu, sisu-vim, sisu-remote
  Replaces: vim-sisu, sisu-vim
  Recommends: sisu-pdf, sisu-sqlite, sisu-postgresql, hyperestraier, keychain,
librmagick-ruby, librexml-ruby, openssl, openssh-client | lsh-client, rsync,
tidy, vim-addon-manager
  Suggests: kdissert, lv, rcs | cvs, pinfo, texinfo, trang
  Description: documents - structuring, publishing in multiple formats and
search
   SiSU is a lightweight markup based, command line oriented, document
   structuring, publishing and search framework for document collections.
   .
   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
   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.
   .
   SiSU also provides concordance files, document content certificates
and
   manifests of generated output.
   .
   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.
   .
   man pages, and interactive help are provided.
   .
   Dependencies for various features are taken care of in sisu related
packages.
   The package sisu-complete installs the whole of SiSU.
   .
   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.
   .
    Homepage: <http://www.jus.uio.no/sisu>

  Package: sisu-complete
  Architecture: all
  Depends: ruby (>= 1.8.2), sisu, sisu-pdf, sisu-postgresql, sisu-sqlite
  Recommends: hyperestraier
  Description: installs all SiSU related packages
   This package installs SiSU and related packages that enable sisu to
produce
   pdf and to populate postgresql and sqlite databases.
   .
   SiSU is a lightweight markup based document publishing framework.
   .
   See sisu for a description of the package.
   .
    Homepage: <http://www.jus.uio.no/sisu>

  Package: sisu-pdf
  Architecture: all
  Depends: sisu, texlive-latex-base, texlive-fonts-recommended, texlive-latex-recommended,
texlive-latex-extra
  #Suggests: evince, xpdf
  Description: dependencies to convert SiSU LaTeX output to pdf
   This package enables the conversion of SiSU LaTeX output to pdf.
   .
   SiSU is a lightweight markup based document publishing framework.
   .
    Homepage: <http://www.jus.uio.no/sisu>

  Package: sisu-postgresql
  Architecture: all
  Depends: sisu, libdbd-pg-ruby, libdbi-ruby, libdbm-ruby, postgresql
  Recommends: libfcgi-ruby
  Suggests: postgresql-contrib
  Description: SiSU dependencies for use with postgresql database
   This package enables SiSU to populate a postgresql database. This is
done at
   an object/paragraph level, making granular searches of documents possible.
   .
   This relational database feature of SiSU is not required but provides
   interesting possibilities, including that of granular searches of documents
   for matching units of text, primarily paragraphs that can be displayed
or
   identified by object citation number, from which an index of documents
   matched and each matched paragraph within them can be displayed.
   .
   SiSU is a lightweight markup based document publishing framework.
   .
    Homepage: <http://www.jus.uio.no/sisu>

  Package: sisu-sqlite
  Architecture: all
  Depends: sisu, sqlite, libdbd-sqlite-ruby, libdbi-ruby, libdbm-ruby
  Recommends: libfcgi-ruby
  Description: SiSU dependencies for use with sqlite database
   This package enables SiSU to populate an sqlite database. This is done
at an
   object/paragraph level, making granular searches of documents possible.
   .
   This relational database feature of SiSU is not required but provides
   interesting possibilities, including that of granular searches of documents
   for matching units of text, primarily paragraphs that can be displayed
or
   identified by object citation number, from which an index of documents
   matched and each matched paragraph within them can be displayed.
   .
   SiSU is a lightweight markup based document publishing framework.
   .
    Homepage: <http://www.jus.uio.no/sisu>

6.4 QUICK START

Most of the installation should be taken care of by the aptitude or rant install. (The rant install if run in full will also test run the generation of the first document).

After installation of sisu-complete,

move to the document samples directory

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

and run

sisu -3 free_as_in_freedom.rms_and_free_software.sam_williams.sst

or the same:

sisu -NhwpoabxXyv free_as_in_freedom.rms_and_free_software.sam_williams.sst

look at output results, see the

or to generate an online document move to a writable directory, as the file will be downloaded there and e.g.

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

the database stuff is extra perhaps, the latex stuff could be considered

extra perhaps but neither needs to be installed for most of sisu output

to work

examine source document, vim has syntax support

gvim free_as_in_freedom.rms_and_free_software.sam_williams.sst

additional markup samples in

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

For help

man sisu

sisu --help

e.g.

for the way sisu

sisu --help env

for list of commands and so on

sisu --help commands

6.5 CONFIGURATION FILES

The default configuration/setup is contained

within the program and is altered by configuration settings in etc [sisu

version]/sisurc.yml or in ~/.sisu/sisurc.yml

* configuration file - a yaml

file

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

~/.sisu/sisurc.yml

* directory structure - setting up of output and working directory.

* skins - changing the appearance of a project, directory or individual

documents within ~/.sisu/skin

~/.sisu/skin/doc contains individual skins, with symbolic links from

~/.sisu/skin/dir if the contents of a directory are to take a particular
document skin.

* additional software - eg. Tex and LaTeX (tetex, tetex-base, tetex-extra on Debian ), Postgresql, [sqlite], trang, tidy, makeinfo, ... none of which are required for basic html or XML processing.

* if you use Vim as editor there is a syntax highlighter and fold resource config file for SiSU hope more syntax highlighters follow.

There are post installation steps (which are really part of the overall installation)

sisu -C in your marked up document directory, should do some auto-configuring provided you have the right permissions for the output directories. (and provided the output directories have already been specified if you are not using the defaults).

6.6 USE

GENERAL OVERVIEW

Documents are marked up in SiSU syntax and kept in an ordinary text editable file, named with the suffix .sst, or .ssm

Marked

up SiSU documents are usually kept in a sub-directory of your choosing

use the interactive help and man pages

sisu --help

man sisu

6.7 HELP

interactive help described below, or man page:

man sisu

man 8 sisu

’man sisu_markup-samples’ [if the sisu-markup-samples package is also installed]

Once installed an interactive help is available typing ’sisu’ (without) any flags, and select an option:

sisu

alternatively, you could type e.g.

sisu --help commands

sisu --help env

sisu --help headers

sisu --help markup

sisu --help headings

etc.

for questions about mappings, output paths etc.

sisu --help env

sisu --help path

sisu --help directory

6.8 DIRECTORY STRUCTURE

Once installed, type:

sisu --help env

sisu -V

6.9 CONFIGURATION FILE

The defaults can be changed via SiSU ’s configure file sisurc.yml which the program expects to find in ./_sisu ~/.sisu or /etc/sisu (searched in that order, stopping on the first one found)

6.10 MARKUP

See man pages.

man sisu

man 8 sisu

Once installed there is some information on SiSU Markup in its help:

sisu --help markup

and

sisu --help headers

Sample marked up document are provided with the download tarball in the directory:

./data/doc/sisu/sisu_markup_samples/dfsg

These are installed on the system usually at:

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

More markup samples are available in the package sisu-markup-samples

<http://www.jus.uio.no/sisu/SiSU/download.html#sisu-markup-samples >

Many more are available online off:

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

6.11 ADDITIONAL THINGS

There is syntax support for some editors provided (together with a README file) in

./data/sisu/conf/syntax

usually installed to:

/usr/share/sisu/conf/syntax

6.12 LICENSE

License: GPL 3 or later see the copyright file in

./data/doc/sisu

usually installed to:

/usr/share/doc/sisu

6.13 SISU STANDARD

SiSU uses:

* Standard SiSU markup syntax,

* Standard SiSU meta-markup syntax, and the

* Standard SiSU object citation numbering

and system

however note the License section

CHANGELOG

./CHANGELOG

and see

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

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

EXTRACTS FROM MAN 8 SISU

7. POST INSTALLATION SETUP

7.1 POST INSTALLATION SETUP - QUICK START

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

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

[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]

and in that directory, initialise

the output directory with the command

sisu -CC

then run:

sisu -1 free_as_in_freedom.rms_and_free_software.sam_williams.sst

or the same:

sisu -NhwpoabxXyv free_as_in_freedom.rms_and_free_software.sam_williams.sst

look at output results, see the

for an overview of your current sisu setup, type:

sisu --help env

sisu -V

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.

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

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

examine source document, vim has syntax highlighting support

gvim

free_as_in_freedom.rms_and_free_software.sam_williams.sst

additional markup

samples in

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

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.

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

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:

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

For help

man sisu

sisu --help

sisu --help env for the way sisu

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

7.2 DOCUMENT MARKUP DIRECTORY

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:

mkdir ~/sisu_test

cd ~/sisu_test

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

Tip: the markup syntax examples may be of interest

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

Tip:

sisu -U [sisu markup filename]

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

Tip: if you want to toggle ansi color add

to your flags.

7.2.1 CONFIGURATION FILES

SiSU configuration file search path is:

./_sisu/sisurc.yaml

~/.sisu/sisurc.yaml

/etc/sisu/sisurc.yaml

Debian Installation Note

7.2.2 DEBIAN INSTALLATION NOTE

It is best

you see

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

for up the most up to date information.

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

Package: sisu

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

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

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

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

man pages, and interactive help are provided.

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

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

7.2.3 DOCUMENT RESOURCE CONFIGURATION

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

~/.sisu/sisurc.yaml

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

sisu program defaults

7.2.4 SKINS

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

./_sisu/skin

~/.sisu/skin