SiSU - Markup,
Ralph Amissah

SiSU Markup

1. Introduction to SiSU Markup  ¹ 

1.1 Summary

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

All paragraphs are separated by an empty line.

Markup is comprised of:

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

To check the markup in a file:

sisu --identify [filename].sst

For brief descriptive summary of markup history

sisu --query-history

or if for a particular version:

sisu --query-0.38

1.2 Markup Examples

1.2.1 Online

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

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

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

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

1.2.2 Installed

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

2. Markup of Headers

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.

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:

  % this would be a comment

2.1 Sample Header

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

  % 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/examples.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

2.2 Available Headers

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

@indentifier: information or instructions

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

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.

This is a sample header

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

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

@subtitle: The Subtitle if any

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

@subject: (whatever your subject)

@description:

@publisher:

@contributor:

@translator: [or @translated_by:]

@illustrator: [or @illustrated_by:]

@prepared_by: [or @digitized_by:]

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

@type: article

@format:

@identifier:

@source:

@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.]

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

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

@relation:

@coverage:

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

@owner:

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

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

@comment: [...]

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

@classify_loc: [Library of Congress classification]

@classify_dewey: [Dewey classification]

@classify_isbn: [ISBN]

@classify_pg: [Project Gutenberg text number]

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

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

@prefix_b:

@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 ]

@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:)

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

@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]

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

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

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

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

@man: 8;
name=sisu - documents: markup, structuring, publishing in multiple standard formats, and search;
synopsis=sisu [-abcDdFHhIiMmNnopqRrSsTtUuVvwXxYyZz0-9] [filename/wildcard ]
sisu [-Ddcv] [instruction]
sisu [-CcFLSVvW]
the man page category number (default 1) and special tags used in preparing man page headings

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

@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]

3. Markup of Substantive Text

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

3.2 Font Attributes

markup example:

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

  normal text

  !{emphasis}!

  *{bold text}*

  _{underscore}_

  /{italics}/

  "{citation}"

  ^{superscript}^

  ,{subscript},

  +{inserted text}+

  -{strikethrough}-

resulting output:

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

normal text

emphasis

bold text

underscore

italics

citation

^superscript

_subscript

inserted text

strikethrough

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

3.4 Footnotes / Endnotes

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.

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

3.5 Links

3.5.1 Naked URLs within text, dealing with urls

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

markup example:

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

resulting output:

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

An escaped url without decoration

markup example:

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

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

resulting output:

normal text http://www.jus.uio.no/sisu 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

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

markup example:

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

3.5.2 Linking Text

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

3.5.3 Linking Images

markup example:

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

resulting output:

Gnu/Linux - a better way

Ruby

Way Better - with Gnu/Linux, Debian and 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 *~name

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.

3.6 Grouped Text

3.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: