SiSU - Manual,
Ralph Amissah

  1

What is SiSU?

  2

HowTo

  1464

40. Markup

40. Markup

  1580

See sample markup provided on

  1581

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

  1582

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

  1583

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

  1584

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

  1585

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

  1586

on untarring the source tarball:

  1587

data/sisu-examples/sample/document_samples_sisu_markup/

  1588

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

  1589

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

  1590

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

  1591

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:

  1592

40.1 Headers

  1593

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

  1594

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

  1595

2. semantic information about the document including the dublin core

  1596

40.2 Font Face

  1597

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

  1598

40.2.1 Bold

  1599

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

  1600

bold line

  1601

!_ bold line

  1602

bold word or sentence

  1603

!{ bold word or sentence }!

  1604

*{ bold word or sentence }*

  1605

boldword or boldword

  1606

*boldword* or !boldword!

  1607

40.2.2 Italics

  1608

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

  1609

italicise word or sentence

  1610

/{ italicise word or sentence }/

  1611

italicisedword

  1612

/italicisedword/

  1613

40.2.3 Underscore

  1614

underscore word or sentence

  1615

_{ underscore word or sentence }_

  1616

underscoreword

  1617

40.2.4 Strikethrough

  1618

strikethrough word or sentence

  1619

-{ strikethrough word or sentence }-

  1620

strikeword

  1621

-strikeword-

  1622

40.3 Endnotes

  1623

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

  1624

here  ¹⁰⁵ 

  1625

1. preferred endnote markup

  1626

here~{ this is an endnote }~

  1627

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

  1628

here~^

  1629

^~ this is an endote

  1630

40.4 Links

  1631

SiSU

  1632

{ SiSU }http://sisudoc.org

  1633

  1634

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

  1635

  1636

{ tux.png 64x80 }image

  1637

SiSU   ¹⁰⁶ 

  1638

{ SiSU }http://sisudoc.org

  1639

is equivalent to:

  1640

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

  1641

the same can be done with an image:

  1642

SiSU

  1643

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

  1644

40.5 Number Titles

  1645

Set with the header @markup:

  1646

40.6 Line operations

  1647

Line Operations (marker placed at start of line)

  1648

!_ bold line

  1649

bold line

  1650

_1 indent paragraph one level

  1651

indent paragraph one level

  1652

_2 indent paragraph two steps

  1653

indent paragraph two steps

  1654

_* bullet paragraph

  1655

  1656

# number paragraph (see headers for numbering document headings)

  1657

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

  1658

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

  1659

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

  1660

40.7 Tables

  1661

Table markup sample

  1662

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

  1663

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

  1664

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

  1665

column one row three
and so on
here

  1666

}table

  1667

Alternative form of table markup

  1668

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

  1669

40.8 Grouped Text

  1670

    5.times { puts 'Ruby' }

  1671

code{

  1672

    5.times { puts 'Ruby' }

  1673

}code

  1674

A Limerick

  1675

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.

  1676

poem{

  1677

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.

  1678

}\poem

  1679

40.9 Composite Document

  1680

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

  1681

<< { filename.sst }

  1682

<< { filename.ssi }

  1683

 ^105. this is an endnote

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

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

Output generated by SiSU 0.59.1 2007-09-25 (2007w39/2)
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!