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?

Markup and Output Examples

Markup examples
SiSU Markup Samples

Markup examples

Current markup examples and document output samples are provided off ‹http://sisudoc.org› or ‹http://www.jus.uio.no/sisu› and in the sisu -markup-sample package available off ‹http://git.sisudoc.org

For some documents hardly any markup at all is required at all, other than a header, and an indication that the levels to be taken into account by the program in generating its output are.

SiSU Markup Samples

A few additional sample books prepared as sisu markup samples, output formats to be generated using SiSU are contained in a separate package sisu -markup-samples. sisu -markup-samples contains books (prepared using sisu markup), that were released by their authors various licenses mostly different Creative Commons licences that do not permit inclusion in the Debian Project as they have requirements that do not meet the Debian Free Software Guidelines for various reasons, most commonly that they require that the original substantive text remain unchanged, and sometimes that the works be used only non-commercially.

Accelerando, Charles Stross (2005)
accelerando.charles_stross.sst

Alice's Adventures in Wonderland, Lewis Carroll (1865)
alices_adventures_in_wonderland.lewis_carroll.sst

CONTENT, Cory Doctorow (2008)
content.cory_doctorow.sst

Democratizing Innovation, Eric von Hippel (2005)
democratizing_innovation.eric_von_hippel.sst

Down and Out in the Magic Kingdom, Cory Doctorow (2003)
down_and_out_in_the_magic_kingdom.cory_doctorow.sst

For the Win, Cory Doctorow (2010)
for_the_win.cory_doctorow.sst

Free as in Freedom - Richard Stallman's Crusade for Free Software, Sam Williams (2002)
free_as_in_freedom.richard_stallman_crusade_for_free_software.sam_williams.sst

Free as in Freedom 2.0 - Richard Stallman and the Free Software Revolution, Sam Williams (2002), Richard M. Stallman (2010)
free_as_in_freedom_2.richard_stallman_and_the_free_software_revolution.sam_williams.richard_stallman.sst

Free Culture - How Big Media Uses Technology and the Law to Lock Down Culture and Control Creativity, Lawrence Lessig (2004)
free_culture.lawrence_lessig.sst

Free For All - How Linux and the Free Software Movement Undercut the High Tech Titans, Peter Wayner (2002)
free_for_all.peter_wayner.sst

GNU GENERAL PUBLIC LICENSE v2, Free Software Foundation (1991)
gpl2.fsf.sst

GNU GENERAL PUBLIC LICENSE v3, Free Software Foundation (2007)
gpl3.fsf.sst

Gulliver's Travels, Jonathan Swift (1726 / 1735)
gullivers_travels.jonathan_swift.sst

Little Brother, Cory Doctorow (2008)
little_brother.cory_doctorow.sst

The Cathederal and the Bazaar, Eric Raymond (2000)
the_cathedral_and_the_bazaar.eric_s_raymond.sst

The Public Domain - Enclosing the Commons of the Mind, James Boyle (2008)
the_public_domain.james_boyle.sst

The Wealth of Networks - How Social Production Transforms Markets and Freedom, Yochai Benkler (2006)
the_wealth_of_networks.yochai_benkler.sst

Through the Looking Glass, Lewis Carroll (1871)
through_the_looking_glass.lewis_carroll.sst

Two Bits - The Cultural Significance of Free Software, Christopher Kelty (2008)
two_bits.christopher_kelty.sst

UN Contracts for International Sale of Goods, UN (1980)
un_contracts_international_sale_of_goods_convention_1980.sst

Viral Spiral, David Bollier (2008)
viral_spiral.david_bollier.sst


[ document manifest ]

<< previous toc next >>