% SiSU 4.0 @title: SiSU :subtitle: Markup @creator: :author: Amissah, Ralph @date: :created: 2002-08-28 :issued: 2002-08-28 :available: 2002-08-28 :published: 2008-05-22 :modified: 2012-10-03 @rights: :copyright: Copyright (C) Ralph Amissah 2007 :license: GPL 3 (part of SiSU documentation) @classify: :topic_register: electronic documents:SiSU:document:markup;SiSU:document:markup;SiSU:document:markup;SiSU:manual:markup;electronic documents:SiSU:manual:markup :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search :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 ={ SiSU markup:description } 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. 2~ Markup Rules, document structure and metadata requirements ={ SiSU markup:rules and requirements } minimal content/structure requirement: [metadata] @title: @creator: [levels] ``` code A~ (level A [title]) 1~ (at least one level 1 [segment/(chapter)]) ``` ={ output:code markup example;SiSU markup output:code block (tic syntax);code block:tic syntax } structure rules (document heirarchy, heading levels): there are two sets of heading levels ABCD (title & parts if any) and 123 (segment & subsegments if any) ={ SiSU markup:heading levels } sisu has the fllowing levels: ``` code A~ [title] . required (== 1) followed by B~ or 1~ B~ [part] * followed by C~ or 1~ C~ [subpart] * followed by D~ or 1~ D~ [subsubpart] * followed by 1~ 1~ [segment (chapter)] + required (>= 1) followed by text or 2~ text * followed by more text or 1~, 2~ or relevant part *() 2~ [subsegment] * followed by text or 3~ text * followed by more text or 1~, 2~ or 3~ or relevant part, see *() 3~ [subsubsegment] * followed by text text * followed by more text or 1~, 2~ or 3~ or relevant part, see *() *(B~ if none other used; if C~ is last used: C~ or B~; if D~ is used: D~, C~ or B~) ``` ``` code * level A~ is the tile and is mandatory * there can only be one level A~ * heading levels BCD, are optional and there may be several of each (where all three are used corresponding to e.g. Book Part Section) * sublevels that are used must follow each other sequentially (alphabetically), * heading levels A~ B~ C~ D~ are followed by other heading levels rather than substantive text which may be the subsequent sequential (alphabetic) heading part level or a heading (segment) level 1~ * there must be at least one heading (segment) level 1~ (the level on which the text is segmented, in a book would correspond to the Chapter level) * additional heading levels 1~ 2~ 3~ are optional and there may be several of each * heading levels 1~ 2~ 3~ are followed by text (which may be followed by the same heading level) and/or the next lower numeric heading level (followed by text) or indeed return to the relevant part level (as a corollary to the rules above substantive text/ content must be preceded by a level 1~ (2~ or 3~) heading) ``` 2~ Markup Examples ={ SiSU markup:locating examples } 3~ Online ={ SiSU markup:examples 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/ an alternative presentation of markup syntax: /usr/share/doc/sisu/on_markup.txt.gz 3~ Installed ={ SiSU markup:examples installed } With SiSU installed sample skins may be found in: /usr/share/doc/sisu/markup-samples (or equivalent directory) and if sisu-markup-samples is installed also under: /usr/share/doc/sisu/markup-samples-non-free 1~headers Markup of Headers ={ SiSU markup:headers} Headers contain either: semantic meta-data about a document, which can be used by any output module of the program, or; 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 ={ output:code markup example;SiSU markup output:code block (curly brace syntax);code block:curly brace syntax } 2~ Sample Header ={ SiSU markup:sample header} This current document is loaded by a master document that has a header similar to this one: code{ % SiSU master 4.0 @title: SiSU :subtitle: Manual @creator: :author: Amissah, Ralph @publisher: [publisher name] @rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 @classify: :topic_register: SiSU:manual;electronic documents:SiSU:manual :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search % used_by: manual @date: :published: 2008-05-22 :created: 2002-08-28 :issued: 2002-08-28 :available: 2002-08-28 :modified: 2010-03-03 @make: :num_top: 1 :breaks: new=C; break=1 :bold: /Gnu|Debian|Ruby|SiSU/ :home_button_text: {SiSU}http://sisudoc.org; {git}http://git.sisudoc.org :footer: {SiSU}http://sisudoc.org; {git}http://git.sisudoc.org :manpage: name=sisu - documents: markup, structuring, publishing in multiple standard formats, and search; synopsis=sisu [-abcDdeFhIiMmNnopqRrSsTtUuVvwXxYyZz0-9] [filename/wildcard ] . sisu [-Ddcv] [instruction] . sisu [-CcFLSVvW] @links: { SiSU Homepage }http://www.sisudoc.org/ { SiSU Manual }http://www.sisudoc.org/sisu/sisu_manual/ { Book Samples & Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html { SiSU Git repo }http://git.sisudoc.org/gitweb/?p=code/sisu.git;a=summary { SiSU List Archives }http://lists.sisudoc.org/pipermail/sisu/ { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html { SiSU Project @ Debian }http://qa.debian.org/developer.php?login=sisu@lists.sisudoc.org { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU }code 2~ Available Headers ={ SiSU markup:headers available } 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 the form @headername: or on the next line and indented by once space :subheadername: All Dublin Core meta tags are available !_ @identifier: information or instructions where the "identifier" is a tag recognised by the program, and the "information" or "instructions" belong to the tag/identifier 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): code{ % SiSU 2.0 [declared file-type identifier with markup version] }code code{ @title: [title text] [this header is the only one that is mandatory] :subtitle: [subtitle if any] :language: English }code code{ @creator: :author: [Lastname, First names] :illustrator: [Lastname, First names] :translator: [Lastname, First names] :prepared_by: [Lastname, First names] }code code{ @date: :published: [year or yyyy-mm-dd] :created: [year or yyyy-mm-dd] :issued: [year or yyyy-mm-dd] :available: [year or yyyy-mm-dd] :modified: [year or yyyy-mm-dd] :valid: [year or yyyy-mm-dd] :added_to_site: [year or yyyy-mm-dd] :translated: [year or yyyy-mm-dd] }code code{ @rights: :copyright: Copyright (C) [Year and Holder] :license: [Use License granted] :text: [Year and Holder] :translation: [Name, Year] :illustrations: [Name, Year] }code code{ @classify: :topic_register: SiSU:markup sample:book;book:novel:fantasy :type: :subject: :description: :keywords: :abstract: :loc: [Library of Congress classification] :dewey: [Dewey classification }code code{ @identify: :isbn: [ISBN] :oclc: }code code{ @links: { SiSU }http://www.sisudoc.org { FSF }http://www.fsf.org }code code{ @make: :num_top: 1 :headings: [text to match for each level (e.g. PART; Chapter; Section; Article; or another: none; BOOK|FIRST|SECOND; none; CHAPTER;) :breaks: new=:C; break=1 :promo: sisu, ruby, sisu_search_libre, open_society :bold: [regular expression of words/phrases to be made bold] :italics: [regular expression of words/phrases to italicise] :home_button_text: {SiSU}http://sisudoc.org; {git}http://git.sisudoc.org :footer: {SiSU}http://sisudoc.org; {git}http://git.sisudoc.org }code code{ @original: :language: [language] }code code{ @notes: :comment: :prefix: [prefix is placed just after table of contents] }code % 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 ={ SiSU markup:substantive text } 2~heading_levels Heading Levels ={ SiSU markup: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 ={ SiSU markup:font attributes } !_ markup example: code{ normal text, *{emphasis}*, !{bold text}!, /{italics}/, _{underscore}_, "{citation}", ^{superscript}^, ,{subscript},, +{inserted text}+, -{strikethrough}-, #{monospace}# normal text *{emphasis}* [note: can be configured to be represented by bold, italics or underscore] !{bold text}! /{italics}/ _{underscore}_ "{citation}" ^{superscript}^ ,{subscript}, +{inserted text}+ -{strikethrough}- #{monospace}# }code !_ resulting output: normal text, *{emphasis}*, !{bold text}!, /{italics}/, _{underscore}_, "{citation}", ^{superscript}^, ,{subscript},, +{inserted text}+, -{strikethrough}-, #{monospace}# normal text *{emphasis}* [note: can be configured to be represented by bold, italics or underscore] !{bold text}! /{italics}/ _{underscore}_ "{citation}" ^{superscript}^ ,{subscript}, +{inserted text}+ -{strikethrough}- #{monospace}# 2~ Indentation and bullets ={ SiSU markup:indentation and bullets } !_ markup example: ={ SiSU markup:indentation } 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: ={ SiSU markup:bullets } 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~ Hanging Indents ={ SiSU markup:hanging indents;indented text:hanging } !_ markup example: code{ _0_1 first line no indent, rest of paragraph indented one step _1_0 first line indented, rest of paragraph no indent in each case level may be 0-9 }code !_ resulting output: _0_1 first line no indent, rest of paragraph indented one step; first line no indent, rest of paragraph indented one step; first line no indent, rest of paragraph indented one step; first line no indent, rest of paragraph indented one step; first line no indent, rest of paragraph indented one step; first line no indent, rest of paragraph indented one step; first line no indent, rest of paragraph indented one step; first line no indent, rest of paragraph indented one step; first line no indent, rest of paragraph indented one step; A regular paragraph. _1_0 first line indented, rest of paragraph no indent first line indented, rest of paragraph no indent first line indented, rest of paragraph no indent first line indented, rest of paragraph no indent first line indented, rest of paragraph no indent first line indented, rest of paragraph no indent first line indented, rest of paragraph no indent first line indented, rest of paragraph no indent first line indented, rest of paragraph no indent first line indented, rest of paragraph no indent first line indented, rest of paragraph no indent in each case level may be 0-9 _0_1 *{live-build}* A collection of scripts used to build customized Debian Livesystems. /{live-build}/ was formerly known as live-helper, and even earlier known as live-package. _0_1 *{live-build}* \\ A collection of scripts used to build customized Debian Livesystems. /{live-build}/ was formerly known as live-helper, and even earlier known as live-package. 2~ Footnotes / Endnotes ={ SiSU markup:hanging indents;footnotes;endnotes } Footnotes and endnotes are marked up at the location where they would be indicated within a text. They are automatically numbered. The output type determines whether footnotes or endnotes will be produced !_ markup example: 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 plus symbol footnote/endnote series ]~ continues }code !_ resulting output: normal text ~[* editors notes, numbered asterisk footnote/endnote series ]~ continues normal text ~[+ editors notes, numbered plus symbol footnote/endnote series ]~ continues !_ Alternative endnote pair notation for footnotes/endnotes: 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 ={ SiSU markup:links (text, images);links:images|text } 3~ Naked URLs within text, dealing with urls urls found within text are marked up automatically. A url within text is automatically hyperlinked to itself and by default decorated with angled braces, unless they are contained within a code block (in which case they are passed as normal text), or escaped by a preceding underscore (in which case the decoration is omitted). !_ markup example: code{ normal text http://www.sisudoc.org/ continues }code !_ resulting output: normal text http://www.sisudoc.org/ continues An escaped url without decoration !_ markup example: code{ normal text _http://www.sisudoc.org/ continues deb _http://www.jus.uio.no/sisu/archive unstable main non-free }code !_ resulting output: normal text _http://www.sisudoc.org/ continues deb _http://www.jus.uio.no/sisu/archive unstable main non-free where a code block is used there is neither decoration nor hyperlinking, code blocks are discussed later in this document !_ resulting output: 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 3~link_text Linking Text ={ SiSU markup:links (text);links:text } To link text or an image to a url the markup is as follows !_ markup example: code{ about { SiSU }http://url.org markup }code !_ resulting output: about { SiSU }http://www.sisudoc.org/ 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.sisudoc.org/ markup Internal document links to a tagged location, including an ocn !_ markup example: code{ about { text links }#link_text }code !_ resulting output: about { text links }#link_text Shared document collection link !_ markup example: code{ about { SiSU book markup examples }:SiSU/examples.html }code !_ resulting output: about { SiSU book markup examples }:SiSU/examples.html 3~ Linking Images ={ SiSU markup:links (images);links:images } !_ markup example: code{ { tux.png 64x80 }image % various url linked images {tux.png 64x80 "a better way" }http://www.sisudoc.org/ {GnuDebianLinuxRubyBetterWay.png 100x101 "Way Better - with Gnu/Linux, Debian and Ruby" }http://www.sisudoc.org/ {~^ ruby_logo.png "Ruby" }http://www.ruby-lang.org/en/ }code !_ resulting output: { tux.png 64x80 }image {tux.png 64x80 "Gnu/Linux - a better way" }http://www.sisudoc.org/ {GnuDebianLinuxRubyBetterWay.png 100x101 "Way Better - with Gnu/Linux, Debian and Ruby" }http://www.sisudoc.org/ {~^ ruby_logo.png "Ruby" }http://www.ruby-lang.org/en/ !_ 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. 3~ Link shortcut for multiple versions of a sisu document in the same directory tree !_ markup example: code{ !_ /{"Viral Spiral"}/, David Bollier { "Viral Spiral", David Bollier [3sS]}viral_spiral.david_bollier.sst }code !_ /{"Viral Spiral"}/, David Bollier { "Viral Spiral", David Bollier [3sS]}viral_spiral.david_bollier.sst 2~ Grouped Text / blocked text ={ SiSU markup:grouped text;grouped text;blocked text;text blocks } There are two markup syntaxes for blocked text, using curly braces or using tics 3~ blocked text curly brace syntax ={ SiSU markup:grouped text;grouped text:curly brace syntax;blocked text:curly brace syntax;text blocks:curly brace syntax } at the start of a line on its own use name of block type with an opening curly brace, follow with the content of the block, and close with a closing curly brace and the name of the block type, e.g. ``` code code{ this is a code block }code ``` ``` code poem{ this here is a poem }poem ``` 3~ blocked text tic syntax ={ SiSU markup:grouped text;grouped text:tic syntax;blocked text:tic syntax;text blocks:tic syntax } code{ ``` code this is a code block ``` ``` poem this here is a poem ``` }code start a line with three backtics, a space followed by the name of the name of block type, follow with the content of the block, and close with three back ticks on a line of their own, e.g. 3~ Tables ={ SiSU markup:tables;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 % ={ output:table markup example;SiSU markup output:table (curly brace syntax) } 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 \\ 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 ={ SiSU markup:poem;poems } !_ basic markup: code{ poem{ Your poem here }poem Each verse in a poem is given an 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 % ={ output:poem markup example;SiSU markup output:poem (curly brace syntax) } 3~ Group ={ SiSU markup:group text;group text } !_ 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 ={ output:group block markup example;SiSU markup output:group block (curly brace syntax) } 3~ Code ={ SiSU markup:code block;code block } Code tags #{ code{ ... }code }# (used as with other group tags described above) are used to escape regular sisu markup, and have been used extensively within this document to provide examples of SiSU markup. You cannot however use code tags to escape code tags. They are however used in the same way as group or poem tags. A code-block is treated as an object and given a single object number. [an option to number each line of code may be considered at some later time] !_ use of code tags instead of poem compared, resulting output: 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 From SiSU 2.7.7 on you can number codeblocks by placing a hash after the opening code tag #{ code{# }# this is depreciated from sisu 7.2.0 with the introduction of the parenthesis before curly braces for attributes. From SiSU 7.2.0 on you can number codeblocks by writing the "numberline" attribute within parenthesis before the opening code tag #{ code(numberlines){ }# as demonstrated here: code(numberlines){ `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 ={ output:code markup example;SiSU markup output:code block (curly brace syntax);code block:curly brace syntax } 2~ Additional breaks - linebreaks within objects, column and page-breaks ={ SiSU markup:breaks (page and line);breaks } 3~ line-breaks ={ SiSU markup:line break;line break } To break a line within a "paragraph object", two backslashes \\\\ \\ with a space before and a space or newline after them \\ may be used. code{ To break a line within a "paragraph object", two backslashes \\ with a space before and a space or newline after them \\ may be used. }code The html break br enclosed in angle brackets (though undocumented) is available in versions prior to 3.0.13 and 2.9.7 (it remains available for the time being, but is depreciated). To draw a dividing line dividing paragraphs, see the section on page breaks. 3~ page breaks ={ SiSU markup:page break;page break } Page breaks are only relevant and honored in some output formats. A page break or a new page may be inserted manually using the following markup on a line on its own: page new =\\= breaks the page, starts a new page. page break -\\- breaks a column, starts a new column, if using columns, else breaks the page, starts a new page. page break line across page -..- draws a dividing line, dividing paragraphs page break: code{ -\\- }code page (break) new: code{ =\\= }code page (break) line across page (dividing paragraphs): code{ -..- }code 2~ Bibliography / References ={ SiSU markup:references|bibliography|citations;references } There are three ways to prepare a bibliography using sisu (which are mutually exclusive): (i) manually preparing and marking up as regular text in sisu a list of references, this is treated as a regular document segment (and placed before endnotes if any); (ii) preparing a bibliography, marking a heading level 1~!biblio (note the exclamation mark) and preparing a bibliography using various metadata tags including for author: title: year: a list of which is provided below, or; (iii) as an assistance in preparing a bibliography, marking a heading level 1~!biblio and tagging citations within footnotes for inclusion, identifying citations and having a parser attempt to extract them and build a bibliography of the citations provided. For the heading/section sequence: endnotes, bibliography then book index to occur, the name biblio or bibliography must be given to the bibliography section, like so: code{ 1~!biblio }code 3~ a markup tagged metadata bibliography section Here instead of writing your full citations directly in footnotes, each time you have new material to cite, you add it to your bibliography section (if it has not been added yet) providing the information you need against an available list of tags (provided below). The required tags are au: ti: and year: ~{for which you may alternatively use the full form author: title: and year: }~ an short quick example might be as follows: code{ 1~!biblio au: von Hippel, E. ti: Perspective: User Toolkits for Innovation lng: (language) jo: Journal of Product Innovation Management vo: 18 ed: (editor) yr: 2001 note: sn: Hippel, /{User Toolkits}/ (2001) id: vHippel_2001 % form: au: Benkler, Yochai ti: The Wealth of Networks st: How Social Production Transforms Markets and Freedom lng: (language) pb: Harvard University Press edn: (edition) yr: 2006 pl: U.S. url: http://cyber.law.harvard.edu/wealth_of_networks/Main_Page note: sn: Benkler, /{Wealth of Networks}/ (2006) id: Benkler2006 au: Quixote, Don; Panza, Sancho ti: Taming Windmills, Keeping True jo: Imaginary Journal yr: 1605 url: https://en.wikipedia.org/wiki/Don_Quixote note: made up to provide an example of author markup for an article with two authors sn: Quixote & Panza, /{Taming Windmills}/ (1605) id: quixote1605 }code Note that the section name !biblio (or !bibliography) is required for the bibliography to be treated specially as such, and placed after the auto-generated endnote section. Using this method, work goes into preparing the bibliography, the tags author or editor, year and title are required and will be used to sort the bibliography that is placed under the Bibliography section The metadata tags may include shortname (sn:) and id, if provided, which are used for substitution within text. Every time the given id is found within the text it will be replaced by the given short title of the work (it is for this reason the short title has sisu markup to italicize the title), it should work with any page numbers to be added, the short title should be one that can easily be used to look up the full description in the bibliography. code{ The following footnote~{ quixote1605, pp 1000 - 1001, also Benkler2006 p 1. }~ }code would be presented as: Quixote and Panza, /{Taming Windmills}/ (1605), pp 1000 - 1001 also, Benkler, /{Wealth of Networks}/, (2006) p 1 or rather~{ Quixote and Panza, /{Taming Windmills}/ (1605), pp 1000 - 1001 also, Benkler, /{Wealth of Networks}/ (2006), p 1 }~ code{ au: author Surname, FirstNames (if multiple semi-colon separator) (required unless editor to be used instead) ti: title (required) st: subtitle jo: journal vo: volume ed: editor (required if author not provided) tr: translator src: source (generic field where others are not appropriate) in: in (like src) pl: place/location (state, country) pb: publisher edn: edition yr: year (yyyy or yyyy-mm or yyyy-mm-dd) (required) pg: pages url: http://url note: note id: create_short_identifier e.g. authorSurnameYear (used in substitutions: when found within text will be replaced by the short name provided) sn: short name e.g. Author, /{short title}/, Year (used in substitutions: when an id is found within text the short name will be used to replace it) }code 3~ Tagging citations for inclusion in the Bibliography Here whenever you make a citation that you wish be included in the bibliography, you tag the citation as such using special delimiters (which are subsequently removed from the final text produced by sisu) Here you would write something like the following, either in regular text or a footnote code{ See .: Quixote, Don; Panza, Sancho /{Taming Windmills, Keeping True}/ (1605) :. }code SiSU will parse for a number of patterns within the delimiters to try make out the authors, title, date etc. and from that create a Bibliography. This is more limited than the previously described method of preparing a tagged bibliography, and using an id within text to identify the work, which also lends itself to greater consistency. 2~ Glossary ={ SiSU markup:glossary|Glossary } Using the section name 1~!glossary results in the Glossary being treated specially as such, and placed after the auto-generated endnote section (before the bibliography/list of references if there is one). The Glossary is ordinary text marked up in a manner deemed suitable for that purpose. e.g. with the term in bold, possibly with a hanging indent. code{ 1~!glossary _0_1 *{GPL}* An abbreviation that stands for "General Purpose License." ... _0_1 [provide your list of terms and definitions] }code In the given example the first line is not indented subsequent lines are by one level, and the term to be defined is in bold text. 2~ Book index ={ SiSU markup:book index;book index } To make an index append to paragraph the book index term relates to it, using an equal sign and curly braces. Currently two levels are provided, a main term and if needed a sub-term. Sub-terms are separated from the main term by a colon. code{ Paragraph containing main term and sub-term. ={Main term:sub-term} }code The index syntax starts on a new line, but there should not be an empty line between paragraph and index markup. The structure of the resulting index would be: code{ Main term, 1 sub-term, 1 }code Several terms may relate to a paragraph, they are separated by a semicolon. If the term refers to more than one paragraph, indicate the number of paragraphs. code{ Paragraph containing main term, second term and sub-term. ={first term; second term: sub-term} }code The structure of the resulting index would be: code{ First term, 1, Second term, 1, sub-term, 1 }code If multiple sub-terms appear under one paragraph, they are separated under the main term heading from each other by a pipe symbol. code{ Paragraph containing main term, second term and sub-term. ={Main term: sub-term+2|second sub-term; Another term } A paragraph that continues discussion of the first sub-term }code The plus one in the example provided indicates the first sub-term spans one additional paragraph. The logical structure of the resulting index would be: code{ Main term, 1, sub-term, 1-3, second sub-term, 1, Another term, 1 }code 1~ Composite documents markup ={ SiSU markup:composite documents;composite documents } 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. 1~ Substitutions ={ SiSU markup:substitutions;substitutions } !_ markup example: code{ The current Debian is ${debian_stable} the next debian will be ${debian_testing} Configure substitution in _sisu/sisu_document_make @make: :substitute: /${debian_stable}/,'*{Wheezy}*' /${debian_testing}/,'*{Jessie}*' }code !_ resulting output: The current Debian is ${debian_stable} the next debian will be ${debian_testing} Configure substitution in _sisu/sisu_document_make