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

SiSU

Markup

Ralph Amissah

copy @ SiSU

Rights: Copyright ©  Ralph Amissah 2007, part of SiSU documentation, License GPL 3


SiSU - Markup,
Ralph Amissah

SiSU Markup

1. Introduction to SiSU Markup

1.1 Summary
1.2 Markup Examples
1.2.1 Online
1.2.2 Installed

2. Markup of Headers

2.1 Sample Header
2.2 Available Headers

3. Markup of Substantive Text

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

4. Composite documents markup

Markup Syntax History

5. Notes related to Files-types and Markup Syntax

Document Information (metadata)

SiSU - Markup,
Ralph Amissah

  1

SiSU Markup

  2

1. Introduction to SiSU Markup  1 

  3

1.1 Summary

  4

SiSU source documents are plaintext (UTF-8)  2  files

  5

All paragraphs are separated by an empty line.

  6

Markup is comprised of:

  7

  • at the top of a document, the document header made up of semantic meta-data about the document and if desired additional processing instructions (such an instruction to automatically number headings from a particular level down)
  •   8

  • followed by the prepared substantive text of which the most important single characteristic is the markup of different heading levels, which define the primary outline of the document structure. Markup of substantive text includes:
  •   9

  • heading levels defines document structure
  •   10

  • text basic attributes, italics, bold etc.
  •   11

  • grouped text (objects), which are to be treated differently, such as code blocks or poems.
  •   12

  • footnotes/endnotes
  •   13

  • linked text and images
  •   14

  • paragraph actions, such as indent, bulleted, numbered-lists, etc.
  •   15

    Some interactive help on markup is available, by typing sisu and selecting markup or sisu --help markup

      16

    1.2 Markup Examples

      17

    1.2.1 Online

      18

    Online markup examples are available together with the respective outputs produced from <http://www.jus.uio.no/sisu/SiSU/2.html> or from <http://www.jus.uio.no/sisu/sisu_examples/>

      19

    There is of course this document, which provides a cursory overview of sisu markup and the respective output produced: <http://www.jus.uio.no/sisu/sisu_markup/>

      20

    Some example marked up files are available as html with syntax highlighting for viewing: <http://www.jus.uio.no/sisu/sample/syntax>

      21

    an alternative presentation of markup syntax: <http://www.jus.uio.no/sisu/sample/on_markup.txt>

      22

    1.2.2 Installed

      23

    With SiSU installed sample skins may be found in: /usr/share/doc/sisu/sisu_markup_samples/dfsg (or equivalent directory) and if sisu-markup-samples is installed also under: /usr/share/doc/sisu/sisu_markup_samples/non-free

      24

    2. Markup of Headers

      25

    Headers consist of semantic meta-data about a document, which can be used by any output module of the program; and may in addition include extra processing instructions.

      26

    Note: the first line of a document may include information on the markup version used in the form of a comment. Comments are a percentage mark at the start of a paragraph (and as the first character in a line of text) followed by a space and the comment:

      27

      % this would be a comment

      28

    2.1 Sample Header

      29

    This current document has a header similar to this one (without the comments):

      30

      % SiSU 0.57

      @title: SiSU

      @subtitle: Markup

      @creator: Ralph Amissah

      @rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3

      @type: information

      @subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search

      @date.created: 2002-08-28

      @date.issued: 2002-08-28

      @date.available: 2002-08-28

      @date.modified: 2007-09-16

      @date: 2007-09-16

      @level: new=C; break=1; num_top=1

      % comment: in this @level header num_top=1 starts automatic heading numbering at heading level 1 (numbering continues 3 levels down); the new and break instructions are used by the LaTeX/pdf and odf output to determine where to put page breaks (that are not used by html output or say sql database population).

      @skin: skin_sisu_manual

      % skins modify the appearance of a document and are placed in a sub-directory under ./_sisu/skin ~/.sisu/skin or /etc/sisu/skin. A skin may affect single documents that request them, all documents in a directory, or be site-wide. (A document is affected by a single skin)

      @bold: /Gnu|Debian|Ruby|SiSU/

      @links: { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/
      { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/2.html
      { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU
      { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/
      { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/
      { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html
      { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html
      { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html

      31

    2.2 Available Headers

      32

    Header tags appear at the beginning of a document and provide meta information on the document (such as the Dublin Core), or information as to how the document as a whole is to be processed. All header instructions take either the form @headername: or 0~headername. All Dublin Core meta tags are available

      33

    @indentifier: information or instructions

      34

    where the "identifier" is a tag recognised by the program, and the "information" or "instructions" belong to the tag/indentifier specified

      35

    Note: a header where used should only be used once; all headers apart from @title: are optional; the @structure: header is used to describe document structure, and can be useful to know.

      36

    This is a sample header

      37

    % SiSU 0.38 [declared file-type identifier with markup version]

      38

    @title: [title text] This is the title of the document and used as such, this header is the only one that is mandatory

      39

    @subtitle: The Subtitle if any

      40

    @creator: [or @author:] Name of Author

      41

    @subject: (whatever your subject)

      42

    @description:

      43

    @publisher:

      44

    @contributor:

      45

    @translator: [or @translated_by:]

      46

    @illustrator: [or @illustrated_by:]

      47

    @prepared_by: [or @digitized_by:]

      48

    @date: 2000-08-27 [ also @date.created: @date.issued: @date.available: @date.valid: @date.modified: ]

      49

    @type: article

      50

    @format:

      51

    @identifier:

      52

    @source:

      53

    @language: [or @language.document:] [country code for language if available, or language, English, en is the default setting] (en - English, fr - French, de - German, it - Italian, es - Spanish, pt - Portuguese, sv - Swedish, da - Danish, fi - Finnish, no - Norwegian, is - Icelandic, nl - Dutch, et - Estonian, hu - Hungarian, pl - Polish, ro - Romanian, ru - Russian, el - Greek, uk - Ukranian, tr - Turkish, sk - Slovak, sl - Slovenian, hr - Croatian, cs - Czech, bg - Bul garian ) [however, encodings are not available for all of the languages listed.]

      54

    [@language.original: original language in which the work was published]

      55

    @papersize: (A4|US_letter|book_B5|book_A5|US_legal)

      56

    @relation:

      57

    @coverage:

      58

    @rights: Copyright (c) Name of Right Holder, all rights reserved, or as granted: public domain, copyleft, creative commons variant, etc.

      59

    @owner:

      60

    @keywords: text document generation processing management latex pdf structured xml citation [your keywords here, used for example by rss feeds, and in sql searches]

      61

    @abstract: [paper abstract, placed after table of contents]

      62

    @comment: [...]

      63

    @catalogue: loc=[Library of Congress classification]; dewey=[Dewey classification]; isbn=[ISBN]; pg=[Project Gutenberg text number]

      64

    @classify_loc: [Library of Congress classification]

      65

    @classify_dewey: [Dewey classification]

      66

    @classify_isbn: [ISBN]

      67

    @classify_pg: [Project Gutenberg text number]

      68

    @prefix: [prefix is placed just after table of contents]

      69

    @prefix_a: [prefix is placed just before table of contents - not implemented]

      70

    @prefix_b:

      71

    @rcs: $Id: sisu_markup.sst,v 1.2 2007/09/08 17:12:47 ralph Exp $ [used by rcs or cvs to embed version (revision control) information into document, rcs or cvs can usefully provide a history of updates to a document ]

      72

    @structure: PART; CHAPTER; SECTION; ARTICLE; none; none;
    optional, document structure can be defined by words to match or regular expression (the regular expression is assumed to start at the beginning of a line of text i.e. ^) default markers :A~ to :C~ and 1~ to 6~ can be used within text instead, without this header tag, and may be used to supplement the instructions provided in this header tag if provided (@structure: is a synonym for @toc:)

      73

    @level: newpage=3; breakpage=4
    [paragraph level, used by latex to breakpages, the page is optional eg. in newpage]

      74

    @markup: information on the markup used, e.g. new=1,2,3; break=4; num_top=4 [or newpage=1,2,3; breakpage=4; num_top=4] newpage and breakpage, heading level, used by LaTeX to breakpages. breakpage: starts on a new page in single column text and on a new column in double column text; newpage: starts on a new page for both single and double column texts.
    num_top=4 [auto-number document, starting at level 4. the default is to provide 3 levels, as in 1 level 4, 1.1 level 5, 1.1.1 level 6, markup to be merged within level]
    num_extract [take numbering of headings provided (manually in marked up source document), and use for numbering of segments. Available where a clear numbering structure is provided within document, without the repetition of a number in a header.] [In 0.38 notation, you would map to the equivalent levels, the examples provided would map to the following new=A,B,C; break=1; num_top=1 [or newpage=A,B,C; breakpage=1; num_top=1] see headings]

      75

    @bold: [regular expression of words/phrases to be made bold]

      76

    @italics: [regular expression of words/phrases to italicise]

      77

    @vocabulary: name of taxonomy/vocabulary/wordlist to use against document

      78

    @skin: skin_doc_[name_of_desired_document_skin]
    skins change default settings related to the appearance of documents generated, such as the urls of the home site, and the icon/logo for the document or site.

      79

    @links: { SiSU }http://www.jus.uio.no/sisu/;
    { FSF }
    http://www.fsf.org

      80

    @promo: sisu, ruby, search_libre_docs, open_society
    [places content in right pane in html, makes use of list.yml and promo.yml, commented out sample in document sample: free_as_in_freedom.richard_stallman_crusade_for_free_software.sam_williams.sst]

      81

    3. Markup of Substantive Text

      82

    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

      % 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

    4. Composite documents markup

      219

    It is possible to build a document by creating a master document that requires other documents. The documents required may be complete documents that could be generated independently, or they could be markup snippets, prepared so as to be easily available to be placed within another text. If the calling document is a master document (built from other documents), it should be named with the suffix .ssm Within this document you would provide information on the other documents that should be included within the text. These may be other documents that would be processed in a regular way, or markup bits prepared only for inclusion within a master document .sst regular markup file, or .ssi (insert/information) A secondary file of the composite document is built prior to processing with the same prefix and the suffix ._sst

      220

    basic markup for importing a document into a master document

      221

      << |filename1.sst|@|^|

      << |filename2.ssi|@|^|

      222

    The form described above should be relied on. Within the Vim editor it results in the text thus linked becoming hyperlinked to the document it is calling in which is convenient for editing. Alternative markup for importation of documents under consideration, and occasionally supported have been.

      223

      r{filename}

      {filename.ssi}require

      << {filename.ssi}

      % using textlink alternatives

      |filename.ssi|@|^|require

      << |filename.ssi|@|^|

      % using thlnk alternatives

      <url:filename.ssi>require

      << <url:filename.ssi>

      224

    Markup Syntax History

      225

    5. Notes related to Files-types and Markup Syntax

      226

    0.38 is substantially current, depreciated 0.16 supported, though file names were changed at 0.37

      227

    0.52 (2007w14/6) declared document type identifier at start of text/document:

      228

    SiSU 0.52

      229

    or, backward compatible using the comment marker:

      230

    % SiSU 0.38

      231

    variations include 'SiSU (text|master|insert) [version]' and 'sisu-[version]'

      232

    0.51 (2007w13/6) skins changed (simplified), markup unchanged

      233

    0.42 (2006w27/4) * (asterisk) type endnotes, used e.g. in relation to author

      234

    0.38 (2006w15/7) introduced new/alternative notation for headers, e.g. @title: (instead of 0~title), and accompanying document structure markup, :A,:B,:C,1,2,3 (maps to previous 1,2,3,4,5,6)

      235

    0.37 (2006w09/7) introduced new file naming convention, .sst (text), .ssm (master), .ssi (insert), markup syntax unchanged

      236

    0.35 (2005w52/3) sisupod, zipped content file introduced

      237

    0.23 (2005w36/2) utf-8 for markup file

      238

    0.22 (2005w35/3) image dimensions may be omitted if rmagick is available to be relied upon

      239

    0.20.4 (2005w33/4) header 0~links

      240

    0.16 (2005w25/2) substantial changes introduced to make markup cleaner, header 0~title type, and headings [1-6]~ introduced, also percentage sign (%) at start of a text line as comment marker

      241

    Endnotes

      0


     

     1. From sometime after SiSU 0.58 it should be possible to describe SiSU markup using SiSU, which though not an original design goal is useful.

     

     2. files should be prepared using UTF-8 character encoding

     

     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>

     

    Document Information (metadata)

      0

    Metadata

       

    <http://www.jus.uio.no/sisu/sisu_manual/sisu_markup/sisu_manifest.html>

    Dublin Core (DC)

    DC tags included with this document are provided here.

    DC Title: SiSU - Markup

    DC Creator: Ralph Amissah

    DC Rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3

    DC Type: information

    DC Date created: 2002-08-28

    DC Date issued: 2002-08-28

    DC Date available: 2002-08-28

    DC Date modified: 2007-09-16

    DC Date: 2007-09-16

    Version Information

    Sourcefile: sisu_markup.sst

    Filetype: SiSU text 0.58

    Sourcefile Digest, MD5(sisu_markup.sst)= 6848f40f5844e0a7d59dbb86b3ddae92

    Skin_Digest: MD5(/home/ralph/grotto/theatre/dbld/builds/sisu/sisu/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/skin/doc/skin_sisu_manual.rb)= 20fc43cf3eb6590bc3399a1aef65c5a9

    Generated

    Document (metaverse) last generated: Tue Sep 25 02:53:09 +0100 2007

    Generated by: SiSU 0.59.1 of 2007w39/2 (2007-09-25)

    Ruby version: ruby 1.8.6 (2007-06-07 patchlevel 36) [i486-linux]

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

    SiSU

    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.

    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