SiSU -->
TOC linked  toc  Full Text  scroll  PDF portrait   pdf  PDF landscape   pdf  ODF/ODT  odt    A-Z  Document Manifest  @
<< previous TOC next >>
< ^ >

SiSU

Markup

Ralph Amissah

copy @ SiSU

SiSU - Markup,
Ralph Amissah

 

  1

 

  2

 

3. Markup of Substantive Text

  82

3.1 Heading Levels
3.2 Font Attributes
3.3 Indentation and bullets
3.4 Footnotes / Endnotes
3.5 Links
3.5.1 Naked URLs within text, dealing with urls
3.5.2 Linking Text
3.5.3 Linking Images
3.6 Grouped Text
3.6.1 Tables
3.6.2 Poem
3.6.3 Group
3.6.4 Code

3.1 Heading Levels

  83

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)

  84

: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

  85

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

  86

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

  87

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

  88

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.

  89

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

  90

  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)

  91

3.2 Font Attributes

  92

markup example:

  93

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

  94

resulting output:

  95

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

  96

normal text

  97

emphasis

  98

bold text

  99

underscore

  100

italics

  101

citation

  102

superscript

  103

subscript

  104

inserted text

  105

strikethrough

  106

3.3 Indentation and bullets

  107

markup example:

  108

  ordinary paragraph

  _1 indent paragraph one step

  _2 indent paragraph two steps

  _9 indent paragraph nine steps

  109

resulting output:

  110

ordinary paragraph

  111

indent paragraph one step

  112

indent paragraph two steps

  113

indent paragraph nine steps

  114

markup example:

  115

  _* bullet text

  _1* bullet text, first indent

  _2* bullet text, two step indent

  116

resulting output:

  117

  • bullet text
  •   118

  • bullet text, first indent
  •   119

  • bullet text, two step indent
  •   120

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

      121

    markup example:

      122

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

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

      123

    3.4 Footnotes / Endnotes

      124

    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.

      125

    markup example:

      126

      ~{ a footnote or endnote }~

      127

    resulting output:

      128

      3 

      129

    markup example:

      130

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

      131

    resulting output:

      132

    normal text  4  continues

      133

    markup example:

      134

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

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

      135

    resulting output:

      136

    normal text   *  continues

      137

    normal text   **  continues

      138

    markup example:

      139

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

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

      140

    resulting output:

      141

    normal text   *1  continues

      142

    normal text   +1  continues

      143

    Alternative endnote pair notation for footnotes/endnotes:

      144

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

      normal text~^ continues

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

      145

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

      146

    3.5 Links

      147

    3.5.1 Naked URLs within text, dealing with urls

      148

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

      149

    markup example:

      150

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

      151

    resulting output:

      152

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

      153

    An escaped url without decoration

      154

    markup example:

      155

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

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

      156

    resulting output:

      157

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

      158

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

      159

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

      160

    resulting output:

      161

      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

      162

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

      163

    markup example:

      164

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

      165

    3.5.2 Linking Text

      166

    resulting output:

      167

    about SiSU markup

      168

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

      169

    markup example:

      170

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

      171

    resulting output:

      172

    about SiSU   5  markup

      173

    3.5.3 Linking Images

      174

    markup example:

      175

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

      176

    resulting output:

      177

      178


    Gnu/Linux - a better way

      179

    [ ruby_logo (png missing) ]   6 

      180


    Way Better - with Gnu/Linux, Debian and Ruby

      181

    linked url footnote shortcut

      182

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

      183

      text marker *~name

      184

    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.

      185

    3.6 Grouped Text

      186

    3.6.1 Tables

      187

    Tables may be prepared in two either of two forms

      188

    markup example:

      189

      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

      190

    resulting output:

      191

    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

      192

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

      193

    markup example:  7 

      194

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

      195

    resulting output:

      196

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

      197

    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

      198

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

      199

    3.6.2 Poem

      200

    basic markup:

      201

      poem{

        Your poem here

      }poem

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

      202

    markup example:

      203

      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

      204

    resulting output:

      205

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

      206

    3.6.3 Group

      207

    basic markup:

      208

      group{

        Your grouped text here

      }group

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

      209

    markup example:

      210

      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

      211

    resulting output:

      212

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

      213

    3.6.4 Code

      214

    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.

      215

    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]

      216

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

      217

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

      218

    ^

     3. a footnote or endnote

     

     4. self contained endnote marker & endnote in one

     

     * unnumbered asterisk footnote/endnote, insert multiple asterisks if required

     

     ** another unnumbered asterisk footnote/endnote

     

     *1. editors notes, numbered asterisk footnote/endnote series

     

     +1. editors notes, numbered asterisk footnote/endnote series

     

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

     

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

     

     7. Table from the Wealth of Networks by Yochai Benkler

     

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

     
     
    SiSU -->
    TOC linked  toc  Full Text  scroll  PDF portrait   pdf  PDF landscape   pdf  ODF/ODT  odt    A-Z  Document Manifest  @
    << previous TOC next >>
    < ^ >

    SiSU

    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.

    GPLv3

    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!



    idx txt


    SiSU manual


    SiSU