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

Endnotes

 1.http://www.jus.uio.no/sisu/man/

 2.http://www.jus.uio.no/sisu/man/sisu.1.html

 *1. square brackets

 *2. square brackets

 +1. square brackets

 3. From sometime after SiSU 0.58 it should be possible to describe SiSU markup using SiSU, which though not an original design goal is useful.

 4. files should be prepared using UTF-8 character encoding

 5. a footnote or endnote

 6. self contained endnote marker & endnote in one

 * unnumbered asterisk footnote/endnote, insert multiple asterisks if required

 ** another unnumbered asterisk footnote/endnote

 *3. editors notes, numbered asterisk footnote/endnote series

 +2. editors notes, numbered plus symbol footnote/endnote series

 7.http://www.sisudoc.org/

 8.http://www.ruby-lang.org/en/

 9. Table from the Wealth of Networks by Yochai Benkler
http://www.jus.uio.no/sisu/the_wealth_of_networks.yochai_benkler

 10. for which you may alternatively use the full form author: title: and year:

 11. Quixote and Panza, Taming Windmills (1605), pp 1000 - 1001 also, Benkler, Wealth of Networks (2006), p 1

 12. .ssc (for composite) is under consideration but ._sst makes clear that this is not a regular file to be worked on, and thus less likely that people will have "accidents", working on a .ssc file that is overwritten by subsequent processing. It may be however that when the resulting file is shared .ssc is an appropriate suffix to use.

 13. SiSU has worked this way in the past, though this was dropped as it was thought the complexity outweighed the flexibility, however, the balance was rather fine and this behaviour could be reinstated.

 14.http://www.postgresql.org/
http://advocacy.postgresql.org/
http://en.wikipedia.org/wiki/Postgresql

 15.http://www.hwaci.com/sw/sqlite/
http://en.wikipedia.org/wiki/Sqlite

 16.http://search.sisudoc.org

 17. (which could be extended further with current back-end). As regards scaling of the database, it is as scalable as the database (here Postgresql) and hardware allow.

 18. of this feature when demonstrated to an IBM software innovations evaluator in 2004 he said to paraphrase: this could be of interest to us. We have large document management systems, you can search hundreds of thousands of documents and we can tell you which documents meet your search criteria, but there is no way we can tell you without opening each document where within each your matches are found.

 19.http://www.jus.uio.no/sisu/pkg/src/

 20.http://www.jus.uio.no/sisu/pkg/src/

 21.http://www.kernel.org/pub/software/scm/git/docs/user-manual.html

 22.http://www.kernel.org/pub/software/scm/git/docs/everyday.html

 23.http://www.kernel.org/pub/software/scm/git/docs/v1.4.4.4/tutorial.html

 24.http://www.kernel.org/pub/software/scm/git/docs/v1.4.4.4/tutorial-2.html

 25.http://book.git-scm.com/index.html

 26.http://www-cs-students.stanford.edu/~blynn/gitmagic/

 27.http://www.newartisans.com/blog_assets/git.from.bottom.up.pdf

 28.http://www.jus.uio.no/sisu/archive/pool/main/s/sisu/
sisu, the base code, (the main package on which the others depend), without any dependencies other than ruby (and for convenience the ruby webrick web server), this generates a number of types of output on its own, other packages provide additional functionality, and have their dependencies
Depends: ruby (>=1.8.7), libwebrick-ruby
Recommends: sisu -pdf, sisu -sqlite, sisu -postgresql, sisu -examples, vim-sisu, librmagick-ruby, trang, tidy, libtidy, librexml-ruby, zip, unzip, openssl

 29.http://www.jus.uio.no/sisu/archive/pool/main/s/sisu/
a package that pulls in other packages to build the whole of sisu (excluding sisu -examples)
Depends: ruby (>=1.8.7), sisu, sisu -pdf, sisu -postgresql, sisu -remote, sisu -sqlite, vim-sisu
Recommends: sisu -examples

 30.http://www.jus.uio.no/sisu/archive/pool/main/s/sisu/
dependencies used by sisu to produce PDF from LaTeX generated
Depends: sisu, tetex-bin, tetex-extra, latex-ucs
Suggests: evince, xpdf

 31.http://www.jus.uio.no/sisu/archive/pool/main/s/sisu/
dependencies used by sisu to populate postgresql database (further configuration is necessary)
Depends: sisu, postgresql, libdbi-ruby, libdbm-ruby, libdbd-pg-ruby
Suggests: pgaccess, libdbd-pgsql, postgresql-contrib

 32.http://www.jus.uio.no/sisu/archive/pool/main/s/sisu/
dependencies used by sisu to populate sqlite database
Depends: sisu, sqlite, libdbi-ruby, libdbm-ruby, libdbd-sqlite-ruby
Suggests: libdbd-sqlite

 33.http://www.jus.uio.no/sisu/archive/pool/non-free/s/sisu-markup-samples/
marked up documents and other examples related to sisu, a larger package containing a number of texts
Depends: sisu

 34.http://www.jus.uio.no/sisu/pkg/src/
sisu-markup-samples_[version].dsc

 35.http://www.kitenet.net/programs/alien/

 36.http://www.jus.uio.no/sisu/pkg/rpm/
created using alien

 37.http://www.jus.uio.no/sisu/pkg/rpm/
http://www.jus.uio.no/sisu/archive/pool/non-free/s/sisu-markup-samples/
created using: alien -r sisu_[version]_all.deb

 38.http://packages.qa.debian.org/s/sisu.html

 39. from the Debian control file

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

 41.http://www.jus.uio.no/sisu/man/sisu.1.html

 42.http://www.jus.uio.no/sisu/man/sisu.8.html

 43.http://www.jus.uio.no/sisu/man

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

 45. generated from source using rman
http://polyglotman.sourceforge.net/rman.html \With regard to SiSU man pages the formatting generated for markup syntax is not quite right, for that you might prefer the links under:
http://www.jus.uio.no/sample

 46.http://www.jus.uio.no/sisu/man/

 47.http://www.jus.uio.no/sisu/man/sisu.1.html

 48.http://www.jus.uio.no/sisu/man/sisu.8.html

 49.http://www.jus.uio.no/sisu/man/sisu_webrick.1.html

 50. this is an endnote

 51.http://www.sisudoc.org

 52.http://www.sisudoc.org

 53. named index.html or more extensively through sisu_manifest.html


[ document manifest ]

<< previous toc next >>