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

Heading Levels

Heading levels are :A~ ,:B~ ,:C~ ,1~ ,2~ ,3~ ... :A - :C being part / section headings, followed by other heading levels, and 1 -6 being headings followed by substantive text or sub-headings. :A~ usually the title :A~? conditional level 1 heading (used where a stand-alone document may be imported into another)

:A~ [heading text] Top level heading [this usually has similar content to the title @title: ] NOTE: the heading levels described here are in 0.38 notation, see heading

:B~ [heading text] Second level heading [this is a heading level divider]

:C~ [heading text] Third level heading [this is a heading level divider]

1~ [heading text] Top level heading preceding substantive text of document or sub-heading 2, the heading level that would normally be marked 1. or 2. or 3. etc. in a document, and the level on which sisu by default would break html output into named segments, names are provided automatically if none are given (a number), otherwise takes the form 1~my_filename_for_this_segment

2~ [heading text] Second level heading preceding substantive text of document or sub-heading 3 , the heading level that would normally be marked 1.1 or 1.2 or 1.3 or 2.1 etc. in a document.

3~ [heading text] Third level heading preceding substantive text of document, that would normally be marked 1.1.1 or 1.1.2 or 1.2.1 or 2.1.1 etc. in a document

1~filename level 1 heading,

% the primary division such as Chapter that is followed by substantive text, and may be further subdivided (this is the level on which by default html segments are made)

Font Attributes

markup example:

normal text, *{emphasis}*, !{bold text}!, /{italics}/, _{underscore}_, "{citation}",
^{superscript}^, ,{subscript},, +{inserted text}+, -{strikethrough}-, #{monospace}#

normal text

*{emphasis}* [note: can be configured to be represented by bold, italics or underscore]

!{bold text}!

/{italics}/

_{underscore}_

"{citation}"

^{superscript}^

,{subscript},

+{inserted text}+

-{strikethrough}-

#{monospace}#

resulting output:

normal text, emphasis, bold text, italics, underscore, citation, superscript, subscript, inserted text, strikethrough, monospace

normal text

emphasis [note: can be configured to be represented by bold, italics or underscore]

bold text

italics

underscore

citation

superscript

subscript

inserted text

strikethrough

monospace

Indentation and bullets

markup example:

ordinary paragraph

_1 indent paragraph one step

_2 indent paragraph two steps

_9 indent paragraph nine steps

resulting output:

ordinary paragraph

indent paragraph one step

indent paragraph two steps

indent paragraph nine steps

markup example:

_* bullet text

_1* bullet text, first indent

_2* bullet text, two step indent

resulting output:

Numbered List (not to be confused with headings/titles, (document structure))

markup example:

# numbered list                numbered list 1., 2., 3, etc.

_# numbered list numbered list indented a., b., c., d., etc.

Hanging Indents

markup example:

_0_1 first line no indent,
rest of paragraph indented one step

_1_0 first line indented,
rest of paragraph no indent

in each case level may be 0-9

resulting output:

first line no indent, rest of paragraph indented one step; first line no indent, rest of paragraph indented one step; first line no indent, rest of paragraph indented one step; first line no indent, rest of paragraph indented one step; first line no indent, rest of paragraph indented one step; first line no indent, rest of paragraph indented one step; first line no indent, rest of paragraph indented one step; first line no indent, rest of paragraph indented one step; first line no indent, rest of paragraph indented one step;

A regular paragraph.

first line indented, rest of paragraph no indent first line indented, rest of paragraph no indent first line indented, rest of paragraph no indent first line indented, rest of paragraph no indent first line indented, rest of paragraph no indent first line indented, rest of paragraph no indent first line indented, rest of paragraph no indent first line indented, rest of paragraph no indent first line indented, rest of paragraph no indent first line indented, rest of paragraph no indent first line indented, rest of paragraph no indent

in each case level may be 0-9

live-build A collection of scripts used to build customized Debian Livesystems. live-build was formerly known as live-helper, and even earlier known as live-package.

live-build
A collection of scripts used to build customized Debian Livesystems. live-build was formerly known as live-helper, and even earlier known as live-package.

Footnotes / Endnotes

Footnotes and endnotes are marked up at the location where they would be indicated within a text. They are automatically numbered. The output type determines whether footnotes or endnotes will be produced

markup example:

~{ a footnote or endnote }~

resulting output:

  5 

markup example:

normal text~{ self contained endnote marker & endnote in one }~ continues

resulting output:

normal text  6  continues

markup example:

normal text ~{* unnumbered asterisk footnote/endnote, insert multiple asterisks if required }~ continues

