6. Markup of Substantive Text

6.1 Heading Levels

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)

: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

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

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

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

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.

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

  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)

6.2 Font Attributes

markup example:

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

  normal text

  *{emphasis}* [note: can be configured to be represented by bold, italics or underscore]

  !{bold text}!

  /{italics}/

  _{underscore}_

  "{citation}"

  ^{superscript}^

  ,{subscript},

  +{inserted text}+

  -{strikethrough}-

  #{monospace}#

resulting output:

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

normal text

emphasis [note: can be configured to be represented by bold, italics or underscore]

bold text

italics

underscore

citation

^superscript

_subscript

inserted text

strikethrough

monospace

6.3 Indentation and bullets

markup example:

  ordinary paragraph

  _1 indent paragraph one step

  _2 indent paragraph two steps

  _9 indent paragraph nine steps

resulting output:

ordinary paragraph

indent paragraph one step

indent paragraph two steps

indent paragraph nine steps

markup example:

  _* bullet text

  _1* bullet text, first indent

  _2* bullet text, two step indent

resulting output:

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

markup example:

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

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

6.4 Footnotes / Endnotes

Footnotes and endnotes are marked up at the location where they would be indicated within a text. They are automatically numbered. The output type determines whether footnotes or endnotes will be produced

markup example:

  ~{ a footnote or endnote }~

resulting output:

  ¹¹⁶ 

markup example:

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

resulting output:

normal text  ¹¹⁷  continues

markup example:

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

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

resulting output:

normal text   ^*  continues

normal text   ^**  continues

markup example:

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

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

resulting output:

normal text   ^*1  continues

normal text   ⁺¹  continues

Alternative endnote pair notation for footnotes/endnotes:

  % note the endnote marker "~^"

  normal text~^ continues

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

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

6.5 Links

6.5.1 Naked URLs within text, dealing with urls

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

markup example:

  normal text http://www.sisudoc.org/ continues

resulting output:

normal text ‹http://www.sisudoc.org/› continues

An escaped url without decoration

markup example:

  normal text _http://www.sisudoc.org/ continues

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

resulting output:

normal text http://www.sisudoc.org/ continues

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

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

resulting output:

  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

6.5.2 Linking Text

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

markup example:

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

resulting output:

about SiSU markup

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

markup example:

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

resulting output:

about SiSU   ¹¹⁸  markup

Internal document links to a tagged location, including an ocn

markup example:

  about { text links }#link_text

resulting output:

about text links

Shared document collection link

markup example:

  about { SiSU book markup examples }:SiSU/examples.html

resulting output:

about SiSU book markup examples

6.5.3 Linking Images

markup example:

  { tux.png 64x80 }image

  % various url linked images

  {tux.png 64x80 "a better way" }http://www.sisudoc.org/

  {GnuDebianLinuxRubyBetterWay.png 100x101 "Way Better - with Gnu/Linux, Debian and Ruby" }http://www.sisudoc.org/

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

resulting output:

Gnu/Linux - a better way

Way Better - with Gnu/Linux, Debian and Ruby

Ruby

linked url footnote shortcut

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

  text marker

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.

6.6 Grouped Text

6.6.1 Tables

Tables may be prepared in two either of two forms

markup example:

  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

resulting output:

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

markup example:  ¹²⁰ 

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

resulting output:

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

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

6.6.2 Poem

basic markup:

  poem{

    Your poem here

  }poem

  Each verse in a poem is given an object number.

markup example:

  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

resulting output:

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

6.6.3 Group

basic markup:

  group{

    Your grouped text here

  }group

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

markup example:

  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

resulting output:

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

6.6.4 Code

Code tags code{ ... }code (used as with other group tags described above) 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.

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]

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

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

From SiSU 2.7.7 on you can number codeblocks by placing a hash after the opening code tag code{# as demonstrated here:

1  ┆                      `Fury said to a
2  ┆                     mouse, That he
3  ┆                   met in the
4  ┆                 house,
5  ┆              "Let us
6  ┆                both go to
7  ┆                  law:  I will
8  ┆                    prosecute
9  ┆                      YOU.  --Come,
10 ┆                         I'll take no
11 ┆                          denial; We
12 ┆                       must have a
13 ┆                   trial:  For
14 ┆                really this
15 ┆             morning I've
16 ┆            nothing
17 ┆           to do."
18 ┆             Said the
19 ┆               mouse to the
20 ┆                 cur, "Such
21 ┆                   a trial,
22 ┆                     dear Sir,
23 ┆                           With
24 ┆                       no jury
25 ┆                    or judge,
26 ┆                  would be
27 ┆                wasting
28 ┆               our
29 ┆                breath."
30 ┆                 "I'll be
31 ┆                   judge, I'll
32 ┆                     be jury,"
33 ┆                           Said
34 ┆                      cunning
35 ┆                        old Fury:
36 ┆                       "I'll
37 ┆                        try the
38 ┆                           whole
39 ┆                            cause,
40 ┆                               and
41 ┆                          condemn
42 ┆                         you
43 ┆                        to
44 ┆                         death."'

6.7 Book index

To make an index append to paragraph the book index term relates to it, using an equal sign and curly braces.

Currently two levels are provided, a main term and if needed a sub-term. Sub-terms are separated from the main term by a colon.

    Paragraph containing main term and sub-term.
    ={Main term:sub-term}

The index syntax starts on a new line, but there should not be an empty line between paragraph and index markup.

The structure of the resulting index would be:

    Main term, 1
      sub-term, 1

Several terms may relate to a paragraph, they are separated by a semicolon. If the term refers to more than one paragraph, indicate the number of paragraphs.

    Paragraph containing main term, second term and sub-term.
    ={first term; second term: sub-term}

The structure of the resulting index would be:

    First term, 1,
    Second term, 1,
      sub-term, 1

If multiple sub-terms appear under one paragraph, they are separated under the main term heading from each other by a pipe symbol.

    Paragraph containing main term, second term and sub-term.
    ={Main term:sub-term+1|second sub-term

    A paragraph that continues discussion of the first sub-term

The plus one in the example provided indicates the first sub-term spans one additional paragraph. The logical structure of the resulting index would be:

    Main term, 1,
      sub-term, 1-3,
      second sub-term, 1,