path: root/data/doc/manuals_generated/sisu_manual/sisu_markup/sisu_markup.sst

% SiSU 0.58

@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

@skin: skin_sisu_manual

@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
{ SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/
{ SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/

% @prefix: 

:A~? @title @creator

:B~? SiSU Markup

1~markup Introduction to SiSU Markup~{ 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~ Summary

SiSU source documents are plaintext (UTF-8)~{ files should be prepared using UTF-8 character encoding }~ files

All paragraphs are separated by an empty line.

Markup is comprised of:

_* 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)

_* 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:

_1* heading levels defines document structure

_1* text basic attributes, italics, bold etc.

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

_1* footnotes/endnotes

_1* linked text and images

_1* paragraph actions, such as indent, bulleted, numbered-lists, etc.

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

2~ Markup Examples

3~ Online

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/

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

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

1~headers 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:

code{

% this would be a comment

}code

2~ Sample Header

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

code{

% 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

}code

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

% (Dublin Core in fuschia, other information headers in cyan, markup instructions in red):

!_ % 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: BUG bold marker see to

[@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;<br>
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<br>
[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.<br>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]<br>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]<br>
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.

!_ @links:
\{ SiSU }http://www.jus.uio.no/sisu/;<br>
\{ FSF }http://www.fsf.org

!_ @promo:
sisu, ruby, search_libre_docs, open_society<br>
[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]

% header ends here, NB only @title: is mandatory [this would be a comment]
% NOTE: headings/levels below refer to 0.38 expermental markup (a conversion script provided in sisu-examples, modify.rb makes conversion between 0.37 and 0.38 markup simple)

1~ Markup of Substantive Text

2~heading_levels 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

code{

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)

}code

2~ Font Attributes

!_ markup example:

code{

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

}code

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

2~ Indentation and bullets

!_ markup example:

code{

ordinary paragraph

_1 indent paragraph one step

_2 indent paragraph two steps

_9 indent paragraph nine steps

}code

!_ resulting output:

ordinary paragraph

_1 indent paragraph one step

_2 indent paragraph two steps

_9 indent paragraph nine steps

!_ markup example:

code{

_* bullet text

_1* bullet text, first indent

_2* bullet text, two step indent

}code

!_ resulting output:

_* bullet text

_1* bullet text, first indent

_2* bullet text, two step indent

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

!_ markup example:

code{

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

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

}code

2~ 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:

code{

~{ a footnote or endnote }~

}code

!_ resulting output:

~{ a footnote or endnote }~

!_ markup example:

code{

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

}code

!_ resulting output:

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

!_ markup example:

code{

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

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

}code

!_ resulting output:

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

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

!_ markup example:

code{

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

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

}code

!_ resulting output:

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

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

!_ Alternative endnote pair notation for footnotes/endnotes:

code{

code{

% note the endnote marker "~^"

normal text~^ continues

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

}code

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

2~ Links

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

code{

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

}code

!_ resulting output:

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

An escaped url without decoration

!_ markup example:

code{

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

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

}code

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

code{

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

}code

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

!_ markup example:

code{

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

}code

3~ Linking Text

!_ resulting output:

about { SiSU }http://www.jus.uio.no/sisu/ markup

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

!_ markup example:

code{

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

}code

!_ resulting output:

about {~^ SiSU }http://www.jus.uio.no/sisu/ markup

3~ Linking Images

!_ markup example:

code{

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


}code

!_ resulting output:

{ tux.png 64x80 }image

{tux.png 64x80 "Gnu/Linux - a better way" }http://www.jus.uio.no/sisu/

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

{GnuDebianLinuxRubyBetterWay.png 100x101 "Way Better - with Gnu/Linux, Debian and Ruby" }http://www.jus.uio.no/sisu/


!_ linked url footnote shortcut

code{

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

}code

code{

text marker *~name

}code

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.

2~ Grouped Text

3~ Tables

Tables may be prepared in two either of two forms

!_ markup example:

code{

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

}code

!_ resulting output:

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

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

*{markup example:}*~{ Table from the Wealth of Networks by Yochai Benkler<br> http://www.jus.uio.no/sisu/the_wealth_of_networks.yochai_benkler }~

code{

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

}code

!_ resulting output:


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


% code{
% 
% test
% 
% ~# 
% 
% % unnumbered paragraph (place marker at end of paragraph)
% 
% -# 
% 
% % unnumbered paragraph, delete when not required (place marker at end of paragraph) [used in dummy headings, eg. for segmented html]
% 
% % add a comment to text, that will be removed prior to processing (place marker at beginning of line)
% 
% }code

3~ Poem

!_ basic markup:

code{

poem{

  Your poem here

}poem

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

}code

!_ markup example:

code{

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

}code

!_ resulting output:

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

3~ Group

!_ basic markup:

code{

group{

  Your grouped text here

}group

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

}code

!_ markup example:

code{

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

}code

!_ resulting output:

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

3~ Code

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.

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:

code{

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

}code

1~ Composite documents markup

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

basic markup for importing a document into a master document

code{

<< |filename1.sst|@|^|

<< |filename2.ssi|@|^|

}code

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.

code{

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>

}code

% Composite documents - remote parts

% Composite documents may be built from remote parts, by using the composite document syntax with a url. This makes sense using either sisu regular syntax (which is just a convenient way of marking up), or thlnk syntax, which also recognises remote urls, and permits hyperlinking ascii to the url location.

% remote documents may be called with the thlnk syntax (or regular sisu syntax), e.g.

% << <url:http://www.url.com/filename.ssi>
% 
% 
% .SH "DOCUMENT NAMING CONVENTION"
% .PP
% SiSU documents are named with the suffix
% .I ss
% followed by a third distinguishing letter, usually t for ordinary text files.
% .PP
% .I .sst
% is used by regular documents, and for most purposes is all you need to be aware of
% .PP
% .I .ssm
% suffix indicates a master or composite document, i.e. a document which requests other documents, which may have the file extension .sst or .ssi. See section on Composite Documents for information on how these are prepared.
% .PP
% .I .ssi
% indicates some prepared sisu markup information that is to be requested within master or composite document(s) and is not to be processed as a stand\-alone document.
% .PP
% .I ._sst
% and
% .I .\-sst
% suffix are reserved for SiSU processing, and indicate a secondary file. Such secondary files are created when a composite file is constructed, and when a url is provided, it is saved locally for processing, as a secondary processing file. Secondary files may be clobbered by SiSU at will, and are not a way of storing information.
% 
% .I .sxs.xml
% simple xml sax, sisu markup representation
% 
% .I .sxd.xml
% simple xml dom, sisu markup representation
% 
% .I .sxn.xml
% simple xml node, sisu markup representation
% 
% .I .sxs.xml.sst
% or
% .I .sxd.xml.sst
% or
% .I .sxn.xml.sst
% auto\-converted from a simple xml markup representation (sxs, sxd, sxn)
% .\" %% Remote Operations
% .SH "REMOTE OPERATIONS"
% .PP
% These may be of three basic types.
% .PP
% Instruction that processed files are to be copied to a remote server, using the \-r or \-R flag as part of the processing instruction. This requires previous setting up/configuration of the method to be used (eg scp assumed for \-r and rsync for \-R) and url to which these files are to be sent. *
% .PP
% The downloading of a remote file for processing using SiSU locally, which is achieved in one of two ways:
% .PP
% A processing instruction may include the url to the a remote file that is to be processed \- this will be downloaded and given a temporary file .t extension, and will be processed using SiSU locally.
% .PP
% A file may request the inclusion of a remote document within it, see comments on "Composite Documents" for the request syntax.
% .PP
% Finally SiSU may be run on a remote server, which you download marked up files to for processing. This is not really a function of the operation of SiSU, just an available possibility given that not much bandwidth is required.
% .PP
% * with regard to remote files processed locally, the \-r option, a limitation is that it is up to the user to ensure that the remote file does not have an identical filename to another, e.g. local file, that is to be processed in the same directory. So far this has not been found to happen in practice... Alternative solutions are under consideration, but it is desired that filenames be human assigned, and meaningful, so hash keys of contents for filenames are not amongst the options considered.

:C~ Markup Syntax History

1~ 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

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

_1 SiSU 0.52

or, backward compatible using the comment marker:

_1 % 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

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

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

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