normal text ~{** another unnumbered asterisk footnote/endnote }~ continues

resulting output:

normal text   *  continues

normal text   **  continues

markup example:

normal text ~[* editors notes, numbered asterisk footnote/endnote series ]~ continues

normal text ~[+ editors notes, numbered plus symbol footnote/endnote series ]~ continues

resulting output:

normal text   *3  continues

normal text   +2  continues

Alternative endnote pair notation for footnotes/endnotes:

% note the endnote marker "~^"

normal text~^ continues

^~ endnote text following the paragraph in which the marker occurs

the standard and pair notation cannot be mixed in the same document

Links

Naked URLs within text, dealing with urls

urls found within text are marked up automatically. A url within text is automatically hyperlinked to itself and by default decorated with angled braces, unless they are contained within a code block (in which case they are passed as normal text), or escaped by a preceding underscore (in which case the decoration is omitted).

markup example:

normal text http://www.sisudoc.org/ continues

resulting output:

normal text ‹http://www.sisudoc.org/› continues

An escaped url without decoration

markup example:

normal text _http://www.sisudoc.org/ continues

deb _http://www.jus.uio.no/sisu/archive unstable main non-free

resulting output:

normal text http://www.sisudoc.org/ continues

deb http://www.jus.uio.no/sisu/archive unstable main non-free

where a code block is used there is neither decoration nor hyperlinking, code blocks are discussed later in this document

resulting output:

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

Linking Text

To link text or an image to a url the markup is as follows

markup example:

about { SiSU }http://url.org markup

resulting output:

about SiSU markup

A shortcut notation is available so the url link may also be provided automatically as a footnote

markup example:

about {~^ SiSU }http://url.org markup

resulting output:

about SiSU   7  markup

Internal document links to a tagged location, including an ocn

markup example:

about { text links }#link_text

resulting output:

about text links

Shared document collection link

markup example:

about { SiSU book markup examples }:SiSU/examples.html

resulting output:

about SiSU book markup examples

Linking Images

markup example:

{ tux.png 64x80 }image

% various url linked images

{tux.png 64x80 "a better way" }http://www.sisudoc.org/

{GnuDebianLinuxRubyBetterWay.png 100x101 "Way Better - with Gnu/Linux, Debian and Ruby" }http://www.sisudoc.org/

{~^ ruby_logo.png "Ruby" }http://www.ruby-lang.org/en/

resulting output:


Gnu/Linux - a better way


Way Better - with Gnu/Linux, Debian and Ruby


Ruby

  8 

linked url footnote shortcut

{~^ [text to link] }http://url.org

% maps to: { [text to link] }http://url.org ~{ http://url.org }~

% which produces hyper-linked text within a document/paragraph, with an endnote providing the url for the text location used in the hyperlink

text marker *~name

note at a heading level the same is automatically achieved by providing names to headings 1, 2 and 3 i.e. 2~[name] and 3~[name] or in the case of auto-heading numbering, without further intervention.

Link shortcut for multiple versions of a sisu document in the same directory tree

markup example:

!_ /{"Viral Spiral"}/, David Bollier

{ "Viral Spiral", David Bollier [3sS]}viral_spiral.david_bollier.sst

"Viral Spiral", David Bollier

⌠"Viral Spiral", David Bollier [3sS]⌡viral_spiral.david_bollier.sst

Grouped Text / blocked text

There are two markup syntaxes for blocked text, using curly braces or using tics

blocked text curly brace syntax

at the start of a line on its own use name of block type with an opening curly brace, follow with the content of the block, and close with a closing curly brace and the name of the block type, e.g.

code{
this is a code block

}code

poem{

this here is a poem

}poem

blocked text tic syntax

``` code
this is a code block

```

``` poem

this here is a poem

```

start a line with three backtics, a space followed by the name of the name of block type, follow with the content of the block, and close with three back ticks on a line of their own, e.g.

Tables

Tables may be prepared in two either of two forms

markup example:

table{ c3; 40; 30; 30;

This is a table
this would become column two of row one
column three of row one is here

And here begins another row
column two of row two
column three of row two, and so on

}table

resulting output:

This is a tablethis would become column two of row onecolumn three of row one is here
And here begins another rowcolumn two of row twocolumn three of row two, and so on

a second form may be easier to work with in cases where there is not much information in each column

markup example:  9 

!_ Table 3.1: Contributors to Wikipedia, January 2001 - June 2005

