SISU\-CONCORDANCE(1) manual page

From 780c5275cb88587243902e6d720c935ecbb8dd94 Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Sun, 30 Dec 2012 15:51:42 -0500 Subject: v4: documentation, sisu.1 manpage & minor --- data/doc/sisu/CHANGELOG_v4 | 2 + data/doc/sisu/html/sisu-concordance.1.html | 6 +- data/doc/sisu/html/sisu-epub.1.html | 6 +- data/doc/sisu/html/sisu-git.1.html | 4 +- data/doc/sisu/html/sisu-harvest.1.html | 6 +- data/doc/sisu/html/sisu-html.1.html | 6 +- data/doc/sisu/html/sisu-odf.1.html | 6 +- data/doc/sisu/html/sisu-pdf.1.html | 6 +- data/doc/sisu/html/sisu-pg.1.html | 6 +- data/doc/sisu/html/sisu-po.1.html | 4 +- data/doc/sisu/html/sisu-sqlite.1.html | 6 +- data/doc/sisu/html/sisu-txt.1.html | 6 +- data/doc/sisu/html/sisu.1.html | 3590 +++++++++----------- data/doc/sisu/html/sisu4.1.html | 3590 +++++++++----------- .../markup-samples/v3/sisu_manual/sisu_markup.sst | 370 +- .../v3/sisu_manual/sisu_markup_syntax_history.sst | 256 ++ .../v4/sisu_manual/_sisu/sisu_document_make | 2 +- .../markup-samples/v4/sisu_manual/sisu_markup.sst | 145 +- .../v4/sisu_manual/sisu_markup_syntax_history.sst | 28 +- man/man1/sisu.1 | 2574 +++++++------- 20 files changed, 4802 insertions(+), 5817 deletions(-) create mode 100644 data/doc/sisu/markup-samples/v3/sisu_manual/sisu_markup_syntax_history.sst diff --git a/data/doc/sisu/CHANGELOG_v4 b/data/doc/sisu/CHANGELOG_v4 index 60ed276d..471c83e9 100644 --- a/data/doc/sisu/CHANGELOG_v4 +++ b/data/doc/sisu/CHANGELOG_v4 @@ -57,6 +57,8 @@ http://www.jus.uio.no/sisu/pkg/src/sisu_4.0.1.orig.tar.xz sisu -v -k sisu --version --color-off +* v4: documentation minor updates and regenerated manpage + %% 4.0.0.orig.tar.xz (2012-12-12:50/3) http://sources.sisudoc.org/gitweb/?p=code/sisu.git;a=shortlog;h=refs/tags/sisu_4.0.0 http://sources.sisudoc.org/gitweb/?p=code/sisu.git;a=shortlog;h=refs/tags/debian/sisu_4.0.0-1 diff --git a/data/doc/sisu/html/sisu-concordance.1.html b/data/doc/sisu/html/sisu-concordance.1.html index b4e53653..ef456d75 100644 --- a/data/doc/sisu/html/sisu-concordance.1.html +++ b/data/doc/sisu/html/sisu-concordance.1.html @@ -3,7 +3,7 @@ -SISU\-CONCORDANCE(1) manual page +SISU-CONCORDANCE(1) manual page Table of Contents

@@ -30,8 +30,6 @@ for sisu --concordance (or sisu -w) which produces an HTML concord ,
sisu-epub(1) ,
-sisu-git(1) -,
sisu-harvest(1) ,
sisu-html(1) @@ -42,8 +40,6 @@ for sisu --concordance (or sisu -w) which produces an HTML concord ,
sisu-pg(1) ,
-sisu-po(1) -,
sisu-sqlite(1) ,
sisu-txt(1) diff --git a/data/doc/sisu/html/sisu-epub.1.html b/data/doc/sisu/html/sisu-epub.1.html index fe853f62..6a84b876 100644 --- a/data/doc/sisu/html/sisu-epub.1.html +++ b/data/doc/sisu/html/sisu-epub.1.html @@ -3,7 +3,7 @@ -SISU\-EPUB(1) manual page +SISU-EPUB(1) manual page Table of Contents

@@ -30,8 +30,6 @@ The sisu-epub command is an alias for ,
sisu-concordance(1) ,
-sisu-git(1) -,
sisu-harvest(1) ,
sisu-html(1) @@ -42,8 +40,6 @@ The sisu-epub command is an alias for ,
sisu-pg(1) ,
-sisu-po(1) -,
sisu-sqlite(1) ,
sisu-txt(1) diff --git a/data/doc/sisu/html/sisu-git.1.html b/data/doc/sisu/html/sisu-git.1.html index b2955f6e..a23d0118 100644 --- a/data/doc/sisu/html/sisu-git.1.html +++ b/data/doc/sisu/html/sisu-git.1.html @@ -3,7 +3,7 @@ -SISU\-GIT(1) manual page +SISU-GIT(1) manual page Table of Contents

@@ -40,8 +40,6 @@ document and associated parts (images, ). ,
sisu-pg(1) ,
-sisu-po(1) -,
sisu-sqlite(1) ,
sisu-txt(1) diff --git a/data/doc/sisu/html/sisu-harvest.1.html b/data/doc/sisu/html/sisu-harvest.1.html index ac5d3034..8d264278 100644 --- a/data/doc/sisu/html/sisu-harvest.1.html +++ b/data/doc/sisu/html/sisu-harvest.1.html @@ -3,7 +3,7 @@ -SISU\-HARVEST(1) manual page +SISU-HARVEST(1) manual page Table of Contents

@@ -34,8 +34,6 @@ Also ,
sisu-epub(1) ,
-sisu-git(1) -,
sisu-html(1) ,
sisu-pdf(1) @@ -44,8 +42,6 @@ Also ,
sisu-pg(1) ,
-sisu-po(1) -,
sisu-sqlite(1) ,
sisu-txt(1) diff --git a/data/doc/sisu/html/sisu-html.1.html b/data/doc/sisu/html/sisu-html.1.html index 3114567e..a95b7796 100644 --- a/data/doc/sisu/html/sisu-html.1.html +++ b/data/doc/sisu/html/sisu-html.1.html @@ -3,7 +3,7 @@ -SISU\-HTML(1) manual page +SISU-HTML(1) manual page Table of Contents

@@ -32,8 +32,6 @@ The sisu-html command is an alias for ,
sisu-epub(1) ,
-sisu-git(1) -,
sisu-harvest(1) ,
sisu-pdf(1) @@ -42,8 +40,6 @@ The sisu-html command is an alias for ,
sisu-pg(1) ,
-sisu-po(1) -,
sisu-sqlite(1) ,
sisu-txt(1) diff --git a/data/doc/sisu/html/sisu-odf.1.html b/data/doc/sisu/html/sisu-odf.1.html index f2e32f3f..fddd3148 100644 --- a/data/doc/sisu/html/sisu-odf.1.html +++ b/data/doc/sisu/html/sisu-odf.1.html @@ -3,7 +3,7 @@ -SISU\-ODF(1) manual page +SISU-ODF(1) manual page Table of Contents

@@ -32,8 +32,6 @@ file. ,
sisu-epub(1) ,
-sisu-git(1) -,
sisu-harvest(1) ,
sisu-html(1) @@ -42,8 +40,6 @@ file. ,
sisu-pg(1) ,
-sisu-po(1) -,
sisu-sqlite(1) ,
sisu-txt(1) diff --git a/data/doc/sisu/html/sisu-pdf.1.html b/data/doc/sisu/html/sisu-pdf.1.html index 2394a227..ec9f39d2 100644 --- a/data/doc/sisu/html/sisu-pdf.1.html +++ b/data/doc/sisu/html/sisu-pdf.1.html @@ -3,7 +3,7 @@ -SISU\-PDF(1) manual page +SISU-PDF(1) manual page Table of Contents

@@ -32,8 +32,6 @@ Also ,
sisu-epub(1) ,
-sisu-git(1) -,
sisu-harvest(1) ,
sisu-html(1) @@ -42,8 +40,6 @@ Also ,
sisu-pg(1) ,
-sisu-po(1) -,
sisu-sqlite(1) ,
sisu-txt(1) diff --git a/data/doc/sisu/html/sisu-pg.1.html b/data/doc/sisu/html/sisu-pg.1.html index 98aa2070..056598f2 100644 --- a/data/doc/sisu/html/sisu-pg.1.html +++ b/data/doc/sisu/html/sisu-pg.1.html @@ -3,7 +3,7 @@ -SISU\-PG(1) manual page +SISU-PG(1) manual page Table of Contents

@@ -32,16 +32,12 @@ The sisu-pq command is an alias for sisu ,
sisu-epub(1) ,
-sisu-git(1) -,
sisu-harvest(1) ,
sisu-html(1) ,
sisu-pdf(1) ,
-sisu-po(1) -,
sisu-odf(1) ,
sisu-sqlite(1) diff --git a/data/doc/sisu/html/sisu-po.1.html b/data/doc/sisu/html/sisu-po.1.html index 3c87cce1..ea1c5b43 100644 --- a/data/doc/sisu/html/sisu-po.1.html +++ b/data/doc/sisu/html/sisu-po.1.html @@ -3,7 +3,7 @@ -SISU\-PO(1) manual page +SISU-PO(1) manual page Table of Contents

@@ -33,8 +33,6 @@ Experimental, and under development. ,
sisu-epub(1) ,
-sisu-git(1) -,
sisu-harvest(1) ,
sisu-html(1) diff --git a/data/doc/sisu/html/sisu-sqlite.1.html b/data/doc/sisu/html/sisu-sqlite.1.html index 218dbc81..f40c3a8b 100644 --- a/data/doc/sisu/html/sisu-sqlite.1.html +++ b/data/doc/sisu/html/sisu-sqlite.1.html @@ -3,7 +3,7 @@ -SISU\-SQLITE(1) manual page +SISU-SQLITE(1) manual page Table of Contents

@@ -32,8 +32,6 @@ The sisu-sqlite command is an alias for ,
sisu-epub(1) ,
-sisu-git(1) -,
sisu-harvest(1) ,
sisu-html(1) @@ -44,8 +42,6 @@ The sisu-sqlite command is an alias for ,
sisu-pg(1) ,
-sisu-po(1) -,
sisu-txt(1) .

diff --git a/data/doc/sisu/html/sisu-txt.1.html b/data/doc/sisu/html/sisu-txt.1.html index fb96ed17..dbfc71f4 100644 --- a/data/doc/sisu/html/sisu-txt.1.html +++ b/data/doc/sisu/html/sisu-txt.1.html @@ -3,7 +3,7 @@ -SISU\-TXT(1) manual page +SISU-TXT(1) manual page Table of Contents

@@ -32,8 +32,6 @@ file. ,
sisu-epub(1) ,
-sisu-git(1) -,
sisu-harvest(1) ,
sisu-html(1) @@ -44,8 +42,6 @@ file. ,
sisu-pg(1) ,
-sisu-po(1) -,
sisu-sqlite(1) .

diff --git a/data/doc/sisu/html/sisu.1.html b/data/doc/sisu/html/sisu.1.html index 345e574b..f7268daa 100644 --- a/data/doc/sisu/html/sisu.1.html +++ b/data/doc/sisu/html/sisu.1.html @@ -34,47 +34,44 @@ sisu [-CcFLSVvW]

sisu (--configure|--webrick|--sample-search-form)

Sisu - Manual,

-RALPH AMISSAH
- +RALPH AMISSAH
-
What is Sisu?
-
+
What +is Sisu?

Introduction - What is Sisu?
-
- -

-SiSU is a framework for document structuring, publishing (in multiple open -standard formats) and search, comprising of: (a) a lightweight document -structure and presentation markup syntax; and (b) an accompanying engine -for generating standard document format outputs from documents prepared -in sisu markup syntax, which is able to produce multiple standard outputs -(including the population of sql databases) that (can) share a common numbering -system for the citation of text within a document. -

-SiSU is developed under an open source, software libre license ( GPLv3 -). Its use case for development is work with medium to large document sets -and cope with evolving document formats/ representation technologies. Documents -are prepared once, and generated as need be to update the technical presentation -or add additional output formats. Various output formats (including search -related output) share a common mechanism for cross-output-format citation. -

-SiSU both defines a markup syntax and provides an engine that produces -open standards format outputs from documents prepared with SiSU markup. -From a single lightly prepared document sisu custom builds several standard -output formats which share a common (text object) numbering system for -citation of content within a document (that also has implications for search). -The sisu engine works with an abstraction of the document’s structure and -content from which it is possible to generate different forms of representation -of the document. Significantly SiSU markup is more sparse than html and -outputs which include HTML, EPUB, ODT (Open Document Format text), LaTeX, -landscape and portrait PDF, all of which can be added to and updated. SiSU -is also able to populate SQL type databases at an object level, which means -that searches can be made with that degree of granularity. -

-Source document preparation and output generation is a two step process: +
+
SiSU is a framework for document +structuring, publishing (in multiple open standard formats) and search, +comprising of: (a) a lightweight document structure and presentation markup +syntax; and (b) an accompanying engine for generating standard document +format outputs from documents prepared in sisu markup syntax, which is +able to produce multiple standard outputs (including the population of +sql databases) that (can) share a common numbering system for the citation +of text within a document. +
SiSU is developed under an open source, software +libre license ( GPLv3 ). Its use case for development is work with medium +to large document sets and cope with evolving document formats/ representation +technologies. Documents are prepared once, and generated as need be to update +the technical presentation or add additional output formats. Various output +formats (including search related output) share a common mechanism for +cross-output-format citation. +
SiSU both defines a markup syntax and provides +an engine that produces open standards format outputs from documents prepared +with SiSU markup. From a single lightly prepared document sisu custom builds +several standard output formats which share a common (text object) numbering +system for citation of content within a document (that also has implications +for search). The sisu engine works with an abstraction of the document’s +structure and content from which it is possible to generate different forms +of representation of the document. Significantly SiSU markup is more sparse +than html and outputs which include HTML, EPUB, ODT (Open Document Format +text), LaTeX, landscape and portrait PDF, all of which can be added to +and updated. SiSU is also able to populate SQL type databases at an object +level, which means that searches can be made with that degree of granularity. + +
Source document preparation and output generation is a two step process: (i) document source is prepared, that is, marked up in sisu markup syntax and (ii) the desired output subsequently generated by running the sisu engine against document source. Output representations if updated (in the @@ -90,41 +87,40 @@ Document output formats share a common object numbering system for locating content. This 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. -

-In preparing a SiSU document you optionally provide semantic information -related to the document in a document header, and in marking up the substantive -text provide information on the structure of the document, primarily indicating -heading levels and footnotes. You also provide information on basic text -attributes where used. The rest is automatic, sisu from this information -custom builds[^2] the different forms of output requested. -

-SiSU works with an abstraction of the document based on its structure which -is comprised of its headings[^3] and objects[^4], which enables SiSU to represent -the document in many different ways, and to take advantage of the strengths -of different ways of presenting documents. The objects are numbered, and -these numbers can be used to provide a common basis for citing material -within a document across the different output format types. This is significant -as page numbers are not well suited to the digital age, in web publishing, -changing a browser’s default font or using a different browser can mean -that text will appear on a different page; and publishing in different -formats, html, landscape and portrait pdf etc. again page numbers are not -useful to cite text. Dealing with documents at an object level together -with object numbering also has implications for search that SiSU is able -to take advantage of. -

-One of the challenges of maintaining documents is to keep them in a format -that allows use of them independently of proprietary platforms. Consider -issues related to dealing with legacy proprietary formats today and what -guarantee you have that old proprietary formats will remain (or can be -read without proprietary software/equipment) in 15 years time, or the way -the way in which html has evolved over its relatively short span of existence. -SiSU provides the flexibility of producing documents in multiple non-proprietary -open formats including HTML, EPUB, [^5] ODT, [^6] PDF [^7] ODF, [^8]. Whilst -SiSU relies on software, the markup is uncomplicated and minimalistic which -guarantees that future engines can be written to run against it. It is also -easily converted to other formats, which means documents prepared in SiSU -can be migrated to other document formats. Further security is provided -by the fact that the software itself, SiSU is available under GPLv3 a licence +
In preparing a SiSU +document you optionally provide semantic information related to the document +in a document header, and in marking up the substantive text provide information +on the structure of the document, primarily indicating heading levels and +footnotes. You also provide information on basic text attributes where used. +The rest is automatic, sisu from this information custom builds[^2] the +different forms of output requested. +
SiSU works with an abstraction of +the document based on its structure which is comprised of its headings[^3] +and objects[^4], which enables SiSU to represent the document in many different +ways, and to take advantage of the strengths of different ways of presenting +documents. The objects are numbered, and these numbers can be used to provide +a common basis for citing material within a document across the different +output format types. This is significant as page numbers are not well suited +to the digital age, in web publishing, changing a browser’s default font +or using a different browser can mean that text will appear on a different +page; and publishing in different formats, html, landscape and portrait +pdf etc. again page numbers are not useful to cite text. Dealing with documents +at an object level together with object numbering also has implications +for search that SiSU is able to take advantage of. +
One of the challenges +of maintaining documents is to keep them in a format that allows use of +them independently of proprietary platforms. Consider issues related to +dealing with legacy proprietary formats today and what guarantee you have +that old proprietary formats will remain (or can be read without proprietary +software/equipment) in 15 years time, or the way the way in which html +has evolved over its relatively short span of existence. SiSU provides the +flexibility of producing documents in multiple non-proprietary open formats +including HTML, EPUB, [^5] ODT, [^6] PDF [^7] ODF, [^8]. Whilst SiSU relies +on software, the markup is uncomplicated and minimalistic which guarantees +that future engines can be written to run against it. It is also easily +converted to other formats, which means documents prepared in SiSU can +be migrated to other document formats. Further security is provided by the +fact that the software itself, SiSU is available under GPLv3 a licence that guarantees that the source code will always be open, and free as in libre, which means that that code base can be used, updated and further developed as required under the terms of its license. Another challenge @@ -137,1150 +133,948 @@ related module has been updated repeatedly over the years, presumably when the World Wide Web Consortium (w3c) finalises HTML 5 which is currently under development, the HTML module will again be updated allowing all existing documents to be regenerated as HTML 5). -

-The document formats are written to the file-system and available for indexing -by independent indexing tools, whether off the web like Google and Yahoo -or on the site like Lucene and Hyperestraier. -

-SiSU also provides other features such as concordance files and document -content certificates, and the working against an abstraction of document -structure has further possibilities for the research and development of -other document representations, the availability of objects is useful for -example for topic maps and thesauri, together with the flexibility of SiSU -offers great possibilities. -

-SiSU is primarily for published works, which can take advantage of the -citation system to reliably reference its documents. SiSU works well in -a complementary manner with such collaborative technologies as Wikis, which -can take advantage of and be used to discuss the substance of content prepared -in SiSU. -

-<http://www.sisudoc.org/ +
The document formats are written +to the file-system and available for indexing by independent indexing tools, +whether off the web like Google and Yahoo or on the site like Lucene and +Hyperestraier. +
SiSU also provides other features such as concordance files +and document content certificates, and the working against an abstraction +of document structure has further possibilities for the research and development +of other document representations, the availability of objects is useful +for example for topic maps and thesauri, together with the flexibility +of SiSU offers great possibilities. +
SiSU is primarily for published works, +which can take advantage of the citation system to reliably reference its +documents. SiSU works well in a complementary manner with such collaborative +technologies as Wikis, which can take advantage of and be used to discuss +the substance of content prepared in SiSU. +
<http://www.sisudoc.org/ > -

-<http://www.jus.uio.no/sisu +
<http://www.jus.uio.no/sisu > -
+
Commands Summary
-

Description
-

-SiSU is a document publishing system, that from a simple single marked-up -document, produces multiple output formats including: plaintext, HTML, -XHTML, XML, EPUB, ODT ( OpenDocument ( ODF ) text), LaTeX, PDF, info, and -SQL ( PostgreSQL and SQLite ) , which share text object numbers ("object -citation numbering") and the same document structure information. For more -see: <http://sisudoc.org +
SiSU is a document publishing system, that +from a simple single marked-up document, produces multiple output formats +including: plaintext, HTML, XHTML, XML, EPUB, ODT ( OpenDocument ( ODF +) text), LaTeX, PDF, info, and SQL ( PostgreSQL and SQLite ) , which share +text object numbers ("object citation numbering") and the same document +structure information. For more see: <http://sisudoc.org > or <http://www.jus.uio.no/sisu > -
-
Document Processing -Command Flags
+ +
Document Processing Command Flags

-a [filename/wildcard]
-
produces plaintext with Unix linefeeds -and without markup, (object numbers are omitted), has footnotes at end -of each paragraph that contains them [ -A for output file] [see -e for endnotes]. -(Options include: --endnotes for endnotes --footnotes for footnotes at the -end of each paragraph --unix for unix linefeed (default) --msdos for msdos -linefeed) -

- -
-b [filename/wildcard]
-
see --xhtml -

+
produces plaintext +with Unix linefeeds and without markup, (object numbers are omitted), has +footnotes at end of each paragraph that contains them [ -A for equivalent +dos (linefeed) output file] [see -e for endnotes]. (Options include: --endnotes +for endnotes --footnotes for footnotes at the end of each paragraph --unix +for unix linefeed (default) --msdos for msdos linefeed)
+ +
-b [filename/wildcard] +
+
see --xhtml

--by-*
-
see --output-by-* -

+
see --output-by-*

-C
-
configure/initialise -shared output directory files initialize shared output directory (config -files such as css and dtd files are not updated if they already exist unless -modifier is used). -C --init-site configure/initialise site more extensive than --C on its own, shared output directory files/force update, existing shared -output config files such as css and dtd files are updated if this modifier -is used. -

+
configure/initialise shared output directory +files initialize shared output directory (config files such as css and +dtd files are not updated if they already exist unless modifier is used). +-C --init-site configure/initialise site more extensive than -C on its own, +shared output directory files/force update, existing shared output config +files such as css and dtd files are updated if this modifier is used.
-
-CC
-
see --configure -

+
-CC +
+
see --configure

-c [filename/wildcard]
-
see --color-toggle -

+
see --color-toggle
-
--color-toggle -[filename/wildcard]
-
screen toggle ansi screen colour on or off depending -on default set (unless -c flag is used: if sisurc colour default is set -to ’true’, output to screen will be with colour, if sisurc colour default -is set to ’false’ or is undefined screen output will be without colour). Alias +
--color
+
see --color-on
-
- -
c -
+
--color-off +
+
turn off color in output to terminal
-
--configure
-
configure/initialise shared output directory files initialize -shared output directory (config files such as css and dtd files are not -updated if they already exist unless modifier is used). The equivalent of: --C --init-site configure/initialise site, more extensive than -C on its own, -shared output directory files/force update, existing shared output config -files such as css and dtd files are updated if -CC is used. -

+
--color-on
+
turn on color in output to +terminal
-
--concordance -[filename/wildcard]
-
produces concordance (wordmap) a rudimentary index -of all the words in a document. (Concordance files are not generated for -documents of over 260,000 words unless this limit is increased in the file -sisurc.yml). Alias -w -

+
--color-toggle [filename/wildcard]
+
screen toggle ansi screen colour +on or off depending on default set (unless -c flag is used: if sisurc colour +default is set to ’true’, output to screen will be with colour, if sisurc +colour default is set to ’false’ or is undefined screen output will be without +colour). Alias -c
+ +
--configure
+
configure/initialise shared output directory +files initialize shared output directory (config files such as css and +dtd files are not updated if they already exist unless modifier is used). +The equivalent of: -C --init-site configure/initialise site, more extensive +than -C on its own, shared output directory files/force update, existing +shared output config files such as css and dtd files are updated if -CC +is used.
+ +
--concordance [filename/wildcard]
+
produces concordance (wordmap) +a rudimentary index of all the words in a document. (Concordance files are +not generated for documents of over 260,000 words unless this limit is +increased in the file sisurc.yml). Alias -w

-D [instruction] [filename]
-
see --pg -

+
see +--pg
-
-d [--db-[database type - (sqlite|pg)]] --[instruction] [filename]
+
-d [--db-[database type (sqlite|pg)]] --[instruction] [filename]

see --sqlite -

+ -
--dal [filename/wildcard/url] -
-
assumed for most other flags, creates new intermediate files for processing -(document abstraction) that is used in all subsequent processing of other -output. This step is assumed for most processing flags. To skip it see -n. - -
Alias -m -

+
--dal [filename/wildcard/url]
+
assumed for most other flags, creates new intermediate +files for processing (document abstraction) that is used in all subsequent +processing of other output. This step is assumed for most processing flags. +To skip it see -n. Alias -m

--delete [filename/wildcard]
-
see --zap -

+
see --zap
-
--dump[=directory_path] [filename/wildcard] -
-
places output in directory specified, if none is specified in the current -directory (pwd). Compare --redirect -

+
--dump[=directory_path] +[filename/wildcard]
+
places output in directory specified, if none is specified +in the current directory (pwd). Compare --redirect

-e [filename/wildcard]
-
see --epub -

- -
--epub -[filename/wildcard]
-
produces an epub document, [sisu version >=2 ] (filename.epub). +
see +--epub
-
Alias -e -
+
--epub [filename/wildcard]
+
produces an epub document, [sisu version +>=2 ] (filename.epub). Alias -e

--exc-*
-
exclude output feature, overrides configuration settings ---exc- ocn, (exclude object citation numbering, (switches off object citation -numbering ) , affects html (seg, scroll), epub, xhtml, xml, pdf) ; --exc-toc, -(exclude table of contents, affects html (scroll), epub, pdf) ; --exc-links-to-manifest, ---exc-manifest-links, (exclude links to manifest, affects html (seg, scroll)); ---exc-search-form, (exclude search form, affects html (seg, scroll), manifest); ---exc-minitoc, (exclude mini table of contents, affects html (seg), concordance, -manifest); --exc-manifest-minitoc, (exclude mini table of contents, affects -manifest); --exc-html-minitoc, (exclude mini table of contents, affects html -(seg), concordance); --exc-html-navigation, (exclude navigation, affects html -(seg)); --exc-html-navigation-bar, (exclude navigation bar, affects html (seg)); ---exc-html-search-form, (exclude search form, affects html (seg, scroll)); --exc-html-right-pane, -(exclude right pane/column, affects html (seg, scroll)); --exc-html-top-band, -(exclude top band, affects html (seg, scroll), concordance (minitoc forced -on to provide seg navigation)); --exc-segsubtoc (exclude sub table of contents, -affects html (seg), epub) ; see also --inc-* -

+
exclude output feature, overrides configuration +settings --exc-ocn, (exclude object citation numbering, (switches off object +citation numbering ) , affects html (seg, scroll), epub, xhtml, xml, pdf) +; --exc-toc, (exclude table of contents, affects html (scroll), epub, pdf) +; --exc-links-to-manifest, --exc-manifest-links, (exclude links to manifest, affects +html (seg, scroll)); --exc-search-form, (exclude search form, affects html +(seg, scroll), manifest); --exc-minitoc, (exclude mini table of contents, +affects html (seg), concordance, manifest); --exc-manifest-minitoc, (exclude +mini table of contents, affects manifest); --exc-html-minitoc, (exclude mini +table of contents, affects html (seg), concordance); --exc-html-navigation, +(exclude navigation, affects html (seg)); --exc-html-navigation-bar, (exclude +navigation bar, affects html (seg)); --exc-html-search-form, (exclude search +form, affects html (seg, scroll)); --exc-html-right-pane, (exclude right pane/column, +affects html (seg, scroll)); --exc-html-top-band, (exclude top band, affects +html (seg, scroll), concordance (minitoc forced on to provide seg navigation)); +--exc-segsubtoc (exclude sub table of contents, affects html (seg), epub) +; see also --inc-*

-F [--webserv=webrick]
-
see --sample-search-form +
see --sample-search-form
-
- -
-f [optional string part of filename]
-
see --find -

- -
--find [optional string part - of filename]
-
without match string, glob all .sst .ssm files in directory -(including language subdirectories). With match string, find files that -match given string in directory (including language subdirectories). Alias --f, --glob, -G -

+
-f [optional string +part of filename]
+
see --find
-
-G [optional string part of filename]
-
see --find -

+
--find [optional string part of filename]
+
without +match string, glob all .sst .ssm files in directory (including language subdirectories). +With match string, find files that match given string in directory (including +language subdirectories). Alias -f, --glob, -G
-
-g [filename/wildcard] +
-G [optional string part of filename]
-
-
see --git -

+
see --find
-
--git [filename/wildcard]
-
produces or updates markup source file -structure in a git repo (experimental and subject to change). Alias -g -

+
-g [filename/wildcard]
+
see --git
-
--glob -[optional string part of filename]
-
see --find -

+
--git [filename/wildcard]
+
produces +or updates markup source file structure in a git repo (experimental and +subject to change). Alias -g
-
-h [filename/wildcard]
+
--glob [optional string part of filename]

see +--find
-
- -
- -
html -
+
-h [filename/wildcard]
+
see --html

--harvest *.ss[tm]
-
makes two lists of sisu output based on the sisu -markup documents in a directory: list of author and authors works (year -and titles), and; list by topic with titles and author. Makes use of header -metadata fields (author, title, date, topic_register). Can be used with -maintenance (-M) and remote placement (-R) flags. -

+
makes two lists of +sisu output based on the sisu markup documents in a directory: list of +author and authors works (year and titles), and; list by topic with titles +and author. Makes use of header metadata fields (author, title, date, topic_register). +Can be used with maintenance (-M) and remote placement (-R) flags.
-
--help [topic]
-
provides help -on the selected topic, where topics (keywords) include: list, (com)mands, -short(cuts), (mod)ifiers, (env)ironment, markup, syntax, headers, headings, -endnotes, tables, example, customise, skin, (dir)ectories, path, (lang)uage, -db, install, setup, (conf)igure, convert, termsheet, search, sql, features, -license. -

+
--help [topic] +
+
provides help on the selected topic, where topics (keywords) include: list, +(com)mands, short(cuts), (mod)ifiers, (env)ironment, markup, syntax, headers, +headings, endnotes, tables, example, customise, skin, (dir)ectories, path, +(lang)uage, db, install, setup, (conf)igure, convert, termsheet, search, +sql, features, license.

--html [filename/wildcard]
-
produces html output, segmented text -with table of contents (toc.html and index.html) and the document in a single -file (scroll.html). Alias -h -

+
produces html output, segmented +text with table of contents (toc.html and index.html) and the document in +a single file (scroll.html). Alias -h

-I [filename/wildcard]
-
see --texinfo -

+
see --texinfo
-
-i [filename/wildcard] -
-
-
see --manpage -

+
-i +[filename/wildcard]
+
see --manpage

--inc-*
-
include output feature, overrides configuration settings, -(usually the default if none set), has precedence over --exc-* (exclude output -feature). Some detail provided under --exc-*, see --exc-* -

+
include output feature, overrides +configuration settings, (usually the default if none set), has precedence +over --exc-* (exclude output feature). Some detail provided under --exc-*, see +--exc-*
-
-j [filename/wildcard] -
-
copies images associated with a file for use by html, xhtml & xml outputs -(automatically invoked by --dump & redirect). -

+
-j [filename/wildcard]
+
copies images associated with a file for use +by html, xhtml & xml outputs (automatically invoked by --dump & redirect).
-
--keep-processing-files [filename/wildcard/url] +
-k
-
-
see --maintenance -

+
see --color-off
+ +
--keep-processing-files [filename/wildcard/url]
+
see --maintenance +

-L
-
prints license information. -

+
prints license information.
-
-M [filename/wildcard/url] -
-
-
see --maintenance -

+
-M [filename/wildcard/url]
+
see --maintenance +

-m [filename/wildcard/url]
-
see --dal (document abstraction -level/layer) -

+
see --dal (document abstraction level/layer)
-
--machine [filename/wildcard/url]
-
see --dal (document abstraction -level/layer) -

+
--machine +[filename/wildcard/url]
+
see --dal (document abstraction level/layer)
-
--maintenance [filename/wildcard/url]
-
maintenance mode, interim -processing files are preserved and their locations indicated. (also see --V). Aliases -M and --keep-processing-files. -

+
--maintenance +[filename/wildcard/url]
+
maintenance mode, interim processing files are +preserved and their locations indicated. (also see -V). Aliases -M and --keep-processing-files. +

--manpage [filename/wildcard]
-
produces -man page of file, not suitable for all outputs. Alias -i -

- -
-N [filename/wildcard/url] -
-
document digest or document content certificate ( DCC ) as md5 digest tree -of the document: the digest for the document, and digests for each object -contained within the document (together with information on software versions -that produced it) (digest.txt). -NV for verbose digest output to screen. -

- -
-n -[filename/wildcard/url]
-
skip the creation of intermediate processing files -(document abstraction) if they already exist, this skips the equivalent -of -m which is otherwise assumed by most processing flags. -

+
produces man page of file, not suitable for +all outputs. Alias -i
+ +
-N [filename/wildcard/url]
+
document digest or document +content certificate ( DCC ) as md5 digest tree of the document: the digest +for the document, and digests for each object contained within the document +(together with information on software versions that produced it) (digest.txt). +-NV for verbose digest output to screen.
+ +
-n [filename/wildcard/url]
+
skip the +creation of intermediate processing files (document abstraction) if they +already exist, this skips the equivalent of -m which is otherwise assumed +by most processing flags.

--no-*
-
see --exc-* - -

+
see --exc-*

-o [filename/wildcard/url]

see --odt -

+
--odf [filename/wildcard/url]
-
see --odt - -

+
see --odt

--odt [filename/wildcard/url]
-
output basic document in opendocument file -format (opendocument.odt). Alias -o -

+
output +basic document in opendocument file format (opendocument.odt). Alias -o
-
--output-by-*
-
select output directory structure -from 3 alternatives: --output-by-language, (language directory (based on language -code) with filetype (html, epub, pdf etc.) subdirectories); --output-by-filetype, -(filetype directories with language code as part of filename); --output-by-filename, -(filename directories with language code as part of filename). This is configurable. -Alias --by-* -

- -
-P [language_directory/filename language_directory]
-
see --po4a - -

- -
-p [filename/wildcard]
-
see --pdf -

+
--output-by-* +
+
select output directory structure from 3 alternatives: --output-by-language, +(language directory (based on language code) with filetype (html, epub, +pdf etc.) subdirectories); --output-by-filetype, (filetype directories with +language code as part of filename); --output-by-filename, (filename directories +with language code as part of filename). This is configurable. Alias --by-* +
-
--pdf [filename/wildcard]
-
produces LaTeX -pdf (portrait.pdf & landscape.pdf). Default paper size is set in config file, -or document header, or provided with additional command line parameter, -e.g. --papersize-a4 preset sizes include: ’A4’, U.S. ’letter’ and ’legal’ and book sizes -’A5’ and ’B5’ (system defaults to A4). Alias -p -

+
-P [language_directory/filename language_directory]
+
see --po4a
-
--pg [instruction] [filename] +
-p [filename/wildcard]
-
database PostgreSQL ( --pgsql may be used instead) possible instructions, -include: --createdb; --create; --dropall; --import [filename]; --update [filename]; ---remove [filename]; see database section below. Alias -D -

+
see --pdf
-
--po [language_directory/filename - language_directory]
+
--pdf [filename/wildcard]
+
produces LaTeX pdf (portrait.pdf & landscape.pdf). +Default paper size is set in config file, or document header, or provided +with additional command line parameter, e.g. --papersize-a4 preset sizes include: +’A4’, U.S. ’letter’ and ’legal’ and book sizes ’A5’ and ’B5’ (system defaults to A4). +Alias -p
+ +
--pg [instruction] [filename]
+
database PostgreSQL ( --pgsql may be +used instead) possible instructions, include: --createdb; --create; --dropall; +--import [filename]; --update [filename]; --remove [filename]; see database section +below. Alias -D
+ +
--po [language_directory/filename language_directory]

see --po4a -

- -
--po4a [language_directory/filename language_directory] -
-
produces .pot and po files for the file in the languages specified by the -language directory. SiSU markup is placed in subdirectories named with the -language code, e.g. en/ fr/ es/. The sisu config file must set the output -directory structure to multilingual. v3, experimental -

+ -
-Q [filename/wildcard] -
-
-
see --qrcode -

+
--po4a [language_directory/filename language_directory]
+
produces .pot and +po files for the file in the languages specified by the language directory. +SiSU markup is placed in subdirectories named with the language code, e.g. +en/ fr/ es/. The sisu config file must set the output directory structure +to multilingual. v3, experimental
-
-q [filename/wildcard]
-
see --quiet -

+
-Q [filename/wildcard]
+
see --qrcode
-
--qrcode [filename/wildcard] +
-q [filename/wildcard]
-
generate QR code image of metadata (used in manifest). v3 only. -

+
see --quiet
-
--quiet [filename/wildcard] -
-
quiet less output to screen. -

+
--qrcode [filename/wildcard]
+
generate QR code image of metadata +(used in manifest). v3 only.
+ +
--quiet [filename/wildcard]
+
quiet less output +to screen.

-R [filename/wildcard]
-
see --rsync -

+
see --rsync
-
-r [filename/wildcard] -
-
-
see --scp -

+
-r [filename/wildcard]
+
see --scp +

--redirect[=directory_path] [filename/wildcard]
-
places output in -subdirectory under specified directory, subdirectory uses the filename -(without the suffix). If no output directory is specified places the subdirectory -under the current directory (pwd). Compare --dump -

- -
--rsync [filename/wildcard] -
-
copies sisu output files to remote host using rsync. This requires that -sisurc.yml has been provided with information on hostname and username, -and that you have your "keys" and ssh agent in place. Note the behavior -of rsync different if -R is used with other flags from if used alone. Alone -the rsync --delete parameter is sent, useful for cleaning the remote directory -(when -R is used together with other flags, it is not). Also see --scp. Alias - -
- -
R -

+
places output in subdirectory +under specified directory, subdirectory uses the filename (without the +suffix). If no output directory is specified places the subdirectory under +the current directory (pwd). Compare --dump
+ +
--rsync [filename/wildcard]
+
copies +sisu output files to remote host using rsync. This requires that sisurc.yml +has been provided with information on hostname and username, and that you +have your "keys" and ssh agent in place. Note the behavior of rsync different +if -R is used with other flags from if used alone. Alone the rsync --delete +parameter is sent, useful for cleaning the remote directory (when -R is +used together with other flags, it is not). Also see --scp. Alias -R

-S

see --sisupod -

+
-S [filename/wildcard]
-
see --sisupod -

- -
-s [filename/wildcard] -
-
-
see --source -

- -
--sample-search-form [--webserv=webrick]
-
generate examples of (naive) -cgi search form for SQLite and PgSQL depends on your already having used -sisu to populate an SQLite and/or PgSQL database, (the SQLite version scans -the output directories for existing sisu_sqlite databases, so it is first -necessary to create them, before generating the search form) see -d -D and -the database section below. If the optional parameter --webserv=webrick is -passed, the cgi examples created will be set up to use the default port -set for use by the webrick server, (otherwise the port is left blank and -the system setting used, usually 80). The samples are dumped in the present -work directory which must be writable, (with screen instructions given -that they be copied to the cgi-bin directory). Alias -F -

- -
--scp [filename/wildcard] +
see --sisupod
+ +
-s [filename/wildcard]
+
see --source
+ +
--sample-search-form +[--webserv=webrick]
+
generate examples of (naive) cgi search form for SQLite +and PgSQL depends on your already having used sisu to populate an SQLite +and/or PgSQL database, (the SQLite version scans the output directories +for existing sisu_sqlite databases, so it is first necessary to create +them, before generating the search form) see -d -D and the database section +below. If the optional parameter --webserv=webrick is passed, the cgi examples +created will be set up to use the default port set for use by the webrick +server, (otherwise the port is left blank and the system setting used, +usually 80). The samples are dumped in the present work directory which +must be writable, (with screen instructions given that they be copied to +the cgi-bin directory). Alias -F
+ +
--scp [filename/wildcard]
+
copies sisu output +files to remote host using scp. This requires that sisurc.yml has been provided +with information on hostname and username, and that you have your "keys" +and ssh agent in place. Also see --rsync. Alias -r
+ +
--sqlite --[instruction] [filename]
-
copies sisu output files to remote host using scp. This requires that sisurc.yml -has been provided with information on hostname and username, and that you -have your "keys" and ssh agent in place. Also see --rsync. Alias -r -

- -
--sqlite ---[instruction] [filename]
-
database type set to SQLite, this produces one -of two possible databases, without additional database related instructions -it produces a discreet SQLite file for the document processed; with additional -instructions it produces a common SQLite database of all processed documents -that (come from the same document preparation directory and as a result) -share the same output directory base path (possible instructions include: ---createdb; --create; --dropall; --import [filename]; --update [filename]; --remove -[filename]); see database section below. Alias -d -

+
database type set to SQLite, this produces one of two possible databases, +without additional database related instructions it produces a discreet +SQLite file for the document processed; with additional instructions it +produces a common SQLite database of all processed documents that (come +from the same document preparation directory and as a result) share the +same output directory base path (possible instructions include: --createdb; +--create; --dropall; --import [filename]; --update [filename]; --remove [filename]); +see database section below. Alias -d

--sisupod
-
produces a sisupod -a zipped sisu directory of markup files including sisu markup source files -and the directories local configuration file, images and skins. Note: this -only includes the configuration files or skins contained in ./_sisu not -those in ~/.sisu -S [filename/wildcard] option. Note: (this
- option is tested only with zsh). Alias -S -

+
produces a sisupod a zipped +sisu directory of markup files including sisu markup source files and the +directories local configuration file, images and skins. Note: this only +includes the configuration files or skins contained in is tested only +with zsh). Alias -S

--sisupod [filename/wildcard]
-
produces -a zipped file of the prepared document specified along with associated -images, by default named sisupod.zip they may alternatively be named with -the filename extension .ssp This provides a quick way of gathering the relevant -parts of a sisu document which can then for example be emailed. A sisupod -includes sisu markup source file, (along with associated documents if a -master file, or available in multilingual versions), together with related -images and skin. SiSU commands can be run directly against a sisupod contained -in a local directory, or provided as a url on a remote site. As there is -a security issue with skins provided by other users, they are not applied -unless the flag --trust or --trusted is added to the command instruction, it -is recommended that file that are not your own are treated as untrusted. -The directory structure of the unzipped file is understood by sisu, and -sisu commands can be run within it. Note: if you wish to send multiple files, -it quickly becomes more space efficient to zip the sisu markup directory, -rather than the individual files for sending). See the -S option without -[filename/wildcard]. Alias -S -

+
produces a zipped file of +the prepared document specified along with associated images, by default +named sisupod.zip they may alternatively be named with the filename extension +.ssp This provides a quick way of gathering the relevant parts of a sisu +document which can then for example be emailed. A sisupod includes sisu +markup source file, (along with associated documents if a master file, +or available in multilingual versions), together with related images and +skin. SiSU commands can be run directly against a sisupod contained in a +local directory, or provided as a url on a remote site. As there is a security +issue with skins provided by other users, they are not applied unless the +flag --trust or --trusted is added to the command instruction, it is recommended +that file that are not your own are treated as untrusted. The directory +structure of the unzipped file is understood by sisu, and sisu commands +can be run within it. Note: if you wish to send multiple files, it quickly +becomes more space efficient to zip the sisu markup directory, rather than +the individual files for sending). See the -S option without [filename/wildcard]. +Alias -S

--source [filename/wildcard]
-
copies sisu markup -file to output directory. Alias -s -

- -
-T [filename/wildcard (*.termsheet.rb)] -
-
standard form document builder, preprocessing feature -

- -
-t [filename/wildcard] -
-
-
see --txt -

+
copies sisu markup file to output directory. +Alias -s
-
--texinfo [filename/wildcard]
-
produces texinfo and info file, (view -with pinfo). Alias -I -

+
-T [filename/wildcard (*.termsheet.rb)]
+
standard form document builder, +preprocessing feature
-
--txt [filename/wildcard]
-
produces plaintext with Unix -linefeeds and without markup, (object numbers are omitted), has footnotes -at end of each paragraph that contains them [ -A for output file] [see -e - for endnotes]. (Options include: --endnotes for endnotes --footnotes for footnotes -at the end of each paragraph --unix for unix linefeed (default) --msdos for -msdos linefeed). Alias -t -

+
-t [filename/wildcard]
+
see --txt
-
-U [filename/wildcard]
-
see --urls -

+
--texinfo [filename/wildcard] +
+
produces texinfo and info file, (view with pinfo). Alias -I
-
-u [filename/wildcard] +
--txt [filename/wildcard]
-
provides url mapping of output files for the flags requested for processing, +
produces plaintext with Unix linefeeds and without markup, (object numbers +are omitted), has footnotes at end of each paragraph that contains them +[ -A for equivalent dos (linefeed) output file] [see -e for endnotes]. (Options +include: --endnotes for endnotes --footnotes for footnotes at the end of each +paragraph --unix for unix linefeed (default) --msdos for msdos linefeed). Alias +-t
-
also see -U -
+
-U [filename/wildcard]
+
see --urls
-
--urls [filename/wildcard]
-
prints url output list/map for the -available processing flags options and resulting files that could be requested, -(can be used to get a list of processing options in relation to a file, -together with information on the output that would be produced), -u provides -url output mapping for those flags requested for processing. The default -assumes sisu_webrick is running and provides webrick url mappings where -appropriate, but these can be switched to file system paths in sisurc.yml. +
-u [filename/wildcard]
+
provides url mapping +of output files for the flags requested for processing, also see -U
-
Alias -U -
+
--urls +[filename/wildcard]
+
prints url output list/map for the available processing +flags options and resulting files that could be requested, (can be used +to get a list of processing options in relation to a file, together with +information on the output that would be produced), -u provides url output +mapping for those flags requested for processing. The default assumes sisu_webrick +is running and provides webrick url mappings where appropriate, but these +can be switched to file system paths in sisurc.yml. Alias -U

-V
-
on its own, provides SiSU version and environment information -(sisu --help env) -

- -
-V [filename/wildcard]
-
even more verbose than the -v flag. +
on its own, +provides SiSU version and environment information (sisu --help env)
-
+
-V [filename/wildcard] +
+
even more verbose than the -v flag.

-v

on its own, provides SiSU version information -

+ -
-v [filename/wildcard] -
-
-
see --verbose -

+
-v [filename/wildcard]
+
see --verbose

--v3 [filename/wildcard]
-
invokes the sisu v3 document parser/generator. -You may run sisu3 instead. -

+
invokes the sisu +v3 document parser/generator. You may run sisu3 instead.
-
--v4 [filename/wildcard]
-
invokes the sisu v4 document -parser/generator. This is the default and is normally omitted. -

- -
--verbose [filename/wildcard] +
--v4 [filename/wildcard]
-
provides verbose output of what is being generated, where output is placed -(and error messages if any), as with -u flag provides a url mapping of files -created for each of the processing flag requests. Alias -v -

+
invokes the sisu v4 document parser/generator. This is the default and is +normally omitted.
-
-W
-
see --webrick +
--verbose [filename/wildcard]
+
provides verbose output of +what is being generated, where output is placed (and error messages if +any), as with -u flag provides a url mapping of files created for each of +the processing flag requests. Alias -v
-
+
-W
+
see --webrick
-
-w [filename/wildcard]
-
see --concordance -

+
-w [filename/wildcard] +
+
see --concordance

--webrick
-
starts ruby’ s webrick webserver -points at sisu output directories, the default port is set to 8081 and -can be changed in the resource configuration files. [tip: the webrick server - requires link suffixes, so html output should be created using the -h option - rather than also, note -F webrick ]. Alias -W -

+
starts ruby’ s webrick webserver points at sisu +output directories, the default port is set to 8081 and can be changed +in the resource configuration files. [tip: the webrick server requires link +suffixes, so html output should be created using the -h option rather than +-H ; also, note -F webrick ]. Alias -W
-
--wordmap [filename/wildcard] -
-
-
see --concordance -

+
--wordmap [filename/wildcard]
+
see --concordance +

--xhtml [filename/wildcard]
-
produces xhtml/ XML output for -browser viewing (sax parsing). Alias -b -

+
produces xhtml/ XML output for browser viewing +(sax parsing). Alias -b

--xml-dom [filename/wildcard]
-
produces -XML output with deep document structure, in the nature of dom. Alias -X -
-
- -
--xml-sax [filename/wildcard]
-
produces XML output shallow structure (sax parsing). +
produces XML output with +deep document structure, in the nature of dom. Alias -X
-
Alias -x -
+
--xml-sax [filename/wildcard] +
+
produces XML output shallow structure (sax parsing). Alias -x
-
-X [filename/wildcard]
-
see --xml-dom -

+
-X [filename/wildcard] +
+
see --xml-dom

-x [filename/wildcard]
-
see --xml-sax - -

+
see --xml-sax

-Y [filename/wildcard]
-
produces a short sitemap entry for the document, -based on html output and the sisu_manifest. --sitemaps generates/updates the -sitemap index of existing sitemaps. (Experimental, [g,y,m announcement this - week]) -

+
produces +a short sitemap entry for the document, based on html output and the sisu_manifest. +--sitemaps generates/updates the sitemap index of existing sitemaps. (Experimental, +[g,y,m announcement this week])

-y [filename/wildcard]
-
produces an html summary of output generated -(hyperlinked to content) and document specific metadata (sisu_manifest.html). -This step is assumed for most processing flags. -

+
produces an html +summary of output generated (hyperlinked to content) and document specific +metadata (sisu_manifest.html). This step is assumed for most processing flags. +

-Z [filename/wildcard]
-
see - -
- -
- -
zap -

+
see --zap

--zap [filename/wildcard]
-
Zap, if used with other processing flags deletes -output files of the type about to be processed, prior to processing. If --Z is used as the lone processing related flag (or in conjunction with a -combination of -[mMvVq]), will remove the related document output directory. - -
Alias -Z -

+
Zap, if used with +other processing flags deletes output files of the type about to be processed, +prior to processing. If -Z is used as the lone processing related flag (or +in conjunction with a combination of -[mMvVq]), will remove the related +document output directory. Alias -Z

Command Line Modifiers
-

-
--no-
-
ocn [with --html --pdf or --epub] switches off object citation numbering. -Produce output without identifying numbers in margins of html or LaTeX -/pdf output. -

- -
--no-annotate
-
strips output text of editor endnotes[^*1] denoted +
--no-ocn
+
[with --html +--pdf or --epub] switches off object citation numbering. Produce output without +identifying numbers in margins of html or LaTeX /pdf output.
-
by asterisk or dagger/plus sign -
+
--no-annotate +
+
strips output text of editor endnotes[^*1] denoted by asterisk or dagger/plus +sign

--no-asterisk
-
strips output text of editor -endnotes[^*2] denoted by asterisk sign -

+
strips output text of editor endnotes[^*2] denoted by asterisk +sign

--no-dagger
-
strips output text of editor -endnotes[^+1] denoted by dagger/plus sign -

+
strips output text of editor endnotes[^+1] denoted by dagger/plus +sign

Database Commands
-
-

-dbi - database interface -

--D or --pgsql set for PostgreSQL -d or --sqlite default set for SQLite -d is modifiable -with --db=[database type (PgSQL or .I SQLite ) ] -
+
dbi - database interface +
-D or --pgsql set for PostgreSQL +-d or --sqlite default set for SQLite -d is modifiable with --db=[database type +(PgSQL or SQLite ) ]

--pg -v --createall
-
initial step, -creates required relations (tables, indexes) in existing PostgreSQL database -(a database should be created manually and given the same name as working -directory, as requested) (rb.dbi) [ -dv --createall .I SQLite equivalent] it -may be necessary to run sisu -Dv --createdb initially NOTE: at the present -time for PostgreSQL it may be necessary to manually create the database. -The command would be working directory name (without path)]. Please use -only alphanumerics and underscores. -

- -
--pg -v --import
-
[filename/wildcard] imports -data specified to PostgreSQL db (rb.dbi) [ -dv --import .I SQLite equivalent] - -

+
initial step, creates required relations +(tables, indexes) in existing PostgreSQL database (a database should be +created manually and given the same name as working directory, as requested) +(rb.dbi) [ -dv --createall SQLite equivalent] it may be necessary to run sisu +-Dv --createdb initially NOTE: at the present time for PostgreSQL it may be +necessary to manually create the database. The command would be directory +name (without path)]. Please use only alphanumerics and underscores.
+ +
--pg -v +--import
+
[filename/wildcard] imports data specified to PostgreSQL db (rb.dbi) +[ -dv --import SQLite equivalent]

--pg -v --update
-
[filename/wildcard] updates/imports specified data to PostgreSQL -db (rb.dbi) [ -dv --update .I SQLite equivalent] -

+
[filename/wildcard] updates/imports +specified data to PostgreSQL db (rb.dbi) [ -dv --update SQLite equivalent] +

--pg --remove
-
[filename/wildcard] -removes specified data to PostgreSQL db (rb.dbi) [ -d --remove .I SQLite equivalent] - -

+
[filename/wildcard] removes specified data to PostgreSQL db (rb.dbi) +[ -d --remove SQLite equivalent]

--pg --dropall
-
kills data" and drops ( PostgreSQL or SQLite ) db, tables & -indexes [ -d --dropall .I SQLite equivalent] -

-The -v is for verbose output. -

+
kills data" and drops ( PostgreSQL +or SQLite ) db, tables & indexes [ -d --dropall SQLite equivalent] +
The -v +is for verbose output.

Shortcuts, Shorthand for Multiple Flags
-

-
--update [filename/wildcard]
-
Checks existing file output and runs the flags -required to update this output. This means that if only html and pdf output -was requested on previous runs, only the -hp files will be applied, and -only these will be generated this time, together with the summary. This -can be very convenient, if you offer different outputs of different files, -and just want to do the same again. -

- -
-0 to -5 [filename or wildcard]
-
Default -shorthand mappings (for v3, note that the defaults can be changed/configured -in the sisurc.yml file): -

+
--update [filename/wildcard] +
+
Checks existing file output and runs the flags required to update this +output. This means that if only html and pdf output was requested on previous +runs, only the -hp files will be applied, and only these will be generated +this time, together with the summary. This can be very convenient, if you +offer different outputs of different files, and just want to do the same +again.
+ +
-0 to -5 [filename or wildcard]
+
Default shorthand mappings (for v3, +note that the defaults can be changed/configured in the sisurc.yml file): +

-0
-
-NQhewpotbxXyYv [this is the default action run - when no options are give, i.e. on ’sisu [filename]’] -

+
-NQhewpotbxXyYv [this is the default action run when no options are give, +i.e. on ’sisu [filename]’]

-1
-
-Qhewpoty -

+
-Qhewpoty

-2
-
-NQhewpotbxXy - -

+
-NQhewpotbxXy

-3
-
-NQhewpotbxXyY -

+
-NQhewpotbxXyY

-4
-
-NQhewpotbxXDyY --update -

+
-NQhewpotbxXDyY +--update

-5

-NQhewpotbxXDyYv --update -

-add -v for verbose mode and -c to toggle color state, e.g. sisu -2vc [filename - or wildcard] -

+
add -v for verbose mode and -c to toggle +color state, e.g. sisu -2vc [filename or wildcard] +
consider -u for appended -
consider -u for appended url info or -v for verbose output +
url info or -v for verbose output

-
Command Line -with Flags - Batch Processing
+
Command Line with Flags - Batch Processing
-

-In the data directory run sisu -mh filename or wildcard eg. "sisu -h cisg.sst" -or "sisu -h *.{sst,ssm}" to produce html version of all documents. -

-Running sisu (alone without any flags, filenames or wildcards) brings up -the interactive help, as does any sisu command that is not recognised. Enter -to escape.
+ In the data directory run sisu -mh filename or wildcard eg. "sisu -h cisg.sst" +or "sisu -h *.{sst,ssm}" to produce html version of all documents. +
Running +sisu (alone without any flags, filenames or wildcards) brings up the interactive +help, as does any sisu command that is not recognised. Enter to escape.
Help
-

+
Sisu Manual
-

-The most up to date information on sisu should be contained in the sisu_manual, -available at: -

- <http://sisudoc.org/sisu/sisu_manual/ ->
+
The most up to date information on sisu should be contained +in the sisu_manual, available at: +
<http://sisudoc.org/sisu/sisu_manual/ +> -

-The manual can be generated from source, found respectively, either within +
The manual can be generated from source, found respectively, either within the SiSU tarball or installed locally at: -

- ./data/doc/sisu/markup-samples/sisu_manual
- -

- /usr/share/doc/sisu/markup-samples/sisu_manual
- -

-move to the respective directory and type e.g.: -

- sisu sisu_manual.ssm
-
-
Sisu Man Pages
+
/usr/share/doc/sisu/markup-samples/sisu_manual -

-If SiSU is installed on your system usual man commands should be available, -try: -

- man sisu
+
move to the respective directory and type e.g.: +
sisu sisu_manual.ssm +
Sisu +Man Pages
-

-Most SiSU man pages are generated directly from sisu documents that are -used to prepare the sisu manual, the sources files for which are located -within the SiSU tarball at: -

- ./data/doc/sisu/markup-samples/sisu_manual
+
If SiSU is installed on your system usual man commands should +be available, try: +
man sisu +
Most SiSU man pages are generated directly +from sisu documents that are used to prepare the sisu manual, the sources +files for which are located within the SiSU tarball at: +
./data/doc/sisu/markup-samples/sisu_manual
-

-Once installed, directory equivalent to: -

- /usr/share/doc/sisu/markup-samples/sisu_manual
+
Once installed, directory equivalent to: +
/usr/share/doc/sisu/markup-samples/sisu_manual
-

-Available man pages are converted back to html using man2html: -

- /usr/share/doc/sisu/html/
+
Available man pages are converted back to html using man2html: +
/usr/share/doc/sisu/html/
-

- ./data/doc/sisu/html
+
./data/doc/sisu/html
-

-An online version of the sisu man page is available here: -

-* various sisu man pages <http://www.jus.uio.no/sisu/man/ +
An online version of the sisu man page is available here: +
* various +sisu man pages <http://www.jus.uio.no/sisu/man/ > [^9] -

-* sisu.1 <http://www.jus.uio.no/sisu/man/sisu.1.html -> [^10] -
-
Sisu Built-in Interactive -Help
- -

-This is particularly useful for getting the current sisu setup/environment -information: -

- sisu --help
- -

- sisu --help [subject]
- -

- sisu --help commands
- -

- sisu --help markup
- -

- sisu --help env [for feedback on the way your system is
- setup with regard to sisu ]
- -

- sisu -V [environment information, same as above command]
- -

- sisu (on its own provides version and some help information)
- -

-Apart from real-time information on your current configuration the SiSU -manual and man pages are likely to contain more up-to-date information than -the sisu interactive help (for example on commands and markup). -

-NOTE: Running the command sisu (alone without any flags, filenames or wildcards) -brings up the interactive help, as does any sisu command that is not recognised. -Enter to escape. -
-
Introduction to Sisu Markup[^11]
-
+
* sisu.1 <http://www.jus.uio.no/sisu/man/sisu.1.html +> +[^10] +
+
Sisu Built-in Interactive Help
+ +
This is particularly useful for getting +the current sisu setup/environment information: +
sisu --help +
sisu --help +[subject] +
sisu --help commands +
sisu --help markup +
sisu --help env [for +feedback on the way your system is setup with regard to sisu ]
+ +
sisu -V [environment information, same as above command] +
sisu (on its +own provides version and some help information) +
Apart from real-time information +on your current configuration the SiSU manual and man pages are likely +to contain more up-to-date information than the sisu interactive help (for +example on commands and markup). +
NOTE: Running the command sisu (alone +without any flags, filenames or wildcards) brings up the interactive help, +as does any sisu command that is not recognised. Enter to escape. +
Introduction +to Sisu Markup[^11]

Summary
-

-SiSU source documents are plaintext ( UTF-8 )[^12] files -

-All paragraphs are separated by an empty line. -

-Markup is comprised of: -

-* at the top of a document, the document header made up of semantic meta-data -about the document and if desired additional processing instructions (such -an instruction to automatically number headings from a particular level -down) -

-* followed by the prepared substantive text of which the most important -single characteristic is the markup of different heading levels, which -define the primary outline of the document structure. Markup of substantive -text includes: -

- * heading levels defines document structure
- -

- * text basic attributes, italics, bold etc.
- -

- * grouped text (objects), which are to be treated differently, such as -code
+
SiSU source documents are plaintext ( UTF-8 +)[^12] files +
All paragraphs are separated by an empty line. +
Markup is +comprised of: +
* at the top of a document, the document header made up +of semantic meta-data about the document and if desired additional processing +instructions (such an instruction to automatically number headings from +a particular level down) +
* followed by the prepared substantive text +of which the most important single characteristic is the markup of different +heading levels, which define the primary outline of the document structure. +Markup of substantive text includes: +
* 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.
- -

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

-To check the markup in a file: -

- sisu --identify [filename].sst
+
* footnotes/endnotes
-

- -
For brief descriptive summary of markup history -

- sisu --query-history
- -

-or if for a particular version: -

- sisu --query-0.38
+
* linked text and images +
* paragraph actions, such as indent, bulleted, +numbered-lists, etc. +
Some interactive help on markup is available, by typing +
sisu and selecting markup or sisu --help markup +
To check the markup in +a file: +
sisu --identify [filename].sst +
For brief descriptive summary of + +
markup history +
sisu --query-history +
or if for a particular version:
+sisu --query-0.38
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/ +
Online markup examples are available +together with the respective outputs produced from <http://www.jus.uio.no/sisu/SiSU/examples.html > - -

-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/ +or from <http://www.jus.uio.no/sisu/sisu_examples/ > - -

-an alternative presentation of markup syntax: /usr/share/doc/sisu/on_markup.txt.gz - +
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

Installed
-

-With SiSU installed sample skins may be found in: /usr/share/doc/sisu/markup-samples +
+ 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

Markup of 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: +
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:

% this would be a comment

Sample Header
+
This current document is loaded by a master document that +has a header similar to this one:

-This current document is loaded by a master document that has a header -similar to this one: -

-
% SiSU master 2.0 +
% SiSU master 4.0 @title: SiSU -:subtitle: Manual + :subtitle: Manual @creator: -:author: Amissah, Ralph -@publisher: [publisher name] + :author: Amissah, Ralph +@publisher: [publisher name] @rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 @classify: -:type: information -:topic_register: SiSU:manual;electronic documents:SiSU:manual -:subject: ebook, epublishing, electronic book, electronic publishing, + :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 + :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 + :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] . sisu --v4 [operations] . sisu --v3 [operations] @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/?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 + { 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/?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

Available Headers
-

-Header tags appear at the beginning of a document and provide meta information -on the document (such as the Dublin Core ) , or information as to how the -document as a whole is to be processed. All header instructions take the -form @headername: or on the next line and indented by once space :subheadername: +
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 +
+ @indentifier: information or instructions +
where the "identifier" is +a tag recognised by the program, and the "information" or "instructions" -
All Dublin Core meta tags are available -

-@indentifier: information or instructions -

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

-Note: a header where used should only be used once; all headers apart from -@title: are optional; the @structure: header is used to describe document -structure, and can be useful to know. -

+
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 +
This is a sample header

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

-
@title: [title text] [this header is the only one that is mandatory] - :subtitle: [subtitle if any] +
@title: [title text] [this header is the only one that is mandatory] + :subtitle: [subtitle if any] :language: English

@creator: -:author: [Lastname, First names] -:illustrator: [Lastname, First names] -:translator: [Lastname, First names] -:prepared_by: [Lastname, First names] + :author: [Lastname, First names] + :illustrator: [Lastname, First names] + :translator: [Lastname, First names] + :prepared_by: [Lastname, First names]

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

@rights: -:copyright: Copyright (C) [Year and Holder] -:license: [Use License granted] -:text: [Year and Holder] -:translation: [Name, Year] -:illustrations: [Name, Year] + :copyright: Copyright (C) [Year and Holder] + :license: [Use License granted] + :text: [Year and Holder] + :translation: [Name, Year] + :illustrations: [Name, Year]

@classify: -:topic_register: SiSU:markup sample:book;book:novel:fantasy -:type: -:subject: -:description: -:keywords: -:abstract: -:loc: [Library of Congress classification] -:dewey: Dewey classification + :topic_register: SiSU:markup sample:book;book:novel:fantasy + :type: + :subject: + :description: + :keywords: + :abstract: + :loc: [Library of Congress classification] + :dewey: [Dewey classification

@identify: -:isbn: [ISBN] -:oclc: + :isbn: [ISBN] + :oclc:

@links: { SiSU }http://www.sisudoc.org @@ -1288,62 +1082,58 @@ structure, and can be useful to know.

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

@original: -:language: [language] + :language: [language]

@notes: -:comment: -:prefix: [prefix is placed just after table of contents] + :comment: + :prefix: [prefix is placed just after table of contents]

Markup of Substantive Text
-

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 - +
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 @@ -1353,15 +1143,14 @@ html segments are made)

Font Attributes
-

-markup example: +
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] +*{emphasis}* [note: can be configured to be represented by bold, italics +or underscore] !{bold text}! /{italics}/ _{underscore}_ @@ -1372,86 +1161,58 @@ _{underscore}_ -{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 italics - or underscore] or underscore] -

- -
bold text -

+
resulting output: +
normal text, emphasis, bold text , italics, underscore, +"citation", ^superscript^, [subscript], ++inserted text++, --strikethrough--, -
italics -

+
monospace +
normal text +
emphasis [note: can be configured to be represented +by bold, italics or underscore] +
bold text +
italics +
underscore +
"citation" -
underscore -

-"citation" -

-^superscript^ -

-[subscript] -

-++inserted text++ -

---strikethrough-- -

+
^superscript^ +
[subscript] +
++inserted text++ +
--strikethrough-- +
monospace -
monospace

Indentation and Bullets
-

-markup example: +
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
+
resulting output: +
ordinary paragraph +
indent paragraph one step
-

- indent paragraph two steps
+
indent paragraph two steps
-

- indent paragraph nine steps
+
indent paragraph nine steps
-

-markup example: +
markup example:

_* bullet text _1* bullet text, first indent _2* bullet text, two step indent
-

-resulting output: -

-* bullet text -

- * bullet text, first indent
+
resulting output: +
* bullet text +
* bullet text, first indent
-

- * bullet text, two step indent
+
* bullet text, two step indent
-

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

-markup example: +
markup example:

# numbered list numbered list 1., 2., 3, etc. _# numbered list numbered list indented a., b., c., d., etc. @@ -1459,8 +1220,7 @@ _# numbered list numbered list indented a., b., c., d., etc.

Hanging Indents
-

-markup example: +
markup example:

_0_1 first line no indent, rest of paragraph indented one step @@ -1468,125 +1228,127 @@ _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
- -

+
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.
+ .I 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.
-
in each case level may be 0-9 -

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 +
Footnotes and endnotes are marked up at the location +where they would be indicated within a text. They are automatically numbered. -
determines whether footnotes or endnotes will be produced -

-markup example: +
The output type determines whether footnotes or endnotes will be produced + +
markup example:

~{ a footnote or endnote }~
-

-resulting output: -

-[^13] -

-markup example: +
resulting output: +
[^13] +
markup example:

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

-resulting output: -

-normal text[^14] continues -

-markup example: +
resulting output: +
normal text[^14] continues +
markup example:

normal text ~{* unnumbered asterisk footnote/endnote, insert multiple asterisks if required }~ continues normal text ~{** another unnumbered asterisk footnote/endnote }~ continues
+
resulting output: +
normal text [^*] continues +
normal text [^**] continues + +
markup example:

-resulting output: -

-normal text [^*] continues -

-normal text [^**] continues -

-markup example: -

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

-resulting output: -

-normal text [^*3] continues -

-normal text [^+2] continues -

-Alternative endnote pair notation for footnotes/endnotes: +
resulting output: +
normal text [^*3] continues +
normal text [^+2] continues + +
Alternative endnote pair notation for footnotes/endnotes:

% note the endnote marker "~^" normal text~^ continues ^~ endnote text following the paragraph in which the marker occurs
-

- -
the standard and pair notation cannot be mixed in the same document +
the standard and pair notation cannot be mixed in the same document
+
Links

-
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: +
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 http://www.sisudoc.org/ continues
-

-resulting output: -

-normal text <http://www.sisudoc.org/ +
resulting output: +
normal text <http://www.sisudoc.org/ > continues -

+
An -
An escaped url without decoration -

-markup example: +
escaped url without decoration +
markup example:

normal text _http://www.sisudoc.org/ continues deb _http://www.jus.uio.no/sisu/archive unstable main non-free
-

-resulting output: -

-normal text <_http://www.sisudoc.org/ +
resulting output: +
normal text <_http://www.sisudoc.org/ > continues -

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

-where a code block is used there is neither decoration nor hyperlinking, +
where a code block +is used there is neither decoration nor hyperlinking, code blocks are discussed -
code blocks are discussed later in this document -

-resulting output: +
later in this document +
resulting output:

deb http://www.jus.uio.no/sisu/archive unstable main non-free deb-src http://www.jus.uio.no/sisu/archive unstable main non-free @@ -1594,63 +1356,50 @@ deb-src http://www.jus.uio.no/sisu/archive unstable main non-free

Linking Text
-

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

-markup example: +
markup example:

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

-resulting output: -

-aboutSiSU <http://www.sisudoc.org/ +
resulting output: +
aboutSiSU <http://www.sisudoc.org/ > markup -

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

-markup example: +
markup example:

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

-resulting output: -

-aboutSiSU <http://www.sisudoc.org/ +
resulting output: +
aboutSiSU <http://www.sisudoc.org/ > [^15] markup -

-Internal document links to a tagged location, including an ocn -

-markup example: +
Internal +document links to a tagged location, including an ocn +
markup example: +

about { text links }#link_text
-

-resulting output: -

-about ⌠text links⌡⌈link_text⌋ -

+
resulting output: +
about ⌠text links⌡⌈link_text⌋ +
Shared document -
Shared document collection link -

-markup example: +
collection link +
markup example:

about { SiSU book markup examples }:SiSU/examples.html
-

-resulting output: -

-about ⌠ SiSU book markup examples⌡⌈:SiSU/examples.html⌋ +
resulting output: +
about ⌠ SiSU book markup examples⌡⌈:SiSU/examples.html⌋ +
-
Linking -Images
+
Linking Images
-

-markup example: +
markup example:

{ tux.png 64x80 }image % various url linked images @@ -1659,48 +1408,41 @@ Images and Ruby" }http://www.sisudoc.org/ {~^ ruby_logo.png "Ruby" }http://www.ruby-lang.org/en/
-

-resulting output: -

-[ tux.png ] -

-tux.png 64x80 "Gnu/Linux - a better way" <http://www.sisudoc.org/ +
resulting output: +
[ tux.png ] +
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/ +
GnuDebianLinuxRubyBetterWay.png 100x101 "Way Better +- with Gnu/Linux, Debian and Ruby" <http://www.sisudoc.org/ > -

-ruby_logo.png 70x90 "Ruby" <http://www.ruby-lang.org/en/ +
ruby_logo.png +70x90 "Ruby" <http://www.ruby-lang.org/en/ > [^16] -

+
linked url footnote shortcut -
linked url footnote shortcut

-
{~^ [text to link] }http://url.org -% maps to: { [text to link] }http://url.org ~{ http://url.org }~ +
{~^ [text to link] }http://url.org +% maps to: { [text to link] }http://url.org ~{ http://url.org }~ % which produces hyper-linked text within a document/paragraph, with an endnote providing the url for the text location used in the hyperlink

text marker *~name
-

-note at a heading level the same is automatically achieved by providing +
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. -
-
Link Shortcut for -Multiple Versions of a Sisu Document in the Same Directory
+
Link Shortcut for Multiple +Versions of a Sisu Document in the Same Directory
TREE -

-markup example: +
markup example: +

!_ /{"Viral Spiral"}/, David Bollier { "Viral Spiral", David Bollier [3sS]}viral_spiral.david_bollier.sst
-

- Viral Spiral, David Bollier +
Viral Spiral, David Bollier
"Viral Spiral", David Bollier <http://corundum/sisu_manual/en/manifest/viral_spiral.david_bollier.html > document manifest <http://corundum/sisu_manual/en/manifest/viral_spiral.david_bollier.html @@ -1738,11 +1480,9 @@ TREE

Tables
-

+
Tables may be prepared in two either of two forms -
Tables may be prepared in two either of two forms -

-markup example: +
markup example:

table{ c3; 40; 30; 30; This is a table @@ -1753,19 +1493,16 @@ 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』 -

+
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』 +
a second form may -
a second form may be easier to work with in cases where there is not much +
be easier to work with in cases where there is not much information in -
information in each column -

-markup example: [^18] -

+
each column +
markup example: [^17]

!_ 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 @@ -1782,31 +1519,26 @@ No. of articles, all languages | 25| 19,000| 138,000| 490,000| 862,0 * 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 +
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. +
* Contributed +at least ten times; ** at least 5 times in last month; *** more than 100 +times in last month.

Poem
-

-basic markup: +
basic markup:

poem{ Your poem here }poem Each verse in a poem is given an object number.
-

-markup example: +
markup example:

poem{ ‘Fury said to a @@ -1855,8 +1587,7 @@ Each verse in a poem is given an object number. death."’ }poem
-

-resulting output: +
resulting output:
‘Fury said to a
mouse, That he
met in the
@@ -1905,16 +1636,14 @@ Each verse in a poem is given an object number.

Group
-

-basic markup: +
basic markup:

group{ Your grouped text here }group A group is treated as an object and given a single object number.
-

-markup example: +
markup example:

group{ ‘Fury said to a @@ -1963,8 +1692,7 @@ A group is treated as an object and given a single object number. death."’ }group
-

-resulting output: +
resulting output:
‘Fury said to a
mouse, That he
met in the
@@ -2013,18 +1741,16 @@ A group is treated as an object and given a single object number.

Code
-

-Code tags code{ ... }code (used as with other group tags described above) -are used to escape regular sisu markup, and have been used extensively +
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: +
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 @@ -2071,8 +1797,7 @@ option to number each line of code may to death."’
-

-From SiSU 2.7.7 on you can number codeblocks by placing a hash after the +
From SiSU 2.7.7 on you can number codeblocks by placing a hash after the opening code tag code{# as demonstrated here:

1 | ‘Fury said to a @@ -2127,8 +1852,7 @@ opening code tag code{# as demonstrated here:
Line-breaks

-
-To break a line within a "paragraph object", two backslashes \\ with a space + 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", @@ -2136,30 +1860,26 @@ 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). +
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).

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 =\= or breaks the page, starts a new page. -

-page break -\- or breaks a column, starts a new column, if using columns, -else breaks the page, starts a new page. +
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 =\= +or breaks the page, starts a new page. +
page break -\- or breaks a column, +starts a new column, if using columns, else breaks the page, starts a new +page.

-\\- or <:pb>
-

- -
or +
or

=\\= or @@ -2168,50 +1888,43 @@ or

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

+
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 +
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: +
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. +
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: +
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 +
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+1|second sub-term} A paragraph that continues discussion of the first sub-term
-

-The plus one in the example provided indicates the first sub-term spans +
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:

@@ -2221,97 +1934,88 @@ be:

Composite Documents Markup
-
-

-It is possible to build a document by creating a master document that requires -other documents. The documents required may be complete documents that could -be generated independently, or they could be markup snippets, prepared -so as to be easily available to be placed within another text. If the calling -document is a master document (built from other documents), it should be -named with the suffix .ssm Within this document you would provide information -on the other documents that should be included within the text. These may -be other documents that would be processed in a regular way, or markup -bits prepared only for inclusion within a master document .sst regular markup -file, or .ssi (insert/information) A secondary file of the composite document - -
is built prior to processing with the same prefix and the suffix ._sst -
-
+
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) -
basic markup for importing a document into a master document +
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. +
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.

Sisu Filetypes
-
-

-SiSU has plaintext and binary filetypes, and can process either type of -document. +
SiSU has +plaintext and binary filetypes, and can process either type of document. +

.sst .ssm .ssi Marked Up Plain Text

-
SiSU¤b〕 documents are prepared -as plain-text (utf-8) files with
-
SiSU markup. They may make reference to and -contain images (for example), which are stored in the directory beneath -them _sisu/image. 〔b¤SiSU plaintext markup files are of three types that -may be distinguished by the file extension used: regular text .sst; master -documents, composite documents that incorporate other text, which can be -any regular text or text insert; and inserts the contents of which are -like regular text except these are marked .ssi and are not processed.
- -

-SiSU processing can be done directly against a sisu documents; which may -be located locally or on a remote server for which a url is provided. -

-SiSU source markup can be shared with the command: -

- sisu -s [filename]
- +
SiSU
+
documents are prepared as plain-text +(utf-8) files with SiSU markup. They may make reference to and contain images +(for example), which are stored in the directory beneath them _sisu/image. +〔b¤SiSU plaintext markup files are of three types that may be distinguished +by the file extension used: regular text .sst; master documents, composite +documents that incorporate other text, which can be any regular text or +text insert; and inserts the contents of which are like regular text except +these are marked .ssi and are not processed. +
SiSU processing can be done +directly against a sisu documents; which may be located locally or on a +remote server for which a url is provided. +
SiSU source markup can be shared +with the command: +
sisu -s [filename]

Sisu Text - Regular Files (.sst)
-

+
The most common form of document in SiSU, see the section on SiSU markup.

Sisu Master Files (.ssm)
-

-Composite documents which incorporate other SiSU documents which may be -either regular SiSU text .sst which may be generated independently, or inserts -prepared solely for the purpose of being incorporated into one or more -master documents. -

-The mechanism by which master files incorporate other documents is described -as one of the headings under under SiSU markup in the SiSU manual. -

-Note: Master documents may be prepared in a similar way to regular documents, -and processing will occur normally if a .sst file is renamed .ssm without -requiring any other documents; the .ssm marker flags that the document may -contain other documents. -

-Note: a secondary file of the composite document is built prior to processing -with the same prefix and the suffix ._sst [^19] +
Composite documents which incorporate other SiSU +documents which may be either regular SiSU text .sst which may be generated +independently, or inserts prepared solely for the purpose of being incorporated +into one or more master documents. +
The mechanism by which master files +incorporate other documents is described as one of the headings under under +SiSU markup in the SiSU manual. +
Note: Master documents may be prepared +in a similar way to regular documents, and processing will occur normally +if a .sst file is renamed .ssm without requiring any other documents; the +.ssm marker flags that the document may contain other documents. +
Note: +a secondary file of the composite document is built prior to processing +with the same prefix and the suffix ._sst [^18]

Sisu Insert Files (.ssi)

-
-Inserts are documents prepared solely for the purpose of being incorporated + Inserts are documents prepared solely for the purpose of being incorporated into one or more master documents. They resemble regular SiSU text files except they are ignored by the SiSU processor. Making a file a .ssi file is a quick and convenient way of flagging that it is not intended that @@ -2320,170 +2024,134 @@ the file should be processed on its own.
Sisupod, Zipped Binary Container (sisupod.zip, .ssp)
-

-A sisupod is a zipped SiSU text file or set of SiSU text files and any -associated images that they contain (this will be extended to include sound -and multimedia-files) +
A sisupod is a zipped SiSU text file or set of SiSU +text files and any associated images that they contain (this will be extended +to include sound and multimedia-files)

SiSU
-
plaintext files rely on a recognised directory -structure to find contents such as images associated with documents, but -all images for example for all documents contained in a directory are located -in the sub-directory _sisu/image. Without the ability to create a sisupod -it can be inconvenient to manually identify all other files associated +
plaintext files rely on a recognised +directory structure to find contents such as images associated with documents, +but all images for example for all documents contained in a directory are +located in the sub-directory _sisu/image. Without the ability to create a +sisupod it can be inconvenient to manually identify all other files associated with a document. A sisupod automatically bundles all associated files with the document that is turned into a pod. -

-The structure of the sisupod is such that it may for example contain a -single document and its associated images; a master document and its associated -documents and anything else; or the zipped contents of a whole directory -of prepared SiSU documents. -

-The command to create a sisupod is: -

- sisu -S [filename]
- -

-Alternatively, make a pod of the contents of a whole directory: -

- sisu -S
- -

-SiSU processing can be done directly against a sisupod; which may be located -locally or on a remote server for which a url is provided. -

-<http://www.sisudoc.org/sisu/sisu_commands +
The structure of the sisupod is +such that it may for example contain a single document and its associated +images; a master document and its associated documents and anything else; +or the zipped contents of a whole directory of prepared SiSU documents. + +
The command to create a sisupod is: +
sisu -S [filename] +
Alternatively, +make a pod of the contents of a whole directory: +
sisu -S +
SiSU processing +can be done directly against a sisupod; which may be located locally or +on a remote server for which a url is provided. +
<http://www.sisudoc.org/sisu/sisu_commands > -

-<http://www.sisudoc.org/sisu/sisu_manual + +
<http://www.sisudoc.org/sisu/sisu_manual >

Configuration
-

Configuration Files

+
Config.yml
-

-SiSU configration parameters are adjusted in the configuration file, which -can be used to override the defaults set. This includes such things as which -directory interim processing should be done in and where the generated -output should be placed. -

-The SiSU configuration file is a yaml file, which means indentation is -significant. -

-SiSU resource configuration is determined by looking at the following files -if they exist: -

- ./_sisu/v4/sisurc.yml
+
SiSU configration parameters are adjusted in the configuration +file, which can be used to override the defaults set. This includes such +things as which directory interim processing should be done in and where +the generated output should be placed. +
The SiSU configuration file is +a yaml file, which means indentation is significant. +
SiSU resource configuration +is determined by looking at the following files if they exist: +
./_sisu/v4/sisurc.yml
-

- ./_sisu/sisurc.yml
+
./_sisu/sisurc.yml
-

- ~/.sisu/v4/sisurc.yml
+
~/.sisu/v4/sisurc.yml
-

- ~/.sisu/sisurc.yml
+
~/.sisu/sisurc.yml
-

- /etc/sisu/v4/sisurc.yml
+
/etc/sisu/v4/sisurc.yml
-

- /etc/sisu/sisurc.yml
+
/etc/sisu/sisurc.yml
-

-The search is in the order listed, and the first one found is used. -

-In the absence of instructions in any of these it falls back to the internal +
The search is in the order listed, and the first one found is used. +
+ In the absence of instructions in any of these it falls back to the internal program defaults. -

-Configuration determines the output and processing directories and the -database access details. -

- -
If SiSU is installed a sample sisurc.yml may be found in /etc/sisu/sisurc.yml +
Configuration determines the output and processing directories +and the database access details. +
If SiSU is installed a sample sisurc.yml +
may be found in /etc/sisu/sisurc.yml

Sisu_document_make
-

-Most sisu document headers relate to metadata, the exception is the @make: -header which provides processing related information. The default contents -of the @make header may be set by placing them in a file sisu_document_make. - -

-The search order is as for resource configuration: -

- ./_sisu/v4/sisu_document_make
+
Most sisu document +headers relate to metadata, the exception is the @make: header which provides +processing related information. The default contents of the @make header +may be set by placing them in a file sisu_document_make. +
The search order +is as for resource configuration: +
./_sisu/v4/sisu_document_make
-

- ./_sisu/sisu_document_make
+
./_sisu/sisu_document_make
-

- ~/.sisu/v4/sisu_document_make
+
~/.sisu/v4/sisu_document_make
-

- ~/.sisu/sisu_document_make
+
~/.sisu/sisu_document_make
-

- /etc/sisu/v4/sisu_document_make
+
/etc/sisu/v4/sisu_document_make
-

- /etc/sisu/sisu_document_make
+
/etc/sisu/sisu_document_make
-

-A sample sisu_document_make can be found in the _sisu/ directory under +
A sample sisu_document_make can be found in the _sisu/ directory under along with the provided sisu markup samples.

Css - Cascading Style Sheets (for Html, Xhtml and Xml)
-
- -

-CSS files to modify the appearance of SiSU html, XHTML or XML may be placed -in the configuration directory: ./_sisu/css ; ~/.sisu/css or; /etc/sisu/css -and these will be copied to the output directories with the command sisu --CC. -

-The basic CSS file for html output is html. css, placing a file of that -name in directory _sisu/css or equivalent will result in the default file -of that name being overwritten. -

-HTML: html. css -

-XML DOM: dom.css -

-XML SAX: sax.css -

-XHTML: xhtml. css -

-The default homepage may use homepage.css or html. css -

-Under consideration is to permit the placement of a CSS file with a different -name in directory _sisu/css directory or equivalent.[^20] -
-
Organising Content -- Directory Structure and Mapping
-
-

-SiSU v3 has new options for the source directory tree, and output directory +
CSS files to modify the appearance of SiSU html, +XHTML or XML may be placed in the configuration directory: ./_sisu/css ; +~/.sisu/css or; /etc/sisu/css and these will be copied to the output directories +with the command sisu -CC. +
The basic CSS file for html output is html. css, +placing a file of that name in directory _sisu/css or equivalent will result +in the default file of that name being overwritten. +
HTML: html. css +
XML +DOM: dom.css +
XML SAX: sax.css +
XHTML: xhtml. css +
The default homepage +may use homepage.css or html. css +
Under consideration is to permit the +placement of a CSS file with a different name in directory _sisu/css directory +or equivalent.[^19] +
+
Organising Content - Directory Structure and Mapping
+ +
+ SiSU v3 has new options for the source directory tree, and output directory structures of which there are 3 alternatives.

Document Source Directory

-
-The document source directory is the directory in which sisu processing + The document source directory is the directory in which sisu processing commands are given. It contains the sisu source files (.sst .ssm .ssi), or (for sisu v3 may contain) subdirectories with language codes which contain the sisu source files, so all English files would go in subdirectory en/, @@ -2512,35 +2180,34 @@ is limited to langagues supported by XeTeX polyglosia.

Output Directory Root
-

-The output directory root can be set in the sisurc.yml file. Under the root, -subdirectories are made for each directory in which a document set resides. -If you have a directory named poems or conventions, that directory will -be created under the output directory root and the output for all documents -contained in the directory of a particular name will be generated to subdirectories +
The output +directory root can be set in the sisurc.yml file. Under the root, subdirectories +are made for each directory in which a document set resides. If you have +a directory named poems or conventions, that directory will be created +under the output directory root and the output for all documents contained +in the directory of a particular name will be generated to subdirectories beneath that directory (poem or conventions). A document will be placed in a subdirectory of the same name as the document with the filetype identifier stripped (.sst .ssm) -

-The last part of a directory path, representing the sub-directory in which -a document set resides, is the directory name that will be used for the -output directory. This has implications for the organisation of document -collections as it could make sense to place documents of a particular subject, -or type within a directory identifying them. This grouping as suggested -could be by subject (sales_law, english_literature); or just as conveniently -by some other classification (X University). The mapping means it is also -possible to place in the same output directory documents that are for organisational -purposes kept separately, for example documents on a given subject of two -different institutions may be kept in two different directories of the -same name, under a directory named after each institution, and these would -be output to the same output directory. Skins could be associated with each -institution on a directory basis and resulting documents will take on the -appropriate different appearance. +
The last part of a directory path, representing the +sub-directory in which a document set resides, is the directory name that +will be used for the output directory. This has implications for the organisation +of document collections as it could make sense to place documents of a +particular subject, or type within a directory identifying them. This grouping +as suggested could be by subject (sales_law, english_literature); or just +as conveniently by some other classification (X University). The mapping +means it is also possible to place in the same output directory documents +that are for organisational purposes kept separately, for example documents +on a given subject of two different institutions may be kept in two different +directories of the same name, under a directory named after each institution, +and these would be output to the same output directory. Skins could be associated +with each institution on a directory basis and resulting documents will +take on the appropriate different appearance.

Alternative Output Structures
-

-There are 3 possibile output structures described as being, by language, +
+ There are 3 possibile output structures described as being, by language, by filetype or by filename, the selection is made in sisurc.yml

#% output_dir_structure_by: language; filetype; or filename @@ -2552,18 +2219,15 @@ v2)

by Language
-

- -
The by language directory structure places output files -

-The by language directory structure separates output files by language +
The by language directory structure places output files +
+ The by language directory structure separates output files by language code (all files of a given language), and within the language directory by filetype. -

+
Its selection is configured in sisurc.yml +
output_dir_structure_by: -
Its selection is configured in sisurc.yml -

-output_dir_structure_by: language +
language

|-- en |-- epub @@ -2592,20 +2256,18 @@ output_dir_structure_by: language |-- rng ‘-- xsd
-

-#by: language subject_dir/en/manifest/filename.html +
#by: language subject_dir/en/manifest/filename.html

by Filetype
-

-The by filetype directory structure separates output files by filetype, -all html files in one directory pdfs in another and so on. Filenames are -given a language extension. -

+
The +by filetype directory structure separates output files by filetype, all +html files in one directory pdfs in another and so on. Filenames are given +a language extension. +
Its selection is configured in sisurc.yml +
output_dir_structure_by: -
Its selection is configured in sisurc.yml -

-output_dir_structure_by: filetype +
filetype

|-- epub |-- hashes @@ -2633,19 +2295,17 @@ output_dir_structure_by: filetype |-- xhtml ‘-- xml
-

-#by: filetype subject_dir/html/filename/manifest.en.html +
#by: filetype subject_dir/html/filename/manifest.en.html

by Filename
-

+
The by filename directory structure places most output of a particular file (the different filetypes) in a common directory. -

+
Its selection is -
Its selection is configured in sisurc.yml -

-output_dir_structure_by: filename +
configured in sisurc.yml +
output_dir_structure_by: filename

|-- epub |-- po4a @@ -2666,13 +2326,14 @@ output_dir_structure_by: filename |-- pod ‘-- viral_spiral.david_bollier
-

-#by: filename subject_dir/filename/manifest.en.html +
#by: filename subject_dir/filename/manifest.en.html

Remote Directories
-

-
% containing sub_directories named after the generated files from which +
+
+
./subject_name/ +% containing sub_directories named after the generated files from which they are made ./subject_name/src % contains shared source files text and binary e.g. sisu_manual.sst and sisu_manual.sst.zip @@ -2689,7 +2350,8 @@ they are made
Sisupod

-
% files stored at this level e.g. sisu_manual.sst +
./sisupod/ +% files stored at this level e.g. sisu_manual.sst ./sisupod/_sisu % configuration file e.g. sisurc.yml ./sisupod/_sisu/skin @@ -2704,60 +2366,52 @@ they are made

Homepages
-
- -

-SiSU is about the ability to auto-generate documents. Home pages are regarded -as custom built items, and are not created by SiSU. More accurately, SiSU -has a default home page, which will not be appropriate for use with other -sites, and the means to provide your own home page instead in one of two -ways as part of a site’s configuration, these being: -

-1. through placing your home page and other custom built documents in the -subdirectory _sisu/home/ (this probably being the easier and more convenient -option) -

-2. through providing what you want as the home page in a skin, -

-Document sets are contained in directories, usually organised by site or -subject. Each directory can/should have its own homepage. See the section -on directory structure and organisation of content. -
-
Home Page and Other -Custom Built Pages in a Sub-directory
- -

-Custom built pages, including the home page index.html may be placed within -the configuration directory _sisu/home/ in any of the locations that is -searched for the configuration directory, namely ./_sisu ; ~/_sisu ; /etc/sisu -From there they are copied to the root of the output directory with the -command: -

- sisu -CC
-
+
SiSU is about the ability to auto-generate +documents. Home pages are regarded as custom built items, and are not created +by SiSU. More accurately, SiSU has a default home page, which will not be +appropriate for use with other sites, and the means to provide your own +home page instead in one of two ways as part of a site’s configuration, +these being: +
1. through placing your home page and other custom built +documents in the subdirectory _sisu/home/ (this probably being the easier +and more convenient option) +
2. through providing what you want as the +home page in a skin, +
Document sets are contained in directories, usually +organised by site or subject. Each directory can/should have its own homepage. +See the section on directory structure and organisation of content. +
+
Home +Page and Other Custom Built Pages in a Sub-directory
+ +
Custom built pages, +including the home page index.html may be placed within the configuration +directory _sisu/home/ in any of the locations that is searched for the +configuration directory, namely ./_sisu ; ~/_sisu ; /etc/sisu From there +they are copied to the root of the output directory with the command: +
+ sisu -CC
Markup and Output Examples
-

Markup Examples
-

-Current markup examples and document output samples are provided off <http://sisudoc.org +
Current markup examples +and document output samples are provided off <http://sisudoc.org +> or <http://www.jus.uio.no/sisu > -or <http://www.jus.uio.no/sisu -> and in the sisu -markup-sample package available -off <http://sources.sisudoc.org +and in the sisu -markup-sample package available off <http://sources.sisudoc.org > -

-For some documents hardly any markup at all is required at all, other than -a header, and an indication that the levels to be taken into account by -the program in generating its output are. + +
For some documents hardly any markup at all is required at all, other +than a header, and an indication that the levels to be taken into account +by the program in generating its output are.

Sisu Markup Samples
-

-A few additional sample books prepared as sisu markup samples, output formats +
A few +additional sample books prepared as sisu markup samples, output formats to be generated using SiSU are contained in a separate package sisu -markup-samples. sisu -markup-samples contains books (prepared using sisu markup), that were released by their authors various licenses mostly different Creative Commons @@ -2766,320 +2420,284 @@ requirements that do not meet the Debian Free Software Guidelines for var reasons, most commonly that they require that the original substantive text remain unchanged, and sometimes that the works be used only non-commercially. -

-Accelerando, Charles Stross (2005) accelerando.charles_stross.sst -

-Alice’s Adventures in Wonderland, Lewis Carroll (1865) alices_adventures_in_wonderland.lewis_carroll.sst +
Accelerando, Charles Stross (2005) accelerando.charles_stross.sst +
Alice’s +Adventures in Wonderland, Lewis Carroll (1865) alices_adventures_in_wonderland.lewis_carroll.sst -

-CONTENT, Cory Doctorow (2008) content.cory_doctorow.sst -

-Democratizing Innovation, Eric von Hippel (2005) democratizing_innovation.eric_von_hippel.sst +
CONTENT, Cory Doctorow (2008) content.cory_doctorow.sst +
Democratizing +Innovation, Eric von Hippel (2005) democratizing_innovation.eric_von_hippel.sst -

-Down and Out in the Magic Kingdom, Cory Doctorow (2003) down_and_out_in_the_magic_kingdom.cory_doctorow.sst +
Down and Out in the Magic Kingdom, Cory Doctorow (2003) down_and_out_in_the_magic_kingdom.cory_doctorow.sst -

-For the Win, Cory Doctorow (2010) for_the_win.cory_doctorow.sst -

-Free as in Freedom - Richard Stallman’s Crusade for Free Software, Sam Williams +
For the Win, Cory Doctorow (2010) for_the_win.cory_doctorow.sst +
Free +as in Freedom - Richard Stallman’s Crusade for Free Software, Sam Williams (2002) free_as_in_freedom.richard_stallman_crusade_for_free_software.sam_williams.sst -

-Free as in Freedom 2.0 - Richard Stallman and the Free Software Revolution, +
Free as in Freedom 2.0 - Richard Stallman and the Free Software Revolution, Sam Williams (2002), Richard M. Stallman (2010) free_as_in_freedom_2.richard_stallman_and_the_free_software_revolution.sam_williams.richard_stallman.sst -

-Free Culture - How Big Media Uses Technology and the Law to Lock Down Culture -and Control Creativity, Lawrence Lessig (2004) free_culture.lawrence_lessig.sst +
Free Culture - How Big Media Uses Technology and the Law to Lock Down +Culture and Control Creativity, Lawrence Lessig (2004) free_culture.lawrence_lessig.sst -

-Free For All - How Linux and the Free Software Movement Undercut the High +
Free For All - How Linux and the Free Software Movement Undercut the High Tech Titans, Peter Wayner (2002) free_for_all.peter_wayner.sst -

-GNU GENERAL PUBLIC LICENSE v2, Free Software Foundation (1991) gpl2.fsf.sst - -

-GNU GENERAL PUBLIC LICENSE v3, Free Software Foundation (2007) gpl3.fsf.sst - -

-Gulliver’s Travels, Jonathan Swift (1726 / 1735) gullivers_travels.jonathan_swift.sst +
GNU GENERAL +PUBLIC LICENSE v2, Free Software Foundation (1991) gpl2.fsf.sst +
GNU GENERAL +PUBLIC LICENSE v3, Free Software Foundation (2007) gpl3.fsf.sst +
Gulliver’s +Travels, Jonathan Swift (1726 / 1735) gullivers_travels.jonathan_swift.sst -

-Little Brother, Cory Doctorow (2008) little_brother.cory_doctorow.sst -

-The Cathederal and the Bazaar, Eric Raymond (2000) the_cathedral_and_the_bazaar.eric_s_raymond.sst +
Little Brother, Cory Doctorow (2008) little_brother.cory_doctorow.sst +
+ The Cathederal and the Bazaar, Eric Raymond (2000) the_cathedral_and_the_bazaar.eric_s_raymond.sst -

-The Public Domain - Enclosing the Commons of the Mind, James Boyle (2008) +
The Public Domain - Enclosing the Commons of the Mind, James Boyle (2008)
the_public_domain.james_boyle.sst -

-The Wealth of Networks - How Social Production Transforms Markets and Freedom, -Yochai Benkler (2006) the_wealth_of_networks.yochai_benkler.sst -

-Through the Looking Glass, Lewis Carroll (1871) through_the_looking_glass.lewis_carroll.sst +
The Wealth of Networks - How Social Production +Transforms Markets and Freedom, Yochai Benkler (2006) the_wealth_of_networks.yochai_benkler.sst -

-Two Bits - The Cultural Significance of Free Software, Christopher Kelty +
Through the Looking Glass, Lewis Carroll (1871) through_the_looking_glass.lewis_carroll.sst + +
Two Bits - The Cultural Significance of Free Software, Christopher Kelty (2008) two_bits.christopher_kelty.sst -

-UN Contracts for International Sale of Goods, UN (1980) un_contracts_international_sale_of_goods_convention_1980.sst +
UN Contracts for International Sale +of Goods, UN (1980) un_contracts_international_sale_of_goods_convention_1980.sst -

-Viral Spiral, David Bollier (2008) viral_spiral.david_bollier.sst +
Viral Spiral, David Bollier (2008) viral_spiral.david_bollier.sst
-
Sisu Search -- Introduction
-
+
Sisu +Search - Introduction
-

-SiSU output can easily and conveniently be indexed by a number of standalone -indexing tools, such as Lucene, Hyperestraier. -

-Because the document structure of sites created is clearly defined, and +
SiSU output can easily and conveniently be indexed +by a number of standalone indexing tools, such as Lucene, Hyperestraier. + +
Because the document structure of sites created is clearly defined, and the text object citation system is available hypothetically at least, for all forms of output, it is possible to search the sql database, and either read results from that database, or just as simply map the results to the html output, which has richer text markup. -

-In addition to this SiSU has the ability to populate a relational sql type -database with documents at an object level, with objects numbers that are -shared across different output types, which make them searchable with that -degree of granularity. Basically, your match criteria is met by these documents -and at these locations within each document, which can be viewed within -the database directly or in various output formats. +
In addition to this SiSU has +the ability to populate a relational sql type database with documents at +an object level, with objects numbers that are shared across different +output types, which make them searchable with that degree of granularity. +Basically, your match criteria is met by these documents and at these locations +within each document, which can be viewed within the database directly +or in various output formats.

Sql
-

Populating Sql Type Databases
-

-SiSU feeds sisu markupd documents into sql type databases PostgreSQL [^21] -and/or SQLite [^22] database together with information related to document -structure. -

-This is one of the more interesting output forms, as all the structural +
SiSU feeds +sisu markupd documents into sql type databases PostgreSQL [^20] and/or SQLite +[^21] database together with information related to document structure. +
+ This is one of the more interesting output forms, as all the structural data of the documents are retained (though can be ignored by the user of the database should they so choose). All site texts/documents are (currently) streamed to four tables: -

- * one containing semantic (and other) headers, including, title, author,
- subject, (the
+
* one containing semantic (and other) headers, +including, title, author, subject, (the
.I Dublin Core.
..);
-

- * another the substantive texts by individual "paragraph" (or object) --
- along with structural information, each paragraph being identifiable +
* another the substantive texts by individual "paragraph" (or object) +- along with structural information, each paragraph being identifiable by its
paragraph number (if it has one which almost all of them do), and the
substantive text of each paragraph quite naturally being searchable (both in
formatted and clean text versions for searching); and
-

- * a third containing endnotes cross-referenced back to the paragraph from
- which they are referenced (both in formatted and clean text versions +
* a third containing endnotes cross-referenced back to the paragraph +from which they are referenced (both in formatted and clean text versions for
searching).
-

- * a fourth table with a one to one relation with the headers table contains
- full text versions of output, eg. pdf, html, xml, and
+
* a fourth table with a one to one relation with the headers table contains + full text versions of output, eg. pdf, html, xml, and
.I ascii.
-

-There is of course the possibility to add further structures. -

-At this level SiSU loads a relational database with documents chunked into -objects, their smallest logical structurally constituent parts, as text -objects, with their object citation number and all other structural information +
There is of course the possibility to add further structures. +
At this +level SiSU loads a relational database with documents chunked into objects, +their smallest logical structurally constituent parts, as text objects, +with their object citation number and all other structural information needed to construct the document. Text is stored (at this text object level) with and without elementary markup tagging, the stripped version being so as to facilitate ease of searching. -

-Being able to search a relational database at an object level with the -SiSU citation system is an effective way of locating content generated -by SiSU. As individual text objects of a document stored (and indexed) together -with object numbers, and all versions of the document have the same numbering, -complex searches can be tailored to return just the locations of the search -results relevant for all available output formats, with live links to the -precise locations in the database or in html/xml documents; or, the structural -information provided makes it possible to search the full contents of the -database and have headings in which search content appears, or to search -only headings etc. (as the Dublin Core is incorporated it is easy to make -use of that as well). +
Being able to search a relational +database at an object level with the SiSU citation system is an effective +way of locating content generated by SiSU. As individual text objects of +a document stored (and indexed) together with object numbers, and all versions +of the document have the same numbering, complex searches can be tailored +to return just the locations of the search results relevant for all available +output formats, with live links to the precise locations in the database +or in html/xml documents; or, the structural information provided makes +it possible to search the full contents of the database and have headings +in which search content appears, or to search only headings etc. (as the +Dublin Core is incorporated it is easy to make use of that as well).

Postgresql
-

-
Name
-

-SiSU - Structured information, Serialized Units - a document publishing system, +
Name
-
postgresql dependency package +
SiSU - Structured information, Serialized Units - a document publishing +system, postgresql dependency package

Description
-

-Information related to using postgresql with sisu (and related to the sisu_postgresql -dependency package, which is a dummy package to install dependencies needed -for SiSU to populate a postgresql database, this being part of SiSU - man -sisu) . +
Information related +to using postgresql with sisu (and related to the sisu_postgresql dependency +package, which is a dummy package to install dependencies needed for SiSU +to populate a postgresql database, this being part of SiSU - man sisu) . +

Synopsis
-

- sisu -D [instruction] [filename/wildcard if required]
- -

- sisu -D --pg --[instruction] [filename/wildcard if required]
- +
sisu -D [instruction] [filename/wildcard if required] +
sisu +-D --pg --[instruction] [filename/wildcard if required]

Commands
-

-Mappings to two databases are provided by default, postgresql and sqlite, -the same commands are used within sisu to construct and populate databases -however -d (lowercase) denotes sqlite and -D (uppercase) denotes postgresql, +
Mappings +to two databases are provided by default, postgresql and sqlite, the same +commands are used within sisu to construct and populate databases however +-d (lowercase) denotes sqlite and -D (uppercase) denotes postgresql, alternatively -
alternatively --sqlite or --pgsql may be used -

--D or --pgsql may be used interchangeably. +
- +
- +
sqlite or --pgsql may be used +
-D or --pgsql may be used interchangeably.
-
Create and Destroy Database
+
Create +and Destroy Database

-
--pgsql ---createall
-
initial step, creates required relations (tables, indexes) in -existing (postgresql) database (a database should be created manually and -given the same name as working directory, as requested) (rb.dbi) +
--pgsql --createall
+
initial step, creates required relations +(tables, indexes) in existing (postgresql) database (a database should +be created manually and given the same name as working directory, as requested) +(rb.dbi)

-
sisu -D ---createdb
+
sisu -D --createdb

creates database where no database existed before +

-
sisu -D --create -
-
-
creates database tables where no database tables existed before +
sisu -D --create
+
creates database tables where no database tables existed + +
before

-
sisu -D ---Dropall
-
destroys database (including all its content)! kills data and drops -tables, indexes and database associated with a given directory (and directories -of the same name). +
sisu -D --Dropall
+
destroys database (including all its content)! kills +data and drops tables, indexes and database associated with a given directory +(and directories of the same name).

sisu -D --recreate
-
destroys existing database and builds +
destroys existing database -
a new empty database structure +
and builds a new empty database structure

Import and Remove Documents

-
-
sisu -D --import --v [filename/wildcard]
-
populates database with the contents of the file. -Imports documents(s) specified to a postgresql database (at an object level). +
+
sisu -D --import -v [filename/wildcard]
+
populates database with the contents +of the file. Imports documents(s) specified to a postgresql database (at +an object level).

sisu -D --update -v [filename/wildcard]
-
updates file contents in database +
updates file contents +
in database

sisu -D --remove -v [filename/wildcard]
-
removes specified document from postgresql -database. +
removes specified document +from postgresql database.

Sqlite
-

Name
-

-SiSU - Structured information, Serialized Units - a document publishing system. - +
SiSU - Structured information, Serialized +Units - a document publishing system.

Description
-

-Information related to using sqlite with sisu (and related to the sisu_sqlite -dependency package, which is a dummy package to install dependencies needed -for SiSU to populate an sqlite database, this being part of SiSU - man sisu) -. +
Information related to +using sqlite with sisu (and related to the sisu_sqlite dependency package, +which is a dummy package to install dependencies needed for SiSU to populate +an sqlite database, this being part of SiSU - man sisu) .

Synopsis
-

- sisu -d [instruction] [filename/wildcard if required]
- -

- sisu -d --(sqlite|pg) --[instruction] [filename/wildcard if
- required]
- +
sisu +-d [instruction] [filename/wildcard if required] +
sisu -d --(sqlite|pg) --[instruction] +[filename/wildcard if required]

Commands
-

-Mappings to two databases are provided by default, postgresql and sqlite, -the same commands are used within sisu to construct and populate databases -however -d (lowercase) denotes sqlite and -D (uppercase) denotes postgresql, +
Mappings to two databases +are provided by default, postgresql and sqlite, the same commands are used +within sisu to construct and populate databases however -d (lowercase) denotes +sqlite and -D (uppercase) denotes postgresql, alternatively --sqlite or --pgsql -
alternatively --sqlite or --pgsql may be used -

--d or --sqlite may be used interchangeably. +
may be used +
-d or --sqlite may be used interchangeably.
-
Create and Destroy Database
+
Create and Destroy +Database

-
--sqlite ---createall
-
initial step, creates required relations (tables, indexes) in -existing (sqlite) database (a database should be created manually and given -the same name as working directory, as requested) (rb.dbi) +
--sqlite --createall
+
initial step, creates required relations (tables, +indexes) in existing (sqlite) database (a database should be created manually +and given the same name as working directory, as requested) (rb.dbi)

-
sisu -d --createdb -
-
-
creates database where no database existed before +
sisu +-d --createdb
+
creates database where no database existed before

-
sisu -d --create
-
creates - -
database tables where no database tables existed before +
sisu -d --create +
+
+
creates database tables where no database tables existed before

-
sisu -d --dropall -
-
destroys database (including all its content)! kills data and drops tables, -indexes and database associated with a given directory (and directories +
sisu -d +--dropall
+
destroys database (including all its content)! kills data and drops +tables, indexes and database associated with a given directory (and directories of the same name).

@@ -3114,43 +2732,38 @@ database.

Introduction
-

-
Search - Database Frontend Sample, Utilising Database and Sisu Features,
-INCLUDING -OBJECT CITATION NUMBERING (BACKEND CURRENTLY POSTGRESQL) -

-Sample search frontend <http://search.sisudoc.org -> [^23] A small database and -sample query front-end (search from) that makes use of the citation system, -object citation numbering to demonstrates functionality.[^24] -

-SiSU can provide information on which documents are matched and at what +
Search - Database Frontend Sample, Utilising Database +and Sisu Features,
+INCLUDING OBJECT CITATION NUMBERING (BACKEND CURRENTLY +POSTGRESQL) +
Sample search frontend <http://search.sisudoc.org +> [^22] A small +database and sample query front-end (search from) that makes use of the +citation system, .I object citation numbering to demonstrates functionality.[^23] + +
SiSU can provide information on which documents are matched and at what locations within each document the matches are found. These results are relevant across all outputs using object citation numbering, which includes html, XML, EPUB, LaTeX, PDF and indeed the SQL database. You can then refer to one of the other outputs or in the SQL database expand the text within the matched objects (paragraphs) in the documents matched. -

-Note you may set results either for documents matched and object number -locations within each matched document meeting the search criteria; or -display the names of the documents matched along with the objects (paragraphs) -that meet the search criteria.[^25] +
Note you may +set results either for documents matched and object number locations within +each matched document meeting the search criteria; or display the names +of the documents matched along with the objects (paragraphs) that meet +the search criteria.[^24]

sisu -F --webserv-webrick
-
builds a cgi web +
builds a cgi web search -
search frontend for the database created -

-The following is feedback on the setup on a machine provided by the help -command: -

- sisu --help sql
- -

+
frontend for the database created +
The following is feedback on the setup +on a machine provided by the help command: +
sisu --help sql

Postgresql user: ralph current db set: SiSU_sisu @@ -3160,156 +2773,138 @@ sqlite current db set: /home/ralph/sisu_www/sisu/sisu_sqlite.db dbi connect DBI:SQLite:/home/ralph/sisu_www/sisu/sisu_sqlite.db
-

- -
Note on databases built -

-By default, [unless otherwise specified] databases are built on a directory -basis, from collections of documents within that directory. The name of -the directory you choose to work from is used as the database name, i.e. -if you are working in a directory called /home/ralph/ebook the database -SiSU_ebook is used. [otherwise a manual mapping for the collection is -

+
Note on databases built +
By default, [unless otherwise specified] databases +are built on a directory basis, from collections of documents within that +directory. The name of the directory you choose to work from is used as +the database name, i.e. if you are working in a directory called /home/ralph/ebook +the database SiSU_ebook is used. [otherwise a manual mapping for the collection +is necessary]

-
Search -Form
+
Search Form

sisu -F
-
generates a sample search form, which must be copied to the +
generates a sample search form, which -
web-server cgi directory +
must be copied to the web-server cgi directory

sisu -F --webserv-webrick
-
generates a sample search -form for use with the webrick server, which must be copied to the web-server +
generates +a sample search form for use with the webrick server, which must be copied -
cgi directory +
to the web-server cgi directory

sisu -W
-
starts the webrick server which should be available +
starts the webrick server which -
wherever sisu is properly installed -

+
should be available wherever sisu is properly installed +
The generated -
The generated search form must be copied manually to the webserver directory +
search form must be copied manually to the webserver directory as instructed -
as instructed

Sisu_webrick
-

Name
-

-SiSU - Structured information, Serialized Units - a document publishing system +
SiSU - Structured information, Serialized Units - a document +
publishing system

Synopsis
-

-sisu_webrick [port] -

- -
or -

-sisu -W [port] +
sisu_webrick [port] +
or +
sisu -W [port]
+
Description
-

-sisu_webrick is part of SiSU (man sisu) sisu_webrick starts Ruby SiSU -output is written, providing a list of these directories (assuming SiSU -is in use and they exist). -

-The default port for sisu_webrick is set to 8081, this may be modified -in the yaml file: ~/.sisu/sisurc.yml a sample of which is provided as /etc/sisu/sisurc.yml -(or in the equivalent directory on your system). +
sisu_webrick is part of SiSU (man sisu) sisu_webrick starts +Ruby SiSU output is written, providing a list of these directories (assuming +SiSU is in use and they exist). +
The default port for sisu_webrick is set +to 8081, this may be modified in the yaml file: ~/.sisu/sisurc.yml a sample +of which is provided as /etc/sisu/sisurc.yml (or in the equivalent directory +on your system).

Summary of Man Page
-

-sisu_webrick, may be started on it’s own with the command: sisu_webrick -[port] or using the sisu command with the -W flag: sisu -W [port] -

- -
where no port is given and settings are unchanged the default port is 8081 +
sisu_webrick, may be started on it’s +own with the command: sisu_webrick [port] or using the sisu command with +the -W flag: sisu -W [port] +
where no port is given and settings are unchanged +
the default port is 8081

Document Processing Command Flags
-

-sisu -W [port] starts Ruby Webrick web-server, serving SiSU output directories, -on the port provided, or if no port is provided and the defaults have not +
sisu -W [port] +starts Ruby Webrick web-server, serving SiSU output directories, on the +port provided, or if no port is provided and the defaults have not been -
been changed in ~/.sisu/sisurc.yaml then on port 8081 +
changed in ~/.sisu/sisurc.yaml then on port 8081

Summary of Features
-
-

-* sparse/minimal markup (clean utf-8 source texts). Documents are prepared +
* +sparse/minimal markup (clean utf-8 source texts). Documents are prepared in a single UTF-8 file using a minimalistic mnemonic syntax. Typical literature, documents like "War and Peace" require almost no markup, and most of the headers are optional. -

-* markup is easily readable/parsable by the human eye, (basic markup is -simpler and more sparse than the most basic HTML ) , [this may also be - converted to .I XML representations of the same input/source document]. -
-
-* markup defines document structure (this may be done once in a header -pattern-match description, or for heading levels individually); basic text -attributes (bold, italics, underscore, strike-through etc.) as required; -and semantic information related to the document (header information, extended -beyond the Dublin core and easily further extended as required); the headers -may also contain processing instructions. SiSU markup is primarily an abstraction -of document structure and document metadata to permit taking advantage -of the basic strengths of existing alternative practical standard ways -of representing documents [be that browser viewing, paper publication, - sql search etc.] (html, epub, xml, odf, latex, pdf, sql) -

-* for output produces reasonably elegant output of established industry -and institutionally accepted open standard formats.[3] takes advantage of -the different strengths of various standard formats for representing documents, -amongst the output formats currently supported are: -

-* HTML - both as a single scrollable text and a segmented document -

-* XHTML -

-* EPUB -

-* XML - both in sax and dom style xml structures for further development - -
as required -

-* ODT - Open Document Format text, the iso standard for document storage - -

-* LaTeX - used to generate pdf -

-* PDF (via LaTeX ) -

-* SQL - population of an sql database ( PostgreSQL or SQLite ) , (at the -same object level that is used to cite text within a document) -

-Also produces: concordance files; document content certificates (md5 or -sha256 digests of headings, paragraphs, images etc.) and html manifests -(and sitemaps of content). (b) takes advantage of the strengths implicit -in these very different output types, (e.g. PDFs produced using typesetting -of LaTeX, databases populated with documents at an individual object/paragraph -level, making possible granular search (and related possibilities)) -

-* ensuring content can be cited in a meaningful way regardless of selected +
* markup is easily readable/parsable by the human +eye, (basic markup is simpler and more sparse than the most basic HTML +) , [this may also be converted to XML representations of the same input/source +document]. +
* markup defines document structure (this may be done once +in a header pattern-match description, or for heading levels individually); +basic text attributes (bold, italics, underscore, strike-through etc.) as +required; and semantic information related to the document (header information, +extended beyond the Dublin core and easily further extended as required); +the headers may also contain processing instructions. SiSU markup is primarily +an abstraction of document structure and document metadata to permit taking +advantage of the basic strengths of existing alternative practical standard +ways of representing documents [be that browser viewing, paper publication, +sql search etc.] (html, epub, xml, odf, latex, pdf, sql) +
* for output +produces reasonably elegant output of established industry and institutionally +accepted open standard formats.[3] takes advantage of the different strengths +of various standard formats for representing documents, amongst the output +formats currently supported are: +
* HTML - both as a single scrollable + +
text and a segmented document +
* XHTML +
* EPUB +
* XML - both in sax and + +
dom style xml structures for further development as required +
* ODT - Open +Document Format text, the iso standard for document storage +
* LaTeX - + +
used to generate pdf +
* PDF (via LaTeX ) +
* SQL - population of an sql +database ( PostgreSQL or SQLite ) , (at the same object level that is used +to cite text within a document) +
Also produces: concordance files; document +content certificates (md5 or sha256 digests of headings, paragraphs, images +etc.) and html manifests (and sitemaps of content). (b) takes advantage of +the strengths implicit in these very different output types, (e.g. PDFs produced +using typesetting of LaTeX, databases populated with documents at an individual +object/paragraph level, making possible granular search (and related possibilities)) + +
* ensuring content can be cited in a meaningful way regardless of selected output format. Online publishing (and publishing in multiple document formats) lacks a useful way of citing text internally within documents (important to academics generally and to lawyers) as page numbers are meaningless @@ -3319,229 +2914,178 @@ search engines). The outputs share a common numbering system that is meaningful (to man and machine) across all digital outputs whether paper, screen, or database oriented, (pdf, HTML, EPUB, xml, sqlite, postgresql) , this numbering system can be used to reference content. -

-* Granular search within documents. SQL databases are populated at an object -level (roughly headings, paragraphs, verse, tables) and become searchable -with that degree of granularity, the output information provides the object/paragraph -numbers which are relevant across all generated outputs; it is also possible -to look at just the matching paragraphs of the documents in the database; -[output indexing also work -

-* long term maintainability of document collections in a world of changing -formats, having a very sparsely marked-up source document base. there is -a considerable degree of future-proofing, output representations are "upgradeable", -and new document formats may be added. e.g. addition of odf (open document -text) module in 2006, epub in 2009 and in future html5 output sometime -in future, without modification of existing prepared texts -

-* SQL search aside, documents are generated as required and static once -generated. -

-* documents produced are static files, and may be batch processed, this -needs to be done only once but may be repeated for various reasons as desired -(updated content, addition of new output formats, updated technology document -presentations/representations) -

-* document source ( plaintext utf-8) if shared on the net may be used as - -
input and processed locally to produce the different document outputs -
-
-* document source may be bundled together (automatically) with associated +
* Granular search within +documents. SQL databases are populated at an object level (roughly headings, +paragraphs, verse, tables) and become searchable with that degree of granularity, +the output information provides the object/paragraph numbers which are +relevant across all generated outputs; it is also possible to look at just +the matching paragraphs of the documents in the database; [output indexing +also work well with search indexing tools like hyperestraier]. +
* long +term maintainability of document collections in a world of changing formats, +having a very sparsely marked-up source document base. there is a considerable +degree of future-proofing, output representations are "upgradeable", and +new document formats may be added. e.g. addition of odf (open document text) +module in 2006, epub in 2009 and in future html5 output sometime in future, + +
without modification of existing prepared texts +
* SQL search aside, documents +are generated as required and static once generated. +
* documents produced +are static files, and may be batch processed, this needs to be done only +once but may be repeated for various reasons as desired (updated content, +addition of new output formats, updated technology document presentations/representations) + +
* document source ( plaintext utf-8) if shared on the net may be used + +
as input and processed locally to produce the different document outputs + +
* document source may be bundled together (automatically) with associated documents (multiple language versions or master document with inclusions) and images and sent as a zip file called a sisupod, if shared on the net
these too may be processed locally to produce the desired document outputs -

-* generated document outputs may automatically be posted to remote sites. +
* generated document outputs may automatically be posted to remote sites. -

-* for basic document generation, the only software dependency is Ruby, +
* for basic document generation, the only software dependency is Ruby, and a few standard Unix tools (this covers plaintext, HTML, EPUB, XML, ODF, LaTeX ) . To use a database you of course need that, and to convert the LaTeX generated to pdf, a latex processor like tetex or texlive. -

-* as a developers tool it is flexible and extensible -

-Syntax highlighting for SiSU markup is available for a number of text editors. - -

-SiSU is less about document layout than about finding a way with little -markup to be able 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, or search of content -

-i.e. to be able to take advantage from this 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 viewing (e.g. html, -xml, pdf) , or paper publication (e.g. pdf) ... -

-the solution arrived at is by extracting structural information about the -document (about headings within the document) and by tracking objects (which -are serialized and also given hash values) in the manner described. It makes -possible representations that are quite different from those offered at -present. For example objects could be saved individually and identified -by their hashes, with an index of how the objects relate to each other -to form a document. +
* + +
as a developers tool it is flexible and extensible +
Syntax highlighting +for SiSU markup is available for a number of text editors. +
SiSU is less +about document layout than about finding a way with little markup to be +able 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, or search of content +
i.e. to be able to take advantage +from this 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 viewing (e.g. html, xml, pdf) , or paper publication +(e.g. pdf) ... +
the solution arrived at is by extracting structural information +about the document (about headings within the document) and by tracking +objects (which are serialized and also given hash values) in the manner +described. It makes possible representations that are quite different from +those offered at present. For example objects could be saved individually +and identified by their hashes, with an index of how the objects relate +to each other to form a document.

-.
objects include: headings, paragraphs, verse, tables, -images, but not footnotes/endnotes which are numbered separately and tied -to the object from which they are referenced. -

-
.
i.e. the -

-HTML, -

-PDF, -

-EPUB, -

- -
ODT -

-outputs are each built individually and optimised for that form of presentation, -rather than for example the html being a saved version of the odf, or the -pdf being a saved version of the html. -

-
.
-
the different heading levels -

-
.
units of text, primarily paragraphs and headings, also any tables, poems, - -
code-blocks -

-
.
-
An open standard format for e-books -

-
.
Open Document Format ( -

- -
ODF -

-) text -

-
.
-
Specification submitted by Adobe to ISO to become a full open ISO specification - -

-<http://www.linux-watch.com/news/NS7542722606.html +.
objects include: headings, paragraphs, +verse, tables, images, but not footnotes/endnotes which are numbered separately +and tied to the object from which they are referenced. +

.
i.e. the HTML, PDF, +EPUB, ODT outputs are each built individually and optimised for that form +of presentation, rather than for example the html being a saved version +of the odf, or the pdf being a saved version of the html. +

.
the different + +
heading levels +

.
units of text, primarily paragraphs and headings, also +any tables, poems, code-blocks +

.
An open standard format for e-books +

.
Open +Document Format ( ODF ) text +

.
Specification submitted by Adobe to ISO +to become a full open ISO specification <http://www.linux-watch.com/news/NS7542722606.html > -

-
.
-
ISO standard ISO/IEC 26300:2006 -

- + +

.
ISO standard ISO/IEC 26300:2006 +

*1.

square brackets -

-
+

*2.

square brackets -

-
+ +

+1.

square brackets -

-
.
<http://www.jus.uio.no/sisu/man/ +

.
<http://www.jus.uio.no/sisu/man/ > -

-
.
<http://www.jus.uio.no/sisu/man/sisu.1.html +

.
<http://www.jus.uio.no/sisu/man/sisu.1.html > -

-
.
From sometime after SiSU 0.58 it should be possible to describe 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. -

-
.
-
files should be prepared using -

+

.
files -
UTF-8 -

+
should be prepared using UTF-8 character encoding +

.
a footnote or endnote -
character encoding -

-
.
-
a footnote or endnote -

-
.
self contained endnote marker & endnote in one -

- +

.
self contained endnote marker & endnote in one +

*.
-
unnumbered asterisk footnote/endnote, insert multiple asterisks if required - -

-
+
unnumbered asterisk +footnote/endnote, insert multiple asterisks if required +

**.
-
another unnumbered asterisk footnote/endnote -

-
+
another unnumbered + +
asterisk footnote/endnote +

*3.
-
editors notes, numbered asterisk footnote/endnote series -

-
+
editors notes, numbered asterisk footnote/endnote + +
series +

+2.

editors notes, numbered asterisk footnote/endnote series -

+

.
<http://www.sisudoc.org/ > -

-
.
<http://www.ruby-lang.org/en/ +

.
<http://www.ruby-lang.org/en/ > -

-
.
-
Table from the Wealth of Networks by Yochai Benkler -

-<http://www.jus.uio.no/sisu/the_wealth_of_networks.yochai_benkler +

.
Table from the Wealth +of Networks by Yochai Benkler <http://www.jus.uio.no/sisu/the_wealth_of_networks.yochai_benkler > -

-
.
.ssc (for composite) is under consideration but ._sst makes clear that this -is not a regular file to be worked on, and thus less likely that people + +

.
.ssc (for composite) is under consideration but ._sst makes clear that +this is not a regular file to be worked on, and thus less likely that people will have "accidents", working on a .ssc file that is overwritten by subsequent processing. It may be however that when the resulting file is shared .ssc is an appropriate suffix to use. -

-
.
<http://www.postgresql.org/ +

.
SiSU has worked this way in the past, +though this was dropped as it was thought the complexity outweighed the +flexibility, however, the balance was rather fine and this behaviour could +be reinstated. +

.
<http://www.postgresql.org/ +> <http://advocacy.postgresql.org/ > -

-<http://advocacy.postgresql.org/ -> -

<http://en.wikipedia.org/wiki/Postgresql > -

-
.
<http://www.hwaci.com/sw/sqlite/ -> -

-<http://en.wikipedia.org/wiki/Sqlite +

.
<http://www.hwaci.com/sw/sqlite/ +> <http://en.wikipedia.org/wiki/Sqlite > -

-
.
<http://search.sisudoc.org + +

.
<http://search.sisudoc.org > -

-
.
(which could be extended further with current back-end). As regards scaling -of the database, it is as scalable as the database (here Postgresql) and -hardware allow. -

-
.
of this feature when demonstrated to an IBM software innovations evaluator -in 2004 he said to paraphrase: this could be of interest to us. We have -large document management systems, you can search hundreds of thousands -of documents and we can tell you which documents meet your search criteria, -but there is no way we can tell you without opening each document where -within each your matches are found. -

+

.
(which could be extended further with current +back-end). As regards scaling of the database, it is as scalable as the database +(here Postgresql) and hardware allow. +

.
of this feature when demonstrated +to an IBM software innovations evaluator in 2004 he said to paraphrase: +this could be of interest to us. We have large document management systems, +you can search hundreds of thousands of documents and we can tell you which +documents meet your search criteria, but there is no way we can tell you +without opening each document where within each your matches are found. +

diff --git a/data/doc/sisu/html/sisu4.1.html b/data/doc/sisu/html/sisu4.1.html index 345e574b..f7268daa 100644 --- a/data/doc/sisu/html/sisu4.1.html +++ b/data/doc/sisu/html/sisu4.1.html @@ -34,47 +34,44 @@ sisu [-CcFLSVvW]

sisu (--configure|--webrick|--sample-search-form)
Sisu - Manual,
-RALPH AMISSAH
- +RALPH AMISSAH
-
What is Sisu?
-
+
What +is Sisu?

Introduction - What is Sisu?
-
- -

-SiSU is a framework for document structuring, publishing (in multiple open -standard formats) and search, comprising of: (a) a lightweight document -structure and presentation markup syntax; and (b) an accompanying engine -for generating standard document format outputs from documents prepared -in sisu markup syntax, which is able to produce multiple standard outputs -(including the population of sql databases) that (can) share a common numbering -system for the citation of text within a document. -

-SiSU is developed under an open source, software libre license ( GPLv3 -). Its use case for development is work with medium to large document sets -and cope with evolving document formats/ representation technologies. Documents -are prepared once, and generated as need be to update the technical presentation -or add additional output formats. Various output formats (including search -related output) share a common mechanism for cross-output-format citation. -

-SiSU both defines a markup syntax and provides an engine that produces -open standards format outputs from documents prepared with SiSU markup. -From a single lightly prepared document sisu custom builds several standard -output formats which share a common (text object) numbering system for -citation of content within a document (that also has implications for search). -The sisu engine works with an abstraction of the document’s structure and -content from which it is possible to generate different forms of representation -of the document. Significantly SiSU markup is more sparse than html and -outputs which include HTML, EPUB, ODT (Open Document Format text), LaTeX, -landscape and portrait PDF, all of which can be added to and updated. SiSU -is also able to populate SQL type databases at an object level, which means -that searches can be made with that degree of granularity. -

-Source document preparation and output generation is a two step process: +
+
SiSU is a framework for document +structuring, publishing (in multiple open standard formats) and search, +comprising of: (a) a lightweight document structure and presentation markup +syntax; and (b) an accompanying engine for generating standard document +format outputs from documents prepared in sisu markup syntax, which is +able to produce multiple standard outputs (including the population of +sql databases) that (can) share a common numbering system for the citation +of text within a document. +
SiSU is developed under an open source, software +libre license ( GPLv3 ). Its use case for development is work with medium +to large document sets and cope with evolving document formats/ representation +technologies. Documents are prepared once, and generated as need be to update +the technical presentation or add additional output formats. Various output +formats (including search related output) share a common mechanism for +cross-output-format citation. +
SiSU both defines a markup syntax and provides +an engine that produces open standards format outputs from documents prepared +with SiSU markup. From a single lightly prepared document sisu custom builds +several standard output formats which share a common (text object) numbering +system for citation of content within a document (that also has implications +for search). The sisu engine works with an abstraction of the document’s +structure and content from which it is possible to generate different forms +of representation of the document. Significantly SiSU markup is more sparse +than html and outputs which include HTML, EPUB, ODT (Open Document Format +text), LaTeX, landscape and portrait PDF, all of which can be added to +and updated. SiSU is also able to populate SQL type databases at an object +level, which means that searches can be made with that degree of granularity. + +
Source document preparation and output generation is a two step process: (i) document source is prepared, that is, marked up in sisu markup syntax and (ii) the desired output subsequently generated by running the sisu engine against document source. Output representations if updated (in the @@ -90,41 +87,40 @@ Document output formats share a common object numbering system for locating content. This 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. -

-In preparing a SiSU document you optionally provide semantic information -related to the document in a document header, and in marking up the substantive -text provide information on the structure of the document, primarily indicating -heading levels and footnotes. You also provide information on basic text -attributes where used. The rest is automatic, sisu from this information -custom builds[^2] the different forms of output requested. -

-SiSU works with an abstraction of the document based on its structure which -is comprised of its headings[^3] and objects[^4], which enables SiSU to represent -the document in many different ways, and to take advantage of the strengths -of different ways of presenting documents. The objects are numbered, and -these numbers can be used to provide a common basis for citing material -within a document across the different output format types. This is significant -as page numbers are not well suited to the digital age, in web publishing, -changing a browser’s default font or using a different browser can mean -that text will appear on a different page; and publishing in different -formats, html, landscape and portrait pdf etc. again page numbers are not -useful to cite text. Dealing with documents at an object level together -with object numbering also has implications for search that SiSU is able -to take advantage of. -

-One of the challenges of maintaining documents is to keep them in a format -that allows use of them independently of proprietary platforms. Consider -issues related to dealing with legacy proprietary formats today and what -guarantee you have that old proprietary formats will remain (or can be -read without proprietary software/equipment) in 15 years time, or the way -the way in which html has evolved over its relatively short span of existence. -SiSU provides the flexibility of producing documents in multiple non-proprietary -open formats including HTML, EPUB, [^5] ODT, [^6] PDF [^7] ODF, [^8]. Whilst -SiSU relies on software, the markup is uncomplicated and minimalistic which -guarantees that future engines can be written to run against it. It is also -easily converted to other formats, which means documents prepared in SiSU -can be migrated to other document formats. Further security is provided -by the fact that the software itself, SiSU is available under GPLv3 a licence +
In preparing a SiSU +document you optionally provide semantic information related to the document +in a document header, and in marking up the substantive text provide information +on the structure of the document, primarily indicating heading levels and +footnotes. You also provide information on basic text attributes where used. +The rest is automatic, sisu from this information custom builds[^2] the +different forms of output requested. +
SiSU works with an abstraction of +the document based on its structure which is comprised of its headings[^3] +and objects[^4], which enables SiSU to represent the document in many different +ways, and to take advantage of the strengths of different ways of presenting +documents. The objects are numbered, and these numbers can be used to provide +a common basis for citing material within a document across the different +output format types. This is significant as page numbers are not well suited +to the digital age, in web publishing, changing a browser’s default font +or using a different browser can mean that text will appear on a different +page; and publishing in different formats, html, landscape and portrait +pdf etc. again page numbers are not useful to cite text. Dealing with documents +at an object level together with object numbering also has implications +for search that SiSU is able to take advantage of. +
One of the challenges +of maintaining documents is to keep them in a format that allows use of +them independently of proprietary platforms. Consider issues related to +dealing with legacy proprietary formats today and what guarantee you have +that old proprietary formats will remain (or can be read without proprietary +software/equipment) in 15 years time, or the way the way in which html +has evolved over its relatively short span of existence. SiSU provides the +flexibility of producing documents in multiple non-proprietary open formats +including HTML, EPUB, [^5] ODT, [^6] PDF [^7] ODF, [^8]. Whilst SiSU relies +on software, the markup is uncomplicated and minimalistic which guarantees +that future engines can be written to run against it. It is also easily +converted to other formats, which means documents prepared in SiSU can +be migrated to other document formats. Further security is provided by the +fact that the software itself, SiSU is available under GPLv3 a licence that guarantees that the source code will always be open, and free as in libre, which means that that code base can be used, updated and further developed as required under the terms of its license. Another challenge @@ -137,1150 +133,948 @@ related module has been updated repeatedly over the years, presumably when the World Wide Web Consortium (w3c) finalises HTML 5 which is currently under development, the HTML module will again be updated allowing all existing documents to be regenerated as HTML 5). -

-The document formats are written to the file-system and available for indexing -by independent indexing tools, whether off the web like Google and Yahoo -or on the site like Lucene and Hyperestraier. -

-SiSU also provides other features such as concordance files and document -content certificates, and the working against an abstraction of document -structure has further possibilities for the research and development of -other document representations, the availability of objects is useful for -example for topic maps and thesauri, together with the flexibility of SiSU -offers great possibilities. -

-SiSU is primarily for published works, which can take advantage of the -citation system to reliably reference its documents. SiSU works well in -a complementary manner with such collaborative technologies as Wikis, which -can take advantage of and be used to discuss the substance of content prepared -in SiSU. -

-<http://www.sisudoc.org/ +
The document formats are written +to the file-system and available for indexing by independent indexing tools, +whether off the web like Google and Yahoo or on the site like Lucene and +Hyperestraier. +
SiSU also provides other features such as concordance files +and document content certificates, and the working against an abstraction +of document structure has further possibilities for the research and development +of other document representations, the availability of objects is useful +for example for topic maps and thesauri, together with the flexibility +of SiSU offers great possibilities. +
SiSU is primarily for published works, +which can take advantage of the citation system to reliably reference its +documents. SiSU works well in a complementary manner with such collaborative +technologies as Wikis, which can take advantage of and be used to discuss +the substance of content prepared in SiSU. +
<http://www.sisudoc.org/ > -

-<http://www.jus.uio.no/sisu +
<http://www.jus.uio.no/sisu > -
+
Commands Summary
-

Description
-

-SiSU is a document publishing system, that from a simple single marked-up -document, produces multiple output formats including: plaintext, HTML, -XHTML, XML, EPUB, ODT ( OpenDocument ( ODF ) text), LaTeX, PDF, info, and -SQL ( PostgreSQL and SQLite ) , which share text object numbers ("object -citation numbering") and the same document structure information. For more -see: <http://sisudoc.org +
SiSU is a document publishing system, that +from a simple single marked-up document, produces multiple output formats +including: plaintext, HTML, XHTML, XML, EPUB, ODT ( OpenDocument ( ODF +) text), LaTeX, PDF, info, and SQL ( PostgreSQL and SQLite ) , which share +text object numbers ("object citation numbering") and the same document +structure information. For more see: <http://sisudoc.org > or <http://www.jus.uio.no/sisu > -
-
Document Processing -Command Flags
+ +
Document Processing Command Flags

-a [filename/wildcard]
-
produces plaintext with Unix linefeeds -and without markup, (object numbers are omitted), has footnotes at end -of each paragraph that contains them [ -A for output file] [see -e for endnotes]. -(Options include: --endnotes for endnotes --footnotes for footnotes at the -end of each paragraph --unix for unix linefeed (default) --msdos for msdos -linefeed) -

- -
-b [filename/wildcard]
-
see --xhtml -

+
produces plaintext +with Unix linefeeds and without markup, (object numbers are omitted), has +footnotes at end of each paragraph that contains them [ -A for equivalent +dos (linefeed) output file] [see -e for endnotes]. (Options include: --endnotes +for endnotes --footnotes for footnotes at the end of each paragraph --unix +for unix linefeed (default) --msdos for msdos linefeed)
+ +
-b [filename/wildcard] +
+
see --xhtml

--by-*
-
see --output-by-* -

+
see --output-by-*

-C
-
configure/initialise -shared output directory files initialize shared output directory (config -files such as css and dtd files are not updated if they already exist unless -modifier is used). -C --init-site configure/initialise site more extensive than --C on its own, shared output directory files/force update, existing shared -output config files such as css and dtd files are updated if this modifier -is used. -

+
configure/initialise shared output directory +files initialize shared output directory (config files such as css and +dtd files are not updated if they already exist unless modifier is used). +-C --init-site configure/initialise site more extensive than -C on its own, +shared output directory files/force update, existing shared output config +files such as css and dtd files are updated if this modifier is used.
-
-CC
-
see --configure -

+
-CC +
+
see --configure

-c [filename/wildcard]
-
see --color-toggle -

+
see --color-toggle
-
--color-toggle -[filename/wildcard]
-
screen toggle ansi screen colour on or off depending -on default set (unless -c flag is used: if sisurc colour default is set -to ’true’, output to screen will be with colour, if sisurc colour default -is set to ’false’ or is undefined screen output will be without colour). Alias +
--color
+
see --color-on
-
- -
c -
+
--color-off +
+
turn off color in output to terminal
-
--configure
-
configure/initialise shared output directory files initialize -shared output directory (config files such as css and dtd files are not -updated if they already exist unless modifier is used). The equivalent of: --C --init-site configure/initialise site, more extensive than -C on its own, -shared output directory files/force update, existing shared output config -files such as css and dtd files are updated if -CC is used. -

+
--color-on
+
turn on color in output to +terminal
-
--concordance -[filename/wildcard]
-
produces concordance (wordmap) a rudimentary index -of all the words in a document. (Concordance files are not generated for -documents of over 260,000 words unless this limit is increased in the file -sisurc.yml). Alias -w -

+
--color-toggle [filename/wildcard]
+
screen toggle ansi screen colour +on or off depending on default set (unless -c flag is used: if sisurc colour +default is set to ’true’, output to screen will be with colour, if sisurc +colour default is set to ’false’ or is undefined screen output will be without +colour). Alias -c
+ +
--configure
+
configure/initialise shared output directory +files initialize shared output directory (config files such as css and +dtd files are not updated if they already exist unless modifier is used). +The equivalent of: -C --init-site configure/initialise site, more extensive +than -C on its own, shared output directory files/force update, existing +shared output config files such as css and dtd files are updated if -CC +is used.
+ +
--concordance [filename/wildcard]
+
produces concordance (wordmap) +a rudimentary index of all the words in a document. (Concordance files are +not generated for documents of over 260,000 words unless this limit is +increased in the file sisurc.yml). Alias -w

-D [instruction] [filename]
-
see --pg -

+
see +--pg
-
-d [--db-[database type - (sqlite|pg)]] --[instruction] [filename]
+
-d [--db-[database type (sqlite|pg)]] --[instruction] [filename]

see --sqlite -

+ -
--dal [filename/wildcard/url] -
-
assumed for most other flags, creates new intermediate files for processing -(document abstraction) that is used in all subsequent processing of other -output. This step is assumed for most processing flags. To skip it see -n. - -
Alias -m -

+
--dal [filename/wildcard/url]
+
assumed for most other flags, creates new intermediate +files for processing (document abstraction) that is used in all subsequent +processing of other output. This step is assumed for most processing flags. +To skip it see -n. Alias -m

--delete [filename/wildcard]
-
see --zap -

+
see --zap
-
--dump[=directory_path] [filename/wildcard] -
-
places output in directory specified, if none is specified in the current -directory (pwd). Compare --redirect -

+
--dump[=directory_path] +[filename/wildcard]
+
places output in directory specified, if none is specified +in the current directory (pwd). Compare --redirect

-e [filename/wildcard]
-
see --epub -

- -
--epub -[filename/wildcard]
-
produces an epub document, [sisu version >=2 ] (filename.epub). +
see +--epub
-
Alias -e -
+
--epub [filename/wildcard]
+
produces an epub document, [sisu version +>=2 ] (filename.epub). Alias -e

--exc-*
-
exclude output feature, overrides configuration settings ---exc- ocn, (exclude object citation numbering, (switches off object citation -numbering ) , affects html (seg, scroll), epub, xhtml, xml, pdf) ; --exc-toc, -(exclude table of contents, affects html (scroll), epub, pdf) ; --exc-links-to-manifest, ---exc-manifest-links, (exclude links to manifest, affects html (seg, scroll)); ---exc-search-form, (exclude search form, affects html (seg, scroll), manifest); ---exc-minitoc, (exclude mini table of contents, affects html (seg), concordance, -manifest); --exc-manifest-minitoc, (exclude mini table of contents, affects -manifest); --exc-html-minitoc, (exclude mini table of contents, affects html -(seg), concordance); --exc-html-navigation, (exclude navigation, affects html -(seg)); --exc-html-navigation-bar, (exclude navigation bar, affects html (seg)); ---exc-html-search-form, (exclude search form, affects html (seg, scroll)); --exc-html-right-pane, -(exclude right pane/column, affects html (seg, scroll)); --exc-html-top-band, -(exclude top band, affects html (seg, scroll), concordance (minitoc forced -on to provide seg navigation)); --exc-segsubtoc (exclude sub table of contents, -affects html (seg), epub) ; see also --inc-* -

+
exclude output feature, overrides configuration +settings --exc-ocn, (exclude object citation numbering, (switches off object +citation numbering ) , affects html (seg, scroll), epub, xhtml, xml, pdf) +; --exc-toc, (exclude table of contents, affects html (scroll), epub, pdf) +; --exc-links-to-manifest, --exc-manifest-links, (exclude links to manifest, affects +html (seg, scroll)); --exc-search-form, (exclude search form, affects html +(seg, scroll), manifest); --exc-minitoc, (exclude mini table of contents, +affects html (seg), concordance, manifest); --exc-manifest-minitoc, (exclude +mini table of contents, affects manifest); --exc-html-minitoc, (exclude mini +table of contents, affects html (seg), concordance); --exc-html-navigation, +(exclude navigation, affects html (seg)); --exc-html-navigation-bar, (exclude +navigation bar, affects html (seg)); --exc-html-search-form, (exclude search +form, affects html (seg, scroll)); --exc-html-right-pane, (exclude right pane/column, +affects html (seg, scroll)); --exc-html-top-band, (exclude top band, affects +html (seg, scroll), concordance (minitoc forced on to provide seg navigation)); +--exc-segsubtoc (exclude sub table of contents, affects html (seg), epub) +; see also --inc-*

-F [--webserv=webrick]
-
see --sample-search-form +
see --sample-search-form
-
- -
-f [optional string part of filename]
-
see --find -

- -
--find [optional string part - of filename]
-
without match string, glob all .sst .ssm files in directory -(including language subdirectories). With match string, find files that -match given string in directory (including language subdirectories). Alias --f, --glob, -G -

+
-f [optional string +part of filename]
+
see --find
-
-G [optional string part of filename]
-
see --find -

+
--find [optional string part of filename]
+
without +match string, glob all .sst .ssm files in directory (including language subdirectories). +With match string, find files that match given string in directory (including +language subdirectories). Alias -f, --glob, -G
-
-g [filename/wildcard] +
-G [optional string part of filename]
-
-
see --git -

+
see --find
-
--git [filename/wildcard]
-
produces or updates markup source file -structure in a git repo (experimental and subject to change). Alias -g -

+
-g [filename/wildcard]
+
see --git
-
--glob -[optional string part of filename]
-
see --find -

+
--git [filename/wildcard]
+
produces +or updates markup source file structure in a git repo (experimental and +subject to change). Alias -g
-
-h [filename/wildcard]
+
--glob [optional string part of filename]

see +--find
-
- -
- -
html -
+
-h [filename/wildcard]
+
see --html

--harvest *.ss[tm]
-
makes two lists of sisu output based on the sisu -markup documents in a directory: list of author and authors works (year -and titles), and; list by topic with titles and author. Makes use of header -metadata fields (author, title, date, topic_register). Can be used with -maintenance (-M) and remote placement (-R) flags. -

+
makes two lists of +sisu output based on the sisu markup documents in a directory: list of +author and authors works (year and titles), and; list by topic with titles +and author. Makes use of header metadata fields (author, title, date, topic_register). +Can be used with maintenance (-M) and remote placement (-R) flags.
-
--help [topic]
-
provides help -on the selected topic, where topics (keywords) include: list, (com)mands, -short(cuts), (mod)ifiers, (env)ironment, markup, syntax, headers, headings, -endnotes, tables, example, customise, skin, (dir)ectories, path, (lang)uage, -db, install, setup, (conf)igure, convert, termsheet, search, sql, features, -license. -

+
--help [topic] +
+
provides help on the selected topic, where topics (keywords) include: list, +(com)mands, short(cuts), (mod)ifiers, (env)ironment, markup, syntax, headers, +headings, endnotes, tables, example, customise, skin, (dir)ectories, path, +(lang)uage, db, install, setup, (conf)igure, convert, termsheet, search, +sql, features, license.

--html [filename/wildcard]
-
produces html output, segmented text -with table of contents (toc.html and index.html) and the document in a single -file (scroll.html). Alias -h -

+
produces html output, segmented +text with table of contents (toc.html and index.html) and the document in +a single file (scroll.html). Alias -h

-I [filename/wildcard]
-
see --texinfo -

+
see --texinfo
-
-i [filename/wildcard] -
-
-
see --manpage -

+
-i +[filename/wildcard]
+
see --manpage

--inc-*
-
include output feature, overrides configuration settings, -(usually the default if none set), has precedence over --exc-* (exclude output -feature). Some detail provided under --exc-*, see --exc-* -

+
include output feature, overrides +configuration settings, (usually the default if none set), has precedence +over --exc-* (exclude output feature). Some detail provided under --exc-*, see +--exc-*
-
-j [filename/wildcard] -
-
copies images associated with a file for use by html, xhtml & xml outputs -(automatically invoked by --dump & redirect). -

+
-j [filename/wildcard]
+
copies images associated with a file for use +by html, xhtml & xml outputs (automatically invoked by --dump & redirect).
-
--keep-processing-files [filename/wildcard/url] +
-k
-
-
see --maintenance -

+
see --color-off
+ +
--keep-processing-files [filename/wildcard/url]
+
see --maintenance +

-L
-
prints license information. -

+
prints license information.
-
-M [filename/wildcard/url] -
-
-
see --maintenance -

+
-M [filename/wildcard/url]
+
see --maintenance +

-m [filename/wildcard/url]
-
see --dal (document abstraction -level/layer) -

+
see --dal (document abstraction level/layer)
-
--machine [filename/wildcard/url]
-
see --dal (document abstraction -level/layer) -

+
--machine +[filename/wildcard/url]
+
see --dal (document abstraction level/layer)
-
--maintenance [filename/wildcard/url]
-
maintenance mode, interim -processing files are preserved and their locations indicated. (also see --V). Aliases -M and --keep-processing-files. -

+
--maintenance +[filename/wildcard/url]
+
maintenance mode, interim processing files are +preserved and their locations indicated. (also see -V). Aliases -M and --keep-processing-files. +

--manpage [filename/wildcard]
-
produces -man page of file, not suitable for all outputs. Alias -i -

- -
-N [filename/wildcard/url] -
-
document digest or document content certificate ( DCC ) as md5 digest tree -of the document: the digest for the document, and digests for each object -contained within the document (together with information on software versions -that produced it) (digest.txt). -NV for verbose digest output to screen. -

- -
-n -[filename/wildcard/url]
-
skip the creation of intermediate processing files -(document abstraction) if they already exist, this skips the equivalent -of -m which is otherwise assumed by most processing flags. -

+
produces man page of file, not suitable for +all outputs. Alias -i
+ +
-N [filename/wildcard/url]
+
document digest or document +content certificate ( DCC ) as md5 digest tree of the document: the digest +for the document, and digests for each object contained within the document +(together with information on software versions that produced it) (digest.txt). +-NV for verbose digest output to screen.
+ +
-n [filename/wildcard/url]
+
skip the +creation of intermediate processing files (document abstraction) if they +already exist, this skips the equivalent of -m which is otherwise assumed +by most processing flags.

--no-*
-
see --exc-* - -

+
see --exc-*

-o [filename/wildcard/url]

see --odt -

+
--odf [filename/wildcard/url]
-
see --odt - -

+
see --odt

--odt [filename/wildcard/url]
-
output basic document in opendocument file -format (opendocument.odt). Alias -o -

+
output +basic document in opendocument file format (opendocument.odt). Alias -o
-
--output-by-*
-
select output directory structure -from 3 alternatives: --output-by-language, (language directory (based on language -code) with filetype (html, epub, pdf etc.) subdirectories); --output-by-filetype, -(filetype directories with language code as part of filename); --output-by-filename, -(filename directories with language code as part of filename). This is configurable. -Alias --by-* -

- -
-P [language_directory/filename language_directory]
-
see --po4a - -

- -
-p [filename/wildcard]
-
see --pdf -

+
--output-by-* +
+
select output directory structure from 3 alternatives: --output-by-language, +(language directory (based on language code) with filetype (html, epub, +pdf etc.) subdirectories); --output-by-filetype, (filetype directories with +language code as part of filename); --output-by-filename, (filename directories +with language code as part of filename). This is configurable. Alias --by-* +
-
--pdf [filename/wildcard]
-
produces LaTeX -pdf (portrait.pdf & landscape.pdf). Default paper size is set in config file, -or document header, or provided with additional command line parameter, -e.g. --papersize-a4 preset sizes include: ’A4’, U.S. ’letter’ and ’legal’ and book sizes -’A5’ and ’B5’ (system defaults to A4). Alias -p -

+
-P [language_directory/filename language_directory]
+
see --po4a
-
--pg [instruction] [filename] +
-p [filename/wildcard]
-
database PostgreSQL ( --pgsql may be used instead) possible instructions, -include: --createdb; --create; --dropall; --import [filename]; --update [filename]; ---remove [filename]; see database section below. Alias -D -

+
see --pdf
-
--po [language_directory/filename - language_directory]
+
--pdf [filename/wildcard]
+
produces LaTeX pdf (portrait.pdf & landscape.pdf). +Default paper size is set in config file, or document header, or provided +with additional command line parameter, e.g. --papersize-a4 preset sizes include: +’A4’, U.S. ’letter’ and ’legal’ and book sizes ’A5’ and ’B5’ (system defaults to A4). +Alias -p
+ +
--pg [instruction] [filename]
+
database PostgreSQL ( --pgsql may be +used instead) possible instructions, include: --createdb; --create; --dropall; +--import [filename]; --update [filename]; --remove [filename]; see database section +below. Alias -D
+ +
--po [language_directory/filename language_directory]

see --po4a -

- -
--po4a [language_directory/filename language_directory] -
-
produces .pot and po files for the file in the languages specified by the -language directory. SiSU markup is placed in subdirectories named with the -language code, e.g. en/ fr/ es/. The sisu config file must set the output -directory structure to multilingual. v3, experimental -

+ -
-Q [filename/wildcard] -
-
-
see --qrcode -

+
--po4a [language_directory/filename language_directory]
+
produces .pot and +po files for the file in the languages specified by the language directory. +SiSU markup is placed in subdirectories named with the language code, e.g. +en/ fr/ es/. The sisu config file must set the output directory structure +to multilingual. v3, experimental
-
-q [filename/wildcard]
-
see --quiet -

+
-Q [filename/wildcard]
+
see --qrcode
-
--qrcode [filename/wildcard] +
-q [filename/wildcard]
-
generate QR code image of metadata (used in manifest). v3 only. -

+
see --quiet
-
--quiet [filename/wildcard] -
-
quiet less output to screen. -

+
--qrcode [filename/wildcard]
+
generate QR code image of metadata +(used in manifest). v3 only.
+ +
--quiet [filename/wildcard]
+
quiet less output +to screen.

-R [filename/wildcard]
-
see --rsync -

+
see --rsync
-
-r [filename/wildcard] -
-
-
see --scp -

+
-r [filename/wildcard]
+
see --scp +

--redirect[=directory_path] [filename/wildcard]
-
places output in -subdirectory under specified directory, subdirectory uses the filename -(without the suffix). If no output directory is specified places the subdirectory -under the current directory (pwd). Compare --dump -

- -
--rsync [filename/wildcard] -
-
copies sisu output files to remote host using rsync. This requires that -sisurc.yml has been provided with information on hostname and username, -and that you have your "keys" and ssh agent in place. Note the behavior -of rsync different if -R is used with other flags from if used alone. Alone -the rsync --delete parameter is sent, useful for cleaning the remote directory -(when -R is used together with other flags, it is not). Also see --scp. Alias - -
- -
R -

+
places output in subdirectory +under specified directory, subdirectory uses the filename (without the +suffix). If no output directory is specified places the subdirectory under +the current directory (pwd). Compare --dump
+ +
--rsync [filename/wildcard]
+
copies +sisu output files to remote host using rsync. This requires that sisurc.yml +has been provided with information on hostname and username, and that you +have your "keys" and ssh agent in place. Note the behavior of rsync different +if -R is used with other flags from if used alone. Alone the rsync --delete +parameter is sent, useful for cleaning the remote directory (when -R is +used together with other flags, it is not). Also see --scp. Alias -R

-S

see --sisupod -

+
-S [filename/wildcard]
-
see --sisupod -

- -
-s [filename/wildcard] -
-
-
see --source -

- -
--sample-search-form [--webserv=webrick]
-
generate examples of (naive) -cgi search form for SQLite and PgSQL depends on your already having used -sisu to populate an SQLite and/or PgSQL database, (the SQLite version scans -the output directories for existing sisu_sqlite databases, so it is first -necessary to create them, before generating the search form) see -d -D and -the database section below. If the optional parameter --webserv=webrick is -passed, the cgi examples created will be set up to use the default port -set for use by the webrick server, (otherwise the port is left blank and -the system setting used, usually 80). The samples are dumped in the present -work directory which must be writable, (with screen instructions given -that they be copied to the cgi-bin directory). Alias -F -

- -
--scp [filename/wildcard] +
see --sisupod
+ +
-s [filename/wildcard]
+
see --source
+ +
--sample-search-form +[--webserv=webrick]
+
generate examples of (naive) cgi search form for SQLite +and PgSQL depends on your already having used sisu to populate an SQLite +and/or PgSQL database, (the SQLite version scans the output directories +for existing sisu_sqlite databases, so it is first necessary to create +them, before generating the search form) see -d -D and the database section +below. If the optional parameter --webserv=webrick is passed, the cgi examples +created will be set up to use the default port set for use by the webrick +server, (otherwise the port is left blank and the system setting used, +usually 80). The samples are dumped in the present work directory which +must be writable, (with screen instructions given that they be copied to +the cgi-bin directory). Alias -F
+ +
--scp [filename/wildcard]
+
copies sisu output +files to remote host using scp. This requires that sisurc.yml has been provided +with information on hostname and username, and that you have your "keys" +and ssh agent in place. Also see --rsync. Alias -r
+ +
--sqlite --[instruction] [filename]
-
copies sisu output files to remote host using scp. This requires that sisurc.yml -has been provided with information on hostname and username, and that you -have your "keys" and ssh agent in place. Also see --rsync. Alias -r -

- -
--sqlite ---[instruction] [filename]
-
database type set to SQLite, this produces one -of two possible databases, without additional database related instructions -it produces a discreet SQLite file for the document processed; with additional -instructions it produces a common SQLite database of all processed documents -that (come from the same document preparation directory and as a result) -share the same output directory base path (possible instructions include: ---createdb; --create; --dropall; --import [filename]; --update [filename]; --remove -[filename]); see database section below. Alias -d -

+
database type set to SQLite, this produces one of two possible databases, +without additional database related instructions it produces a discreet +SQLite file for the document processed; with additional instructions it +produces a common SQLite database of all processed documents that (come +from the same document preparation directory and as a result) share the +same output directory base path (possible instructions include: --createdb; +--create; --dropall; --import [filename]; --update [filename]; --remove [filename]); +see database section below. Alias -d

--sisupod
-
produces a sisupod -a zipped sisu directory of markup files including sisu markup source files -and the directories local configuration file, images and skins. Note: this -only includes the configuration files or skins contained in ./_sisu not -those in ~/.sisu -S [filename/wildcard] option. Note: (this
- option is tested only with zsh). Alias -S -

+
produces a sisupod a zipped +sisu directory of markup files including sisu markup source files and the +directories local configuration file, images and skins. Note: this only +includes the configuration files or skins contained in is tested only +with zsh). Alias -S

--sisupod [filename/wildcard]
-
produces -a zipped file of the prepared document specified along with associated -images, by default named sisupod.zip they may alternatively be named with -the filename extension .ssp This provides a quick way of gathering the relevant -parts of a sisu document which can then for example be emailed. A sisupod -includes sisu markup source file, (along with associated documents if a -master file, or available in multilingual versions), together with related -images and skin. SiSU commands can be run directly against a sisupod contained -in a local directory, or provided as a url on a remote site. As there is -a security issue with skins provided by other users, they are not applied -unless the flag --trust or --trusted is added to the command instruction, it -is recommended that file that are not your own are treated as untrusted. -The directory structure of the unzipped file is understood by sisu, and -sisu commands can be run within it. Note: if you wish to send multiple files, -it quickly becomes more space efficient to zip the sisu markup directory, -rather than the individual files for sending). See the -S option without -[filename/wildcard]. Alias -S -

+
produces a zipped file of +the prepared document specified along with associated images, by default +named sisupod.zip they may alternatively be named with the filename extension +.ssp This provides a quick way of gathering the relevant parts of a sisu +document which can then for example be emailed. A sisupod includes sisu +markup source file, (along with associated documents if a master file, +or available in multilingual versions), together with related images and +skin. SiSU commands can be run directly against a sisupod contained in a +local directory, or provided as a url on a remote site. As there is a security +issue with skins provided by other users, they are not applied unless the +flag --trust or --trusted is added to the command instruction, it is recommended +that file that are not your own are treated as untrusted. The directory +structure of the unzipped file is understood by sisu, and sisu commands +can be run within it. Note: if you wish to send multiple files, it quickly +becomes more space efficient to zip the sisu markup directory, rather than +the individual files for sending). See the -S option without [filename/wildcard]. +Alias -S

--source [filename/wildcard]
-
copies sisu markup -file to output directory. Alias -s -

- -
-T [filename/wildcard (*.termsheet.rb)] -
-
standard form document builder, preprocessing feature -

- -
-t [filename/wildcard] -
-
-
see --txt -

+
copies sisu markup file to output directory. +Alias -s
-
--texinfo [filename/wildcard]
-
produces texinfo and info file, (view -with pinfo). Alias -I -

+
-T [filename/wildcard (*.termsheet.rb)]
+
standard form document builder, +preprocessing feature
-
--txt [filename/wildcard]
-
produces plaintext with Unix -linefeeds and without markup, (object numbers are omitted), has footnotes -at end of each paragraph that contains them [ -A for output file] [see -e - for endnotes]. (Options include: --endnotes for endnotes --footnotes for footnotes -at the end of each paragraph --unix for unix linefeed (default) --msdos for -msdos linefeed). Alias -t -

+
-t [filename/wildcard]
+
see --txt
-
-U [filename/wildcard]
-
see --urls -

+
--texinfo [filename/wildcard] +
+
produces texinfo and info file, (view with pinfo). Alias -I
-
-u [filename/wildcard] +
--txt [filename/wildcard]
-
provides url mapping of output files for the flags requested for processing, +
produces plaintext with Unix linefeeds and without markup, (object numbers +are omitted), has footnotes at end of each paragraph that contains them +[ -A for equivalent dos (linefeed) output file] [see -e for endnotes]. (Options +include: --endnotes for endnotes --footnotes for footnotes at the end of each +paragraph --unix for unix linefeed (default) --msdos for msdos linefeed). Alias +-t
-
also see -U -
+
-U [filename/wildcard]
+
see --urls
-
--urls [filename/wildcard]
-
prints url output list/map for the -available processing flags options and resulting files that could be requested, -(can be used to get a list of processing options in relation to a file, -together with information on the output that would be produced), -u provides -url output mapping for those flags requested for processing. The default -assumes sisu_webrick is running and provides webrick url mappings where -appropriate, but these can be switched to file system paths in sisurc.yml. +
-u [filename/wildcard]
+
provides url mapping +of output files for the flags requested for processing, also see -U
-
Alias -U -
+
--urls +[filename/wildcard]
+
prints url output list/map for the available processing +flags options and resulting files that could be requested, (can be used +to get a list of processing options in relation to a file, together with +information on the output that would be produced), -u provides url output +mapping for those flags requested for processing. The default assumes sisu_webrick +is running and provides webrick url mappings where appropriate, but these +can be switched to file system paths in sisurc.yml. Alias -U

-V
-
on its own, provides SiSU version and environment information -(sisu --help env) -

- -
-V [filename/wildcard]
-
even more verbose than the -v flag. +
on its own, +provides SiSU version and environment information (sisu --help env)
-
+
-V [filename/wildcard] +
+
even more verbose than the -v flag.

-v

on its own, provides SiSU version information -

+ -
-v [filename/wildcard] -
-
-
see --verbose -

+
-v [filename/wildcard]
+
see --verbose

--v3 [filename/wildcard]
-
invokes the sisu v3 document parser/generator. -You may run sisu3 instead. -

+
invokes the sisu +v3 document parser/generator. You may run sisu3 instead.
-
--v4 [filename/wildcard]
-
invokes the sisu v4 document -parser/generator. This is the default and is normally omitted. -

- -
--verbose [filename/wildcard] +
--v4 [filename/wildcard]
-
provides verbose output of what is being generated, where output is placed -(and error messages if any), as with -u flag provides a url mapping of files -created for each of the processing flag requests. Alias -v -

+
invokes the sisu v4 document parser/generator. This is the default and is +normally omitted.
-
-W
-
see --webrick +
--verbose [filename/wildcard]
+
provides verbose output of +what is being generated, where output is placed (and error messages if +any), as with -u flag provides a url mapping of files created for each of +the processing flag requests. Alias -v
-
+
-W
+
see --webrick
-
-w [filename/wildcard]
-
see --concordance -

+
-w [filename/wildcard] +
+
see --concordance

--webrick
-
starts ruby’ s webrick webserver -points at sisu output directories, the default port is set to 8081 and -can be changed in the resource configuration files. [tip: the webrick server - requires link suffixes, so html output should be created using the -h option - rather than also, note -F webrick ]. Alias -W -

+
starts ruby’ s webrick webserver points at sisu +output directories, the default port is set to 8081 and can be changed +in the resource configuration files. [tip: the webrick server requires link +suffixes, so html output should be created using the -h option rather than +-H ; also, note -F webrick ]. Alias -W
-
--wordmap [filename/wildcard] -
-
-
see --concordance -

+
--wordmap [filename/wildcard]
+
see --concordance +

--xhtml [filename/wildcard]
-
produces xhtml/ XML output for -browser viewing (sax parsing). Alias -b -

+
produces xhtml/ XML output for browser viewing +(sax parsing). Alias -b

--xml-dom [filename/wildcard]
-
produces -XML output with deep document structure, in the nature of dom. Alias -X -
-
- -
--xml-sax [filename/wildcard]
-
produces XML output shallow structure (sax parsing). +
produces XML output with +deep document structure, in the nature of dom. Alias -X
-
Alias -x -
+
--xml-sax [filename/wildcard] +
+
produces XML output shallow structure (sax parsing). Alias -x
-
-X [filename/wildcard]
-
see --xml-dom -

+
-X [filename/wildcard] +
+
see --xml-dom

-x [filename/wildcard]
-
see --xml-sax - -

+
see --xml-sax

-Y [filename/wildcard]
-
produces a short sitemap entry for the document, -based on html output and the sisu_manifest. --sitemaps generates/updates the -sitemap index of existing sitemaps. (Experimental, [g,y,m announcement this - week]) -

+
produces +a short sitemap entry for the document, based on html output and the sisu_manifest. +--sitemaps generates/updates the sitemap index of existing sitemaps. (Experimental, +[g,y,m announcement this week])

-y [filename/wildcard]
-
produces an html summary of output generated -(hyperlinked to content) and document specific metadata (sisu_manifest.html). -This step is assumed for most processing flags. -

+
produces an html +summary of output generated (hyperlinked to content) and document specific +metadata (sisu_manifest.html). This step is assumed for most processing flags. +

-Z [filename/wildcard]
-
see - -
- -
- -
zap -

+
see --zap

--zap [filename/wildcard]
-
Zap, if used with other processing flags deletes -output files of the type about to be processed, prior to processing. If --Z is used as the lone processing related flag (or in conjunction with a -combination of -[mMvVq]), will remove the related document output directory. - -
Alias -Z -

+
Zap, if used with +other processing flags deletes output files of the type about to be processed, +prior to processing. If -Z is used as the lone processing related flag (or +in conjunction with a combination of -[mMvVq]), will remove the related +document output directory. Alias -Z

Command Line Modifiers
-

-
--no-
-
ocn [with --html --pdf or --epub] switches off object citation numbering. -Produce output without identifying numbers in margins of html or LaTeX -/pdf output. -

- -
--no-annotate
-
strips output text of editor endnotes[^*1] denoted +
--no-ocn
+
[with --html +--pdf or --epub] switches off object citation numbering. Produce output without +identifying numbers in margins of html or LaTeX /pdf output.
-
by asterisk or dagger/plus sign -
+
--no-annotate +
+
strips output text of editor endnotes[^*1] denoted by asterisk or dagger/plus +sign

--no-asterisk
-
strips output text of editor -endnotes[^*2] denoted by asterisk sign -

+
strips output text of editor endnotes[^*2] denoted by asterisk +sign

--no-dagger
-
strips output text of editor -endnotes[^+1] denoted by dagger/plus sign -

+
strips output text of editor endnotes[^+1] denoted by dagger/plus +sign

Database Commands
-
-

-dbi - database interface -

--D or --pgsql set for PostgreSQL -d or --sqlite default set for SQLite -d is modifiable -with --db=[database type (PgSQL or .I SQLite ) ] -
+
dbi - database interface +
-D or --pgsql set for PostgreSQL +-d or --sqlite default set for SQLite -d is modifiable with --db=[database type +(PgSQL or SQLite ) ]

--pg -v --createall
-
initial step, -creates required relations (tables, indexes) in existing PostgreSQL database -(a database should be created manually and given the same name as working -directory, as requested) (rb.dbi) [ -dv --createall .I SQLite equivalent] it -may be necessary to run sisu -Dv --createdb initially NOTE: at the present -time for PostgreSQL it may be necessary to manually create the database. -The command would be working directory name (without path)]. Please use -only alphanumerics and underscores. -

- -
--pg -v --import
-
[filename/wildcard] imports -data specified to PostgreSQL db (rb.dbi) [ -dv --import .I SQLite equivalent] - -

+
initial step, creates required relations +(tables, indexes) in existing PostgreSQL database (a database should be +created manually and given the same name as working directory, as requested) +(rb.dbi) [ -dv --createall SQLite equivalent] it may be necessary to run sisu +-Dv --createdb initially NOTE: at the present time for PostgreSQL it may be +necessary to manually create the database. The command would be directory +name (without path)]. Please use only alphanumerics and underscores.
+ +
--pg -v +--import
+
[filename/wildcard] imports data specified to PostgreSQL db (rb.dbi) +[ -dv --import SQLite equivalent]

--pg -v --update
-
[filename/wildcard] updates/imports specified data to PostgreSQL -db (rb.dbi) [ -dv --update .I SQLite equivalent] -

+
[filename/wildcard] updates/imports +specified data to PostgreSQL db (rb.dbi) [ -dv --update SQLite equivalent] +

--pg --remove
-
[filename/wildcard] -removes specified data to PostgreSQL db (rb.dbi) [ -d --remove .I SQLite equivalent] - -

+
[filename/wildcard] removes specified data to PostgreSQL db (rb.dbi) +[ -d --remove SQLite equivalent]

--pg --dropall
-
kills data" and drops ( PostgreSQL or SQLite ) db, tables & -indexes [ -d --dropall .I SQLite equivalent] -

-The -v is for verbose output. -

+
kills data" and drops ( PostgreSQL +or SQLite ) db, tables & indexes [ -d --dropall SQLite equivalent] +
The -v +is for verbose output.

Shortcuts, Shorthand for Multiple Flags
-

-
--update [filename/wildcard]
-
Checks existing file output and runs the flags -required to update this output. This means that if only html and pdf output -was requested on previous runs, only the -hp files will be applied, and -only these will be generated this time, together with the summary. This -can be very convenient, if you offer different outputs of different files, -and just want to do the same again. -

- -
-0 to -5 [filename or wildcard]
-
Default -shorthand mappings (for v3, note that the defaults can be changed/configured -in the sisurc.yml file): -

+
--update [filename/wildcard] +
+
Checks existing file output and runs the flags required to update this +output. This means that if only html and pdf output was requested on previous +runs, only the -hp files will be applied, and only these will be generated +this time, together with the summary. This can be very convenient, if you +offer different outputs of different files, and just want to do the same +again.
+ +
-0 to -5 [filename or wildcard]
+
Default shorthand mappings (for v3, +note that the defaults can be changed/configured in the sisurc.yml file): +

-0
-
-NQhewpotbxXyYv [this is the default action run - when no options are give, i.e. on ’sisu [filename]’] -

+
-NQhewpotbxXyYv [this is the default action run when no options are give, +i.e. on ’sisu [filename]’]

-1
-
-Qhewpoty -

+
-Qhewpoty

-2
-
-NQhewpotbxXy - -

+
-NQhewpotbxXy

-3
-
-NQhewpotbxXyY -

+
-NQhewpotbxXyY

-4
-
-NQhewpotbxXDyY --update -

+
-NQhewpotbxXDyY +--update

-5

-NQhewpotbxXDyYv --update -

-add -v for verbose mode and -c to toggle color state, e.g. sisu -2vc [filename - or wildcard] -

+
add -v for verbose mode and -c to toggle +color state, e.g. sisu -2vc [filename or wildcard] +
consider -u for appended -
consider -u for appended url info or -v for verbose output +
url info or -v for verbose output

-
Command Line -with Flags - Batch Processing
+
Command Line with Flags - Batch Processing
-

-In the data directory run sisu -mh filename or wildcard eg. "sisu -h cisg.sst" -or "sisu -h *.{sst,ssm}" to produce html version of all documents. -

-Running sisu (alone without any flags, filenames or wildcards) brings up -the interactive help, as does any sisu command that is not recognised. Enter -to escape.
+ In the data directory run sisu -mh filename or wildcard eg. "sisu -h cisg.sst" +or "sisu -h *.{sst,ssm}" to produce html version of all documents. +
Running +sisu (alone without any flags, filenames or wildcards) brings up the interactive +help, as does any sisu command that is not recognised. Enter to escape.
Help
-

+
Sisu Manual
-

-The most up to date information on sisu should be contained in the sisu_manual, -available at: -

- <http://sisudoc.org/sisu/sisu_manual/ ->
+
The most up to date information on sisu should be contained +in the sisu_manual, available at: +
<http://sisudoc.org/sisu/sisu_manual/ +> -

-The manual can be generated from source, found respectively, either within +
The manual can be generated from source, found respectively, either within the SiSU tarball or installed locally at: -

- ./data/doc/sisu/markup-samples/sisu_manual
- -

- /usr/share/doc/sisu/markup-samples/sisu_manual
- -

-move to the respective directory and type e.g.: -

- sisu sisu_manual.ssm
-
-
Sisu Man Pages
+
/usr/share/doc/sisu/markup-samples/sisu_manual -

-If SiSU is installed on your system usual man commands should be available, -try: -

- man sisu
+
move to the respective directory and type e.g.: +
sisu sisu_manual.ssm +
Sisu +Man Pages
-

-Most SiSU man pages are generated directly from sisu documents that are -used to prepare the sisu manual, the sources files for which are located -within the SiSU tarball at: -

- ./data/doc/sisu/markup-samples/sisu_manual
+
If SiSU is installed on your system usual man commands should +be available, try: +
man sisu +
Most SiSU man pages are generated directly +from sisu documents that are used to prepare the sisu manual, the sources +files for which are located within the SiSU tarball at: +
./data/doc/sisu/markup-samples/sisu_manual
-

-Once installed, directory equivalent to: -

- /usr/share/doc/sisu/markup-samples/sisu_manual
+
Once installed, directory equivalent to: +
/usr/share/doc/sisu/markup-samples/sisu_manual
-

-Available man pages are converted back to html using man2html: -

- /usr/share/doc/sisu/html/
+
Available man pages are converted back to html using man2html: +
/usr/share/doc/sisu/html/
-

- ./data/doc/sisu/html
+
./data/doc/sisu/html
-

-An online version of the sisu man page is available here: -

-* various sisu man pages <http://www.jus.uio.no/sisu/man/ +
An online version of the sisu man page is available here: +
* various +sisu man pages <http://www.jus.uio.no/sisu/man/ > [^9] -

-* sisu.1 <http://www.jus.uio.no/sisu/man/sisu.1.html -> [^10] -
-
Sisu Built-in Interactive -Help
- -

-This is particularly useful for getting the current sisu setup/environment -information: -

- sisu --help
- -

- sisu --help [subject]
- -

- sisu --help commands
- -

- sisu --help markup
- -

- sisu --help env [for feedback on the way your system is
- setup with regard to sisu ]
- -

- sisu -V [environment information, same as above command]
- -

- sisu (on its own provides version and some help information)
- -

-Apart from real-time information on your current configuration the SiSU -manual and man pages are likely to contain more up-to-date information than -the sisu interactive help (for example on commands and markup). -

-NOTE: Running the command sisu (alone without any flags, filenames or wildcards) -brings up the interactive help, as does any sisu command that is not recognised. -Enter to escape. -
-
Introduction to Sisu Markup[^11]
-
+
* sisu.1 <http://www.jus.uio.no/sisu/man/sisu.1.html +> +[^10] +
+
Sisu Built-in Interactive Help
+ +
This is particularly useful for getting +the current sisu setup/environment information: +
sisu --help +
sisu --help +[subject] +
sisu --help commands +
sisu --help markup +
sisu --help env [for +feedback on the way your system is setup with regard to sisu ]
+ +
sisu -V [environment information, same as above command] +
sisu (on its +own provides version and some help information) +
Apart from real-time information +on your current configuration the SiSU manual and man pages are likely +to contain more up-to-date information than the sisu interactive help (for +example on commands and markup). +
NOTE: Running the command sisu (alone +without any flags, filenames or wildcards) brings up the interactive help, +as does any sisu command that is not recognised. Enter to escape. +
Introduction +to Sisu Markup[^11]

Summary
-

-SiSU source documents are plaintext ( UTF-8 )[^12] files -

-All paragraphs are separated by an empty line. -

-Markup is comprised of: -

-* at the top of a document, the document header made up of semantic meta-data -about the document and if desired additional processing instructions (such -an instruction to automatically number headings from a particular level -down) -

-* followed by the prepared substantive text of which the most important -single characteristic is the markup of different heading levels, which -define the primary outline of the document structure. Markup of substantive -text includes: -

- * heading levels defines document structure
- -

- * text basic attributes, italics, bold etc.
- -

- * grouped text (objects), which are to be treated differently, such as -code
+
SiSU source documents are plaintext ( UTF-8 +)[^12] files +
All paragraphs are separated by an empty line. +
Markup is +comprised of: +
* at the top of a document, the document header made up +of semantic meta-data about the document and if desired additional processing +instructions (such an instruction to automatically number headings from +a particular level down) +
* followed by the prepared substantive text +of which the most important single characteristic is the markup of different +heading levels, which define the primary outline of the document structure. +Markup of substantive text includes: +
* 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.
- -

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

-To check the markup in a file: -

- sisu --identify [filename].sst
+
* footnotes/endnotes
-

- -
For brief descriptive summary of markup history -

- sisu --query-history
- -

-or if for a particular version: -

- sisu --query-0.38
+
* linked text and images +
* paragraph actions, such as indent, bulleted, +numbered-lists, etc. +
Some interactive help on markup is available, by typing +
sisu and selecting markup or sisu --help markup +
To check the markup in +a file: +
sisu --identify [filename].sst +
For brief descriptive summary of + +
markup history +
sisu --query-history +
or if for a particular version:
+sisu --query-0.38
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/ +
Online markup examples are available +together with the respective outputs produced from <http://www.jus.uio.no/sisu/SiSU/examples.html > - -

-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/ +or from <http://www.jus.uio.no/sisu/sisu_examples/ > - -

-an alternative presentation of markup syntax: /usr/share/doc/sisu/on_markup.txt.gz - +
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

Installed
-

-With SiSU installed sample skins may be found in: /usr/share/doc/sisu/markup-samples +
+ 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

Markup of 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: +
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:

% this would be a comment

Sample Header
+
This current document is loaded by a master document that +has a header similar to this one:

-This current document is loaded by a master document that has a header -similar to this one: -

-
% SiSU master 2.0 +
% SiSU master 4.0 @title: SiSU -:subtitle: Manual + :subtitle: Manual @creator: -:author: Amissah, Ralph -@publisher: [publisher name] + :author: Amissah, Ralph +@publisher: [publisher name] @rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 @classify: -:type: information -:topic_register: SiSU:manual;electronic documents:SiSU:manual -:subject: ebook, epublishing, electronic book, electronic publishing, + :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 + :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 + :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] . sisu --v4 [operations] . sisu --v3 [operations] @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/?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 + { 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/?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

Available Headers
-

-Header tags appear at the beginning of a document and provide meta information -on the document (such as the Dublin Core ) , or information as to how the -document as a whole is to be processed. All header instructions take the -form @headername: or on the next line and indented by once space :subheadername: +
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 +
+ @indentifier: information or instructions +
where the "identifier" is +a tag recognised by the program, and the "information" or "instructions" -
All Dublin Core meta tags are available -

-@indentifier: information or instructions -

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

-Note: a header where used should only be used once; all headers apart from -@title: are optional; the @structure: header is used to describe document -structure, and can be useful to know. -

+
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 +
This is a sample header

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

-
@title: [title text] [this header is the only one that is mandatory] - :subtitle: [subtitle if any] +
@title: [title text] [this header is the only one that is mandatory] + :subtitle: [subtitle if any] :language: English

@creator: -:author: [Lastname, First names] -:illustrator: [Lastname, First names] -:translator: [Lastname, First names] -:prepared_by: [Lastname, First names] + :author: [Lastname, First names] + :illustrator: [Lastname, First names] + :translator: [Lastname, First names] + :prepared_by: [Lastname, First names]

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

@rights: -:copyright: Copyright (C) [Year and Holder] -:license: [Use License granted] -:text: [Year and Holder] -:translation: [Name, Year] -:illustrations: [Name, Year] + :copyright: Copyright (C) [Year and Holder] + :license: [Use License granted] + :text: [Year and Holder] + :translation: [Name, Year] + :illustrations: [Name, Year]

@classify: -:topic_register: SiSU:markup sample:book;book:novel:fantasy -:type: -:subject: -:description: -:keywords: -:abstract: -:loc: [Library of Congress classification] -:dewey: Dewey classification + :topic_register: SiSU:markup sample:book;book:novel:fantasy + :type: + :subject: + :description: + :keywords: + :abstract: + :loc: [Library of Congress classification] + :dewey: [Dewey classification

@identify: -:isbn: [ISBN] -:oclc: + :isbn: [ISBN] + :oclc:

@links: { SiSU }http://www.sisudoc.org @@ -1288,62 +1082,58 @@ structure, and can be useful to know.

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

@original: -:language: [language] + :language: [language]

@notes: -:comment: -:prefix: [prefix is placed just after table of contents] + :comment: + :prefix: [prefix is placed just after table of contents]

Markup of Substantive Text
-

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 - +
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 @@ -1353,15 +1143,14 @@ html segments are made)

Font Attributes
-

-markup example: +
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] +*{emphasis}* [note: can be configured to be represented by bold, italics +or underscore] !{bold text}! /{italics}/ _{underscore}_ @@ -1372,86 +1161,58 @@ _{underscore}_ -{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 italics - or underscore] or underscore] -

- -
bold text -

+
resulting output: +
normal text, emphasis, bold text , italics, underscore, +"citation", ^superscript^, [subscript], ++inserted text++, --strikethrough--, -
italics -

+
monospace +
normal text +
emphasis [note: can be configured to be represented +by bold, italics or underscore] +
bold text +
italics +
underscore +
"citation" -
underscore -

-"citation" -

-^superscript^ -

-[subscript] -

-++inserted text++ -

---strikethrough-- -

+
^superscript^ +
[subscript] +
++inserted text++ +
--strikethrough-- +
monospace -
monospace

Indentation and Bullets
-

-markup example: +
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
+
resulting output: +
ordinary paragraph +
indent paragraph one step
-

- indent paragraph two steps
+
indent paragraph two steps
-

- indent paragraph nine steps
+
indent paragraph nine steps
-

-markup example: +
markup example:

_* bullet text _1* bullet text, first indent _2* bullet text, two step indent
-

-resulting output: -

-* bullet text -

- * bullet text, first indent
+
resulting output: +
* bullet text +
* bullet text, first indent
-

- * bullet text, two step indent
+
* bullet text, two step indent
-

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

-markup example: +
markup example:

# numbered list numbered list 1., 2., 3, etc. _# numbered list numbered list indented a., b., c., d., etc. @@ -1459,8 +1220,7 @@ _# numbered list numbered list indented a., b., c., d., etc.

Hanging Indents
-

-markup example: +
markup example:

_0_1 first line no indent, rest of paragraph indented one step @@ -1468,125 +1228,127 @@ _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
- -

+
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.
+ .I 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.
-
in each case level may be 0-9 -

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 +
Footnotes and endnotes are marked up at the location +where they would be indicated within a text. They are automatically numbered. -
determines whether footnotes or endnotes will be produced -

-markup example: +
The output type determines whether footnotes or endnotes will be produced + +
markup example:

~{ a footnote or endnote }~
-

-resulting output: -

-[^13] -

-markup example: +
resulting output: +
[^13] +
markup example:

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

-resulting output: -

-normal text[^14] continues -

-markup example: +
resulting output: +
normal text[^14] continues +
markup example:

normal text ~{* unnumbered asterisk footnote/endnote, insert multiple asterisks if required }~ continues normal text ~{** another unnumbered asterisk footnote/endnote }~ continues
+
resulting output: +
normal text [^*] continues +
normal text [^**] continues + +
markup example:

-resulting output: -

-normal text [^*] continues -

-normal text [^**] continues -

-markup example: -

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

-resulting output: -

-normal text [^*3] continues -

-normal text [^+2] continues -

-Alternative endnote pair notation for footnotes/endnotes: +
resulting output: +
normal text [^*3] continues +
normal text [^+2] continues + +
Alternative endnote pair notation for footnotes/endnotes:

% note the endnote marker "~^" normal text~^ continues ^~ endnote text following the paragraph in which the marker occurs
-

- -
the standard and pair notation cannot be mixed in the same document +
the standard and pair notation cannot be mixed in the same document
+
Links

-
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: +
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 http://www.sisudoc.org/ continues
-

-resulting output: -

-normal text <http://www.sisudoc.org/ +
resulting output: +
normal text <http://www.sisudoc.org/ > continues -

+
An -
An escaped url without decoration -

-markup example: +
escaped url without decoration +
markup example:

normal text _http://www.sisudoc.org/ continues deb _http://www.jus.uio.no/sisu/archive unstable main non-free
-

-resulting output: -

-normal text <_http://www.sisudoc.org/ +
resulting output: +
normal text <_http://www.sisudoc.org/ > continues -

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

-where a code block is used there is neither decoration nor hyperlinking, +
where a code block +is used there is neither decoration nor hyperlinking, code blocks are discussed -
code blocks are discussed later in this document -

-resulting output: +
later in this document +
resulting output:

deb http://www.jus.uio.no/sisu/archive unstable main non-free deb-src http://www.jus.uio.no/sisu/archive unstable main non-free @@ -1594,63 +1356,50 @@ deb-src http://www.jus.uio.no/sisu/archive unstable main non-free

Linking Text
-

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

-markup example: +
markup example:

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

-resulting output: -

-aboutSiSU <http://www.sisudoc.org/ +
resulting output: +
aboutSiSU <http://www.sisudoc.org/ > markup -

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

-markup example: +
markup example:

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

-resulting output: -

-aboutSiSU <http://www.sisudoc.org/ +
resulting output: +
aboutSiSU <http://www.sisudoc.org/ > [^15] markup -

-Internal document links to a tagged location, including an ocn -

-markup example: +
Internal +document links to a tagged location, including an ocn +
markup example: +

about { text links }#link_text
-

-resulting output: -

-about ⌠text links⌡⌈link_text⌋ -

+
resulting output: +
about ⌠text links⌡⌈link_text⌋ +
Shared document -
Shared document collection link -

-markup example: +
collection link +
markup example:

about { SiSU book markup examples }:SiSU/examples.html
-

-resulting output: -

-about ⌠ SiSU book markup examples⌡⌈:SiSU/examples.html⌋ +
resulting output: +
about ⌠ SiSU book markup examples⌡⌈:SiSU/examples.html⌋ +
-
Linking -Images
+
Linking Images
-

-markup example: +
markup example:

{ tux.png 64x80 }image % various url linked images @@ -1659,48 +1408,41 @@ Images and Ruby" }http://www.sisudoc.org/ {~^ ruby_logo.png "Ruby" }http://www.ruby-lang.org/en/
-

-resulting output: -

-[ tux.png ] -

-tux.png 64x80 "Gnu/Linux - a better way" <http://www.sisudoc.org/ +
resulting output: +
[ tux.png ] +
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/ +
GnuDebianLinuxRubyBetterWay.png 100x101 "Way Better +- with Gnu/Linux, Debian and Ruby" <http://www.sisudoc.org/ > -

-ruby_logo.png 70x90 "Ruby" <http://www.ruby-lang.org/en/ +
ruby_logo.png +70x90 "Ruby" <http://www.ruby-lang.org/en/ > [^16] -

+
linked url footnote shortcut -
linked url footnote shortcut

-
{~^ [text to link] }http://url.org -% maps to: { [text to link] }http://url.org ~{ http://url.org }~ +
{~^ [text to link] }http://url.org +% maps to: { [text to link] }http://url.org ~{ http://url.org }~ % which produces hyper-linked text within a document/paragraph, with an endnote providing the url for the text location used in the hyperlink

text marker *~name
-

-note at a heading level the same is automatically achieved by providing +
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. -
-
Link Shortcut for -Multiple Versions of a Sisu Document in the Same Directory
+
Link Shortcut for Multiple +Versions of a Sisu Document in the Same Directory
TREE -

-markup example: +
markup example: +

!_ /{"Viral Spiral"}/, David Bollier { "Viral Spiral", David Bollier [3sS]}viral_spiral.david_bollier.sst
-

- Viral Spiral, David Bollier +
Viral Spiral, David Bollier
"Viral Spiral", David Bollier <http://corundum/sisu_manual/en/manifest/viral_spiral.david_bollier.html > document manifest <http://corundum/sisu_manual/en/manifest/viral_spiral.david_bollier.html @@ -1738,11 +1480,9 @@ TREE

Tables
-

+
Tables may be prepared in two either of two forms -
Tables may be prepared in two either of two forms -

-markup example: +
markup example:

table{ c3; 40; 30; 30; This is a table @@ -1753,19 +1493,16 @@ 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』 -

+
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』 +
a second form may -
a second form may be easier to work with in cases where there is not much +
be easier to work with in cases where there is not much information in -
information in each column -

-markup example: [^18] -

+
each column +
markup example: [^17]

!_ 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 @@ -1782,31 +1519,26 @@ No. of articles, all languages | 25| 19,000| 138,000| 490,000| 862,0 * 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 +
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. +
* Contributed +at least ten times; ** at least 5 times in last month; *** more than 100 +times in last month.

Poem
-

-basic markup: +
basic markup:

poem{ Your poem here }poem Each verse in a poem is given an object number.
-

-markup example: +
markup example:

poem{ ‘Fury said to a @@ -1855,8 +1587,7 @@ Each verse in a poem is given an object number. death."’ }poem
-

-resulting output: +
resulting output:
‘Fury said to a
mouse, That he
met in the
@@ -1905,16 +1636,14 @@ Each verse in a poem is given an object number.

Group
-

-basic markup: +
basic markup:

group{ Your grouped text here }group A group is treated as an object and given a single object number.
-

-markup example: +
markup example:

group{ ‘Fury said to a @@ -1963,8 +1692,7 @@ A group is treated as an object and given a single object number. death."’ }group
-

-resulting output: +
resulting output:
‘Fury said to a
mouse, That he
met in the
@@ -2013,18 +1741,16 @@ A group is treated as an object and given a single object number.

Code
-

-Code tags code{ ... }code (used as with other group tags described above) -are used to escape regular sisu markup, and have been used extensively +
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: +
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 @@ -2071,8 +1797,7 @@ option to number each line of code may to death."’
-

-From SiSU 2.7.7 on you can number codeblocks by placing a hash after the +
From SiSU 2.7.7 on you can number codeblocks by placing a hash after the opening code tag code{# as demonstrated here:

1 | ‘Fury said to a @@ -2127,8 +1852,7 @@ opening code tag code{# as demonstrated here:
Line-breaks

-
-To break a line within a "paragraph object", two backslashes \\ with a space + 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", @@ -2136,30 +1860,26 @@ 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). +
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).

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 =\= or breaks the page, starts a new page. -

-page break -\- or breaks a column, starts a new column, if using columns, -else breaks the page, starts a new page. +
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 =\= +or breaks the page, starts a new page. +
page break -\- or breaks a column, +starts a new column, if using columns, else breaks the page, starts a new +page.

-\\- or <:pb>
-

- -
or +
or

=\\= or @@ -2168,50 +1888,43 @@ or

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

+
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 +
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: +
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. +
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: +
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 +
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+1|second sub-term} A paragraph that continues discussion of the first sub-term
-

-The plus one in the example provided indicates the first sub-term spans +
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:

@@ -2221,97 +1934,88 @@ be:

Composite Documents Markup
-
-

-It is possible to build a document by creating a master document that requires -other documents. The documents required may be complete documents that could -be generated independently, or they could be markup snippets, prepared -so as to be easily available to be placed within another text. If the calling -document is a master document (built from other documents), it should be -named with the suffix .ssm Within this document you would provide information -on the other documents that should be included within the text. These may -be other documents that would be processed in a regular way, or markup -bits prepared only for inclusion within a master document .sst regular markup -file, or .ssi (insert/information) A secondary file of the composite document - -
is built prior to processing with the same prefix and the suffix ._sst -
-
+
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) -
basic markup for importing a document into a master document +
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. +
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.

Sisu Filetypes
-
-

-SiSU has plaintext and binary filetypes, and can process either type of -document. +
SiSU has +plaintext and binary filetypes, and can process either type of document. +

.sst .ssm .ssi Marked Up Plain Text

-
SiSU¤b〕 documents are prepared -as plain-text (utf-8) files with
-
SiSU markup. They may make reference to and -contain images (for example), which are stored in the directory beneath -them _sisu/image. 〔b¤SiSU plaintext markup files are of three types that -may be distinguished by the file extension used: regular text .sst; master -documents, composite documents that incorporate other text, which can be -any regular text or text insert; and inserts the contents of which are -like regular text except these are marked .ssi and are not processed.
- -

-SiSU processing can be done directly against a sisu documents; which may -be located locally or on a remote server for which a url is provided. -

-SiSU source markup can be shared with the command: -

- sisu -s [filename]
- +
SiSU
+
documents are prepared as plain-text +(utf-8) files with SiSU markup. They may make reference to and contain images +(for example), which are stored in the directory beneath them _sisu/image. +〔b¤SiSU plaintext markup files are of three types that may be distinguished +by the file extension used: regular text .sst; master documents, composite +documents that incorporate other text, which can be any regular text or +text insert; and inserts the contents of which are like regular text except +these are marked .ssi and are not processed. +
SiSU processing can be done +directly against a sisu documents; which may be located locally or on a +remote server for which a url is provided. +
SiSU source markup can be shared +with the command: +
sisu -s [filename]

Sisu Text - Regular Files (.sst)
-

+
The most common form of document in SiSU, see the section on SiSU markup.

Sisu Master Files (.ssm)
-

-Composite documents which incorporate other SiSU documents which may be -either regular SiSU text .sst which may be generated independently, or inserts -prepared solely for the purpose of being incorporated into one or more -master documents. -

-The mechanism by which master files incorporate other documents is described -as one of the headings under under SiSU markup in the SiSU manual. -

-Note: Master documents may be prepared in a similar way to regular documents, -and processing will occur normally if a .sst file is renamed .ssm without -requiring any other documents; the .ssm marker flags that the document may -contain other documents. -

-Note: a secondary file of the composite document is built prior to processing -with the same prefix and the suffix ._sst [^19] +
Composite documents which incorporate other SiSU +documents which may be either regular SiSU text .sst which may be generated +independently, or inserts prepared solely for the purpose of being incorporated +into one or more master documents. +
The mechanism by which master files +incorporate other documents is described as one of the headings under under +SiSU markup in the SiSU manual. +
Note: Master documents may be prepared +in a similar way to regular documents, and processing will occur normally +if a .sst file is renamed .ssm without requiring any other documents; the +.ssm marker flags that the document may contain other documents. +
Note: +a secondary file of the composite document is built prior to processing +with the same prefix and the suffix ._sst [^18]

Sisu Insert Files (.ssi)

-
-Inserts are documents prepared solely for the purpose of being incorporated + Inserts are documents prepared solely for the purpose of being incorporated into one or more master documents. They resemble regular SiSU text files except they are ignored by the SiSU processor. Making a file a .ssi file is a quick and convenient way of flagging that it is not intended that @@ -2320,170 +2024,134 @@ the file should be processed on its own.
Sisupod, Zipped Binary Container (sisupod.zip, .ssp)
-

-A sisupod is a zipped SiSU text file or set of SiSU text files and any -associated images that they contain (this will be extended to include sound -and multimedia-files) +
A sisupod is a zipped SiSU text file or set of SiSU +text files and any associated images that they contain (this will be extended +to include sound and multimedia-files)

SiSU
-
plaintext files rely on a recognised directory -structure to find contents such as images associated with documents, but -all images for example for all documents contained in a directory are located -in the sub-directory _sisu/image. Without the ability to create a sisupod -it can be inconvenient to manually identify all other files associated +
plaintext files rely on a recognised +directory structure to find contents such as images associated with documents, +but all images for example for all documents contained in a directory are +located in the sub-directory _sisu/image. Without the ability to create a +sisupod it can be inconvenient to manually identify all other files associated with a document. A sisupod automatically bundles all associated files with the document that is turned into a pod. -

-The structure of the sisupod is such that it may for example contain a -single document and its associated images; a master document and its associated -documents and anything else; or the zipped contents of a whole directory -of prepared SiSU documents. -

-The command to create a sisupod is: -

- sisu -S [filename]
- -

-Alternatively, make a pod of the contents of a whole directory: -

- sisu -S
- -

-SiSU processing can be done directly against a sisupod; which may be located -locally or on a remote server for which a url is provided. -

-<http://www.sisudoc.org/sisu/sisu_commands +
The structure of the sisupod is +such that it may for example contain a single document and its associated +images; a master document and its associated documents and anything else; +or the zipped contents of a whole directory of prepared SiSU documents. + +
The command to create a sisupod is: +
sisu -S [filename] +
Alternatively, +make a pod of the contents of a whole directory: +
sisu -S +
SiSU processing +can be done directly against a sisupod; which may be located locally or +on a remote server for which a url is provided. +
<http://www.sisudoc.org/sisu/sisu_commands > -

-<http://www.sisudoc.org/sisu/sisu_manual + +
<http://www.sisudoc.org/sisu/sisu_manual >

Configuration
-

Configuration Files

+
Config.yml
-

-SiSU configration parameters are adjusted in the configuration file, which -can be used to override the defaults set. This includes such things as which -directory interim processing should be done in and where the generated -output should be placed. -

-The SiSU configuration file is a yaml file, which means indentation is -significant. -

-SiSU resource configuration is determined by looking at the following files -if they exist: -

- ./_sisu/v4/sisurc.yml
+
SiSU configration parameters are adjusted in the configuration +file, which can be used to override the defaults set. This includes such +things as which directory interim processing should be done in and where +the generated output should be placed. +
The SiSU configuration file is +a yaml file, which means indentation is significant. +
SiSU resource configuration +is determined by looking at the following files if they exist: +
./_sisu/v4/sisurc.yml
-

- ./_sisu/sisurc.yml
+
./_sisu/sisurc.yml
-

- ~/.sisu/v4/sisurc.yml
+
~/.sisu/v4/sisurc.yml
-

- ~/.sisu/sisurc.yml
+
~/.sisu/sisurc.yml
-

- /etc/sisu/v4/sisurc.yml
+
/etc/sisu/v4/sisurc.yml
-

- /etc/sisu/sisurc.yml
+
/etc/sisu/sisurc.yml
-

-The search is in the order listed, and the first one found is used. -

-In the absence of instructions in any of these it falls back to the internal +
The search is in the order listed, and the first one found is used. +
+ In the absence of instructions in any of these it falls back to the internal program defaults. -

-Configuration determines the output and processing directories and the -database access details. -

- -
If SiSU is installed a sample sisurc.yml may be found in /etc/sisu/sisurc.yml +
Configuration determines the output and processing directories +and the database access details. +
If SiSU is installed a sample sisurc.yml +
may be found in /etc/sisu/sisurc.yml

Sisu_document_make
-

-Most sisu document headers relate to metadata, the exception is the @make: -header which provides processing related information. The default contents -of the @make header may be set by placing them in a file sisu_document_make. - -

-The search order is as for resource configuration: -

- ./_sisu/v4/sisu_document_make
+
Most sisu document +headers relate to metadata, the exception is the @make: header which provides +processing related information. The default contents of the @make header +may be set by placing them in a file sisu_document_make. +
The search order +is as for resource configuration: +
./_sisu/v4/sisu_document_make
-

- ./_sisu/sisu_document_make
+
./_sisu/sisu_document_make
-

- ~/.sisu/v4/sisu_document_make
+
~/.sisu/v4/sisu_document_make
-

- ~/.sisu/sisu_document_make
+
~/.sisu/sisu_document_make
-

- /etc/sisu/v4/sisu_document_make
+
/etc/sisu/v4/sisu_document_make
-

- /etc/sisu/sisu_document_make
+
/etc/sisu/sisu_document_make
-

-A sample sisu_document_make can be found in the _sisu/ directory under +
A sample sisu_document_make can be found in the _sisu/ directory under along with the provided sisu markup samples.

Css - Cascading Style Sheets (for Html, Xhtml and Xml)
-
- -

-CSS files to modify the appearance of SiSU html, XHTML or XML may be placed -in the configuration directory: ./_sisu/css ; ~/.sisu/css or; /etc/sisu/css -and these will be copied to the output directories with the command sisu --CC. -

-The basic CSS file for html output is html. css, placing a file of that -name in directory _sisu/css or equivalent will result in the default file -of that name being overwritten. -

-HTML: html. css -

-XML DOM: dom.css -

-XML SAX: sax.css -

-XHTML: xhtml. css -

-The default homepage may use homepage.css or html. css -

-Under consideration is to permit the placement of a CSS file with a different -name in directory _sisu/css directory or equivalent.[^20] -
-
Organising Content -- Directory Structure and Mapping
-
-

-SiSU v3 has new options for the source directory tree, and output directory +
CSS files to modify the appearance of SiSU html, +XHTML or XML may be placed in the configuration directory: ./_sisu/css ; +~/.sisu/css or; /etc/sisu/css and these will be copied to the output directories +with the command sisu -CC. +
The basic CSS file for html output is html. css, +placing a file of that name in directory _sisu/css or equivalent will result +in the default file of that name being overwritten. +
HTML: html. css +
XML +DOM: dom.css +
XML SAX: sax.css +
XHTML: xhtml. css +
The default homepage +may use homepage.css or html. css +
Under consideration is to permit the +placement of a CSS file with a different name in directory _sisu/css directory +or equivalent.[^19] +
+
Organising Content - Directory Structure and Mapping
+ +
+ SiSU v3 has new options for the source directory tree, and output directory structures of which there are 3 alternatives.

Document Source Directory

-
-The document source directory is the directory in which sisu processing + The document source directory is the directory in which sisu processing commands are given. It contains the sisu source files (.sst .ssm .ssi), or (for sisu v3 may contain) subdirectories with language codes which contain the sisu source files, so all English files would go in subdirectory en/, @@ -2512,35 +2180,34 @@ is limited to langagues supported by XeTeX polyglosia.

Output Directory Root
-

-The output directory root can be set in the sisurc.yml file. Under the root, -subdirectories are made for each directory in which a document set resides. -If you have a directory named poems or conventions, that directory will -be created under the output directory root and the output for all documents -contained in the directory of a particular name will be generated to subdirectories +
The output +directory root can be set in the sisurc.yml file. Under the root, subdirectories +are made for each directory in which a document set resides. If you have +a directory named poems or conventions, that directory will be created +under the output directory root and the output for all documents contained +in the directory of a particular name will be generated to subdirectories beneath that directory (poem or conventions). A document will be placed in a subdirectory of the same name as the document with the filetype identifier stripped (.sst .ssm) -

-The last part of a directory path, representing the sub-directory in which -a document set resides, is the directory name that will be used for the -output directory. This has implications for the organisation of document -collections as it could make sense to place documents of a particular subject, -or type within a directory identifying them. This grouping as suggested -could be by subject (sales_law, english_literature); or just as conveniently -by some other classification (X University). The mapping means it is also -possible to place in the same output directory documents that are for organisational -purposes kept separately, for example documents on a given subject of two -different institutions may be kept in two different directories of the -same name, under a directory named after each institution, and these would -be output to the same output directory. Skins could be associated with each -institution on a directory basis and resulting documents will take on the -appropriate different appearance. +
The last part of a directory path, representing the +sub-directory in which a document set resides, is the directory name that +will be used for the output directory. This has implications for the organisation +of document collections as it could make sense to place documents of a +particular subject, or type within a directory identifying them. This grouping +as suggested could be by subject (sales_law, english_literature); or just +as conveniently by some other classification (X University). The mapping +means it is also possible to place in the same output directory documents +that are for organisational purposes kept separately, for example documents +on a given subject of two different institutions may be kept in two different +directories of the same name, under a directory named after each institution, +and these would be output to the same output directory. Skins could be associated +with each institution on a directory basis and resulting documents will +take on the appropriate different appearance.

Alternative Output Structures
-

-There are 3 possibile output structures described as being, by language, +
+ There are 3 possibile output structures described as being, by language, by filetype or by filename, the selection is made in sisurc.yml

#% output_dir_structure_by: language; filetype; or filename @@ -2552,18 +2219,15 @@ v2)

by Language
-

- -
The by language directory structure places output files -

-The by language directory structure separates output files by language +
The by language directory structure places output files +
+ The by language directory structure separates output files by language code (all files of a given language), and within the language directory by filetype. -

+
Its selection is configured in sisurc.yml +
output_dir_structure_by: -
Its selection is configured in sisurc.yml -

-output_dir_structure_by: language +
language

|-- en |-- epub @@ -2592,20 +2256,18 @@ output_dir_structure_by: language |-- rng ‘-- xsd
-

-#by: language subject_dir/en/manifest/filename.html +
#by: language subject_dir/en/manifest/filename.html

by Filetype
-

-The by filetype directory structure separates output files by filetype, -all html files in one directory pdfs in another and so on. Filenames are -given a language extension. -

+
The +by filetype directory structure separates output files by filetype, all +html files in one directory pdfs in another and so on. Filenames are given +a language extension. +
Its selection is configured in sisurc.yml +
output_dir_structure_by: -
Its selection is configured in sisurc.yml -

-output_dir_structure_by: filetype +
filetype

|-- epub |-- hashes @@ -2633,19 +2295,17 @@ output_dir_structure_by: filetype |-- xhtml ‘-- xml
-

-#by: filetype subject_dir/html/filename/manifest.en.html +
#by: filetype subject_dir/html/filename/manifest.en.html

by Filename
-

+
The by filename directory structure places most output of a particular file (the different filetypes) in a common directory. -

+
Its selection is -
Its selection is configured in sisurc.yml -

-output_dir_structure_by: filename +
configured in sisurc.yml +
output_dir_structure_by: filename

|-- epub |-- po4a @@ -2666,13 +2326,14 @@ output_dir_structure_by: filename |-- pod ‘-- viral_spiral.david_bollier
-

-#by: filename subject_dir/filename/manifest.en.html +
#by: filename subject_dir/filename/manifest.en.html

Remote Directories
-

-
% containing sub_directories named after the generated files from which +
+
+
./subject_name/ +% containing sub_directories named after the generated files from which they are made ./subject_name/src % contains shared source files text and binary e.g. sisu_manual.sst and sisu_manual.sst.zip @@ -2689,7 +2350,8 @@ they are made
Sisupod

-
% files stored at this level e.g. sisu_manual.sst +
./sisupod/ +% files stored at this level e.g. sisu_manual.sst ./sisupod/_sisu % configuration file e.g. sisurc.yml ./sisupod/_sisu/skin @@ -2704,60 +2366,52 @@ they are made

Homepages
-
- -

-SiSU is about the ability to auto-generate documents. Home pages are regarded -as custom built items, and are not created by SiSU. More accurately, SiSU -has a default home page, which will not be appropriate for use with other -sites, and the means to provide your own home page instead in one of two -ways as part of a site’s configuration, these being: -

-1. through placing your home page and other custom built documents in the -subdirectory _sisu/home/ (this probably being the easier and more convenient -option) -

-2. through providing what you want as the home page in a skin, -

-Document sets are contained in directories, usually organised by site or -subject. Each directory can/should have its own homepage. See the section -on directory structure and organisation of content. -
-
Home Page and Other -Custom Built Pages in a Sub-directory
- -

-Custom built pages, including the home page index.html may be placed within -the configuration directory _sisu/home/ in any of the locations that is -searched for the configuration directory, namely ./_sisu ; ~/_sisu ; /etc/sisu -From there they are copied to the root of the output directory with the -command: -

- sisu -CC
-
+
SiSU is about the ability to auto-generate +documents. Home pages are regarded as custom built items, and are not created +by SiSU. More accurately, SiSU has a default home page, which will not be +appropriate for use with other sites, and the means to provide your own +home page instead in one of two ways as part of a site’s configuration, +these being: +
1. through placing your home page and other custom built +documents in the subdirectory _sisu/home/ (this probably being the easier +and more convenient option) +
2. through providing what you want as the +home page in a skin, +
Document sets are contained in directories, usually +organised by site or subject. Each directory can/should have its own homepage. +See the section on directory structure and organisation of content. +
+
Home +Page and Other Custom Built Pages in a Sub-directory
+ +
Custom built pages, +including the home page index.html may be placed within the configuration +directory _sisu/home/ in any of the locations that is searched for the +configuration directory, namely ./_sisu ; ~/_sisu ; /etc/sisu From there +they are copied to the root of the output directory with the command: +
+ sisu -CC
Markup and Output Examples
-

Markup Examples
-

-Current markup examples and document output samples are provided off <http://sisudoc.org +
Current markup examples +and document output samples are provided off <http://sisudoc.org +> or <http://www.jus.uio.no/sisu > -or <http://www.jus.uio.no/sisu -> and in the sisu -markup-sample package available -off <http://sources.sisudoc.org +and in the sisu -markup-sample package available off <http://sources.sisudoc.org > -

-For some documents hardly any markup at all is required at all, other than -a header, and an indication that the levels to be taken into account by -the program in generating its output are. + +
For some documents hardly any markup at all is required at all, other +than a header, and an indication that the levels to be taken into account +by the program in generating its output are.

Sisu Markup Samples
-

-A few additional sample books prepared as sisu markup samples, output formats +
A few +additional sample books prepared as sisu markup samples, output formats to be generated using SiSU are contained in a separate package sisu -markup-samples. sisu -markup-samples contains books (prepared using sisu markup), that were released by their authors various licenses mostly different Creative Commons @@ -2766,320 +2420,284 @@ requirements that do not meet the Debian Free Software Guidelines for var reasons, most commonly that they require that the original substantive text remain unchanged, and sometimes that the works be used only non-commercially. -

-Accelerando, Charles Stross (2005) accelerando.charles_stross.sst -

-Alice’s Adventures in Wonderland, Lewis Carroll (1865) alices_adventures_in_wonderland.lewis_carroll.sst +
Accelerando, Charles Stross (2005) accelerando.charles_stross.sst +
Alice’s +Adventures in Wonderland, Lewis Carroll (1865) alices_adventures_in_wonderland.lewis_carroll.sst -

-CONTENT, Cory Doctorow (2008) content.cory_doctorow.sst -

-Democratizing Innovation, Eric von Hippel (2005) democratizing_innovation.eric_von_hippel.sst +
CONTENT, Cory Doctorow (2008) content.cory_doctorow.sst +
Democratizing +Innovation, Eric von Hippel (2005) democratizing_innovation.eric_von_hippel.sst -

-Down and Out in the Magic Kingdom, Cory Doctorow (2003) down_and_out_in_the_magic_kingdom.cory_doctorow.sst +
Down and Out in the Magic Kingdom, Cory Doctorow (2003) down_and_out_in_the_magic_kingdom.cory_doctorow.sst -

-For the Win, Cory Doctorow (2010) for_the_win.cory_doctorow.sst -

-Free as in Freedom - Richard Stallman’s Crusade for Free Software, Sam Williams +
For the Win, Cory Doctorow (2010) for_the_win.cory_doctorow.sst +
Free +as in Freedom - Richard Stallman’s Crusade for Free Software, Sam Williams (2002) free_as_in_freedom.richard_stallman_crusade_for_free_software.sam_williams.sst -

-Free as in Freedom 2.0 - Richard Stallman and the Free Software Revolution, +
Free as in Freedom 2.0 - Richard Stallman and the Free Software Revolution, Sam Williams (2002), Richard M. Stallman (2010) free_as_in_freedom_2.richard_stallman_and_the_free_software_revolution.sam_williams.richard_stallman.sst -

-Free Culture - How Big Media Uses Technology and the Law to Lock Down Culture -and Control Creativity, Lawrence Lessig (2004) free_culture.lawrence_lessig.sst +
Free Culture - How Big Media Uses Technology and the Law to Lock Down +Culture and Control Creativity, Lawrence Lessig (2004) free_culture.lawrence_lessig.sst -

-Free For All - How Linux and the Free Software Movement Undercut the High +
Free For All - How Linux and the Free Software Movement Undercut the High Tech Titans, Peter Wayner (2002) free_for_all.peter_wayner.sst -

-GNU GENERAL PUBLIC LICENSE v2, Free Software Foundation (1991) gpl2.fsf.sst - -

-GNU GENERAL PUBLIC LICENSE v3, Free Software Foundation (2007) gpl3.fsf.sst - -

-Gulliver’s Travels, Jonathan Swift (1726 / 1735) gullivers_travels.jonathan_swift.sst +
GNU GENERAL +PUBLIC LICENSE v2, Free Software Foundation (1991) gpl2.fsf.sst +
GNU GENERAL +PUBLIC LICENSE v3, Free Software Foundation (2007) gpl3.fsf.sst +
Gulliver’s +Travels, Jonathan Swift (1726 / 1735) gullivers_travels.jonathan_swift.sst -

-Little Brother, Cory Doctorow (2008) little_brother.cory_doctorow.sst -

-The Cathederal and the Bazaar, Eric Raymond (2000) the_cathedral_and_the_bazaar.eric_s_raymond.sst +
Little Brother, Cory Doctorow (2008) little_brother.cory_doctorow.sst +
+ The Cathederal and the Bazaar, Eric Raymond (2000) the_cathedral_and_the_bazaar.eric_s_raymond.sst -

-The Public Domain - Enclosing the Commons of the Mind, James Boyle (2008) +
The Public Domain - Enclosing the Commons of the Mind, James Boyle (2008)
the_public_domain.james_boyle.sst -

-The Wealth of Networks - How Social Production Transforms Markets and Freedom, -Yochai Benkler (2006) the_wealth_of_networks.yochai_benkler.sst -

-Through the Looking Glass, Lewis Carroll (1871) through_the_looking_glass.lewis_carroll.sst +
The Wealth of Networks - How Social Production +Transforms Markets and Freedom, Yochai Benkler (2006) the_wealth_of_networks.yochai_benkler.sst -

-Two Bits - The Cultural Significance of Free Software, Christopher Kelty +
Through the Looking Glass, Lewis Carroll (1871) through_the_looking_glass.lewis_carroll.sst + +
Two Bits - The Cultural Significance of Free Software, Christopher Kelty (2008) two_bits.christopher_kelty.sst -

-UN Contracts for International Sale of Goods, UN (1980) un_contracts_international_sale_of_goods_convention_1980.sst +
UN Contracts for International Sale +of Goods, UN (1980) un_contracts_international_sale_of_goods_convention_1980.sst -

-Viral Spiral, David Bollier (2008) viral_spiral.david_bollier.sst +
Viral Spiral, David Bollier (2008) viral_spiral.david_bollier.sst
-
Sisu Search -- Introduction
-
+
Sisu +Search - Introduction
-

-SiSU output can easily and conveniently be indexed by a number of standalone -indexing tools, such as Lucene, Hyperestraier. -

-Because the document structure of sites created is clearly defined, and +
SiSU output can easily and conveniently be indexed +by a number of standalone indexing tools, such as Lucene, Hyperestraier. + +
Because the document structure of sites created is clearly defined, and the text object citation system is available hypothetically at least, for all forms of output, it is possible to search the sql database, and either read results from that database, or just as simply map the results to the html output, which has richer text markup. -

-In addition to this SiSU has the ability to populate a relational sql type -database with documents at an object level, with objects numbers that are -shared across different output types, which make them searchable with that -degree of granularity. Basically, your match criteria is met by these documents -and at these locations within each document, which can be viewed within -the database directly or in various output formats. +
In addition to this SiSU has +the ability to populate a relational sql type database with documents at +an object level, with objects numbers that are shared across different +output types, which make them searchable with that degree of granularity. +Basically, your match criteria is met by these documents and at these locations +within each document, which can be viewed within the database directly +or in various output formats.

Sql
-

Populating Sql Type Databases
-

-SiSU feeds sisu markupd documents into sql type databases PostgreSQL [^21] -and/or SQLite [^22] database together with information related to document -structure. -

-This is one of the more interesting output forms, as all the structural +
SiSU feeds +sisu markupd documents into sql type databases PostgreSQL [^20] and/or SQLite +[^21] database together with information related to document structure. +
+ This is one of the more interesting output forms, as all the structural data of the documents are retained (though can be ignored by the user of the database should they so choose). All site texts/documents are (currently) streamed to four tables: -

- * one containing semantic (and other) headers, including, title, author,
- subject, (the
+
* one containing semantic (and other) headers, +including, title, author, subject, (the
.I Dublin Core.
..);
-

- * another the substantive texts by individual "paragraph" (or object) --
- along with structural information, each paragraph being identifiable +
* another the substantive texts by individual "paragraph" (or object) +- along with structural information, each paragraph being identifiable by its
paragraph number (if it has one which almost all of them do), and the
substantive text of each paragraph quite naturally being searchable (both in
formatted and clean text versions for searching); and
-

- * a third containing endnotes cross-referenced back to the paragraph from
- which they are referenced (both in formatted and clean text versions +
* a third containing endnotes cross-referenced back to the paragraph +from which they are referenced (both in formatted and clean text versions for
searching).
-

- * a fourth table with a one to one relation with the headers table contains
- full text versions of output, eg. pdf, html, xml, and
+
* a fourth table with a one to one relation with the headers table contains + full text versions of output, eg. pdf, html, xml, and
.I ascii.
-

-There is of course the possibility to add further structures. -

-At this level SiSU loads a relational database with documents chunked into -objects, their smallest logical structurally constituent parts, as text -objects, with their object citation number and all other structural information +
There is of course the possibility to add further structures. +
At this +level SiSU loads a relational database with documents chunked into objects, +their smallest logical structurally constituent parts, as text objects, +with their object citation number and all other structural information needed to construct the document. Text is stored (at this text object level) with and without elementary markup tagging, the stripped version being so as to facilitate ease of searching. -

-Being able to search a relational database at an object level with the -SiSU citation system is an effective way of locating content generated -by SiSU. As individual text objects of a document stored (and indexed) together -with object numbers, and all versions of the document have the same numbering, -complex searches can be tailored to return just the locations of the search -results relevant for all available output formats, with live links to the -precise locations in the database or in html/xml documents; or, the structural -information provided makes it possible to search the full contents of the -database and have headings in which search content appears, or to search -only headings etc. (as the Dublin Core is incorporated it is easy to make -use of that as well). +
Being able to search a relational +database at an object level with the SiSU citation system is an effective +way of locating content generated by SiSU. As individual text objects of +a document stored (and indexed) together with object numbers, and all versions +of the document have the same numbering, complex searches can be tailored +to return just the locations of the search results relevant for all available +output formats, with live links to the precise locations in the database +or in html/xml documents; or, the structural information provided makes +it possible to search the full contents of the database and have headings +in which search content appears, or to search only headings etc. (as the +Dublin Core is incorporated it is easy to make use of that as well).

Postgresql
-

-
Name
-

-SiSU - Structured information, Serialized Units - a document publishing system, +
Name
-
postgresql dependency package +
SiSU - Structured information, Serialized Units - a document publishing +system, postgresql dependency package

Description
-

-Information related to using postgresql with sisu (and related to the sisu_postgresql -dependency package, which is a dummy package to install dependencies needed -for SiSU to populate a postgresql database, this being part of SiSU - man -sisu) . +
Information related +to using postgresql with sisu (and related to the sisu_postgresql dependency +package, which is a dummy package to install dependencies needed for SiSU +to populate a postgresql database, this being part of SiSU - man sisu) . +

Synopsis
-

- sisu -D [instruction] [filename/wildcard if required]
- -

- sisu -D --pg --[instruction] [filename/wildcard if required]
- +
sisu -D [instruction] [filename/wildcard if required] +
sisu +-D --pg --[instruction] [filename/wildcard if required]

Commands
-

-Mappings to two databases are provided by default, postgresql and sqlite, -the same commands are used within sisu to construct and populate databases -however -d (lowercase) denotes sqlite and -D (uppercase) denotes postgresql, +
Mappings +to two databases are provided by default, postgresql and sqlite, the same +commands are used within sisu to construct and populate databases however +-d (lowercase) denotes sqlite and -D (uppercase) denotes postgresql, alternatively -
alternatively --sqlite or --pgsql may be used -

--D or --pgsql may be used interchangeably. +
- +
- +
sqlite or --pgsql may be used +
-D or --pgsql may be used interchangeably.
-
Create and Destroy Database
+
Create +and Destroy Database

-
--pgsql ---createall
-
initial step, creates required relations (tables, indexes) in -existing (postgresql) database (a database should be created manually and -given the same name as working directory, as requested) (rb.dbi) +
--pgsql --createall
+
initial step, creates required relations +(tables, indexes) in existing (postgresql) database (a database should +be created manually and given the same name as working directory, as requested) +(rb.dbi)

-
sisu -D ---createdb
+
sisu -D --createdb

creates database where no database existed before +

-
sisu -D --create -
-
-
creates database tables where no database tables existed before +
sisu -D --create
+
creates database tables where no database tables existed + +
before

-
sisu -D ---Dropall
-
destroys database (including all its content)! kills data and drops -tables, indexes and database associated with a given directory (and directories -of the same name). +
sisu -D --Dropall
+
destroys database (including all its content)! kills +data and drops tables, indexes and database associated with a given directory +(and directories of the same name).

sisu -D --recreate
-
destroys existing database and builds +
destroys existing database -
a new empty database structure +
and builds a new empty database structure

Import and Remove Documents

-
-
sisu -D --import --v [filename/wildcard]
-
populates database with the contents of the file. -Imports documents(s) specified to a postgresql database (at an object level). +
+
sisu -D --import -v [filename/wildcard]
+
populates database with the contents +of the file. Imports documents(s) specified to a postgresql database (at +an object level).

sisu -D --update -v [filename/wildcard]
-
updates file contents in database +
updates file contents +
in database

sisu -D --remove -v [filename/wildcard]
-
removes specified document from postgresql -database. +
removes specified document +from postgresql database.

Sqlite
-

Name
-

-SiSU - Structured information, Serialized Units - a document publishing system. - +
SiSU - Structured information, Serialized +Units - a document publishing system.

Description
-

-Information related to using sqlite with sisu (and related to the sisu_sqlite -dependency package, which is a dummy package to install dependencies needed -for SiSU to populate an sqlite database, this being part of SiSU - man sisu) -. +
Information related to +using sqlite with sisu (and related to the sisu_sqlite dependency package, +which is a dummy package to install dependencies needed for SiSU to populate +an sqlite database, this being part of SiSU - man sisu) .

Synopsis
-

- sisu -d [instruction] [filename/wildcard if required]
- -

- sisu -d --(sqlite|pg) --[instruction] [filename/wildcard if
- required]
- +
sisu +-d [instruction] [filename/wildcard if required] +
sisu -d --(sqlite|pg) --[instruction] +[filename/wildcard if required]

Commands
-

-Mappings to two databases are provided by default, postgresql and sqlite, -the same commands are used within sisu to construct and populate databases -however -d (lowercase) denotes sqlite and -D (uppercase) denotes postgresql, +
Mappings to two databases +are provided by default, postgresql and sqlite, the same commands are used +within sisu to construct and populate databases however -d (lowercase) denotes +sqlite and -D (uppercase) denotes postgresql, alternatively --sqlite or --pgsql -
alternatively --sqlite or --pgsql may be used -

--d or --sqlite may be used interchangeably. +
may be used +
-d or --sqlite may be used interchangeably.
-
Create and Destroy Database
+
Create and Destroy +Database

-
--sqlite ---createall
-
initial step, creates required relations (tables, indexes) in -existing (sqlite) database (a database should be created manually and given -the same name as working directory, as requested) (rb.dbi) +
--sqlite --createall
+
initial step, creates required relations (tables, +indexes) in existing (sqlite) database (a database should be created manually +and given the same name as working directory, as requested) (rb.dbi)

-
sisu -d --createdb -
-
-
creates database where no database existed before +
sisu +-d --createdb
+
creates database where no database existed before

-
sisu -d --create
-
creates - -
database tables where no database tables existed before +
sisu -d --create +
+
+
creates database tables where no database tables existed before

-
sisu -d --dropall -
-
destroys database (including all its content)! kills data and drops tables, -indexes and database associated with a given directory (and directories +
sisu -d +--dropall
+
destroys database (including all its content)! kills data and drops +tables, indexes and database associated with a given directory (and directories of the same name).

@@ -3114,43 +2732,38 @@ database.

Introduction
-

-
Search - Database Frontend Sample, Utilising Database and Sisu Features,
-INCLUDING -OBJECT CITATION NUMBERING (BACKEND CURRENTLY POSTGRESQL) -

-Sample search frontend <http://search.sisudoc.org -> [^23] A small database and -sample query front-end (search from) that makes use of the citation system, -object citation numbering to demonstrates functionality.[^24] -

-SiSU can provide information on which documents are matched and at what +
Search - Database Frontend Sample, Utilising Database +and Sisu Features,
+INCLUDING OBJECT CITATION NUMBERING (BACKEND CURRENTLY +POSTGRESQL) +
Sample search frontend <http://search.sisudoc.org +> [^22] A small +database and sample query front-end (search from) that makes use of the +citation system, .I object citation numbering to demonstrates functionality.[^23] + +
SiSU can provide information on which documents are matched and at what locations within each document the matches are found. These results are relevant across all outputs using object citation numbering, which includes html, XML, EPUB, LaTeX, PDF and indeed the SQL database. You can then refer to one of the other outputs or in the SQL database expand the text within the matched objects (paragraphs) in the documents matched. -

-Note you may set results either for documents matched and object number -locations within each matched document meeting the search criteria; or -display the names of the documents matched along with the objects (paragraphs) -that meet the search criteria.[^25] +
Note you may +set results either for documents matched and object number locations within +each matched document meeting the search criteria; or display the names +of the documents matched along with the objects (paragraphs) that meet +the search criteria.[^24]

sisu -F --webserv-webrick
-
builds a cgi web +
builds a cgi web search -
search frontend for the database created -

-The following is feedback on the setup on a machine provided by the help -command: -

- sisu --help sql
- -

+
frontend for the database created +
The following is feedback on the setup +on a machine provided by the help command: +
sisu --help sql

Postgresql user: ralph current db set: SiSU_sisu @@ -3160,156 +2773,138 @@ sqlite current db set: /home/ralph/sisu_www/sisu/sisu_sqlite.db dbi connect DBI:SQLite:/home/ralph/sisu_www/sisu/sisu_sqlite.db
-

- -
Note on databases built -

-By default, [unless otherwise specified] databases are built on a directory -basis, from collections of documents within that directory. The name of -the directory you choose to work from is used as the database name, i.e. -if you are working in a directory called /home/ralph/ebook the database -SiSU_ebook is used. [otherwise a manual mapping for the collection is -

+
Note on databases built +
By default, [unless otherwise specified] databases +are built on a directory basis, from collections of documents within that +directory. The name of the directory you choose to work from is used as +the database name, i.e. if you are working in a directory called /home/ralph/ebook +the database SiSU_ebook is used. [otherwise a manual mapping for the collection +is necessary]

-
Search -Form
+
Search Form

sisu -F
-
generates a sample search form, which must be copied to the +
generates a sample search form, which -
web-server cgi directory +
must be copied to the web-server cgi directory

sisu -F --webserv-webrick
-
generates a sample search -form for use with the webrick server, which must be copied to the web-server +
generates +a sample search form for use with the webrick server, which must be copied -
cgi directory +
to the web-server cgi directory

sisu -W
-
starts the webrick server which should be available +
starts the webrick server which -
wherever sisu is properly installed -

+
should be available wherever sisu is properly installed +
The generated -
The generated search form must be copied manually to the webserver directory +
search form must be copied manually to the webserver directory as instructed -
as instructed

Sisu_webrick
-

Name
-

-SiSU - Structured information, Serialized Units - a document publishing system +
SiSU - Structured information, Serialized Units - a document +
publishing system

Synopsis
-

-sisu_webrick [port] -

- -
or -

-sisu -W [port] +
sisu_webrick [port] +
or +
sisu -W [port]
+
Description
-

-sisu_webrick is part of SiSU (man sisu) sisu_webrick starts Ruby SiSU -output is written, providing a list of these directories (assuming SiSU -is in use and they exist). -

-The default port for sisu_webrick is set to 8081, this may be modified -in the yaml file: ~/.sisu/sisurc.yml a sample of which is provided as /etc/sisu/sisurc.yml -(or in the equivalent directory on your system). +
sisu_webrick is part of SiSU (man sisu) sisu_webrick starts +Ruby SiSU output is written, providing a list of these directories (assuming +SiSU is in use and they exist). +
The default port for sisu_webrick is set +to 8081, this may be modified in the yaml file: ~/.sisu/sisurc.yml a sample +of which is provided as /etc/sisu/sisurc.yml (or in the equivalent directory +on your system).

Summary of Man Page
-

-sisu_webrick, may be started on it’s own with the command: sisu_webrick -[port] or using the sisu command with the -W flag: sisu -W [port] -

- -
where no port is given and settings are unchanged the default port is 8081 +
sisu_webrick, may be started on it’s +own with the command: sisu_webrick [port] or using the sisu command with +the -W flag: sisu -W [port] +
where no port is given and settings are unchanged +
the default port is 8081

Document Processing Command Flags
-

-sisu -W [port] starts Ruby Webrick web-server, serving SiSU output directories, -on the port provided, or if no port is provided and the defaults have not +
sisu -W [port] +starts Ruby Webrick web-server, serving SiSU output directories, on the +port provided, or if no port is provided and the defaults have not been -
been changed in ~/.sisu/sisurc.yaml then on port 8081 +
changed in ~/.sisu/sisurc.yaml then on port 8081

Summary of Features
-
-

-* sparse/minimal markup (clean utf-8 source texts). Documents are prepared +
* +sparse/minimal markup (clean utf-8 source texts). Documents are prepared in a single UTF-8 file using a minimalistic mnemonic syntax. Typical literature, documents like "War and Peace" require almost no markup, and most of the headers are optional. -

-* markup is easily readable/parsable by the human eye, (basic markup is -simpler and more sparse than the most basic HTML ) , [this may also be - converted to .I XML representations of the same input/source document]. -
-
-* markup defines document structure (this may be done once in a header -pattern-match description, or for heading levels individually); basic text -attributes (bold, italics, underscore, strike-through etc.) as required; -and semantic information related to the document (header information, extended -beyond the Dublin core and easily further extended as required); the headers -may also contain processing instructions. SiSU markup is primarily an abstraction -of document structure and document metadata to permit taking advantage -of the basic strengths of existing alternative practical standard ways -of representing documents [be that browser viewing, paper publication, - sql search etc.] (html, epub, xml, odf, latex, pdf, sql) -

-* for output produces reasonably elegant output of established industry -and institutionally accepted open standard formats.[3] takes advantage of -the different strengths of various standard formats for representing documents, -amongst the output formats currently supported are: -

-* HTML - both as a single scrollable text and a segmented document -

-* XHTML -

-* EPUB -

-* XML - both in sax and dom style xml structures for further development - -
as required -

-* ODT - Open Document Format text, the iso standard for document storage - -

-* LaTeX - used to generate pdf -

-* PDF (via LaTeX ) -

-* SQL - population of an sql database ( PostgreSQL or SQLite ) , (at the -same object level that is used to cite text within a document) -

-Also produces: concordance files; document content certificates (md5 or -sha256 digests of headings, paragraphs, images etc.) and html manifests -(and sitemaps of content). (b) takes advantage of the strengths implicit -in these very different output types, (e.g. PDFs produced using typesetting -of LaTeX, databases populated with documents at an individual object/paragraph -level, making possible granular search (and related possibilities)) -

-* ensuring content can be cited in a meaningful way regardless of selected +
* markup is easily readable/parsable by the human +eye, (basic markup is simpler and more sparse than the most basic HTML +) , [this may also be converted to XML representations of the same input/source +document]. +
* markup defines document structure (this may be done once +in a header pattern-match description, or for heading levels individually); +basic text attributes (bold, italics, underscore, strike-through etc.) as +required; and semantic information related to the document (header information, +extended beyond the Dublin core and easily further extended as required); +the headers may also contain processing instructions. SiSU markup is primarily +an abstraction of document structure and document metadata to permit taking +advantage of the basic strengths of existing alternative practical standard +ways of representing documents [be that browser viewing, paper publication, +sql search etc.] (html, epub, xml, odf, latex, pdf, sql) +
* for output +produces reasonably elegant output of established industry and institutionally +accepted open standard formats.[3] takes advantage of the different strengths +of various standard formats for representing documents, amongst the output +formats currently supported are: +
* HTML - both as a single scrollable + +
text and a segmented document +
* XHTML +
* EPUB +
* XML - both in sax and + +
dom style xml structures for further development as required +
* ODT - Open +Document Format text, the iso standard for document storage +
* LaTeX - + +
used to generate pdf +
* PDF (via LaTeX ) +
* SQL - population of an sql +database ( PostgreSQL or SQLite ) , (at the same object level that is used +to cite text within a document) +
Also produces: concordance files; document +content certificates (md5 or sha256 digests of headings, paragraphs, images +etc.) and html manifests (and sitemaps of content). (b) takes advantage of +the strengths implicit in these very different output types, (e.g. PDFs produced +using typesetting of LaTeX, databases populated with documents at an individual +object/paragraph level, making possible granular search (and related possibilities)) + +
* ensuring content can be cited in a meaningful way regardless of selected output format. Online publishing (and publishing in multiple document formats) lacks a useful way of citing text internally within documents (important to academics generally and to lawyers) as page numbers are meaningless @@ -3319,229 +2914,178 @@ search engines). The outputs share a common numbering system that is meaningful (to man and machine) across all digital outputs whether paper, screen, or database oriented, (pdf, HTML, EPUB, xml, sqlite, postgresql) , this numbering system can be used to reference content. -

-* Granular search within documents. SQL databases are populated at an object -level (roughly headings, paragraphs, verse, tables) and become searchable -with that degree of granularity, the output information provides the object/paragraph -numbers which are relevant across all generated outputs; it is also possible -to look at just the matching paragraphs of the documents in the database; -[output indexing also work -

-* long term maintainability of document collections in a world of changing -formats, having a very sparsely marked-up source document base. there is -a considerable degree of future-proofing, output representations are "upgradeable", -and new document formats may be added. e.g. addition of odf (open document -text) module in 2006, epub in 2009 and in future html5 output sometime -in future, without modification of existing prepared texts -

-* SQL search aside, documents are generated as required and static once -generated. -

-* documents produced are static files, and may be batch processed, this -needs to be done only once but may be repeated for various reasons as desired -(updated content, addition of new output formats, updated technology document -presentations/representations) -

-* document source ( plaintext utf-8) if shared on the net may be used as - -
input and processed locally to produce the different document outputs -
-
-* document source may be bundled together (automatically) with associated +
* Granular search within +documents. SQL databases are populated at an object level (roughly headings, +paragraphs, verse, tables) and become searchable with that degree of granularity, +the output information provides the object/paragraph numbers which are +relevant across all generated outputs; it is also possible to look at just +the matching paragraphs of the documents in the database; [output indexing +also work well with search indexing tools like hyperestraier]. +
* long +term maintainability of document collections in a world of changing formats, +having a very sparsely marked-up source document base. there is a considerable +degree of future-proofing, output representations are "upgradeable", and +new document formats may be added. e.g. addition of odf (open document text) +module in 2006, epub in 2009 and in future html5 output sometime in future, + +
without modification of existing prepared texts +
* SQL search aside, documents +are generated as required and static once generated. +
* documents produced +are static files, and may be batch processed, this needs to be done only +once but may be repeated for various reasons as desired (updated content, +addition of new output formats, updated technology document presentations/representations) + +
* document source ( plaintext utf-8) if shared on the net may be used + +
as input and processed locally to produce the different document outputs + +
* document source may be bundled together (automatically) with associated documents (multiple language versions or master document with inclusions) and images and sent as a zip file called a sisupod, if shared on the net
these too may be processed locally to produce the desired document outputs -

-* generated document outputs may automatically be posted to remote sites. +
* generated document outputs may automatically be posted to remote sites. -

-* for basic document generation, the only software dependency is Ruby, +
* for basic document generation, the only software dependency is Ruby, and a few standard Unix tools (this covers plaintext, HTML, EPUB, XML, ODF, LaTeX ) . To use a database you of course need that, and to convert the LaTeX generated to pdf, a latex processor like tetex or texlive. -

-* as a developers tool it is flexible and extensible -

-Syntax highlighting for SiSU markup is available for a number of text editors. - -

-SiSU is less about document layout than about finding a way with little -markup to be able 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, or search of content -

-i.e. to be able to take advantage from this 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 viewing (e.g. html, -xml, pdf) , or paper publication (e.g. pdf) ... -

-the solution arrived at is by extracting structural information about the -document (about headings within the document) and by tracking objects (which -are serialized and also given hash values) in the manner described. It makes -possible representations that are quite different from those offered at -present. For example objects could be saved individually and identified -by their hashes, with an index of how the objects relate to each other -to form a document. +
* + +
as a developers tool it is flexible and extensible +
Syntax highlighting +for SiSU markup is available for a number of text editors. +
SiSU is less +about document layout than about finding a way with little markup to be +able 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, or search of content +
i.e. to be able to take advantage +from this 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 viewing (e.g. html, xml, pdf) , or paper publication +(e.g. pdf) ... +
the solution arrived at is by extracting structural information +about the document (about headings within the document) and by tracking +objects (which are serialized and also given hash values) in the manner +described. It makes possible representations that are quite different from +those offered at present. For example objects could be saved individually +and identified by their hashes, with an index of how the objects relate +to each other to form a document.

-.
objects include: headings, paragraphs, verse, tables, -images, but not footnotes/endnotes which are numbered separately and tied -to the object from which they are referenced. -

-
.
i.e. the -

-HTML, -

-PDF, -

-EPUB, -

- -
ODT -

-outputs are each built individually and optimised for that form of presentation, -rather than for example the html being a saved version of the odf, or the -pdf being a saved version of the html. -

-
.
-
the different heading levels -

-
.
units of text, primarily paragraphs and headings, also any tables, poems, - -
code-blocks -

-
.
-
An open standard format for e-books -

-
.
Open Document Format ( -

- -
ODF -

-) text -

-
.
-
Specification submitted by Adobe to ISO to become a full open ISO specification - -

-<http://www.linux-watch.com/news/NS7542722606.html +.
objects include: headings, paragraphs, +verse, tables, images, but not footnotes/endnotes which are numbered separately +and tied to the object from which they are referenced. +

.
i.e. the HTML, PDF, +EPUB, ODT outputs are each built individually and optimised for that form +of presentation, rather than for example the html being a saved version +of the odf, or the pdf being a saved version of the html. +

.
the different + +
heading levels +

.
units of text, primarily paragraphs and headings, also +any tables, poems, code-blocks +

.
An open standard format for e-books +

.
Open +Document Format ( ODF ) text +

.
Specification submitted by Adobe to ISO +to become a full open ISO specification <http://www.linux-watch.com/news/NS7542722606.html > -

-
.
-
ISO standard ISO/IEC 26300:2006 -

- + +

.
ISO standard ISO/IEC 26300:2006 +

*1.

square brackets -

-
+

*2.

square brackets -

-
+ +

+1.

square brackets -

-
.
<http://www.jus.uio.no/sisu/man/ +

.
<http://www.jus.uio.no/sisu/man/ > -

-
.
<http://www.jus.uio.no/sisu/man/sisu.1.html +

.
<http://www.jus.uio.no/sisu/man/sisu.1.html > -

-
.
From sometime after SiSU 0.58 it should be possible to describe 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. -

-
.
-
files should be prepared using -

+

.
files -
UTF-8 -

+
should be prepared using UTF-8 character encoding +

.
a footnote or endnote -
character encoding -

-
.
-
a footnote or endnote -

-
.
self contained endnote marker & endnote in one -

- +

.
self contained endnote marker & endnote in one +

*.
-
unnumbered asterisk footnote/endnote, insert multiple asterisks if required - -

-
+
unnumbered asterisk +footnote/endnote, insert multiple asterisks if required +

**.
-
another unnumbered asterisk footnote/endnote -

-
+
another unnumbered + +
asterisk footnote/endnote +

*3.
-
editors notes, numbered asterisk footnote/endnote series -

-
+
editors notes, numbered asterisk footnote/endnote + +
series +

+2.

editors notes, numbered asterisk footnote/endnote series -

+

.
<http://www.sisudoc.org/ > -

-
.
<http://www.ruby-lang.org/en/ +

.
<http://www.ruby-lang.org/en/ > -

-
.
-
Table from the Wealth of Networks by Yochai Benkler -

-<http://www.jus.uio.no/sisu/the_wealth_of_networks.yochai_benkler +

.
Table from the Wealth +of Networks by Yochai Benkler <http://www.jus.uio.no/sisu/the_wealth_of_networks.yochai_benkler > -

-
.
.ssc (for composite) is under consideration but ._sst makes clear that this -is not a regular file to be worked on, and thus less likely that people + +

.
.ssc (for composite) is under consideration but ._sst makes clear that +this is not a regular file to be worked on, and thus less likely that people will have "accidents", working on a .ssc file that is overwritten by subsequent processing. It may be however that when the resulting file is shared .ssc is an appropriate suffix to use. -

-
.
<http://www.postgresql.org/ +

.
SiSU has worked this way in the past, +though this was dropped as it was thought the complexity outweighed the +flexibility, however, the balance was rather fine and this behaviour could +be reinstated. +

.
<http://www.postgresql.org/ +> <http://advocacy.postgresql.org/ > -

-<http://advocacy.postgresql.org/ -> -

<http://en.wikipedia.org/wiki/Postgresql > -

-
.
<http://www.hwaci.com/sw/sqlite/ -> -

-<http://en.wikipedia.org/wiki/Sqlite +

.
<http://www.hwaci.com/sw/sqlite/ +> <http://en.wikipedia.org/wiki/Sqlite > -

-
.
<http://search.sisudoc.org + +

.
<http://search.sisudoc.org > -

-
.
(which could be extended further with current back-end). As regards scaling -of the database, it is as scalable as the database (here Postgresql) and -hardware allow. -

-
.
of this feature when demonstrated to an IBM software innovations evaluator -in 2004 he said to paraphrase: this could be of interest to us. We have -large document management systems, you can search hundreds of thousands -of documents and we can tell you which documents meet your search criteria, -but there is no way we can tell you without opening each document where -within each your matches are found. -

+

.
(which could be extended further with current +back-end). As regards scaling of the database, it is as scalable as the database +(here Postgresql) and hardware allow. +

.
of this feature when demonstrated +to an IBM software innovations evaluator in 2004 he said to paraphrase: +this could be of interest to us. We have large document management systems, +you can search hundreds of thousands of documents and we can tell you which +documents meet your search criteria, but there is no way we can tell you +without opening each document where within each your matches are found. +

diff --git a/data/doc/sisu/markup-samples/v3/sisu_manual/sisu_markup.sst b/data/doc/sisu/markup-samples/v3/sisu_manual/sisu_markup.sst index e3fbb226..3af84ad9 100644 --- a/data/doc/sisu/markup-samples/v3/sisu_manual/sisu_markup.sst +++ b/data/doc/sisu/markup-samples/v3/sisu_manual/sisu_markup.sst @@ -119,37 +119,37 @@ code{ % SiSU master 2.0 @title: SiSU - :subtitle: Manual + :subtitle: Manual @creator: - :author: Amissah, Ralph + :author: Amissah, Ralph @publisher: [publisher name] @rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 @classify: - :type: information - :topic_register: SiSU:manual;electronic documents:SiSU:manual - :subject: ebook, epublishing, electronic book, electronic publishing, + :type: information + :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 + :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 - :skin: skin_sisu_manual - :bold: /Gnu|Debian|Ruby|SiSU/ - :manpage: name=sisu - documents: markup, structuring, publishing in multiple standard formats, and search; + :num_top: 1 + :breaks: new=C; break=1 + :skin: skin_sisu_manual + :bold: /Gnu|Debian|Ruby|SiSU/ + :manpage: name=sisu - documents: markup, structuring, publishing in multiple standard formats, and search; synopsis=sisu [-abcDdeFhIiMmNnopqRrSsTtUuVvwXxYyZz0-9] [filename/wildcard ] . sisu [-Ddcv] [instruction] . sisu [-CcFLSVvW] @@ -157,16 +157,16 @@ code{ . sisu --v3 [operations] @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/?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 + { 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/?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 @@ -174,10 +174,10 @@ code{ 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 -!_ @indentifier: +!_ @identifier: information or instructions -where the "identifier" is a tag recognised by the program, and the "information" or "instructions" belong to the tag/indentifier specified +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. @@ -191,7 +191,6 @@ code{ }code - code{ @title: [title text] [this header is the only one that is mandatory] @@ -203,50 +202,50 @@ code{ code{ @creator: - :author: [Lastname, First names] - :illustrator: [Lastname, First names] - :translator: [Lastname, First names] - :prepared_by: [Lastname, First names] + :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] + :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] + :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: - :isbn: [ISBN] - :loc: [Library of Congress classification] - :dewey: [Dewey classification + :topic_register: SiSU:markup sample:book;book:novel:fantasy + :type: + :subject: + :description: + :keywords: + :abstract: + :isbn: [ISBN] + :loc: [Library of Congress classification] + :dewey: [Dewey classification }code @@ -260,29 +259,29 @@ code{ code{ @make: - :skin: skin_name [skins change default settings related to the appearance of documents generated] - :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] + :skin: skin_name [skins change default settings related to the appearance of documents generated] + :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] }code code{ @original: - :language: [language] + :language: [language] }code code{ @notes: - :comment: - :prefix: [prefix is placed just after table of contents] + :comment: + :prefix: [prefix is placed just after table of contents] }code @@ -458,12 +457,19 @@ in each case level may be 0-9 !_ resulting output: -_0_1 first line no indent, rest of paragraph indented one step +_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; -_1_0 first line indented, rest of paragraph no indent +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 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 @@ -1266,232 +1272,4 @@ code{ }code -The form described above should be relied on. Within the Vim editor it results in the text thus linked becoming hyperlinked to the document it is calling in which is convenient for editing. Alternative markup for importation of documents under consideration, and occasionally supported have been. - -code{ - -<< filename.ssi - -<<{filename.ssi} - -% using textlink alternatives - -<< |filename.ssi|@|^| - -}code - -1~syntax_history Markup Syntax History - -2~ Notes related to Files-types and Markup Syntax - -3.0 very minor additions to markup added, substantially the same as version 2.0 - -2.0 introduced new headers and is therefore incompatible with 1.0 though otherwise the same with the addition of a couple of tags (i.e. a superset) - -0.38 is substantially current for version 1.0 - -depreciated 0.16 supported, though file names were changed at 0.37 - -_* sisu --query=[sisu version [0.38] or 'history] - -provides a short history of changes to SiSU markup - -!_ SiSU 2.0 -(2010-03-06:09/6) -same as 1.0, apart from the changing of headers and the addition of a monospace tag related headers now grouped, e.g. - -code{ - -@title: - :subtitle: - -@creator: - :author: - :translator: - :illustrator: - -@rights: - :text: - :illustrations: - -}code - -see document markup samples, and sisu --help headers - -the monospace tag takes the form of a hash '#' - -code{ - -#{ this enclosed text would be monospaced }# - -}code - -!_ 1.0 -(2009-12-19:50/6) -same as 0.69 - -!_ 0.69 -(2008-09-16:37/2) -(same as 1.0) and as previous (0.57) with the addition of book index tags - -code{ - -/^={.+?}$/ - -}code - -e.g. appended to a paragraph, on a new-line (without a blank line in between) logical structure produced assuming this is the first text "object" - -code{ - - ={GNU/Linux community distribution:Debian+2|Fedora|Gentoo;Free Software Foundation+5} - -}code - -code{ - -Free Software Foundation, 1-6 -GNU/Linux community distribution, 1 - Debian, 1-3 - Fedora, 1 - Gentoo, - -}code - -!_ 0.66 -(2008-02-24:07/7) -same as previous, adds semantic tags, [experimental and not-used] - -code{ - -/[:;]{.+?}[:;][a-z+]/ - -}code - -!_ 0.57 -(2007w34/4) -SiSU 0.57 is the same as 0.42 with the introduction of some a shortcut to use the headers @title and @creator in the first heading [expanded using the contents of the headers @title: and @author:] - -code{ - -:A~ @title by @author - -}code - -!_ 0.52 -(2007w14/6) -declared document type identifier at start of text/document: - -_1 SiSU 0.52 - -or, backward compatible using the comment marker: - -_1 % SiSU 0.38 - -variations include 'SiSU (text|master|insert) [version]' and 'sisu-[version]' - -!_ 0.51 -(2007w13/6) -skins changed (simplified), markup unchanged - -!_ 0.42 -(2006w27/4) -* (asterisk) type endnotes, used e.g. in relation to author - -SiSU 0.42 is the same as 0.38 with the introduction of some additional endnote types, - -Introduces some variations on endnotes, in particular the use of the asterisk - -code{ - -~{* for example for describing an author }~ and ~{** for describing a second author }~ - -}code - -* for example for describing an author - -** for describing a second author - -and - -code{ - -~[* my note ]~ or ~[+ another note ]~ - -}code - -which numerically increments an asterisk and plus respectively - -*1 my note -+1 another note - -!_ 0.38 -(2006w15/7) -introduced new/alternative notation for headers, e.g. @title: (instead of 0\~title), and accompanying document structure markup, :A,:B,:C,1,2,3 (maps to previous 1,2,3,4,5,6) - -SiSU 0.38 introduced alternative experimental header and heading/structure markers, - -code{ - -@headername: and headers :A~ :B~ :C~ 1~ 2~ 3~ - -}code - -as the equivalent of: - -code{ - -0~headername and headers 1~ 2~ 3~ 4~ 5~ 6~ - -}code - -The internal document markup of SiSU 0.16 remains valid and standard Though note that SiSU 0.37 introduced a new file naming convention - -SiSU has in effect two sets of levels to be considered, using 0.38 notation A-C headings/levels, pre-ordinary paragraphs /pre-substantive text, and 1-3 headings/levels, levels which are followed by ordinary text. This may be conceptualised as levels A,B,C, 1,2,3, and using such letter number notation, in effect: A must exist, optional B and C may follow in sequence (not strict) 1 must exist, optional 2 and 3 may follow in sequence i.e. there are two independent heading level sequences A,B,C and 1,2,3 (using the 0.16 standard notation 1,2,3 and 4,5,6) on the positive side: the 0.38 A,B,C,1,2,3 alternative makes explicit an aspect of structuring documents in SiSU that is not otherwise obvious to the newcomer (though it appears more complicated, is more in your face and likely to be understood fairly quickly); the substantive text follows levels 1,2,3 and it is 'nice' to do most work in those levels - -!_ 0.37 -(2006w09/7) -introduced new file naming convention, .sst (text), .ssm (master), .ssi (insert), markup syntax unchanged - -SiSU 0.37 introduced new file naming convention, using the file extensions .sst .ssm and .ssi to replace .s1 .s2 .s3 .r1 .r2 .r3 and .si - -this is captured by the following file 'rename' instruction: - -code{ - -rename 's/\.s[123]$/\.sst/' *.s{1,2,3} -rename 's/\.r[123]$/\.ssm/' *.r{1,2,3} -rename 's/\.si$/\.ssi/' *.si - -}code - -The internal document markup remains unchanged, from SiSU 0.16 - -!_ 0.35 -(2005w52/3) -sisupod, zipped content file introduced - -!_ 0.23 -(2005w36/2) -utf-8 for markup file - -!_ 0.22 -(2005w35/3) -image dimensions may be omitted if rmagick is available to be relied upon - -!_ 0.20.4 -(2005w33/4) -header 0~links - -!_ 0.16 -(2005w25/2) -substantial changes introduced to make markup cleaner, header 0\~title type, and headings [1-6]\~ introduced, also percentage sign (%) at start of a text line as comment marker - -SiSU 0.16 (0.15 development branch) introduced the use of - -the header 0~ and headings/structure 1~ 2~ 3~ 4~ 5~ 6~ - -in place of the 0.1 header, heading/structure notation - -SiSU 0.1 headers and headings structure represented by -header 0{~ and headings/structure 1{ 2{ 3{ 4{~ 5{ 6{ +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. diff --git a/data/doc/sisu/markup-samples/v3/sisu_manual/sisu_markup_syntax_history.sst b/data/doc/sisu/markup-samples/v3/sisu_manual/sisu_markup_syntax_history.sst new file mode 100644 index 00000000..f0b621ff --- /dev/null +++ b/data/doc/sisu/markup-samples/v3/sisu_manual/sisu_markup_syntax_history.sst @@ -0,0 +1,256 @@ +% SiSU 2.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 + +@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/?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 + +@make: + :num_top: 1 + :breaks: new=C; break=1 + +:A~? @title @creator + +1~syntax_history Markup Syntax History + +2~ Notes related to Files-types and Markup Syntax + +3.0 very minor additions to markup added, substantially the same as version 2.0 + +2.0 introduced new headers and is therefore incompatible with 1.0 though otherwise the same with the addition of a couple of tags (i.e. a superset) + +0.38 is substantially current for version 1.0 + +depreciated 0.16 supported, though file names were changed at 0.37 + +_* sisu --query=[sisu version [0.38] or 'history] + +provides a short history of changes to SiSU markup + +!_ SiSU 2.0 +(2010-03-06:09/6) +same as 1.0, apart from the changing of headers and the addition of a monospace tag related headers now grouped, e.g. + +code{ + +@title: + :subtitle: + +@creator: + :author: + :translator: + :illustrator: + +@rights: + :text: + :illustrations: + +}code + +see document markup samples, and sisu --help headers + +the monospace tag takes the form of a hash '#' + +code{ + +#{ this enclosed text would be monospaced }# + +}code + +!_ 1.0 +(2009-12-19:50/6) +same as 0.69 + +!_ 0.69 +(2008-09-16:37/2) +(same as 1.0) and as previous (0.57) with the addition of book index tags + +code{ + +/^={.+?}$/ + +}code + +e.g. appended to a paragraph, on a new-line (without a blank line in between) logical structure produced assuming this is the first text "object" + +code{ + + ={GNU/Linux community distribution:Debian+2|Fedora|Gentoo;Free Software Foundation+5} + +}code + +code{ + +Free Software Foundation, 1-6 +GNU/Linux community distribution, 1 + Debian, 1-3 + Fedora, 1 + Gentoo, + +}code + +!_ 0.66 +(2008-02-24:07/7) +same as previous, adds semantic tags, [experimental and not-used] + +code{ + +/[:;]{.+?}[:;][a-z+]/ + +}code + +!_ 0.57 +(2007w34/4) +SiSU 0.57 is the same as 0.42 with the introduction of some a shortcut to use the headers @title and @creator in the first heading [expanded using the contents of the headers @title: and @author:] + +code{ + +:A~ @title by @author + +}code + +!_ 0.52 +(2007w14/6) +declared document type identifier at start of text/document: + +_1 SiSU 0.52 + +or, backward compatible using the comment marker: + +_1 % SiSU 0.38 + +variations include 'SiSU (text|master|insert) [version]' and 'sisu-[version]' + +!_ 0.51 +(2007w13/6) +skins changed (simplified), markup unchanged + +!_ 0.42 +(2006w27/4) +* (asterisk) type endnotes, used e.g. in relation to author + +SiSU 0.42 is the same as 0.38 with the introduction of some additional endnote types, + +Introduces some variations on endnotes, in particular the use of the asterisk + +code{ + +~{* for example for describing an author }~ and ~{** for describing a second author }~ + +}code + +* for example for describing an author + +** for describing a second author + +and + +code{ + +~[* my note ]~ or ~[+ another note ]~ + +}code + +which numerically increments an asterisk and plus respectively + +*1 my note ++1 another note + +!_ 0.38 +(2006w15/7) +introduced new/alternative notation for headers, e.g. @title: (instead of 0\~title), and accompanying document structure markup, :A,:B,:C,1,2,3 (maps to previous 1,2,3,4,5,6) + +SiSU 0.38 introduced alternative experimental header and heading/structure markers, + +code{ + +@headername: and headers :A~ :B~ :C~ 1~ 2~ 3~ + +}code + +as the equivalent of: + +code{ + +0~headername and headers 1~ 2~ 3~ 4~ 5~ 6~ + +}code + +The internal document markup of SiSU 0.16 remains valid and standard Though note that SiSU 0.37 introduced a new file naming convention + +SiSU has in effect two sets of levels to be considered, using 0.38 notation A-C headings/levels, pre-ordinary paragraphs /pre-substantive text, and 1-3 headings/levels, levels which are followed by ordinary text. This may be conceptualised as levels A,B,C, 1,2,3, and using such letter number notation, in effect: A must exist, optional B and C may follow in sequence (not strict) 1 must exist, optional 2 and 3 may follow in sequence i.e. there are two independent heading level sequences A,B,C and 1,2,3 (using the 0.16 standard notation 1,2,3 and 4,5,6) on the positive side: the 0.38 A,B,C,1,2,3 alternative makes explicit an aspect of structuring documents in SiSU that is not otherwise obvious to the newcomer (though it appears more complicated, is more in your face and likely to be understood fairly quickly); the substantive text follows levels 1,2,3 and it is 'nice' to do most work in those levels + +!_ 0.37 +(2006w09/7) +introduced new file naming convention, .sst (text), .ssm (master), .ssi (insert), markup syntax unchanged + +SiSU 0.37 introduced new file naming convention, using the file extensions .sst .ssm and .ssi to replace .s1 .s2 .s3 .r1 .r2 .r3 and .si + +this is captured by the following file 'rename' instruction: + +code{ + +rename 's/\.s[123]$/\.sst/' *.s{1,2,3} +rename 's/\.r[123]$/\.ssm/' *.r{1,2,3} +rename 's/\.si$/\.ssi/' *.si + +}code + +The internal document markup remains unchanged, from SiSU 0.16 + +!_ 0.35 +(2005w52/3) +sisupod, zipped content file introduced + +!_ 0.23 +(2005w36/2) +utf-8 for markup file + +!_ 0.22 +(2005w35/3) +image dimensions may be omitted if rmagick is available to be relied upon + +!_ 0.20.4 +(2005w33/4) +header 0~links + +!_ 0.16 +(2005w25/2) +substantial changes introduced to make markup cleaner, header 0\~title type, and headings [1-6]\~ introduced, also percentage sign (%) at start of a text line as comment marker + +SiSU 0.16 (0.15 development branch) introduced the use of + +the header 0~ and headings/structure 1~ 2~ 3~ 4~ 5~ 6~ + +in place of the 0.1 header, heading/structure notation + +SiSU 0.1 headers and headings structure represented by +header 0{~ and headings/structure 1{ 2{ 3{ 4{~ 5{ 6{ diff --git a/data/doc/sisu/markup-samples/v4/sisu_manual/_sisu/sisu_document_make b/data/doc/sisu/markup-samples/v4/sisu_manual/_sisu/sisu_document_make index 17c6bbf8..72706d10 100644 --- a/data/doc/sisu/markup-samples/v4/sisu_manual/_sisu/sisu_document_make +++ b/data/doc/sisu/markup-samples/v4/sisu_manual/_sisu/sisu_document_make @@ -2,7 +2,7 @@ :num_top: 1 :breaks: new=C; break=1 :bold: /Debian|Ruby|SiSU/ - :italics: /Linux|GPL|GPLv3|LaTeX|PostgreSQL|SQLite|SQL|Vim|ascii|plaintext|UTF-?8|HTML|XHTML|XML|EPUB|OpenDocument|ODF|ODT|PDF|pgSQL|TeXinfo|YAML|YML|ocn|object citation system|object citation numbering|granular search|Dublin Core/ + :italics: /Linux|GPL|GPLv3|LaTeX|PostgreSQL|SQLite|SQL|Vim|ascii|plaintext|UTF-?8|HTML|XHTML|XML|EPUB|OpenDocument|ODF|ODT|PDF|pgSQL|TeXinfo|YAML|YML|OCN|object citation system|object citation numbering|granular search|Dublin Core/ :substitute: /${debian_stable}/,'*{Wheezy}*' /${debian_testing}/,'*{Jessie}*' :home_button_text: {SiSU}http://sisudoc.org; {git}http://git.sisudoc.org :footer: {SiSU}http://sisudoc.org; {git}http://git.sisudoc.org diff --git a/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_markup.sst b/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_markup.sst index 9027817a..98377850 100644 --- a/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_markup.sst +++ b/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_markup.sst @@ -97,41 +97,40 @@ This current document is loaded by a master document that has a header similar t code{ -% SiSU master 2.0 +% SiSU master 4.0 @title: SiSU - :subtitle: Manual + :subtitle: Manual @creator: - :author: Amissah, Ralph + :author: Amissah, Ralph @publisher: [publisher name] @rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 @classify: - :type: information - :topic_register: SiSU:manual;electronic documents:SiSU:manual - :subject: ebook, epublishing, electronic book, electronic publishing, + :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 + :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; + :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] @@ -139,16 +138,16 @@ code{ . sisu --v3 [operations] @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/?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 + { 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/?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 @@ -156,10 +155,10 @@ code{ 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 -!_ @indentifier: +!_ @identifier: information or instructions -where the "identifier" is a tag recognised by the program, and the "information" or "instructions" belong to the tag/indentifier specified +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. @@ -173,7 +172,6 @@ code{ }code - code{ @title: [title text] [this header is the only one that is mandatory] @@ -185,57 +183,57 @@ code{ code{ @creator: - :author: [Lastname, First names] - :illustrator: [Lastname, First names] - :translator: [Lastname, First names] - :prepared_by: [Lastname, First names] + :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] + :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] + :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 + :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: + :isbn: [ISBN] + :oclc: }code @@ -250,30 +248,30 @@ code{ code{ @make: - :num_top: 1 - :headings: [text to match for each level + :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 + :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] + :language: [language] }code code{ @notes: - :comment: - :prefix: [prefix is placed just after table of contents] + :comment: + :prefix: [prefix is placed just after table of contents] }code @@ -449,12 +447,19 @@ in each case level may be 0-9 !_ resulting output: -_0_1 first line no indent, rest of paragraph indented one step +_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 +_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 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 diff --git a/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_markup_syntax_history.sst b/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_markup_syntax_history.sst index a5b56f1f..c6da0a14 100644 --- a/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_markup_syntax_history.sst +++ b/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_markup_syntax_history.sst @@ -25,22 +25,6 @@ :B~? SiSU Markup Syntax History -1~ Composite documents markup - -It is possible to build a document by creating a master document that requires other documents. The documents required may be complete documents that could be generated independently, or they could be markup snippets, prepared so as to be easily available to be placed within another text. If the calling document is a master document (built from other documents), it should be named with the suffix *{.ssm}* Within this document you would provide information on the other documents that should be included within the text. These may be other documents that would be processed in a regular way, or markup bits prepared only for inclusion within a master document *{.sst}* regular markup file, or *{.ssi}* (insert/information) A secondary file of the composite document is built prior to processing with the same prefix and the suffix *{._sst}* - -basic markup for importing a document into a master document - -code{ - -<< filename1.sst - -<< filename2.ssi - -}code - -The form described above should be relied on. Within the Vim editor it results in the text thus linked becoming hyperlinked to the document it is calling in which is convenient for editing. - 1~syntax_history Markup Syntax History 2~ Notes related to Files-types and Markup Syntax @@ -66,16 +50,16 @@ same as 1.0, apart from the changing of headers and the addition of a monospace code{ @title: - :subtitle: + :subtitle: @creator: - :author: - :translator: - :illustrator: + :author: + :translator: + :illustrator: @rights: - :text: - :illustrations: + :text: + :illustrations: }code diff --git a/man/man1/sisu.1 b/man/man1/sisu.1 index ccf359c0..b297f3e3 100644 --- a/man/man1/sisu.1 +++ b/man/man1/sisu.1 @@ -1,4 +1,4 @@ -.TH "sisu" "1" "2012-10-03" "4.0.0" "SiSU" +.TH "sisu" "1" "2012-10-03" "4.0.1" "SiSU" .br .SH NAME .br @@ -28,17 +28,15 @@ sisu [\-CcFLSVvW] .br sisu (\-\-configure|\-\-webrick|\-\-sample\-search\-form) -.SH SISU \- MANUAL, +.SH SISU - MANUAL, RALPH AMISSAH -.br .SH WHAT IS SISU? -.br -.SH INTRODUCTION \- WHAT IS SISU? -.br +.SH INTRODUCTION - WHAT IS SISU? -.br + +.BR .B SiSU is a framework for document structuring, publishing (in multiple open standard formats) and search, comprising of: (a) a lightweight document structure and @@ -48,7 +46,7 @@ which is able to produce multiple standard outputs (including the population of sql databases) that (can) share a common numbering system for the citation of text within a document. -.br +.BR .B SiSU is developed under an open source, software libre license ( .I GPLv3 @@ -56,9 +54,9 @@ is developed under an open source, software libre license ( cope with evolving document formats/ representation technologies. Documents are prepared once, and generated as need be to update the technical presentation or add additional output formats. Various output formats (including search related -output) share a common mechanism for cross\-output\-format citation. +output) share a common mechanism for cross-output-format citation. -.br +.BR .B SiSU both defines a markup syntax and provides an engine that produces open standards format outputs from documents prepared with @@ -85,12 +83,12 @@ is also able to populate type databases at an object level, which means that searches can be made with that degree of granularity. -.br +.BR Source document preparation and output generation is a two step process: (i) document source is prepared, that is, marked up in sisu markup syntax and (ii) the desired output subsequently generated by running the sisu engine against document source. Output representations if updated (in the sisu engine) can be -generated by re\-running the engine against the prepared source. Using +generated by re-running the engine against the prepared source. Using .B SiSU markup applied to a document, .B SiSU @@ -107,7 +105,7 @@ or .I PDF files, and populate an .I SQL -database with objects[^1] (equating generally to paragraph\-sized chunks) so +database with objects[^1] (equating generally to paragraph-sized chunks) so searches may be performed and matches returned with that degree of granularity ( e.g. your search criteria is met by these documents and at these locations within each document). Document output formats share a common object numbering @@ -115,7 +113,7 @@ system for locating content. This 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. -.br +.BR In preparing a .B SiSU document you optionally provide semantic information related to the document in @@ -125,7 +123,7 @@ footnotes. You also provide information on basic text attributes where used. The rest is automatic, sisu from this information custom builds[^2] the different forms of output requested. -.br +.BR .B SiSU works with an abstraction of the document based on its structure which is comprised of its headings[^3] and objects[^4], which enables @@ -143,7 +141,7 @@ also has implications for search that .B SiSU is able to take advantage of. -.br +.BR One of the challenges of maintaining documents is to keep them in a format that allows use of them independently of proprietary platforms. Consider issues related to dealing with legacy proprietary formats today and what guarantee you @@ -151,7 +149,7 @@ have that old proprietary formats will remain (or can be read without proprietary software/equipment) in 15 years time, or the way the way in which html has evolved over its relatively short span of existence. .B SiSU -provides the flexibility of producing documents in multiple non\-proprietary +provides the flexibility of producing documents in multiple non-proprietary open formats including .I HTML, .I EPUB, @@ -194,12 +192,12 @@ as .I HTML 5). -.br -The document formats are written to the file\-system and available for indexing +.BR +The document formats are written to the file-system and available for indexing by independent indexing tools, whether off the web like Google and Yahoo or on the site like Lucene and Hyperestraier. -.br +.BR .B SiSU also provides other features such as concordance files and document content certificates, and the working against an abstraction of document structure has @@ -209,7 +207,7 @@ maps and thesauri, together with the flexibility of .B SiSU offers great possibilities. -.br +.BR .B SiSU is primarily for published works, which can take advantage of the citation system to reliably reference its documents. @@ -219,20 +217,19 @@ Wikis, which can take advantage of and be used to discuss the substance of content prepared in .B SiSU. -.br +.BR -.br +.BR .SH COMMANDS SUMMARY -.br .SH DESCRIPTION -.br +.BR .B SiSU -is a document publishing system, that from a simple single marked\-up document, +is a document publishing system, that from a simple single marked-up document, produces multiple output formats including: .I plaintext, .I HTML, @@ -260,353 +257,297 @@ document structure information. For more see: or .SH DOCUMENT PROCESSING COMMAND FLAGS .TP -.B \-a [filename/wildcard] +.B -a [filename/wildcard] produces .I plaintext with Unix linefeeds and without markup, (object numbers are omitted), has -footnotes at end of each paragraph that contains them [ \ \-A \ for \ -equivalent \ dos \ (linefeed) \ output \ file] [see \ \-e \ for \ endnotes]. -(Options include: \-\-endnotes for endnotes \-\-footnotes for footnotes at the -end of each paragraph \-\-unix for unix linefeed (default) \-\-msdos for msdos -linefeed) - +footnotes at end of each paragraph that contains them [ -A for equivalent dos +(linefeed) output file] [see -e for endnotes]. (Options include: --endnotes for +endnotes --footnotes for footnotes at the end of each paragraph --unix for unix +linefeed (default) --msdos for msdos linefeed) .TP -.B \-b [filename/wildcard] -see \-\-xhtml - +.B -b [filename/wildcard] +see --xhtml .TP -.B \-\-by\-* -see \-\-output\-by\-* - +.B --by-* +see --output-by-* .TP -.B \-C +.B -C configure/initialise shared output directory files initialize shared output directory (config files such as css and dtd files are not updated if they -already exist unless modifier is used). \-C \-\-init\-site configure/initialise -site more extensive than \-C on its own, shared output directory files/force +already exist unless modifier is used). -C --init-site configure/initialise +site more extensive than -C on its own, shared output directory files/force update, existing shared output config files such as css and dtd files are updated if this modifier is used. - .TP -.B \-CC -see \-\-configure - +.B -CC +see --configure .TP -.B \-c [filename/wildcard] -see \-\-color\-toggle - +.B -c [filename/wildcard] +see --color-toggle +.TP +.B --color +see --color-on +.TP +.B --color-off +turn off color in output to terminal +.TP +.B --color-on +turn on color in output to terminal .TP -.B \-\-color\-toggle [filename/wildcard] -screen toggle ansi screen colour on or off depending on default set (unless \-c +.B --color-toggle [filename/wildcard] +screen toggle ansi screen colour on or off depending on default set (unless -c flag is used: if sisurc colour default is set to 'true', output to screen will be with colour, if sisurc colour default is set to 'false' or is undefined -screen output will be without colour). Alias \-c - +screen output will be without colour). Alias -c .TP -.B \-\-configure +.B --configure configure/initialise shared output directory files initialize shared output directory (config files such as css and dtd files are not updated if they -already exist unless modifier is used). The equivalent of: \-C \-\-init\-site -configure/initialise site, more extensive than \-C on its own, shared output +already exist unless modifier is used). The equivalent of: -C --init-site +configure/initialise site, more extensive than -C on its own, shared output directory files/force update, existing shared output config files such as css -and dtd files are updated if \-CC is used. - +and dtd files are updated if -CC is used. .TP -.B \-\-concordance [filename/wildcard] +.B --concordance [filename/wildcard] produces concordance (wordmap) a rudimentary index of all the words in a document. (Concordance files are not generated for documents of over 260,000 -words unless this limit is increased in the file sisurc.yml). Alias \-w - +words unless this limit is increased in the file sisurc.yml). Alias -w .TP -.B \-D [instruction] [filename] -see \-\-pg - +.B -D [instruction] [filename] +see --pg .TP -.B \-d [\-\-db\-[database \ type \ (sqlite|pg)]] \-\-[instruction] [filename] -see \-\-sqlite - +.B -d [--db-[database type (sqlite|pg)]] --[instruction] [filename] +see --sqlite .TP -.B \-\-dal [filename/wildcard/url] +.B --dal [filename/wildcard/url] assumed for most other flags, creates new intermediate files for processing (document abstraction) that is used in all subsequent processing of other -output. This step is assumed for most processing flags. To skip it see \-n. -Alias \-m - +output. This step is assumed for most processing flags. To skip it see -n. +Alias -m .TP -.B \-\-delete [filename/wildcard] -see \-\-zap - +.B --delete [filename/wildcard] +see --zap .TP -.B \-\-dump[=directory_path] [filename/wildcard] +.B --dump[=directory_path] [filename/wildcard] places output in directory specified, if none is specified in the current -directory (pwd). Compare \-\-redirect - +directory (pwd). Compare --redirect .TP -.B \-e [filename/wildcard] -see \-\-epub - +.B -e [filename/wildcard] +see --epub .TP -.B \-\-epub [filename/wildcard] -produces an epub document, [sisu \ version \ >=2 \ ] (filename.epub). Alias \-e - +.B --epub [filename/wildcard] +produces an epub document, [sisu version >=2 ] (filename.epub). Alias -e .TP -.B \-\-exc\-* -exclude output feature, overrides configuration settings \-\-exc\- -.I ocn, -(exclude +.B --exc-* +exclude output feature, overrides configuration settings --exc-ocn, (exclude .I object citation numbering, (switches off .I object citation numbering -) , affects html (seg, scroll), epub, xhtml, xml, pdf) ; \-\-exc\-toc, (exclude -table of contents, affects html (scroll), epub, pdf) ; -\-\-exc\-links\-to\-manifest, \-\-exc\-manifest\-links, (exclude links to -manifest, affects html (seg, scroll)); \-\-exc\-search\-form, (exclude search -form, affects html (seg, scroll), manifest); \-\-exc\-minitoc, (exclude mini -table of contents, affects html (seg), concordance, manifest); -\-\-exc\-manifest\-minitoc, (exclude mini table of contents, affects manifest); -\-\-exc\-html\-minitoc, (exclude mini table of contents, affects html (seg), -concordance); \-\-exc\-html\-navigation, (exclude navigation, affects html -(seg)); \-\-exc\-html\-navigation\-bar, (exclude navigation bar, affects html -(seg)); \-\-exc\-html\-search\-form, (exclude search form, affects html (seg, -scroll)); \-\-exc\-html\-right\-pane, (exclude right pane/column, affects html -(seg, scroll)); \-\-exc\-html\-top\-band, (exclude top band, affects html (seg, +) , affects html (seg, scroll), epub, xhtml, xml, pdf) ; --exc-toc, (exclude +table of contents, affects html (scroll), epub, pdf) ; --exc-links-to-manifest, +--exc-manifest-links, (exclude links to manifest, affects html (seg, scroll)); +--exc-search-form, (exclude search form, affects html (seg, scroll), manifest); +--exc-minitoc, (exclude mini table of contents, affects html (seg), +concordance, manifest); --exc-manifest-minitoc, (exclude mini table of +contents, affects manifest); --exc-html-minitoc, (exclude mini table of +contents, affects html (seg), concordance); --exc-html-navigation, (exclude +navigation, affects html (seg)); --exc-html-navigation-bar, (exclude navigation +bar, affects html (seg)); --exc-html-search-form, (exclude search form, affects +html (seg, scroll)); --exc-html-right-pane, (exclude right pane/column, affects +html (seg, scroll)); --exc-html-top-band, (exclude top band, affects html (seg, scroll), concordance (minitoc forced on to provide seg navigation)); -\-\-exc\-segsubtoc (exclude sub table of contents, affects html (seg), epub) ; -see also \-\-inc\-* - +--exc-segsubtoc (exclude sub table of contents, affects html (seg), epub) ; see +also --inc-* .TP -.B \-F [\-\-webserv=webrick] -see \-\-sample\-search\-form - +.B -F [--webserv=webrick] +see --sample-search-form .TP -.B \-f [optional \ string \ part \ of \ filename] -see \-\-find - +.B -f [optional string part of filename] +see --find .TP -.B \-\-find [optional \ string \ part \ of \ filename] -without match string, glob all \.sst \.ssm files in directory (including -language subdirectories). With match string, find files that match given string -in directory (including language subdirectories). Alias \-f, \-\-glob, \-G - +.B --find [optional string part of filename] +without match string, glob all .sst .ssm files in directory (including language +subdirectories). With match string, find files that match given string in +directory (including language subdirectories). Alias -f, --glob, -G .TP -.B \-G [optional \ string \ part \ of \ filename] -see \-\-find - +.B -G [optional string part of filename] +see --find .TP -.B \-g [filename/wildcard] -see \-\-git - +.B -g [filename/wildcard] +see --git .TP -.B \-\-git [filename/wildcard] +.B --git [filename/wildcard] produces or updates markup source file structure in a git repo (experimental -and subject to change). Alias \-g - +and subject to change). Alias -g .TP -.B \-\-glob [optional \ string \ part \ of \ filename] -see \-\-find - +.B --glob [optional string part of filename] +see --find .TP -.B \-h [filename/wildcard] -see \-\-html - +.B -h [filename/wildcard] +see --html .TP -.B \-\-harvest *.ss[tm] +.B --harvest *.ss[tm] makes two lists of sisu output based on the sisu markup documents in a directory: list of author and authors works (year and titles), and; list by topic with titles and author. Makes use of header metadata fields (author, -title, date, topic_register). Can be used with maintenance (\-M) and remote -placement (\-R) flags. - +title, date, topic_register). Can be used with maintenance (-M) and remote +placement (-R) flags. .TP -.B \-\-help [topic] +.B --help [topic] provides help on the selected topic, where topics (keywords) include: list, (com)mands, short(cuts), (mod)ifiers, (env)ironment, markup, syntax, headers, headings, endnotes, tables, example, customise, skin, (dir)ectories, path, (lang)uage, db, install, setup, (conf)igure, convert, termsheet, search, sql, features, license. - .TP -.B \-\-html [filename/wildcard] +.B --html [filename/wildcard] produces html output, segmented text with table of contents (toc.html and -index.html) and the document in a single file (scroll.html). Alias \-h - +index.html) and the document in a single file (scroll.html). Alias -h .TP -.B \-I [filename/wildcard] -see \-\-texinfo - +.B -I [filename/wildcard] +see --texinfo .TP -.B \-i [filename/wildcard] -see \-\-manpage - +.B -i [filename/wildcard] +see --manpage .TP -.B \-\-inc\-* +.B --inc-* include output feature, overrides configuration settings, (usually the default -if none set), has precedence over \-\-exc\-* (exclude output feature). Some -detail provided under \-\-exc\-*, see \-\-exc\-* - +if none set), has precedence over --exc-* (exclude output feature). Some detail +provided under --exc-*, see --exc-* .TP -.B \-j [filename/wildcard] +.B -j [filename/wildcard] copies images associated with a file for use by html, xhtml & xml outputs -(automatically invoked by \-\-dump & redirect). - +(automatically invoked by --dump & redirect). .TP -.B \-\-keep\-processing\-files [filename/wildcard/url] -see \-\-maintenance - +.B -k +see --color-off .TP -.B \-L +.B --keep-processing-files [filename/wildcard/url] +see --maintenance +.TP +.B -L prints license information. - .TP -.B \-M [filename/wildcard/url] -see \-\-maintenance - +.B -M [filename/wildcard/url] +see --maintenance .TP -.B \-m [filename/wildcard/url] -see \-\-dal (document abstraction level/layer) - +.B -m [filename/wildcard/url] +see --dal (document abstraction level/layer) .TP -.B \-\-machine [filename/wildcard/url] -see \-\-dal (document abstraction level/layer) - +.B --machine [filename/wildcard/url] +see --dal (document abstraction level/layer) .TP -.B \-\-maintenance [filename/wildcard/url] +.B --maintenance [filename/wildcard/url] maintenance mode, interim processing files are preserved and their locations -indicated. (also see \-V). Aliases \-M and \-\-keep\-processing\-files. - +indicated. (also see -V). Aliases -M and --keep-processing-files. .TP -.B \-\-manpage [filename/wildcard] -produces man page of file, not suitable for all outputs. Alias \-i - +.B --manpage [filename/wildcard] +produces man page of file, not suitable for all outputs. Alias -i .TP -.B \-N [filename/wildcard/url] +.B -N [filename/wildcard/url] document digest or document content certificate ( DCC ) as md5 digest tree of the document: the digest for the document, and digests for each object contained within the document (together with information on software versions -that produced it) (digest.txt). \-NV for verbose digest output to screen. - +that produced it) (digest.txt). -NV for verbose digest output to screen. .TP -.B \-n [filename/wildcard/url] +.B -n [filename/wildcard/url] skip the creation of intermediate processing files (document abstraction) if -they already exist, this skips the equivalent of \-m which is otherwise assumed +they already exist, this skips the equivalent of -m which is otherwise assumed by most processing flags. - .TP -.B \-\-no\-* -see \-\-exc\-* - +.B --no-* +see --exc-* .TP -.B \-o [filename/wildcard/url] -see \-\-odt - +.B -o [filename/wildcard/url] +see --odt .TP -.B \-\-odf [filename/wildcard/url] -see \-\-odt - +.B --odf [filename/wildcard/url] +see --odt .TP -.B \-\-odt [filename/wildcard/url] -output basic document in opendocument file format (opendocument.odt). Alias \-o - +.B --odt [filename/wildcard/url] +output basic document in opendocument file format (opendocument.odt). Alias -o .TP -.B \-\-output\-by\-* -select output directory structure from 3 alternatives: -\-\-output\-by\-language, (language directory (based on language code) with -filetype (html, epub, pdf etc.) subdirectories); \-\-output\-by\-filetype, -(filetype directories with language code as part of filename); -\-\-output\-by\-filename, (filename directories with language code as part of -filename). This is configurable. Alias \-\-by\-* - +.B --output-by-* +select output directory structure from 3 alternatives: --output-by-language, +(language directory (based on language code) with filetype (html, epub, pdf +etc.) subdirectories); --output-by-filetype, (filetype directories with +language code as part of filename); --output-by-filename, (filename directories +with language code as part of filename). This is configurable. Alias --by-* .TP -.B \-P [language_directory/filename \ language_directory] -see \-\-po4a - +.B -P [language_directory/filename language_directory] +see --po4a .TP -.B \-p [filename/wildcard] -see \-\-pdf - +.B -p [filename/wildcard] +see --pdf .TP -.B \-\-pdf [filename/wildcard] +.B --pdf [filename/wildcard] produces .I LaTeX pdf (portrait.pdf & landscape.pdf). Default paper size is set in config file, or document header, or provided with additional command line parameter, e.g. -\-\-papersize\-a4 preset sizes include: 'A4', U.S. 'letter' and 'legal' and -book sizes 'A5' and 'B5' (system defaults to A4). Alias \-p - +--papersize-a4 preset sizes include: 'A4', U.S. 'letter' and 'legal' and book +sizes 'A5' and 'B5' (system defaults to A4). Alias -p .TP -.B \-\-pg [instruction] [filename] +.B --pg [instruction] [filename] database .I PostgreSQL -( \-\-pgsql may be used instead) possible instructions, include: \-\-createdb; -\-\-create; \-\-dropall; \-\-import [filename]; \-\-update [filename]; -\-\-remove [filename]; see database section below. Alias \-D - +( --pgsql may be used instead) possible instructions, include: --createdb; +--create; --dropall; --import [filename]; --update [filename]; --remove +[filename]; see database section below. Alias -D .TP -.B \-\-po [language_directory/filename \ language_directory] -see \-\-po4a - +.B --po [language_directory/filename language_directory] +see --po4a .TP -.B \-\-po4a [language_directory/filename \ language_directory] -produces \.pot and po files for the file in the languages specified by the +.B --po4a [language_directory/filename language_directory] +produces .pot and po files for the file in the languages specified by the language directory. .B SiSU markup is placed in subdirectories named with the language code, e.g. en/ fr/ es/. The sisu config file must set the output directory structure to multilingual. v3, experimental - .TP -.B \-Q [filename/wildcard] -see \-\-qrcode - +.B -Q [filename/wildcard] +see --qrcode .TP -.B \-q [filename/wildcard] -see \-\-quiet - +.B -q [filename/wildcard] +see --quiet .TP -.B \-\-qrcode [filename/wildcard] +.B --qrcode [filename/wildcard] generate QR code image of metadata (used in manifest). v3 only. - .TP -.B \-\-quiet [filename/wildcard] +.B --quiet [filename/wildcard] quiet less output to screen. - .TP -.B \-R [filename/wildcard] -see \-\-rsync - +.B -R [filename/wildcard] +see --rsync .TP -.B \-r [filename/wildcard] -see \-\-scp - +.B -r [filename/wildcard] +see --scp .TP -.B \-\-redirect[=directory_path] [filename/wildcard] +.B --redirect[=directory_path] [filename/wildcard] places output in subdirectory under specified directory, subdirectory uses the filename (without the suffix). If no output directory is specified places the -subdirectory under the current directory (pwd). Compare \-\-dump - +subdirectory under the current directory (pwd). Compare --dump .TP -.B \-\-rsync [filename/wildcard] +.B --rsync [filename/wildcard] copies sisu output files to remote host using rsync. This requires that sisurc.yml has been provided with information on hostname and username, and that you have your "keys" and ssh agent in place. Note the behavior of rsync -different if \-R is used with other flags from if used alone. Alone the rsync -\-\-delete parameter is sent, useful for cleaning the remote directory (when -\-R is used together with other flags, it is not). Also see \-\-scp. Alias \-R - +different if -R is used with other flags from if used alone. Alone the rsync +--delete parameter is sent, useful for cleaning the remote directory (when -R +is used together with other flags, it is not). Also see --scp. Alias -R .TP -.B \-S -see \-\-sisupod - +.B -S +see --sisupod .TP -.B \-S [filename/wildcard] -see \-\-sisupod - +.B -S [filename/wildcard] +see --sisupod .TP -.B \-s [filename/wildcard] -see \-\-source - +.B -s [filename/wildcard] +see --source .TP -.B \-\-sample\-search\-form [\-\-webserv=webrick] +.B --sample-search-form [--webserv=webrick] generate examples of (naive) cgi search form for .I SQLite and PgSQL depends on your already having used sisu to populate an @@ -614,22 +555,20 @@ and PgSQL depends on your already having used sisu to populate an and/or PgSQL database, (the .I SQLite version scans the output directories for existing sisu_sqlite databases, so it -is first necessary to create them, before generating the search form) see \-d -\-D and the database section below. If the optional parameter -\-\-webserv=webrick is passed, the cgi examples created will be set up to use -the default port set for use by the webrick server, (otherwise the port is left -blank and the system setting used, usually 80). The samples are dumped in the -present work directory which must be writable, (with screen instructions given -that they be copied to the cgi\-bin directory). Alias \-F - -.TP -.B \-\-scp [filename/wildcard] +is first necessary to create them, before generating the search form) see -d -D +and the database section below. If the optional parameter --webserv=webrick is +passed, the cgi examples created will be set up to use the default port set for +use by the webrick server, (otherwise the port is left blank and the system +setting used, usually 80). The samples are dumped in the present work directory +which must be writable, (with screen instructions given that they be copied to +the cgi-bin directory). Alias -F +.TP +.B --scp [filename/wildcard] copies sisu output files to remote host using scp. This requires that sisurc.yml has been provided with information on hostname and username, and -that you have your "keys" and ssh agent in place. Also see \-\-rsync. Alias \-r - +that you have your "keys" and ssh agent in place. Also see --rsync. Alias -r .TP -.B \-\-sqlite \-\-[instruction] [filename] +.B --sqlite --[instruction] [filename] database type set to .I SQLite, this produces one of two possible databases, without additional database @@ -640,23 +579,21 @@ common .I SQLite database of all processed documents that (come from the same document preparation directory and as a result) share the same output directory base -path (possible instructions include: \-\-createdb; \-\-create; \-\-dropall; -\-\-import [filename]; \-\-update [filename]; \-\-remove [filename]); see -database section below. Alias \-d - +path (possible instructions include: --createdb; --create; --dropall; --import +[filename]; --update [filename]; --remove [filename]); see database section +below. Alias -d .TP -.B \-\-sisupod +.B --sisupod produces a sisupod a zipped sisu directory of markup files including sisu markup source files and the directories local configuration file, images and skins. Note: this only includes the configuration files or skins contained in - \./_sisu not those in ~/.sisu \-S [filename/wildcard] option. Note: (this -option is tested only with zsh). Alias \-S - +./_sisu not those in ~/.sisu -S [filename/wildcard] option. Note: (this option +is tested only with zsh). Alias -S .TP -.B \-\-sisupod [filename/wildcard] +.B --sisupod [filename/wildcard] produces a zipped file of the prepared document specified along with associated images, by default named sisupod.zip they may alternatively be named with the -filename extension \.ssp This provides a quick way of gathering the relevant +filename extension .ssp This provides a quick way of gathering the relevant parts of a sisu document which can then for example be emailed. A sisupod includes sisu markup source file, (along with associated documents if a master file, or available in multilingual versions), together with related images and @@ -664,347 +601,303 @@ skin. .B SiSU commands can be run directly against a sisupod contained in a local directory, or provided as a url on a remote site. As there is a security issue with skins -provided by other users, they are not applied unless the flag \-\-trust or -\-\-trusted is added to the command instruction, it is recommended that file -that are not your own are treated as untrusted. The directory structure of the +provided by other users, they are not applied unless the flag --trust or +--trusted is added to the command instruction, it is recommended that file that +are not your own are treated as untrusted. The directory structure of the unzipped file is understood by sisu, and sisu commands can be run within it. Note: if you wish to send multiple files, it quickly becomes more space efficient to zip the sisu markup directory, rather than the individual files -for sending). See the \-S option without [filename/wildcard]. Alias \-S - +for sending). See the -S option without [filename/wildcard]. Alias -S .TP -.B \-\-source [filename/wildcard] -copies sisu markup file to output directory. Alias \-s - +.B --source [filename/wildcard] +copies sisu markup file to output directory. Alias -s .TP -.B \-T [filename/wildcard \ (*.termsheet.rb)] +.B -T [filename/wildcard (*.termsheet.rb)] standard form document builder, preprocessing feature - .TP -.B \-t [filename/wildcard] -see \-\-txt - +.B -t [filename/wildcard] +see --txt .TP -.B \-\-texinfo [filename/wildcard] -produces texinfo and info file, (view with pinfo). Alias \-I - +.B --texinfo [filename/wildcard] +produces texinfo and info file, (view with pinfo). Alias -I .TP -.B \-\-txt [filename/wildcard] +.B --txt [filename/wildcard] produces .I plaintext with Unix linefeeds and without markup, (object numbers are omitted), has -footnotes at end of each paragraph that contains them [ \ \-A \ for \ -equivalent \ dos \ (linefeed) \ output \ file] [see \ \-e \ for \ endnotes]. -(Options include: \-\-endnotes for endnotes \-\-footnotes for footnotes at the -end of each paragraph \-\-unix for unix linefeed (default) \-\-msdos for msdos -linefeed). Alias \-t - +footnotes at end of each paragraph that contains them [ -A for equivalent dos +(linefeed) output file] [see -e for endnotes]. (Options include: --endnotes for +endnotes --footnotes for footnotes at the end of each paragraph --unix for unix +linefeed (default) --msdos for msdos linefeed). Alias -t .TP -.B \-U [filename/wildcard] -see \-\-urls - +.B -U [filename/wildcard] +see --urls .TP -.B \-u [filename/wildcard] +.B -u [filename/wildcard] provides url mapping of output files for the flags requested for processing, -also see \-U - +also see -U .TP -.B \-\-urls [filename/wildcard] +.B --urls [filename/wildcard] prints url output list/map for the available processing flags options and resulting files that could be requested, (can be used to get a list of processing options in relation to a file, together with information on the -output that would be produced), \-u provides url output mapping for those flags +output that would be produced), -u provides url output mapping for those flags requested for processing. The default assumes sisu_webrick is running and provides webrick url mappings where appropriate, but these can be switched to -file system paths in sisurc.yml. Alias \-U - +file system paths in sisurc.yml. Alias -U .TP -.B \-V +.B -V on its own, provides .B SiSU -version and environment information (sisu \-\-help env) - +version and environment information (sisu --help env) .TP -.B \-V [filename/wildcard] -even more verbose than the \-v flag. - +.B -V [filename/wildcard] +even more verbose than the -v flag. .TP -.B \-v +.B -v on its own, provides .B SiSU version information - .TP -.B \-v [filename/wildcard] -see \-\-verbose - +.B -v [filename/wildcard] +see --verbose .TP -.B \-\-v3 [filename/wildcard] +.B --v3 [filename/wildcard] invokes the sisu v3 document parser/generator. You may run sisu3 instead. - .TP -.B \-\-v4 [filename/wildcard] +.B --v4 [filename/wildcard] invokes the sisu v4 document parser/generator. This is the default and is normally omitted. - .TP -.B \-\-verbose [filename/wildcard] +.B --verbose [filename/wildcard] provides verbose output of what is being generated, where output is placed (and -error messages if any), as with \-u flag provides a url mapping of files -created for each of the processing flag requests. Alias \-v - +error messages if any), as with -u flag provides a url mapping of files created +for each of the processing flag requests. Alias -v .TP -.B \-W -see \-\-webrick - +.B -W +see --webrick .TP -.B \-w [filename/wildcard] -see \-\-concordance - +.B -w [filename/wildcard] +see --concordance .TP -.B \-\-webrick +.B --webrick starts ruby' s webrick webserver points at sisu output directories, the default port is set to 8081 and can be changed in the resource configuration files. -[tip: \ the \ webrick \ server \ requires \ link \ suffixes, \ so \ html \ -output \ should \ be \ created \ using \ the \ \-h \ option \ rather \ than \ -\-H \ ; \ also, \ note \ \-F \ webrick \ ]. Alias \-W - +[tip: the webrick server requires link suffixes, so html output should be +created using the -h option rather than -H ; also, note -F webrick ]. Alias -W .TP -.B \-\-wordmap [filename/wildcard] -see \-\-concordance - +.B --wordmap [filename/wildcard] +see --concordance .TP -.B \-\-xhtml [filename/wildcard] +.B --xhtml [filename/wildcard] produces xhtml/ .I XML -output for browser viewing (sax parsing). Alias \-b - +output for browser viewing (sax parsing). Alias -b .TP -.B \-\-xml\-dom [filename/wildcard] +.B --xml-dom [filename/wildcard] produces .I XML -output with deep document structure, in the nature of dom. Alias \-X - +output with deep document structure, in the nature of dom. Alias -X .TP -.B \-\-xml\-sax [filename/wildcard] +.B --xml-sax [filename/wildcard] produces .I XML -output shallow structure (sax parsing). Alias \-x - +output shallow structure (sax parsing). Alias -x .TP -.B \-X [filename/wildcard] -see \-\-xml\-dom - +.B -X [filename/wildcard] +see --xml-dom .TP -.B \-x [filename/wildcard] -see \-\-xml\-sax - +.B -x [filename/wildcard] +see --xml-sax .TP -.B \-Y [filename/wildcard] +.B -Y [filename/wildcard] produces a short sitemap entry for the document, based on html output and the -sisu_manifest. \-\-sitemaps generates/updates the sitemap index of existing -sitemaps. (Experimental, [g,y,m \ announcement \ this \ week]) - +sisu_manifest. --sitemaps generates/updates the sitemap index of existing +sitemaps. (Experimental, [g,y,m announcement this week]) .TP -.B \-y [filename/wildcard] +.B -y [filename/wildcard] produces an html summary of output generated (hyperlinked to content) and document specific metadata (sisu_manifest.html). This step is assumed for most processing flags. - .TP -.B \-Z [filename/wildcard] -see \-\-zap - +.B -Z [filename/wildcard] +see --zap .TP -.B \-\-zap [filename/wildcard] +.B --zap [filename/wildcard] Zap, if used with other processing flags deletes output files of the type about -to be processed, prior to processing. If \-Z is used as the lone processing -related flag (or in conjunction with a combination of \-[mMvVq]), will remove -the related document output directory. Alias \-Z - +to be processed, prior to processing. If -Z is used as the lone processing +related flag (or in conjunction with a combination of -[mMvVq]), will remove +the related document output directory. Alias -Z .SH COMMAND LINE MODIFIERS -.br .TP -.B \-\-no\- -.I ocn -[with \ \-\-html \ \-\-pdf \ or \ \-\-epub] switches off +.B --no-ocn +[with --html --pdf or --epub] switches off .I object citation numbering. Produce output without identifying numbers in margins of html or .I LaTeX /pdf output. - .TP -.B \-\-no\-annotate +.B --no-annotate strips output text of editor endnotes[^*1] denoted by asterisk or dagger/plus sign - .TP -.B \-\-no\-asterisk +.B --no-asterisk strips output text of editor endnotes[^*2] denoted by asterisk sign - .TP -.B \-\-no\-dagger +.B --no-dagger strips output text of editor endnotes[^+1] denoted by dagger/plus sign - .SH DATABASE COMMANDS -.br -.br -.B dbi \- database interface +.BR +.B dbi - database interface -.br -.B \-D or \-\-pgsql +.BR +.B -D or --pgsql set for .I PostgreSQL -.B \-d or \-\-sqlite +.B -d or --sqlite default set for .I SQLite -\-d is modifiable with \-\-db=[database \ type \ (PgSQL \ or \ .I \ SQLite \ ) -\ ] - +-d is modifiable with --db=[database type (PgSQL or +.I SQLite +) ] .TP -.B \-\-pg \-v \-\-createall +.B --pg -v --createall initial step, creates required relations (tables, indexes) in existing .I PostgreSQL database (a database should be created manually and given the same name as -working directory, as requested) (rb.dbi) [ \ \-dv \ \-\-createall \ .I \ -SQLite \ equivalent] it may be necessary to run sisu \-Dv \-\-createdb -initially NOTE: at the present time for +working directory, as requested) (rb.dbi) [ -dv --createall +.I SQLite +equivalent] it may be necessary to run sisu -Dv --createdb initially NOTE: at +the present time for .I PostgreSQL it may be necessary to manually create the database. The command would be -'createdb [database \ name]' where database name would be SiSU_[present \ -working \ directory \ name \ (without \ path)]. Please use only alphanumerics -and underscores. - +'createdb [database name]' where database name would be SiSU_[present working +directory name (without path)]. Please use only alphanumerics and underscores. .TP -.B \-\-pg \-v \-\-import +.B --pg -v --import [filename/wildcard] imports data specified to .I PostgreSQL -db (rb.dbi) [ \ \-dv \ \-\-import \ .I \ SQLite \ equivalent] - +db (rb.dbi) [ -dv --import +.I SQLite +equivalent] .TP -.B \-\-pg \-v \-\-update +.B --pg -v --update [filename/wildcard] updates/imports specified data to .I PostgreSQL -db (rb.dbi) [ \ \-dv \ \-\-update \ .I \ SQLite \ equivalent] - +db (rb.dbi) [ -dv --update +.I SQLite +equivalent] .TP -.B \-\-pg \-\-remove +.B --pg --remove [filename/wildcard] removes specified data to .I PostgreSQL -db (rb.dbi) [ \ \-d \ \-\-remove \ .I \ SQLite \ equivalent] - +db (rb.dbi) [ -d --remove +.I SQLite +equivalent] .TP -.B \-\-pg \-\-dropall +.B --pg --dropall kills data" and drops ( .I PostgreSQL or .I SQLite -) db, tables & indexes [ \ \-d \ \-\-dropall \ .I \ SQLite \ equivalent] - -.br -The \-v is for verbose output. +) db, tables & indexes [ -d --dropall +.I SQLite +equivalent] +.BR +The -v is for verbose output. .SH SHORTCUTS, SHORTHAND FOR MULTIPLE FLAGS -.br .TP -.B \-\-update [filename/wildcard] +.B --update [filename/wildcard] Checks existing file output and runs the flags required to update this output. This means that if only html and pdf output was requested on previous runs, -only the \-hp files will be applied, and only these will be generated this -time, together with the summary. This can be very convenient, if you offer -different outputs of different files, and just want to do the same again. - +only the -hp files will be applied, and only these will be generated this time, +together with the summary. This can be very convenient, if you offer different +outputs of different files, and just want to do the same again. .TP -.B \-0 to \-5 [filename \ or \ wildcard] +.B -0 to -5 [filename or wildcard] Default shorthand mappings (for v3, note that the defaults can be changed/configured in the sisurc.yml file): - .TP -.B \-0 -\-NQhewpotbxXyYv [this \ is \ the \ default \ action \ run \ when \ no \ -options \ are \ give, \ i.e. \ on \ 'sisu \ [filename]'] - +.B -0 +-NQhewpotbxXyYv [this is the default action run when no options are give, i.e. +on 'sisu [filename]'] .TP -.B \-1 -\-Qhewpoty - +.B -1 +-Qhewpoty .TP -.B \-2 -\-NQhewpotbxXy - +.B -2 +-NQhewpotbxXy .TP -.B \-3 -\-NQhewpotbxXyY - +.B -3 +-NQhewpotbxXyY .TP -.B \-4 -\-NQhewpotbxXDyY \-\-update - +.B -4 +-NQhewpotbxXDyY --update .TP -.B \-5 -\-NQhewpotbxXDyYv \-\-update +.B -5 +-NQhewpotbxXDyYv --update -.br -add \-v for verbose mode and \-c to toggle color state, e.g. sisu \-2vc -[filename \ or \ wildcard] +.BR +add -v for verbose mode and -c to toggle color state, e.g. sisu -2vc [filename +or wildcard] -.br -consider \-u for appended url info or \-v for verbose output +.BR +consider -u for appended url info or -v for verbose output -.SH COMMAND LINE WITH FLAGS \- BATCH PROCESSING +.SH COMMAND LINE WITH FLAGS - BATCH PROCESSING -.br -In the data directory run sisu \-mh filename or wildcard eg. "sisu \-h -cisg.sst" or "sisu \-h *.{sst,ssm}" to produce html version of all documents. +.BR +In the data directory run sisu -mh filename or wildcard eg. "sisu -h cisg.sst" +or "sisu -h *.{sst,ssm}" to produce html version of all documents. -.br +.BR Running sisu (alone without any flags, filenames or wildcards) brings up the interactive help, as does any sisu command that is not recognised. Enter to escape. .SH HELP -.br .SH SISU MANUAL -.br +.BR The most up to date information on sisu should be contained in the sisu_manual, available at: -.br +.BR -.br +.BR The manual can be generated from source, found respectively, either within the .B SiSU tarball or installed locally at: -.br - ./data/doc/sisu/markup\-samples/sisu_manual +.BR + ./data/doc/sisu/markup-samples/sisu_manual -.br - /usr/share/doc/sisu/markup\-samples/sisu_manual +.BR + /usr/share/doc/sisu/markup-samples/sisu_manual -.br +.BR move to the respective directory and type e.g.: -.br +.BR sisu sisu_manual.ssm .SH SISU MAN PAGES -.br +.BR If .B SiSU is installed on your system usual man commands should be available, try: -.br +.BR man sisu -.br +.BR Most .B SiSU man pages are generated directly from sisu documents that are used to prepare @@ -1012,177 +905,175 @@ the sisu manual, the sources files for which are located within the .B SiSU tarball at: -.br - ./data/doc/sisu/markup\-samples/sisu_manual +.BR + ./data/doc/sisu/markup-samples/sisu_manual -.br +.BR Once installed, directory equivalent to: -.br - /usr/share/doc/sisu/markup\-samples/sisu_manual +.BR + /usr/share/doc/sisu/markup-samples/sisu_manual -.br +.BR Available man pages are converted back to html using man2html: -.br +.BR /usr/share/doc/sisu/html/ -.br +.BR ./data/doc/sisu/html -.br +.BR An online version of the sisu man page is available here: -.br +.BR * various sisu man pages [^9] -.br +.BR * sisu.1 [^10] .SH SISU BUILT\-IN INTERACTIVE HELP -.br +.BR This is particularly useful for getting the current sisu setup/environment information: -.br - sisu \-\-help +.BR + sisu --help -.br - sisu \-\-help [subject] +.BR + sisu --help [subject] -.br - sisu \-\-help commands +.BR +sisu --help commands -.br - sisu \-\-help markup +.BR +sisu --help markup -.br - sisu \-\-help env [for \ feedback \ on \ the \ way \ your \ system \ is \ - setup \ with \ regard \ to \ sisu \ ] +.BR +sisu --help env [for feedback on the way your system is setup with regard + to sisu ] -.br - sisu \-V [environment \ information, \ same \ as \ above \ command] +.BR + sisu -V [environment information, same as above command] -.br +.BR sisu (on its own provides version and some help information) -.br -Apart from real\-time information on your current configuration the +.BR +Apart from real-time information on your current configuration the .B SiSU -manual and man pages are likely to contain more up\-to\-date information than -the sisu interactive help (for example on commands and markup). +manual and man pages are likely to contain more up-to-date information than the +sisu interactive help (for example on commands and markup). -.br +.BR NOTE: Running the command sisu (alone without any flags, filenames or wildcards) brings up the interactive help, as does any sisu command that is not recognised. Enter to escape. .SH INTRODUCTION TO SISU MARKUP[^11] -.br .SH SUMMARY -.br +.BR .B SiSU source documents are .I plaintext ( -.I UTF\-8 +.I UTF-8 )[^12] files -.br +.BR All paragraphs are separated by an empty line. -.br +.BR Markup is comprised of: -.br -* at the top of a document, the document header made up of semantic meta\-data +.BR +* 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) -.br +.BR * 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: -.br +.BR * heading levels defines document structure -.br +.BR * text basic attributes, italics, bold etc. -.br +.BR * grouped text (objects), which are to be treated differently, such as code blocks or poems. -.br +.BR * footnotes/endnotes -.br +.BR * linked text and images -.br - * paragraph actions, such as indent, bulleted, numbered\-lists, etc. +.BR + * paragraph actions, such as indent, bulleted, numbered-lists, etc. -.br +.BR Some interactive help on markup is available, by typing sisu and selecting -markup or sisu \-\-help markup +markup or sisu --help markup -.br +.BR To check the markup in a file: -.br - sisu \-\-identify [filename].sst +.BR + sisu --identify [filename].sst -.br +.BR For brief descriptive summary of markup history -.br - sisu \-\-query\-history +.BR + sisu --query-history -.br +.BR or if for a particular version: -.br - sisu \-\-query\-0.38 - +.BR + sisu --query-0.38 .SH MARKUP EXAMPLES .SH ONLINE -.br +.BR Online markup examples are available together with the respective outputs produced from or from -.br +.BR There is of course this document, which provides a cursory overview of sisu markup and the respective output produced: -.br +.BR an alternative presentation of markup syntax: /usr/share/doc/sisu/on_markup.txt.gz .SH INSTALLED -.br +.BR With .B 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 +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 .SH MARKUP OF HEADERS -.br -.br -Headers contain either: semantic meta\-data about a document, which can be used + +.BR +Headers contain either: semantic meta-data about a document, which can be used by any output module of the program, or; processing instructions. -.br +.BR 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 @@ -1194,59 +1085,67 @@ a space and the comment: .SH SAMPLE HEADER -.br +.BR This current document is loaded by a master document that has a header similar to this one: .nf -% SiSU master 2.0 +% SiSU master 4.0 + @title: SiSU -:subtitle: Manual + :subtitle: Manual + @creator: -:author: Amissah, Ralph -@publisher: [publisher \ name] + :author: Amissah, Ralph + +@publisher: [publisher name] + @rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + @classify: -:type: information -:topic_register: SiSU:manual;electronic documents:SiSU:manual -:subject: ebook, epublishing, electronic book, electronic publishing, + :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 + :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] - . sisu \-\-v4 [operations] - . sisu \-\-v3 [operations] + :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] + . sisu --v4 [operations] + . sisu --v3 [operations] + @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/?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 + { 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/?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 .fi .SH AVAILABLE HEADERS -.br +.BR Header tags appear at the beginning of a document and provide meta information on the document (such as the .I Dublin Core @@ -1256,77 +1155,77 @@ by once space :subheadername: All .I Dublin Core meta tags are available -.br +.BR .B @indentifier: information or instructions -.br +.BR where the "identifier" is a tag recognised by the program, and the -"information" or "instructions" belong to the tag/indentifier specified +"information" or "instructions" belong to the tag/identifier specified -.br +.BR 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. -.br +.BR This is a sample header .nf -% SiSU 2.0 [declared \ file\-type \ identifier \ with \ markup \ version] +% SiSU 2.0 [declared file-type identifier with markup version] .fi .nf -@title: [title \ text] [this \ header \ is \ the \ only \ one \ that \ is \ mandatory] - :subtitle: [subtitle \ if \ any] +@title: [title text] [this header is the only one that is mandatory] + :subtitle: [subtitle if any] :language: English .fi .nf @creator: -:author: [Lastname, \ First \ names] -:illustrator: [Lastname, \ First \ names] -:translator: [Lastname, \ First \ names] -:prepared_by: [Lastname, \ First \ names] + :author: [Lastname, First names] + :illustrator: [Lastname, First names] + :translator: [Lastname, First names] + :prepared_by: [Lastname, First names] .fi .nf @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] + :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] .fi .nf @rights: -:copyright: Copyright (C) [Year \ and \ Holder] -:license: [Use \ License \ granted] -:text: [Year \ and \ Holder] -:translation: [Name, \ Year] -:illustrations: [Name, \ Year] + :copyright: Copyright (C) [Year and Holder] + :license: [Use License granted] + :text: [Year and Holder] + :translation: [Name, Year] + :illustrations: [Name, Year] .fi .nf @classify: -:topic_register: SiSU:markup sample:book;book:novel:fantasy -:type: -:subject: -:description: -:keywords: -:abstract: -:loc: [Library \ of \ Congress \ classification] -:dewey: Dewey classification + :topic_register: SiSU:markup sample:book;book:novel:fantasy + :type: + :subject: + :description: + :keywords: + :abstract: + :loc: [Library of Congress classification] + :dewey: [Dewey classification .fi .nf @identify: -:isbn: [ISBN] -:oclc: + :isbn: [ISBN] + :oclc: .fi .nf @@ -1336,495 +1235,534 @@ This is a sample header .nf @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 + :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 .fi .nf @original: -:language: [language] + :language: [language] .fi .nf @notes: -:comment: -:prefix: [prefix \ is \ placed \ just \ after \ table \ of \ contents] + :comment: + :prefix: [prefix is placed just after table of contents] .fi .SH MARKUP OF SUBSTANTIVE TEXT -.br .SH HEADING LEVELS -.br -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) +.BR +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) -.br -.B :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 +.BR +.B :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 -.br -.B :B~ [heading \ text] -Second level heading [this \ is \ a \ heading \ level \ divider] +.BR +.B :B~ [heading text] +Second level heading [this is a heading level divider] -.br -.B :C~ [heading \ text] -Third level heading [this \ is \ a \ heading \ level \ divider] +.BR +.B :C~ [heading text] +Third level heading [this is a heading level divider] -.br -.B 1~ [heading \ text] -Top level heading preceding substantive text of document or sub\-heading 2, the +.BR +.B 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 -.br -.B 2~ [heading \ text] -Second level heading preceding substantive text of document or sub\-heading 3 , +.BR +.B 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. -.br -.B 3~ [heading \ text] +.BR +.B 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 .nf 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) .fi .SH FONT ATTRIBUTES -.br +.BR .B markup example: - .nf normal text, *{emphasis}*, !{bold text}!, /{italics}/, _{underscore}_, "{citation}", -^{superscript}^, ,{subscript},, +{inserted text}+, \-{strikethrough}\-, #{monospace}# +^{superscript}^, ,{subscript},, +{inserted text}+, -{strikethrough}-, #{monospace}# + normal text -*{emphasis}* [note: \ can \ be \ configured \ to \ be \ represented \ by \ bold, \ italics \ or \ underscore] + +*{emphasis}* [note: can be configured to be represented by bold, italics or underscore] + !{bold text}! + /{italics}/ + _{underscore}_ + "{citation}" + ^{superscript}^ + ,{subscript}, + +{inserted text}+ -\-{strikethrough}\- + +-{strikethrough}- + #{monospace}# .fi -.br +.BR .B resulting output: -.br +.BR normal text, .B emphasis, .B bold text , .I italics, .I underscore, -"citation", ^superscript^, [subscript], ++inserted text++, -\-\-strikethrough\-\-, monospace +"citation", ^superscript^, [subscript], ++inserted text++, --strikethrough--, +monospace -.br +.BR normal text -.br +.BR .B emphasis -[note: \ can \ be \ configured \ to \ be \ represented \ by \ bold, \ italics \ -or \ underscore] +[note: can be configured to be represented by bold, italics or underscore] -.br +.BR .B bold text -.br +.BR .I italics -.br +.BR .I underscore -.br +.BR "citation" -.br +.BR ^superscript^ -.br +.BR [subscript] -.br +.BR ++inserted text++ -.br -\-\-strikethrough\-\- +.BR +--strikethrough-- -.br +.BR monospace .SH INDENTATION AND BULLETS -.br +.BR .B markup example: - .nf ordinary paragraph + _1 indent paragraph one step + _2 indent paragraph two steps + _9 indent paragraph nine steps .fi -.br +.BR .B resulting output: -.br +.BR ordinary paragraph -.br +.BR indent paragraph one step -.br +.BR indent paragraph two steps -.br +.BR indent paragraph nine steps -.br +.BR .B markup example: - .nf _* bullet text + _1* bullet text, first indent + _2* bullet text, two step indent .fi -.br +.BR .B resulting output: -.br +.BR * bullet text -.br +.BR * bullet text, first indent -.br +.BR * bullet text, two step indent -.br +.BR Numbered List (not to be confused with headings/titles, (document structure)) -.br +.BR .B markup example: - .nf # numbered list numbered list 1., 2., 3, etc. + _# numbered list numbered list indented a., b., c., d., etc. .fi .SH HANGING INDENTS -.br +.BR .B markup example: - .nf _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 + +in each case level may be 0-9 .fi -.br +.BR .B resulting output: -.br - first line no indent, rest of paragraph indented one step - -.br -first line indented, rest of paragraph no indent - -.br -in each case level may be 0\-9 - +.BR +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; + +.BR +A regular paragraph. + +.BR +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 + +.BR +in each case level may be 0-9 + +.BR +.B live-build + A collection of scripts used to build customized Debian + Livesystems. + .I live-build + was formerly known as live-helper, and even earlier known as live-package. + +.BR +.B 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. .SH FOOTNOTES / ENDNOTES -.br +.BR 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 -.br +.BR .B markup example: .nf ~{ a footnote or endnote }~ .fi -.br +.BR .B resulting output: -.br +.BR [^13] -.br +.BR .B markup example: - .nf normal text~{ self contained endnote marker & endnote in one }~ continues .fi -.br +.BR .B resulting output: -.br +.BR normal text[^14] continues -.br +.BR .B markup example: - .nf normal text ~{* unnumbered asterisk footnote/endnote, insert multiple asterisks if required }~ continues + normal text ~{** another unnumbered asterisk footnote/endnote }~ continues .fi -.br +.BR .B resulting output: -.br +.BR normal text [^*] continues -.br +.BR normal text [^**] continues -.br +.BR .B markup example: .nf -normal text ~[* \ editors \ notes, \ numbered \ asterisk \ footnote/endnote \ series \ ]~ continues -normal text ~[+ \ editors \ notes, \ numbered \ asterisk \ footnote/endnote \ series \ ]~ continues +normal text ~[* editors notes, numbered asterisk footnote/endnote series ]~ continues + +normal text ~[+ editors notes, numbered asterisk footnote/endnote series ]~ continues .fi -.br +.BR .B resulting output: -.br +.BR normal text [^*3] continues -.br +.BR normal text [^+2] continues -.br +.BR .B Alternative endnote pair notation for footnotes/endnotes: - .nf % note the endnote marker "~^" + normal text~^ continues + ^~ endnote text following the paragraph in which the marker occurs .fi -.br +.BR the standard and pair notation cannot be mixed in the same document .SH LINKS .SH NAKED URLS WITHIN TEXT, DEALING WITH URLS -.br +.BR 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). -.br +.BR .B markup example: - .nf normal text http://www.sisudoc.org/ continues .fi -.br +.BR .B resulting output: -.br +.BR normal text continues -.br +.BR An escaped url without decoration -.br +.BR .B markup example: - .nf normal text _http://www.sisudoc.org/ continues -deb _http://www.jus.uio.no/sisu/archive unstable main non\-free + +deb _http://www.jus.uio.no/sisu/archive unstable main non-free .fi -.br +.BR .B resulting output: -.br +.BR normal text <_http://www.sisudoc.org/> continues -.br -deb <_http://www.jus.uio.no/sisu/archive> unstable main non\-free +.BR +deb <_http://www.jus.uio.no/sisu/archive> unstable main non-free -.br +.BR where a code block is used there is neither decoration nor hyperlinking, code blocks are discussed later in this document -.br +.BR .B resulting output: - .nf -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 +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 .fi .SH LINKING TEXT -.br +.BR To link text or an image to a url the markup is as follows -.br +.BR .B markup example: - .nf about { SiSU }http://url.org markup .fi -.br +.BR .B resulting output: -.br +.BR aboutSiSU markup -.br +.BR A shortcut notation is available so the url link may also be provided automatically as a footnote -.br +.BR .B markup example: - .nf about {~^ SiSU }http://url.org markup .fi -.br +.BR .B resulting output: -.br +.BR aboutSiSU [^15] markup -.br -Internal document links to a tagged location, including an -.I ocn +.BR +Internal document links to a tagged location, including an ocn -.br +.BR .B markup example: - .nf about { text links }#link_text .fi -.br +.BR .B resulting output: -.br +.BR about ⌠text links⌡⌈link_text⌋ -.br +.BR Shared document collection link -.br +.BR .B markup example: - .nf about { SiSU book markup examples }:SiSU/examples.html .fi -.br +.BR .B resulting output: -.br +.BR about ⌠ .B SiSU book markup examples⌡⌈:SiSU/examples.html⌋ .SH LINKING IMAGES -.br +.BR .B markup example: - .nf { 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/ + +{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/ .fi -.br +.BR .B resulting output: -.br +.BR [ tux.png ] -.br -tux.png 64x80 "Gnu/Linux \- a better way" +.BR +tux.png 64x80 "Gnu/Linux - a better way" -.br -GnuDebianLinuxRubyBetterWay.png 100x101 "Way Better \- with Gnu/Linux, Debian +.BR +GnuDebianLinuxRubyBetterWay.png 100x101 "Way Better - with Gnu/Linux, Debian and Ruby" -.br -ruby_logo.png 70x90 "Ruby" [^16] +.BR +ruby_logo.png 70x90 "Ruby" [^16] -.br +.BR .B linked url footnote shortcut - .nf -{~^ [text \ to \ link] }http://url.org -% maps to: { [text \ to \ link] }http://url.org ~{ http://url.org }~ -% which produces hyper\-linked text within a document/paragraph, with an endnote providing the url for the text location used in the hyperlink +{~^ [text 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 .fi .nf text marker *~name .fi -.br +.BR 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. - +auto-heading numbering, without further intervention. .SH LINK SHORTCUT FOR MULTIPLE VERSIONS OF A SISU DOCUMENT IN THE SAME DIRECTORY TREE -.br +.BR .B markup example: - .nf !_ /{"Viral Spiral"}/, David Bollier + { "Viral Spiral", David Bollier [3sS]}viral_spiral.david_bollier.sst .fi -.br +.BR .B .I "Viral Spiral", David Bollier - "Viral Spiral", David Bollier document manifest ⌠html, segmented text⌡「http://corundum/sisu_manual/en/html/viral_spiral.david_bollier.html」 @@ -1845,38 +1783,41 @@ David Bollier .SH TABLES -.br +.BR Tables may be prepared in two either of two forms -.br +.BR .B markup example: - .nf 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 .fi -.br +.BR .B 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』 -.br +.BR a second form may be easier to work with in cases where there is not much information in each column -.br +.BR .B markup example: [^18] .nf -!_ Table 3.1: Contributors to Wikipedia, January 2001 \- June 2005 +!_ 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 @@ -1884,38 +1825,40 @@ Active contributors** | 9| 212| 846| 3,228| 8,4 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. .fi -.br +.BR .B resulting output: -.br -.B Table 3.1: Contributors to Wikipedia, January 2001 \- June 2005 - +.BR +.B 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』 -.br +.BR * Contributed at least ten times; ** at least 5 times in last month; *** more than 100 times in last month. .SH POEM -.br +.BR .B basic markup: - .nf poem{ + Your poem here + }poem + Each verse in a poem is given an object number. .fi -.br +.BR .B markup example: - .nf poem{ + `Fury said to a mouse, That he met in the @@ -1924,7 +1867,7 @@ poem{ both go to law: I will prosecute - YOU. \-\-Come, + YOU. --Come, I'll take no denial; We must have a @@ -1960,12 +1903,12 @@ poem{ you to death."' + }poem .fi -.br +.BR .B resulting output: - `Fury said to a mouse, That he met in the @@ -1974,7 +1917,7 @@ poem{ both go to law: I will prosecute - YOU. \-\-Come, + YOU. --Come, I'll take no denial; We must have a @@ -2013,21 +1956,23 @@ poem{ .SH GROUP -.br +.BR .B basic markup: - .nf group{ + Your grouped text here + }group + A group is treated as an object and given a single object number. .fi -.br +.BR .B markup example: - .nf group{ + `Fury said to a mouse, That he met in the @@ -2036,7 +1981,7 @@ group{ both go to law: I will prosecute - YOU. \-\-Come, + YOU. --Come, I'll take no denial; We must have a @@ -2072,12 +2017,12 @@ group{ you to death."' + }group .fi -.br +.BR .B resulting output: - `Fury said to a mouse, That he met in the @@ -2086,7 +2031,7 @@ group{ both go to law: I will prosecute - YOU. \-\-Come, + YOU. --Come, I'll take no denial; We must have a @@ -2125,22 +2070,20 @@ group{ .SH CODE -.br -Code tags code{ \... }code (used as with other group tags described above) are +.BR +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 .B 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. -.br -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] +.BR +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] -.br +.BR .B use of code tags instead of poem compared, resulting output: - .nf `Fury said to a mouse, That he @@ -2150,7 +2093,7 @@ some \ later \ time] both go to law: I will prosecute - YOU. \-\-Come, + YOU. --Come, I'll take no denial; We must have a @@ -2188,7 +2131,7 @@ some \ later \ time] death."' .fi -.br +.BR From .B SiSU 2.7.7 on you can number codeblocks by placing a hash after the opening code tag @@ -2203,7 +2146,7 @@ code{# as demonstrated here: 6 | both go to 7 | law: I will 8 | prosecute -9 | YOU. \-\-Come, +9 | YOU. --Come, 10 | I'll take no 11 | denial; We 12 | must have a @@ -2241,11 +2184,11 @@ code{# as demonstrated here: 44 | death."' .fi -.SH ADDITIONAL BREAKS \- LINEBREAKS WITHIN OBJECTS, COLUMN AND PAGE\-BREAKS +.SH ADDITIONAL BREAKS - LINEBREAKS WITHIN OBJECTS, COLUMN AND PAGE-BREAKS -.SH LINE\-BREAKS +.SH LINE-BREAKS -.br +.BR To break a line within a "paragraph object", two backslashes \e\e with a space before and a space or newline after them may be used. @@ -2257,34 +2200,33 @@ and a space or newline after them \e\e may be used. .fi -.br +.BR 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). .SH PAGE BREAKS -.br +.BR 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: -.br +.BR page new =\e= or breaks the page, starts a new page. -.br -page break \-\\- or breaks a column, starts a new column, if using columns, +.BR +page break -\\- or breaks a column, starts a new column, if using columns, else breaks the page, starts a new page. - .nf -\-\e\e\- +-\e\e- + or <:pb> .fi -.br +.BR or - .nf =\e\e= or @@ -2293,143 +2235,140 @@ or .SH BOOK INDEX -.br +.BR To make an index append to paragraph the book index term relates to it, using an equal sign and curly braces. -.br -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. - +.BR +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. .nf - Paragraph containing main term and sub\-term. - ={Main term:sub\-term} + Paragraph containing main term and sub-term. + ={Main term:sub-term} .fi -.br +.BR The index syntax starts on a new line, but there should not be an empty line between paragraph and index markup. -.br +.BR The structure of the resulting index would be: .nf Main term, 1 - sub\-term, 1 + sub-term, 1 .fi -.br +.BR 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. .nf - Paragraph containing main term, second term and sub\-term. - ={first term; second term: sub\-term} + Paragraph containing main term, second term and sub-term. + ={first term; second term: sub-term} .fi -.br +.BR The structure of the resulting index would be: - .nf First term, 1, Second term, 1, - sub\-term, 1 + sub-term, 1 .fi -.br -If multiple sub\-terms appear under one paragraph, they are separated under the +.BR +If multiple sub-terms appear under one paragraph, they are separated under the main term heading from each other by a pipe symbol. - .nf - Paragraph containing main term, second term and sub\-term. - ={Main term:sub\-term+1|second sub\-term} - A paragraph that continues discussion of the first sub\-term + Paragraph containing main term, second term and sub-term. + ={Main term:sub-term+1|second sub-term} + + A paragraph that continues discussion of the first sub-term .fi -.br -The plus one in the example provided indicates the first sub\-term spans one +.BR +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: - .nf Main term, 1, - sub\-term, 1\-3, - second sub\-term, 1, + sub-term, 1-3, + second sub-term, 1, .fi .SH COMPOSITE DOCUMENTS MARKUP -.br -.br +.BR 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 -.B \.ssm +.B .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 -.B \.sst +.B .sst regular markup file, or -.B \.ssi +.B .ssi (insert/information) A secondary file of the composite document is built prior to processing with the same prefix and the suffix -.B \._sst +.B ._sst -.br +.BR basic markup for importing a document into a master document .nf << filename1.sst + << filename2.ssi .fi -.br +.BR The form described above should be relied on. Within the .I Vim editor it results in the text thus linked becoming hyperlinked to the document it is calling in which is convenient for editing. .SH SISU FILETYPES -.br -.br +.BR .B SiSU has .I plaintext and binary filetypes, and can process either type of document. -.SH .SST \.SSM \.SSI MARKED UP PLAIN TEXT +.SH .SST .SSM .SSI MARKED UP PLAIN TEXT .TP -.B SiSU¤b〕 documents are prepared as plain\-text (utf\-8) files with +.B SiSU +documents are prepared as plain-text (utf-8) files with .B SiSU markup. They may make reference to and contain images (for example), which are stored in the directory beneath them _sisu/image. 〔b¤SiSU .I plaintext markup files are of three types that may be distinguished by the file extension -used: regular text \.sst; master documents, composite documents that -incorporate other text, which can be any regular text or text insert; and -inserts the contents of which are like regular text except these are marked - \.ssi and are not processed. +used: regular text .sst; master documents, composite documents that incorporate +other text, which can be any regular text or text insert; and inserts the +contents of which are like regular text except these are marked .ssi and are +not processed. -.br +.BR .B SiSU processing can be done directly against a sisu documents; which may be located locally or on a remote server for which a url is provided. -.br +.BR .B SiSU source markup can be shared with the command: -.br - sisu \-s [filename] +.BR + sisu -s [filename] -.SH SISU TEXT \- REGULAR FILES (.SST) +.SH SISU TEXT - REGULAR FILES (.SST) -.br +.BR The most common form of document in .B SiSU, see the section on @@ -2438,15 +2377,15 @@ markup. .SH SISU MASTER FILES (.SSM) -.br +.BR Composite documents which incorporate other .B SiSU documents which may be either regular .B SiSU -text \.sst which may be generated independently, or inserts prepared solely for +text .sst which may be generated independently, or inserts prepared solely for the purpose of being incorporated into one or more master documents. -.br +.BR The mechanism by which master files incorporate other documents is described as one of the headings under under .B SiSU @@ -2454,48 +2393,46 @@ markup in the .B SiSU manual. -.br +.BR Note: Master documents may be prepared in a similar way to regular documents, -and processing will occur normally if a \.sst file is renamed \.ssm without -requiring any other documents; the \.ssm marker flags that the document may +and processing will occur normally if a .sst file is renamed .ssm without +requiring any other documents; the .ssm marker flags that the document may contain other documents. -.br +.BR Note: a secondary file of the composite document is built prior to processing -with the same prefix and the suffix \._sst [^19] - +with the same prefix and the suffix ._sst [^19] .SH SISU INSERT FILES (.SSI) -.br +.BR Inserts are documents prepared solely for the purpose of being incorporated into one or more master documents. They resemble regular .B SiSU text files except they are ignored by the .B SiSU -processor. Making a file a \.ssi file is a quick and convenient way of flagging +processor. Making a file a .ssi file is a quick and convenient way of flagging that it is not intended that the file should be processed on its own. +.SH SISUPOD, ZIPPED BINARY CONTAINER (SISUPOD.ZIP, .SSP) -.SH SISUPOD, ZIPPED BINARY CONTAINER (SISUPOD.ZIP, \.SSP) - -.br +.BR A sisupod is a zipped .B SiSU text file or set of .B SiSU text files and any associated images that they contain (this will be extended -to include sound and multimedia\-files) +to include sound and multimedia-files) .TP .B SiSU .I plaintext files rely on a recognised directory structure to find contents such as images associated with documents, but all images for example for all documents -contained in a directory are located in the sub\-directory _sisu/image. Without +contained in a directory are located in the sub-directory _sisu/image. Without the ability to create a sisupod it can be inconvenient to manually identify all other files associated with a document. A sisupod automatically bundles all associated files with the document that is turned into a pod. -.br +.BR The structure of the sisupod is such that it may for example contain a single document and its associated images; a master document and its associated documents and anything else; or the zipped contents of a whole directory of @@ -2503,201 +2440,204 @@ prepared .B SiSU documents. -.br +.BR The command to create a sisupod is: -.br - sisu \-S [filename] +.BR + sisu -S [filename] -.br +.BR Alternatively, make a pod of the contents of a whole directory: -.br - sisu \-S +.BR + sisu -S -.br +.BR .B SiSU processing can be done directly against a sisupod; which may be located locally or on a remote server for which a url is provided. -.br +.BR -.br +.BR .SH CONFIGURATION -.br .SH CONFIGURATION FILES .SH CONFIG.YML -.br +.BR .B SiSU configration parameters are adjusted in the configuration file, which can be used to override the defaults set. This includes such things as which directory interim processing should be done in and where the generated output should be placed. -.br +.BR The .B SiSU configuration file is a yaml file, which means indentation is significant. -.br +.BR .B SiSU resource configuration is determined by looking at the following files if they exist: -.br +.BR ./_sisu/v4/sisurc.yml -.br +.BR ./_sisu/sisurc.yml -.br +.BR ~/.sisu/v4/sisurc.yml -.br +.BR ~/.sisu/sisurc.yml -.br +.BR /etc/sisu/v4/sisurc.yml -.br +.BR /etc/sisu/sisurc.yml -.br +.BR The search is in the order listed, and the first one found is used. -.br +.BR In the absence of instructions in any of these it falls back to the internal program defaults. -.br +.BR Configuration determines the output and processing directories and the database access details. -.br +.BR If .B SiSU is installed a sample sisurc.yml may be found in /etc/sisu/sisurc.yml .SH SISU_DOCUMENT_MAKE -.br +.BR Most sisu document headers relate to metadata, the exception is the @make: header which provides processing related information. The default contents of the @make header may be set by placing them in a file sisu_document_make. -.br +.BR The search order is as for resource configuration: -.br +.BR ./_sisu/v4/sisu_document_make -.br +.BR ./_sisu/sisu_document_make -.br +.BR ~/.sisu/v4/sisu_document_make -.br +.BR ~/.sisu/sisu_document_make -.br +.BR /etc/sisu/v4/sisu_document_make -.br +.BR /etc/sisu/sisu_document_make -.br +.BR A sample sisu_document_make can be found in the _sisu/ directory under along with the provided sisu markup samples. -.SH CSS \- CASCADING STYLE SHEETS (FOR HTML, XHTML AND XML) -.br +.SH CSS - CASCADING STYLE SHEETS (FOR HTML, XHTML AND XML) -.br +.BR CSS files to modify the appearance of .B SiSU html, .I XHTML or .I XML -may be placed in the configuration directory: \./_sisu/css ; ~/.sisu/css or; +may be placed in the configuration directory: ./_sisu/css ; ~/.sisu/css or; /etc/sisu/css and these will be copied to the output directories with the -command sisu \-CC. +command sisu -CC. -.br +.BR The basic CSS file for html output is html. css, placing a file of that name in directory _sisu/css or equivalent will result in the default file of that name being overwritten. -.br +.BR .I HTML: html. css -.br +.BR .I XML DOM: dom.css -.br +.BR .I XML SAX: sax.css -.br +.BR .I XHTML: xhtml. css -.br +.BR The default homepage may use homepage.css or html. css -.br +.BR Under consideration is to permit the placement of a CSS file with a different name in directory _sisu/css directory or equivalent.[^20] -.SH ORGANISING CONTENT \- DIRECTORY STRUCTURE AND MAPPING -.br +.SH ORGANISING CONTENT - DIRECTORY STRUCTURE AND MAPPING -.br +.BR .B SiSU v3 has new options for the source directory tree, and output directory structures of which there are 3 alternatives. .SH DOCUMENT SOURCE DIRECTORY -.br +.BR The document source directory is the directory in which sisu processing -commands are given. It contains the sisu source files (.sst \.ssm \.ssi), or -(for sisu v3 may contain) subdirectories with language codes which contain the -sisu source files, so all English files would go in subdirectory en/, French in -fr/, Spanish in es/ and so on. ISO 639\-1 codes are used (as varied by po4a). A -list of available languages (and possible sub\-directory names) can be obtained -with the command "sisu \-\-help lang" The list of languages is limited to -langagues supported by XeTeX polyglosia. - +commands are given. It contains the sisu source files (.sst .ssm .ssi), or (for +sisu v3 may contain) subdirectories with language codes which contain the sisu +source files, so all English files would go in subdirectory en/, French in fr/, +Spanish in es/ and so on. ISO 639-1 codes are used (as varied by po4a). A list +of available languages (and possible sub-directory names) can be obtained with +the command "sisu --help lang" The list of languages is limited to langagues +supported by XeTeX polyglosia. .SH GENERAL DIRECTORIES .nf -./subject_name/ + ./subject_name/ + % files stored at this level e.g. sisu_manual.sst or -% for sisu v3 may be under language sub\-directories +% for sisu v3 may be under language sub-directories % e.g. - \./subject_name/en - \./subject_name/fr - \./subject_name/es - \./subject_name/_sisu - \./subject_name/_sisu/css - \./subject_name/_sisu/image + + ./subject_name/en + + ./subject_name/fr + + ./subject_name/es + + ./subject_name/_sisu + + ./subject_name/_sisu/css + + ./subject_name/_sisu/image .fi .SH DOCUMENT OUTPUT DIRECTORY STRUCTURES .SH OUTPUT DIRECTORY ROOT -.br +.BR The output directory root can be set in the sisurc.yml file. Under the root, subdirectories are made for each directory in which a document set resides. If you have a directory named poems or conventions, that directory will be created @@ -2705,10 +2645,10 @@ under the output directory root and the output for all documents contained in the directory of a particular name will be generated to subdirectories beneath that directory (poem or conventions). A document will be placed in a subdirectory of the same name as the document with the filetype identifier -stripped (.sst \.ssm) +stripped (.sst .ssm) -.br -The last part of a directory path, representing the sub\-directory in which a +.BR +The last part of a directory path, representing the sub-directory in which a document set resides, is the directory name that will be used for the output directory. This has implications for the organisation of document collections as it could make sense to place documents of a particular subject, or type @@ -2725,7 +2665,7 @@ appearance. .SH ALTERNATIVE OUTPUT STRUCTURES -.br +.BR There are 3 possibile output structures described as being, by language, by filetype or by filename, the selection is made in sisurc.yml @@ -2738,171 +2678,190 @@ output_dir_structure_by: language #(language & filetype, preferred?) .SH BY LANGUAGE -.br +.BR The by language directory structure places output files -.br +.BR The by language directory structure separates output files by language code (all files of a given language), and within the language directory by filetype. -.br +.BR Its selection is configured in sisurc.yml -.br +.BR output_dir_structure_by: language .nf - |\-\- en - |\-\- epub - |\-\- hashes - |\-\- html - | |\-\- viral_spiral.david_bollier - | |\-\- manifest - | |\-\- qrcode - | |\-\- odt - | |\-\- pdf - | |\-\- sitemaps - | |\-\- txt - | |\-\- xhtml - | `\-\- xml - |\-\- po4a - | `\-\- live\-manual - | |\-\- po - | |\-\- fr - | `\-\- pot - `\-\- _sisu - |\-\- css - |\-\- image - |\-\- image_sys \-> \../../_sisu/image_sys - `\-\- xml - |\-\- rnc - |\-\- rng - `\-\- xsd + |-- en + |-- epub + |-- hashes + |-- html + | |-- viral_spiral.david_bollier + | |-- manifest + | |-- qrcode + | |-- odt + | |-- pdf + | |-- sitemaps + | |-- txt + | |-- xhtml + | `-- xml + |-- po4a + | `-- live-manual + | |-- po + | |-- fr + | `-- pot + `-- _sisu + |-- css + |-- image + |-- image_sys -> ../../_sisu/image_sys + `-- xml + |-- rnc + |-- rng + `-- xsd .fi -.br +.BR #by: language subject_dir/en/manifest/filename.html .SH BY FILETYPE -.br +.BR The by filetype directory structure separates output files by filetype, all html files in one directory pdfs in another and so on. Filenames are given a language extension. -.br +.BR Its selection is configured in sisurc.yml -.br +.BR output_dir_structure_by: filetype .nf - |\-\- epub - |\-\- hashes - |\-\- html - |\-\- viral_spiral.david_bollier - |\-\- manifest - |\-\- qrcode - |\-\- odt - |\-\- pdf - |\-\- po4a - |\-\- live\-manual - | |\-\- po - | |\-\- fr - | `\-\- pot - |\-\- _sisu - | |\-\- css - | |\-\- image - | |\-\- image_sys \-> \../../_sisu/image_sys - | `\-\- xml - | |\-\- rnc - | |\-\- rng - | `\-\- xsd - |\-\- sitemaps - |\-\- txt - |\-\- xhtml - `\-\- xml + |-- epub + |-- hashes + |-- html + |-- viral_spiral.david_bollier + |-- manifest + |-- qrcode + |-- odt + |-- pdf + |-- po4a + |-- live-manual + | |-- po + | |-- fr + | `-- pot + |-- _sisu + | |-- css + | |-- image + | |-- image_sys -> ../../_sisu/image_sys + | `-- xml + | |-- rnc + | |-- rng + | `-- xsd + |-- sitemaps + |-- txt + |-- xhtml + `-- xml .fi -.br +.BR #by: filetype subject_dir/html/filename/manifest.en.html .SH BY FILENAME -.br +.BR The by filename directory structure places most output of a particular file (the different filetypes) in a common directory. -.br +.BR Its selection is configured in sisurc.yml -.br +.BR output_dir_structure_by: filename .nf - |\-\- epub - |\-\- po4a - |\-\- live\-manual - | |\-\- po - | |\-\- fr - | `\-\- pot - |\-\- _sisu - | |\-\- css - | |\-\- image - | |\-\- image_sys \-> \../../_sisu/image_sys - | `\-\- xml - | |\-\- rnc - | |\-\- rng - | `\-\- xsd - |\-\- sitemaps - |\-\- src - |\-\- pod - `\-\- viral_spiral.david_bollier + |-- epub + |-- po4a + |-- live-manual + | |-- po + | |-- fr + | `-- pot + |-- _sisu + | |-- css + | |-- image + | |-- image_sys -> ../../_sisu/image_sys + | `-- xml + | |-- rnc + | |-- rng + | `-- xsd + |-- sitemaps + |-- src + |-- pod + `-- viral_spiral.david_bollier .fi -.br +.BR #by: filename subject_dir/filename/manifest.en.html .SH REMOTE DIRECTORIES .nf -./subject_name/ + ./subject_name/ + % containing sub_directories named after the generated files from which they are made - \./subject_name/src + + ./subject_name/src + % contains shared source files text and binary e.g. sisu_manual.sst and sisu_manual.sst.zip - \./subject_name/_sisu + + ./subject_name/_sisu + % configuration file e.g. sisurc.yml - \./subject_name/_sisu/skin + + ./subject_name/_sisu/skin + % skins in various skin directories doc, dir, site, yml - \./subject_name/_sisu/css - \./subject_name/_sisu/image + + ./subject_name/_sisu/css + + ./subject_name/_sisu/image + % images for documents contained in this directory - \./subject_name/_sisu/mm + + ./subject_name/_sisu/mm .fi .SH SISUPOD .nf -./sisupod/ + ./sisupod/ + % files stored at this level e.g. sisu_manual.sst - \./sisupod/_sisu + + ./sisupod/_sisu + % configuration file e.g. sisurc.yml - \./sisupod/_sisu/skin + + ./sisupod/_sisu/skin + % skins in various skin directories doc, dir, site, yml - \./sisupod/_sisu/css - \./sisupod/_sisu/image + + ./sisupod/_sisu/css + + ./sisupod/_sisu/image + % images for documents contained in this directory - \./sisupod/_sisu/mm + + ./sisupod/_sisu/mm .fi .SH ORGANISING CONTENT .SH HOMEPAGES -.br -.br +.BR .B SiSU -is about the ability to auto\-generate documents. Home pages are regarded as +is about the ability to auto-generate documents. Home pages are regarded as custom built items, and are not created by .B SiSU. More accurately, @@ -2911,179 +2870,176 @@ has a default home page, which will not be appropriate for use with other sites, and the means to provide your own home page instead in one of two ways as part of a site's configuration, these being: -.br +.BR 1. through placing your home page and other custom built documents in the subdirectory _sisu/home/ (this probably being the easier and more convenient option) -.br +.BR 2. through providing what you want as the home page in a skin, -.br +.BR Document sets are contained in directories, usually organised by site or subject. Each directory can/should have its own homepage. See the section on directory structure and organisation of content. -.SH HOME PAGE AND OTHER CUSTOM BUILT PAGES IN A SUB\-DIRECTORY +.SH HOME PAGE AND OTHER CUSTOM BUILT PAGES IN A SUB-DIRECTORY -.br +.BR Custom built pages, including the home page index.html may be placed within the configuration directory _sisu/home/ in any of the locations that is searched -for the configuration directory, namely \./_sisu ; ~/_sisu ; /etc/sisu From +for the configuration directory, namely ./_sisu ; ~/_sisu ; /etc/sisu From there they are copied to the root of the output directory with the command: -.br - sisu \-CC - +.BR + sisu -CC .SH MARKUP AND OUTPUT EXAMPLES -.br .SH MARKUP EXAMPLES -.br +.BR Current markup examples and document output samples are provided off or and in the sisu -\-markup\-sample package available off +-markup-sample package available off -.br +.BR For some documents hardly any markup at all is required at all, other than a header, and an indication that the levels to be taken into account by the program in generating its output are. .SH SISU MARKUP SAMPLES -.br +.BR A few additional sample books prepared as sisu markup samples, output formats to be generated using .B SiSU -are contained in a separate package sisu \-markup\-samples. sisu -\-markup\-samples contains books (prepared using sisu markup), that were -released by their authors various licenses mostly different Creative Commons -licences that do not permit inclusion in the +are contained in a separate package sisu -markup-samples. sisu -markup-samples +contains books (prepared using sisu markup), that were released by their +authors various licenses mostly different Creative Commons licences that do not +permit inclusion in the .B Debian Project as they have requirements that do not meet the .B Debian Free Software Guidelines for various reasons, most commonly that they require that the original substantive text remain unchanged, and sometimes that the -works be used only non\-commercially. +works be used only non-commercially. -.br +.BR .I Accelerando, Charles Stross (2005) accelerando.charles_stross.sst -.br +.BR .I Alice's Adventures in Wonderland, Lewis Carroll (1865) alices_adventures_in_wonderland.lewis_carroll.sst -.br +.BR .I CONTENT, Cory Doctorow (2008) content.cory_doctorow.sst -.br +.BR .I Democratizing Innovation, Eric von Hippel (2005) democratizing_innovation.eric_von_hippel.sst -.br +.BR .I Down and Out in the Magic Kingdom, Cory Doctorow (2003) down_and_out_in_the_magic_kingdom.cory_doctorow.sst -.br +.BR .I For the Win, Cory Doctorow (2010) for_the_win.cory_doctorow.sst -.br -.I Free as in Freedom \- Richard Stallman's Crusade for Free Software, +.BR +.I Free as in Freedom - Richard Stallman's Crusade for Free Software, Sam Williams (2002) free_as_in_freedom.richard_stallman_crusade_for_free_software.sam_williams.sst -.br -.I Free as in Freedom 2.0 \- Richard Stallman and the Free Software Revolution, +.BR +.I Free as in Freedom 2.0 - Richard Stallman and the Free Software Revolution, Sam Williams (2002), Richard M. Stallman (2010) free_as_in_freedom_2.richard_stallman_and_the_free_software_revolution.sam_williams.richard_stallman.sst -.br -.I Free Culture \- How Big Media Uses Technology and the Law to Lock Down +.BR +.I Free Culture - How Big Media Uses Technology and the Law to Lock Down Culture and Control Creativity, Lawrence Lessig (2004) free_culture.lawrence_lessig.sst -.br -.I Free For All \- How Linux and the Free Software Movement Undercut the High +.BR +.I Free For All - How Linux and the Free Software Movement Undercut the High Tech Titans, Peter Wayner (2002) free_for_all.peter_wayner.sst -.br +.BR .I GNU GENERAL PUBLIC LICENSE v2, Free Software Foundation (1991) gpl2.fsf.sst -.br +.BR .I GNU GENERAL PUBLIC LICENSE v3, Free Software Foundation (2007) gpl3.fsf.sst -.br +.BR .I Gulliver's Travels, Jonathan Swift (1726 / 1735) gullivers_travels.jonathan_swift.sst -.br +.BR .I Little Brother, Cory Doctorow (2008) little_brother.cory_doctorow.sst -.br +.BR .I The Cathederal and the Bazaar, Eric Raymond (2000) the_cathedral_and_the_bazaar.eric_s_raymond.sst -.br -.I The Public Domain \- Enclosing the Commons of the Mind, +.BR +.I The Public Domain - Enclosing the Commons of the Mind, James Boyle (2008) the_public_domain.james_boyle.sst -.br -.I The Wealth of Networks \- How Social Production Transforms Markets and +.BR +.I The Wealth of Networks - How Social Production Transforms Markets and Freedom, Yochai Benkler (2006) the_wealth_of_networks.yochai_benkler.sst -.br +.BR .I Through the Looking Glass, Lewis Carroll (1871) through_the_looking_glass.lewis_carroll.sst -.br -.I Two Bits \- The Cultural Significance of Free Software, +.BR +.I Two Bits - The Cultural Significance of Free Software, Christopher Kelty (2008) two_bits.christopher_kelty.sst -.br +.BR .I UN Contracts for International Sale of Goods, UN (1980) un_contracts_international_sale_of_goods_convention_1980.sst -.br +.BR .I Viral Spiral, David Bollier (2008) viral_spiral.david_bollier.sst -.SH SISU SEARCH \- INTRODUCTION -.br +.SH SISU SEARCH - INTRODUCTION -.br +.BR .B SiSU output can easily and conveniently be indexed by a number of standalone indexing tools, such as Lucene, Hyperestraier. -.br +.BR Because the document structure of sites created is clearly defined, and the text .I object citation system @@ -3091,7 +3047,7 @@ is available hypothetically at least, for all forms of output, it is possible to search the sql database, and either read results from that database, or just as simply map the results to the html output, which has richer text markup. -.br +.BR In addition to this .B SiSU has the ability to populate a relational sql type database with documents at an @@ -3102,11 +3058,10 @@ each document, which can be viewed within the database directly or in various output formats. .SH SQL -.br .SH POPULATING SQL TYPE DATABASES -.br +.BR .B SiSU feeds sisu markupd documents into sql type databases .I PostgreSQL @@ -3114,39 +3069,39 @@ feeds sisu markupd documents into sql type databases .I SQLite [^22] database together with information related to document structure. -.br +.BR This is one of the more interesting output forms, as all the structural data of the documents are retained (though can be ignored by the user of the database should they so choose). All site texts/documents are (currently) streamed to four tables: -.br +.BR * one containing semantic (and other) headers, including, title, author, subject, (the .I Dublin Core. ..); -.br - * another the substantive texts by individual "paragraph" (or object) \- - along with structural information, each paragraph being identifiable by its +.BR + * another the substantive texts by individual "paragraph" (or object) - along + with structural information, each paragraph being identifiable by its paragraph number (if it has one which almost all of them do), and the substantive text of each paragraph quite naturally being searchable (both in formatted and clean text versions for searching); and -.br - * a third containing endnotes cross\-referenced back to the paragraph from +.BR + * a third containing endnotes cross-referenced back to the paragraph from which they are referenced (both in formatted and clean text versions for searching). -.br +.BR * a fourth table with a one to one relation with the headers table contains full text versions of output, eg. pdf, html, xml, and .I ascii. -.br +.BR There is of course the possibility to add further structures. -.br +.BR At this level .B SiSU loads a relational database with documents chunked into objects, their smallest @@ -3156,7 +3111,7 @@ document. Text is stored (at this text object level) with and without elementary markup tagging, the stripped version being so as to facilitate ease of searching. -.br +.BR Being able to search a relational database at an object level with the .B SiSU citation system is an effective way of locating content generated by @@ -3173,181 +3128,176 @@ headings etc. (as the is incorporated it is easy to make use of that as well). .SH POSTGRESQL -.br .SH NAME -.br +.BR .B SiSU -\- Structured information, Serialized Units \- a document publishing system, +- Structured information, Serialized Units - a document publishing system, postgresql dependency package .SH DESCRIPTION -.br +.BR Information related to using postgresql with sisu (and related to the sisu_postgresql dependency package, which is a dummy package to install dependencies needed for .B SiSU to populate a postgresql database, this being part of .B SiSU -\- man sisu) . +- man sisu) . .SH SYNOPSIS -.br - sisu \-D [instruction] [filename/wildcard \ if \ required] - -.br - sisu \-D \-\-pg \-\-[instruction] [filename/wildcard \ if \ required] +.BR + sisu -D [instruction] [filename/wildcard if required] +.BR + sisu -D --pg --[instruction] [filename/wildcard if required] .SH COMMANDS -.br +.BR Mappings to two databases are provided by default, postgresql and sqlite, the same commands are used within sisu to construct and populate databases however -\-d (lowercase) denotes sqlite and \-D (uppercase) denotes postgresql, -alternatively \-\-sqlite or \-\-pgsql may be used +-d (lowercase) denotes sqlite and -D (uppercase) denotes postgresql, +alternatively --sqlite or --pgsql may be used -.br -.B \-D or \-\-pgsql +.BR +.B -D or --pgsql may be used interchangeably. .SH CREATE AND DESTROY DATABASE .TP -.B \-\-pgsql \-\-createall +.B --pgsql --createall initial step, creates required relations (tables, indexes) in existing (postgresql) database (a database should be created manually and given the same name as working directory, as requested) (rb.dbi) .TP -.B sisu \-D \-\-createdb +.B sisu -D --createdb creates database where no database existed before .TP -.B sisu \-D \-\-create +.B sisu -D --create creates database tables where no database tables existed before .TP -.B sisu \-D \-\-Dropall +.B sisu -D --Dropall destroys database (including all its content)! kills data and drops tables, indexes and database associated with a given directory (and directories of the same name). .TP -.B sisu \-D \-\-recreate +.B sisu -D --recreate destroys existing database and builds a new empty database structure .SH IMPORT AND REMOVE DOCUMENTS .TP -.B sisu \-D \-\-import \-v [filename/wildcard] +.B sisu -D --import -v [filename/wildcard] populates database with the contents of the file. Imports documents(s) specified to a postgresql database (at an object level). .TP -.B sisu \-D \-\-update \-v [filename/wildcard] +.B sisu -D --update -v [filename/wildcard] updates file contents in database .TP -.B sisu \-D \-\-remove \-v [filename/wildcard] +.B sisu -D --remove -v [filename/wildcard] removes specified document from postgresql database. .SH SQLITE -.br .SH NAME -.br +.BR .B SiSU -\- Structured information, Serialized Units \- a document publishing system. +- Structured information, Serialized Units - a document publishing system. .SH DESCRIPTION -.br +.BR Information related to using sqlite with sisu (and related to the sisu_sqlite dependency package, which is a dummy package to install dependencies needed for .B SiSU to populate an sqlite database, this being part of .B SiSU -\- man sisu) . +- man sisu) . .SH SYNOPSIS -.br - sisu \-d [instruction] [filename/wildcard \ if \ required] +.BR + sisu -d [instruction] [filename/wildcard if required] -.br - sisu \-d \-\-(sqlite|pg) \-\-[instruction] [filename/wildcard \ if \ - required] +.BR + sisu -d --(sqlite|pg) --[instruction] [filename/wildcard if required] .SH COMMANDS -.br +.BR Mappings to two databases are provided by default, postgresql and sqlite, the same commands are used within sisu to construct and populate databases however -\-d (lowercase) denotes sqlite and \-D (uppercase) denotes postgresql, -alternatively \-\-sqlite or \-\-pgsql may be used +-d (lowercase) denotes sqlite and -D (uppercase) denotes postgresql, +alternatively --sqlite or --pgsql may be used -.br -.B \-d or \-\-sqlite +.BR +.B -d or --sqlite may be used interchangeably. .SH CREATE AND DESTROY DATABASE .TP -.B \-\-sqlite \-\-createall +.B --sqlite --createall initial step, creates required relations (tables, indexes) in existing (sqlite) database (a database should be created manually and given the same name as working directory, as requested) (rb.dbi) .TP -.B sisu \-d \-\-createdb +.B sisu -d --createdb creates database where no database existed before .TP -.B sisu \-d \-\-create +.B sisu -d --create creates database tables where no database tables existed before .TP -.B sisu \-d \-\-dropall +.B sisu -d --dropall destroys database (including all its content)! kills data and drops tables, indexes and database associated with a given directory (and directories of the same name). .TP -.B sisu \-d \-\-recreate +.B sisu -d --recreate destroys existing database and builds a new empty database structure .SH IMPORT AND REMOVE DOCUMENTS .TP -.B sisu \-d \-\-import \-v [filename/wildcard] +.B sisu -d --import -v [filename/wildcard] populates database with the contents of the file. Imports documents(s) specified to an sqlite database (at an object level). .TP -.B sisu \-d \-\-update \-v [filename/wildcard] +.B sisu -d --update -v [filename/wildcard] updates file contents in database .TP -.B sisu \-d \-\-remove \-v [filename/wildcard] +.B sisu -d --remove -v [filename/wildcard] removes specified document from sqlite database. .SH INTRODUCTION -.br -.SH SEARCH \- DATABASE FRONTEND SAMPLE, UTILISING DATABASE AND SISU FEATURES, +.SH SEARCH - DATABASE FRONTEND SAMPLE, UTILISING DATABASE AND SISU FEATURES, INCLUDING OBJECT CITATION NUMBERING (BACKEND CURRENTLY POSTGRESQL) -.br +.BR Sample search frontend [^23] A small database and -sample query front\-end (search from) that makes use of the citation system, +sample query front-end (search from) that makes use of the citation system, .I object citation numbering to demonstrates functionality.[^24] -.br +.BR .B SiSU can provide information on which documents are matched and at what locations within each document the matches are found. These results are relevant across @@ -3365,23 +3315,22 @@ database. You can then refer to one of the other outputs or in the database expand the text within the matched objects (paragraphs) in the documents matched. -.br +.BR Note you may set results either for documents matched and object number locations within each matched document meeting the search criteria; or display the names of the documents matched along with the objects (paragraphs) that meet the search criteria.[^25] .TP -.B sisu \-F \-\-webserv\-webrick +.B sisu -F --webserv-webrick builds a cgi web search frontend for the database created -.br +.BR The following is feedback on the setup on a machine provided by the help command: -.br - sisu \-\-help sql - +.BR + sisu --help sql .nf Postgresql user: ralph @@ -3393,177 +3342,173 @@ sqlite dbi connect DBI:SQLite:/home/ralph/sisu_www/sisu/sisu_sqlite.db .fi -.br +.BR Note on databases built -.br -By default, [unless \ otherwise \ specified] databases are built on a directory +.BR +By default, [unless otherwise specified] databases are built on a directory basis, from collections of documents within that directory. The name of the directory you choose to work from is used as the database name, i.e. if you are working in a directory called /home/ralph/ebook the database SiSU_ebook is -used. [otherwise \ a \ manual \ mapping \ for \ the \ collection \ is \ -necessary] - +used. [otherwise a manual mapping for the collection is necessary] .SH SEARCH FORM .TP -.B sisu \-F -generates a sample search form, which must be copied to the web\-server cgi +.B sisu -F +generates a sample search form, which must be copied to the web-server cgi directory .TP -.B sisu \-F \-\-webserv\-webrick +.B sisu -F --webserv-webrick generates a sample search form for use with the webrick server, which must be -copied to the web\-server cgi directory +copied to the web-server cgi directory .TP -.B sisu \-W +.B sisu -W starts the webrick server which should be available wherever sisu is properly installed -.br +.BR The generated search form must be copied manually to the webserver directory as instructed .SH SISU_WEBRICK -.br .SH NAME -.br +.BR .B SiSU -\- Structured information, Serialized Units \- a document publishing system +- Structured information, Serialized Units - a document publishing system .SH SYNOPSIS -.br +.BR sisu_webrick [port] -.br +.BR or -.br -sisu \-W [port] +.BR +sisu -W [port] .SH DESCRIPTION -.br +.BR sisu_webrick is part of .B SiSU (man sisu) sisu_webrick starts .B Ruby -' s Webrick web\-server and points it to the directories to which +' s Webrick web-server and points it to the directories to which .B SiSU output is written, providing a list of these directories (assuming .B SiSU is in use and they exist). -.br +.BR The default port for sisu_webrick is set to 8081, this may be modified in the yaml file: ~/.sisu/sisurc.yml a sample of which is provided as /etc/sisu/sisurc.yml (or in the equivalent directory on your system). .SH SUMMARY OF MAN PAGE -.br +.BR sisu_webrick, may be started on it's own with the command: sisu_webrick [port] -or using the sisu command with the \-W flag: sisu \-W [port] +or using the sisu command with the -W flag: sisu -W [port] -.br +.BR where no port is given and settings are unchanged the default port is 8081 .SH DOCUMENT PROCESSING COMMAND FLAGS -.br -sisu \-W [port] starts +.BR +sisu -W [port] starts .B Ruby -Webrick web\-server, serving +Webrick web-server, serving .B SiSU output directories, on the port provided, or if no port is provided and the defaults have not been changed in ~/.sisu/sisurc.yaml then on port 8081 .SH SUMMARY OF FEATURES -.br -.br -* sparse/minimal markup (clean utf\-8 source texts). Documents are prepared in -a single -.I UTF\-8 +.BR +* sparse/minimal markup (clean utf-8 source texts). Documents are prepared in a +single +.I UTF-8 file using a minimalistic mnemonic syntax. Typical literature, documents like "War and Peace" require almost no markup, and most of the headers are optional. -.br +.BR * markup is easily readable/parsable by the human eye, (basic markup is simpler and more sparse than the most basic .I HTML -) , [this \ may \ also \ be \ converted \ to \ .I \ XML \ representations \ of -\ the \ same \ input/source \ document]. +) , [this may also be converted to +.I XML +representations of the same input/source document]. -.br +.BR * markup defines document structure (this may be done once in a header -pattern\-match description, or for heading levels individually); basic text -attributes (bold, italics, underscore, strike\-through etc.) as required; and +pattern-match description, or for heading levels individually); basic text +attributes (bold, italics, underscore, strike-through etc.) as required; and semantic information related to the document (header information, extended beyond the Dublin core and easily further extended as required); the headers may also contain processing instructions. .B SiSU markup is primarily an abstraction of document structure and document metadata to permit taking advantage of the basic strengths of existing alternative -practical standard ways of representing documents [be \ that \ browser \ -viewing, \ paper \ publication, \ sql \ search \ etc.] (html, epub, xml, odf, -latex, pdf, sql) +practical standard ways of representing documents [be that browser viewing, +paper publication, sql search etc.] (html, epub, xml, odf, latex, pdf, sql) -.br +.BR * for output produces reasonably elegant output of established industry and institutionally accepted open standard formats.[3] takes advantage of the different strengths of various standard formats for representing documents, amongst the output formats currently supported are: -.br +.BR * .I HTML -\- both as a single scrollable text and a segmented document +- both as a single scrollable text and a segmented document -.br +.BR * .I XHTML -.br +.BR * .I EPUB -.br +.BR * .I XML -\- both in sax and dom style xml structures for further development as required +- both in sax and dom style xml structures for further development as required -.br +.BR * .I ODT -\- Open Document Format text, the iso standard for document storage +- Open Document Format text, the iso standard for document storage -.br +.BR * .I LaTeX -\- used to generate pdf +- used to generate pdf -.br +.BR * .I PDF (via .I LaTeX ) -.br +.BR * .I SQL -\- population of an sql database ( +- population of an sql database ( .I PostgreSQL or .I SQLite ) , (at the same object level that is used to cite text within a document) -.br +.BR Also produces: concordance files; document content certificates (md5 or sha256 digests of headings, paragraphs, images etc.) and html manifests (and sitemaps of content). (b) takes advantage of the strengths implicit in these very @@ -3574,7 +3519,7 @@ making possible .I granular search (and related possibilities)) -.br +.BR * ensuring content can be cited in a meaningful way regardless of selected output format. Online publishing (and publishing in multiple document formats) lacks a useful way of citing text internally within documents (important to @@ -3589,51 +3534,51 @@ oriented, (pdf, xml, sqlite, postgresql) , this numbering system can be used to reference content. -.br +.BR * Granular search within documents. .I SQL databases are populated at an object level (roughly headings, paragraphs, verse, tables) and become searchable with that degree of granularity, the output information provides the object/paragraph numbers which are relevant across all generated outputs; it is also possible to look at just the matching -paragraphs of the documents in the database; [output \ indexing \ also \ work \ -well \ with \ search \ indexing \ tools \ like \ hyperestraier]. +paragraphs of the documents in the database; [output indexing also work well +with search indexing tools like hyperestraier]. -.br +.BR * long term maintainability of document collections in a world of changing -formats, having a very sparsely marked\-up source document base. there is a -considerable degree of future\-proofing, output representations are +formats, having a very sparsely marked-up source document base. there is a +considerable degree of future-proofing, output representations are "upgradeable", and new document formats may be added. e.g. addition of odf (open document text) module in 2006, epub in 2009 and in future html5 output sometime in future, without modification of existing prepared texts -.br +.BR * .I SQL search aside, documents are generated as required and static once generated. -.br +.BR * documents produced are static files, and may be batch processed, this needs to be done only once but may be repeated for various reasons as desired (updated content, addition of new output formats, updated technology document presentations/representations) -.br +.BR * document source ( .I plaintext -utf\-8) if shared on the net may be used as input and processed locally to +utf-8) if shared on the net may be used as input and processed locally to produce the different document outputs -.br +.BR * document source may be bundled together (automatically) with associated documents (multiple language versions or master document with inclusions) and images and sent as a zip file called a sisupod, if shared on the net these too may be processed locally to produce the desired document outputs -.br +.BR * generated document outputs may automatically be posted to remote sites. -.br +.BR * for basic document generation, the only software dependency is .B Ruby, and a few standard Unix tools (this covers @@ -3647,15 +3592,15 @@ and a few standard Unix tools (this covers .I LaTeX generated to pdf, a latex processor like tetex or texlive. -.br +.BR * as a developers tool it is flexible and extensible -.br +.BR Syntax highlighting for .B SiSU markup is available for a number of text editors. -.br +.BR .B SiSU is less about document layout than about finding a way with little markup to be able to construct an abstract representation of a document that makes it @@ -3663,15 +3608,15 @@ possible to produce multiple representations of it which may be rather different from each other and used for different purposes, whether layout and publishing, or search of content -.br +.BR i.e. to be able to take advantage from this 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 viewing (e.g. html, xml, pdf) , or -paper publication (e.g. pdf) \... +paper publication (e.g. pdf) ... -.br +.BR the solution arrived at is by extracting structural information about the document (about headings within the document) and by tracking objects (which are serialized and also given hash values) in the manner described. It makes @@ -3686,160 +3631,128 @@ objects include: headings, paragraphs, verse, tables, images, but not footnotes/endnotes which are numbered separately and tied to the object from which they are referenced. -.br +.BR .TP .BI 2. -i.e. the - -.br -.I HTML, - -.br -.I PDF, - -.br -.I EPUB, - -.br -.I ODT - -.br -outputs are each built individually and optimised for that form of +i.e. the HTML, PDF, EPUB, ODT outputs are each built individually and optimised for that form of presentation, rather than for example the html being a saved version of the odf, or the pdf being a saved version of the html. -.br +.BR .TP .BI 3. the different heading levels -.br +.BR .TP .BI 4. units of text, primarily paragraphs and headings, also any tables, poems, code-blocks -.br +.BR .TP .BI 5. An open standard format for e-books -.br +.BR .TP .BI 6. -Open Document Format ( - -.br -.I ODF +Open Document Format ( ODF ) text -.br -) text - -.br +.BR .TP .BI 7. Specification submitted by Adobe to ISO to become a full open ISO -specification - -.br - +specification -.br +.BR .TP .BI 8. ISO standard ISO/IEC 26300:2006 -.br +.BR .TP .BI *1. square brackets -.br +.BR .TP .BI *2. square brackets -.br +.BR .TP .BI +1. square brackets -.br +.BR .TP .BI 9. -.br +.BR .TP .BI 10. -.br +.BR .TP .BI 11. 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. -.br +.BR .TP .BI 12. -files should be prepared using - -.br -.I UTF-8 +files should be prepared using UTF-8 character encoding -.br -character encoding - -.br +.BR .TP .BI 13. a footnote or endnote -.br +.BR .TP .BI 14. self contained endnote marker & endnote in one -.br +.BR .TP .BI *. unnumbered asterisk footnote/endnote, insert multiple asterisks if required -.br +.BR .TP .BI **. another unnumbered asterisk footnote/endnote -.br +.BR .TP .BI *3. editors notes, numbered asterisk footnote/endnote series -.br +.BR .TP .BI +2. editors notes, numbered asterisk footnote/endnote series -.br +.BR .TP .BI 15. -.br +.BR .TP .BI 16. -.br +.BR .TP .BI 18. Table from the Wealth of Networks by Yochai Benkler - -.br -.br +.BR .TP .BI 19. \.ssc (for composite) is under consideration but \._sst makes clear that this @@ -3848,38 +3761,37 @@ have "accidents", working on a \.ssc file that is overwritten by subsequent processing. It may be however that when the resulting file is shared \.ssc is an appropriate suffix to use. -.br +.BR .TP -.BI 21. - +.BI 20. +SiSU has worked this way in the past, though this was dropped as it was +thought the complexity outweighed the flexibility, however, the balance was +rather fine and this behaviour could be reinstated. -.br - - -.br +.BR +.TP +.BI 21. + -.br +.BR .TP .BI 22. - - -.br - + -.br +.BR .TP .BI 23. -.br +.BR .TP .BI 24. (which could be extended further with current back-end). As regards scaling of the database, it is as scalable as the database (here Postgresql) and hardware allow. -.br +.BR .TP .BI 25. of this feature when demonstrated to an IBM software innovations evaluator @@ -3889,7 +3801,7 @@ and we can tell you which documents meet your search criteria, but there is no way we can tell you without opening each document where within each your matches are found. -.br +.BR .TP .SH SEE ALSO -- cgit v1.2.3