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?

Commands Summary

Description
Document Processing Command Flags

Description

SiSU is a document publishing system, that from a simple single marked-up document, produces multiple output formats including: plaintext, HTML, XHTML, XML, EPUB, ODT (OpenDocument (ODF) text), LaTeX, PDF, info, and SQL (PostgreSQL and SQLite) , which share text object numbers ("object citation numbering") and the same document structure information. For more see: ‹http://sisudoc.org› or ‹http://www.jus.uio.no/sisu

Document Processing Command Flags

-[0-9] [filename/wildcard]
see --act

--ao [filename/wildcard/url]
assumed for most other flags, creates new intermediate files for processing (abstract objects, document abstraction) that is used in all subsequent processing of other output. This step is assumed for most processing flags. To skip it see -n. Alias -m.

--act[s0-9] [filename/wildcard]
--act0 to --act9 configurable shortcuts for multiple flags, -0 to -9 synonyms, configure in sisurc.yml; sisu default action on a specified file where no flag is provided is --act0; --act or --acts for information on current actions ascribed to --act0 to --act9

--asciidoc [filename/wildcard]
asciidoc, smart text (not available)

-b [filename/wildcard]
see --xhtml

--by-*
see --output-by-*

-C
configure/initialise shared output directory files initialize shared output directory (config files such as css and dtd files are not updated if they already exist unless modifier is used). -C --init-site configure/initialise site more extensive than -C on its own, shared output directory files/force update, existing shared output config files such as css and dtd files are updated if this modifier is used.

-c [filename/wildcard]
see --color-toggle

--color
see --color-on

--color-off
turn off color in output to terminal

--color-on
turn on color in output to terminal

--color-toggle [filename/wildcard]
screen toggle ansi screen colour on or off depending on default set (unless -c flag is used: if sisurc colour default is set to 'true', output to screen will be with colour, if sisurc colour default is set to 'false' or is undefined screen output will be without colour). Alias -c

--configure
configure/initialise shared output directory files initialize shared output directory (config files such as css and dtd files are not updated if they already exist unless modifier is used). The equivalent of: -C --init-site configure/initialise site, more extensive than -C on its own, shared output directory files/force update, existing shared output config files such as css and dtd files are updated if -CC is used.

--concordance [filename/wildcard]
produces concordance (wordmap) a rudimentary index of all the words in a document. (Concordance files are not generated for documents of over 260,000 words unless this limit is increased in the file sisurc.yml). Alias -w

-d [filename/wildcard/url]
see --docbook

--dal [filename/wildcard/url]
(abstract objects, document abstraction renamed abstract objects in sisu5) see --ao

--delete [filename/wildcard]
see --zap

--digests [filename/wildcard/url]
document digest or document content certificate ( DCC ) as sha digest tree of the document: the digest for the document, and digests for each object contained within the document (together with information on software versions that produced it) (digest.txt). --digests -V for verbose digest output to screen.

--docbook [filename/wildcard/url]
docbook xml

--dom [filename/wildcard/url]
see --xml-dom

--dump[=directory_path] [filename/wildcard]
places output in directory specified, if none is specified in the current directory (pwd). Unlike using default settings HTML files have embedded css. Compare --redirect

-e [filename/wildcard]
see --epub

--epub [filename/wildcard]
produces an epub document, [sisu version >=2 ] (filename.epub). Alias -e

--errors-as-warnings
override stop processing on error. Alias --no-stop

--exc-*
exclude output feature, overrides configuration settings --exc-numbering, see --exc-ocn; --exc-ocn, (exclude "object citation numbering", (switches off object citation numbers), affects html (seg, scroll), epub, xhtml, xml, pdf) ; --exc-toc, (exclude table of contents, affects html (scroll), epub, pdf) ; --exc-links-to-manifest, --exc-manifest-links, (exclude links to manifest, affects html (seg, scroll)); --exc-search-form, (exclude search form, affects html (seg, scroll), manifest); --exc-minitoc, (exclude mini table of contents, affects html (seg), concordance, manifest); --exc-manifest-minitoc, (exclude mini table of contents, affects manifest); --exc-html-minitoc, (exclude mini table of contents, affects html (seg), concordance); --exc-html-navigation, (exclude navigation, affects html (seg)); --exc-html-navigation-bar, (exclude navigation bar, affects html (seg)); --exc-html-search-form, (exclude search form, affects html (seg, scroll)); --exc-html-right-pane, (exclude right pane/column, affects html (seg, scroll)); --exc-html-top-band, (exclude top band, affects html (seg, scroll), concordance (minitoc forced on to provide seg navigation)); --exc-segsubtoc (exclude sub table of contents, affects html (seg), epub) ; see also --inc-*