{table~h 24; 12; 12; 12; 12; 12; 12;}
                                |Jan. 2001|Jan. 2002|Jan. 2003|Jan. 2004|July 2004|June 2006
Contributors*                   |       10|      472|    2,188|    9,653|   25,011|   48,721
Active contributors**           |        9|      212|      846|    3,228|    8,442|   16,945
Very active contributors***     |        0|       31|      190|      692|    1,639|    3,016
No. of English language articles|       25|   16,000|  101,000|  190,000|  320,000|  630,000
No. of articles, all languages  |       25|   19,000|  138,000|  490,000|  862,000|1,600,000

* Contributed at least ten times; ** at least 5 times in last month; *** more than 100 times in last month.

resulting output:

Table 3.1: Contributors to Wikipedia, January 2001 - June 2005

Jan. 2001Jan. 2002Jan. 2003Jan. 2004July 2004June 2006
Contributors*104722,1889,65325,01148,721
Active contributors**92128463,2288,44216,945
Very active contributors***0311906921,6393,016
No. of English language articles2516,000101,000190,000320,000630,000
No. of articles, all languages2519,000138,000490,000862,0001,600,000

* Contributed at least ten times; ** at least 5 times in last month; *** more than 100 times in last month.

Poem

basic markup:

poem{

  Your poem here

}poem

Each verse in a poem is given an object number.

markup example:

