SiSU - Manual,
Ralph Amissah

  1

What is SiSU?

  2

HowTo

  1463

40. Markup

40. Markup

  1579

See sample markup provided on

  1580

<http://www.jus.uio.no/sisu>

  1581

<http://www.jus.uio.no/sisu_markup>

  1582

<http://www.jus.uio.no/sisu/SiSU>

  1583

in particular for each of the document output samples provided, the source document is provided as well

  1584

<http://www.jus.uio.no/sisu/SiSU/2#books>

  1585

on untarring the source tarball:

  1586

data/sisu-examples/sample/document_samples_sisu_markup/

  1587

or the same once source is installed (or sisu-examples) under:

  1588

/usr/share/sisu-examples/sample/document_samples_sisu_markup/

  1589

Some notes are contained within the man page, man sisu and within sisu help via the commands sisu help markup and sisu help headers

  1590

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:

  1591

40.1 Headers

  1592

Headers @headername: provide information related to the document, this may relate to

  1593

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

  1594

2. semantic information about the document including the dublin core

  1595

40.2 Font Face

  1596

Defaults are set. You may change the face to: bold, italics, underscore, strikethrough, ...

  1597

40.2.1 Bold

  1598

\@bold: [list of words that should be made bold within document]

  1599

bold line

  1600

!_ bold line

  1601

bold word or sentence

  1602

!{ bold word or sentence }!

  1603

*{ bold word or sentence }*

  1604

boldword or boldword

  1605

*boldword* or !boldword!

  1606

40.2.2 Italics

  1607

\@italics: [list of words that should be italicised within document]

  1608

italicise word or sentence

  1609

/{ italicise word or sentence }/

  1610

italicisedword

  1611

/italicisedword/

  1612

40.2.3 Underscore

  1613

underscore word or sentence

  1614

_{ underscore word or sentence }_

  1615

underscoreword

  1616

40.2.4 Strikethrough

  1617

strikethrough word or sentence

  1618

-{ strikethrough word or sentence }-

  1619

strikeword

  1620

-strikeword-

  1621

40.3 Endnotes

  1622

There are two forms of markup for endnotes, they cannot be mixed within the same document

  1623

here  ¹⁰⁵ 

  1624

1. preferred endnote markup

  1625

here~{ this is an endnote }~

  1626

2. alternative markup equivalent, kept because it is possible to search and replace to get markup in existing texts such as Project Gutenberg

  1627

here~^

  1628

^~ this is an endote

  1629

40.4 Links

  1630

SiSU

  1631

{ SiSU }http://sisudoc.org

  1632

  1633

{sisu.png }http://sisudoc.org

  1634

  1635

{ tux.png 64x80 }image

  1636

SiSU   ¹⁰⁶ 

  1637

{ SiSU }http://sisudoc.org

  1638

is equivalent to:

  1639

{ SiSU }http://sisudoc.org ~{ <http://sisudoc.org> }~

  1640

the same can be done with an image:

  1641

SiSU

  1642

{ sisu.png "SiSU" }http://sisudoc.org

  1643

40.5 Number Titles

  1644

Set with the header @markup:

  1645

40.6 Line operations

  1646

Line Operations (marker placed at start of line)

  1647

!_ bold line

  1648

bold line

  1649

_1 indent paragraph one level

  1650

indent paragraph one level

  1651

_2 indent paragraph two steps

  1652

indent paragraph two steps

  1653

_* bullet paragraph

  1654

  1655

# number paragraph (see headers for numbering document headings)

  1656

1. number paragraph (see headers for numbering document headings)

  1657

_# number paragraph level 2 (see headers for numbering document headings)

  1658

a. number paragraph level 2 (see headers for numbering document headings)

  1659

40.7 Tables

  1660

Table markup sample

  1661

table{~h c3; 26; 32; 32;

  1662

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

  1663

column one row 2
column two of row two
column three of row two, and so on

  1664

column one row three
and so on
here

  1665

}table

  1666

Alternative form of table markup

  1667

  {t\~h}
       |Mon|Tue|Wed|Thu|Fri|Sat|Sun
  0    | * | * | * | * | * | * | *
  1    | * | * | * | * |   |   |  
  2    | - | * | * | * | * | * |  
  3    | - | * | * | * | * | * | *
  4    | - |   |   | * | * | * |  
  5    | * | * | * | * | * | * | *

  1668

40.8 Grouped Text

  1669

    5.times { puts 'Ruby' }

  1670

code{

  1671

    5.times { puts 'Ruby' }

  1672

}code

  1673

A Limerick

  1674

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.

  1675

poem{

  1676

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.

  1677

}\poem

  1678

40.9 Composite Document

  1679

To import another document, the master document or importing document should be named filename.r3 (r for require)

  1680

<< { filename.sst }

  1681

<< { filename.ssi }

  1682

 ^105. this is an endnote

 ^106. <http://sisudoc.org>

 ^108. <http://sisudoc.org>

Output generated by SiSU 0.59.0 2007-09-23 (2007w38/0)
SiSU Copyright ^© Ralph Amissah 1997, current 2007. All Rights Reserved.
SiSU is software for document structuring, publishing and search,
www.jus.uio.no/sisu and www.sisudoc.org
w3 since October 3 1993 ralph@amissah.com

SiSU using:
Standard SiSU markup syntax,
Standard SiSU meta-markup syntax, and the
Standard SiSU object citation numbering and system, (object/text positioning system)
Copyright ^© Ralph Amissah 1997, current 2007. All Rights Reserved.

SiSU is released under GPLv3 or later, <http://www.gnu.org/licenses/gpl.html>

SiSU, developed using Ruby on Debian/Gnu/Linux software infrastructure, with the usual GPL (or OSS) suspects.
Better - "performance, reliability, scalability, security & total cost of ownership" [not to mention flexibility & choice] use of and adherence to open standards (where practical and fair) and it is software libre.
Get With the Future Way Better!