-F [--webserv=webrick]
see --sample-search-form

-f [optional string part of filename]
see --find

--fictionbook [filename/wildcard/url]
fictionbook xml (not available)

--find [optional string part of filename]
see --glob

-G [optional string part of filename]
see --glob

-g [filename/wildcard]
see --git

--git [filename/wildcard]
produces or updates markup source file structure in a git repo (experimental and subject to change). Alias -g

--glob [optional string part of filename]
without match string, glob all .sst .ssm files in directory (including language subdirectories). With match string, find files that match given string in directory (including language subdirectories). Alias -G, -f, --find

-h [filename/wildcard]
see --html

--harvest *.ss[tm]
makes two lists of sisu output based on the sisu markup documents in a directory: list of author and authors works (year and titles), and; list by topic with titles and author. Makes use of header metadata fields (author, title, date, topic_register). Can be used with maintenance (-M) and remote placement (-R) flags.

--html [filename/wildcard]
produces html output, in two forms (i) segmented text with table of contents (toc.html and index.html) and (ii) the document in a single file (scroll.html). Alias -h

--html-scroll [filename/wildcard]
produces html output, the document in a single file (scroll.html) only. Compare --html-seg and --html

--html-seg [filename/wildcard]
produces html output, segmented text with table of contents (toc.html and index.html). Compare --html-scroll and --html

--html-strict [filename/wildcard]
produces html with --strict option. see --strict

-I [filename/wildcard]
see --texinfo

-i [filename/wildcard]
see --manpage

--i18n-*
these flags affect output by filetype and filename): --i18n-mono (--monolingual) output filenames without language code for default language ('en' or as set); --i18n-multi (--multilingual) language code provided as part of the output filename, this is the default. Where output is in one language only the language code may not be desired. see also --output-by-*

--inc-*
include output feature, overrides configuration settings, (usually the default if none set), has precedence over --exc-* (exclude output feature). Some detail provided under --exc-*, see --exc-*

-j [filename/wildcard]
copies images associated with a file for use by html, xhtml & xml outputs (automatically invoked by --dump & redirect).

-k
see --color-off

--keep-processing-files [filename/wildcard/url]
see --maintenance

-M [filename/wildcard/url]
see --maintenance

-m [filename/wildcard/url]
see --dal (document abstraction level/layer)

--machine [filename/wildcard/url]
see --dal (document abstraction level/layer)

--maintenance [filename/wildcard/url]
maintenance mode, interim processing files are preserved and their locations indicated. (also see -V). Aliases -M and --keep-processing-files.

--manifest [filename/wildcard]
produces an html summary of output generated (hyperlinked to content) and document specific metadata (sisu_manifest.html). This step is assumed for most processing flags.

--manpage [filename/wildcard]
produces man page of file, not suitable for all outputs. Alias -i

--markdown [filename/wildcard/url]
markdown smart text (not available)

--monolingual
see --i18n-*

--multilingual
see --i18n-*

-N [filename/wildcard/url]
see --digests

-n [filename/wildcard/url]
skip the creation of intermediate processing files (document abstraction) if they already exist, this skips the equivalent of -m which is otherwise assumed by most processing flags.

--no-*
see --exc-*

--no-stop
override stop processing on error. Alias --erros-as-warnings

--numbering
turn on "object citation numbers". See --inc-ocn and --exc-ocn

-o [filename/wildcard/url]
see --odt

--ocn
"object citation numbers". See --inc-ocn and --exc-ocn

--odf [filename/wildcard/url]
see --odt

--odt [filename/wildcard/url]
output basic document in opendocument file format (opendocument.odt). Alias -o

--output-by-*
select output directory structure from 3 alternatives: --output-by-language, (language directory (based on language code) with filetype (html, epub, pdf etc.) subdirectories); --output-by-filetype, (filetype directories with language code as part of filename); --output-by-filename, (filename directories with language code as part of filename). This is configurable. Alias --by-*

-P [language_directory/filename language_directory]
see --po4a

-p [filename/wildcard]
see --pdf

--papersize-(a4|a5|b5|letter|legal)
in conjunction with --pdf set pdf papersize, overriding any configuration settings, to set more than one papersize repeat the option --pdf --papersize-a4 --papersize-letter. See also --papersize=*

--papersize=a4,a5,b5,letter,legal in conjunction with --pdf set pdf papersize, overriding any configuration settings, to set more than one papersize list after the equal sign with a comma separator --papersize=a4,letter. See also --papersize-*

