SiSU - Manual,
Ralph Amissah

  1

What is SiSU?

  2

11. Markup of Substantive Text

11. Markup of Substantive Text

  249

11.1 Heading Levels

  250

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)

  251

: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

  252

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

  253

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

  254

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

  255

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.

  256

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

  257

  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)

  258

11.2 Font Attributes

  259

markup example:

  260

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

  normal text

  !{emphasis}!

  *{bold text}*

  _{underscore}<br />
  /{italics}/

  "{citation}"

  ^{superscript}^

  ,{subscript},

  +{inserted text}+

  -{strikethrough}-

  261

resulting output:

  262

normal text emphasis bold text underscore italics citation ^superscript _subscript inserted text strikethrough

  263

normal text

  264

emphasis

  265

bold text

  266

underscore

  267

italics

  268

citation

  269

^superscript

  270

_subscript

  271

inserted text

  272

strikethrough

  273

11.3 Indentation and bullets

  274

markup example:

  275

  ordinary paragraph

  _1 indent paragraph one step

  _2 indent paragraph two steps

  _9 indent paragraph nine steps

  276

resulting output:

  277

ordinary paragraph

  278

indent paragraph one step

  279

indent paragraph two steps

  280

indent paragraph nine steps

  281

markup example:

  282

  _* bullet text

  _1* bullet text, first indent

  _2* bullet text, two step indent

  283

resulting output:

  284

  285

  286

  287

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

  288

markup example:

  289

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

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

  290

11.4 Footnotes / Endnotes

  291

Footnotes and endnotes not distinguished in markup. They are automatically numbered. Depending on the output file format (html, odf, pdf etc.), the document output selected will have either footnotes or endnotes.

  292

markup example:

  293

  ~{ a footnote or endnote }~

  294

resulting output:

  295

  ¹⁷ 

  296

markup example:

  297

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

  298

resulting output:

  299

normal text  ¹⁸  continues

  300

markup example:

  301

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

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

  302

resulting output:

  303

normal text   ^*  continues

  304

normal text   ^**  continues

  305

markup example:

  306

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

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

  307

resulting output:

  308

normal text   ^*3  continues

  309

normal text   ⁺²  continues

  310

Alternative endnote pair notation for footnotes/endnotes:

  311

<:code>  % note the endnote marker "~^"

  normal text~^ continues

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

  312

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

  313

11.5 Links

  314

11.5.1 Naked URLs within text, dealing with urls

  315

urls are found within text and 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).

  316

markup example:

  317

  normal text http://www.jus.uio.no/sisu continues

  318

resulting output:

  319

normal text <http://www.jus.uio.no/sisu> continues

  320

An escaped url without decoration

  321

markup example:

  322

  normal text _http://www.jus.uio.no/sisu continues

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

  323

resulting output:

  324

normal text http://www.jus.uio.no/sisu continues

  325

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

  326

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

  327

resulting output:

  328

  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

  329

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

  330

markup example:

  331

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

  332

11.5.2 Linking Text

  333

resulting output:

  334

about SiSU markup

  335

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

  336

markup example:

  337

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

  338

resulting output:

  339

about SiSU   ¹⁹  markup

  340

11.5.3 Linking Images

  341

markup example:

  342

  {tux.png 64x80 }image

  % various url linked images

  {tux.png 64x80 "a better way" }http://www.jus.uio.no/sisu/

  {GnuDebianLinuxRubyBetterWay.png 100x101 "Way Better - with Gnu/Linux, Debian and Ruby" }http://www.jus.uio.no/sisu/

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

  343

resulting output:

  344

  345

Gnu/Linux - a better way

  346

[ ruby_logo (png missing) ]   ²⁰ 

  347

Way Better - with Gnu/Linux, Debian and Ruby

  348

linked url footnote shortcut

  349

  {~^ [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

  350

  text marker *~name

  351

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.

  352

11.6 Grouped Text

  353

11.6.1 Tables

  354

Tables may be prepared in two either of two forms

  355

markup example:

  356

  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

  357

resulting output:

  358

  359

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

  360

markup example:  ²¹ 

  361

  !_ 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.

  362

resulting output:

  363

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

  364

  365

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

  366

11.6.2 Poem

  367

basic markup:

  368

  poem{

    Your poem here

  }poem

  Each verse in a poem is given a separate object number.

  369

markup example:

  370

  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

  371

resulting output:

  372

                    '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."'

  373

11.6.3 Group

  374

basic markup:

  375

  group{

    Your grouped text here

  }group

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

  376

markup example:

  377

  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

  378

resulting output:

  379

                    '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."'

  380

11.6.4 Code

  381

Code tags 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.

  382

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]

  383

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

  384

                      '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."'

  385

 ^17. a footnote or endnote

 ^18. 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 asterisk footnote/endnote series

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

 ^20. <http://www.ruby-lang.org/en/>

 ^21. Table from the Wealth of Networks by Yochai Benkler

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

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!