poem{

                    `Fury said to a
                   mouse, That he
                 met in the
               house,
            "Let us
              both go to
                law:  I will
                  prosecute
                    YOU.  --Come,
                       I'll take no
                        denial; We
                     must have a
                 trial:  For
              really this
           morning I've
          nothing
         to do."
           Said the
             mouse to the
               cur, "Such
                 a trial,
                   dear Sir,
                         With
                     no jury
                  or judge,
                would be
              wasting
             our
              breath."
               "I'll be
                 judge, I'll
                   be jury,"
                         Said
                    cunning
                      old Fury:
                     "I'll
                      try the
                         whole
                          cause,
                             and
                        condemn
                       you
                      to
                       death."'

}poem

resulting output:

                    `Fury said to a
                   mouse, That he
                 met in the
               house,
            "Let us
              both go to
                law:  I will
                  prosecute
                    YOU.  --Come,
                       I'll take no
                        denial; We
                     must have a
                 trial:  For
              really this
           morning I've
          nothing
         to do."
           Said the
             mouse to the
               cur, "Such
                 a trial,
                   dear Sir,
                         With
                     no jury
                  or judge,
                would be
              wasting
             our
              breath."
               "I'll be
                 judge, I'll
                   be jury,"
                         Said
                    cunning
                      old Fury:
                     "I'll
                      try the
                         whole
                          cause,
                             and
                        condemn
                       you
                      to
                       death."'

Group

basic markup:

group{

  Your grouped text here

}group

A group is treated as an object and given a single object number.

markup example:

group{

                    `Fury said to a
                   mouse, That he
                 met in the
               house,
            "Let us
              both go to
                law:  I will
                  prosecute
                    YOU.  --Come,
                       I'll take no
                        denial; We
                     must have a
                 trial:  For
              really this
           morning I've
          nothing
         to do."
           Said the
             mouse to the
               cur, "Such
                 a trial,
                   dear Sir,
                         With
                     no jury
                  or judge,
                would be
              wasting
             our
              breath."
               "I'll be
                 judge, I'll
                   be jury,"
                         Said
                    cunning
                      old Fury:
                     "I'll
                      try the
                         whole
                          cause,
                             and
                        condemn
                       you
                      to
                       death."'

}group

resulting output:

                    `Fury said to a
                   mouse, That he
                 met in the
               house,
            "Let us
              both go to
                law:  I will
                  prosecute
                    YOU.  --Come,
                       I'll take no
                        denial; We
                     must have a
                 trial:  For
              really this
           morning I've
          nothing
         to do."
           Said the
             mouse to the
               cur, "Such
                 a trial,
                   dear Sir,
                         With
                     no jury
                  or judge,
                would be
              wasting
             our
              breath."
               "I'll be
                 judge, I'll
                   be jury,"
                         Said
                    cunning
                      old Fury:
                     "I'll
                      try the
                         whole
                          cause,
                             and
                        condemn
                       you
                      to
                       death."'

Code

Code tags code{ ... }code (used as with other group tags described above) are used to escape regular sisu markup, and have been used extensively within this document to provide examples of SiSU markup. You cannot however use code tags to escape code tags. They are however used in the same way as group or poem tags.

A code-block is treated as an object and given a single object number. [an option to number each line of code may be considered at some later time]

use of code tags instead of poem compared, resulting output:

                    `Fury said to a
                   mouse, That he
                 met in the
               house,
            "Let us
              both go to
                law:  I will
                  prosecute
                    YOU.  --Come,
                       I'll take no
                        denial; We
                     must have a
                 trial:  For
              really this
           morning I've
          nothing
         to do."
           Said the
             mouse to the
               cur, "Such
                 a trial,
                   dear Sir,
                         With
                     no jury
                  or judge,
                would be
              wasting
             our
              breath."
               "I'll be
                 judge, I'll
                   be jury,"
                         Said
                    cunning
                      old Fury:
                     "I'll
                      try the
                         whole
                          cause,
                             and
                        condemn
                       you
                      to
                       death."'

From SiSU 2.7.7 on you can number codeblocks by placing a hash after the opening code tag code{# as demonstrated here:

1  ┆                    `Fury said to a
2  ┆                   mouse, That he
3  ┆                 met in the
4  ┆               house,
5  ┆            "Let us
6  ┆              both go to
7  ┆                law:  I will
8  ┆                  prosecute
9  ┆                    YOU.  --Come,
10 ┆                       I'll take no
11 ┆                        denial; We
12 ┆                     must have a
13 ┆                 trial:  For
14 ┆              really this
15 ┆           morning I've
16 ┆          nothing
17 ┆         to do."
18 ┆           Said the
19 ┆             mouse to the
20 ┆               cur, "Such
21 ┆                 a trial,
22 ┆                   dear Sir,
23 ┆                         With
24 ┆                     no jury
25 ┆                  or judge,
26 ┆                would be
27 ┆              wasting
28 ┆             our
29 ┆              breath."
30 ┆               "I'll be
31 ┆                 judge, I'll
32 ┆                   be jury,"
33 ┆                         Said
34 ┆                    cunning
35 ┆                      old Fury:
36 ┆                     "I'll
37 ┆                      try the
38 ┆                         whole
39 ┆                          cause,
40 ┆                             and
41 ┆                        condemn
42 ┆                       you
43 ┆                      to
44 ┆                       death."'

Additional breaks - linebreaks within objects, column and page-breaks

line-breaks

To break a line within a "paragraph object", two backslashes \\
with a space before and a space or newline after them
may be used.

To break a line within a "paragraph object",
two backslashes \\ with a space before
and a space or newline after them \\
may be used.

The html break br enclosed in angle brackets (though undocumented) is available in versions prior to 3.0.13 and 2.9.7 (it remains available for the time being, but is depreciated).

To draw a dividing line dividing paragraphs, see the section on page breaks.

page breaks

Page breaks are only relevant and honored in some output formats. A page break or a new page may be inserted manually using the following markup on a line on its own:

page new =\= breaks the page, starts a new page.

page break -\- breaks a column, starts a new column, if using columns, else breaks the page, starts a new page.

page break line across page -..- draws a dividing line, dividing paragraphs

page break:

-\\-

page (break) new:

=\\=

page (break) line across page (dividing paragraphs):

-..-

Bibliography / References

There are three ways to prepare a bibliography using sisu (which are mutually exclusive): (i) manually preparing and marking up as regular text in sisu a list of references, this is treated as a regular document segment (and placed before endnotes if any); (ii) preparing a bibliography, marking a heading level 1~!biblio (note the exclamation mark) and preparing a bibliography using various metadata tags including for author: title: year: a list of which is provided below, or; (iii) as an assistance in preparing a bibliography, marking a heading level 1~!biblio and tagging citations within footnotes for inclusion, identifying citations and having a parser attempt to extract them and build a bibliography of the citations provided.

For the heading/section sequence: endnotes, bibliography then book index to occur, the name biblio or bibliography must be given to the bibliography section, like so:

1~!biblio~ [Note: heading marker::required title missing]

a markup tagged metadata bibliography section

Here instead of writing your full citations directly in footnotes, each time you have new material to cite, you add it to your bibliography section (if it has not been added yet) providing the information you need against an available list of tags (provided below).

The required tags are au: ti: and year:   10  an short quick example might be as follows:

1~!biblio~ [Note: heading marker::required title missing]

au: von Hippel, E.
ti: Perspective: User Toolkits for Innovation
lng: (language)
jo: Journal of Product Innovation Management
vo: 18
ed: (editor)
yr: 2001
note:
sn: Hippel, /{User Toolkits}/ (2001)
id: vHippel_2001
% form:

au: Benkler, Yochai
ti: The Wealth of Networks
st: How Social Production Transforms Markets and Freedom
lng: (language)
pb: Harvard University Press
edn: (edition)
yr: 2006
pl: U.S.
url: http://cyber.law.harvard.edu/wealth_of_networks/Main_Page
note:
sn: Benkler, /{Wealth of Networks}/ (2006)
id: Benkler2006

au: Quixote, Don; Panza, Sancho
ti: Taming Windmills, Keeping True
jo: Imaginary Journal
yr: 1605
url: https://en.wikipedia.org/wiki/Don_Quixote
note: made up to provide an example of author markup for an article with two authors
sn: Quixote & Panza, /{Taming Windmills}/ (1605)
id: quixote1605

Note that the section name !biblio (or !bibliography) is required for the bibliography to be treated specially as such, and placed after the auto-generated endnote section.

Using this method, work goes into preparing the bibliography, the tags author or editor, year and title are required and will be used to sort the bibliography that is placed under the Bibliography section

The metadata tags may include shortname (sn:) and id, if provided, which are used for substitution within text. Every time the given id is found within the text it will be replaced by the given short title of the work (it is for this reason the short title has sisu markup to italicize the title), it should work with any page numbers to be added, the short title should be one that can easily be used to look up the full description in the bibliography.

The following footnote~{ quixote1605, pp 1000 - 1001, also Benkler2006 p 1. }~

would be presented as:

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

au: author Surname, FirstNames (if multiple semi-colon separator)
    (required unless editor to be used instead)
ti: title  (required)
st: subtitle
jo: journal
vo: volume
ed: editor (required if author not provided)
tr: translator
src: source (generic field where others are not appropriate)
in: in (like src)
pl: place/location (state, country)
pb: publisher
edn: edition
yr: year (yyyy or yyyy-mm or yyyy-mm-dd) (required)
pg: pages
url: http://url
note: note
id: create_short_identifier e.g. authorSurnameYear
    (used in substitutions: when found within text will be
    replaced by the short name provided)
sn: short name e.g. Author, /{short title}/, Year
    (used in substitutions: when an id is found within text
    the short name will be used to replace it)

Tagging citations for inclusion in the Bibliography

Here whenever you make a citation that you wish be included in the bibliography, you tag the citation as such using special delimiters (which are subsequently removed from the final text produced by sisu)

Here you would write something like the following, either in regular text or a footnote

See .: Quixote, Don; Panza, Sancho /{Taming Windmills, Keeping True}/ (1605) :.

SiSU will parse for a number of patterns within the delimiters to try make out the authors, title, date etc. and from that create a Bibliography. This is more limited than the previously described method of preparing a tagged bibliography, and using an id within text to identify the work, which also lends itself to greater consistency.

Glossary

Using the section name 1~!glossary results in the Glossary being treated specially as such, and placed after the auto-generated endnote section (before the bibliography/list of references if there is one).

The Glossary is ordinary text marked up in a manner deemed suitable for that purpose. e.g. with the term in bold, possibly with a hanging indent.

1~!glossary~ [Note: heading marker::required title missing]

_0_1 *{GPL}* An abbreviation that stands for "General Purpose License." ...

_0_1 [provide your list of terms and definitions]

In the given example the first line is not indented subsequent lines are by one level, and the term to be defined is in bold text.

Book index

To make an index append to paragraph the book index term relates to it, using an equal sign and curly braces.

Currently two levels are provided, a main term and if needed a sub-term. Sub-terms are separated from the main term by a colon.

  Paragraph containing main term and sub-term.
  ={Main term:sub-term}

The index syntax starts on a new line, but there should not be an empty line between paragraph and index markup.

The structure of the resulting index would be:

  Main term, 1
    sub-term, 1

Several terms may relate to a paragraph, they are separated by a semicolon. If the term refers to more than one paragraph, indicate the number of paragraphs.

  Paragraph containing main term, second term and sub-term.
  ={first term; second term: sub-term}

The structure of the resulting index would be:

  First term, 1,
  Second term, 1,
    sub-term, 1

If multiple sub-terms appear under one paragraph, they are separated under the main term heading from each other by a pipe symbol.

  Paragraph containing main term, second term and sub-term.
  ={Main term:
      sub-term+2|second sub-term;
    Another term
   }

  A paragraph that continues discussion of the first sub-term

The plus one in the example provided indicates the first sub-term spans one additional paragraph. The logical structure of the resulting index would be:

  Main term, 1,
    sub-term, 1-3,
    second sub-term, 1,
  Another term, 1


 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


[ document manifest ]

<< previous toc next >>