--pdf [filename/wildcard]
produces LaTeX pdf (portrait.pdf & landscape.pdf). Orientation and papersize may be set on the command-line. Default paper size is set in config file, or document header, or provided with additional command line parameter, e.g. --papersize-a4 preset sizes include: 'A4', U.S. 'letter' and 'legal' and book sizes 'A5' and 'B5' (system defaults to A4), and; --landscape or --portrait, so: e.g. "sisu --pdf-a4 --pdf-letter --landscape --verbose [filename/wildcard]" or "sisu --pdf --landscape --a4 --letter --verbose [filename/wildcard]". --pdf defaults to both landscape & portrait output, and a4 if no other papersizes are configured. Related options --pdf-landscape --pdf-portrait --pdf-papersize-* --pdf-papersize=[list]. Alias -p

--pdf-l [filename/wildcard]
See --pdf-landscape

--pdf-landscape [filename/wildcard]
sets orientation, produces LaTeX pdf landscape.pdf. Default paper size is set in config file, or document header, or provided with additional command line parameter, e.g. --papersize-a4 preset sizes include: 'A4', U.S. 'letter' and 'legal' and book sizes 'A5' and 'B5' (system defaults to A4). Related options --pdf --pdf-portrait. See also --papersize-* or --papersize=[list]. Alias --pdf-l or in conjunction with --pdf --landscape

--pdf-p [filename/wildcard]
See --pdf-portrait

--pdf-portrait [filename/wildcard]
sets orientation, produces LaTeX pdf portrait.pdf.pdf. Default paper size is set in config file, or document header, or provided with additional command line parameter, e.g. --papersize-a4 preset sizes include: 'A4', U.S. 'letter' and 'legal' and book sizes 'A5' and 'B5' (system defaults to A4). Related options --pdf --pdf-landscape. See also --papersize-* or --papersize=[list]. Alias --pdf-p or in conjunction with --pdf --portrait

--pg-[instruction] [filename]
database PostgreSQL ( --pgsql may be used instead) possible instructions, include: --pg-createdb; --pg-create; --pg-dropall; --pg-import [filename]; --pg-update [filename]; --pg-remove [filename]; see database section below.

--po [language_directory/filename language_directory]
see --po4a

--po4a [language_directory/filename language_directory]
produces .pot and po files for the file in the languages specified by the language directory. SiSU markup is placed in subdirectories named with the language code, e.g. en/ fr/ es/. The sisu config file must set the output directory structure to multilingual. v3, experimental

-Q [filename/wildcard]
see --qrcode

-q [filename/wildcard]
see --quiet

--qrcode [filename/wildcard]
generate QR code image of metadata (used in manifest).

--quiet [filename/wildcard]
quiet less output to screen.

-R [filename/wildcard]
see --rsync

-r [filename/wildcard]
see --scp

--redirect[=directory_path] [filename/wildcard]
places output in subdirectory under specified directory, subdirectory uses the filename (without the suffix). If no output directory is specified places the subdirectory under the current directory (pwd). Unlike using default settings HTML files have embedded css. Compare --dump

--rst [filename/wildcard/url]
ReST (rST restructured text) smart text (not available)

--rsync [filename/wildcard]
copies sisu output files to remote host using rsync. This requires that sisurc.yml has been provided with information on hostname and username, and that you have your "keys" and ssh agent in place. Note the behavior of rsync different if -R is used with other flags from if used alone. Alone the rsync --delete parameter is sent, useful for cleaning the remote directory (when -R is used together with other flags, it is not). Also see --scp. Alias -R

-S
see --sisupod

-S [filename/wildcard]
see --sisupod

-s [filename/wildcard]
see --source

--sample-search-form [--db-(pg|sqlite)]
generate examples of (naive) cgi search form for SQLite or PgSQL depends on your already having used sisu to populate an SQLite or PgSQL database, (the SQLite version scans the output directories for existing sisu_sqlite databases, so it is first necessary to create them, before generating the search form) see --sqlite & --pg and the database section below. Optional additional parameters: --db-user='www-data'. The samples are dumped in the present work directory which must be writable, (with screen instructions given that they be copied to the cgi-bin directory). Alias -F

--sax [filename/wildcard/url]
see --xml-sax

--scp [filename/wildcard]
copies sisu output files to remote host using scp. This requires that sisurc.yml has been provided with information on hostname and username, and that you have your "keys" and ssh agent in place. Also see --rsync. Alias -r

--sha256
set hash digest where used to sha256

--sha512
set hash digest where used to sha512

--sqlite-[instruction] [filename]
database type set to SQLite, this produces one of two possible databases, without additional database related instructions it produces a discreet SQLite file for the document processed; with additional instructions it produces a common SQLite database of all processed documents that (come from the same document preparation directory and as a result) share the same output directory base path (possible instructions include: --sqlite-createdb; --sqlite-create; --sqlite-dropall; --sqlite-import [filename]; --sqlite-update [filename]; --sqlite-remove [filename]); see database section below.

