SiSU

git

[ document manifest ]

<< previous toc next >>

SiSU - Manual,
Ralph Amissah

What is SiSU?

Introduction - What is SiSU?

How does sisu work?

Summary of features

Help

SiSU Manual
SiSU man pages
SiSU built-in interactive help, [discontinued]

Commands Summary

Description
Document Processing Command Flags

command line modifiers

database commands

Command Line with Flags - Batch Processing

Introduction to SiSU Markup  3 

Summary
Markup Rules, document structure and metadata requirements
Markup Examples
Online
Installed

Markup of Headers

Sample Header
Available Headers

Markup of Substantive Text

Heading Levels
Font Attributes
Indentation and bullets
Hanging Indents
Footnotes / Endnotes
Links
Naked URLs within text, dealing with urls
Linking Text
Linking Images
Link shortcut for multiple versions of a sisu document in the same directory tree
Grouped Text / blocked text
blocked text curly brace syntax
blocked text tic syntax
Tables
Poem
Group
Code
Additional breaks - linebreaks within objects, column and page-breaks
line-breaks
page breaks
Bibliography / References
a markup tagged metadata bibliography section
Tagging citations for inclusion in the Bibliography
Glossary
Book index

Composite documents markup

Substitutions

SiSU filetypes

.sst .ssm .ssi marked up plain text
sisu text - regular files (.sst)
sisu master files (.ssm)
sisu insert files (.ssi)
sisupod, zipped binary container (sisupod.zip, .ssp)

Configuration

Configuration files
config.yml
sisu_document_make

CSS - Cascading Style Sheets (for html, XHTML and XML)

Organising Content - Directory Structure and Mapping

Document Source Directory
General Directories
Document Output Directory Structures
Output Directory Root
Alternative Output Structures
By Language
By Filetype
By Filename
Remote Directories
Sisupod

Homepages

Home page and other custom built pages in a sub-directory

Markup and Output Examples

Markup examples
SiSU Markup Samples

SiSU Search - Introduction

SQL

populating SQL type databases

Postgresql

Name
Description
Synopsis
Commands
create and destroy database
import and remove documents

Sqlite

Name
Description
Synopsis
Commands
create and destroy database
import and remove documents

CGI Search Form

Setup search form
Search - database frontend sample, utilising database and SiSU features, including object citation numbering (backend currently PostgreSQL)
Search Form

sisu_webrick

Name
Synopsis
Description
Summary of man page
Document processing command flags

Remote Source Documents

Remote Document Output

Remote Output

commands
configuration

Remote Servers

Download information

Download SiSU - Linux/Unix

SiSU Current Version - Linux/Unix
Source (tarball tar.gz)
Git (source control management)
Debian
RPM

Source tree

run off source package directory tree (without installing)
Gem install
Gem install with qi (quick install) script
Gem install with rake
misc Gem
direct installation with qi (quick install) script
installation with setup.rb

Unix/Linux Distribution

Debian

Dependencies

Quickstart - Getting Started Howto

Installation
Debian Installation
RPM Installation
Installation from source
Testing SiSU, generating output
basic text, plaintext, html, XML, ODF, EPUB
LaTeX / pdf
relational database - postgresql, sqlite
Getting Help
The man pages
Built in help
The home page
Markup Samples

HowTo

Getting Help

SiSU "man" pages

Setup, initialisation

initialise output directory
Use of search functionality, an example using sqlite
misc
url for output files -u -U
toggle screen color
verbose mode
quiet mode
maintenance mode intermediate files kept -M
start the webrick server
remote placement of output

Configuration Files

Markup

Headers
Font Face
Bold
Italics
Underscore
Strikethrough
Endnotes
Links
Number Titles
Line operations
Tables
Grouped Text
Composite Document

Change Appearance

Skins
CSS

Extracts from the README

README

Online Information, places to look
Installation
Debian
RPM
Source package .tgz
to use setup.rb
to use install (prapared with "Rake")
to use install (prapared with "Rant")
Dependencies
Quick start
Configuration files
Use General Overview
Help
Directory Structure
Configuration File
Markup
Additional Things
License
SiSU Standard

Extracts from man 8 sisu

Post Installation Setup

Post Installation Setup - Quick start
Document markup directory
Configuration files
Debian INSTALLATION Note
Document Resource Configuration

FAQ - Frequently Asked/Answered Questions

Why are urls produced with the -v (and -u) flag that point to a web server on port 8081 ?
I cannot find my output, where is it?
I do not get any pdf output, why?
Where is the latex (or some other interim) output?
Why isn't SiSU markup XML
LaTeX claims to be a document preparation system for high-quality typesetting. Can the same be said about SiSU?
Can the SiSU markup be used to prepare for a LaTex automatic building of an index to the work?
Can the conversion from SiSU to LaTeX be modified if we have special needs for the LaTeX, or do we need to modify the LaTeX manually?
How do I create GIN or GiST index in Postgresql for use in SiSU
Are there some examples of using Ferret Search with a SiSU repository?
Have you had any reports of building SiSU from tar on Mac OS 10.4?
Where is version 1?
What is the difference between version 1 and 2?

Who might be interested in the SiSU feature set?

Work Needed

Wishlist

Editor Files, Syntax Highlighting

Help Sources

man pages
sisu generated output - links to html
www.sisudoc.org
man2html
locally installed
www.jus.uio.no/sisu

Endnotes

Endnotes

Index

Index

Metadata

SiSU Metadata, document information

SiSU - Manual,
Ralph Amissah

What is SiSU?

HowTo

Markup

Headers
Font Face
Bold
Italics
Underscore
Strikethrough
Endnotes
Links
Number Titles
Line operations
Tables
Grouped Text
Composite Document

See sample markup provided on

http://www.sisudoc.org/

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/examples.html

on untarring the source tarball:

data/doc/sisu/markup-samples

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

/usr/share/doc/sisu/markup-samples/

and if you have sisu -markup-samples installed, under

data/doc/sisu/markup-samples-non-free/

/usr/share/doc/sisu/markup-samples-non-free/

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:

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

Font Face

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

Bold

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

bold line

!_ bold line

bold word or sentence

!{ bold word or sentence }!

*{ bold word or sentence }*

*boldword* or !boldword!

*boldword* or !boldword!

Italics

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

italicise word or sentence

/{ italicise word or sentence }/

/italicisedword/

/italicisedword/

Underscore

underscore word or sentence

_{ underscore word or sentence }_

_underscoreword_

Strikethrough

strikethrough word or sentence

-{ strikethrough word or sentence }-

-strikeword-

-strikeword-

Endnotes

There are two forms of markup for endnotes, they cannot be mixed within the same document

here  50 

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

Links

SiSU

{ SiSU }http://www.sisudoc.org

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

{ tux.png 64x80 }image

SiSU   51 

{~^ SiSU }http://www.sisudoc.org

is equivalent to:

{ SiSU }http://www.sisudoc.org ~{ http://www.sisudoc.org }~

the same can be done with an image:


SiSU

  52 

{~^ sisu.png "SiSU" }http://www.sisudoc.org

Number Titles

Set with the header @markup:

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

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

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

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

Composite Document

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

<< { filename.sst }

<< { filename.ssi }


 50. this is an endnote

 51.http://www.sisudoc.org

 52.http://www.sisudoc.org


[ document manifest ]

<< previous toc next >>