SiSU is an object-centric, lightweight markup based, document structuring, parser, publishing and search tool for document collections. It is command line oriented and generates static content that is currently made searchable at an object level through an SQL database. Markup helps define (delineate) objects (primarily various types of text block) which are tracked in sequence, substantive objects being numbered sequentially by the program for object citation.
Summary. An object is a unit of text within a document the most common being a paragraph. Objects include individual headings, paragraphs, tables, grouped text of various types such as code blocks and within poems, verse. Objects have properties and attributes, of particular significance are headings and their levels which provide document structure. A heading is an object with a heirarchical value, that conceptually contains other objects (such as paragraphs and possibly sub-headings etc.). Objects are tracked sequentially as they relate to each other object within a document and substantive objects are numbered sequentially, for citation purposes. Notably footnotes are not objects in themselves, rather belonging to the object from which they are referenced, and following their own numbering sequence. From heading objects (linked) tables of content may be generated, and if additional metadata is provided book type indexes can be generated that link back to the objects to which they relate.
Unpacking this a bit further. SiSU as a concept independent of its markup language and the parsers that have been implemented, is based on the following ideas:
Object-Centricity. On objects: In SiSU objects are the fundamental unit from which larger constructs within a document and the document itself is built. Breaking the document into objects provides interesting possibilities.
Objects are fundamental building blocks: Conceptually within SiSU, objects are the building blocks or individual units of construction of a document. Objects are usually blocks of text, the most common of which is the paragraph, other examples include: individual headings, tables, grouped text of various types which include code blocks and verse within poems, ... and as mentioned an object could also, for example, be an image. Objects can be formatted and placed as needed, providing flexibility and enabling multiple types of representation across disperate formats and text recepticle, examples including html, epub, latex (in the past mind-maps) and sql (populated at an object level, and thereby providing search with that degree of granularity).
Sequential. Objects have sequence: That objects have sequence, goes largely without saying, this follows authorship, it is part of the definition of a document and how a document is written to convey meaning.
Object Numbers & Citation. Substantive objects are numbered for citation purposes: Most objects within a document are meant by the author to be a substantive part of the document. All such objects are numbered sequentially and can be referenced thereby for citation purposes. Object numbers provide the possibility of citing/locating text precisely across different document formats and different languages (assuming the document has been translated). For search it also makes it possible to identify precisely where search criteria is met within in each document in the form of an index or to view those precise text objects before deciding which documents are of interest. Additionally the use of objects (and that objects are numbered) frees the possibility to represent the document in the manner considered most suitable to a specific document format wilst retaining its structural (and citation) integrity).
Characteristics. Objects have properties and attributes: Objects have properties (and may have attributes). By properties I here refer to the fundamental type of object, be it a heading, a paragraph, table, verse etc. Attributes extend further and may include other things that one might wish to associate with the object (examples not necessarily currently available/ implemented in SiSU might include, formatting whether it is indented, or metadata e.g. the associated language, or programming language for a code block)
Document structure. Heading objects hold documents structure: Heading objects hold documents structure through their heading level property. The types of document of interest to SiSU have structure that is captured by the heading level property. Headings are individual objects like any other with the additional properties that (i) they may be regarded as containing the other objects following them sequentially (until the next heading of a similar or higher level), heading objects may include other headings (sub-headings), and (ii) that they have a heirarchy, the root “heading” being the document title.
A complication was intruduced to provide greater flexibility across document output formats. Headings have two sets of levels, the level under which substantive text occurs, this would be a chapter or segment level, and above that in the heirarchy if needed are document section separators, book, section, part.
Non-objects Most but not all parts of a document are treated as objects. Notably footnotes are not objects in themselves, rather belonging to the object from which they are referenced, and following their own numbering sequence. From heading objects (linked) tables of content may be generated, and if additional metadata is provided book type indexes can be generated that link back to the objects to which they relate.
The Document Header. SiSU document have headers which contain document metadata, at a minimum the document title and author. In addition the document header may contain markup instruction (e.g. how to identify headings within the document, in which case those headings need not be found and treated accordingly)
SiSU parsers have now been implemented in different programming paradigms and languages a couple of times, the chosen markup has been left unchanged though the document headers have been modified.
This is the core of sisu, beyond which there is more but largely in the form of choices based on ... existing output formats and of implementation detail, deciding what attributes of objects, or within objects should be supported, extending markup to allow for the generation of book indexes from if tagging provided.
Here is a description that has been used for the original sisu (scribe):
With minimal preparation of a plain-text (UTF-8) file, using sisu markup syntax in your text editor of choice, SiSU can generate various document formats, most of which share a common object numbering system for locating content, including plain text, HTML, XHTML, XML, EPUB, OpenDocument text (ODF:ODT), LaTeX, PDF files, and populate an SQL database with objects (roughly paragraph-sized chunks) so searches may be performed and matches returned with that degree of granularity. Think of being able to finely match text in documents, using common object numbers, across different output formats (same object identifier for pdf, epub or html) and across languages if you have translations of the same document (same object identifier across languages). For search, your criteria is met by these documents at these locations within each document (equally relevant across different output formats and languages). To be clear (if obvious) page numbers provide none of this functionality. Object numbering is particularly suitable for “published” works (finalized texts as opposed to works that are frequently changed or updated) for which it provides a fixed means of reference of content. Document outputs can also share provided semantic meta-data.
SiSU is less about document layout than it is about finding a way using little markup to construct an abstract representation of a document that makes it possible to produce multiple representations of it which may be rather different from each other and used for different purposes, whether layout and publishing, scrollworthy online viewing/ reading, or content search. To be able to take advantage from its minimal preparation starting point of some of the strengths of rather different established ways of representing documents for different purposes, whether for search (relational database, or indexed flat files generated for that purpose whether of complete documents, or say of files made up of objects), online or other electronic viewing (e.g. html, xml, epub), or paper publication (e.g. pdf via latex)...
The solution arrived at is to extract structural information about the document (document sections and headings within the document, available through pattern matching or markup) and tracking objects (which primarily are defined units of text such as paragraphs, headings, tables, verse, etc. but also images) which can be reconstituted as the same documents with relevant object identification numbers so text (objects) can be referenced across different output formats and presentations.
SiSU generates tables of content, and through its markup the means for metadata to be provided for the generation of book style indexes for a document (that again due to document object numbers are the same and equally relevant across all document formats). Per document classifying/organizing metadata can also be provided for automated document curation.
... there have also been working experiments with sisu markup source, two way conversion/representation of sisu document markup source in mind-mapping (software kdissert was used for its strong focus on producing documents (now apparently called semantik)); also po4a software for translators has been used successfuly in its regular text mode for sisu markup in translation, (which is more an attribute of po4a than of sisu, but) which is of interest due to sisu/spine's object citation numbering being available across translations. Open Document Format text (odf:odt), has been an output, but much more interesting (and requested by potential users of sisu/spine) would be the ability of a word processor to save text/a document in sisu markup, making alternative document processing and presentations with sisu possible.
also worth mention, in the relatively long history of this project, there has been work done on extracting hash representations of each object, that could hypothetically be shared to prove the content of a document without sharing its content, or of identifying which objects change; these hashes can also be used as unique identifiers in a database or as identifying filenames if individual objects are saved.
SiSU has evolved, the current implementation focuses on one primary use-case, books and literary writings. However the concept on which it is based has wider application. Here is a prevously posted souvenir from my encounter with an IBM software evaluator in London June 2004 that came about through a chance encounter with an IBM manager at a Linux Expo, who was curious about my interest in Gnu/Linux with my legal background... on hearing that I also wrote software, he suggested, maybe IBM should have a look at it. I was interested, the meeting was set up... with an IBM, Software Innovations evaluator<br>His response after the meeting:
“Ralph
Good to meet with you today, I was very impressed with your software.
[colleague's name (also posted to an IBM colleague)] - in summary - Ralph has built an application that runs on linux and takes ASCII documents and pulls them apart in to the smallest constituent parts, storing them as XML, PDF and HTML, the HTML are hyperlinked up so the document can be browsed in its full form. the format and text data created is stored in a database.<br>This has potential in any place that needs the power of full text search whilst holding the structural concepts of the document i.e. legal, pharma, education, research.. which ones we need to figure out, ...”
Special interest was expressed in the search implications of SiSU. To paraphrase, the company has document management systems dealing with hundreds of thousands of texts, these tell you which documents match your search criteria, but cannot inform you where within a text these matches were found without opening the documents. This is achieved through defining document objects and making them the building block of the document, trackable document objects (that can be placed back in the context of the document or corpus of documents if part of a collection). SiSU's early design was to - abstract documents to their structure, and identified objects, numbered in a citable way (as pointed out document object hashes can be of use for the purpose).
SiSU Spine is the new generator for documents prepared in sisu markup, written in D as opposed to the original sisu which was first shared in Ruby.
Spine code has not as yet been made publicly available.
As compared with the original sisu generator sisu spine:
- Spine uses the same document markup for the document body, but uses yaml for document headers (which contains document metadata and configuration details), the original sisu has a bespoke markup for headers.
- Spine (written in D) is considerably faster at generating native output than sisu (written in Ruby), on last test at least 60 times faster (what took 1 minute takes 1 second; 1 hour a minute :-) (admittedly some time ago, ruby has been getting faster, hopefully this is not over over promising).
- Spine produces fewer document outputs types than sisu (html, epub, (odt, latex) and populates sql db for search)
- As regards non-native output, so far Spine has greater separation of what it does and largely leaves calling the external program to the user, e.g.: latex output is a native output in the sense that it is generated directly by spine, but the pdfs that can be produced from these are produced through use of an external program xelatex, which produces fine output but is a very much slower process.
- (where both produce the same output type, generally) Spine generally produces more up to date output format representations.
2. Introduction to SiSU Markup 1
This is the D version of the program sisu on which the markup it uses is based.
SiSU source documents are plaintext (UTF-8)
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:
● heading levels defines document structure
● text basic attributes, italics, bold etc.
● grouped text (objects), which are to be treated differently, such as code blocks or poems.
● footnotes/endnotes
● linked text and images
● paragraph actions, such as indent, bulleted, numbered-lists, etc.
minimal content/structure requirement, minimum being:
metadata
title: "SiSU Spine" subtitle: "Markup" creator: author: "Amissah, Ralph"
levels
A~ (level A [title]) 1~ (at least one level 1 [segment/(chapter)])
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 has the fllowing levels (that may be described as document parts, headings and subheadings):
A~ [title (& author)]
- document root, required once (== 1)
- followed by part B~ or level 1~
- often written in the form:
A~ @title @creator
where title and creator are taken from the document header
B~ [part]
- part B is followed by a part C~ if there is one or level 1~
C~ [subpart]
- part C is followed by a part D~ if there is one or level 1~
D~ [subsubpart]
- part D is followed by level 1~
1~ [heading, segment (chapter)]
- level 1 required at least once (>= 1)
- is followed by level 2~ or
by text which can then be followed
- by more text or by levels 1~ or 2~ (or relevant part)
- level 1 in html (and epub) is the basis of a document segment and in a book
would correspond to a chapter
2~ [sub-heading]
- followed by level 3~ or
- by text which can then be followed
by more text or by levels 1~, 2~ or 3~ (or relevant part)
3~ [sub-sub-heading]
- followed by text which can be followed
by more text or by levels 1~, 2~ or 3~ (or relevant part)
Rules:
- level A~ is mandatory, it is the (document root and) title
- there can only be one document root == level/part A~
- heading levels B,C,D, 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)
Markup examples are available in the form of prepared texts that were written under creative commons license that permit re-publication.
There is of course this document, which is provided with the program and provides a cursory overview of sisu markup. Running sisu spine against it gives an overview of the output produced by the program.
The document header is based on yaml, and is the part of the document preceeding the document root marked by “A~ [Document title & author]”
The document header contains either: semantic meta-data about the document, 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 within the header section are the hash symbol at the start of a line (and as the first character in a line of text) followed by a space and the comment:
# in the header section of a document, this would be a comment
This current document is loaded by a master document that has a header similar to this one:
# SiSU 8.0 title: main: "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: "2020-04-11" rights: copyright: "Copyright (C) Ralph Amissah 2007, 2020" license: "AGPL 3 (part of SiSU Spine documentation)" classify: topic_register: "electronic documents: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"
Looking back a bit:
# SiSU master 8.0
title:
main: "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: "2020-04-11"
rights:
copyright: "Copyright (C) Ralph Amissah 2007, 2020"
license: "AGPL 3 (part of SiSU Spine documentation)"
classify:
topic_register: "electronic documents: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"
make:
auto_num_top_at_level: "1"
substitute: [
[ "[$]{2}\\{sisudoc\\}", "www.sisudoc.org" ]
]
bold: "Debian|SiSU"
italics: "Linux|GPL|LaTeX|SQL"
breaks: "new=:B; break=1"
home_button_text: "{SiSU}https://sisudoc.org; {sources / git}https://git.sisudoc.org/projects/"
footer: "{SiSU}https://sisudoc.org; {git}https://git.sisudoc.org/projects"
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 two spaces 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
# SiSU 8.0
title: main: "SiSU" subtitle: "Markup" language: "English"
creator: author: [Lastname, First names] illustrator: [Lastname, First names] translator: [Lastname, First names] prepared_by: [Lastname, First names]
date: created: [year or yyyy-mm-dd] issued: [year or yyyy-mm-dd] available: [year or yyyy-mm-dd] published: [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]
rights: copyright: "Copyright (C) [Year and Holder]" license: "[Use License granted]" text: "[Name, Year]" translation: "[Name, Year]" illustrations: "[Name, Year]" # check rest
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" keywords: "list" loc: "[Library of Congress classification]" dewey: "[Dewey classification]"
identifier: isbn: "[ISBN]" oclc: ""
links: [
"{SiSU }https://www.sisudoc.org",
"{ FSF }https://www.fsf.org",
]
make:
auto_num_top_at_level: "1"
substitute: [
[ "[$]{2}\\{sisudoc\\}", "www.sisudoc.org" ]
]
bold: "Debian|SiSU" # [regular expression of words/phrases to be made bold]
italics: "Linux|GPL|LaTeX|SQL" # [regular expression of words/phrases to italicise]
breaks: "new=:B; break=1"
home_button_text: "{SiSU}https://sisudoc.org; {sources / git}https://git.sisudoc.org/gitweb/"
footer: "{SiSU}https://sisudoc.org; {git}https://git.sisudoc.org"
headings: text to match for each level
(e.g. PART; Chapter; Section; Article; or another: none; BOOK|FIRST|SECOND; none; CHAPTER;)
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)
markup example:
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}#
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
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:
● bullet text
● bullet text, first indent
● bullet text, two step indent
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.
markup example:
_0_1 first line no indent (no hang), rest of paragraph indented one step _1_0 first line indented, rest of paragraph no indent in each case level may be 0-9
resulting output:
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.
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
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.
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.
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:
~{ a footnote or endnote }~
resulting output:
markup example:
normal text~{ self contained endnote marker & endnote in one }~ continues
resulting output:
normal text
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
normal text
markup example:
normal text ~[* editors notes, numbered asterisk footnote/endnote series ]~ continues normal text ~[+ editors notes, numbered plus symbol footnote/endnote series ]~ continues
resulting output:
normal text ~[* editors notes, numbered asterisk footnote/endnote series ]~ continues
normal text ~[+ editors notes, numbered plus symbol footnote/endnote series ]~ continues
[discontinued] Alternative binary endnote notation (endnote pair) for footnotes/endnotes:
% note the endnote marker "~^" normal text~^ continues ^~ endnote text following the paragraph in which the marker occurs
standard (inline) and pair (binary) notation could not be mixed in the same document.
The reason binary notation was provided as an option was for the conversion of documents to sisu markup. Many documents were prepared in such a way that endnotes had been previously marked up in a binary fashion, and this provided a convenient and faster way to make the document conversion, just reflect those markup practices. The reason it has been dropped is it adds a slowing step to something that needs to be done at most once and it prove to be flakey, unnecessarily so even when kept under version control. It is preferable to do a two step conversion of the previously marked up document to sisu: first to the binary/paired footnote markup, then; convert it to the proper form of inline endnote markup with a dedicated helper conversion program, keeping the resulting properly marked up text.
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:
normal text https://www.sisudoc.org/ continues
resulting output:
normal text https://www.sisudoc.org/ continues
An escaped url without decoration
markup example:
normal text _https://www.sisudoc.org/ continues deb _https://www.jus.uio.no/sisu/archive unstable main non-free
resulting output:
normal text _https://www.sisudoc.org/ continues
deb _https://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 https://www.jus.uio.no/sisu/archive unstable main non-free deb-src https://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 }https://url.org markup
resulting output:
about SiSU markup
a couple of test urls
A shortcut notation is available so the url link may also be provided automatically as a footnote
markup example:
about {~^ SiSU }https://url.org markup
resulting output:
Internal document links to a named (anchor) tagged location, including named headings named inline anchor tags or an ocn the heading:
1~markup Markup
can be linked to as follows:
to find out more see { Markup }#markup
to find out more see Markup
named inline anchor tags *~an-inline-anchor-tag
and linked to the same way
the link { an inline anchor tag }#an-inline-anchor-tag
the link an inline anchor tag or to another part of the document: markup summary
markup example:
about { text links }#link_text
resulting output:
about text links
Shared document collection link
markup example:
about { SiSU book markup examples }:SiSU/examples.html
resulting output:
about { SiSU book markup examples }:SiSU/examples.html
markup example:
{ sm_tux.png 64x80 }image
% various url linked images
{sm_tux.png 64x80 "a better way" }https://www.sisudoc.org/
{sm_GnuDebianLinuxRubyBetterWay.png 100x101 "Way Better - with Gnu/Linux, Debian and Ruby" }https://www.sisudoc.org/
{~^ sm_ruby_logo.png "Ruby" }https://www.ruby-lang.org/en/
resulting output:
“test”
“Way Better - with Gnu/Linux, Debian and Ruby”
“Ruby”
“D for me”
“D, hey no fair”linked url footnote shortcut
{~^ [text to link] }https://url.org
% maps to: { [text to link] }https://url.org ~{ https://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.
markup example:
!_ /{"Viral Spiral"}/, David Bollier
{ "Viral Spiral", David Bollier [3sS]}viral_spiral.david_bollier.sst
“Viral Spiral”, David Bollier
{ “Viral Spiral”, David Bollier [3sS]}viral_spiral.david_bollier.sst
There are two markup syntaxes for blocked text, using curly braces or using tics
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{
this is a code block
}code
poem{
this here is a poem
}poem
``` code this is a code block ``` ``` poem this here is a poem ```
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.
The “group” is different from the “block” mark in that “group” does not preserve whitespace, the “block” mark does. The text falling within the block is a single object.
basic markup:
group{
Your grouped text here
}group
A group is treated as an object and given a single object number.
resulting group text output:
`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."
resulting group text output:
The Road Not Taken Related Poem Content Details
BY ROBERT FROST
Two roads diverged in a yellow wood,
And sorry I could not travel both
And be one traveler, long I stood
And looked down one as far as I could
To where it bent in the undergrowth;
Then took the other, as just as fair,
And having perhaps the better claim,
Because it was grassy and wanted wear;
Though as for that the passing there
Had worn them really about the same,
And both that morning equally lay
In leaves no step had trodden black.
Oh, I kept the first for another day!
Yet knowing how way leads on to way,
I doubted if I should ever come back.
I shall be telling this with a sigh
Somewhere ages and ages hence:
Two roads diverged in a wood, and I—
I took the one less traveled by,
And that has made all the difference.
The “block” is different from the “group” mark in that the “block” mark (like the “poem” mark) preserves whitespace, the “group” mark does not. The text falling within the “block” is a single object, which is different from the “poem” mark where each identified verse is an object.
basic markup:
block{
Your block text here
}block
A block is treated as an object and given a single object number.
resulting block text output:
`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."
curly brace delimiter, resulting block text output:
The Road Not Taken Related Poem Content Details BY ROBERT FROST Two roads diverged in a yellow wood, And sorry I could not travel both And be one traveler, long I stood And looked down one as far as I could To where it bent in the undergrowth; Then took the other, as just as fair, And having perhaps the better claim, Because it was grassy and wanted wear; Though as for that the passing there Had worn them really about the same, And both that morning equally lay In leaves no step had trodden black. Oh, I kept the first for another day! Yet knowing how way leads on to way, I doubted if I should ever come back. I shall be telling this with a sigh Somewhere ages and ages hence: Two roads diverged in a wood, and I— I took the one less traveled by, And that has made all the difference.
The “poem” mark like the “block” preserves whitespace. Text followed by two newlines are identified as verse and each verse is an object i.e. a poem may consist of multiple verse each of which is identified as an object, unlike a text “block” which is identified as a single object.
basic markup:
poem{
Your poem here
}poem
Each verse in a poem is given an object number.
curly brace delimiter, resulting poem text output (broken into verse):
`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."'
curly brace delimiter, resulting poem text output (broken into verse):
The Road Not Taken
by Robert Frost
Two roads diverged in a yellow wood, And sorry I could not travel both And be one traveler, long I stood And looked down one as far as I could To where it bent in the undergrowth;
Then took the other, as just as fair, And having perhaps the better claim, Because it was grassy and wanted wear; Though as for that the passing there Had worn them really about the same,
And both that morning equally lay In leaves no step had trodden black. Oh, I kept the first for another day! Yet knowing how way leads on to way, I doubted if I should ever come back.
I shall be telling this with a sigh Somewhere ages and ages hence: Two roads diverged in a wood, and I— I took the one less traveled by, And that has made all the difference.
tics delimiter, resulting group text output:
The Road Not Taken
by Robert Frost
Two roads diverged in a yellow wood, And sorry I could not travel both And be one traveler, long I stood And looked down one as far as I could To where it bent in the undergrowth;
Then took the other, as just as fair, And having perhaps the better claim, Because it was grassy and wanted wear; Though as for that the passing there Had worn them really about the same,
And both that morning equally lay In leaves no step had trodden black. Oh, I kept the first for another day! Yet knowing how way leads on to way, I doubted if I should ever come back.
I shall be telling this with a sigh Somewhere ages and ages hence: Two roads diverged in a wood, and I— I took the one less traveled by, And that has made all the difference.
“Code” blocks are a single text object, in which the original text is preserved.
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:
`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."'
From SiSU 2.7.7 on you can number codeblocks by placing a hash after the opening code tag code{# as demonstrated here:
`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."'
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:
| 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 |
Same as a tic table
| 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 |
Without instruction
| 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 |
a second form may be easier to work with in cases where there is not much information in each column
markup example:
!_ 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.
resulting output:
Table 3.1: Contributors to Wikipedia, January 2001 - June 2005
| 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.
To break a line within a “paragraph object”, two backslashes
\\
with a space before and a space or newline after them
may be used.
To break a line within a "paragraph object", two backslashes \\ with a space before and a space or newline after them \\ may be used.
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.
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:
-\\-
page (break) new:
=\\=
page (break) line across page (dividing paragraphs):
-..-
Object numbers can be switched off by adding a ~# to the end of a text object.
Sometimes it is wished to switch off object numbers for a larger group of text. In this case it is possible before the group, body of text to be without object numbers on a new line with nothing else on it to open the un-numbered object block with --~# and to close the un-numbered block, and restart object numbering with on a similarly otherwise empty new-line with --+#
--~# un-numbered object block of text contained here still un-numbered --+# object numbering returns here and for subsequent text objects to switch of object numbering for a single objct, to the end of the object add ~# like so:~#
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:
1~!biblio
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:
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: https://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
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.
The following footnote~{ quixote1605, pp 1000 - 1001, also Benkler2006 p 1. }~
would be presented as:
Quixote and Panza, Taming Windmills (1605), pp 1000 - 1001 also, Benkler, Wealth of Networks, (2006) p 1 or rather
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: https://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)
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
See .: Quixote, Don; Panza, Sancho /{Taming Windmills, Keeping True}/ (1605) :.
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.
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.
1~!glossary
_0_1 *{GPL}* An abbreviation that stands for "General Purpose License." ...
_0_1 [provide your list of terms and definitions]
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.
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.
Paragraph containing main term and sub-term.
={Main term:sub-term}
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:
Main term, 1
sub-term, 1
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.
Paragraph containing main term, second term and sub-term.
={first term; second term: sub-term}
The structure of the resulting index would be:
First term, 1,
Second term, 1,
sub-term, 1
If multiple sub-terms appear under one paragraph, they are separated under the main term heading from each other by a pipe symbol.
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
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:
Main term, 1,
sub-term, 1-3,
second sub-term, 1,
Another term, 1
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
<< filename1.sst << filename2.ssi
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.
markup example:
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}*'
resulting output:
The current Debian is ${debian_stable} the next debian will be ${debian_testing}
Another test ${sisudoc} ok?
Configure substitution in _sisu/sisu_document_make
Globalisation is to be observed as a trend intrinsic to the world economy.
Within commercial law an analysis of law and economics may assist in developing a better understanding of the relationship between commercial law and the commercial sector it serves.
$$$
Difference?
* !glossary
head
header document header, containing document specific (i) metadata information or (ii) make instructions
(document) structure relationship between headings and sub-headings, and the objects they contain. Document structure is extracted from heading levels, which are either: explicitly marked up, or; determined from a make regex provided in the document header. Use of document structure allow for the meaningful representation of documents in alternative ways and the use of ocn permits easy reference across different output formats.
heading document heading, each heading is marked indicating its level (in relation to other headings), and this is used as basis for determininge document structure. There are 8 levels, which are can be distinguesed as being one of three types: (i) 1 title level (marked up A or numeric 0); (ii) 3 optional document division levels, above text separating headings (marked up B - D, or numeric 1 to 3); (iii) 4 text headings (marked up 1 - 4, or numeric 4 to 7)
levels == heading levels document heading level, see heading and structure
marked up headings / mark up level
collapsed headings / collapsed levels
numeric levels
dummy heading a markup level 1 / dummy level 4 that does not exist in the original text that is manually inserted to maintain the documents structure rule that text follows a heading of markup level 1 (rather than A to D) (numeric level 4 rather than 0 to 3)
relatives? see ancestors and descendants
document ...
ancestors heading levels above the current heading level which it logically falls under and to which it belongs (headings preceding current level under which it occurs)
decendants decendant headings are sub-headings beneath the current heading level, heading levels below the current heading level which are derived from it and belong to it (sub-headings contained beneath current level); decendant objects are the range of objects contained by a heading (ocn ranges for each heading in document body)
(document) sections a document can be divided into 3 parts: front; body and; back. Front matter includes the table of contents (which is generated from headings) and any parts of the document that are presented before the document body (this might include a copyright notice for example). The document body, the substantive part of the document, all its substantive objects, including: headings, paragraphs, tables, verse etc. This is followed by optional backmatter: endnotes, generated from inline markup; glossary, from section using a subset of regular markup, with an indication that section is to be treated as glossary. Note two things glossary might do that it does not, there is: no automatic (sorting) alphabetisation of listing; no creation of term anchor tags (perhaps it should); bibliography, created from a specially marked up section, with indication that section is to be treated as bibliography; bookindex generated from dedicated markup appended to objects providing index terms and the relevant range; blurb made up of ordinary markup, with indication that section is to be treated as blurb
segment, segmented text certain forms of output are conveniently segmented, e.g. epub and segmented html. The document is broken into chunks indicated by markup level 1 heading (numeric level 4 headings) as the significant level at which the document should be segmented, and including all decendant objects of that level. For a longer text/book this will usually the chapter level. (this is significant in e.g. for epub and segmented html, which are broken by segment, usually chosen to be chapter)
scroll the document as a “scroll”, e.g. as a single text file, or continuous html document
object a unit of text. Objects include: headings; paragraphs; code blocks; grouped text; verse of poems; tables. Each substantive object is given an object number, that should make it citable.
ocn (object citation number / citation number) numbers assigned sequentially to each substantive object of a document. An ocn has the characteristic of remaining identical across output formats. Translations should be prepared so number remains identical across objects in different languages
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. sometimes used for segmented html, e.g. to mark a prologue that is not otherwise identified as such as belonging to its own segment, segment will be created as such an placed in toc, but will not be found in scroll versions of the document]
citation number (see ocn / object citation number)
heading auto-numbering set in header, switched off in markup level 1~ with an appended minus 1~- or 1~given_segname-
document abstraction (== internal representation) intermediate step, preprocessing of document, into abstraction / representation that is used by all downstream processing, i.e. for all output formats. This allows normalisation, reducing alternative markup options to common representations, e.g. code blocks (open and close), tables, ways of instructing that text be bold, shortuct way of providing and endnote reference to a link
(document) internal representation (== document abstraction) see document abstraction
node representation
attribute (object attributes) when the document is abstracted attributes associated with an object, for example for a: paragraph, indent (hang ... check & add), bulleted, for a: code block, the language syntax, whether the block is numbered
inline markup when the document is abstracted, markup that remains embedded in the text, such as its font face (bold, italic, emphasis, underscore, strike, superscript, subscript), links, endnotes
sequential all objects backkeeping number?
~sdp/bin/sdp-ldc -v --epub --html --sqlite-update --output-dir=tmp/program-output data/sisupod/sisu-manual
time ( ~sdp/bin/sdp-ldc -v --epub --html --sqlite-update --output-dir=tmp/program-output data/sisupod/* )
~sdp/bin/sdp-ldc -v --source --sisupod --output-dir=tmp/program-output data/sisudir/media/text/sisu-manual.sst
~sdp/bin/sdp-ldc -v --source --sisupod --output-dir=tmp/program-output data/sisupod/sisu-manual
~sdp/bin/sdp-ldc -v --source --sisupod --output-dir=tmp/program-output data/sisupod/*
~sdp/bin/sdp-ldc -v --sqlite-db-drop --output-dir=tmp/program-output
~sdp/bin/sdp-ldc -v --sqlite-db-create --output-dir=tmp/program-output
~sdp/bin/sdp-ldc -v --sqlite-db-recreate --output-dir=tmp/program-output
~sdp/bin/sdp-ldc -v --sqlite-db-recreate --sqlite-insert --output-dir=tmp/program-output data/sisupod/*
~sdp/bin/sdp-ldc -v --sqlite-db-recreate --sqlite-update --output-dir=tmp/program-output data/sisupod/*
~sdp/bin/sdp-ldc -v --sqlite-db-drop --sqlite-db-create --sqlite-update --epub --html --output-dir=tmp/program-output data/sisupod/*
~sdp/bin/sdp-ldc -v --sqlite-db-drop --sqlite-db-create --sqlite-update --epub --html --output-dir=tmp/program-output data/sisupod/*
~sdp/bin/sdp-ldc -v --sqlite-db-drop --sqlite-db-create --sqlite-update --epub --html --output-dir=tmp/program-output data/sisupod/sisu-manual
~sdp/bin/sdp-ldc -v --sqlite-db-drop --sqlite-db-create --sqlite-update --epub --html --output-dir=tmp/program-output data/sisupod/sisu-manual
~sdp/bin/sdp-dmd -v --epub --html --output-dir=tmp/program-output data/sisudir/media/text/sisu_markup.sst