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

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
3.7 Book index

4. Composite documents markup

Markup Syntax History

5. Notes related to Files-types and Markup Syntax

Endnotes

Concordance (wordlist)

Manifest (alternative outputs)

Metadata

SiSU

Markup

Ralph Amissah

copy @ SiSU

SiSU - Markup,
Ralph Amissah

SiSU Markup

Markup Syntax History

5. Notes related to Files-types and Markup Syntax

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

  • sisu --query=[sisu version [0.38] or 'history]
  • provides a short history of changes to SiSU markup

    0.57 (2007w34/4) SiSU 0.57 is the same as 0.42 with the introduction of some a shortcut to use the headers @title and @creator in the first heading [expanded using the contents of the headers @title: and @author:]

      :A~ @title by @author

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

    SiSU 0.52

    or, backward compatible using the comment marker:

    % SiSU 0.38

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

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

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

    SiSU 0.42 is the same as 0.38 with the introduction of some additional endnote types,

    Introduces some variations on endnotes, in particular the use of the asterisk

      ~{* for example for describing an author }~ and ~{** for describing a second author }~

    * for example for describing an author

    ** for describing a second author

    and

      ~[* my note ]~ or ~[+ another note ]~

    which numerically increments an asterisk and plus respectively

    *1 my note +1 another note

    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)

    SiSU 0.38 introduced alternative experimental header and heading/structure markers,

      @headername: and headers :A~ :B~ :C~ 1~ 2~ 3~

    as the equivalent of:

      0~headername and headers 1~ 2~ 3~ 4~ 5~ 6~

    The internal document markup of SiSU 0.16 remains valid and standard Though note that SiSU 0.37 introduced a new file naming convention

    SiSU has in effect two sets of levels to be considered, using 0.38 notation A-C headings/levels, pre-ordinary paragraphs /pre-substantive text, and 1-3 headings/levels, levels which are followed by ordinary text. This may be conceptualised as levels A,B,C, 1,2,3, and using such letter number notation, in effect: A must exist, optional B and C may follow in sequence (not strict) 1 must exist, optional 2 and 3 may follow in sequence i.e. there are two independent heading level sequences A,B,C and 1,2,3 (using the 0.16 standard notation 1,2,3 and 4,5,6) on the positive side: the 0.38 A,B,C,1,2,3 alternative makes explicit an aspect of structuring documents in SiSU that is not otherwise obvious to the newcomer (though it appears more complicated, is more in your face and likely to be understood fairly quickly); the substantive text follows levels 1,2,3 and it is 'nice' to do most work in those levels

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

    SiSU 0.37 introduced new file naming convention, using the file extensions .sst .ssm and .ssi to replace .s1 .s2 .s3 .r1 .r2 .r3 and .si

    this is captured by the following file 'rename' instruction:

      rename 's/\.s[123]$/\.sst/' *.s{1,2,3}
      rename 's/\.r[123]$/\.ssm/' *.r{1,2,3}
      rename 's/\.si$/\.ssi/' *.si

    The internal document markup remains unchanged, from SiSU 0.16

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

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

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

    0.20.4 (2005w33/4) header 0~links

    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

    SiSU 0.16 (0.15 development branch) introduced the use of

    the header 0~ and headings/structure 1~ 2~ 3~ 4~ 5~ 6~

    in place of the 0.1 header, heading/structure notation

    SiSU 0.1 headers and headings structure represented by header 0{~ and headings/structure 1{ 2{ 3{ 4{~ 5{ 6{

    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.70.0 2008-12-03 (2008w48/3)
    SiSU Copyright © Ralph Amissah 1997, current 2008. 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 2008. 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 libré.
    Get With the Future Way Better!



    idx txt


    SiSU manual


    SiSU