--sisupod
produces a sisupod a zipped sisu directory of markup files including sisu markup source files and the directories local configuration file, images and skins. Note: this only includes the configuration files or skins contained in ./_sisu not those in ~/.sisu -S [filename/wildcard] option. Note: (this option is tested only with zsh). Alias -S

--sisupod [filename/wildcard]
produces a zipped file of the prepared document specified along with associated images, by default named sisupod.zip they may alternatively be named with the filename extension .ssp This provides a quick way of gathering the relevant parts of a sisu document which can then for example be emailed. A sisupod includes sisu markup source file, (along with associated documents if a master file, or available in multilingual versions), together with related images and skin. SiSU commands can be run directly against a sisupod contained in a local directory, or provided as a url on a remote site. As there is a security issue with skins provided by other users, they are not applied unless the flag --trust or --trusted is added to the command instruction, it is recommended that file that are not your own are treated as untrusted. The directory structure of the unzipped file is understood by sisu, and sisu commands can be run within it. Note: if you wish to send multiple files, it quickly becomes more space efficient to zip the sisu markup directory, rather than the individual files for sending). See the -S option without [filename/wildcard]. Alias -S

--source [filename/wildcard]
copies sisu markup file to output directory. Alias -s

--strict
together with --html, produces more w3c compliant html, for example not having purely numeric identifiers for text, the location object url#33 becomes url#o33

-T [filename/wildcard (*.termsheet.rb)]
standard form document builder, preprocessing feature

-t [filename/wildcard]
see --txt

--texinfo [filename/wildcard]
produces texinfo and info file, (view with pinfo). Alias -I

--textile [filename/wildcard/url]
textile smart text (not available)

--txt [filename/wildcard]
produces plaintext with Unix linefeeds and without markup, (object numbers are omitted), has footnotes at end of each paragraph that contains them [ -A for equivalent dos (linefeed) output file] [see -e for endnotes]. (Options include: --endnotes for endnotes --footnotes for footnotes at the end of each paragraph --unix for unix linefeed (default) --msdos for msdos linefeed). Alias -t

--txt-asciidoc [filename/wildcard]
see --asciidoc

--txt-markdown [filename/wildcard]
see --markdown

--txt-rst [filename/wildcard]
see --rst

--txt-textile [filename/wildcard]
see --textile

-U [filename/wildcard]
see --urls

-u [filename/wildcard]
provides url mapping of output files for the flags requested for processing, also see -U

--urls [filename/wildcard]
prints url output list/map for the available processing flags options and resulting files that could be requested, (can be used to get a list of processing options in relation to a file, together with information on the output that would be produced), -u provides url output mapping for those flags requested for processing. The default assumes sisu_webrick is running and provides webrick url mappings where appropriate, but these can be switched to file system paths in sisurc.yml. Alias -U

-V
on its own, provides SiSU version and environment information (sisu --help env)

-V [filename/wildcard]
even more verbose than the -v flag.

-v
on its own, provides SiSU version information

-v [filename/wildcard]
see --verbose

--verbose [filename/wildcard]
provides verbose output of what is being generated, where output is placed (and error messages if any), as with -u flag provides a url mapping of files created for each of the processing flag requests. Alias -v

--very-verbose [filename/wildcard]
provides more verbose output of what is being generated. See --verbose. Alias -V

--version
sisu version

-W
see --webrick

-w [filename/wildcard]
see --concordance

--webrick
starts ruby' s webrick webserver points at sisu output directories, the default port is set to 8081 and can be changed in the resource configuration files. [tip: the webrick server requires link suffixes, so html output should be created using the -h option rather than -H ; also, note -F webrick ]. Alias -W

--wordmap [filename/wildcard]
see --concordance

--xhtml [filename/wildcard]
produces xhtml/XML output for browser viewing (sax parsing). Alias -b

--xml-dom [filename/wildcard]
produces XML output with deep document structure, in the nature of dom. Alias -X

--xml-sax [filename/wildcard]
produces XML output shallow structure (sax parsing). Alias -x

-X [filename/wildcard]
see --xml-dom

-x [filename/wildcard]
see --xml-sax

-Y [filename/wildcard]
produces a short sitemap entry for the document, based on html output and the sisu_manifest. --sitemaps generates/updates the sitemap index of existing sitemaps. (Experimental, [g,y,m announcement this week])

-y [filename/wildcard]
see --manifest

-Z [filename/wildcard]
see --zap

--zap [filename/wildcard]
Zap, if used with other processing flags deletes output files of the type about to be processed, prior to processing. If -Z is used as the lone processing related flag (or in conjunction with a combination of -[mMvVq]), will remove the related document output directory. Alias -Z


[ document manifest ]

<< previous toc next >>