|
|
|
|
|
|
|
|
|
|
|
|
|
See sample markup provided on
in particular for each of the document output samples provided, the source document is provided as well
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 @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
Defaults are set. You may change the face to: bold, italics, underscore, strikethrough, ...
\@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: [list of words that should be italicised within document]
italicise word or sentence
/{ italicise word or sentence }/
/italicisedword/
/italicisedword/
underscore word or sentence
_{ underscore word or sentence }_
_underscoreword_
strikethrough word or sentence
-{ strikethrough word or sentence }-
-strikeword-
-strikeword-
There are two forms of markup for endnotes, they cannot be mixed within the same document
here 944
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
{ SiSU }http://www.sisudoc.org
{sisu.png }http://www.sisudoc.org
{ tux.png 64x80 }image
{~^ 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.png "SiSU" }http://www.sisudoc.org
Set with the header @markup:
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)
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 | * | * | * | * | * | * | *
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
To import another document, the master document or importing document should be named filename.r3 (r for require)
<< { filename.sst }
<< { filename.ssi }
SiSU Book Samples and Markup Examples
Viral Spiral - How the Commoners Built a Digital Republic of Their Own
David Bollier
2009
The Wealth of Networks - How Social Production Transforms Markets and Freedom
Yochai Benkler
2006
Free Culture - How Big Media Uses Technology and the Law to Lock Down Culture and Control Creativity
Lawrence Lessig
2004
CONTENT - Selected Essays on Technology, Creativity, Copyright and the Future of the Future
Cory Doctorow
2008
Eric von Hippel
2005
Free As In Freedom - Richard Stallman's Crusade for Free Software
Sam Williams
2002
Two Bits - The Cultural Significance of Free Software
Christopher Kelty
2008
Free For All - How Linux and the Free Software Movement Undercut the High Tech Titans
Peter Wayner
2002
The Cathedral & the Bazaar - Musings on Linux and Open Source by an Accidental Revolutionary
Erik S. Raymond
1999
Cory Doctorow
2008
Down and Out in the Magic Kingdom
Cory Doctorow
2003
Cory Doctorow
2008
Free Software Foundation - FSF
GPL - GNU General Public License