From eae9bb93fdd2e677c8882bcc96d42b804ac2bafe Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Sun, 18 Nov 2012 21:50:04 -0500 Subject: v4: documentation; markup samples & help --- data/doc/sisu/CHANGELOG_v4 | 2 + data/doc/sisu/html/sisu.1.html | 9614 +++++++------------- data/doc/sisu/html/sisu4.1.html | 3693 ++++++++ data/doc/sisu/markup-samples/README | 8 +- ...lman_crusade_for_free_software.sam_williams.sst | 127 +- ...re_revolution.sam_williams.richard_stallman.sst | 16 +- .../v3/sisu_manual/sisu_description.sst | 2 +- .../markup-samples/v3/sisu_manual/sisu_markup.sst | 1 - .../v4/samples/_sisu/sisu_document_make | 9 + ...lman_crusade_for_free_software.sam_williams.sst | 5 +- ...re_revolution.sam_williams.richard_stallman.sst | 12 +- .../v4/sisu_manual/_sisu/sisu_document_make | 20 + .../sisu/markup-samples/v4/sisu_manual/sisu.ssm | 27 +- .../v4/sisu_manual/sisu_commands.sst | 24 +- .../markup-samples/v4/sisu_manual/sisu_config.ssi | 42 +- .../v4/sisu_manual/sisu_description.sst | 18 - .../v4/sisu_manual/sisu_examples.ssi | 71 +- .../markup-samples/v4/sisu_manual/sisu_faq.sst | 17 - .../v4/sisu_manual/sisu_filetypes.sst | 151 +- .../markup-samples/v4/sisu_manual/sisu_help.sst | 17 - .../v4/sisu_manual/sisu_help_sources.sst | 17 - .../markup-samples/v4/sisu_manual/sisu_howto.sst | 17 - .../v4/sisu_manual/sisu_introduction.sst | 17 - .../markup-samples/v4/sisu_manual/sisu_manual.ssm | 17 - .../markup-samples/v4/sisu_manual/sisu_markup.sst | 262 +- .../v4/sisu_manual/sisu_markup_syntax_history.sst | 260 + .../v4/sisu_manual/sisu_output_overview.sst | 17 - .../v4/sisu_manual/sisu_postgresql.sst | 15 - .../v4/sisu_manual/sisu_quickstart.sst | 17 - .../markup-samples/v4/sisu_manual/sisu_remote.sst | 17 - .../markup-samples/v4/sisu_manual/sisu_search.ssm | 17 - .../v4/sisu_manual/sisu_search_intro.ssi | 5 - .../v4/sisu_manual/sisu_short_feature_summary.ssi | 16 +- .../markup-samples/v4/sisu_manual/sisu_sqlite.sst | 15 - .../v4/sisu_manual/sisu_syntax_highlighting.sst | 17 - .../markup-samples/v4/sisu_manual/sisu_webrick.sst | 32 - lib/sisu/v4/help.rb | 308 +- lib/sisu/v4/manpage.rb | 33 +- man/man1/sisu.1 | 3623 +++----- 39 files changed, 9017 insertions(+), 9581 deletions(-) create mode 100644 data/doc/sisu/html/sisu4.1.html create mode 100644 data/doc/sisu/markup-samples/v4/samples/_sisu/sisu_document_make create mode 100644 data/doc/sisu/markup-samples/v4/sisu_manual/_sisu/sisu_document_make create mode 100644 data/doc/sisu/markup-samples/v4/sisu_manual/sisu_markup_syntax_history.sst diff --git a/data/doc/sisu/CHANGELOG_v4 b/data/doc/sisu/CHANGELOG_v4 index 61c1f555..c3461a6c 100644 --- a/data/doc/sisu/CHANGELOG_v4 +++ b/data/doc/sisu/CHANGELOG_v4 @@ -66,3 +66,5 @@ http://www.jus.uio.no/sisu/pkg/src/sisu_4.0.0.orig.tar.xz * v4: document headers, metadata rearranged, wide-ranging effect * v4: vim syntax, sisu.vim, make new headers + +* v4: documentation; markup samples & help diff --git a/data/doc/sisu/html/sisu.1.html b/data/doc/sisu/html/sisu.1.html index 61535580..345e574b 100644 --- a/data/doc/sisu/html/sisu.1.html +++ b/data/doc/sisu/html/sisu.1.html @@ -1,2150 +1,1750 @@ -Content-type: text/html - - -Man page of sisu - -

sisu

-Section: SiSU (1)
Updated: 2012-05-25
Index -Return to Main Contents
- -
- -  -

NAME

- -
- -sisu - documents: markup, structuring, publishing in multiple standard formats, and search -
- -  -

SYNOPSIS

- -
- + + + + + +"sisu"("1") manual page + + +Table of Contents

+
+ +

Name

+
+sisu - documents: markup, structuring, publishing in multiple standard formats, +and search
+ +

Synopsis

+
+sisu [-short-options|--long-options] [filename/wildcard] +


sisu [-abCcDdeFGghIikLMmNnoPpQqRrSsTtUuVvWwXxYyZ_0-9] [filename/wildcard] -
+


+sisu --txt --html --epub --odt --pdf --wordmap --sqlite --manpage --texinfo --sisupod --source +--qrcode [filename/wildcard] +


sisu [-Ddcv] [instruction] [filename/wildcard] -


- -sisu [-CcFLSVvW] -


- +


+sisu --pg (--createdb|update [filename/wildcard]|--dropall) +


sisu [operations] -


- -sisu --v3 [operations] -


- -sisu --v2 [operations] -


- -sisu2 [operations] -  -

SISU - MANUAL,

- -RALPH AMISSAH -
- -

-  -

WHAT IS SISU?

- -
-

-  -

1. 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 (GPL3). -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 +


+sisu [-CcFLSVvW] +


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

Sisu - Manual,

+RALPH AMISSAH
+ +

+

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 +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, LaTeX, -landscape and portrait pdfs, Open Document Format (ODF), all of which can be -added to and updated. -SiSU -is also able to populate SQL type databases at an object level, which means +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 sisu engine) can be -generated by re-running the engine against the prepared source. Using -SiSU markup applied to a document, SiSU custom builds (to take -advantage of the strengths of different ways of representing documents) various -standard open output formats including plain text, HTML, XHTML, XML, EPUB, -OpenDocument, LaTeX or PDF files, and populate an SQL 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 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 +


+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 SiSU markup applied to a document, SiSU custom builds (to +take advantage of the strengths of different ways of representing documents) +various standard open output formats including plain text, HTML, XHTML, +XML, EPUB, ODT, LaTeX or PDF files, and populate an SQL 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 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 +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 +


+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, pdf[^5] ODF,[^6] and EPUB.[^7] Whilst SiSU -relies on software, the markup is uncomplicated and minimalistic which +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 -GPL3 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 is to keep up with a moving target. SiSU permits new forms of -output to be added as they become important, (Open Document Format text was -added in 2006 when it became an ISO standard for office applications and the -archival of documents), EPUB was introduced in 2009; and allows the technical -representations existing output to be updated (html has evolved and the 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). - -


- +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 +is to keep up with a moving target. SiSU permits new forms of output to +be added as they become important, (Open Document Format text was added +in 2006 when it became an ISO standard for office applications and the +archival of documents), EPUB was introduced in 2009; and allows the technical +representations existing output to be updated ( HTML has evolved and the +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 +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> - -

-  -

2. COMMANDS SUMMARY

- -

- -  -

2.1 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 (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://www.jus.uio.no/sisu> - -

-  -

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

-

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

-

-CC - -
-see --configure -

-

-c [filename/wildcard] - -
-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 -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 -

-

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

+

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

+

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 +

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

+ +
-CC
+
see --configure +

+ +
-c [filename/wildcard]
+
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 + +

- +

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 +

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

-

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

-

--dump[=directory_path] [filename/wildcard] +

Alias -m +

-
-places output in directory specified, if none is specified in the current +
--delete [filename/wildcard]
+
see --zap +

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

-

-F [--webserv=webrick] - -
-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 -

-

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

-

-g [filename/wildcard] - -
-see --git -

-

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

-

--glob [optional  string  part  of  filename] - -
-see --find -

-

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

-

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

-

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

-

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

-

-j [filename/wildcard] - -
-copies images associated with a file for use by html, xhtml & xml outputs +

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

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

+ +
-F [--webserv=webrick]
+
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 +

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

+ +
-g [filename/wildcard] +
+
+

see --git +

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

+ +
--glob +[optional  string  part  of  filename]
+
see --find +

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

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

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

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

+ +
-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] - -
-see --maintenance -

-

-L - -
-prints license information. -

-

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

-

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

-

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

+ +
--keep-processing-files [filename/wildcard/url] +
+
+

see --maintenance +

+ +
-L
+
prints license information. +

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

see --maintenance +

+ +
-m [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. +

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

-

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

-

-o [filename/wildcard/url] - -
-see --odt -

-

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

-

--odt [filename/wildcard/url] - -
-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 -

-

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

-

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

-

-q [filename/wildcard] - -
-see --quiet -

-

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

-

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

-

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

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

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

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

+ +
--odt [filename/wildcard/url]
+
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 +

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

+ +
-q [filename/wildcard]
+
see --quiet +

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

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

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

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

-

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

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

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

-

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

-

--texinfo [filename/wildcard] - -
-produces texinfo and info file, (view with pinfo). Alias -I -

-

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

-

-U [filename/wildcard] - -
-see --urls -

-

-u [filename/wildcard] - -
-provides url mapping of output files for the flags requested for processing, -also see -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. -

-

-v - -
-on its own, provides -SiSU - -version information -

-

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

-

--v2 [filename/wildcard] - -
-invokes the sisu v2 document parser/generator. This is the default and is -normally omitted. -

-

--v3 [filename/wildcard] - -
-invokes the sisu v3 document parser/generator. Currently under development and -incomplete, v3 requires >= ruby1.9.2p180. You may run sisu3 instead. -

-

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

+ +
--texinfo [filename/wildcard]
+
produces texinfo and info file, (view +with pinfo). Alias -I +

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

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

+ +
-u [filename/wildcard] +
+
provides url mapping of output files for the flags requested for processing, + +

also see -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. + +

+ +
-v
+
on its own, provides SiSU version information +

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

see --verbose +

+ +
--v3 [filename/wildcard]
+
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] +
+
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 -

-

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

-

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

-

--xhtml [filename/wildcard] - -
-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). Alias -x -

-

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

-

-x [filename/wildcard] - -
-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]) -

-

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

-

-Z [filename/wildcard] - -
-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 -

-

-  -

3. 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 by asterisk or dagger/plus -sign -

-

--no-asterisk - -
-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 -

-

-  -

4. 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  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 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 'createdb [database  name]' -where database name would be SiSU_[present  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  sqlite  equivalent] -

-

--pg -v --update - -
-[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  sqlite  equivalent] -

-

--pg --dropall - -
-kills data" and drops (postgresql or sqlite) db, tables & indexes [  -d --dropall  sqlite  equivalent] -

-
- +

+ +
-W
+
see --webrick + +

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

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

see --concordance +

+ +
--xhtml [filename/wildcard]
+
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). + +

Alias -x +

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

+ +
-x [filename/wildcard]
+
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]) +

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

+ +
-Z [filename/wildcard]
+
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 +

+
+ +

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

by asterisk or dagger/plus sign +

+ +
--no-asterisk
+
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 +

+
+ +

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  )  ] +

+

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

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

+ +
--pg --remove
+
[filename/wildcard] +removes specified data to PostgreSQL db (rb.dbi) [  -d  --remove  .I  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. -

-

-  -

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

-

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

-

-1 - -
--Qhewpoty -

-

-2 - -
--NQhewpotbxXy -

-

-3 - -
--NQhewpotbxXyY -

-

-4 - -
--NQhewpotbxXDyY --update -

-

-5 - -
--NQhewpotbxXDyYv --update -

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

-
- -consider -u for appended url info or -v for verbose output -

-

-  -

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

-  -

6. HELP

- -
- -

-  -

6.1 SISU MANUAL

- -

-
- +

+ + +

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

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

+ +
-1
+
-Qhewpoty +

+ +
-2
+
-NQhewpotbxXy + +

+ +
-3
+
-NQhewpotbxXyY +

+ +
-4
+
-NQhewpotbxXDyY --update +

+ +
-5
+
-NQhewpotbxXDyYv --update +


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


+ +

consider -u for appended url info or -v for verbose output +

+
+ +

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

+

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

-
+


+ <http://sisudoc.org/sisu/sisu_manual/ +>
-The manual can be generated from source, found respectively, either within the -SiSU +


+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
-tarball or installed locally at: -

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

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

-  -

6.2 SISU MAN PAGES

- -

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

-
- +


+ sisu sisu_manual.ssm
+ +

+

Sisu Man Pages

+ +


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

-
+


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


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

-
- -
  /usr/share/doc/sisu/html/ -

-
+


+ /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/> [^8] -

-
- -* sisu.1 <http://www.jus.uio.no/sisu/man/sisu.1.html> [^9] -

-  -

6.3 SISU BUILT-IN INTERACTIVE HELP

- -

-
- +


+* 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
-
    sisu --help commands -

-
+


+ sisu --help [subject]
-
    sisu --help markup -

-
+


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

-
+


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

-
+


+ sisu --help env [for  feedback  on  the  way  your  system  is
+ setup  with  regard  to  sisu  ]
-
  sisu (on its own provides version and some help information) -

-
+


+ sisu -V [environment  information,  same  as  above  command]
-Apart from real-time information on your current configuration the -SiSU +


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

-  -

7. INTRODUCTION TO SISU MARKUP[^10]

- -
- -

-  -

7.1 SUMMARY

- -

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

-
- +


+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 -
  blocks or poems. -

-
- -
  * footnotes/endnotes -

-
- -
  * linked text and images -

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

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

-
+

markup or sisu --help markup +


To check the markup in a file: -

-
+


+ sisu --identify [filename].sst
-
  sisu --identify [filename].sst -

-
+


-For brief descriptive summary of markup history -

-
- -
  sisu --query-history -

-
+

For brief descriptive summary of markup history +


+ sisu --query-history
+


or if for a particular version: -

-
- -
  sisu --query-0.38 -

-  -

7.2 MARKUP EXAMPLES

+


+ sisu --query-0.38
-

-  -

7.2.1 ONLINE

+

+

Markup Examples

-

-
+

+

Online

+


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

-
- -There is of course this document, which provides a cursory overview of sisu -markup and the respective output produced: -<http://www.jus.uio.no/sisu/sisu_markup/> -

-
- -an alternative presentation of markup syntax: -/usr/share/doc/sisu/on_markup.txt.gz -

-  -

7.2.2 INSTALLED

- -

-
- -With -SiSU - -installed sample skins may be found in: /usr/share/doc/sisu/markup-samples (or -equivalent directory) and if sisu-markup-samples is installed also under: -/usr/share/doc/sisu/markup-samples-non-free -

-  -

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

-
- +produced from <http://www.jus.uio.no/sisu/SiSU/examples.html +> or from <http://www.jus.uio.no/sisu/sisu_examples/ +> + +


+There is of course this document, which provides a cursory overview of +sisu markup and the respective output produced: <http://www.jus.uio.no/sisu/sisu_markup/ +> + +


+an alternative presentation of markup syntax: /usr/share/doc/sisu/on_markup.txt.gz + +

+

Installed

+ +


+With SiSU installed sample skins may be found in: /usr/share/doc/sisu/markup-samples +(or equivalent directory) and if sisu -markup-samples is installed also under: + +

/usr/share/doc/sisu/markup-samples-non-free +

+

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

-

-% this would be a comment
-
- -

-  -

8.1 SAMPLE HEADER

- -

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

-

-% SiSU master 2.0
+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:
+
 

+
% SiSU master 2.0
 @title: SiSU
- :subtitle: Manual
+:subtitle: Manual
 @creator:
- :author: Amissah, Ralph
-@publisher:  [publisher  name]
-@rights: Copyright (C) Ralph Amissah 2007, License GPL 3
+: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;
-     synopsis=sisu  [-abcDdeFhIiMmNnopqRrSsTtUuVvwXxYyZz0-9]  [filename/wildcard  ]
-     . sisu  [-Ddcv]  [instruction]
-     . sisu  [-CcFLSVvW]
-     . sisu --v2  [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
-

-
-

- 
-
8.2 AVAILABLE HEADERS

-
-

-

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

-
- +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" belong to the tag/indentifier specified +


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

-
- -This is a sample header -

-

-% SiSU 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]
+
 

+
+
This is a sample header
+
 

+
% 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]
   :language: English
-

-
-

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

-
-

-
-@rights:
- :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:
- :isbn:  [ISBN]
- :loc:  [Library  of  Congress  classification]
- :dewey:  [Dewey  classification]
- :pg:  [Project  Gutenberg  text  number]
-

-
-

-
-@links: { SiSU }http://www.sisudoc.org
-  { FSF }http://www.fsf.org
-

-
-

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

-
-

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

-
-

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

-
-

- 
-
9. MARKUP OF SUBSTANTIVE TEXT

-
-

-
-

- 
-
9.1 HEADING LEVELS

-
-

-

-
+
+


+

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


+

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


+

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


+

@links: { SiSU }http://www.sisudoc.org
+  { FSF }http://www.fsf.org
+
+


+

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


+

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


+

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

-

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

-  -

9.2 FONT ATTRIBUTES

- -

-
- -markup example: - -

-

-normal text,  *{emphasis}*, !{bold text}!, /{italics}/, _{underscore}_, "{citation}",
+
 

+:A~ [heading  text] Top level heading [this  usually  has  similar  content
+ to  the  title  @title:  ] NOTE: the heading levels described here are in 0.38
+notation, see heading
+
 

+:B~ [heading  text] Second level heading [this  is  a  heading  level  divider]
+
+
 

+:C~ [heading  text] Third level heading [this  is  a  heading  level  divider]
+
+
 

+1~ [heading  text] Top level heading preceding substantive text of document
+or sub-heading 2, the heading level that would normally be marked 1. or 2.
+or 3. etc. in a document, and the level on which sisu by default would break
+html output into named segments, names are provided automatically if none
+are given (a number), otherwise takes the form 1~my_filename_for_this_segment
+
+
 

+2~ [heading  text] Second level heading preceding substantive text of document
+or sub-heading 3 , the heading level that would normally be marked 1.1 or
+1.2 or 1.3 or 2.1 etc. in a document.
+
 

+3~ [heading  text] Third level heading preceding substantive text of document,
+that would normally be marked 1.1.1 or 1.1.2 or 1.2.1 or 2.1.1 etc. in a document
+
+
 

+
1~filename level 1 heading,
+% the primary division such as Chapter that is followed by substantive
+text, and may be further subdivided (this is the level on which by default
+html segments are made)
+

+

+
Font Attributes

+
+
 

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

-_{underscore}_
-

 /{italics}/
-

-"{citation}"
-

+_{underscore}_
+"{citation}"
 ^{superscript}^
-

 ,{subscript},
-

 +{inserted text}+
-

 -{strikethrough}-
-

 #{monospace}#
-

-
-

-

-
-resulting output:
-
-

-

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

-

-
-normal text
-

-

-
-emphasis
-
-[note:  can  be  configured  to  be  represented  by  bold,  italics or  underscore]
-

-

-
-bold text
-
-

-

-
-italics
-
-

-

-
-underscore
-
-

-

-
-"citation"
-

-

-
+
+


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


+ +

italics +


+ +

underscore +


+"citation" +


^superscript^ -

-
- +


[subscript] -

-
- +


++inserted text++ -

-
- +


--strikethrough-- -

-
- -monospace -

-  -

9.3 INDENTATION AND BULLETS

+


-

-
+

monospace +

+

Indentation and Bullets

-markup example: - -

-

-ordinary paragraph
-

+
 

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


-
    indent paragraph two steps -

-
+

ordinary paragraph +


+ indent paragraph one step
-
                  indent paragraph nine steps -

-
+


+ indent paragraph two steps
-markup example: +


+ indent paragraph nine steps
-

-

-_* bullet text
-

+
 

+markup example:
+
 

+
_* bullet text
 _1* bullet text, first indent
-

 _2* bullet text, two step indent
-

-
-

-

-
-resulting output:
-
-

-

-
+
+


+resulting output: +


* bullet text -

-
+


+ * bullet text, first indent
-
  * 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)) -

-
- -markup example: -

-

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

+
 

+markup example:
+
 

+
# numbered list                numbered list 1., 2., 3, etc.
 _# numbered list numbered list indented a., b., c., d., etc.
-

-
-

- 
-
9.4 HANGING INDENTS

-
-

-

-
-markup example:
-
-

-
-_0_1 first line no indent,
+

+

+
Hanging Indents

+
+
 

+markup example:
+
 

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

-
-

-

-
-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 indented, rest of paragraph no indent -

-
- -in each case level may be 0-9 -

-  -

9.5 FOOTNOTES / ENDNOTES

+


-

-
+

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 -determines whether footnotes or endnotes will be produced -

-
-markup example: - -

-

-~{ a footnote or endnote }~
-
- -

-
- -resulting output: - -

-
- -[^12] -

-
- -markup example: - -

-

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

-
- -resulting output: - -

-
- -normal text[^13] continues -

-
- -markup example: - -

-

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

+
determines whether footnotes or endnotes will be produced
+
 

+markup example:
+
 

+
~{ a footnote or endnote }~
+

+
 

+resulting output:
+
 

+[^13]
+
 

+markup example:
+
 

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

+
 

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

-

-
+
+


+resulting output: +


normal text [^*] continues -

-
- +


normal text [^**] continues -

-
- -markup example: - -

-

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

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

-
- -resulting output: - -

-
- +


+markup example: +


+

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


+resulting output: +


normal text [^*3] continues -

-
- +


normal text [^+2] continues -

-
- -Alternative endnote pair notation for footnotes/endnotes: - -

-

-% note the endnote marker "~^"
+
 

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

-  -

9.6 LINKS

+

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

+

Links

-

-  -

9.6.1 NAKED URLS WITHIN TEXT, DEALING WITH URLS

+

-

-
+

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

-

-normal text http://www.sisudoc.org/ continues
-
- -

-
- -resulting output: - -

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

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

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

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

-
- -resulting output: - -

-

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

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

-  -

9.6.2 LINKING TEXT

- -

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

-
- -markup example: - -

-

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

-
- -resulting output: - -

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

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

-
- -markup example: - -

-

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

-
- -resulting output: - -

-
- -about SiSU <http://www.sisudoc.org/> [^14] markup -

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

-
- -markup example: - -

-

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

-

-markup example:
-
-{ tux.png 64x80 }image
+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/
+> continues
+
 

+
+
An 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/
+> continues
+
 

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

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

+resulting output:
+
 

+
deb http://www.jus.uio.no/sisu/archive unstable main non-free
+deb-src http://www.jus.uio.no/sisu/archive unstable main non-free
+

+

+
Linking Text

+
+
 

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

+markup example:
+
 

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

+
 

+resulting output:
+
 

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

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

+markup example:
+
 

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

+
 

+resulting output:
+
 

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

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

+markup example:
+
 

+
about { text links }#link_text
+

+
 

+resulting output:
+
 

+about ⌠text links⌡⌈link_text⌋
+
 

+
+
Shared document collection link
+
 

+markup example:
+
 

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

+
 

+resulting output:
+
 

+about ⌠ SiSU book markup examples⌡⌈:SiSU/examples.html⌋
+

+
Linking
+Images

+
+
 

+markup example:
+
 

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

-
-

-

-
-resulting output:
-
-

-

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


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

-
- -[  ruby_logo  (png  missing)  ] [^15] -

-
- -linked url footnote shortcut - -

-

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

-

-text marker *~name
-
- -

-
- -note at a heading level the same is automatically achieved by providing names -to headings 1, 2 and 3 i.e. 2~[name] and 3~[name] or in the case of +


+tux.png 64x80 "Gnu/Linux - a better way" <http://www.sisudoc.org/ +> +


+GnuDebianLinuxRubyBetterWay.png 100x101 "Way Better - with Gnu/Linux, Debian +and Ruby" <http://www.sisudoc.org/ +> +


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


+ +

linked url footnote shortcut +


+

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


+

text marker *~name
+
+


+note at a heading level the same is automatically achieved by providing +names to headings 1, 2 and 3 i.e. 2~[name] and 3~[name] or in the case of auto-heading numbering, without further intervention. -

-  -

9.7 GROUPED TEXT

- -

-  -

9.7.1 TABLES

- -

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

-
- -markup example: - -

-

-table{ c3; 40; 30; 30;
+

+
Link Shortcut for
+Multiple Versions of a Sisu Document in the Same Directory

+TREE
+
 

+markup example:
+
 

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

+
 

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

+       ⌠html, segmented text⌡「http://corundum/sisu_manual/en/html/viral_spiral.david_bollier.html」
+

+       ⌠html, scroll, document in one⌡「http://corundum/sisu_manual/en/html/viral_spiral.david_bollier.html」
+

+       ⌠epub⌡「http://corundum/sisu_manual/en/epub/viral_spiral.david_bollier.epub」
+

+       ⌠pdf, landscape⌡「http://corundum/sisu_manual/en/pdf/viral_spiral.david_bollier.pdf」
+

+       ⌠pdf, portrait⌡「http://corundum/sisu_manual/en/pdf/viral_spiral.david_bollier.pdf」
+

+       ⌠odf: odt, open document text⌡「http://corundum/sisu_manual/en/odt/viral_spiral.david_bollier.odt」
+

+       ⌠xhtml scroll⌡「http://corundum/sisu_manual/en/xhtml/viral_spiral.david_bollier.xhtml」
+

+       ⌠xml, sax⌡「http://corundum/sisu_manual/en/xml/viral_spiral.david_bollier.xml」
+

+       ⌠xml, dom⌡「http://corundum/sisu_manual/en/xml/viral_spiral.david_bollier.xml」
+

+       ⌠concordance⌡「http://corundum/sisu_manual/en/html/viral_spiral.david_bollier.html」
+

+       ⌠dcc, document content certificate (digests)⌡「http://corundum/sisu_manual/en/digest/viral_spiral.david_bollier.txt」
+

+       ⌠markup source text⌡「http://corundum/sisu_manual/en/src/viral_spiral.david_bollier.sst」
+

+       ⌠markup source (zipped) pod⌡「http://corundum/sisu_manual/en/pod/viral_spiral.david_bollier.sst.zip」
+

+
+

+
Grouped Text

+
+

+
Tables

+
+
 

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

+markup example:
+
 

+
table{ c3; 40; 30; 30;
 This is a table
 this would become column two of row one
 column three of row one is here
@@ -2152,101 +1752,83 @@ And here begins another row
 column two of row two
 column three of row two, and so on
 }table
-

-
-

-

-
-resulting output:
-
-

-
  [table  omitted,  see  other  document  formats]
-

-

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

-

-
-markup example:
-
-[^17]
-

-
-!_ Table 3.1: Contributors to Wikipedia, January 2001 - June 2005
+

+
 

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

+markup example: [^18]
+
 

+
!_ Table 3.1: Contributors to Wikipedia, January 2001 - June 2005
 {table~h 24; 12; 12; 12; 12; 12; 12;}
-                                |Jan. 2001|Jan. 2002|Jan. 2003|Jan. 2004|July 2004|June 2006
-Contributors*                   |       10|      472|    2,188|    9,653|   25,011|   48,721
-Active contributors**           |        9|      212|      846|    3,228|    8,442|   16,945
-Very active contributors***     |        0|       31|      190|      692|    1,639|    3,016
-No. of English language articles|       25|   16,000|  101,000|  190,000|  320,000|  630,000
+                                |Jan. 2001|Jan. 2002|Jan. 2003|Jan. 2004|July 2004|June
+2006
+Contributors*                   |       10|      472|    2,188|    9,653|
+25,011|   48,721
+Active contributors**           |        9|      212|      846|    3,228|
+ 8,442|   16,945
+Very active contributors***     |        0|       31|      190|      692|
+ 1,639|    3,016
+No. of English language articles|       25|   16,000|  101,000|  190,000|  320,000|
+ 630,000
 No. of articles, all languages  |       25|   19,000|  138,000|  490,000|  862,000|1,600,000
-* Contributed at least ten times; ** at least 5 times in last month; *** more than 100 times in last month.
-

-
-

-

-
-resulting output:
-
-

-

-
-Table 3.1: Contributors to Wikipedia, January 2001 - June 2005
-
-

-
  [table  omitted,  see  other  document  formats]
-

-

-
-* Contributed at least ten times; ** at least 5 times in last month; *** more
-than 100 times in last month.
-

- 
-
9.7.2 POEM

-
-

-

-
-basic markup:
-
-

-
-poem{
+* Contributed at least ten times; ** at least 5 times in last month; ***
+more than 100 times in last month.
+

+
 

+resulting output:
+
 

+Table 3.1: Contributors to Wikipedia, January 2001 - June 2005
+
 |Jan. 2001|Jan.
+2002|Jan. 2003|Jan. 2004|July 2004|June 2006』Contributors*|10|472|2,188|9,653|25,011|48,721』Active
+contributors**|9|212|846|3,228|8,442|16,945』Very active contributors***|0|31|190|692|1,639|3,016』No.
+of English language articles|25|16,000|101,000|190,000|320,000|630,000』No. of
+articles, all languages|25|19,000|138,000|490,000|862,000|1,600,000』
+
 

+* Contributed at least ten times; ** at least 5 times in last month; ***
+more than 100 times in last month.
+

+
Poem

+
+
 

+basic markup:
+
 

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

-
-

-

-
-markup example:
-
-

-
-poem{
-                    `Fury said to a
+

+
 

+markup example:
+
 

+
poem{
+                    ‘Fury said to a
                    mouse, That he
                  met in the
                house,
-            "Let us
+            "Let us
               both go to
                 law:  I will
                   prosecute
                     YOU.  --Come,
-                       I'll take no
+                       I’ll take no
                         denial; We
                      must have a
                  trial:  For
               really this
-           morning I've
+           morning I’ve
           nothing
-         to do."
+         to do."
            Said the
              mouse to the
-               cur, "Such
+               cur, "Such
                  a trial,
                    dear Sir,
                          With
@@ -2255,14 +1837,14 @@ poem{
                 would be
               wasting
              our
-              breath."
-               "I'll be
-                 judge, I'll
-                   be jury,"
+              breath."
+               "I’ll be
+                 judge, I’ll
+                   be jury,"
                          Said
                     cunning
                       old Fury:
-                     "I'll
+                     "I’ll
                       try the
                          whole
                           cause,
@@ -2270,196 +1852,91 @@ poem{
                         condemn
                        you
                       to
-                       death."'
+                       death."’
 }poem
-

-
-

-

-
-resulting output:
-
-

-
                    `Fury said to a
-

-
-
                   mouse, That he
-

-
-
                 met in the
-

-
-
               house,
-

-
-
            "Let us
-

-
-
              both go to
-

-
-
                law:  I will
-

-
-
                  prosecute
-

-
-
                    YOU.  --Come,
-

-
-
                       I'll take no
-

-
-
                        denial; We
-

-
-
                     must have a
-

-
-
                 trial:  For
-

-
-
              really this
-

-
-
           morning I've
-

-
-
          nothing
-

-
-
         to do."
-

-
-
           Said the
-

-
-
             mouse to the
-

-
-
               cur, "Such
-

-
-
                 a trial,
-

-
-
                   dear Sir,
-

-
-
                         With
-

-
-
                     no jury
-

-
-
                  or judge,
-

-
-
                would be
-

-
-
              wasting
-

-
-
             our
-

-
-
              breath."
-

-
-
               "I'll be
-

-
-
                 judge, I'll
-

-
-
                   be jury,"
-

-
-
                         Said
-

-
-
                    cunning
-

-
-
                      old Fury:
-

-
-
                     "I'll
-

-
-
                      try the
-

-
-
                         whole
-

-
-
                          cause,
-

-
-
                             and
-

-
-
                        condemn
-

-
-
                       you
-

-
-
                      to
-

-
-
                       death."'
-

-
-

- 
-
9.7.3 GROUP

-
-

-

-
-basic markup:
-
-

-
-group{
-

+

+
 

+resulting output:
+
                     ‘Fury said to a

+                    mouse, That he

+                  met in the

+                house,

+             "Let us

+               both go to

+                 law:  I will

+                   prosecute

+                     YOU.  --Come,

+                        I’ll take no

+                         denial; We

+                      must have a

+                  trial:  For

+               really this

+            morning I’ve

+           nothing

+          to do."

+            Said the

+              mouse to the

+                cur, "Such

+                  a trial,

+                    dear Sir,

+                          With

+                      no jury

+                   or judge,

+                 would be

+               wasting

+              our

+               breath."

+                "I’ll be

+                  judge, I’ll

+                    be jury,"

+                          Said

+                     cunning

+                       old Fury:

+                      "I’ll

+                       try the

+                          whole

+                           cause,

+                              and

+                         condemn

+                        you

+                       to

+                        death."’

+
+

+
Group

+
+
 

+basic markup:
+
 

+
group{
   Your grouped text here
-

 }group
-

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

-
-

-

-
-markup example:
-
-

-
-group{
-                    'Fury said to a
+

+
 

+markup example:
+
 

+
group{
+                    ‘Fury said to a
                    mouse, That he
                  met in the
                house,
-            "Let us
+            "Let us
               both go to
                 law:  I will
                   prosecute
                     YOU.  --Come,
-                       I'll take no
+                       I’ll take no
                         denial; We
                      must have a
                  trial:  For
               really this
-           morning I've
+           morning I’ve
           nothing
-         to do."
+         to do."
            Said the
              mouse to the
-               cur, "Such
+               cur, "Such
                  a trial,
                    dear Sir,
                          With
@@ -2468,14 +1945,14 @@ group{
                 would be
               wasting
              our
-              breath."
-               "I'll be
-                 judge, I'll
-                   be jury,"
+              breath."
+               "I’ll be
+                 judge, I’ll
+                   be jury,"
                          Said
                     cunning
                       old Fury:
-                     "I'll
+                     "I’ll
                       try the
                          whole
                           cause,
@@ -2483,193 +1960,92 @@ group{
                         condemn
                        you
                       to
-                       death."'
+                       death."’
 }group
-

-
-

-

-
-resulting output:
-
-

-
                    `Fury said to a
-

-
-
                   mouse, That he
-

-
-
                 met in the
-

-
-
               house,
-

-
-
            "Let us
-

-
-
              both go to
-

-
-
                law:  I will
-

-
-
                  prosecute
-

-
-
                    YOU.  --Come,
-

-
-
                       I'll take no
-

-
-
                        denial; We
-

-
-
                     must have a
-

-
-
                 trial:  For
-

-
-
              really this
-

-
-
           morning I've
-

-
-
          nothing
-

-
-
         to do."
-

-
-
           Said the
-

-
-
             mouse to the
-

-
-
               cur, "Such
-

-
-
                 a trial,
-

-
-
                   dear Sir,
-

-
-
                         With
-

-
-
                     no jury
-

-
-
                  or judge,
-

-
-
                would be
-

-
-
              wasting
-

-
-
             our
-

-
-
              breath."
-

-
-
               "I'll be
-

-
-
                 judge, I'll
-

-
-
                   be jury,"
-

-
-
                         Said
-

-
-
                    cunning
-

-
-
                      old Fury:
-

-
-
                     "I'll
-

-
-
                      try the
-

-
-
                         whole
-

-
-
                          cause,
-

-
-
                             and
-

-
-
                        condemn
-

-
-
                       you
-

-
-
                      to
-

-
-
                       death."'
-

-
-

- 
-
9.7.4 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 within this
-document to provide examples of
-SiSU
-
-markup. You cannot however use code tags to escape code tags. They are however
-used in the same way as group or poem tags.
-

-

-
-A code-block is treated as an object and given a single object number. [an option  to  number  each  line  of  code  may  be  considered  at some  later  time]
-

-

-
-use of code tags instead of poem compared, resulting output:
-
-

-
-                    `Fury said to a
+

+
 

+resulting output:
+
                     ‘Fury said to a

+                    mouse, That he

+                  met in the

+                house,

+             "Let us

+               both go to

+                 law:  I will

+                   prosecute

+                     YOU.  --Come,

+                        I’ll take no

+                         denial; We

+                      must have a

+                  trial:  For

+               really this

+            morning I’ve

+           nothing

+          to do."

+            Said the

+              mouse to the

+                cur, "Such

+                  a trial,

+                    dear Sir,

+                          With

+                      no jury

+                   or judge,

+                 would be

+               wasting

+              our

+               breath."

+                "I’ll be

+                  judge, I’ll

+                    be jury,"

+                          Said

+                     cunning

+                       old Fury:

+                      "I’ll

+                       try the

+                          whole

+                           cause,

+                              and

+                         condemn

+                        you

+                       to

+                        death."’

+
+

+
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
+within this document to provide examples of SiSU markup. You cannot however
+use code tags to escape code tags. They are however used in the same way
+as group or poem tags.
+
 

+A code-block is treated as an object and given a single object number. [an
+option  to  number  each  line  of  code  may  be  considered  at some  later  time]
+
+
 

+use of code tags instead of poem compared, resulting output:
+
 

+
                    ‘Fury said to a
                    mouse, That he
                  met in the
                house,
-            "Let us
+            "Let us
               both go to
                 law:  I will
                   prosecute
                     YOU.  --Come,
-                       I'll take no
+                       I’ll take no
                         denial; We
                      must have a
                  trial:  For
               really this
-           morning I've
+           morning I’ve
           nothing
-         to do."
+         to do."
            Said the
              mouse to the
-               cur, "Such
+               cur, "Such
                  a trial,
                    dear Sir,
                          With
@@ -2678,14 +2054,14 @@ A code-block is treated as an object and given a single object number. [an optio
                 would be
               wasting
              our
-              breath."
-               "I'll be
-                 judge, I'll
-                   be jury,"
+              breath."
+               "I’ll be
+                 judge, I’ll
+                   be jury,"
                          Said
                     cunning
                       old Fury:
-                     "I'll
+                     "I’ll
                       try the
                          whole
                           cause,
@@ -2693,39 +2069,32 @@ A code-block is treated as an object and given a single object number. [an optio
                         condemn
                        you
                       to
-                       death."'
-

-
-

-

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

-
-1  |                    `Fury said to a
+                       death."’
+

+
 

+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
 2  |                   mouse, That he
 3  |                 met in the
 4  |               house,
-5  |            "Let us
+5  |            "Let us
 6  |              both go to
 7  |                law:  I will
 8  |                  prosecute
 9  |                    YOU.  --Come,
-10 |                       I'll take no
+10 |                       I’ll take no
 11 |                        denial; We
 12 |                     must have a
 13 |                 trial:  For
 14 |              really this
-15 |           morning I've
+15 |           morning I’ve
 16 |          nothing
-17 |         to do."
+17 |         to do."
 18 |           Said the
 19 |             mouse to the
-20 |               cur, "Such
+20 |               cur, "Such
 21 |                 a trial,
 22 |                   dear Sir,
 23 |                         With
@@ -2734,14 +2103,14 @@ code{# as demonstrated here:
 26 |                would be
 27 |              wasting
 28 |             our
-29 |              breath."
-30 |               "I'll be
-31 |                 judge, I'll
-32 |                   be jury,"
+29 |              breath."
+30 |               "I’ll be
+31 |                 judge, I’ll
+32 |                   be jury,"
 33 |                         Said
 34 |                    cunning
 35 |                      old Fury:
-36 |                     "I'll
+36 |                     "I’ll
 37 |                      try the
 38 |                         whole
 39 |                          cause,
@@ -2749,3905 +2118,1576 @@ code{# as demonstrated here:
 41 |                        condemn
 42 |                       you
 43 |                      to
-44 |                       death."'
-

-
-

- 
-
9.8 ADDITIONAL BREAKS - LINEBREAKS WITHIN OBJECTS, COLUMN AND PAGE-BREAKS

-
-

- 
-
9.8.1 LINE-BREAKS

-
-

-

-
-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",
+44 |                       death."’
+

+

+
Additional Breaks - Linebreaks Within Objects, Column and Page-breaks

+
+

+
Line-breaks

+
+

+

+To break a line within a "paragraph object", two backslashes \\ with a space
+before and a space or newline after them may be used.
+
 

+
To break a line within a "paragraph object",
 two backslashes \\ with a space before
 and a space or newline after them \\
 may be used.
-

-
-

-

-
+
+


The html break br enclosed in angle brackets (though undocumented) is available in versions prior to 3.0.13 and 2.9.7 (it remains available for the time being, but is depreciated). -

-  -

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

+
-\\-
+or
 <:pb>
-

-
-

-

+
+


+

or +


+

=\\=
 or
-

-
 <:pn>
-

-
-

-

-
-page new <:pn> breaks the page, starts a new page.
-

-

-
-page break <:pb> breaks a column, starts a new column, if using columns, else
-breaks the page, starts a new page.
-

- 
-
9.9 BOOK INDEX

-
-

-

-
-To make an index append to paragraph the book index term relates to it, using
-an equal sign and curly braces.
-

-

-
+
+

+

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

-

-  Paragraph containing main term and sub-term.
+
 

+
  Paragraph containing main term and sub-term.
   ={Main term:sub-term}
-

-
-

-

-
-The index syntax starts on a new line, but there should not be an empty line
-between paragraph and index markup.
-

-

-
+
+


+The index syntax starts on a new line, but there should not be an empty +line between paragraph and index markup. +


The structure of the resulting index would be: -

-

-  Main term, 1
+
 

+
  Main term, 1
     sub-term, 1
-

-
-

-

+
+


+Several terms may relate to a paragraph, they are separated by a semicolon. +If the term refers to more than one paragraph, indicate the number of paragraphs. -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.
+
 

+
  Paragraph containing main term, second term and sub-term.
   ={first term; second term: sub-term}
-

-
-

-

-
+
+


The structure of the resulting index would be: -

-

-  First term, 1,
+
 

+
  First term, 1,
   Second term, 1,
     sub-term, 1
-

-
-

-

-
-If multiple sub-terms appear under one paragraph, they are separated under the
-main term heading from each other by a pipe symbol.
-

-
-  Paragraph containing main term, second term and sub-term.
+

+
 

+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 one
-additional paragraph. The logical structure of the resulting index would be:
-

-
-  Main term, 1,
+

+
 

+The plus one in the example provided indicates the first sub-term spans
+one additional paragraph. The logical structure of the resulting index would
+be:
+
 

+
  Main term, 1,
     sub-term, 1-3,
     second sub-term, 1,
-

-
-

- 
-
10. COMPOSITE DOCUMENTS MARKUP

-
-

-
-

-

+
+

+

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 -

-

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

+

+
+
basic markup for importing a document into a master document
+
 

+
<< filename1.sst
 << filename2.ssi
-

-
-

-

-
-The form described above should be relied on. Within the Vim editor it results
-in the text thus linked becoming hyperlinked to the document it is calling in
-which is convenient for editing. Alternative markup for importation of
-documents under consideration, and occasionally supported have been.
-

-
-<< filename.ssi
-<<{filename.ssi}
-% using textlink alternatives
-<< |filename.ssi|@|^|
-

-
-

- 
-
11. MARKUP SYNTAX HISTORY

-
-

-
-

- 
-
11.1 NOTES RELATED TO FILES-TYPES AND MARKUP SYNTAX

-
-

-
-

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

-

+
+


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

+

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

+

Sisu Insert Files (.ssi)

-* sisu --query=[sisu  version  [0.38] or 'history] -

-
+

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

+

+ +
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 +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]
-provides a short history of changes to -SiSU +


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


+ sisu -S
-markup -

-
+


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

+
+ +

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/sisurc.yml
+ +


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


+ ~/.sisu/sisurc.yml
+ +


+ /etc/sisu/v4/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 +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 + +

+

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/v4/sisu_document_make
+ +


+ ~/.sisu/sisu_document_make
+ +


+ /etc/sisu/v4/sisu_document_make
+ +


+ /etc/sisu/sisu_document_make
+ +


+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 +structures of which there are 3 alternatives. +

+

Document Source Directory

-SiSU 2.0 +

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

+

General Directories

+ +

+
+

% files stored at this level e.g. sisu_manual.sst or
+% 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
+
+

+

Document Output Directory Structures

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

-

-@title:
- :subtitle:
+

+
Output Directory Root

 
-@creator:
- :author:
- :translator:
- :illustrator:
-
-@rights:
- :text:
- :illustrations:
-
- -

-
- -see document markup samples, and sisu --help headers -

-
- -the monospace tag takes the form of a hash '#' -

-

-#{ this enclosed text would be monospaced }#
-
+


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

+

Alternative Output Structures

+ +


+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
+output_dir_structure_by: language   #(language & filetype, preferred?)
+#output_dir_structure_by: filetype
+#output_dir_structure_by: filename  #(default, closest to original v1 &
+v2)
+
+

+

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


+

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


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


-1.0 +

Its selection is configured in sisurc.yml +


+output_dir_structure_by: filetype +


+

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


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

+

by Filename

-(2009-12-19:50/6) same as 0.69 -

-
+


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


-0.69 +

Its selection is configured in sisurc.yml +


+output_dir_structure_by: filename +


+

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


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

+

Remote Directories

-(2008-09-16:37/2) (same as 1.0) and as previous (0.57) with the addition of -book index tags -

-

-/^={.+?}$/
-
+


+

% 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
+ ./subject_name/_sisu
+% configuration file e.g. sisurc.yml
+ ./subject_name/_sisu/skin
+% skins in various skin directories doc, dir, site, yml
+ ./subject_name/_sisu/css
+ ./subject_name/_sisu/image
+% images for documents contained in this directory
+ ./subject_name/_sisu/mm
+
+

+

Sisupod

-

-
+


+

% files stored at this level e.g. sisu_manual.sst
+ ./sisupod/_sisu
+% configuration file e.g. sisurc.yml
+ ./sisupod/_sisu/skin
+% skins in various skin directories doc, dir, site, yml
+ ./sisupod/_sisu/css
+ ./sisupod/_sisu/image
+% images for documents contained in this directory
+ ./sisupod/_sisu/mm
+
+

+

Organising Content

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

-

-={GNU/Linux community distribution:Debian+2|Fedora|Gentoo;Free Software Foundation+5}
-
+

+

Homepages

+
-

-

-Free Software Foundation, 1-6
-GNU/Linux community distribution, 1
-    Debian, 1-3
-    Fedora, 1
-    Gentoo,
-
+


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

+

Sisu Markup Samples

+ +


+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 +licences that do not permit inclusion in the Debian Project as they have +requirements that do not meet the 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. + +


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


+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 +(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, +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 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 + +


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


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


+Viral Spiral, David Bollier (2008) viral_spiral.david_bollier.sst +

+

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

+

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 +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
+ .I Dublin Core.
+ ..);
+ +


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

+

Postgresql

+
+ +

+

Name

+ +


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

+

Synopsis

+ +


+ 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, + +

alternatively --sqlite or --pgsql may be used +


+-D or --pgsql may be used interchangeably. +

+

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

+ +
sisu -D +--createdb
+
creates database where no database 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 --recreate
+
destroys existing database 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 --update -v [filename/wildcard]
+
updates file contents in database + +

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

+
-

-
+

Sqlite

+
-0.66 +

+

Name

-(2008-02-24:07/7) same as previous, adds semantic tags, [experimental  and not-used] -

-

-/[:;]{.+?}[:;][a-z+]/
-
+


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

-
+

+

Description

-0.57 +


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

+

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, + +

alternatively --sqlite or --pgsql may be used +


+-d or --sqlite may be used interchangeably. +

+

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

+ +
sisu -d --createdb +
+
+

creates database where no database 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 --recreate
+
destroys existing database 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 an sqlite database (at an object level). + +

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

+ +
sisu -d --remove -v [filename/wildcard]
+
removes specified document from sqlite +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 +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] +

+

-(2007w34/4) -SiSU +
sisu -F --webserv-webrick
+
builds a cgi web -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:] -

-

-:A~ @title by @author
-
+

search 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
+  port:             5432
+  dbi connect:      DBI:Pg:database=SiSU_sisu;port=5432
+sqlite
+  current db set:   /home/ralph/sisu_www/sisu/sisu_sqlite.db
+  dbi connect       DBI:SQLite:/home/ralph/sisu_www/sisu/sisu_sqlite.db
+
+


-0.52 +

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 +

+
-(2007w14/6) declared document type identifier at start of text/document: -

-
+

Search +Form

-
  .B SiSU -0.52 -

-
+

+

-or, backward compatible using the comment marker: -

-
+

sisu -F
+
generates a sample search form, which must be copied to the -
  % -SiSU +

web-server cgi directory +

-0.38 -

-
+

sisu -F --webserv-webrick
+
generates a sample search +form for use with the webrick server, which must be copied to the web-server -variations include ' -SiSU +

cgi directory +

-(text|master|insert) [version]' and 'sisu-[version]' -

-
+

sisu -W
+
starts the webrick server which should be available -0.51 +

wherever sisu is properly installed +


-(2007w13/6) skins changed (simplified), markup unchanged -

-
+

The generated search form must be copied manually to the webserver directory -0.42 +

as instructed +

+
-(2006w27/4) * (asterisk) type endnotes, used e.g. in relation to author -

-
- -SiSU +

Sisu_webrick

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

-

-~{* for example for describing an author }~ and ~{** for describing a second author }~
-
+

+

Name

-

-
- -* for example for describing an author -

-
- -** for describing a second author -

-
+


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

-

-~[*  my  note  ]~ or ~[+  another  note  ]~
-
+

+

Synopsis

-

-
+


+sisu_webrick [port] +


-which numerically increments an asterisk and plus respectively -

-
+

or +


+sisu -W [port] +

+

Description

-*1 my note +1 another note -

-
+


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

+

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

been changed in ~/.sisu/sisurc.yaml then on port 8081 +

+

Summary of Features

+
+ +


+* 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 +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 +across browsers and formats. sisu seeks to provide a common way of pinpoint +the text within a document, (which can be utilized for citation and by +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 -0.38 +

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

-
+

these too may be processed locally to produce the desired document outputs -SiSU - -0.38 introduced alternative experimental header and heading/structure markers, -

-

-@headername: and headers :A~ :B~ :C~ 1~ 2~ 3~
-
- -

-
- -as the equivalent of: -

-

-0~headername and headers 1~ 2~ 3~ 4~ 5~ 6~
-
- -

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

-

-rename 's/\.s[123]$/\.sst/' *.s{1,2,3}
-rename 's/\.r[123]$/\.ssm/' *.r{1,2,3}
-rename 's/\.si$/\.ssi/' *.si
-
- -

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

-  -

12. SISU FILETYPES

- -
- -

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

-  -

12.1 .SST .SSM .SSI MARKED UP PLAIN TEXT

- -

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

-  -

12.1.1 SISU TEXT - REGULAR FILES (.SST)

- -

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

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

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

-  -

12.1.2 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 [^18] -

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

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

-  -

12.1.3 SISU INSERT FILES (.SSI)

- -

-
- -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 the file should be processed on its own. -

-  -

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

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

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

-  -

13. EXPERIMENTAL ALTERNATIVE INPUT REPRESENTATIONS

- -
- -

-  -

13.1 ALTERNATIVE XML

- -

-
- -SiSU - -offers alternative XML input representations of documents as a proof of -concept, experimental feature. They are however not strictly maintained, and -incomplete and should be handled with care. -

-
- -convert from sst to simple xml representations (sax, dom and node): - -

-
- -
  sisu --to-sax [filename/wildcard] or sisu --to-sxs [filename/wildcard] -

-
- -
  sisu --to-dom [filename/wildcard] or sisu --to-sxd [filename/wildcard] -

-
- -
  sisu --to-node [filename/wildcard] or sisu --to-sxn [filename/wildcard] -

-
- -convert to sst from any sisu xml representation (sax, dom and node): - -

-
- -
  sisu --from-xml2sst [filename/wildcard  [.sxs.xml,.sxd.xml,sxn.xml]] -

-
- -or the same: -

-
- -
  sisu --from-sxml [filename/wildcard  [.sxs.xml,.sxd.xml,sxn.xml]] -

-  -

13.1.1 XML SAX REPRESENTATION

- -

-
- -To convert from sst to simple xml (sax) representation: -

-
- -
  sisu --to-sax [filename/wildcard] or sisu --to-sxs [filename/wildcard] -

-
- -To convert from any sisu xml representation back to sst -

-
- -
  sisu --from-xml2sst [filename/wildcard  [.sxs.xml,.sxd.xml,sxn.xml]] -

-
- -or the same: -

-
- -
  sisu --from-sxml [filename/wildcard  [.sxs.xml,.sxd.xml,sxn.xml]] -

-  -

13.1.2 XML DOM REPRESENTATION

- -

-
- -To convert from sst to simple xml (dom) representation: -

-
- -
  sisu --to-dom [filename/wildcard] or sisu --to-sxd [filename/wildcard] -

-
- -To convert from any sisu xml representation back to sst -

-
- -
  sisu --from-xml2sst [filename/wildcard  [.sxs.xml,.sxd.xml,sxn.xml]] -

-
- -or the same: -

-
- -
  sisu --from-sxml [filename/wildcard  [.sxs.xml,.sxd.xml,sxn.xml]] -

-  -

13.1.3 XML NODE REPRESENTATION

- -

-
- -To convert from sst to simple xml (node) representation: -

-
- -
  sisu --to-node [filename/wildcard] or sisu --to-sxn [filename/wildcard] -

-
- -To convert from any sisu xml representation back to sst -

-
- -
  sisu --from-xml2sst [filename/wildcard  [.sxs.xml,.sxd.xml,sxn.xml]] -

-
- -or the same: -

-
- -
  sisu --from-sxml [filename/wildcard  [.sxs.xml,.sxd.xml,sxn.xml]] -

-  -

14. CONFIGURATION

- -
- -

-  -

14.1 DETERMINING THE CURRENT CONFIGURATION

- -

-
- -Information on the current configuration of -SiSU - -should be available with the help command: -

-
- -
  sisu -v -

-
- -which is an alias for: -

-
- -
  sisu --help env -

-
- -Either of these should be executed from within a directory that contains sisu -markup source documents. -

-  -

14.2 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/sisurc.yml -

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

-  -

15. SKINS

- -
- -

-
- -Skins modify the default appearance of document output on a document, -directory, or site wide basis. Skins are looked for in the following locations: -

-
- -
  ./_sisu/skin -

-
- -
  ~/.sisu/skin -

-
- -
  /etc/sisu/skin -

-
- -Within the skin directory - -are the following the default sub-directories for document skins: -

-
- -
  ./skin/doc -

-
- -
  ./skin/dir -

-
- -
  ./skin/site -

-
- -A skin is placed in the appropriate directory and the file named skin_[name].rb -

-
- -The skin itself is a ruby file which modifies the default appearances set in -the program. -

-  -

15.1 DOCUMENT SKIN

- -

-
- -Documents take on a document skin, if the header of the document specifies a -skin to be used. -

-

-@skin: skin_united_nations
-
- -

-  -

15.2 DIRECTORY SKIN

- -

-
- -A directory may be mapped on to a particular skin, so all documents within that -directory take on a particular appearance. If a skin exists in the skin/dir -with the same name as the document directory, it will automatically be used for -each of the documents in that directory, (except where a document specifies the -use of another skin, in the skin/doc directory). -

-
- -A personal habit is to place all skins within the doc directory, and symbolic -links as needed from the site, or dir directories as required. -

-  -

15.3 SITE SKIN

- -

-
- -A site skin, modifies the program default skin. -

-  -

15.4 SAMPLE SKINS

- -

-
- -With -SiSU - -installed sample skins may be found in: -

-
- -
  /etc/sisu/skin/doc and -
  /usr/share/doc/sisu/markup-samples/samples/_sisu/skin/doc -

-
- -(or equivalent directory) and if sisu-markup-samples is installed also under: -

-
- -
  /usr/share/doc/sisu/markup-samples-non-free/samples/_sisu/skin/doc -

-
- -Samples of list.yml and promo.yml (which are used to create the right column -list) may be found in: -

-
- -
  /usr/share/doc/sisu/markup-samples-non-free/samples/_sisu/skin/yml (or -
  equivalent directory) -

-  -

16. 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, and change the default CSS -file that is looked for in a skin.[^19] -

-  -

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

-  -

17.1 DOCUMENT SOURCE DIRECTORY

- -

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

-  -

17.1.1 GENERAL DIRECTORIES

- -

-

-% files stored at this level e.g. sisu_manual.sst or
-% for sisu v3 may be under language sub-directories
-% e.g.
-% configuration file e.g. sisurc.yml
-% skins in various skin directories doc, dir, site, yml
-
- -

-  -

17.2 DOCUMENT OUTPUT DIRECTORY STRUCTURES

- -

-  -

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

-  -

17.2.2 ALTERNATIVE OUTPUT STRUCTURES

- -

-
- -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
-output_dir_structure_by: language   #(language & filetype, preferred?)
-#output_dir_structure_by: filetype
-#output_dir_structure_by: filename  #(default, closest to original v1 & v2)
-
- -

-  -

17.2.3 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: language -

-

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

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

-  -

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

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

-
- -output_dir_structure_by: filetype -

-

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

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

-  -

17.2.5 BY FILENAME

- -

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

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

-
- -output_dir_structure_by: filename -

-

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

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

-  -

17.2.6 REMOTE DIRECTORIES

- -

-

-./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
- ./subject_name/_sisu
-% configuration file e.g. sisurc.yml
- ./subject_name/_sisu/skin
-% skins in various skin directories doc, dir, site, yml
- ./subject_name/_sisu/css
- ./subject_name/_sisu/image
-% images for documents contained in this directory
- ./subject_name/_sisu/mm
-
- -

-  -

17.2.7 SISUPOD

- -

-

-./sisupod/
-% files stored at this level e.g. sisu_manual.sst
- ./sisupod/_sisu
-% configuration file e.g. sisurc.yml
- ./sisupod/_sisu/skin
-% skins in various skin directories doc, dir, site, yml
- ./sisupod/_sisu/css
- ./sisupod/_sisu/image
-% images for documents contained in this directory
- ./sisupod/_sisu/mm
-
- -

-  -

17.3 ORGANISING CONTENT

- -

-  -

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

-  -

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

-  -

18.2 HOME PAGE WITHIN A SKIN

- -

-
- -Skins are described in a separate section, but basically are a file written in -the programming language -Ruby - -that may be provided to change the defaults that are provided with sisu with -respect to individual documents, a directories contents or for a site. -

-
- -If you wish to provide a homepage within a skin the skin should be in the -directory _sisu/skin/dir and have the name of the directory for which it is to -become the home page. Documents in the directory commercial_law would have the -homepage modified in skin_commercial law.rb; or the directory poems in -skin_poems.rb -

-

-  class Home
-    def homepage
-      # place the html content of your homepage here, this will become index.html
-      <<HOME <html>
-<head></head>
-<doc>
-<p>this is my new homepage.</p>
-</doc>
-</html>
-HOME
-    end
-  end
-
- -

-  -

19. MARKUP AND OUTPUT EXAMPLES

- -
- -

-  -

19.1 MARKUP EXAMPLES

- -

-
- -Current markup examples and document output samples are provided at -<http://www.jus.uio.no/sisu/SiSU/examples.html> -

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

-  -

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

-  -

21. SQL

- -
- -

-  -

21.1 POPULATING SQL TYPE DATABASES

- -

-
- -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 Dublin Core...); -

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

-  -

22. POSTGRESQL

- -
- -

-  -

22.1 NAME

- -

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

-  -

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

-  -

22.3 SYNOPSIS

- -

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

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

-  -

22.4 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, -alternatively --sqlite or --pgsql may be used -

-
- --D or --pgsql - -may be used interchangeably. -

-  -

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

-

sisu -D --createdb - -
-creates database where no database 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 --recreate - -
-destroys existing database and builds a new empty database structure -

-

-  -

22.4.2 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 --update -v [filename/wildcard] - -
-updates file contents in database -

-

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

-

-  -

23. SQLITE

- -
- -

-  -

23.1 NAME

- -

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

-  -

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

-  -

23.3 SYNOPSIS

- -

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

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

-  -

23.4 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, -alternatively --sqlite or --pgsql may be used -

-
- --d or --sqlite - -may be used interchangeably. -

-  -

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

-

sisu -d --createdb - -
-creates database where no database 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 --recreate - -
-destroys existing database and builds a new empty database structure -

-

-  -

23.4.2 IMPORT AND REMOVE DOCUMENTS

- -

-

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

-

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

-

sisu -d --remove -v [filename/wildcard] - -
-removes specified document from sqlite database. -

-

-  -

24. INTRODUCTION

- -
- -

-  -

24.1 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, -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.[^24] -

-

-
sisu -F --webserv-webrick - -
-builds a cgi web search 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
-  port:             5432
-  dbi connect:      DBI:Pg:database=SiSU_sisu;port=5432
-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 necessary] -

-

-  -

24.2 SEARCH FORM

- -

-

-
sisu -F - -
-generates a sample search form, which 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 cgi directory -

-

sisu -Fv - -
-as above, and provides some information on setting up hyperestraier -

-

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

-
- -The generated search form must be copied manually to the webserver directory as -instructed -

-

-  -

25. SISU_WEBRICK

- -
- -

-  -

25.1 NAME

- -

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

-  -

25.2 SYNOPSIS

- -

-
- -sisu_webrick [port] -

-
- -or -

-
- -sisu -W [port] -

-  -

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

-  -

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

-  -

25.5 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 been changed in ~/.sisu/sisurc.yaml then on port 8081 -

-  -

25.6 FURTHER INFORMATION

- -

-
- -For more information on -SiSU - -see: <http://www.sisudoc.org/> or <http://www.jus.uio.no/sisu> -

-
- -or man sisu -

-  -

25.7 AUTHOR

- -

-
- -Ralph Amissah <ralph@amissah.com> or <ralph.amissah@gmail.com> -

-  -

25.8 SEE ALSO

- -

-
- -
  sisu(1) -

-
- -
  sisu_vim(7) -

-  -

26. REMOTE SOURCE DOCUMENTS

- -
- -

-
- -SiSU - -processing instructions can be run against remote source documents by providing -the url of the documents against which the processing instructions are to be -carried out. The remote -SiSU - -documents can either be sisu marked up files in plaintext .sst or .ssm or; -zipped sisu files, sisupod.zip or filename.ssp -

-
- -.sst / .ssm - sisu text files - -

-
- -SiSU - -can be run against source text files on a remote machine, provide the -processing instruction and the url. The source file and any associated parts -(such as images) will be downloaded and generated locally. -

-

-sisu -3 http://[provide  url  to  valid  .sst  or  .ssm  file]
-
- -

-
- -Any of the source documents in the sisu examples page can be used in this way, -see <http://www.jus.uio.no/sisu/SiSU/examples.html> and use the url to the -
 .sst for the desired document. -

-
- -NOTE: to set up a remote machine to serve -SiSU - -documents in this way, images should be in the directory relative to the -document source ../_sisu/image -

-
- -sisupod - zipped sisu files - -

-
- -A sisupod is the zipped content of a sisu marked up text or texts and any other -associated parts to the document such as images. -

-
- -SiSU - -can be run against a sisupod on a (local or) remote machine, provide the -processing instruction and the url, the sisupod will be downloaded and the -documents it contains generated locally. -

-

-sisu -3 http://[provide  url  to  valid  sisupod.zip  or  .ssp  file]
-
- -

-
- -Any of the source documents in the sisu examples page can be used in this way, -see <http://www.jus.uio.no/sisu/SiSU/examples.html> and use the url for the -desired document. -

-  -

REMOTE DOCUMENT OUTPUT

- -
- -

-  -

27. REMOTE OUTPUT

- -
- -

-
- -Once properly configured -SiSU - -output can be automatically posted once generated to a designated remote -machine using either rsync, or scp. -

-
- -In order to do this some ssh authentication agent and keychain or similar tool -will need to be configured. Once that is done the placement on a remote host -can be done seamlessly with the -r (for scp) or -R (for rsync) flag, which -may be used in conjunction with other processing flags, e.g. -

-

-sisu -3R sisu_remote.sst
-
- -

-  -

27.1 COMMANDS

- -

-

-
-R [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 -r -

-

-r [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 -R -

-

-  -

27.2 CONFIGURATION

- -

-
- -[expand  on  the  setting  up  of  an  ssh-agent  /  keychain] -

-  -

28. REMOTE SERVERS

- -
- -

-
- -As -SiSU - -is generally operated using the command line, and works within a Unix type -environment, -SiSU - -the program and all documents can just as easily be on a remote server, to -which you are logged on using a terminal, and commands and operations would be -pretty much the same as they would be on your local machine. -

-  -

29. QUICKSTART - GETTING STARTED HOWTO

- -
- -

-  -

29.1 INSTALLATION

- -

-
- -Installation is currently most straightforward and tested on the -Debian - -platform, as there are packages for the installation of sisu and all -requirements for what it does. -

-  -

29.1.1 DEBIAN INSTALLATION

- -

-
- -SiSU - -is available directly from the -Debian - -Sid and testing archives (and possibly Ubuntu), assuming your -/etc/apt/sources.list is set accordingly: -

-

-  aptitude update
-  aptitude install sisu-complete
-
- -

-
- -The following /etc/apt/sources.list setting permits the download of additional -markup samples: -

-

-  #/etc/apt/sources.list
-

-    deb http://ftp.fi.debian.org/debian/ unstable main non-free contrib
-

-    deb-src http://ftp.fi.debian.org/debian/ unstable main non-free contrib
-

-
-
- -

-
- -The aptitude commands become: -

-

-    aptitude update
-

-    aptitude install sisu-complete sisu-markup-samples
-
- -

-
- -If there are newer versions of -SiSU - -upstream of the -Debian - -archives, they will be available by adding the following to your -/etc/apt/sources.list -

-

-#/etc/apt/sources.list
-  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
-
- -

-
- -repeat the aptitude commands -

-

-  aptitude update
-  aptitude install sisu-complete sisu-markup-samples
-
- -

-
- -Note however that it is not necessary to install sisu-complete if not all -components of sisu are to be used. Installing just the package sisu will -provide basic functionality. -

-  -

29.1.2 RPM INSTALLATION

- -

-
- -RPMs are provided though untested, they are prepared by running alien against -the source package, and against the debs. -

-
- -They may be downloaded from: -

-
- -
  <http://www.jus.uio.no/sisu/SiSU/download.html#rpm> -

-
- -as root type: -

-
- -
  rpm -i [rpm  package  name] -

-  -

29.1.3 INSTALLATION FROM SOURCE

- -

-
- -To install -SiSU - -from source check information at: -

-
- -
  <http://www.jus.uio.no/sisu/SiSU/download.html#current> -

-
- -* download the source package -

-
- -* Unpack the source -

-
- -Two alternative modes of installation from source are provided, setup.rb (by -Minero Aoki) and a rant(by Stefan Lang) built install file, in either case: the -first steps are the same, download and unpack the source file: -

-
- -For basic use -SiSU - -is only dependent on the programming language in which it is written -Ruby, - -and -SiSU - -will be able to generate html, EPUB, various XMLs, including ODF (and will also -produce LaTeX). Dependencies required for further actions, though it relies on -the installation of additional dependencies which the source tarball does not -take care of, for things like using a database (postgresql or sqlite)[^25] or -converting LaTeX to pdf. -

-
- -setup.rb - -

-
- -This is a standard ruby installer, using setup.rb is a three step process. In -the root directory of the unpacked -SiSU - -as root type: -

-

-    ruby setup.rb config
-    ruby setup.rb setup
-    #[and  as  root:]
-    ruby setup.rb install
-
- -

-
- -further information on setup.rb is available from: -

-
- -
  <http://i.loveruby.net/en/projects/setup/> -

-
- -
  <http://i.loveruby.net/en/projects/setup/doc/usage.html> -

-
- -install - -

-
- -The "install" file provided is an installer prepared using "rant". In the root -directory of the unpacked -SiSU - -as root type: -

-
- -
  ruby install base -

-
- -or for a more complete installation: -

-
- -
  ruby install -

-
- -or -

-
- -
  ruby install base -

-
- -This makes use of Rant (by Stefan Lang) and the provided Rantfile. It has been -configured to do post installation setup setup configuration and generation of -first test file. Note however, that additional external package dependencies, -such as tetex-extra are not taken care of for you. -

-
- -Further information on "rant" is available from: -

-
- -
  <http://make.rubyforge.org/> -

-
- -
  <http://rubyforge.org/frs/?group_id=615> -

-
- -For a list of alternative actions you may type: -

-
- -
  ruby install help -

-
- -
  ruby install -T -

-  -

29.2 TESTING SISU, GENERATING OUTPUT

- -

-
- -To check which version of sisu is installed: -

-
- -sisu -v -

-
- -Depending on your mode of installation one or a number of markup sample files -may be found either in the directory: -

-
- - -

-
- -or -

-
- - -

-
- -change directory to the appropriate one: -

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

-  -

29.2.1 BASIC TEXT, PLAINTEXT, HTML, XML, ODF, EPUB

- -

-
- -Having moved to the directory that contains the markup samples (see -instructions above if necessary), choose a file and run sisu against it -

-
- -sisu -NhwoabxXyv free_as_in_freedom.rms_and_free_software.sam_williams.sst -

-
- -this will generate html including a concordance file, opendocument text format, -plaintext, XHTML and various forms of XML, and OpenDocument text -

-  -

29.2.2 LATEX / PDF

- -

-
- -Assuming a LaTeX engine such as tetex or texlive is installed with the required -modules (done automatically on selection of sisu-pdf in -Debian - -) -

-
- -Having moved to the directory that contains the markup samples (see -instructions above if necessary), choose a file and run sisu against it -

-
- -sisu -pv free_as_in_freedom.rms_and_free_software.sam_williams.sst -

-
- -sisu -3 free_as_in_freedom.rms_and_free_software.sam_williams.sst -

-
- -should generate most available output formats: html including a concordance -file, opendocument text format, plaintext, XHTML and various forms of XML, and -OpenDocument text and pdf -

-  -

29.2.3 RELATIONAL DATABASE - POSTGRESQL, SQLITE

- -

-
- -Relational databases need some setting up - you must have permission to create -the database and write to it when you run sisu. -

-
- -Assuming you have the database installed and the requisite permissions -

-
- -sisu --sqlite --recreate -

-
- -sisu --sqlite -v --import -free_as_in_freedom.rms_and_free_software.sam_williams.sst -

-
- -sisu --pgsql --recreate -

-
- -sisu --pgsql -v --import -free_as_in_freedom.rms_and_free_software.sam_williams.sst -

-  -

29.3 GETTING HELP

- -

-  -

29.3.1 THE MAN PAGES

- -

-
- -Type: -

-
- -
  man sisu -

-
- -The man pages are also available online, though not always kept as up to date -as within the package itself: -

-
- -* sisu.1 <http://www.jus.uio.no/sisu/man/sisu.1.html> [^26] -

-
- -* sisu.8 <http://www.jus.uio.no/sisu/man/sisu.8.html> [^27] -

-
- -* man directory <http://www.jus.uio.no/sisu/man> [^28] -

-  -

29.3.2 BUILT IN HELP

- -

-
- -sisu --help -

-
- -sisu --help --env -

-
- -sisu --help --commands -

-
- -sisu --help --markup -

-  -

29.3.3 THE HOME PAGE

- -

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

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

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

-  -

29.4 MARKUP SAMPLES

- -

-
- -A number of markup samples (along with output) are available off: -

-
- -<http://www.jus.uio.no/sisu/SiSU/examples.html> -

-
- -Additional markup samples are packaged separately in the file: -

-
- -*** -

-
- -On -Debian - -they are available in non-free[^29] to include them it is necessary to include -non-free in your /etc/apt/source.list or obtain them from the sisu home site. -

-  -

30. EDITOR FILES, SYNTAX HIGHLIGHTING

- -
- -

-
- -The directory: -

-
- -
  ./data/sisu/v2/conf/editor-syntax-etc/ -

-
- -
  ./data/sisu/v3/conf/editor-syntax-etc/ -

-
- -
  /usr/share/sisu/v2/conf/editor-syntax-etc -

-
- -
  /usr/share/sisu/v3/conf/editor-syntax-etc -

-
- -contains rudimentary sisu syntax highlighting files for: -

-
- -* (g)vim <http://www.vim.org> -

-
- -
  package: sisu-vim -

-
- -status: largely done -

-
- -
  there is a vim syntax highlighting and folds component -

-
- -* gedit <http://www.gnome.org/projects/gedit> -

-
- -* gobby <http://gobby.0x539.de/> -

-
- -
  file: sisu.lang -

-
- -place in: -

-
- -
  /usr/share/gtksourceview-1.0/language-specs -

-
- -or -

-
- -
  ~/.gnome2/gtksourceview-1.0/language-specs -

-
- -
  status: very basic syntax highlighting -

-
- -
  comments: this editor features display line wrap and is used by Goby! -

-
- -* nano <http://www.nano-editor.org> -

-
- -
  file: nanorc -

-
- -save as: -

-
- -
  ~/.nanorc -

-
- -
  status: basic syntax highlighting -

-
- -
  comments: assumes dark background; no display line-wrap; does line breaks -

-
- -* diakonos (an editor written in ruby) <http://purepistos.net/diakonos> -

-
- -file: diakonos.conf -

-
- -save as: -

-
- -
  ~/.diakonos/diakonos.conf -

-
- -includes: -

-
- -
  status: basic syntax highlighting -

-
- -comments: assumes dark background; no display line-wrap -

-
- -* kate & kwrite <http://kate.kde.org> -

-
- -
  file: sisu.xml -

-
- -
  place in: -

-
- -
    /usr/share/apps/katepart/syntax -

-
- -
  or -

-
- -
    ~/.kde/share/apps/katepart/syntax -

-
- -
  [settings::configure  kate::{highlighting,filetypes}] -

-
- -
  [tools::highlighting::{markup,scripts}::  .B  SiSU  ] -

-
- -* nedit <http://www.nedit.org> -

-
- -
  file: sisu_nedit.pats -

-
- -
  nedit -import sisu_nedit.pats -

-
- -
  status: a very clumsy first attempt [not  really  done] -

-
- -
  comments: this editor features display line wrap -

-
- -* emacs <http://www.gnu.org/software/emacs/emacs.html> -

-
- -
  files: sisu-mode.el -

-
- -
  to file ~/.emacs add the following 2 lines: -

-
- -
    (add-to-list 'load-path -
    "/usr/share/sisu/v2/conf/editor-syntax-etc/emacs") -

-
- -
    (require 'sisu-mode.el) -

-
- -
  [not  done  /  not  yet  included] -

-
- -* vim & gvim <http://www.vim.org> -

-
- -
  files: -

-
- -
  package is the most comprehensive sisu syntax highlighting and editor -
  environment provided to date (is for vim/ gvim, and is separate from the -
  contents of this directory) -

-
- -
  status: this includes: syntax highlighting; vim folds; some error checking -

-
- -
  comments: this editor features display line wrap -

-
- -NOTE: -

-
- -[  .B  SiSU  parses  files  with  long  lines  or  line  breaks, but,  display  linewrap  (without  line-breaks)  is  a  convenient editor  feature  to  have  for  sisu  markup] -

-  -

31. HOW DOES SISU WORK?

- -
- -

-
- -SiSU - -markup is fairly minimalistic, it consists of: a (largely optional) document -header, made up of information about the document (such as when it was -published, who authored it, and granting what rights) and any processing -instructions; and markup within the substantive text of the document, which is -related to document structure and typeface. -SiSU - -must be able to discern the structure of a document, (text headings and their -levels in relation to each other), either from information provided in the -document header or from markup within the text (or from a combination of both). -Processing is done against an abstraction of the document comprising of -information on the document's structure and its objects,[2] which the program -serializes (providing the object numbers) and which are assigned hash sum -values based on their content. This abstraction of information about document -structure, objects, (and hash sums), provides considerable flexibility in -representing documents different ways and for different purposes (e.g. search, -document layout, publishing, content certification, concordance etc.), and -makes it possible to take advantage of some of the strengths of established -ways of representing documents, (or indeed to create new ones). -

-  -

32. SUMMARY OF FEATURES

- -
- -

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

-
- -
  * ODF - open document format, the iso standard for document storage -

-
- -
  * LaTeX - used to generate pdf -

-
- -
  * pdf (via LaTeX) -

-
- -
  * sql - population of an sql database, (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 across -browsers and formats. sisu seeks to provide a common way of pinpoint the text -within a document, (which can be utilized for citation and by 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  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. -

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

-
+


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


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

-
- +


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

-  -

33. HELP SOURCES

- -
- -

-  -

33.1 MAN PAGES

- -

-
- -
  man sisu -

-
- -
  man sisu-concordance -

-
- -
  man sisu-epub -

-
- -
  man sisu-git -

-
- -
  man sisu-harvest -

-
- -
  man sisu-html -

-
- -
  man sisu-odf -

-
- -
  man sisu-pdf -

-
- -
  man sisu-pg -

-
- -
  man sisu-po -

-
- -
  man sisu-sqlite -

-
- -
  man sisu-txt -

-
- -
  man 7 sisu_complete -

-
- -
  man 7 sisu_pdf -

-
- -
  man 7 sisu_postgresql -

-
- -
  man 7 sisu_sqlite -

-
- -
  man sisu_termsheet -

-
- -
  man sisu_webrick -

-  -

33.2 SISU GENERATED OUTPUT - LINKS TO HTML

- -

-
- -Note -SiSU - -documentation is prepared in -SiSU - -and output is available in multiple formats including amongst others html, pdf, -odf and epub, which may be also be accessed via the html pages[^30] -

-  -

33.2.1 WWW.SISUDOC.ORG

- -

-
- -<http://sisudoc.org/sisu/sisu_manual/index.html> -

-
- -
  <http://sisudoc.org/sisu/sisu_manual/index.html> -

-  -

33.3 MAN2HTML

- -

-  -

33.3.1 LOCALLY INSTALLED

- -

-
- -file:///usr/share/doc/sisu/html/sisu.1.html -

-
- -
  file:///usr/share/doc/sisu/html/sisu.1.html -

-
- -
  /usr/share/doc/sisu/html/sisu_pdf.7.html -

-
- -
  /usr/share/doc/sisu/html/sisu_postgresql.7.html -

-
- -
  /usr/share/doc/sisu/html/sisu_sqlite.7.html -

-
- -
  /usr/share/doc/sisu/html/sisu_webrick.1.html -

-  -

33.3.2 WWW.JUS.UIO.NO/SISU

- -

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

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

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

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

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

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

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

-

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

-
- -

2. - -
-i.e. the html, pdf, epub, odf 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. -

-
- -

3. - -
-the different heading levels -

-
- -

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

-
- -

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

-
- -<http://www.linux-watch.com/news/NS7542722606.html> -

-
- -

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

-
- -

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

-
- -

*1. - -
-square brackets -

-
- -

*2. - -
-square brackets -

-
- -

+1. - -
-square brackets -

-
- -

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

-
- -

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

-
- -

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

+

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


    +

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


    +

    3. .
  3. +

    the different heading levels +


    +

    4. .
  4. units of text, primarily paragraphs and headings, also any tables, poems, + +

    code-blocks +


    +

    5. .
  5. +

    An open standard format for e-books +


    +

    6. .
  6. Open Document Format ( +


    + +

    ODF +


    +) text +


    +

    7. .
  7. +

    Specification submitted by Adobe to ISO to become a full open ISO specification + +


    +<http://www.linux-watch.com/news/NS7542722606.html +> +


    +

    8. .
  8. +

    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/sisu.1.html +> +


    +

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

    -
    - -

    11. - -
    -files should be prepared using UTF-8 character encoding -

    -
    - -

    12. - -
    -a footnote or endnote -

    -
    - -

    13. - -
    -self contained endnote marker & endnote in one -

    -
    - -

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

    -
    - -

    **. - -
    -another unnumbered asterisk footnote/endnote -

    -
    - -

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

    -
    - -

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

    -
    - -

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

    -
    - -

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

    -
    - -

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

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

    -
    - -

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

    -
    - -

    20. - -
    -<http://www.postgresql.org/> -

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

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

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

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

    -
    - -

    23. - -
    -(which could be extended further with current back-end). As regards scaling +


    +

    • .
  • +

    files should be prepared using +


    + +

    UTF-8 +


    + +

    character encoding +


    +

    • .
  • +

    a footnote or endnote +


    +

    • .
  • self contained endnote marker & endnote in one +


    +

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


    +

    + +
    **.
    +
    another unnumbered asterisk footnote/endnote +


    +

    + +
    *3.
    +
    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/ +> +


    +

    • .
  • +

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


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


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


    +

    • .
  • <http://www.hwaci.com/sw/sqlite/ +> +


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


    +

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

    -
    - -

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

    -
    - -

    25. - -
    -There is nothing to stop MySQL support being added in future. -

    -
    - -

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

    -
    - -

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

    -
    - -

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

    -
    - -29. the -Debian - -Free Software guidelines require that everything distributed within -Debian - -can be changed - and the documents are authors' works that while freely -distributable are not freely changeable. -

    -
    - -30. named index.html or more extensively through sisu_manifest.html -
    - -

    -

    • -  -

    SEE ALSO

    - -
    - -sisu(1), -
    - -sisu-epub(1), -
    - -sisu-harvest(1), -
    - -sisu-html(1), -
    - -sisu-odf(1), -
    - -sisu-pdf(1), -
    - -sisu-pg(1), -
    - -sisu-sqlite(1), -
    - -sisu-txt(1). -
    - -sisu_vim(7) -

    -  -

    HOMEPAGE

    - -
    - -More information about SiSU can be found at <http://www.sisudoc.org/> or <http://www.jus.uio.no/sisu/>. -

    -  -

    AUTHOR

    - -SiSU is written by Ralph Amissah <ralph@amissah.com>. -

    - -

    - 

    Index

    -
    -
    NAME
    -
    SYNOPSIS
    -
    SISU - MANUAL,
    -
    WHAT IS SISU?
    -
    1. INTRODUCTION - WHAT IS SISU?
    -
    2. COMMANDS SUMMARY
    -
    2.1 DESCRIPTION
    -
    2.2 DOCUMENT PROCESSING COMMAND FLAGS
    -
    3. COMMAND LINE MODIFIERS
    -
    4. DATABASE COMMANDS
    -
    5. SHORTCUTS, SHORTHAND FOR MULTIPLE FLAGS
    -
    5.1 COMMAND LINE WITH FLAGS - BATCH PROCESSING
    -
    6. HELP
    -
    6.1 SISU MANUAL
    -
    6.2 SISU MAN PAGES
    -
    6.3 SISU BUILT-IN INTERACTIVE HELP
    -
    7. INTRODUCTION TO SISU MARKUP[^10]
    -
    7.1 SUMMARY
    -
    7.2 MARKUP EXAMPLES
    -
    7.2.1 ONLINE
    -
    7.2.2 INSTALLED
    -
    8. MARKUP OF HEADERS
    -
    8.1 SAMPLE HEADER
    -
    8.2 AVAILABLE HEADERS
    -
    9. MARKUP OF SUBSTANTIVE TEXT
    -
    9.1 HEADING LEVELS
    -
    9.2 FONT ATTRIBUTES
    -
    9.3 INDENTATION AND BULLETS
    -
    9.4 HANGING INDENTS
    -
    9.5 FOOTNOTES / ENDNOTES
    -
    9.6 LINKS
    -
    9.6.1 NAKED URLS WITHIN TEXT, DEALING WITH URLS
    -
    9.6.2 LINKING TEXT
    -
    9.7 GROUPED TEXT
    -
    9.7.1 TABLES
    -
    9.7.2 POEM
    -
    9.7.3 GROUP
    -
    9.7.4 CODE
    -
    9.8 ADDITIONAL BREAKS - LINEBREAKS WITHIN OBJECTS, COLUMN AND PAGE-BREAKS
    -
    9.8.1 LINE-BREAKS
    -
    9.8.2 PAGE BREAKS
    -
    9.9 BOOK INDEX
    -
    10. COMPOSITE DOCUMENTS MARKUP
    -
    11. MARKUP SYNTAX HISTORY
    -
    11.1 NOTES RELATED TO FILES-TYPES AND MARKUP SYNTAX
    -
    12. SISU FILETYPES
    -
    12.1 .SST .SSM .SSI MARKED UP PLAIN TEXT
    -
    12.1.1 SISU TEXT - REGULAR FILES (.SST)
    -
    12.1.2 SISU MASTER FILES (.SSM)
    -
    12.1.3 SISU INSERT FILES (.SSI)
    -
    12.2 SISUPOD, ZIPPED BINARY CONTAINER (SISUPOD.ZIP, .SSP)
    -
    13. EXPERIMENTAL ALTERNATIVE INPUT REPRESENTATIONS
    -
    13.1 ALTERNATIVE XML
    -
    13.1.1 XML SAX REPRESENTATION
    -
    13.1.2 XML DOM REPRESENTATION
    -
    13.1.3 XML NODE REPRESENTATION
    -
    14. CONFIGURATION
    -
    14.1 DETERMINING THE CURRENT CONFIGURATION
    -
    14.2 CONFIGURATION FILES (CONFIG.YML)
    -
    15. SKINS
    -
    15.1 DOCUMENT SKIN
    -
    15.2 DIRECTORY SKIN
    -
    15.3 SITE SKIN
    -
    15.4 SAMPLE SKINS
    -
    16. CSS - CASCADING STYLE SHEETS (FOR HTML, XHTML AND XML)
    -
    17. ORGANISING CONTENT - DIRECTORY STRUCTURE AND MAPPING
    -
    17.1 DOCUMENT SOURCE DIRECTORY
    -
    17.1.1 GENERAL DIRECTORIES
    -
    17.2 DOCUMENT OUTPUT DIRECTORY STRUCTURES
    -
    17.2.1 OUTPUT DIRECTORY ROOT
    -
    17.2.2 ALTERNATIVE OUTPUT STRUCTURES
    -
    17.2.3 BY LANGUAGE
    -
    17.2.4 BY FILETYPE
    -
    17.2.5 BY FILENAME
    -
    17.2.6 REMOTE DIRECTORIES
    -
    17.2.7 SISUPOD
    -
    17.3 ORGANISING CONTENT
    -
    18. HOMEPAGES
    -
    18.1 HOME PAGE AND OTHER CUSTOM BUILT PAGES IN A SUB-DIRECTORY
    -
    18.2 HOME PAGE WITHIN A SKIN
    -
    19. MARKUP AND OUTPUT EXAMPLES
    -
    19.1 MARKUP EXAMPLES
    -
    20. SISU SEARCH - INTRODUCTION
    -
    21. SQL
    -
    21.1 POPULATING SQL TYPE DATABASES
    -
    22. POSTGRESQL
    -
    22.1 NAME
    -
    22.2 DESCRIPTION
    -
    22.3 SYNOPSIS
    -
    22.4 COMMANDS
    -
    22.4.1 CREATE AND DESTROY DATABASE
    -
    22.4.2 IMPORT AND REMOVE DOCUMENTS
    -
    23. SQLITE
    -
    23.1 NAME
    -
    23.2 DESCRIPTION
    -
    23.3 SYNOPSIS
    -
    23.4 COMMANDS
    -
    23.4.1 CREATE AND DESTROY DATABASE
    -
    23.4.2 IMPORT AND REMOVE DOCUMENTS
    -
    24. INTRODUCTION
    -
    24.1 SEARCH - DATABASE FRONTEND SAMPLE, UTILISING DATABASE AND SISU FEATURES,
    -
    24.2 SEARCH FORM
    -
    25. SISU_WEBRICK
    -
    25.1 NAME
    -
    25.2 SYNOPSIS
    -
    25.3 DESCRIPTION
    -
    25.4 SUMMARY OF MAN PAGE
    -
    25.5 DOCUMENT PROCESSING COMMAND FLAGS
    -
    25.6 FURTHER INFORMATION
    -
    25.7 AUTHOR
    -
    25.8 SEE ALSO
    -
    26. REMOTE SOURCE DOCUMENTS
    -
    REMOTE DOCUMENT OUTPUT
    -
    27. REMOTE OUTPUT
    -
    27.1 COMMANDS
    -
    27.2 CONFIGURATION
    -
    28. REMOTE SERVERS
    -
    29. QUICKSTART - GETTING STARTED HOWTO
    -
    29.1 INSTALLATION
    -
    29.1.1 DEBIAN INSTALLATION
    -
    29.1.2 RPM INSTALLATION
    -
    29.1.3 INSTALLATION FROM SOURCE
    -
    29.2 TESTING SISU, GENERATING OUTPUT
    -
    29.2.1 BASIC TEXT, PLAINTEXT, HTML, XML, ODF, EPUB
    -
    29.2.2 LATEX / PDF
    -
    29.2.3 RELATIONAL DATABASE - POSTGRESQL, SQLITE
    -
    29.3 GETTING HELP
    -
    29.3.1 THE MAN PAGES
    -
    29.3.2 BUILT IN HELP
    -
    29.3.3 THE HOME PAGE
    -
    29.4 MARKUP SAMPLES
    -
    30. EDITOR FILES, SYNTAX HIGHLIGHTING
    -
    31. HOW DOES SISU WORK?
    -
    32. SUMMARY OF FEATURES
    -
    33. HELP SOURCES
    -
    33.1 MAN PAGES
    -
    33.2 SISU GENERATED OUTPUT - LINKS TO HTML
    -
    33.2.1 WWW.SISUDOC.ORG
    -
    33.3 MAN2HTML
    -
    33.3.1 LOCALLY INSTALLED
    -
    33.3.2 WWW.JUS.UIO.NO/SISU
    -
    SEE ALSO
    -
    HOMEPAGE
    -
    AUTHOR
    -
    -
    -This document was created by -man2html, -using the manual pages.
    -Time: 04:10:50 GMT, May 26, 2012 - - +


    +.

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


    + +

    • + + +

    See Also

    + sisu(1) +,
    + sisu-epub(1) +,
    + sisu-harvest(1) +,
    + sisu-html(1) +,
    + sisu-odf(1) +,
    + sisu-pdf(1) +,
    + sisu-pg(1) +,
    + sisu-sqlite(1) +,
    + sisu-txt(1) +.
    + sisu_vim(7) +
    + +

    Homepage

    + More information about SiSU can be found at <http://www.sisudoc.org/ +> +or <http://www.jus.uio.no/sisu/ +>
    + +

    Source

    + <http://sources.sisudoc.org/ +>
    + +

    Author

    + SiSU is written by Ralph Amissah <ralph@amissah.com>
    +

    + +

    +Table of Contents

    +

    + + diff --git a/data/doc/sisu/html/sisu4.1.html b/data/doc/sisu/html/sisu4.1.html new file mode 100644 index 00000000..345e574b --- /dev/null +++ b/data/doc/sisu/html/sisu4.1.html @@ -0,0 +1,3693 @@ + + + + + +"sisu"("1") manual page + + +Table of Contents

    +
    + +

    Name

    +
    +sisu - documents: markup, structuring, publishing in multiple standard formats, +and search
    + +

    Synopsis

    +
    +sisu [-short-options|--long-options] [filename/wildcard] +


    +sisu [-abCcDdeFGghIikLMmNnoPpQqRrSsTtUuVvWwXxYyZ_0-9] [filename/wildcard] + +


    +sisu --txt --html --epub --odt --pdf --wordmap --sqlite --manpage --texinfo --sisupod --source +--qrcode [filename/wildcard] +


    +sisu [-Ddcv] [instruction] [filename/wildcard] +


    +sisu --pg (--createdb|update [filename/wildcard]|--dropall) +


    +sisu [operations] +


    +sisu [-CcFLSVvW] +


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

    Sisu - Manual,

    +RALPH AMISSAH
    + +

    +

    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: +(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 SiSU markup applied to a document, SiSU custom builds (to +take advantage of the strengths of different ways of representing documents) +various standard open output formats including plain text, HTML, XHTML, +XML, EPUB, ODT, LaTeX or PDF files, and populate an SQL 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 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 +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 +is to keep up with a moving target. SiSU permits new forms of output to +be added as they become important, (Open Document Format text was added +in 2006 when it became an ISO standard for office applications and the +archival of documents), EPUB was introduced in 2009; and allows the technical +representations existing output to be updated ( HTML has evolved and the +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/ +> +


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

    +

    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 +

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

    + +
    -CC
    +
    see --configure +

    + +
    -c [filename/wildcard]
    +
    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 + +

    - +

    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 +

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

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

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

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

    + +
    -F [--webserv=webrick]
    +
    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 +

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

    + +
    -g [filename/wildcard] +
    +
    +

    see --git +

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

    + +
    --glob +[optional  string  part  of  filename]
    +
    see --find +

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

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

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

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

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

    see --maintenance +

    + +
    -L
    +
    prints license information. +

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

    see --maintenance +

    + +
    -m [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. +

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

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

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

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

    + +
    --odt [filename/wildcard/url]
    +
    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 +

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

    + +
    -q [filename/wildcard]
    +
    see --quiet +

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

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

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

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

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

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

    + +
    --texinfo [filename/wildcard]
    +
    produces texinfo and info file, (view +with pinfo). Alias -I +

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

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

    + +
    -u [filename/wildcard] +
    +
    provides url mapping of output files for the flags requested for processing, + +

    also see -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. + +

    + +
    -v
    +
    on its own, provides SiSU version information +

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

    see --verbose +

    + +
    --v3 [filename/wildcard]
    +
    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] +
    +
    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 +

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

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

    see --concordance +

    + +
    --xhtml [filename/wildcard]
    +
    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). + +

    Alias -x +

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

    + +
    -x [filename/wildcard]
    +
    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]) +

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

    + +
    -Z [filename/wildcard]
    +
    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 +

    +
    + +

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

    by asterisk or dagger/plus sign +

    + +
    --no-asterisk
    +
    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 +

    +
    + +

    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  )  ] +

    +

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

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

    + +
    --pg --remove
    +
    [filename/wildcard] +removes specified data to PostgreSQL db (rb.dbi) [  -d  --remove  .I  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. +

    +
    + +

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

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

    + +
    -1
    +
    -Qhewpoty +

    + +
    -2
    +
    -NQhewpotbxXy + +

    + +
    -3
    +
    -NQhewpotbxXyY +

    + +
    -4
    +
    -NQhewpotbxXDyY --update +

    + +
    -5
    +
    -NQhewpotbxXDyYv --update +


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


    + +

    consider -u for appended url info or -v for verbose output +

    +
    + +

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

    +

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

    + +


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


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


    + /usr/share/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/ +> [^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]

    +
    + +

    +

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


    + +

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


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


    +

    % this would be a comment
+
    +

    +

    Sample Header

    + +


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


    +

    % SiSU master 2.0
+@title: SiSU
+:subtitle: Manual
+@creator:
+:author: Amissah, Ralph
+@publisher: [publisher  name]
+@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation,
+License GPL 3
+@classify:
+: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
+@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]
+@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
+
    +

    +

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

    All Dublin Core meta tags are available +


    +@indentifier: information or instructions +


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


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


    + +

    This is a sample header +


    +

    % SiSU 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]
+  :language: English
+
    +


    +

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


    +

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


    +

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


    +

    @links: { SiSU }http://www.sisudoc.org
+  { FSF }http://www.fsf.org
+
    +


    +

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


    +

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


    +

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


    +

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

    +

    Font Attributes

    + +


    +markup example: +


    +

    normal text,  *{emphasis}*, !{bold text}!, /{italics}/, _{underscore}_,
+"{citation}",
+^{superscript}^, ,{subscript},, +{inserted text}+, -{strikethrough}-, #{monospace}#
+normal text
+*{emphasis}* [note:  can  be  configured  to  be  represented  by  bold,  italics
+ or  underscore]
+!{bold text}!
+/{italics}/
+_{underscore}_
+"{citation}"
+^{superscript}^
+,{subscript},
++{inserted text}+
+-{strikethrough}-
+#{monospace}#
+
    +


    +resulting output: +


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


    + +

    normal text +


    +emphasis [note:  can  be  configured  to  be  represented  by  bold,  italics  italics + or  underscore] or  underscore] +


    + +

    bold text +


    + +

    italics +


    + +

    underscore +


    +"citation" +


    +^superscript^ +


    +[subscript] +


    +++inserted text++ +


    +--strikethrough-- +


    + +

    monospace +

    +

    Indentation and Bullets

    + +


    +markup example: +


    +

    ordinary paragraph
+_1 indent paragraph one step
+_2 indent paragraph two steps
+_9 indent paragraph nine steps
+
    +


    +resulting output: +


    + +

    ordinary paragraph +


    + indent paragraph one step
    + +


    + indent paragraph two steps
    + +


    + indent paragraph nine steps
    + +


    +markup example: +


    +

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


    +resulting output: +


    +* bullet text +


    + * bullet text, first indent
    + +


    + * bullet text, two step indent
    + +


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


    +markup example: +


    +

    # numbered list                numbered list 1., 2., 3, etc.
+_# numbered list numbered list indented a., b., c., d., etc.
+
    +

    +

    Hanging Indents

    + +


    +markup example: +


    +

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


    +resulting output: +


    + first line no indent, rest of paragraph indented one step
    + +


    +first line indented, rest of paragraph no indent +


    + +

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

    determines whether footnotes or endnotes will be produced +


    +markup example: +


    +

    ~{ a footnote or endnote }~
+
    +


    +resulting output: +


    +[^13] +


    +markup example: +


    +

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


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


    +

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


    +

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

    +

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


    +

    normal text http://www.sisudoc.org/ continues
+
    +


    +resulting output: +


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


    + +

    An 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/ +> continues +


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


    +where a code block is used there is neither decoration nor hyperlinking, + +

    code blocks are discussed later in this document +


    +resulting output: +


    +

    deb http://www.jus.uio.no/sisu/archive unstable main non-free
+deb-src http://www.jus.uio.no/sisu/archive unstable main non-free
+
    +

    +

    Linking Text

    + +


    + +

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


    +markup example: +


    +

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


    +resulting output: +


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


    + +

    A shortcut notation is available so the url link may also be provided automatically + +

    as a footnote +


    +markup example: +


    +

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


    +resulting output: +


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


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


    +markup example: +


    +

    about { text links }#link_text
+
    +


    +resulting output: +


    +about ⌠text links⌡⌈link_text⌋ +


    + +

    Shared document collection link +


    +markup example: +


    +

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


    +resulting output: +


    +about ⌠ SiSU book markup examples⌡⌈:SiSU/examples.html⌋ +

    +

    Linking +Images

    + +


    +markup example: +


    +

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


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


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


    + +

    linked url footnote shortcut +


    +

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


    +

    text marker *~name
+
    +


    +note at a heading level the same is automatically achieved by providing +names to headings 1, 2 and 3 i.e. 2~[name] and 3~[name] or in the case of +auto-heading numbering, without further intervention. +

    +

    Link Shortcut for +Multiple Versions of a Sisu Document in the Same Directory

    +TREE +


    +markup example: +


    +

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


    + 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 +>
    + ⌠html, segmented text⌡「http://corundum/sisu_manual/en/html/viral_spiral.david_bollier.html」 +
    + ⌠html, scroll, document in one⌡「http://corundum/sisu_manual/en/html/viral_spiral.david_bollier.html」 +
    + ⌠epub⌡「http://corundum/sisu_manual/en/epub/viral_spiral.david_bollier.epub」 +
    + ⌠pdf, landscape⌡「http://corundum/sisu_manual/en/pdf/viral_spiral.david_bollier.pdf」 +
    + ⌠pdf, portrait⌡「http://corundum/sisu_manual/en/pdf/viral_spiral.david_bollier.pdf」 +
    + ⌠odf: odt, open document text⌡「http://corundum/sisu_manual/en/odt/viral_spiral.david_bollier.odt」 +
    + ⌠xhtml scroll⌡「http://corundum/sisu_manual/en/xhtml/viral_spiral.david_bollier.xhtml」 +
    + ⌠xml, sax⌡「http://corundum/sisu_manual/en/xml/viral_spiral.david_bollier.xml」 +
    + ⌠xml, dom⌡「http://corundum/sisu_manual/en/xml/viral_spiral.david_bollier.xml」 +
    + ⌠concordance⌡「http://corundum/sisu_manual/en/html/viral_spiral.david_bollier.html」 +
    + ⌠dcc, document content certificate (digests)⌡「http://corundum/sisu_manual/en/digest/viral_spiral.david_bollier.txt」 +
    + ⌠markup source text⌡「http://corundum/sisu_manual/en/src/viral_spiral.david_bollier.sst」 +
    + ⌠markup source (zipped) pod⌡「http://corundum/sisu_manual/en/pod/viral_spiral.david_bollier.sst.zip」 +
    + +

    +

    Grouped Text

    + +

    +

    Tables

    + +


    + +

    Tables may be prepared in two either of two forms +


    +markup example: +


    +

    table{ c3; 40; 30; 30;
+This is a table
+this would become column two of row one
+column three of row one is here
+And here begins another row
+column two of row two
+column three of row two, and so on
+}table
+
    +


    +resulting output: +

    This is a table|this would become column two of row one|column +three of row one is here』And here begins another row|column two of row +two|column three of row two, and so on』 +


    + +

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

    information in each column +


    +markup example: [^18] +


    +

    !_ Table 3.1: Contributors to Wikipedia, January 2001 - June 2005
+{table~h 24; 12; 12; 12; 12; 12; 12;}
+                                |Jan. 2001|Jan. 2002|Jan. 2003|Jan. 2004|July 2004|June
+2006
+Contributors*                   |       10|      472|    2,188|    9,653|
+25,011|   48,721
+Active contributors**           |        9|      212|      846|    3,228|
+ 8,442|   16,945
+Very active contributors***     |        0|       31|      190|      692|
+ 1,639|    3,016
+No. of English language articles|       25|   16,000|  101,000|  190,000|  320,000|
+ 630,000
+No. of articles, all languages  |       25|   19,000|  138,000|  490,000|  862,000|1,600,000
+* Contributed at least ten times; ** at least 5 times in last month; ***
+more than 100 times in last month.
+
    +


    +resulting output: +


    +Table 3.1: Contributors to Wikipedia, January 2001 - June 2005 +

    |Jan. 2001|Jan. +2002|Jan. 2003|Jan. 2004|July 2004|June 2006』Contributors*|10|472|2,188|9,653|25,011|48,721』Active +contributors**|9|212|846|3,228|8,442|16,945』Very active contributors***|0|31|190|692|1,639|3,016』No. +of English language articles|25|16,000|101,000|190,000|320,000|630,000』No. of +articles, all languages|25|19,000|138,000|490,000|862,000|1,600,000』 +


    +* Contributed at least ten times; ** at least 5 times in last month; *** +more than 100 times in last month. +

    +

    Poem

    + +


    +basic markup: +


    +

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


    +markup example: +


    +

    poem{
+                    ‘Fury said to a
+                   mouse, That he
+                 met in the
+               house,
+            "Let us
+              both go to
+                law:  I will
+                  prosecute
+                    YOU.  --Come,
+                       I’ll take no
+                        denial; We
+                     must have a
+                 trial:  For
+              really this
+           morning I’ve
+          nothing
+         to do."
+           Said the
+             mouse to the
+               cur, "Such
+                 a trial,
+                   dear Sir,
+                         With
+                     no jury
+                  or judge,
+                would be
+              wasting
+             our
+              breath."
+               "I’ll be
+                 judge, I’ll
+                   be jury,"
+                         Said
+                    cunning
+                      old Fury:
+                     "I’ll
+                      try the
+                         whole
+                          cause,
+                             and
+                        condemn
+                       you
+                      to
+                       death."’
+}poem
+
    +


    +resulting output: +

    ‘Fury said to a
    + mouse, That he
    + met in the
    + house,
    + "Let us
    + both go to
    + law: I will
    + prosecute
    + YOU. --Come,
    + I’ll take no
    + denial; We
    + must have a
    + trial: For
    + really this
    + morning I’ve
    + nothing
    + to do."
    + Said the
    + mouse to the
    + cur, "Such
    + a trial,
    + dear Sir,
    + With
    + no jury
    + or judge,
    + would be
    + wasting
    + our
    + breath."
    + "I’ll be
    + judge, I’ll
    + be jury,"
    + Said
    + cunning
    + old Fury:
    + "I’ll
    + try the
    + whole
    + cause,
    + and
    + condemn
    + you
    + to
    + death."’
    + +

    +

    Group

    + +


    +basic markup: +


    +

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


    +markup example: +


    +

    group{
+                    ‘Fury said to a
+                   mouse, That he
+                 met in the
+               house,
+            "Let us
+              both go to
+                law:  I will
+                  prosecute
+                    YOU.  --Come,
+                       I’ll take no
+                        denial; We
+                     must have a
+                 trial:  For
+              really this
+           morning I’ve
+          nothing
+         to do."
+           Said the
+             mouse to the
+               cur, "Such
+                 a trial,
+                   dear Sir,
+                         With
+                     no jury
+                  or judge,
+                would be
+              wasting
+             our
+              breath."
+               "I’ll be
+                 judge, I’ll
+                   be jury,"
+                         Said
+                    cunning
+                      old Fury:
+                     "I’ll
+                      try the
+                         whole
+                          cause,
+                             and
+                        condemn
+                       you
+                      to
+                       death."’
+}group
+
    +


    +resulting output: +

    ‘Fury said to a
    + mouse, That he
    + met in the
    + house,
    + "Let us
    + both go to
    + law: I will
    + prosecute
    + YOU. --Come,
    + I’ll take no
    + denial; We
    + must have a
    + trial: For
    + really this
    + morning I’ve
    + nothing
    + to do."
    + Said the
    + mouse to the
    + cur, "Such
    + a trial,
    + dear Sir,
    + With
    + no jury
    + or judge,
    + would be
    + wasting
    + our
    + breath."
    + "I’ll be
    + judge, I’ll
    + be jury,"
    + Said
    + cunning
    + old Fury:
    + "I’ll
    + try the
    + whole
    + cause,
    + and
    + condemn
    + you
    + to
    + death."’
    + +

    +

    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 +within this document to provide examples of SiSU markup. You cannot however +use code tags to escape code tags. They are however used in the same way +as group or poem tags. +


    +A code-block is treated as an object and given a single object number. [an +option  to  number  each  line  of  code  may  be  considered  at some  later  time] + +


    +use of code tags instead of poem compared, resulting output: +


    +

                        ‘Fury said to a
+                   mouse, That he
+                 met in the
+               house,
+            "Let us
+              both go to
+                law:  I will
+                  prosecute
+                    YOU.  --Come,
+                       I’ll take no
+                        denial; We
+                     must have a
+                 trial:  For
+              really this
+           morning I’ve
+          nothing
+         to do."
+           Said the
+             mouse to the
+               cur, "Such
+                 a trial,
+                   dear Sir,
+                         With
+                     no jury
+                  or judge,
+                would be
+              wasting
+             our
+              breath."
+               "I’ll be
+                 judge, I’ll
+                   be jury,"
+                         Said
+                    cunning
+                      old Fury:
+                     "I’ll
+                      try the
+                         whole
+                          cause,
+                             and
+                        condemn
+                       you
+                      to
+                       death."’
+
    +


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


    +

    1  |                    ‘Fury said to a
+2  |                   mouse, That he
+3  |                 met in the
+4  |               house,
+5  |            "Let us
+6  |              both go to
+7  |                law:  I will
+8  |                  prosecute
+9  |                    YOU.  --Come,
+10 |                       I’ll take no
+11 |                        denial; We
+12 |                     must have a
+13 |                 trial:  For
+14 |              really this
+15 |           morning I’ve
+16 |          nothing
+17 |         to do."
+18 |           Said the
+19 |             mouse to the
+20 |               cur, "Such
+21 |                 a trial,
+22 |                   dear Sir,
+23 |                         With
+24 |                     no jury
+25 |                  or judge,
+26 |                would be
+27 |              wasting
+28 |             our
+29 |              breath."
+30 |               "I’ll be
+31 |                 judge, I’ll
+32 |                   be jury,"
+33 |                         Said
+34 |                    cunning
+35 |                      old Fury:
+36 |                     "I’ll
+37 |                      try the
+38 |                         whole
+39 |                          cause,
+40 |                             and
+41 |                        condemn
+42 |                       you
+43 |                      to
+44 |                       death."’
+
    +

    +

    Additional Breaks - Linebreaks Within Objects, Column and Page-breaks

    + +

    +

    Line-breaks

    + +

    +
    +To break a line within a "paragraph object", two backslashes \\ with a space +before and a space or newline after them may be used. +


    +

    To break a line within a "paragraph object",
+two backslashes \\ with a space before
+and a space or newline after them \\
+may be used.
+
    +


    +The html break br enclosed in angle brackets (though undocumented) is available +in versions prior to 3.0.13 and 2.9.7 (it remains available for the time being, +but is depreciated). +

    +

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


    +

    -\\-
+or
+<:pb>
+
    +


    + +

    or +


    +

    =\\=
+or
+<:pn>
+
    +

    +

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


    +

      Paragraph containing main term and sub-term.
+  ={Main term:sub-term}
+
    +


    +The index syntax starts on a new line, but there should not be an empty +line between paragraph and index markup. +


    +The structure of the resulting index would be: +


    +

      Main term, 1
+    sub-term, 1
+
    +


    +Several terms may relate to a paragraph, they are separated by a semicolon. +If the term refers to more than one paragraph, indicate the number of paragraphs. + +


    +

      Paragraph containing main term, second term and sub-term.
+  ={first term; second term: sub-term}
+
    +


    +The structure of the resulting index would be: +


    +

      First term, 1,
+  Second term, 1,
+    sub-term, 1
+
    +


    +If multiple sub-terms appear under one paragraph, they are separated under +the main term heading from each other by a pipe symbol. +


    +

      Paragraph containing main term, second term and sub-term.
+  ={Main term:sub-term+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 +one additional paragraph. The logical structure of the resulting index would +be: +


    +

      Main term, 1,
+    sub-term, 1-3,
+    second sub-term, 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 +


    +

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

    +

    Sisu Filetypes

    +
    + +


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

    +

    Sisu Insert Files (.ssi)

    + +

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

    +

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


    +<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/sisurc.yml
    + +


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


    + ~/.sisu/sisurc.yml
    + +


    + /etc/sisu/v4/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 +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 + +

    +

    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/v4/sisu_document_make
    + +


    + ~/.sisu/sisu_document_make
    + +


    + /etc/sisu/v4/sisu_document_make
    + +


    + /etc/sisu/sisu_document_make
    + +


    +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 +structures of which there are 3 alternatives. +

    +

    Document Source Directory

    + +

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

    +

    General Directories

    + +

    +
    +

    % files stored at this level e.g. sisu_manual.sst or
+% 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
+
    +

    +

    Document Output Directory Structures

    + +

    +

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

    +

    Alternative Output Structures

    + +


    +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
+output_dir_structure_by: language   #(language & filetype, preferred?)
+#output_dir_structure_by: filetype
+#output_dir_structure_by: filename  #(default, closest to original v1 &
+v2)
+
    +

    +

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


    +

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


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


    + +

    Its selection is configured in sisurc.yml +


    +output_dir_structure_by: filetype +


    +

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


    +#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 configured in sisurc.yml +


    +output_dir_structure_by: filename +


    +

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


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

    +

    Remote Directories

    + +


    +

    % 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
+ ./subject_name/_sisu
+% configuration file e.g. sisurc.yml
+ ./subject_name/_sisu/skin
+% skins in various skin directories doc, dir, site, yml
+ ./subject_name/_sisu/css
+ ./subject_name/_sisu/image
+% images for documents contained in this directory
+ ./subject_name/_sisu/mm
+
    +

    +

    Sisupod

    + +


    +

    % files stored at this level e.g. sisu_manual.sst
+ ./sisupod/_sisu
+% configuration file e.g. sisurc.yml
+ ./sisupod/_sisu/skin
+% skins in various skin directories doc, dir, site, yml
+ ./sisupod/_sisu/css
+ ./sisupod/_sisu/image
+% images for documents contained in this directory
+ ./sisupod/_sisu/mm
+
    +

    +

    Organising Content

    + +

    +

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

    +

    Markup and Output Examples

    +
    + +

    +

    Markup Examples

    + +


    +Current markup examples and document output samples are provided off <http://sisudoc.org +> +or <http://www.jus.uio.no/sisu +> 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. +

    +

    Sisu Markup Samples

    + +


    +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 +licences that do not permit inclusion in the Debian Project as they have +requirements that do not meet the 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. + +


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


    +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 +(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, +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 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 + +


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


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


    +Viral Spiral, David Bollier (2008) viral_spiral.david_bollier.sst +

    +

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

    +

    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 +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
    + .I Dublin Core.
    + ..);
    + +


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

    +

    Postgresql

    +
    + +

    +

    Name

    + +


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

    +

    Synopsis

    + +


    + 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, + +

    alternatively --sqlite or --pgsql may be used +


    +-D or --pgsql may be used interchangeably. +

    +

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

    + +
    sisu -D +--createdb
    +
    creates database where no database 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 --recreate
    +
    destroys existing database 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 --update -v [filename/wildcard]
    +
    updates file contents in database + +

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

    +
    + +

    Sqlite

    +
    + +

    +

    Name

    + +


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

    +

    Synopsis

    + +


    + 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, + +

    alternatively --sqlite or --pgsql may be used +


    +-d or --sqlite may be used interchangeably. +

    +

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

    + +
    sisu -d --createdb +
    +
    +

    creates database where no database 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 --recreate
    +
    destroys existing database 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 an sqlite database (at an object level). + +

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

    + +
    sisu -d --remove -v [filename/wildcard]
    +
    removes specified document from sqlite +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 +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] +

    +

    + +
    sisu -F --webserv-webrick
    +
    builds a cgi web + +

    search 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
+  port:             5432
+  dbi connect:      DBI:Pg:database=SiSU_sisu;port=5432
+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 +

    +
    + +

    Search +Form

    + +

    +

    + +
    sisu -F
    +
    generates a sample search form, which 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 + +

    cgi directory +

    + +
    sisu -W
    +
    starts the webrick server which should be available + +

    wherever sisu is properly installed +


    + +

    The generated search form must be copied manually to the webserver directory + +

    as instructed +

    +
    + +

    Sisu_webrick

    +
    + +

    +

    Name

    + +


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

    +

    Synopsis

    + +


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

    +

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

    +

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

    been changed in ~/.sisu/sisurc.yaml then on port 8081 +

    +

    Summary of Features

    +
    + +


    +* 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 +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 +across browsers and formats. sisu seeks to provide a common way of pinpoint +the text within a document, (which can be utilized for citation and by +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 +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. + +


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

    +

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


      +

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


      +

      3. .
    3. +

      the different heading levels +


      +

      4. .
    4. units of text, primarily paragraphs and headings, also any tables, poems, + +

      code-blocks +


      +

      5. .
    5. +

      An open standard format for e-books +


      +

      6. .
    6. Open Document Format ( +


      + +

      ODF +


      +) text +


      +

      7. .
    7. +

      Specification submitted by Adobe to ISO to become a full open ISO specification + +


      +<http://www.linux-watch.com/news/NS7542722606.html +> +


      +

      8. .
    8. +

      ISO standard ISO/IEC 26300:2006 +


      + + +

      *1.
      +
      square brackets +


      +

      + +
      *2.
      +
      square brackets +


      +

      + +
      +1.
      +
      square brackets +


      +

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


      +

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


      +

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


      +

      12. .
    12. +

      files should be prepared using +


      + +

      UTF-8 +


      + +

      character encoding +


      +

      13. .
    13. +

      a footnote or endnote +


      +

      14. .
    14. self contained endnote marker & endnote in one +


      + + +

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


      +

      + +
      **.
      +
      another unnumbered asterisk footnote/endnote +


      +

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


      +

      + +
      +2.
      +
      editors notes, numbered asterisk footnote/endnote series +


      +

      15. .
    15. <http://www.sisudoc.org/ +> +


      +

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


      +

      17. .
    17. +

      Table from the Wealth of Networks by Yochai Benkler +


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


      +

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


      +

      19. .
    19. <http://www.postgresql.org/ +> +


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


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


      +

      20. .
    20. <http://www.hwaci.com/sw/sqlite/ +> +


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


      +

      21. .
    21. <http://search.sisudoc.org +> +


      +

      22. .
    22. (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. +


      +

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


      + +

      24. +
    + +

    See Also

    + sisu(1) +,
    + sisu-epub(1) +,
    + sisu-harvest(1) +,
    + sisu-html(1) +,
    + sisu-odf(1) +,
    + sisu-pdf(1) +,
    + sisu-pg(1) +,
    + sisu-sqlite(1) +,
    + sisu-txt(1) +.
    + sisu_vim(7) +
    + +

    Homepage

    + More information about SiSU can be found at <http://www.sisudoc.org/ +> +or <http://www.jus.uio.no/sisu/ +>
    + +

    Source

    + <http://sources.sisudoc.org/ +>
    + +

    Author

    + SiSU is written by Ralph Amissah <ralph@amissah.com>
    +

    + +

    +Table of Contents

    +

    + + diff --git a/data/doc/sisu/markup-samples/README b/data/doc/sisu/markup-samples/README index ac71cc50..5e7b6944 100644 --- a/data/doc/sisu/markup-samples/README +++ b/data/doc/sisu/markup-samples/README @@ -1,5 +1,6 @@ The package sisu contains a few documents published under the GPL or that are -Debian Free Software Guideline license compatible, noteably: +Debian Free Software Guideline license compatible, in the v4 and legacy v3 +directories below, notably: Text: Free as in Freedom - Richard Stallman's Crusade for Free Software URL: @@ -152,6 +153,11 @@ remain unchanged, and sometimes that the works be used only non-commercially. License: Attribution-Noncommercial-Share Alike (CC-BY-NC-SA) 3.0 URL: Markup: little_brother.cory_doctorow.sst + Cover: cover_image_wordle_little_brother.png + URL: + Copyright: Wordle, Cory Doctorow, 2011 + License: Attribution United States (CC BY) 3.0 + URL: Illustration: little_brother_doctorow.png URL: Copyright: Richard Wilkinson diff --git a/data/doc/sisu/markup-samples/v3/samples/free_as_in_freedom.richard_stallman_crusade_for_free_software.sam_williams.sst b/data/doc/sisu/markup-samples/v3/samples/free_as_in_freedom.richard_stallman_crusade_for_free_software.sam_williams.sst index d19efafa..16de9266 100644 --- a/data/doc/sisu/markup-samples/v3/samples/free_as_in_freedom.richard_stallman_crusade_for_free_software.sam_williams.sst +++ b/data/doc/sisu/markup-samples/v3/samples/free_as_in_freedom.richard_stallman_crusade_for_free_software.sam_williams.sst @@ -14,21 +14,21 @@ :license: Published under the GNU Free Documentation License. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Document License, Version 1.1 or any later version published by the Free Software Foundation; with the Invariant Sections being no invariant sections, with the Front-Cover Texts being no invariant sections, and with the Back-Cover Texts being no invariant sections. A copy of the license is included in Appendix C, GNU Free Documentation License. All images are to be included verbatim when the document is copied, distributed, or modified under the terms of the GFDL. @classify: - :topic_register: SiSU:markup sample:book;copyright;GNU/Linux:GPL|copyleft|free software;free software;Software:Software Libré;GPL;Linux:GNU|Software Libré;book:biography;programming + :topic_register: SiSU markup sample:book:biography;book:biography;copyright;GNU/Linux:GPL|copyleft|free software;free software;Software:Software Libré;GPL;Linux:GNU|Software Libré;programming :oclc: 49044520 :isbn: 9780596002879 @links: - {Home and Source}http://faifzilla.org/ - {@ Wikipedia}http://en.wikipedia.org/wiki/Free_as_in_Freedom:_Richard_Stallman%27s_Crusade_for_Free_Software - {@ Amazon.com}http://www.amazon.com/gp/product/0596002874 - {@ Barnes & Noble}http://search.barnesandnoble.com/booksearch/isbnInquiry.asp?isbn=0596002874 - {SiSU}http://sisudoc.org/ - {sources / git}http://sources.sisudoc.org/ + { Home and Source }http://faifzilla.org/ + { @ Wikipedia }http://en.wikipedia.org/wiki/Free_as_in_Freedom:_Richard_Stallman%27s_Crusade_for_Free_Software + { @ Amazon.com }http://www.amazon.com/gp/product/0596002874 + { @ Barnes & Noble }http://search.barnesandnoble.com/booksearch/isbnInquiry.asp?isbn=0596002874 + { SiSU }http://sisudoc.org/ + { sources / git }http://sources.sisudoc.org/ @make: - :skin: skin_rms :breaks: new=:A,:B,:C,1 + :skin: skin_rms :A~ @title @author @@ -223,7 +223,7 @@ Once inside the auditorium, a visitor finds the person who has forced this tempo % extended range for Microsoft -The subject of Stallman's speech is the history and future of the free software movement. The location is significant. Less than a month before, Microsoft senior vice president Craig Mundie appeared at the nearby NYU Stern School of Business, delivering a speech blasting the General Public License, or GPL, a legal device originally conceived by Stallman 16 years before. Built to counteract the growing wave of software secrecy overtaking the computer industry-a wave first noticed by Stallman during his 1980 troubles with the Xerox laser printer-the GPL has evolved into a central tool of the free software community. In simplest terms, the GPL locks software programs into a form of communal ownership-what today's legal scholars now call the "digital commons"-through the legal weight of copyright. Once locked, programs remain unremovable. Derivative versions must carry the same copyright protection-even derivative versions that bear only a small snippet of the original source code. For this reason, some within the software industry have taken to calling the GPL a "viral" license, because it spreads itself to every software program it touches.~{ Actually, the GPL's powers are not quite that potent. According to section 10 of the GNU General Public License, Version 2 (1991), the viral nature of the license depends heavily on the Free Software Foundation's willingness to view a program as a derivative work, not to mention the existing license the GPL would replace.
    If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software that is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally.
    "To compare something to a virus is very harsh," says Stallman. "A spider plant is a more accurate comparison; it goes to another place if you actively take a cutting."
    For more information on the GNU General Public License, visit http://www.gnu.org/copyleft/gpl.html }~ +The subject of Stallman's speech is the history and future of the free software movement. The location is significant. Less than a month before, Microsoft senior vice president Craig Mundie appeared at the nearby NYU Stern School of Business, delivering a speech blasting the General Public License, or GPL, a legal device originally conceived by Stallman 16 years before. Built to counteract the growing wave of software secrecy overtaking the computer industry-a wave first noticed by Stallman during his 1980 troubles with the Xerox laser printer-the GPL has evolved into a central tool of the free software community. In simplest terms, the GPL locks software programs into a form of communal ownership-what today's legal scholars now call the "digital commons"-through the legal weight of copyright. Once locked, programs remain unremovable. Derivative versions must carry the same copyright protection-even derivative versions that bear only a small snippet of the original source code. For this reason, some within the software industry have taken to calling the GPL a "viral" license, because it spreads itself to every software program it touches.~{ Actually, the GPL's powers are not quite that potent. According to section 10 of the GNU General Public License, Version 2 (1991), the viral nature of the license depends heavily on the Free Software Foundation's willingness to view a program as a derivative work, not to mention the existing license the GPL would replace. \\ If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software that is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. \\ "To compare something to a virus is very harsh," says Stallman. "A spider plant is a more accurate comparison; it goes to another place if you actively take a cutting." \\ For more information on the GNU General Public License, visit http://www.gnu.org/copyleft/gpl.html }~ ={Mundie, Craig+2;NYU Stern School of Business;Stern School of Business (NYU)} In an information economy increasingly dependent on software and increasingly beholden to software standards, the GPL has become the proverbial "big stick." Even companies that once laughed it off as software socialism have come around to recognize the benefits. Linux, the Unix-like kernel developed by Finnish college student Linus Torvalds in 1991, is licensed under the GPL, as are many of the world's most popular programming tools: GNU Emacs, the GNU Debugger, the GNU C Compiler, etc. Together, these tools form the components of a free software operating system developed, nurtured, and owned by the worldwide hacker community. Instead of viewing this community as a threat, high-tech companies like IBM, Hewlett Packard, and Sun Microsystems have come to rely upon it, selling software applications and services built to ride atop the ever-growing free software infrastructure. @@ -235,12 +235,12 @@ They've also come to rely upon it as a strategic weapon in the hacker community' 20 years is a long time in the software industry. Consider this: in 1980, when Richard Stallman was cursing the AI Lab's Xerox laser printer, Microsoft, the company modern hackers view as the most powerful force in the worldwide software industry, was still a privately held startup. IBM, the company hackers used to regard as the most powerful force in the worldwide software industry, had yet to to introduce its first personal computer, thereby igniting the current low-cost PC market. Many of the technologies we now take for granted-the World Wide Web, satellite television, 32-bit video-game consoles-didn't even exist. The same goes for many of the companies that now fill the upper echelons of the corporate establishment, companies like AOL, Sun Microsystems, Amazon.com, Compaq, and Dell. The list goes on and on. ={Amazon.com;AOL (America OnLine);Compaq computers;Dell computers;PCs (personal computers);personal computers (PCs)} -The fact that the high-technology marketplace has come so far in such little time is fuel for both sides of the GPL debate. GPL-proponents point to the short lifespan of most computer hardware platforms. Facing the risk of buying an obsolete product, consumers tend to flock to companies with the best long-term survival. As a result, the software marketplace has become a winner-take-all arena.~{ See Shubha Ghosh, "Revealing the Microsoft Windows Source Code," Gigalaw.com (January, 2000).
    http://www.gigalaw.com/articles/ghosh-2000-01-p1.html }~ The current, privately owned software environment, GPL-proponents say, leads to monopoly abuse and stagnation. Strong companies suck all the oxygen out of the marketplace for rival competitors and innovative startups. +The fact that the high-technology marketplace has come so far in such little time is fuel for both sides of the GPL debate. GPL-proponents point to the short lifespan of most computer hardware platforms. Facing the risk of buying an obsolete product, consumers tend to flock to companies with the best long-term survival. As a result, the software marketplace has become a winner-take-all arena.~{ See Shubha Ghosh, "Revealing the Microsoft Windows Source Code," Gigalaw.com (January, 2000). \\ http://www.gigalaw.com/articles/ghosh-2000-01-p1.html }~ The current, privately owned software environment, GPL-proponents say, leads to monopoly abuse and stagnation. Strong companies suck all the oxygen out of the marketplace for rival competitors and innovative startups. -GPL-opponents argue just the opposite. Selling software is just as risky, if not more risky, than buying software, they say. Without the legal guarantees provided by private software licenses, not to mention the economic prospects of a privately owned "killer app" (i.e., a breakthrough technology that launches an entirely new market),~{ Killer apps don't have to be proprietary. Witness, of course, the legendary Mosaic browser, a program whose copyright permits noncommercial derivatives with certain restrictions. Still, I think the reader gets the point: the software marketplace is like the lottery. The bigger the potential payoff, the more people want to participate. For a good summary of the killer-app phenomenon, see Philip Ben-David, "Whatever Happened to the `Killer App'?" e-Commerce News (December 7, 2000).
    http://www.ecommercetimes.com/perl/story/5893.html }~ companies lose the incentive to participate. Once again, the market stagnates and innovation declines. As Mundie himself noted in his May 3 address on the same campus, the GPL's "viral" nature "poses a threat" to any company that relies on the uniqueness of its software as a competitive asset. Added Mundie: +GPL-opponents argue just the opposite. Selling software is just as risky, if not more risky, than buying software, they say. Without the legal guarantees provided by private software licenses, not to mention the economic prospects of a privately owned "killer app" (i.e., a breakthrough technology that launches an entirely new market),~{ Killer apps don't have to be proprietary. Witness, of course, the legendary Mosaic browser, a program whose copyright permits noncommercial derivatives with certain restrictions. Still, I think the reader gets the point: the software marketplace is like the lottery. The bigger the potential payoff, the more people want to participate. For a good summary of the killer-app phenomenon, see Philip Ben-David, "Whatever Happened to the `Killer App'?" e-Commerce News (December 7, 2000). \\ http://www.ecommercetimes.com/perl/story/5893.html }~ companies lose the incentive to participate. Once again, the market stagnates and innovation declines. As Mundie himself noted in his May 3 address on the same campus, the GPL's "viral" nature "poses a threat" to any company that relies on the uniqueness of its software as a competitive asset. Added Mundie: ={Mundie, Craig+2} -_1 It also fundamentally undermines the independent commercial software sector because it effectively makes it impossible to distribute software on a basis where recipients pay for the product rather than just the cost of distribution.~{ See Craig Mundie, "The Commercial Software Model," senior vice president, Microsoft Corp. Excerpted from an online transcript of Mundie's May 3, 2001, speech to the New York University Stern School of Business.
    http://www.microsoft.com/presspass/exec/craig/05-03sharedsource.asp }~ +_1 It also fundamentally undermines the independent commercial software sector because it effectively makes it impossible to distribute software on a basis where recipients pay for the product rather than just the cost of distribution.~{ See Craig Mundie, "The Commercial Software Model," senior vice president, Microsoft Corp. Excerpted from an online transcript of Mundie's May 3, 2001, speech to the New York University Stern School of Business. \\ http://www.microsoft.com/presspass/exec/craig/05-03sharedsource.asp }~ The mutual success of GNU/Linux, the amalgamated operating system built around the GPL-protected Linux kernel, and Windows over the last 10 years reveals the wisdom of both perspectives. Nevertheless, the battle for momentum is an important one in the software industry. Even powerful vendors such as Microsoft rely on the support of third-party software developers whose tools, programs, and computer games make an underlying software platform such as Windows more attractive to the mainstream consumer. Citing the rapid evolution of the technology marketplace over the last 20 years, not to mention his own company's admirable track record during that period, Mundie advised listeners to not get too carried away by the free software movement's recent momentum: ={GNU Project:Linux and, mutual success of;Linux:GNU Project and;third-party software developers supporting Microsoft} @@ -299,7 +299,7 @@ Richard Matthew Stallman's rise from frustrated academic to political leader ove Most importantly, it speaks to the changing nature of political power in a world increasingly beholden to computer technology and the software programs that power that technology. -Maybe that's why, even at a time when most high-technology stars are on the wane, Stallman's star has grown. Since launching the GNU Project in 1984,~{ The acronym GNU stands for "GNU's not Unix." In another portion of the May 29, 2001, NYU speech, Stallman summed up the acronym's origin:
    _1 We hackers always look for a funny or naughty name for a program, because naming a program is half the fun of writing the program. We also had a tradition of recursive acronyms, to say that the program that you're writing is similar to some existing program . . . I looked for a recursive acronym for Something Is Not UNIX. And I tried all 26 letters and discovered that none of them was a word. I decided to make it a contraction. That way I could have a three-letter acronym, for Something's Not UNIX. And I tried letters, and I came across the word "GNU." That was it.
    _1 Although a fan of puns, Stallman recommends that software users pronounce the "g" at the beginning of the acronym (i.e., "gah-new"). Not only does this avoid confusion with the word "gnu," the name of the African antelope, Connochaetes gnou, it also avoids confusion with the adjective "new." "We've been working on it for 17 years now, so it is not exactly new any more," Stallman says.
    Source: author notes and online transcript of "Free Software: Freedom and Cooperation," Richard Stallman's May 29, 2001, speech at New York University.
    http://www.gnu.org/events/rms-nyu-2001-transcript.txt }~ Stallman has been at turns ignored, satirized, vilified, and attacked-both from within and without the free software movement. Through it all, the GNU Project has managed to meet its milestones, albeit with a few notorious delays, and stay relevant in a software marketplace several orders of magnitude more complex than the one it entered 18 years ago. So too has the free software ideology, an ideology meticulously groomed by Stallman himself. +Maybe that's why, even at a time when most high-technology stars are on the wane, Stallman's star has grown. Since launching the GNU Project in 1984,~{ The acronym GNU stands for "GNU's not Unix." In another portion of the May 29, 2001, NYU speech, Stallman summed up the acronym's origin: \\ _1 We hackers always look for a funny or naughty name for a program, because naming a program is half the fun of writing the program. We also had a tradition of recursive acronyms, to say that the program that you're writing is similar to some existing program . . . I looked for a recursive acronym for Something Is Not UNIX. And I tried all 26 letters and discovered that none of them was a word. I decided to make it a contraction. That way I could have a three-letter acronym, for Something's Not UNIX. And I tried letters, and I came across the word "GNU." That was it. \\ _1 Although a fan of puns, Stallman recommends that software users pronounce the "g" at the beginning of the acronym (i.e., "gah-new"). Not only does this avoid confusion with the word "gnu," the name of the African antelope, Connochaetes gnou, it also avoids confusion with the adjective "new." "We've been working on it for 17 years now, so it is not exactly new any more," Stallman says. \\ Source: author notes and online transcript of "Free Software: Freedom and Cooperation," Richard Stallman's May 29, 2001, speech at New York University. \\ http://www.gnu.org/events/rms-nyu-2001-transcript.txt }~ Stallman has been at turns ignored, satirized, vilified, and attacked-both from within and without the free software movement. Through it all, the GNU Project has managed to meet its milestones, albeit with a few notorious delays, and stay relevant in a software marketplace several orders of magnitude more complex than the one it entered 18 years ago. So too has the free software ideology, an ideology meticulously groomed by Stallman himself. To understand the reasons behind this currency, it helps to examine Richard Stallman both in his own words and in the words of the people who have collaborated and battled with him along the way. The Richard Stallman character sketch is not a complicated one. If any person exemplifies the old adage "what you see is what you get," it's Stallman. @@ -339,7 +339,7 @@ Thirty years after the fact, Lippman punctuates the memory with a laugh. "To tel Seated at the dining-room table of her second Manhattan apartment-the same spacious three-bedroom complex she and her son moved to following her 1967 marriage to Maurice Lippman, now deceased-Alice Lippman exudes a Jewish mother's mixture of pride and bemusement when recalling her son's early years. The nearby dining-room credenza offers an eight-by-ten photo of Stallman glowering in full beard and doctoral robes. The image dwarfs accompanying photos of Lippman's nieces and nephews, but before a visitor can make too much of it, Lippman makes sure to balance its prominent placement with an ironic wisecrack. ={Lippman, Maurice} -"Richard insisted I have it after he received his honorary doctorate at the University of Glasgow," says Lippman. "He said to me, `Guess what, mom? It's the first graduation I ever attended.'"~{ See Michael Gross, "Richard Stallman: High School Misfit, Symbol of Free Software, MacArthur-certified Genius" (1999). This interview is one of the most candid Stallman interviews on the record. I recommend it highly.
    http://www.mgross.com/interviews/stallman1.html }~ +"Richard insisted I have it after he received his honorary doctorate at the University of Glasgow," says Lippman. "He said to me, `Guess what, mom? It's the first graduation I ever attended.'"~{ See Michael Gross, "Richard Stallman: High School Misfit, Symbol of Free Software, MacArthur-certified Genius" (1999). This interview is one of the most candid Stallman interviews on the record. I recommend it highly. \\ http://www.mgross.com/interviews/stallman1.html }~ ={University of Glasgow} Such comments reflect the sense of humor that comes with raising a child prodigy. Make no mistake, for every story Lippman hears and reads about her son's stubbornness and unusual behavior, she can deliver at least a dozen in return. @@ -382,10 +382,10 @@ Seth Breidbart, a fellow Columbia Science Honors Program alumnus, offers bolster "It's hard to describe," Breidbart says. "It wasn't like he was unapproachable. He was just very intense. [He was] very knowledgeable but also very hardheaded in some ways." -Such descriptions give rise to speculation: are judgment-laden adjectives like "intense" and "hardheaded" simply a way to describe traits that today might be categorized under juvenile behavioral disorder? A December, 2001, /{Wired}/ magazine article titled "The Geek Syndrome" paints the portrait of several scientifically gifted children diagnosed with high-functioning autism or Asperger Syndrome. In many ways, the parental recollections recorded in the Wired article are eerily similar to the ones offered by Lippman. Even Stallman has indulged in psychiatric revisionism from time to time. During a 2000 profile for the /{Toronto Star}/, Stallman described himself to an interviewer as "borderline autistic,"~{ See Judy Steed, /{Toronto Star}/, BUSINESS, (October 9, 2000): C03.
    His vision of free software and social cooperation stands in stark contrast to the isolated nature of his private life. A Glenn Gould-like eccentric, the Canadian pianist was similarly brilliant, articulate, and lonely. Stallman considers himself afflicted, to some degree, by autism: a condition that, he says, makes it difficult for him to interact with people. }~ a description that goes a long way toward explaining a lifelong tendency toward social and emotional isolation and the equally lifelong effort to overcome it. +Such descriptions give rise to speculation: are judgment-laden adjectives like "intense" and "hardheaded" simply a way to describe traits that today might be categorized under juvenile behavioral disorder? A December, 2001, /{Wired}/ magazine article titled "The Geek Syndrome" paints the portrait of several scientifically gifted children diagnosed with high-functioning autism or Asperger Syndrome. In many ways, the parental recollections recorded in the Wired article are eerily similar to the ones offered by Lippman. Even Stallman has indulged in psychiatric revisionism from time to time. During a 2000 profile for the /{Toronto Star}/, Stallman described himself to an interviewer as "borderline autistic,"~{ See Judy Steed, /{Toronto Star}/, BUSINESS, (October 9, 2000): C03. \\ His vision of free software and social cooperation stands in stark contrast to the isolated nature of his private life. A Glenn Gould-like eccentric, the Canadian pianist was similarly brilliant, articulate, and lonely. Stallman considers himself afflicted, to some degree, by autism: a condition that, he says, makes it difficult for him to interact with people. }~ a description that goes a long way toward explaining a lifelong tendency toward social and emotional isolation and the equally lifelong effort to overcome it. ={Asperger Syndrome+1;autism+5;Geek Syndrome, The (Silberman)+1;Wired magazine;Toronto Star;Silberman, Steve+1;Stallman, Richard M.:behavioral disorders+1} -Such speculation benefits from the fast and loose nature of most so-called "behavioral disorders" nowadays, of course. As Steve Silberman, author of "The Geek Syndrome," notes, American psychiatrists have only recently come to accept Asperger Syndrome as a valid umbrella term covering a wide set of behavioral traits. The traits range from poor motor skills and poor socialization to high intelligence and an almost obsessive affinity for numbers, computers, and ordered systems.~{ See Steve Silberman, "The Geek Syndrome," Wired (December, 2001).
    http://www.wired.com/wired/archive/9.12/aspergers_pr.html }~ Reflecting on the broad nature of this umbrella, Stallman says its possible that, if born 40 years later, he might have merited just such a diagnosis. Then again, so would many of his computer-world colleagues. +Such speculation benefits from the fast and loose nature of most so-called "behavioral disorders" nowadays, of course. As Steve Silberman, author of "The Geek Syndrome," notes, American psychiatrists have only recently come to accept Asperger Syndrome as a valid umbrella term covering a wide set of behavioral traits. The traits range from poor motor skills and poor socialization to high intelligence and an almost obsessive affinity for numbers, computers, and ordered systems.~{ See Steve Silberman, "The Geek Syndrome," Wired (December, 2001). \\ http://www.wired.com/wired/archive/9.12/aspergers_pr.html }~ Reflecting on the broad nature of this umbrella, Stallman says its possible that, if born 40 years later, he might have merited just such a diagnosis. Then again, so would many of his computer-world colleagues. ={Stallman, Richard M.:childhood, behavioral disorders} "It's possible I could have had something like that," he says. "On the other hand, one of the aspects of that syndrome is difficulty following rhythms. I can dance. In fact, I love following the most complicated rhythms. It's not clear cut enough to know." @@ -589,7 +589,7 @@ Looking back, Stallman sees nothing unusual in the AI Lab's willingness to accep To get a taste of "bureaucratic and stuffy," Stallman need only visit the computer labs at Harvard. There, access to the terminals was doled out according to academic rank. As an undergrad, Stallman usually had to sign up or wait until midnight, about the time most professors and grad students finished their daily work assignments. The waiting wasn't difficult, but it was frustrating. Waiting for a public terminal, knowing all the while that a half dozen equally usable machines were sitting idle inside professors' locked offices, seemed the height of illogic. Although Stallman paid the occasional visit to the Harvard computer labs, he preferred the more egalitarian policies of the AI Lab. "It was a breath of fresh air," he says. "At the AI Lab, people seemed more concerned about work than status." ={Harvard University:computer labs} -Stallman quickly learned that the AI Lab's first-come, first-served policy owed much to the efforts of a vigilant few. Many were holdovers from the days of Project MAC, the Department of Defense-funded research program that had given birth to the first time-share operating systems. A few were already legends in the computing world. There was Richard Greenblatt, the lab's in-house Lisp expert and author of MacHack, the computer chess program that had once humbled A.I. critic Hubert Dreyfus. There was Gerald Sussman, original author of the robotic block-stacking program HACKER. And there was Bill Gosper, the in-house math whiz already in the midst of an 18-month hacking bender triggered by the philosophical implications of the computer game LIFE.~{ See Steven Levy, Hackers (Penguin USA [paperback], 1984): 144.
    Levy devotes about five pages to describing Gosper's fascination with LIFE, a math-based software game first created by British mathematician John Conway. I heartily recommend this book as a supplement, perhaps even a prerequisite, to this one. }~ +Stallman quickly learned that the AI Lab's first-come, first-served policy owed much to the efforts of a vigilant few. Many were holdovers from the days of Project MAC, the Department of Defense-funded research program that had given birth to the first time-share operating systems. A few were already legends in the computing world. There was Richard Greenblatt, the lab's in-house Lisp expert and author of MacHack, the computer chess program that had once humbled A.I. critic Hubert Dreyfus. There was Gerald Sussman, original author of the robotic block-stacking program HACKER. And there was Bill Gosper, the in-house math whiz already in the midst of an 18-month hacking bender triggered by the philosophical implications of the computer game LIFE.~{ See Steven Levy, Hackers (Penguin USA [paperback], 1984): 144. \\ Levy devotes about five pages to describing Gosper's fascination with LIFE, a math-based software game first created by British mathematician John Conway. I heartily recommend this book as a supplement, perhaps even a prerequisite, to this one. }~ ={Dreyfus, Hubert;Gosper, Bill;Greenblat, Richard;LIFE mathematical game;LISP programming language;MacHack;Project MAC;Sussman, Gerald+2} Members of the tight-knit group called themselves "hackers." Over time, they extended the "hacker" description to Stallman as well. In the process of doing so, they inculcated Stallman in the ethical traditions of the "hacker ethic ." To be a hacker meant more than just writing programs, Stallman learned. It meant writing the best possible programs. It meant sitting at a terminal for 36 hours straight if that's what it took to write the best possible programs. Most importantly, it meant having access to the best possible machines and the most useful information at all times. Hackers spoke openly about changing the world through software, and Stallman learned the instinctual hacker disdain for any obstacle that prevented a hacker from fulfilling this noble cause. Chief among these obstacles were poor software, academic bureaucracy, and selfish behavior. @@ -615,7 +615,7 @@ Using this feature, Stallman was able to watch how programs written by hackers p By the end of 1970, hacking at the AI Lab had become a regular part of Stallman's weekly schedule. From Monday to Thursday, Stallman devoted his waking hours to his Harvard classes. As soon as Friday afternoon arrived, however, he was on the T, heading down to MIT for the weekend. Stallman usually timed his arrival to coincide with the ritual food run. Joining five or six other hackers in their nightly quest for Chinese food, he would jump inside a beat-up car and head across the Harvard Bridge into nearby Boston. For the next two hours, he and his hacker colleagues would discuss everything from ITS to the internal logic of the Chinese language and pictograph system. Following dinner, the group would return to MIT and hack code until dawn. -For the geeky outcast who rarely associated with his high-school peers, it was a heady experience, suddenly hanging out with people who shared the same predilection for computers, science fiction, and Chinese food. "I remember many sunrises seen from a car coming back from Chinatown," Stallman would recall nostalgically, 15 years after the fact in a speech at the Swedish Royal Technical Institute. "It was actually a very beautiful thing to see a sunrise, 'cause that's such a calm time of day. It's a wonderful time of day to get ready to go to bed. It's so nice to walk home with the light just brightening and the birds starting to chirp; you can get a real feeling of gentle satisfaction, of tranquility about the work that you have done that night."~{ See Richard Stallman, "RMS lecture at KTH (Sweden)," (October 30, 1986).
    http://www.gnu.org/philosophy/stallman-kth.html }~ +For the geeky outcast who rarely associated with his high-school peers, it was a heady experience, suddenly hanging out with people who shared the same predilection for computers, science fiction, and Chinese food. "I remember many sunrises seen from a car coming back from Chinatown," Stallman would recall nostalgically, 15 years after the fact in a speech at the Swedish Royal Technical Institute. "It was actually a very beautiful thing to see a sunrise, 'cause that's such a calm time of day. It's a wonderful time of day to get ready to go to bed. It's so nice to walk home with the light just brightening and the birds starting to chirp; you can get a real feeling of gentle satisfaction, of tranquility about the work that you have done that night."~{ See Richard Stallman, "RMS lecture at KTH (Sweden)," (October 30, 1986). \\ http://www.gnu.org/philosophy/stallman-kth.html }~ ={Swedish Royal Technical Institute} The more Stallman hung out with the hackers, the more he adopted the hacker worldview. Already committed to the notion of personal liberty, Stallman began to infuse his actions with a sense of communal responsibility. When others violated the communal code, Stallman was quick to speak out. Within a year of his first visit, Stallman was the one breaking into locked offices, trying to recover the sequestered terminals that belonged to the lab community as a whole. In true hacker fashion, Stallman also sought to make his own personal contribution to the art of lock hacking. One of the most artful door-opening tricks, commonly attributed to Greenblatt, involved bending a stiff wire into a cane and attaching a loop of tape to the long end. Sliding the wire under the door, a hacker could twist and rotate the wire so that the long end touched the door knob. Provided the adhesive on the tape held, a hacker could open the doorknob with a few sharp twists. @@ -685,7 +685,7 @@ Ask anyone who's spent more than a minute in Richard Stallman's presence, and yo To call the Stallman gaze intense is an understatement. Stallman's eyes don't just look at you; they look through you. Even when your own eyes momentarily shift away out of simple primate politeness, Stallman's eyes remain locked-in, sizzling away at the side of your head like twin photon beams. -Maybe that's why most writers, when describing Stallman, tend to go for the religious angle. In a 1998 Salon.com article titled "The Saint of Free Software," Andrew Leonard describes Stallman's green eyes as "radiating the power of an Old Testament prophet."~{ See Andrew Leonard, "The Saint of Free Software," Salon.com (August 1998).
    http://www.salon.com/21st/feature/1998/08/cov_31feature.html }~ A 1999 /{Wired}/ magazine article describes the Stallman beard as "Rasputin-like,"~{ See Leander Kahney, "Linux's Forgotten Man," Wired News (March 5, 1999).
    http://www.wired.com/news/print/0,1294,18291,00.html }~ while a /{London Guardian}/ profile describes the Stallman smile as the smile of "a disciple seeing Jesus."~{ See "Programmer on moral high ground; Free software is a moral issue for Richard Stallman believes in freedom and free software." London Guardian (November 6, 1999).
    These are just a small sampling of the religious comparisons. To date, the most extreme comparison has to go to Linus Torvalds, who, in his autobiography-see Linus Torvalds and David Diamond, Just For Fun: The Story of an Accidentaly Revolutionary (HarperCollins Publishers, Inc., 2001): 58-writes "Richard Stallman is the God of Free Software."
    Honorable mention goes to Larry Lessig, who, in a footnote description of Stallman in his book-see Larry Lessig, The Future of Ideas (Random House, 2001): 270-likens Stallman to Moses:
    _1 ... as with Moses, it was another leader, Linus Torvalds, who finally carried the movement into the promised land by facilitating the development of the final part of the OS puzzle. Like Moses, too, Stallman is both respected and reviled by allies within the movement. He is [an] unforgiving, and hence for many inspiring, leader of a critically important aspect of modern culture. I have deep respect for the principle and commitment of this extraordinary individual, though I also have great respect for those who are courageous enough to question his thinking and then sustain his wrath.
    In a final interview with Stallman, I asked him his thoughts about the religious comparisons. "Some people do compare me with an Old Testament prophent, and the reason is Old Testament prophets said certain social practices were wrong. They wouldn't compromise on moral issues. They couldn't be bought off, and they were usually treated with contempt." }~ +Maybe that's why most writers, when describing Stallman, tend to go for the religious angle. In a 1998 Salon.com article titled "The Saint of Free Software," Andrew Leonard describes Stallman's green eyes as "radiating the power of an Old Testament prophet."~{ See Andrew Leonard, "The Saint of Free Software," Salon.com (August 1998). \\ http://www.salon.com/21st/feature/1998/08/cov_31feature.html }~ A 1999 /{Wired}/ magazine article describes the Stallman beard as "Rasputin-like,"~{ See Leander Kahney, "Linux's Forgotten Man," Wired News (March 5, 1999). \\ http://www.wired.com/news/print/0,1294,18291,00.html }~ while a /{London Guardian}/ profile describes the Stallman smile as the smile of "a disciple seeing Jesus."~{ See "Programmer on moral high ground; Free software is a moral issue for Richard Stallman believes in freedom and free software." London Guardian (November 6, 1999). \\ These are just a small sampling of the religious comparisons. To date, the most extreme comparison has to go to Linus Torvalds, who, in his autobiography-see Linus Torvalds and David Diamond, Just For Fun: The Story of an Accidentaly Revolutionary (HarperCollins Publishers, Inc., 2001): 58-writes "Richard Stallman is the God of Free Software." \\ Honorable mention goes to Larry Lessig, who, in a footnote description of Stallman in his book-see Larry Lessig, The Future of Ideas (Random House, 2001): 270-likens Stallman to Moses: \\ _1 ... as with Moses, it was another leader, Linus Torvalds, who finally carried the movement into the promised land by facilitating the development of the final part of the OS puzzle. Like Moses, too, Stallman is both respected and reviled by allies within the movement. He is [an] unforgiving, and hence for many inspiring, leader of a critically important aspect of modern culture. I have deep respect for the principle and commitment of this extraordinary individual, though I also have great respect for those who are courageous enough to question his thinking and then sustain his wrath. \\ In a final interview with Stallman, I asked him his thoughts about the religious comparisons. "Some people do compare me with an Old Testament prophent, and the reason is Old Testament prophets said certain social practices were wrong. They wouldn't compromise on moral issues. They couldn't be bought off, and they were usually treated with contempt." }~ ={Wired magazine;Leonard, Andrew;London Guardian;Salon.com} Such analogies serve a purpose, but they ultimately fall short. That's because they fail to take into account the vulnerable side of the Stallman persona. Watch the Stallman gaze for an extended period of time, and you will begin to notice a subtle change. What appears at first to be an attempt to intimidate or hypnotize reveals itself upon second and third viewing as a frustrated attempt to build and maintain contact. If, as Stallman himself has suspected from time to time, his personality is the product of autism or Asperger Syndrome, his eyes certainly confirm the diagnosis. Even at their most high-beam level of intensity, they have a tendency to grow cloudy and distant, like the eyes of a wounded animal preparing to give up the ghost. @@ -747,7 +747,7 @@ Stallman's body bears witness to the tragedy. Lack of exercise has left Stallman The walk is further slowed by Stallman's willingness to stop and smell the roses, literally. Spotting a particularly beautiful blossom, he tickles the innermost petals with his prodigious nose, takes a deep sniff and steps back with a contented sigh. -"Mmm, rhinophytophilia,"~{ At the time, I thought Stallman was referring to the flower's scientific name. Months later, I would learn that rhinophytophilia was in fact a humorous reference to the activity, i.e., Stallman sticking his nose into a flower and enjoying the moment. For another humorous Stallman flower incident, visit:
    http://www.stallman.org/texas.html }~ he says, rubbing his back. +"Mmm, rhinophytophilia,"~{ At the time, I thought Stallman was referring to the flower's scientific name. Months later, I would learn that rhinophytophilia was in fact a humorous reference to the activity, i.e., Stallman sticking his nose into a flower and enjoying the moment. For another humorous Stallman flower incident, visit: \\ http://www.stallman.org/texas.html }~ he says, rubbing his back. The drive to the restaurant takes less than three minutes. Upon recommendation from Tim Ney, former executive director of the Free Software Foundation, I have let Stallman choose the restaurant. While some reporters zero in on Stallman's monk-like lifestyle, the truth is, Stallman is a committed epicure when it comes to food. One of the fringe benefits of being a traveling missionary for the free software cause is the ability to sample delicious food from around the world. "Visit almost any major city in the world, and chances are Richard knows the best restaurant in town," says Ney. "Richard also takes great pride in knowing what's on the menu and ordering for the entire table." ={Ney, Tim} @@ -772,7 +772,7 @@ The conversation shifts to Napster, the San Mateo, California software company, Although based on proprietary software, the Napster system draws inspiration from the long-held Stallman contention that once a work enters the digital realm-in other words, once making a copy is less a matter of duplicating sounds or duplicating atoms and more a matter of duplicating information-the natural human impulse to share a work becomes harder to restrict. Rather than impose additional restrictions, Napster execs have decided to take advantage of the impulse. Giving music listeners a central place to trade music files, the company has gambled on its ability to steer the resulting user traffic toward other commercial opportunities. -The sudden success of the Napster model has put the fear in traditional record companies, with good reason. Just days before my Palo Alto meeting with Stallman, U.S. District Court Judge Marilyn Patel granted a request filed by the Recording Industry Association of America for an injunction against the file-sharing service. The injunction was subsequently suspended by the U.S. Ninth District Court of Appeals, but by early 2001, the Court of Appeals, too, would find the San Mateo-based company in breach of copyright law,~{ See Cecily Barnes and Scott Ard, "Court Grants Stay of Napster Injunction," News.com (July 28, 2000).
    http://news.cnet.com/news/0-1005-200-2376465.html }~ a decision RIAA spokesperson Hillary Rosen would later proclaim proclaim a "clear victory for the creative content community and the legitimate online marketplace."~{ See "A Clear Victory for Recording Industry in Napster Case," RIAA press release (February 12, 2001).
    http://www.riaa.com/PR_story.cfm?id=372 }~ +The sudden success of the Napster model has put the fear in traditional record companies, with good reason. Just days before my Palo Alto meeting with Stallman, U.S. District Court Judge Marilyn Patel granted a request filed by the Recording Industry Association of America for an injunction against the file-sharing service. The injunction was subsequently suspended by the U.S. Ninth District Court of Appeals, but by early 2001, the Court of Appeals, too, would find the San Mateo-based company in breach of copyright law,~{ See Cecily Barnes and Scott Ard, "Court Grants Stay of Napster Injunction," News.com (July 28, 2000). \\ http://news.cnet.com/news/0-1005-200-2376465.html }~ a decision RIAA spokesperson Hillary Rosen would later proclaim proclaim a "clear victory for the creative content community and the legitimate online marketplace."~{ See "A Clear Victory for Recording Industry in Napster Case," RIAA press release (February 12, 2001). \\ http://www.riaa.com/PR_story.cfm?id=372 }~ For hackers such as Stallman, the Napster business model is scary in different ways. The company's eagerness to appropriate time-worn hacker principles such as file sharing and communal information ownership, while at the same time selling a service based on proprietary software, sends a distressing mixed message. As a person who already has a hard enough time getting his own carefully articulated message into the media stream, Stallman is understandably reticent when it comes to speaking out about the company. Still, Stallman does admit to learning a thing or two from the social side of the Napster phenomenon. @@ -795,7 +795,7 @@ I turn to look, catching a glimpse of a woman's back. The woman is young, somewh "Oh, no," he says. "They're gone. And to think, I'll probably never even get to see her again." -After a brief sigh, Stallman recovers. The moment gives me a chance to discuss Stallman's reputation vis-ý-vis the fairer sex. The reputation is a bit contradictory at times. A number of hackers report Stallman's predilection for greeting females with a kiss on the back of the hand.~{ See Mae Ling Mak, "Mae Ling's Story" (December 17, 1998).
    http://www.crackmonkey.org/pipermail/crackmonkey/1998q4/003006.htm
    So far, Mak is the only person I've found willing to speak on the record in regard to this practice, although I've heard this from a few other female sources. Mak, despite expressing initial revulsion at it, later managed to put aside her misgivings and dance with Stallman at a 1999 LinuxWorld show.
    http://www.linux.com/interact/potd.phtml?potd_id=44 }~ A May 26, 2000 Salon.com article, meanwhile, portrays Stallman as a bit of a hacker lothario. Documenting the free software-free love connection, reporter Annalee Newitz presents Stallman as rejecting traditional family values, telling her, "I believe in love, but not monogamy."~{ See Annalee Newitz, "If Code is Free Why Not Me?" Salon.com (May 26, 2000).
    http://www.salon.com/tech/feature/2000/05/26/free_love/print.html }~ +After a brief sigh, Stallman recovers. The moment gives me a chance to discuss Stallman's reputation vis-ý-vis the fairer sex. The reputation is a bit contradictory at times. A number of hackers report Stallman's predilection for greeting females with a kiss on the back of the hand.~{ See Mae Ling Mak, "Mae Ling's Story" (December 17, 1998). \\ http://www.crackmonkey.org/pipermail/crackmonkey/1998q4/003006.htm \\ So far, Mak is the only person I've found willing to speak on the record in regard to this practice, although I've heard this from a few other female sources. Mak, despite expressing initial revulsion at it, later managed to put aside her misgivings and dance with Stallman at a 1999 LinuxWorld show. \\ http://www.linux.com/interact/potd.phtml?potd_id=44 }~ A May 26, 2000 Salon.com article, meanwhile, portrays Stallman as a bit of a hacker lothario. Documenting the free software-free love connection, reporter Annalee Newitz presents Stallman as rejecting traditional family values, telling her, "I believe in love, but not monogamy."~{ See Annalee Newitz, "If Code is Free Why Not Me?" Salon.com (May 26, 2000). \\ http://www.salon.com/tech/feature/2000/05/26/free_love/print.html }~ ={Newitz, Annalee;Salon.com} Stallman lets his menu drop a little when I bring this up. "Well, most men seem to want sex and seem to have a rather contemptuous attitude towards women," he says. "Even women they're involved with. I can't understand it at all." @@ -839,7 +839,7 @@ Stallman asks me if I would be interested in hearing the folk filk. As soon as I _1 How much wood could a woodchuck chuck,If a woodchuck could chuck wood? How many poles could a polak lock,If a polak could lock poles? How many knees could a negro grow, If a negro could grow knees? The answer, my dear, is stick it in your ear.The answer is to stick it in your ear. -The singing ends, and Stallman's lips curl into another child-like half smile. I glance around at the nearby tables. The Asian families enjoying their Sunday lunch pay little attention to the bearded alto in their midst.~{ For more Stallman filks, visit
    http://www.stallman.org/doggerel.html. To hear Stallman singing "The Free Software Song," visit
    http://www.gnu.org/music/free-software-song.html. }~ After a few moments of hesitation, I finally smile too. +The singing ends, and Stallman's lips curl into another child-like half smile. I glance around at the nearby tables. The Asian families enjoying their Sunday lunch pay little attention to the bearded alto in their midst.~{ For more Stallman filks, visit \\ http://www.stallman.org/doggerel.html. To hear Stallman singing "The Free Software Song," visit \\ http://www.gnu.org/music/free-software-song.html. }~ After a few moments of hesitation, I finally smile too. "Do you want that last cornball?" Stallman asks, eyes twinkling. Before I can screw up the punch line, Stallman grabs the corn-encrusted dumpling with his two chopsticks and lifts it proudly. "Maybe I'm the one who should get the cornball," he says. @@ -903,7 +903,7 @@ The waiter, uncomprehending or fooled by the look of the bill, smiles and scurri The AI Lab of the 1970s was by all accounts a special place. Cutting-edge projects and top-flight researchers gave it an esteemed position in the world of computer science. The internal hacker culture and its anarchic policies lent a rebellious mystique as well. Only later, when many of the lab's scientists and software superstars had departed, would hackers fully realize the unique and ephemeral world they had once inhabited. ={AI Lab (Artificial Intelligence Laboratory)+17} -"It was a bit like the Garden of Eden," says Stallman, summing up the lab and its software-sharing ethos in a 1998 Forbes article. "It hadn't occurred to us not to cooperate."~{ See Josh McHugh, "For the Love of Hacking," Forbes (August 10, 1998).
    http://www.forbes.com/forbes/1998/0810/6203094a.html }~ +"It was a bit like the Garden of Eden," says Stallman, summing up the lab and its software-sharing ethos in a 1998 Forbes article. "It hadn't occurred to us not to cooperate."~{ See Josh McHugh, "For the Love of Hacking," Forbes (August 10, 1998). \\ http://www.forbes.com/forbes/1998/0810/6203094a.html }~ Such mythological descriptions, while extreme, underline an important fact. The ninth floor of 545 Tech Square was more than a workplace for many. For hackers such as Stallman, it was home. @@ -960,13 +960,13 @@ During the late 1960s, interface design made additional leaps. In a famous 1968 Such innovations would take another two decades to make their way into the commercial marketplace. Still, by the 1970s, video screens had started to replace teletypes as display terminals, creating the potential for full-screen-as opposed to line-by-line-editing capabilities. ={display terminals, replacing teletypes;video screens} -One of the first programs to take advantage of this full-screen capability was the MIT AI Lab's TECO. Short for Text Editor and COrrector, the program had been upgraded by hackers from an old teletype line editor for the lab's PDP-6 machine.~{ According to the Jargon File, TECO's name originally stood for Tape Editor and Corrector.
    http://www.tuxedo.org/~esr/jargon/html/entry/TECO.html }~ +One of the first programs to take advantage of this full-screen capability was the MIT AI Lab's TECO. Short for Text Editor and COrrector, the program had been upgraded by hackers from an old teletype line editor for the lab's PDP-6 machine.~{ According to the Jargon File, TECO's name originally stood for Tape Editor and Corrector. \\ http://www.tuxedo.org/~esr/jargon/html/entry/TECO.html }~ -TECO was a substantial improvement over old editors, but it still had its drawbacks. To create and edit a document, a programmer had to enter a series of software commands specifying each edit. It was an abstract process. Unlike modern word processors, which update text with each keystroke, TECO demanded that the user enter an extended series of editing instructions followed by an "end of command" sequence just to change the text.Over time, a hacker grew proficient enough to write entire documents in edit mode, but as Stallman himself would later point out, the process required "a mental skill like that of blindfold chess."~{ See Richard Stallman, "EMACS: The Extensible, Customizable, Display Editor," AI Lab Memo (1979). An updated HTML version of this memo, from which I am quoting, is available at
    http://www.gnu.org/software/emacs/emacs-paper.html }~ +TECO was a substantial improvement over old editors, but it still had its drawbacks. To create and edit a document, a programmer had to enter a series of software commands specifying each edit. It was an abstract process. Unlike modern word processors, which update text with each keystroke, TECO demanded that the user enter an extended series of editing instructions followed by an "end of command" sequence just to change the text.Over time, a hacker grew proficient enough to write entire documents in edit mode, but as Stallman himself would later point out, the process required "a mental skill like that of blindfold chess."~{ See Richard Stallman, "EMACS: The Extensible, Customizable, Display Editor," AI Lab Memo (1979). An updated HTML version of this memo, from which I am quoting, is available at \\ http://www.gnu.org/software/emacs/emacs-paper.html }~ To facilitate the process, AI Lab hackers had built a system that displayed both the "source" and "display" modes on a split screen. Despite this innovative hack, switching from mode to mode was still a nuisance. -TECO wasn't the only full-screen editor floating around the computer world at this time. During a visit to the Stanford Artificial Intelligence Lab in 1976, Stallman encountered an edit program named E. The program contained an internal feature, which allowed a user to update display text after each command keystroke. In the language of 1970s programming, E was one of the first rudimentary WYSIWYG editors. Short for "what you see is what you get," WYSIWYG meant that a user could manipulate the file by moving through the displayed text, as opposed to working through a back-end editor program."~{ See Richard Stallman, "Emacs the Full Screen Editor" (1987).
    http://www.lysator.liu.se/history/garb/txt/87-1-emacs.txt }~ +TECO wasn't the only full-screen editor floating around the computer world at this time. During a visit to the Stanford Artificial Intelligence Lab in 1976, Stallman encountered an edit program named E. The program contained an internal feature, which allowed a user to update display text after each command keystroke. In the language of 1970s programming, E was one of the first rudimentary WYSIWYG editors. Short for "what you see is what you get," WYSIWYG meant that a user could manipulate the file by moving through the displayed text, as opposed to working through a back-end editor program."~{ See Richard Stallman, "Emacs the Full Screen Editor" (1987). \\ http://www.lysator.liu.se/history/garb/txt/87-1-emacs.txt }~ ={E edit program;Stanford Artificial Intelligence Laboratory} Impressed by the hack, Stallman looked for ways to expand TECO's functionality in similar fashion upon his return to MIT. He found a TECO feature called Control-R, written by Carl Mikkelson and named after the two-key combination that triggered it. Mikkelson's hack switched TECO from its usual abstract command-execution mode to a more intuitive keystroke-by-keystroke mode. Stallman revised the feature in a subtle but significant way. He made it possible to trigger other TECO command strings, or "macros," using other, two-key combinations. Where users had once entered command strings and discarded them after entering then, Stallman's hack made it possible to save macro tricks on file and call them up at will. Mikkelson's hack had raised TECO to the level of a WYSIWYG editor. Stallman's hack had raised it to the level of a user-programmable WYSIWYG editor. "That was the real breakthrough," says Guy Steele, a fellow AI Lab hacker at the time. ^39^ @@ -1005,7 +1005,7 @@ Stallman now faced another conundrum: if users made changes but didn't communica Not everybody accepted the contract. The explosive innovation continued throughout the decade, resulting in a host of Emacs-like programs with varying degrees of cross-compatibility. A few cited their relation to Stallman's original Emacs with humorously recursive names: Sine (Sine is not Emacs), Eine (Eine is not Emacs), and Zwei (Zwei was Eine initially). As a devoted exponent of the hacker ethic, Stallman saw no reason to halt this innovation through legal harassment. Still, the fact that some people would so eagerly take software from the community chest, alter it, and slap a new name on the resulting software displayed a stunning lack of courtesy. ={Eine (Eine is not Emacs) text editor;Zwei (Zwei was Eine initially) text editor;Sine (Sine is not Emacs) text editor} -Such rude behavior was reflected against other, unsettling developments in the hacker community. Brian Reid's 1979 decision to embed "time bombs" in Scribe, making it possible for Unilogic to limit unpaid user access to the software, was a dark omen to Stallman. "He considered it the most Nazi thing he ever saw in his life," recalls Reid. Despite going on to later Internet fame as the cocreator of the Usenet alt heirarchy, Reid says he still has yet to live down that 1979 decision, at least in Stallman's eyes. "He said that all software should be free and the prospect of charging money for software was a crime against humanity."~{ In a 1996 interview with online magazine MEME, Stallman cited Scribe's sale as irksome, but hesitated to mention Reid by name. "The problem was nobody censured or punished this student for what he did," Stallman said. "The result was other people got tempted to follow his example." See MEME 2.04.
    http://memex.org/meme2-04.html }~ +Such rude behavior was reflected against other, unsettling developments in the hacker community. Brian Reid's 1979 decision to embed "time bombs" in Scribe, making it possible for Unilogic to limit unpaid user access to the software, was a dark omen to Stallman. "He considered it the most Nazi thing he ever saw in his life," recalls Reid. Despite going on to later Internet fame as the cocreator of the Usenet alt heirarchy, Reid says he still has yet to live down that 1979 decision, at least in Stallman's eyes. "He said that all software should be free and the prospect of charging money for software was a crime against humanity."~{ In a 1996 interview with online magazine MEME, Stallman cited Scribe's sale as irksome, but hesitated to mention Reid by name. "The problem was nobody censured or punished this student for what he did," Stallman said. "The result was other people got tempted to follow his example." See MEME 2.04. \\ http://memex.org/meme2-04.html }~ ={Reid, Brian+1;Unilogic software company;time bombs, in software;Scribe text-formatting program} % additional reference to Unilogic; also time bombs; also scribe text-formatting program @@ -1017,7 +1017,7 @@ Although Stallman had been powerless to head off Reid's sale, he did possess the Over time, Emacs became a sales tool for the hacker ethic. The flexibility Stallman and built into the software not only encouraged collaboration, it demanded it. Users who didn't keep abreast of the latest developments in Emacs evolution or didn't contribute their contributions back to Stallman ran the risk of missing out on the latest breakthroughs. And the breakthroughs were many. Twenty years later, users had modified Emacs for so many different uses-using it as a spreadsheet, calculator, database, and web browser-that later Emacs developers adopted an overflowing sink to represent its versatile functionality. "That's the idea that we wanted to convey," says Stallman. "The amount of stuff it has contained within it is both wonderful and awful at the same time." -Stallman's AI Lab contemporaries are more charitable. Hal Abelson, an MIT grad student who worked with Stallman during the 1970s and would later assist Stallman as a charter boardmember of the Free Software Foundation, describes Emacs as "an absolutely brilliant creation." In giving programmers a way to add new software libraries and features without messing up the system, Abelson says, Stallman paved the way for future large-scale collaborative software projects. "Its structure was robust enough that you'd have people all over the world who were loosely collaborating [and] contributing to it," Abelson says. "I don't know if that had been done before."~{ In writing this chapter, I've elected to focus more on the social significance of Emacs than the software significance. To read more about the software side, I recommend Stallman's 1979 memo. I particularly recommend the section titled "Research Through Development of Installed Tools" (#SEC27). Not only is it accessible to the nontechnical reader, it also sheds light on how closely intertwined Stallman's political philosophies are with his software-design philosophies. A sample excerpt follows:
    _1 EMACS could not have been reached by a process of careful design, because such processes arrive only at goals which are visible at the outset, and whose desirability is established on the bottom line at the outset. Neither I nor anyone else visualized an extensible editor until I had made one, nor appreciated its value until he had experienced it. EMACS exists because I felt free to make individually useful small improvements on a path whose end was not in sight. }~ +Stallman's AI Lab contemporaries are more charitable. Hal Abelson, an MIT grad student who worked with Stallman during the 1970s and would later assist Stallman as a charter boardmember of the Free Software Foundation, describes Emacs as "an absolutely brilliant creation." In giving programmers a way to add new software libraries and features without messing up the system, Abelson says, Stallman paved the way for future large-scale collaborative software projects. "Its structure was robust enough that you'd have people all over the world who were loosely collaborating [and] contributing to it," Abelson says. "I don't know if that had been done before."~{ In writing this chapter, I've elected to focus more on the social significance of Emacs than the software significance. To read more about the software side, I recommend Stallman's 1979 memo. I particularly recommend the section titled "Research Through Development of Installed Tools" (#SEC27). Not only is it accessible to the nontechnical reader, it also sheds light on how closely intertwined Stallman's political philosophies are with his software-design philosophies. A sample excerpt follows: \\ EMACS could not have been reached by a process of careful design, because such processes arrive only at goals which are visible at the outset, and whose desirability is established on the bottom line at the outset. Neither I nor anyone else visualized an extensible editor until I had made one, nor appreciated its value until he had experienced it. EMACS exists because I felt free to make individually useful small improvements on a path whose end was not in sight. }~ ={Abelson, Hal} Guy Steele expresses similar admiration. Currently a research scientist for Sun Microsystems, he remembers Stallman primarily as a "brilliant programmer with the ability to generate large quantities of relatively bug-free code." Although their personalities didn't exactly mesh, Steele and Stallman collaborated long enough for Steele to get a glimpse of Stallman's intense coding style. He recalls a notable episode in the late 1970s when the two programmers banded together to write the editor's "pretty print" feature. Originally conceived by Steele, pretty print was another keystroke-triggerd feature that reformatted Emacs' source code so that it was both more readable and took up less space, further bolstering the program's WYSIWIG qualities. The feature was strategic enough to attract Stallman's active interest, and it wasn't long before Steele wrote that he and Stallman were planning an improved version. @@ -1035,7 +1035,7 @@ The length of the session revealed itself when Steele finally left the AI Lab. S On September 27, 1983, computer programmers logging on to the Usenet newsgroup net.unix-wizards encountered an unusual message. Posted in the small hours of the morning, 12:30 a.m. to be exact, and signed by rms@mit-oz, the message's subject line was terse but attention-grabbing. "New UNIX implementation," it read. Instead of introducing a newly released version of Unix, however, the message's opening paragraph issued a call to arms: ={GNU Project:new UNIX implementation;net.unix-wizards newsgroup} -_1 Starting this Thanksgiving I am going to write a complete Unix-compatible software system called GNU (for Gnu's Not Unix), and give it away free to everyone who can use it. Contributions of time, money, programs and equipment are greatly needed.~{ See Richard Stallman, "Initial GNU Announcement" (September 1983).
    http://www.gnu.ai.mit.edu/gnu/initial-announcement.html }~ +_1 Starting this Thanksgiving I am going to write a complete Unix-compatible software system called GNU (for Gnu's Not Unix), and give it away free to everyone who can use it. Contributions of time, money, programs and equipment are greatly needed.~{ See Richard Stallman, "Initial GNU Announcement" (September 1983). \\ http://www.gnu.ai.mit.edu/gnu/initial-announcement.html }~ ={Unix operating system:GNU system and} To an experienced Unix developer, the message was a mixture of idealism and hubris. Not only did the author pledge to rebuild the already mature Unix operating system from the ground up, he also proposed to improve it in places. The new GNU system, the author predicted, would carry all the usual components-a text editor, a shell program to run Unix-compatible applications, a compiler, "and a few other things." ^44^ It would also contain many enticing features that other Unix systems didn't yet offer: a graphic user interface based on the Lisp programming language, a crash-proof file system, and networking protocols built according to MIT's internal networking system. @@ -1068,7 +1068,7 @@ The breaking point came in 1982. That was the year the lab's administration deci "Without hackers to maintain the system, [faculty members] said, `We're going to have a disaster; we must have commercial software,'" Stallman would recall a few years later. "They said, `We can expect the company to maintain it.' It proved that they were utterly wrong, but that's what they did."~{ See Richard Stallman (1986). }~ -At first, hackers viewed the Twenex system as yet another authoritarian symbol begging to be subverted. The system's name itself was a protest. Officially dubbed TOPS-20 by DEC, it was a successor to TOPS-10, a commercial operating system DEC marketed for the PDP-10. Bolt Beranek Newman had deveoped an improved version, dubbed Tenex, which TOPS-20 drew upon.~{ Multiple sources: see Richard Stallman interview, Gerald Sussman email, and Jargon File 3.0.0.
    http://www.clueless.com/jargon3.0.0/TWENEX.html }~ Stallman, the hacker who coined the Twenex term, says he came up with the name as a way to avoid using the TOPS-20 name. "The system was far from tops, so there was no way I was going to call it that," Stallman recalls. "So I decided to insert a `w' in the Tenex name and call it Twenex." +At first, hackers viewed the Twenex system as yet another authoritarian symbol begging to be subverted. The system's name itself was a protest. Officially dubbed TOPS-20 by DEC, it was a successor to TOPS-10, a commercial operating system DEC marketed for the PDP-10. Bolt Beranek Newman had deveoped an improved version, dubbed Tenex, which TOPS-20 drew upon.~{ Multiple sources: see Richard Stallman interview, Gerald Sussman email, and Jargon File 3.0.0. \\ http://www.clueless.com/jargon3.0.0/TWENEX.html }~ Stallman, the hacker who coined the Twenex term, says he came up with the name as a way to avoid using the TOPS-20 name. "The system was far from tops, so there was no way I was going to call it that," Stallman recalls. "So I decided to insert a `w' in the Tenex name and call it Twenex." ={DEC (Digital Equipment Corporation);TOPS-20 operating system+1} % ={Bolt, Beranek & Newman engineering firm;Tenex} @@ -1088,7 +1088,7 @@ The disguise was a thin one at best. By 1982, Stallman's aversion to passwords a "I'm eternally grateful that MIT let me and many other people use their computers for free," says Hopkins. "It meant a lot to many people." -This so-called "tourist" policy, which had been openly tolerated by MIT management during the ITS years,~{ See "MIT AI Lab Tourist Policy."
    http://catalog.com/hopkins/text/tourist-policy.html }~ fell by the wayside when Oz became the lab's primary link to the ARPAnet. At first, Stallman continued his policy of repeating his login ID as a password so outside users could follow in his footsteps. Over time, however, the Oz's fragility prompted administrators to bar outsiders who, through sheer accident or malicious intent, might bring down the system. When those same administrators eventually demanded that Stallman stop publishing his password, Stallman, citing personal ethics, refused to do so and ceased using the Oz system altogether. ^46^ +This so-called "tourist" policy, which had been openly tolerated by MIT management during the ITS years,~{ See "MIT AI Lab Tourist Policy." \\ http://catalog.com/hopkins/text/tourist-policy.html }~ fell by the wayside when Oz became the lab's primary link to the ARPAnet. At first, Stallman continued his policy of repeating his login ID as a password so outside users could follow in his footsteps. Over time, however, the Oz's fragility prompted administrators to bar outsiders who, through sheer accident or malicious intent, might bring down the system. When those same administrators eventually demanded that Stallman stop publishing his password, Stallman, citing personal ethics, refused to do so and ceased using the Oz system altogether. ^46^ "[When] passwords first appeared at the MIT AI Lab I [decided] to follow my belief that there should be no passwords," Stallman would later say. "Because I don't believe that it's really desirable to have security on a computer, I shouldn't be willing to help uphold the security regime." ^46^ @@ -1151,7 +1151,7 @@ Nowhere was this state of affairs more evident than in the realm of personal com One of the most notorious of these programmers was Bill Gates, a Harvard dropout two years Stallman's junior. Although Stallman didn't know it at the time, seven years before sending out his message to the net.unix-wizards newsgroup, Gates, a budding entrepreneur and general partner with the Albuquerque-based software firm Micro-Soft, later spelled as Microsoft, had sent out his own open letter to the software-developer community. Written in response to the PC users copying Micro-Soft's software programs, Gates' " Open Letter to Hobbyists" had excoriated the notion of communal software development. ={Gates, Bill+2;Micro-Soft;net.unix-wizards newsgroup;Open Letter to Hobbyists (Gates)+1} -"Who can afford to do professional work for nothing?" asked Gates. "What hobbyist can put three man-years into programming, finding all bugs, documenting his product, and distributing it for free?"~{ See Bill Gates, "An Open Letter to Hobbyists" (February 3, 1976).
    To view an online copy of this letter, go to
    http://www.blinkenlights.com/classiccmp/gateswhine.html. }~ +"Who can afford to do professional work for nothing?" asked Gates. "What hobbyist can put three man-years into programming, finding all bugs, documenting his product, and distributing it for free?"~{ See Bill Gates, "An Open Letter to Hobbyists" (February 3, 1976). \\ To view an online copy of this letter, go to \\ http://www.blinkenlights.com/classiccmp/gateswhine.html. }~ Although few hackers at the AI Lab saw the missive, Gates' 1976 letter nevertheless represented the changing attitude toward software both among commercial software companies and commercial software developers. Why treat software as a zero-cost commodity when the market said otherwise? As the 1970s gave way to the 1980s, selling software became more than a way to recoup costs; it became a political statement. At a time when the Reagan Administration was rushing to dismantle many of the federal regulations and spending programs that had been built up during the half century following the Great Depression, more than a few software programmers saw the hacker ethic as anticompetitive and, by extension, un-American. At best, it was a throwback to the anticorporate attitudes of the late 1960s and early 1970s. Like a Wall Street banker discovering an old tie-dyed shirt hiding between French-cuffed shirts and double-breasted suits, many computer programmers treated the hacker ethic as an embarrassing reminder of an idealistic age. @@ -1171,7 +1171,7 @@ group{ If not now, when? -}group ~{ See Richard Stallman, Open Sources (O'Reilly & Associates, Inc., 1999): 56.
    Stallman adds his own footnote to this statement, writing, "As an atheist, I don't follow any religious leaders, but I sometimes find I admire something one of them has said." }~ +}group ~{ See Richard Stallman, Open Sources (O'Reilly & Associates, Inc., 1999): 56. \\ Stallman adds his own footnote to this statement, writing, "As an atheist, I don't follow any religious leaders, but I sometimes find I admire something one of them has said." }~ Speaking to audiences, Stallman avoids the religious route and expresses the decision in pragmatic terms. "I asked myself: what could I, an operating-system developer, do to improve the situation? It wasn't until I examined the question for a while that I realized an operating-system developer was exactly what was needed to solve the problem." @@ -1212,7 +1212,7 @@ In the course of reverse-engineering Gosling's interpreter, Stallman would creat Despite the stress it generated, the dispute over Gosling's innovations would assist both Stallman and the free software movement in the long term. It would force Stallman to address the weaknesses of the Emacs Commune and the informal trust system that had allowed problematic offshoots to emerge. It would also force Stallman to sharpen the free software movement's political objectives. Following the release of GNU Emacs in 1985, Stallman issued " The GNU Manifesto," an expansion of the original announcement posted in September, 1983. Stallman included within the document a lengthy section devoted to the many arguments used by commercial and academic programmers to justify the proliferation of proprietary software programs. One argument, "Don't programmers deserve a reward for their creativity," earned a response encapsulating Stallman's anger over the recent Gosling Emacs episode: ={Emacs Commune:proprietary software and;Emacs text editor;GNU Emacs;GNU Manifesto} -"If anything deserves a reward, it is social contribution," Stallman wrote. "Creativity can be a social contribution, but only in so far [sic] as society is free to use the results. If programmers deserve to be rewarded for creating innovative programs, by the same token they deserve to be punished if they restrict the use of these programs."~{ See Richard Stallman, "The GNU Manifesto" (1985).
    http://www.gnu.org/manifesto.html }~ +"If anything deserves a reward, it is social contribution," Stallman wrote. "Creativity can be a social contribution, but only in so far [sic] as society is free to use the results. If programmers deserve to be rewarded for creating innovative programs, by the same token they deserve to be punished if they restrict the use of these programs."~{ See Richard Stallman, "The GNU Manifesto" (1985). \\ http://www.gnu.org/manifesto.html }~ With the release of GNU Emacs, the GNU Project finally had code to show. It also had the burdens of any software-based enterprise. As more and more Unix developers began playing with the software, money, gifts, and requests for tapes began to pour in. To address the business side of the GNU Project, Stallman drafted a few of his colleagues and formed the Free Software Foundation (FSF), a nonprofit organization dedicated to speeding the GNU Project towards its goal. With Stallman as president and various hacker allies as board members, the FSF helped provide a corporate face for the GNU Project. ={Free Software Foundation (FSF):GNU Project and;GNU Project:Emacs, release of} @@ -1252,9 +1252,9 @@ Needless to say, Stallman, who stands in front of the room dressed in plain blue As Stallman putters around the front of the room, a few audience members wearing T-shirts with the logo of the Maui FreeBSD Users Group (MFUG) race to set up camera and audio equipment. FreeBSD, a free software offshoot of the Berkeley Software Distribution, the venerable 1970s academic version of Unix, is technically a competitor to the GNU/Linux operating system. Still, in the hacking world, Stallman speeches are documented with a fervor reminiscent of the Grateful Dead and its legendary army of amateur archivists. As the local free software heads, it's up to the MFUG members to make sure fellow programmers in Hamburg, Mumbai, and Novosibirsk don't miss out on the latest pearls of RMS wisdom. ={Berkely Software Distribution (BSD);BSD (Berkely Software Distribution);Grateful Dead, The+1;Maui FreeBSD Users Group} -The analogy to the Grateful Dead is apt. Often, when describing the business opportunities inherent within the free software model, Stallman has held up the Grateful Dead as an example. In refusing to restrict fans' ability to record live concerts, the Grateful Dead became more than a rock group. They became the center of a tribal community dedicated to Grateful Dead music. Over time, that tribal community became so large and so devoted that the band shunned record contracts and supported itself solely through musical tours and live appearances. In 1994, the band's last year as a touring act, the Grateful Dead drew $52 million in gate receipts alone.~{ See "Grateful Dead Time Capsule: 1985-1995 North American Tour Grosses."
    http://www.accessplace.com/gdtc/1197.htm }~ +The analogy to the Grateful Dead is apt. Often, when describing the business opportunities inherent within the free software model, Stallman has held up the Grateful Dead as an example. In refusing to restrict fans' ability to record live concerts, the Grateful Dead became more than a rock group. They became the center of a tribal community dedicated to Grateful Dead music. Over time, that tribal community became so large and so devoted that the band shunned record contracts and supported itself solely through musical tours and live appearances. In 1994, the band's last year as a touring act, the Grateful Dead drew $52 million in gate receipts alone.~{ See "Grateful Dead Time Capsule: 1985-1995 North American Tour Grosses." \\ http://www.accessplace.com/gdtc/1197.htm }~ -While few software companies have been able to match that success, the tribal aspect of the free software community is one reason many in the latter half of the 1990s started to accept the notion that publishing software source code might be a good thing. Hoping to build their own loyal followings, companies such as IBM, Sun Microsystems, and Hewlett Packard have come to accept the letter, if not the spirit, of the Stallman free software message. Describing the GPL as the information-technology industry's "Magna Carta," ZDNet software columnist Evan Leibovitch sees the growing affection for all things GNU as more than just a trend. "This societal shift is letting users take back control of their futures," Leibovitch writes. "Just as the Magna Carta gave rights to British subjects, the GPL enforces consumer rights and freedoms on behalf of the users of computer software."~{ See Evan Leibovitch, "Who's Afraid of Big Bad Wolves," ZDNet Tech Update (December 15, 2000).
    http://techupdate.zdnet.com/techupdate/stories/main/0,14179,2664992,00.html }~ +While few software companies have been able to match that success, the tribal aspect of the free software community is one reason many in the latter half of the 1990s started to accept the notion that publishing software source code might be a good thing. Hoping to build their own loyal followings, companies such as IBM, Sun Microsystems, and Hewlett Packard have come to accept the letter, if not the spirit, of the Stallman free software message. Describing the GPL as the information-technology industry's "Magna Carta," ZDNet software columnist Evan Leibovitch sees the growing affection for all things GNU as more than just a trend. "This societal shift is letting users take back control of their futures," Leibovitch writes. "Just as the Magna Carta gave rights to British subjects, the GPL enforces consumer rights and freedoms on behalf of the users of computer software."~{ See Evan Leibovitch, "Who's Afraid of Big Bad Wolves," ZDNet Tech Update (December 15, 2000). \\ http://techupdate.zdnet.com/techupdate/stories/main/0,14179,2664992,00.html }~ ={Hewlett Packard;IBM;Sun Microsystems} The tribal aspect of the free software community also helps explain why 40-odd programmers, who might otherwise be working on physics projects or surfing the Web for windsurfing buoy reports, have packed into a conference room to hear Stallman speak. @@ -1266,7 +1266,7 @@ Unlike the New York speech, Stallman gets no introduction. He also offers no sel Once again, Stallman quickly segues into the parable of the Xerox laser printer, taking a moment to deliver the same dramatic finger-pointing gestures to the crowd. He also devotes a minute or two to the GNU/Linux name. -"Some people say to me, `Why make such a fuss about getting credit for this system? After all, the important thing is the job is done, not whether you get recognition for it.' Well, this would be wise advice if it were true. But the job wasn't to build an operating system; the job is to spread freedom to the users of computers. And to do that we have to make it possible to do everything with computers in freedom."~{ For narrative purposes, I have hesitated to go in-depth when describing Stallman's full definition of software "freedom." The GNU Project web site lists four fundamental components:
    The freedom to run a program, for any purpose (freedom 0).
    The freedom to study how a program works, and adapt it to your needs (freedom 1).
    The freedom to redistribute copies of a program so you can help your neighbor (freedom 2).
    The freedom to improve the program, and release your improvements to the public, so that the whole community benefits (freedom 3).
    For more information, please visit "The Free Software Definition" at http://www.gnu.org/philosophy/free-sw.html }~ +"Some people say to me, `Why make such a fuss about getting credit for this system? After all, the important thing is the job is done, not whether you get recognition for it.' Well, this would be wise advice if it were true. But the job wasn't to build an operating system; the job is to spread freedom to the users of computers. And to do that we have to make it possible to do everything with computers in freedom."~{ For narrative purposes, I have hesitated to go in-depth when describing Stallman's full definition of software "freedom." The GNU Project web site lists four fundamental components: \\ The freedom to run a program, for any purpose (freedom 0). \\ The freedom to study how a program works, and adapt it to your needs (freedom 1). \\ The freedom to redistribute copies of a program so you can help your neighbor (freedom 2). \\ The freedom to improve the program, and release your improvements to the public, so that the whole community benefits (freedom 3). \\ For more information, please visit "The Free Software Definition" at http://www.gnu.org/philosophy/free-sw.html }~ Adds Stallman, "There's a lot more work to do." @@ -1320,7 +1320,7 @@ The skit is a lighthearted moment of self-pardoy, a humorous return-jab at the m Discussing the St. Ignucius persona afterward, Stallman says he first came up with it in 1996, long after the creation of Emacs but well before the emergence of the "open source" term and the struggle for hacker-community leadership that precipitated it. At the time, Stallman says, he wanted a way to "poke fun at himself," to remind listeners that, though stubborn, Stallman was not the fanatic some made him out to be. It was only later, Stallman adds, that others seized the persona as a convenient way to play up his reputation as software ideologue, as Eric Raymond did in an 1999 interview with the linux.com web site: ={linux.com;Raymond, Eric:St. Ignucius and+2} -_1 When I say RMS calibrates what he does, I'm not belittling or accusing him of insincerity. I'm saying that like all good communicators he's got a theatrical streak. Sometimes it's conscious-have you ever seen him in his St. Ignucius drag, blessing software with a disk platter on his head? Mostly it's unconscious; he's just learned the degree of irritating stimulus that works, that holds attention without (usually) freaking people out.~{ See "Guest Interview: Eric S. Raymond," Linux.com (May 18, 1999).
    http://www.linux.com/interviews/19990518/8/ }~ +_1 When I say RMS calibrates what he does, I'm not belittling or accusing him of insincerity. I'm saying that like all good communicators he's got a theatrical streak. Sometimes it's conscious-have you ever seen him in his St. Ignucius drag, blessing software with a disk platter on his head? Mostly it's unconscious; he's just learned the degree of irritating stimulus that works, that holds attention without (usually) freaking people out.~{ See "Guest Interview: Eric S. Raymond," Linux.com (May 18, 1999). \\ http://www.linux.com/interviews/19990518/8/ }~ Stallman takes issue with the Raymond analysis. "It's simply my way of making fun of myself," he says. "The fact that others see it as anything more than that is a reflection of their agenda, not mine." @@ -1370,7 +1370,7 @@ By the spring of 1985, Richard Stallman had settled on the GNU Project's first m The dispute with UniPress had highlighted a flaw in the Emacs Commune social contract. Where users relied on Stallman's expert insight, the Commune's rules held. In areas where Stallman no longer held the position of alpha hacker-pre-1984 Unix systems, for example-individuals and companies were free to make their own rules. ={UniPress software company} -The tension between the freedom to modify and the freedom to exert authorial privilege had been building before GOSMACS. The Copyright Act of 1976 had overhauled U.S. copyright law, extending the legal protection of copyright to software programs. According to Section 102(b) of the Act, individuals and companies now possessed the ability to copyright the "expression" of a software program but not the "actual processes or methods embodied in the program."~{ See Hal Abelson, Mike Fischer, and Joanne Costello, "Software and Copyright Law," updated version (1998).
    http://www.swiss.ai.mit.edu/6805/articles/int-prop/software-copyright.html }~ Translated, programmers and companies had the ability to treat software programs like a story or song. Other programmers could take inspiration from the work, but to make a direct copy or nonsatirical derivative, they first had to secure permission from the original creator. Although the new law guaranteed that even programs without copyright notices carried copyright protection, programmers quickly asserted their rights, attaching coypright notices to their software programs. +The tension between the freedom to modify and the freedom to exert authorial privilege had been building before GOSMACS. The Copyright Act of 1976 had overhauled U.S. copyright law, extending the legal protection of copyright to software programs. According to Section 102(b) of the Act, individuals and companies now possessed the ability to copyright the "expression" of a software program but not the "actual processes or methods embodied in the program."~{ See Hal Abelson, Mike Fischer, and Joanne Costello, "Software and Copyright Law," updated version (1998). \\ http://www.swiss.ai.mit.edu/6805/articles/int-prop/software-copyright.html }~ Translated, programmers and companies had the ability to treat software programs like a story or song. Other programmers could take inspiration from the work, but to make a direct copy or nonsatirical derivative, they first had to secure permission from the original creator. Although the new law guaranteed that even programs without copyright notices carried copyright protection, programmers quickly asserted their rights, attaching coypright notices to their software programs. ={Copyright Act of 1976;copyright laws;GOSMACS (Gosling Emacs);software:copyright laws on} At first, Stallman viewed these notices with alarm. Rare was the software program that didn't borrow source code from past programs, and yet, with a single stroke of the president's pen, Congress had given programmers and companies the power to assert individual authorship over communally built programs. It also injected a dose of formality into what had otherwise been an informal system. Even if hackers could demonstrate how a given program's source-code bloodlines stretched back years, if not decades, the resources and money that went into battling each copyright notice were beyond most hackers' means. Simply put, disputes that had once been settled hacker-to-hacker were now settled lawyer-to-lawyer. In such a system, companies, not hackers, held the automatic advantage. @@ -1402,9 +1402,8 @@ As an example of this informality, Gilmore cites a copyright notice for trn, a U % previous markup as 'poem' with footnote not satisfactory -Copyright (c) 1985, Larry Wall
    -You may copy the trn kit in whole or in part as long as you don't try -to make money off it, or pretend that you wrote it.~{ See Trn Kit README.
    http://www.za.debian.org/doc/trn/trn-readme }~ +Copyright (c) 1985, Larry Wall \\ +You may copy the trn kit in whole or in part as long as you don't try to make money off it, or pretend that you wrote it.~{ See Trn Kit README. \\ http://www.za.debian.org/doc/trn/trn-readme }~ Such statements, while reflective of the hacker ethic, also reflected the difficulty of translating the loose, informal nature of that ethic into the rigid, legal language of copyright. In writing the GNU Emacs License, Stallman had done more than close up the escape hatch that permitted proprietary offshoots. He had expressed the hacker ethic in a manner understandable to both lawyer and hacker alike. @@ -1430,7 +1429,7 @@ anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it. -}poem ~{ See Richard Stallman, et al., "GNU General Public License: Version 1," (February, 1989).
    http://www.gnu.org/copyleft/copying-1.0.html }~ +}poem ~{ See Richard Stallman, et al., "GNU General Public License: Version 1," (February, 1989). \\ http://www.gnu.org/copyleft/copying-1.0.html }~ In fashioning the GPL, Stallman had been forced to make an additional adjustment to the informal tenets of the old Emacs Commune. Where he had once demanded that Commune members publish any and all changes, Stallman now demanded publication only in instances when programmers circulated their derivative versions in the same public manner as Stallman. In other words, programmers who simply modified Emacs for private use no longer needed to send the source-code changes back to Stallman. In what would become a rare compromise of free software doctrine, Stallman slashed the price tag for free software. Users could innovate without Stallman looking over their shoulders just so long as they didn't bar Stallman and the rest of the hacker community from future exchanges of the same program. ={Emacs Commune+1} @@ -1445,7 +1444,7 @@ As hacks go, the GPL stands as one of Stallman's best. It created a system of co "The GPL developed much like any piece of free software with a large community discussing its structure, its respect or the opposite in their observation, needs for tweaking and even to compromise it mildly for greater acceptance," says Jerry Cohen, another attorney who helped Stallman with the creation of the license. "The process worked very well and GPL in its several versions has gone from widespread skeptical and at times hostile response to widespread acceptance." -In a 1986 interview with Byte magazine, Stallman summed up the GPL in colorful terms. In addition to proclaiming hacker values, Stallman said, readers should also "see it as a form of intellectual jujitsu, using the legal system that software hoarders have set up against them."~{ See David Betz and Jon Edwards, "Richard Stallman discusses his public-domain [sic] Unix-compatible software system with BYTE editors," BYTE (July, 1996). (Reprinted on the GNU Project web site: http://www.gnu.org/gnu/byte-interview.html )
    This interview offers an interesting, not to mention candid, glimpse at Stallman's political attitudes during the earliest days of the GNU Project. It is also helpful in tracing the evolution of Stallman's rhetoric.
    Describing the purpose of the GPL, Stallman says, "I'm trying to change the way people approach knowledge and information in general. I think that to try to own knowledge, to try to control whether people are allowed to use it, or to try to stop other people from sharing it, is sabotage."
    Contrast this with a statement to the author in August 2000: "I urge you not to use the term `intellectual property' in your thinking. It will lead you to misunderstand things, because that term generalizes about copyrights, patents, and trademarks. And those things are so different in their effects that it is entirely foolish to try to talk about them at once. If you hear somebody saying something about intellectual property, without quotes, then he's not thinking very clearly and you shouldn't join." }~ Years later, Stallman would describe the GPL's creation in less hostile terms. "I was thinking about issues that were in a sense ethical and in a sense political and in a sense legal," he says. "I had to try to do what could be sustained by the legal system that we're in. In spirit the job was that of legislating the basis for a new society, but since I wasn't a government, I couldn't actually change any laws. I had to try to do this by building on top of the existing legal system, which had not been designed for anything like this." +In a 1986 interview with Byte magazine, Stallman summed up the GPL in colorful terms. In addition to proclaiming hacker values, Stallman said, readers should also "see it as a form of intellectual jujitsu, using the legal system that software hoarders have set up against them."~{ See David Betz and Jon Edwards, "Richard Stallman discusses his public-domain [sic] Unix-compatible software system with BYTE editors," BYTE (July, 1996). (Reprinted on the GNU Project web site: http://www.gnu.org/gnu/byte-interview.html ) \\ This interview offers an interesting, not to mention candid, glimpse at Stallman's political attitudes during the earliest days of the GNU Project. It is also helpful in tracing the evolution of Stallman's rhetoric. \\ Describing the purpose of the GPL, Stallman says, "I'm trying to change the way people approach knowledge and information in general. I think that to try to own knowledge, to try to control whether people are allowed to use it, or to try to stop other people from sharing it, is sabotage." \\ Contrast this with a statement to the author in August 2000: "I urge you not to use the term `intellectual property' in your thinking. It will lead you to misunderstand things, because that term generalizes about copyrights, patents, and trademarks. And those things are so different in their effects that it is entirely foolish to try to talk about them at once. If you hear somebody saying something about intellectual property, without quotes, then he's not thinking very clearly and you shouldn't join." }~ Years later, Stallman would describe the GPL's creation in less hostile terms. "I was thinking about issues that were in a sense ethical and in a sense political and in a sense legal," he says. "I had to try to do what could be sustained by the legal system that we're in. In spirit the job was that of legislating the basis for a new society, but since I wasn't a government, I couldn't actually change any laws. I had to try to do this by building on top of the existing legal system, which had not been designed for anything like this." ={Byte magazine} About the time Stallman was pondering the ethical, political, and legal issues associated with free software, a California hacker named Don Hopkins mailed him a manual for the 68000 microprocessor. Hopkins, a Unix hacker and fellow science-fiction buff, had borrowed the manual from Stallman a while earlier. As a display of gratitude, Hopkins decorated the return envelope with a number of stickers obtained at a local science-fiction convention. One sticker in particular caught Stallman's eye. It read, "Copyleft (L), All Rights Reversed." Following the release of the first version of GPL, Stallman paid tribute to the sticker, nicknaming the free software license "Copyleft." Over time, the nickname and its shorthand symbol, a backwards "C," would become an official Free Software Foundation synonym for the GPL. @@ -1469,7 +1468,7 @@ Hired in 1986, Bostic had taken on the personal project of porting BSD over to t % CSRG abbreviated to SRG above? -The arguments eventually took hold, although not in the way Stallman would have liked. In June, 1989, Berkeley separated its networking code from the rest of the AT&T-owned operating system and distributed it under a University of California license. The contract terms were liberal. All a licensee had to do was give credit to the university in advertisements touting derivative programs.~{ The University of California's "obnoxious advertising clause" would later prove to be a problem. Looking for a less restrictive alternative to the GPL, some hackers used the University of California, replacing "University of California" with the name of their own instution. The result: free software programs that borrowed from dozens of other programs would have to cite dozens of institutions in advertisements. In 1999, after a decade of lobbying on Stallman's part, the University of California agreed to drop this clause.
    See "The BSD License Problem" at http://www.gnu.org/philosophy/bsd.html. }~ In contrast to the GPL, proprietary offshoots were permissible. Only one problem hampered the license's rapid adoption: the BSD Networking release wasn't a complete operating system. People could study the code, but it could only be run in conjunction with other proprietary-licensed code. +The arguments eventually took hold, although not in the way Stallman would have liked. In June, 1989, Berkeley separated its networking code from the rest of the AT&T-owned operating system and distributed it under a University of California license. The contract terms were liberal. All a licensee had to do was give credit to the university in advertisements touting derivative programs.~{ The University of California's "obnoxious advertising clause" would later prove to be a problem. Looking for a less restrictive alternative to the GPL, some hackers used the University of California, replacing "University of California" with the name of their own instution. The result: free software programs that borrowed from dozens of other programs would have to cite dozens of institutions in advertisements. In 1999, after a decade of lobbying on Stallman's part, the University of California agreed to drop this clause. \\ See "The BSD License Problem" at http://www.gnu.org/philosophy/bsd.html. }~ In contrast to the GPL, proprietary offshoots were permissible. Only one problem hampered the license's rapid adoption: the BSD Networking release wasn't a complete operating system. People could study the code, but it could only be run in conjunction with other proprietary-licensed code. ={AT&T+1} Over the next few years, Bostic and other University of California employees worked to replace the missing components and turn BSD into a complete, freely redistributable operating system. Although delayed by a legal challenge from Unix Systems Laboratories-the AT&T spin-off that retained ownership of the Unix brand name-the effort would finally bear fruit in the early 1990s. Even before then, however, many of the Berkeley utilities would make their way into Stallman's GNU Project. @@ -1538,14 +1537,14 @@ Jeremy Allison, a Sun user during the late 1980s and programmer destined to run Stallman's growing stature as a software programmer, however, was balanced by his struggles as a project manager. Although the GNU Project moved from success to success in creation of developer-oriented tools, its inability to generate a working kernel-the central "traffic cop" program in all Unix systems that determines which devices and applications get access to the microprocessor and when-was starting to elicit grumbles as the 1980s came to a close. As with most GNU Project efforts, Stallman had started kernel development by looking for an existing program to modify. According to a January 1987 "Gnusletter," Stallman was already working to overhaul TRIX, a Unix kernel developed at MIT. -A review of GNU Project "GNUsletters" of the late 1980s reflects the management tension. In January, 1987, Stallman announced to the world that the GNU Project was working to overhaul TRIX, a Unix kernel developed at MIT. A year later, in February of 1988, the GNU Project announced that it had shifted its attentions to Mach, a lightweight "micro-kernel" developed at Carnegie Mellon. All told, however, official GNU Project kernel development wouldn't commence until 1990.~{ See "HURD History."
    http://www.gnu.org/software/hurd/history.html }~ +A review of GNU Project "GNUsletters" of the late 1980s reflects the management tension. In January, 1987, Stallman announced to the world that the GNU Project was working to overhaul TRIX, a Unix kernel developed at MIT. A year later, in February of 1988, the GNU Project announced that it had shifted its attentions to Mach, a lightweight "micro-kernel" developed at Carnegie Mellon. All told, however, official GNU Project kernel development wouldn't commence until 1990.~{ See "HURD History." \\ http://www.gnu.org/software/hurd/history.html }~ % ={Carnegie Mellon University} The delays in kernel development were just one of many concerns weighing on Stallman during this period. In 1989, Lotus Development Corporation filed suit against rival software company, Paperback Software International, for copying menu commands in Lotus' popular 1-2-3 Spreadsheet program. Lotus' suit, coupled with the Apple-Microsoft "look and feel" battle, provided a troublesome backdrop for the GNU Project. Although both suits fell outside the scope of the GNU Project, both revolved around operating systems and software applications developed for the personal computer, not Unix-compatible hardware systems-they threatened to impose a chilling effect on the entire culture of software development. Determined to do something, Stallman recruited a few programmer friends and composed a magazine ad blasting the lawsuits. He then followed up the ad by helping to organize a group to protest the corporations filing the suit. Calling itself the League of Programming Freedom, the group held protests outside the offices of Lotus, Inc. and the Boston courtroom hosting the Lotus trial. ={Apple Computers;Lotus Development Corp.;Microsoft Corporation:Apple Computer lawsuit;Paperback Software International} -The protests were notable.~{ According to a League of Programming Freedom Press, the protests were notable for featuring the first hexadecimal protest chant:
    1-2-3-4, toss the lawyers out the door;
    5-6-7-8, innovate don't litigate;
    9-A-B-C, 1-2-3 is not for me;
    D-E-F-O, look and feel have got to go
    http://lpf.ai.mit.edu/Links/prep.ai.mit.edu/demo.final.release }~ They document the evolving nature of software industry. Applications had quietly replaced operating systems as the primary corporate battleground. In its unfulfilled quest to build a free software operating system, the GNU Project seemed hopelessly behind the times. Indeed, the very fact that Stallman had felt it necessary to put together an entirely new group dedicated to battling the "look and feel" lawsuits reinforced that obsolescence in the eyes of some observers. +The protests were notable.~{ According to a League of Programming Freedom Press, the protests were notable for featuring the first hexadecimal protest chant: \\ 1-2-3-4, toss the lawyers out the door; \\ 5-6-7-8, innovate don't litigate; \\ 9-A-B-C, 1-2-3 is not for me; \\ D-E-F-O, look and feel have got to go \\ http://lpf.ai.mit.edu/Links/prep.ai.mit.edu/demo.final.release }~ They document the evolving nature of software industry. Applications had quietly replaced operating systems as the primary corporate battleground. In its unfulfilled quest to build a free software operating system, the GNU Project seemed hopelessly behind the times. Indeed, the very fact that Stallman had felt it necessary to put together an entirely new group dedicated to battling the "look and feel" lawsuits reinforced that obsolescence in the eyes of some observers. In 1990, the John D. and Catherine T. MacArthur Foundation cerified Stallman's genius status when it granted Stallman a MacArthur fellowship, therefore making him a recipient for the organization's so-called "genius grant." The grant, a $240,000 reward for launching the GNU Project and giving voice to the free software philosophy, relieved a number of short-term concerns. First and foremost, it gave Stallman, a nonsalaried employee of the FSF who had been supporting himself through consulting contracts, the ability to devote more time to writing GNU code.~{ I use the term "writing" here loosely. About the time of the MacArthur award, Stallman began suffering chronic pain in his hands and was dictating his work to FSF-employed typists. Although some have speculated that the hand pain was the result of repetitive stress injury, or RSI, an injury common among software programmers, Stallman is not 100% sure. "It was NOT carpal tunnel syndrome," he writes. "My hand problem was in the hands themselves, not in the wrists." Stallman has since learned to work without typists after switching to a keyboard with a lighter touch. }~ @@ -1582,7 +1581,7 @@ things people like/dislike in minix, as my OS resembles it somewhat (same physical layout of the file-system (due to practical reasons) among other things). -}poem~{ See "Linux 10th Anniversary."
    http://www.linux10.org/history/ }~ +}poem~{ See "Linux 10th Anniversary." \\ http://www.linux10.org/history/ }~ The posting drew a smattering of responses and within a month, Torvalds had posted a 0.01 version of the operating system-i.e., the earliest possible version fit for outside review-on an Internet FTP site. In the course of doing so, Torvalds had to come up with a name for the new system. On his own PC hard drive, Torvalds had saved the program as Linux, a name that paid its respects to the software convention of giving each Unix variant a name that ended with the letter X. Deeming the name too "egotistical," Torvalds changed it to Freax, only to have the FTP site manager change it back. ={Freax} @@ -1596,7 +1595,7 @@ _1 You put six months of your life into this thing and you want to make it avail When it was time to release the 0.12 version of Linux, the first to include a fully integrated version of GCC, Torvalds decided to voice his allegiance with the free software movement. He discarded the old kernel license and replaced it with the GPL. The decision triggered a porting spree, as Torvalds and his collaborators looked to other GNU programs to fold into the growing Linux stew. Within three years, Linux developers were offering their first production release, Linux 1.0, including fully modified versions of GCC, GDB, and a host of BSD tools. -By 1994, the amalgamated operating system had earned enough respect in the hacker world to make some observers wonder if Torvalds hadn't given away the farm by switching to the GPL in the project's initial months. In the first issue of Linux Journal, publisher Robert Young sat down with Torvalds for an interview. When Young asked the Finnish programmer if he felt regret at giving up private ownership of the Linux source code, Torvalds said no. "Even with 20/20 hindsight," Torvalds said, he considered the GPL "one of the very best design decisions" made during the early stages of the Linux project.~{ See Robert Young, "Interview with Linus, the Author of Linux," Linux Journal (March 1, 1994).
    http://www.linuxjournal.com/article.php?sid=2736 }~ +By 1994, the amalgamated operating system had earned enough respect in the hacker world to make some observers wonder if Torvalds hadn't given away the farm by switching to the GPL in the project's initial months. In the first issue of Linux Journal, publisher Robert Young sat down with Torvalds for an interview. When Young asked the Finnish programmer if he felt regret at giving up private ownership of the Linux source code, Torvalds said no. "Even with 20/20 hindsight," Torvalds said, he considered the GPL "one of the very best design decisions" made during the early stages of the Linux project.~{ See Robert Young, "Interview with Linus, the Author of Linux," Linux Journal (March 1, 1994). \\ http://www.linuxjournal.com/article.php?sid=2736 }~ ={Young, Robert} % robert young entry added @@ -1628,7 +1627,7 @@ Or were they? To the pessimistically inclined, each sign of acceptance carried i % Intel index ref added -Finally, there was the curious nature of Linux itself. Unrestricted by design bugs (like GNU) and legal disputes (like BSD), Linux' high-speed evolution had been so unplanned, its success so accidental, that programmers closest to the software code itself didn't know what to make of it. More compilation album than operating system, it was comprised of a hacker medley of greatest hits: everything from GCC, GDB, and glibc (the GNU Project's newly developed C Library) to X (a Unix-based graphic user interface developed by MIT's Laboratory for Computer Science) to BSD-developed tools such as BIND (the Berkeley Internet Naming Daemon, which lets users substitute easy-to-remember Internet domain names for numeric IP addresses) and TCP/IP. The arch's capstone, of course, was the Linux kernel-itself a bored-out, super-charged version of Minix. Rather than building their operating system from scratch, Torvalds and his rapidly expanding Linux development team had followed the old Picasso adage, "good artists borrow; great artists steal." Or as Torvalds himself would later translate it when describing the secret of his success: "I'm basically a very lazy person who likes to take credit for things other people actually do."~{ Torvalds has offered this quote in many different settings. To date, however, the quote's most notable appearance is in the Eric Raymond essay, "The Cathedral and the Bazaar" (May, 1997).
    http://www.tuxedo.org/~esr/writings/cathedral-bazaar/cathedral-bazaar/index.html }~ +Finally, there was the curious nature of Linux itself. Unrestricted by design bugs (like GNU) and legal disputes (like BSD), Linux' high-speed evolution had been so unplanned, its success so accidental, that programmers closest to the software code itself didn't know what to make of it. More compilation album than operating system, it was comprised of a hacker medley of greatest hits: everything from GCC, GDB, and glibc (the GNU Project's newly developed C Library) to X (a Unix-based graphic user interface developed by MIT's Laboratory for Computer Science) to BSD-developed tools such as BIND (the Berkeley Internet Naming Daemon, which lets users substitute easy-to-remember Internet domain names for numeric IP addresses) and TCP/IP. The arch's capstone, of course, was the Linux kernel-itself a bored-out, super-charged version of Minix. Rather than building their operating system from scratch, Torvalds and his rapidly expanding Linux development team had followed the old Picasso adage, "good artists borrow; great artists steal." Or as Torvalds himself would later translate it when describing the secret of his success: "I'm basically a very lazy person who likes to take credit for things other people actually do."~{ Torvalds has offered this quote in many different settings. To date, however, the quote's most notable appearance is in the Eric Raymond essay, "The Cathedral and the Bazaar" (May, 1997). \\ http://www.tuxedo.org/~esr/writings/cathedral-bazaar/cathedral-bazaar/index.html }~ ={BIND (Berkely Internet Naming Daemon);Berkely Internet Naming Daemon (BIND);C programming language:glibc;GNU Debugger (GDB):Linux and;GDB (GNU Debugger): Linux and;glibc (GNU C Library);GNU C Library (glibc);kernel (Linux);X graphic user interface;Laboratory for Computer Science:X, developing;Minix operating system:kernel, used for Linux;TCP/IP;Torvalds, Linus:Minix, reworking for Linux+2} Such laziness, while admirable from an efficiency perspective, was troubling from a political perspective. For one thing, it underlined the lack of an ideological agenda on Torvalds' part. Unlike the GNU developers, Torvalds hadn't built an operating system out of a desire to give his fellow hackers something to work with; he'd built it to have something he himself could play with. Like Tom Sawyer whitewashing a fence, Torvalds' genius lay less in the overall vision and more in his ability to recruit other hackers to speed the process. @@ -1657,7 +1656,7 @@ The message represented a dramatic about-face on Stallman's part. Until 1993, St The friend's report was correct. Built to run on 386-based machines, Linux was firmly rooted to its low-cost hardware platform. What the friend failed to report, however, was the sizable advantage Linux enjoyed as the only freely modifiable operating system in the marketplace. In other words, while Stallman spent the next three years listening to bug reports from his HURD team, Torvalds was winning over the programmers who would later uproot and replant the operating system onto new platforms. -By 1993, the GNU Project's inability to deliver a working kernel was leading to problems both within the GNU Project and within the free software movement at large. A March, 1993, a Wired magazine article by Simson Garfinkel described the GNU Project as "bogged down" despite the success of the project's many tools.~{ See Simson Garfinkel, "Is Stallman Stalled?" Wired (March, 1993). }~ Those within the project and its nonprofit adjunct, the Free Software Foundation, remember the mood as being even worse than Garfinkel's article let on. "It was very clear, at least to me at the time, that there was a window of opportunity to introduce a new operating system," says Chassell. "And once that window was closed, people would become less interested. Which is in fact exactly what happened."~{ Chassel's concern about there being a 36-month "window" for a new operating system is not unique to the GNU Project. During the early 1990s, free software versions of the Berkeley Software Distribution were held up by Unix System Laboratories' lawsuit restricting the release of BSD-derived software. While many users consider BSD offshoots such as FreeBSD and OpenBSD to be demonstrably superior to GNU/Linux both in terms of performance and security, the number of FreeBSD and OpenBSD users remains a fraction of the total GNU/Linux user population.
    To view a sample analysis of the relative success of GNU/Linux in relation to other free software operating systems, see the essay by New Zealand hacker, Liam Greenwood, "Why is Linux Successful" (1999). }~ +By 1993, the GNU Project's inability to deliver a working kernel was leading to problems both within the GNU Project and within the free software movement at large. A March, 1993, a Wired magazine article by Simson Garfinkel described the GNU Project as "bogged down" despite the success of the project's many tools.~{ See Simson Garfinkel, "Is Stallman Stalled?" Wired (March, 1993). }~ Those within the project and its nonprofit adjunct, the Free Software Foundation, remember the mood as being even worse than Garfinkel's article let on. "It was very clear, at least to me at the time, that there was a window of opportunity to introduce a new operating system," says Chassell. "And once that window was closed, people would become less interested. Which is in fact exactly what happened."~{ Chassel's concern about there being a 36-month "window" for a new operating system is not unique to the GNU Project. During the early 1990s, free software versions of the Berkeley Software Distribution were held up by Unix System Laboratories' lawsuit restricting the release of BSD-derived software. While many users consider BSD offshoots such as FreeBSD and OpenBSD to be demonstrably superior to GNU/Linux both in terms of performance and security, the number of FreeBSD and OpenBSD users remains a fraction of the total GNU/Linux user population. \\ To view a sample analysis of the relative success of GNU/Linux in relation to other free software operating systems, see the essay by New Zealand hacker, Liam Greenwood, "Why is Linux Successful" (1999). }~ ={Garfinkel, Simson;GNU Project:kernel;Wired magazine:GNU Project and} % ={Chassell, Robert} @@ -1673,7 +1672,7 @@ Stallman cites a number of issues when explaining the delay. The Lotus and Apple "I figured, OK, the [Mach] part that has to talk to the machine has already been debugged," Stallman says, recalling the HURD team's troubles in a 2000 speech. "With that head start, we should be able to get it done faster. But instead, it turned out that debugging these asynchronous multithreaded programs was really hard. There were timing books that would clobber the files, and that's no fun. The end result was that it took many, many years to produce a test version."~{ See Maui High Performance Computing Center Speech. }~ -Whatever the excuse, or excuses, the concurrent success of the Linux-kernel team created a tense situation. Sure, the Linux kernel had been licensed under the GPL, but as Murdock himself had noted, the desire to treat Linux as a purely free software operating system was far from uniform. By late 1993, the total Linux user population had grown from a dozen or so Minix enthusiasts to somewhere between 20,000 and 100,000.~{ GNU/Linux user-population numbers are sketchy at best, which is why I've provided such a broad range. The 100,000 total comes from the Red Hat "Milestones" site,
    http://www.redhat.com/about/corporate/milestones.html }~ What had once been a hobby was now a marketplace ripe for exploitation. Like Winston Churchill watching Soviet troops sweep into Berlin, Stallman felt an understandable set of mixed emotions when it came time to celebrate the Linux "victory."~{ I wrote this Winston Churchill analogy before Stallman himself sent me his own unsolicited comment on Churchill:
    _1 World War II and the determination needed to win it was a very strong memory as I was growing up. Statements such as Churchill's, "We will fight them in the landing zones, we will fight them on the beaches . . . we will never surrender," have always resonated for me. }~ +Whatever the excuse, or excuses, the concurrent success of the Linux-kernel team created a tense situation. Sure, the Linux kernel had been licensed under the GPL, but as Murdock himself had noted, the desire to treat Linux as a purely free software operating system was far from uniform. By late 1993, the total Linux user population had grown from a dozen or so Minix enthusiasts to somewhere between 20,000 and 100,000.~{ GNU/Linux user-population numbers are sketchy at best, which is why I've provided such a broad range. The 100,000 total comes from the Red Hat "Milestones" site, \\ http://www.redhat.com/about/corporate/milestones.html }~ What had once been a hobby was now a marketplace ripe for exploitation. Like Winston Churchill watching Soviet troops sweep into Berlin, Stallman felt an understandable set of mixed emotions when it came time to celebrate the Linux "victory."~{ I wrote this Winston Churchill analogy before Stallman himself sent me his own unsolicited comment on Churchill: \\ _1 World War II and the determination needed to win it was a very strong memory as I was growing up. Statements such as Churchill's, "We will fight them in the landing zones, we will fight them on the beaches . . . we will never surrender," have always resonated for me. }~ Although late to the party, Stallman still had clout. As soon as the FSF announced that it would lend its money and moral support to Murdock's software project, other offers of support began rolling in. Murdock dubbed the new project Debian-a compression of his and his wife, Deborah's, names-and within a few weeks was rolling out the first distribution. "[Richard's support] catapulted Debian almost overnight from this interesting little project to something people within the community had to pay attention to," Murdock says. ={Debian+19} @@ -1685,7 +1684,7 @@ In January of 1994, Murdock issued the " Debian Manifesto." Written in the spiri _1 The Free Software Foundation plays an extremely important role in the future of Debian. By the simple fact that they will be distributing it, a message is sent to the world that Linux is not a commercial product and that it never should be, but that this does not mean that Linux will never be able to compete commercially. For those of you who disagree, I challenge you to rationalize the success of GNU Emacs and GCC, which are not commercial software but which have had quite an impact on the commercial market regardless of that fact. -_1 The time has come to concentrate on the future of Linux rather than on the destructive goal of enriching oneself at the expense of the entire Linux community and its future. The development and distribution of Debian may not be the answer to the problems that I have outlined in the Manifesto, but I hope that it will at least attract enough attention to these problems to allow them to be solved.~{ See Ian Murdock, "A Brief History of Debian," (January 6, 1994): Appendix A, "The Debian Manifesto."
    http://www.debian.org/doc/manuals/project-history/apA.html }~ +_1 The time has come to concentrate on the future of Linux rather than on the destructive goal of enriching oneself at the expense of the entire Linux community and its future. The development and distribution of Debian may not be the answer to the problems that I have outlined in the Manifesto, but I hope that it will at least attract enough attention to these problems to allow them to be solved.~{ See Ian Murdock, "A Brief History of Debian," (January 6, 1994): Appendix A, "The Debian Manifesto." \\ http://www.debian.org/doc/manuals/project-history/apA.html }~ Shortly after the Manifesto's release, the Free Software Foundation made its first major request. Stallman wanted Murdock to call its distribution "GNU/Linux." At first, Murdock says, Stallman had wanted to use the term " Lignux"-"as in Linux with GNU at the heart of it"-but a sample testing of the term on Usenet and in various impromptu hacker focus groups had merited enough catcalls to convince Stallman to go with the less awkward GNU/Linux. ={Lignux (Linux with GNU)} @@ -1698,7 +1697,7 @@ The deepest split, Murdock says, was over glibc. Short for GNU C Library, glibc In the hacker world, forks are an interesting phenomenon. Although the hacker ethic permits a programmer to do anything he wants with a given program's source code, most hackers prefer to pour their innovations into a central source-code file or "tree" to ensure compatibility with other people's programs. To fork glibc this early in the development of Linux would have meant losing the potential input of hundreds, even thousands, of Linux developers. It would also mean growing incompatibility between Linux and the GNU system that Stallman and the GNU team still hoped to develop. ={forks (code)+3;tree (source code)} -As leader of the GNU Project, Stallman had already experienced the negative effects of a software fork in 1991. A group of Emacs developers working for a software company named Lucid had a falling out over Stallman's unwillingness to fold changes back into the GNU Emacs code base. The fork had given birth to a parallel version, Lucid Emacs, and hard feelings all around.~{ Jamie Zawinski, a former Lucid programmer who would go on to head the Mozilla development team, has a web site that documents the Lucid/GNU Emacs fork, titled, "The Lemacs/FSFmacs Schism."
    http://www.jwz.org/doc/lemacs.html }~ +As leader of the GNU Project, Stallman had already experienced the negative effects of a software fork in 1991. A group of Emacs developers working for a software company named Lucid had a falling out over Stallman's unwillingness to fold changes back into the GNU Emacs code base. The fork had given birth to a parallel version, Lucid Emacs, and hard feelings all around.~{ Jamie Zawinski, a former Lucid programmer who would go on to head the Mozilla development team, has a web site that documents the Lucid/GNU Emacs fork, titled, "The Lemacs/FSFmacs Schism." \\ http://www.jwz.org/doc/lemacs.html }~ ={Emacs text editor:Lucid software company and;GNU Emacs:Lucid software company and;Lucid software company} Murdock says Debian was mounting work on a similar fork in glibc source code that motivated Stallman to insist on adding the GNU prefix when Debian rolled out its software distribution. "The fork has since converged. Still, at the time, there was a concern that if the Linux community saw itself as a different thing as the GNU community, it might be a force for disunity." @@ -1749,7 +1748,7 @@ Ready or not. In November , 1995, Peter Salus, a member of the Free Software Foundation and author of the 1994 book, A Quarter Century of Unix, issued a call for papers to members of the GNU Project's "system-discuss" mailing list. Salus, the conference's scheduled chairman, wanted to tip off fellow hackers about the upcoming Conference on Freely Redistributable Software in Cambridge, Massachusetts. Slated for February, 1996 and sponsored by the Free Software Foundation, the event promised to be the first engineering conference solely dedicated to free software and, in a show of unity with other free software programmers, welcomed papers on "any aspect of GNU, Linux, NetBSD, 386BSD, FreeBSD, Perl, Tcl/tk, and other tools for which the code is accessible and redistributable." Salus wrote: ={Free Software Foundation (FSF);FSF (Free Software Foundation);FreeBSD;Conference on Freely Redistributable Software+1;Linux;NetBSD;Perl programming language;386BSD;Salus, Peter+4} -_1 Over the past 15 years, free and low-cost software has become ubiquitous. This conference will bring together implementers of several different types of freely redistributable software and publishers of such software (on various media). There will be tutorials and refereed papers, as well as keynotes by Linus Torvalds and Richard Stallman.~{ See Peter Salus, "FYI-Conference on Freely Redistributable Software, 2/2, Cambridge" (1995) (archived by Terry Winograd).
    http://hci.stanford.edu/pcd-archives/pcd-fyi/1995/0078.html }~ +_1 Over the past 15 years, free and low-cost software has become ubiquitous. This conference will bring together implementers of several different types of freely redistributable software and publishers of such software (on various media). There will be tutorials and refereed papers, as well as keynotes by Linus Torvalds and Richard Stallman.~{ See Peter Salus, "FYI-Conference on Freely Redistributable Software, 2/2, Cambridge" (1995) (archived by Terry Winograd). \\ http://hci.stanford.edu/pcd-archives/pcd-fyi/1995/0078.html }~ One of the first people to receive Salus' email was conference committee member Eric S. Raymond. Although not the leader of a project or company like the various other members of the list, Raymond had built a tidy reputation within the hacker community as a major contributor to GNU Emacs and as editor of /{The New Hacker Dictionary}/, a book version of the hacking community's decade-old Jargon File. ={New Hacker Dictionary, The;Raymond, Eric:open source and+56} @@ -1758,7 +1757,7 @@ For Raymond, the 1996 conference was a welcome event. Active in the GNU Project Despite the falling out, Raymond remained active in the free software community. So much so that when Salus suggested a conference pairing Stallman and Torvalds as keynote speakers, Raymond eagerly seconded the idea. With Stallman representing the older, wiser contingent of ITS/Unix hackers and Torvalds representing the younger, more energetic crop of Linux hackers, the pairing indicated a symbolic show of unity that could only be beneficial, especially to ambitious younger (i.e., below 40) hackers such as Raymond. "I sort of had a foot in both camps," Raymond says. -By the time of the conference, the tension between those two camps had become palpable. Both groups had one thing in common, though: the conference was their first chance to meet the Finnish wunderkind in the flesh. Surprisingly, Torvalds proved himself to be a charming, affable speaker. Possessing only a slight Swedish accent, Torvalds surprised audience members with his quick, self-effacing wit.~{ Although Linus Torvalds is Finnish, his mother tongue is Swedish. "The Rampantly Unofficial Linus FAQ" offers a brief explanation:
    _1 Finland has a significant (about 6%) Swedish-speaking minority population. They call themselves "finlandssvensk" or "finlandssvenskar" and consider themselves Finns; many of their families have lived in Finland for centuries. Swedish is one of Finland's two official languages.
    http://tuxedo.org/~esr/faqs/linus/ }~ Even more surprising, says Raymond, was Torvalds' equal willingness to take potshots at other prominent hackers, including the most prominent hacker of all, Richard Stallman. By the end of the conference, Torvalds' half-hacker, half-slacker manner was winning over older and younger conference-goers alike. +By the time of the conference, the tension between those two camps had become palpable. Both groups had one thing in common, though: the conference was their first chance to meet the Finnish wunderkind in the flesh. Surprisingly, Torvalds proved himself to be a charming, affable speaker. Possessing only a slight Swedish accent, Torvalds surprised audience members with his quick, self-effacing wit.~{ Although Linus Torvalds is Finnish, his mother tongue is Swedish. "The Rampantly Unofficial Linus FAQ" offers a brief explanation: \\ _1 Finland has a significant (about 6%) Swedish-speaking minority population. They call themselves "finlandssvensk" or "finlandssvenskar" and consider themselves Finns; many of their families have lived in Finland for centuries. Swedish is one of Finland's two official languages. \\ http://tuxedo.org/~esr/faqs/linus/ }~ Even more surprising, says Raymond, was Torvalds' equal willingness to take potshots at other prominent hackers, including the most prominent hacker of all, Richard Stallman. By the end of the conference, Torvalds' half-hacker, half-slacker manner was winning over older and younger conference-goers alike. "It was a pivotal moment," recalls Raymond. "Before 1996, Richard was the only credible claimant to being the ideological leader of the entire culture. People who dissented didn't do so in public. The person who broke that taboo was Torvalds." @@ -1776,7 +1775,7 @@ As a former GNU Project member, Raymond sensed an added dynamic to the tension b For Raymond, the defection merely confirmed a growing suspicion: recent delays such as the HURD and recent troubles such as the Lucid-Emacs schism reflected problems normally associated with software project management, not software code development. Shortly after the Freely Redistributable Software Conference, Raymond began working on his own pet software project, a popmail utility called "fetchmail." Taking a cue from Torvalds, Raymond issued his program with a tacked-on promise to update the source code as early and as often as possible. When users began sending in bug reports and feature suggestions, Raymond, at first anticipating a tangled mess, found the resulting software surprisingly sturdy. Analyzing the success of the Torvalds approach, Raymond issued a quick analysis: using the Internet as his "petri dish" and the harsh scrutiny of the hacker community as a form of natural selection, Torvalds had created an evolutionary model free of central planning. ={fetchmail;FreeBSD;Conference on Freely Redistributable Software;Internet} -What's more, Raymond decided, Torvalds had found a way around Brooks' Law. First articulated by Fred P. Brooks, manager of IBM's OS/360 project and author of the 1975 book, The Mythical Man-Month, Brooks' Law held that adding developers to a project only resulted in further project delays. Believing as most hackers that software, like soup, benefits from a limited number of cooks, Raymond sensed something revolutionary at work. In inviting more and more cooks into the kitchen, Torvalds had actually found away to make the resulting software better.~{ Brooks' Law is the shorthand summary of the following quote taken from Brooks' book:
    _1 Since software construction is inherently a systems effort-an exercise in complex interrelationships-communication effort is great, and it quickly dominates the decrease in individual task time brought about by partitioning. Adding more men then lengthens, not shortens, the schedule.
    See Fred P. Brooks, The Mythical Man-Month (Addison Wesley Publishing, 1995) }~ +What's more, Raymond decided, Torvalds had found a way around Brooks' Law. First articulated by Fred P. Brooks, manager of IBM's OS/360 project and author of the 1975 book, The Mythical Man-Month, Brooks' Law held that adding developers to a project only resulted in further project delays. Believing as most hackers that software, like soup, benefits from a limited number of cooks, Raymond sensed something revolutionary at work. In inviting more and more cooks into the kitchen, Torvalds had actually found away to make the resulting software better.~{ Brooks' Law is the shorthand summary of the following quote taken from Brooks' book: \\ _1 Since software construction is inherently a systems effort-an exercise in complex interrelationships-communication effort is great, and it quickly dominates the decrease in individual task time brought about by partitioning. Adding more men then lengthens, not shortens, the schedule. \\ See Fred P. Brooks, The Mythical Man-Month (Addison Wesley Publishing, 1995) }~ ={Brooks, Fred P.;Mythical Man-Month, The (Brooks)} Raymond put his observations on paper. He crafted them into a speech, which he promptly delivered before a group of friends and neighbors in Chester County, Pennsylvania. Dubbed " The Cathedral and the Bazaar," the speech contrasted the management styles of the GNU Project with the management style of Torvalds and the kernel hackers. Raymond says the response was enthusiastic, but not nearly as enthusiastic as the one he received during the 1997 Linux Kongress, a gathering of Linux users in Germany the next spring. @@ -1814,7 +1813,7 @@ While in California, Raymond also managed to squeeze in a visit to VA Research, Peterson, whose organization had taken an active interest in advancing the free software cause, offered an alternative: open source. -Looking back, Peterson says she came up with the open source term while discussing Netscape's decision with a friend in the public relations industry. She doesn't remember where she came upon the term or if she borrowed it from another field, but she does remember her friend disliking the term.~{ See Malcolm Maclachlan, "Profit Motive Splits Open Source Movement," TechWeb News (August 26, 1998).
    http://content.techweb.com/wire/story/TWB19980824S0012 }~ +Looking back, Peterson says she came up with the open source term while discussing Netscape's decision with a friend in the public relations industry. She doesn't remember where she came upon the term or if she borrowed it from another field, but she does remember her friend disliking the term.~{ See Malcolm Maclachlan, "Profit Motive Splits Open Source Movement," TechWeb News (August 26, 1998). \\ http://content.techweb.com/wire/story/TWB19980824S0012 }~ At the meeting, Peterson says, the response was dramatically different. "I was hesitant about suggesting it," Peterson recalls. "I had no standing with the group, so started using it casually, not highlighting it as a new term." To Peterson's surprise, the term caught on. By the end of the meeting, most of the attendees, including Raymond, seemed pleased by it. @@ -1871,7 +1870,7 @@ http://www.opensource.org/docs/definition.html }~ Perens would later resign from the OSI, expressing regret that the organization had set itself up in opposition to Stallman and the FSF. Still, looking back on the need for a free software definition outside the Free Software Foundation's auspices, Perens understands why other hackers might still feel the need for distance. "I really like and admire Richard," says Perens. "I do think Richard would do his job better if Richard had more balance. That includes going away from free software for a couple of months." -Stallman's monomaniacal energies would do little to counteract the public-relations momentum of open source proponents. In August of 1998, when chip-maker Intel purchased a stake in GNU/Linux vendor Red Hat, an accompanying New York Times article described the company as the product of a movement "known alternatively as free software and open source."~{ See Amy Harmon, "For Sale: Free Operating System," New York Times (September 28, 1998).
    http://www.nytimes.com/library/tech/98/09/biztech/articles/28linux.html }~ Six months later, a John Markoff article on Apple Computer was proclaiming the company's adoption of the "open source" Apache server in the article headline.~{ See John Markoff, "Apple Adopts `Open Source' for its Server Computers," New York Times (March 17, 1999).
    http://www.nytimes.com/library/tech/99/03/biztech/articles/17apple.html }~ +Stallman's monomaniacal energies would do little to counteract the public-relations momentum of open source proponents. In August of 1998, when chip-maker Intel purchased a stake in GNU/Linux vendor Red Hat, an accompanying New York Times article described the company as the product of a movement "known alternatively as free software and open source."~{ See Amy Harmon, "For Sale: Free Operating System," New York Times (September 28, 1998). \\ http://www.nytimes.com/library/tech/98/09/biztech/articles/28linux.html }~ Six months later, a John Markoff article on Apple Computer was proclaiming the company's adoption of the "open source" Apache server in the article headline.~{ See John Markoff, "Apple Adopts `Open Source' for its Server Computers," New York Times (March 17, 1999). \\ http://www.nytimes.com/library/tech/99/03/biztech/articles/17apple.html }~ ={Apache web server;Apple Computers:open source software and;Intel;Markoff, John;Red Hat Inc.:success of+1} Such momentum would coincide with the growing momentum of companies that actively embraced the "open source" term. By August of 1999, Red Hat, a company that now eagerly billed itself as "open source," was selling shares on Nasdaq. In December, VA Linux-formerly VA Research-was floating its own IPO to historical effect. Opening at $30 per share, the company's stock price exploded past the $300 mark in initial trading only to settle back down to the $239 level. Shareholders lucky enough to get in at the bottom and stay until the end experienced a 698% increase in paper wealth, a Nasdaq record. @@ -1881,7 +1880,7 @@ Such momentum would coincide with the growing momentum of companies that activel Among those lucky shareholders was Eric Raymond, who, as a company board member since the Mozilla launch, had received 150,000 shares of VA Linux stock. Stunned by the realization that his essay contrasting the Stallman-Torvalds managerial styles had netted him $36 million in potential wealth, Raymond penned a follow-up essay. In it, Raymond mused on the relationship between the hacker ethic and monetary wealth: -_1 Reporters often ask me these days if I think the open-source community will be corrupted by the influx of big money. I tell them what I believe, which is this: commercial demand for programmers has been so intense for so long that anyone who can be seriously distracted by money is already gone. Our community has been self-selected for caring about other things-accomplishment, pride, artistic passion, and each other.~{ See Eric Raymond, "Surprised by Wealth," Linux Today (December 10, 1999).
    http://linuxtoday.com/news_story.php3?ltsn=1999-12-10-001-05-NW-LF }~ +_1 Reporters often ask me these days if I think the open-source community will be corrupted by the influx of big money. I tell them what I believe, which is this: commercial demand for programmers has been so intense for so long that anyone who can be seriously distracted by money is already gone. Our community has been self-selected for caring about other things-accomplishment, pride, artistic passion, and each other.~{ See Eric Raymond, "Surprised by Wealth," Linux Today (December 10, 1999). \\ http://linuxtoday.com/news_story.php3?ltsn=1999-12-10-001-05-NW-LF }~ Whether or not such comments allayed suspicions that Raymond and other open source proponents had simply been in it for the money, they drove home the open source community's ultimate message: all you needed to sell the free software concept is a friendly face and a sensible message. Instead of fighting the marketplace head-on as Stallman had done, Raymond, Torvalds, and other new leaders of the hacker community had adopted a more relaxed approach-ignoring the marketplace in some areas, leveraging it in others. Instead of playing the role of high-school outcasts, they had played the game of celebrity, magnifying their power in the process. @@ -2118,7 +2117,7 @@ During my research, I came across an essay titled "Freedom-Or Copyright?" Writte % additional reference to the Digital Millenium Copyright Act -_1 We still have the same old freedoms in using paper books. But if e-books replace printed books, that exception will do little good. With "electronic ink," which makes it possible to download new text onto an apparently printed piece of paper, even newspapers could become ephemeral. Imagine: no more used book stores; no more lending a book to your friend; no more borrowing one from the public library-no more "leaks" that might give someone a chance to read without paying. (And judging from the ads for Microsoft Reader, no more anonymous purchasing of books either.) This is the world publishers have in mind for us.~{ See "Safari Tech Books Online; Subscriber Agreement: Terms of Service."
    http://safari.oreilly.com/mainhlp.asp?help=service }~ +_1 We still have the same old freedoms in using paper books. But if e-books replace printed books, that exception will do little good. With "electronic ink," which makes it possible to download new text onto an apparently printed piece of paper, even newspapers could become ephemeral. Imagine: no more used book stores; no more lending a book to your friend; no more borrowing one from the public library-no more "leaks" that might give someone a chance to read without paying. (And judging from the ads for Microsoft Reader, no more anonymous purchasing of books either.) This is the world publishers have in mind for us.~{ See "Safari Tech Books Online; Subscriber Agreement: Terms of Service." \\ http://safari.oreilly.com/mainhlp.asp?help=service }~ Needless to say, the essay caused some concern. Neither Tracy nor I had discussed the software her company would use nor had we discussed the type of copyright that would govern the e-book's usage. I mentioned the Technology Review article and asked if she could give me information on her company's e-book policies. Tracy promised to get back to me. @@ -2209,9 +2208,9 @@ In July, a full year after the original email from Tracy, I got a call from Henn Sure enough, the issue did come up. I learned through Henning that O'Reilly intended to publish the biography both as a book and as part of its new Safari Tech Books Online subscription service. The Safari user license would involve special restrictions,1 Henning warned, but O'Reilly was willing to allow for a copyright that permitted users to copy and share and the book's text regardless of medium. Basically, as author, I had the choice between two licenses: the Open Publication License or the GNU Free Documentation License. ={Open Publication License (OPL)+8;OPL (Open Publication License)+8;Safari Tech Books Online subscription service} -I checked out the contents and background of each license. The Open Publication License (OPL)~{ See "The Open Publication License: Draft v1.0" (June 8, 1999).
    http://opencontent.org/openpub/ }~ gives readers the right to reproduce and distribute a work, in whole or in part, in any medium "physical or electronic," provided the copied work retains the Open Publication License. It also permits modification of a work, provided certain conditions are met. Finally, the Open Publication License includes a number of options, which, if selected by the author, can limit the creation of "substantively modified" versions or book-form derivatives without prior author approval. +I checked out the contents and background of each license. The Open Publication License (OPL)~{ See "The Open Publication License: Draft v1.0" (June 8, 1999). \\ http://opencontent.org/openpub/ }~ gives readers the right to reproduce and distribute a work, in whole or in part, in any medium "physical or electronic," provided the copied work retains the Open Publication License. It also permits modification of a work, provided certain conditions are met. Finally, the Open Publication License includes a number of options, which, if selected by the author, can limit the creation of "substantively modified" versions or book-form derivatives without prior author approval. -The GNU Free Documentation License (GFDL),~{ See "The GNU Free Documentation License: Version 1.1" (March, 2000).
    http://www.gnu.org/copyleft/fdl.html }~ meanwhile, permits the copying and distribution of a document in any medium, provided the resulting work carries the same license. It also permits the modification of a document provided certain conditions. Unlike the OPL, however, it does not give authors the option to restrict certain modifications. It also does not give authors the right to reject modifications that might result in a competitive book product. It does require certain forms of front- and back-cover information if a party other than the copyright holder wishes to publish more than 100 copies of a protected work, however. +The GNU Free Documentation License (GFDL),~{ See "The GNU Free Documentation License: Version 1.1" (March, 2000). \\ http://www.gnu.org/copyleft/fdl.html }~ meanwhile, permits the copying and distribution of a document in any medium, provided the resulting work carries the same license. It also permits the modification of a document provided certain conditions. Unlike the OPL, however, it does not give authors the option to restrict certain modifications. It also does not give authors the right to reject modifications that might result in a competitive book product. It does require certain forms of front- and back-cover information if a party other than the copyright holder wishes to publish more than 100 copies of a protected work, however. ={GFDL (GNU Free Documentation License)+1;GNU Free Documentation License (GFDL)+1} In the course of researching the licenses, I also made sure to visit the GNU Project web page titled "Various Licenses and Comments About Them."~{ See http://www.gnu.org/philosophy/license-list.html }~ On that page, I found a Stallman critique of the Open Publication License. Stallman's critique related to the creation of modified works and the ability of an author to select either one of the OPL's options to restrict modification. If an author didn't want to select either option, it was better to use the GFDL instead, Stallman noted, since it minimized the risk of the nonselected options popping up in modified versions of a document. diff --git a/data/doc/sisu/markup-samples/v3/samples/free_as_in_freedom_2.richard_stallman_and_the_free_software_revolution.sam_williams.richard_stallman.sst b/data/doc/sisu/markup-samples/v3/samples/free_as_in_freedom_2.richard_stallman_and_the_free_software_revolution.sam_williams.richard_stallman.sst index 43d64ab4..4b040a75 100644 --- a/data/doc/sisu/markup-samples/v3/samples/free_as_in_freedom_2.richard_stallman_and_the_free_software_revolution.sam_williams.richard_stallman.sst +++ b/data/doc/sisu/markup-samples/v3/samples/free_as_in_freedom_2.richard_stallman_and_the_free_software_revolution.sam_williams.richard_stallman.sst @@ -14,19 +14,19 @@ :license: Published under the GNU Free Documentation License. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License." @classify: - :topic_register: SiSU:markup sample:book;copyright;GNU/Linux:GPL|copyleft|free software;free software;Software:Software Libré;GPL;Linux:GNU|Software Libré;book:biography;programming + :topic_register: SiSU markup sample:book:biography;book:biography;copyright;GNU/Linux:GPL|copyleft|free software;free software;Software:Software Libré;GPL;Linux:GNU|Software Libré;programming @links: - {Home and Source}http://faifzilla.org/ - {@ Wikipedia}http://en.wikipedia.org/wiki/Free_as_in_Freedom:_Richard_Stallman%27s_Crusade_for_Free_Software - {@ Amazon.com}http://www.amazon.com/gp/product/0596002874 - {@ Barnes & Noble}http://search.barnesandnoble.com/booksearch/isbnInquiry.asp?isbn=0596002874 - {SiSU}http://sisudoc.org/ - {sources / git}http://sources.sisudoc.org/ + { Home and Source }http://faifzilla.org/ + { @ Wikipedia }http://en.wikipedia.org/wiki/Free_as_in_Freedom:_Richard_Stallman%27s_Crusade_for_Free_Software + { @ Amazon.com }http://www.amazon.com/gp/product/0596002874 + { @ Barnes & Noble }http://search.barnesandnoble.com/booksearch/isbnInquiry.asp?isbn=0596002874 + { SiSU }http://sisudoc.org/ + { sources / git }http://sources.sisudoc.org/ @make: - :skin: skin_rms2 :breaks: new=:A,:B,:C,1 + :skin: skin_rms2 % http://static.fsf.org/nosvn/faif-2.0.pdf % http://www.scribd.com/doc/55232810/Free-as-in-Freedom-Richard-Stallman diff --git a/data/doc/sisu/markup-samples/v3/sisu_manual/sisu_description.sst b/data/doc/sisu/markup-samples/v3/sisu_manual/sisu_description.sst index 9060160a..ec16f4f6 100644 --- a/data/doc/sisu/markup-samples/v3/sisu_manual/sisu_description.sst +++ b/data/doc/sisu/markup-samples/v3/sisu_manual/sisu_description.sst @@ -39,7 +39,7 @@ :breaks: new=C; break=1 :skin: skin_sisu :bold: /Debian|Ruby|SiSU|ocn|object citation numbering|granular search|rant|utf-?8|WARNING/ - :italics: /Linux|FreeBSD|Dragonfly|Perl|LaTeX|Postgresql|PostgreSQL|Postgres|sqlite|SQL|PHP|xml|XML|Ion|g?vim|ascii|pdf|xhtml|pdflatex|pgsql|Postscript|texinfo|metadata|metatags|metaverse|rant|rake|YAML|object citation system|ocn|object citation numbering|granular search|Dublin Core|Lex Mercatoria|Project Gutenberg|Slashdot/i + :italics: /Linux|FreeBSD|Dragonfly|Perl|LaTeX|Postgresql|PostgreSQL|Postgres|sqlite|SQL|PHP|xml|XML|Ion|g?vim|ascii|pdf|xhtml|pdflatex|pgsql|Postscript|texinfo|metadata|metatags|metaverse|rant|rake|YAML|object citation system|ocn|object citation numbering|granular search|Dublin Core|Lex Mercatoria/i :A~? @title @creator 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 ddc0a3d4..e3fbb226 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 @@ -247,7 +247,6 @@ code{ :isbn: [ISBN] :loc: [Library of Congress classification] :dewey: [Dewey classification - :pg: [Project Gutenberg text number] }code diff --git a/data/doc/sisu/markup-samples/v4/samples/_sisu/sisu_document_make b/data/doc/sisu/markup-samples/v4/samples/_sisu/sisu_document_make new file mode 100644 index 00000000..85e583e1 --- /dev/null +++ b/data/doc/sisu/markup-samples/v4/samples/_sisu/sisu_document_make @@ -0,0 +1,9 @@ +@make: + :breaks: break=1 + :home_button_text: {SiSU}http://sisudoc.org; {sources / git}http://sources.sisudoc.org/ +% :footer: {SiSU}http://sisudoc.org; {sources / git}http://sources.sisudoc.org/ +% :home_button_image: {sisu.png }http://sisudoc.org + +@links:+ + {SiSU}http://sisudoc.org + {sources / git}http://sources.sisudoc.org/ diff --git a/data/doc/sisu/markup-samples/v4/samples/free_as_in_freedom.richard_stallman_crusade_for_free_software.sam_williams.sst b/data/doc/sisu/markup-samples/v4/samples/free_as_in_freedom.richard_stallman_crusade_for_free_software.sam_williams.sst index 97bc59c0..2d38902a 100644 --- a/data/doc/sisu/markup-samples/v4/samples/free_as_in_freedom.richard_stallman_crusade_for_free_software.sam_williams.sst +++ b/data/doc/sisu/markup-samples/v4/samples/free_as_in_freedom.richard_stallman_crusade_for_free_software.sam_williams.sst @@ -25,11 +25,12 @@ { @ Wikipedia }http://en.wikipedia.org/wiki/Free_as_in_Freedom:_Richard_Stallman%27s_Crusade_for_Free_Software { @ Amazon.com }http://www.amazon.com/gp/product/0596002874 { @ Barnes & Noble }http://search.barnesandnoble.com/booksearch/isbnInquiry.asp?isbn=0596002874 - { SiSU }http://sisudoc.org/ - { sources / git }http://sources.sisudoc.org/ @make: :breaks: new=:A,:B,:C,1 + :home_button_image: {free_as_in_freedom.png }http://stallman.org/ + :home_button_text: {Free as in Freedom}http://stallman.org/; {Free Software Foundation}http://www.fsf.org + :footer: {Free as in Freedom}http://stallman.org/; {Free Software Foundation}http://www.fsf.org :A~ @title @author diff --git a/data/doc/sisu/markup-samples/v4/samples/free_as_in_freedom_2.richard_stallman_and_the_free_software_revolution.sam_williams.richard_stallman.sst b/data/doc/sisu/markup-samples/v4/samples/free_as_in_freedom_2.richard_stallman_and_the_free_software_revolution.sam_williams.richard_stallman.sst index f071971e..c99cb10e 100644 --- a/data/doc/sisu/markup-samples/v4/samples/free_as_in_freedom_2.richard_stallman_and_the_free_software_revolution.sam_williams.richard_stallman.sst +++ b/data/doc/sisu/markup-samples/v4/samples/free_as_in_freedom_2.richard_stallman_and_the_free_software_revolution.sam_williams.richard_stallman.sst @@ -17,15 +17,15 @@ :topic_register: SiSU markup sample:book:biography;book:biography;copyright;GNU/Linux:GPL|copyleft|free software;free software;Software:Software Libré;GPL;Linux:GNU|Software Libré;programming @links: - {Home and Source}http://faifzilla.org/ - {@ Wikipedia}http://en.wikipedia.org/wiki/Free_as_in_Freedom:_Richard_Stallman%27s_Crusade_for_Free_Software - {@ Amazon.com}http://www.amazon.com/gp/product/0596002874 - {@ Barnes & Noble}http://search.barnesandnoble.com/booksearch/isbnInquiry.asp?isbn=0596002874 - {CONTENT, Cory Doctorow @ SiSU}http://www.jus.uio.no/sisu/content.cory_doctorow - {Little Brother, Cory Doctorow @ SiSU}http://www.jus.uio.no/sisu/little_brother.cory_doctorow + { Home and Source }http://faifzilla.org/ + { @ Wikipedia }http://en.wikipedia.org/wiki/Free_as_in_Freedom:_Richard_Stallman%27s_Crusade_for_Free_Software + { @ Amazon.com }http://www.amazon.com/gp/product/0596002874 + { @ Barnes & Noble }http://search.barnesandnoble.com/booksearch/isbnInquiry.asp?isbn=0596002874 @make: :breaks: new=:A,:B,:C,1 + :home_button_text: {Free as in Freedom 2.0}http://stallman.org/; {Free Software Foundation}http://www.fsf.org + :footer: {Free as in Freedom 2.0}http://stallman.org/; {Free Software Foundation}http://www.fsf.org % http://static.fsf.org/nosvn/faif-2.0.pdf % http://www.scribd.com/doc/55232810/Free-as-in-Freedom-Richard-Stallman 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 new file mode 100644 index 00000000..17c6bbf8 --- /dev/null +++ b/data/doc/sisu/markup-samples/v4/sisu_manual/_sisu/sisu_document_make @@ -0,0 +1,20 @@ +@make: + :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/ + :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 + +@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 diff --git a/data/doc/sisu/markup-samples/v4/sisu_manual/sisu.ssm b/data/doc/sisu/markup-samples/v4/sisu_manual/sisu.ssm index b3b3ae58..79703fef 100644 --- a/data/doc/sisu/markup-samples/v4/sisu_manual/sisu.ssm +++ b/data/doc/sisu/markup-samples/v4/sisu_manual/sisu.ssm @@ -21,23 +21,8 @@ :topic_register: SiSU:manual;electronic documents:SiSU:manual :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 - :bold: /Gnu|Debian|Ruby|SiSU/ - :manpage: name=sisu - documents: markup, structuring, publishing in multiple standard formats, and search; synopsis=sisu [-abCcDdeFGghIikLMmNnoPpQqRrSsTtUuVvWwXxYyZ_0-9] [filename/wildcard] . sisu [-Ddcv] [instruction] [filename/wildcard] . sisu [-CcFLSVvW] . sisu [operations] . sisu --v4 [operations] . sisu --v3 [operations] . sisu2 [operations] + :manpage: name=sisu - documents: markup, structuring, publishing in multiple standard formats, and search; synopsis=sisu [-short-options|--long-options] [filename/wildcard] . sisu [-abCcDdeFGghIikLMmNnoPpQqRrSsTtUuVvWwXxYyZ_0-9] [filename/wildcard] . sisu --txt --html --epub --odt --pdf --wordmap --sqlite --manpage --texinfo --sisupod --source --qrcode [filename/wildcard] . sisu [-Ddcv] [instruction] [filename/wildcard] . sisu --pg (--createdb|update [filename/wildcard]|--dropall) . sisu [operations] . sisu [-CcFLSVvW] . sisu (--configure|--webrick|--sample-search-form) :A~ @title @creator @@ -85,14 +70,4 @@ << sisu_webrick.sst -<< sisu_remote.sst - -<< sisu_quickstart.sst - -<< sisu_syntax_highlighting.sst - -<< sisu_how.ssi - << sisu_short_feature_summary.ssi - -<< sisu_help_sources.sst diff --git a/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_commands.sst b/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_commands.sst index 068942b5..0f3c0b8e 100644 --- a/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_commands.sst +++ b/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_commands.sst @@ -21,23 +21,6 @@ :topic_register: electronic documents:SiSU:document:commands;SiSU:manual:commands;electronic documents:SiSU:manual:commands;SiSU:document:commands;SiSU:document:commands :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 - :bold: /Gnu|Debian|Ruby|SiSU/ - :A~? @title @creator :B~? SiSU Commands @@ -377,9 +360,12 @@ strips output text of editor endnotes~[+ square brackets ]~ denoted by dagger/pl 1~commands_database database commands -dbi - database interface +!_ 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)] +!_ -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 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 'createdb [database name]' where database name would be SiSU_[present working directory name (without path)]. Please use only alphanumerics and underscores. diff --git a/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_config.ssi b/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_config.ssi index 853580b3..3c29f995 100644 --- a/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_config.ssi +++ b/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_config.ssi @@ -11,7 +11,7 @@ :created: 2002-08-28 :issued: 2002-08-28 :available: 2002-08-28 - :modified: 2011-02-07 + :modified: 2011-12-12 @rights: :copyright: Copyright (C) Ralph Amissah 2007 @@ -23,19 +23,9 @@ 1~config Configuration -2~ Determining the Current Configuration +2~ Configuration files -Information on the current configuration of SiSU should be available with the help command: - -_1 sisu -v - -which is an alias for: - -_1 sisu --help env - -Either of these should be executed from within a directory that contains sisu markup source documents. - -2~ Configuration files (config.yml) +3~ 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. @@ -43,10 +33,16 @@ The SiSU configuration file is a yaml file, which means indentation is significa SiSU resource configuration is determined by looking at the following files if they exist: +_1 ./_sisu/v4/sisurc.yml + _1 ./_sisu/sisurc.yml +_1 ~/.sisu/v4/sisurc.yml + _1 ~/.sisu/sisurc.yml +_1 /etc/sisu/v4/sisurc.yml + _1 /etc/sisu/sisurc.yml The search is in the order listed, and the first one found is used. @@ -57,3 +53,23 @@ Configuration determines the output and processing directories and the database If SiSU is installed a sample sisurc.yml may be found in /etc/sisu/sisurc.yml +3~ 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: + +_1 ./_sisu/v4/sisu_document_make + +_1 ./_sisu/sisu_document_make + +_1 ~/.sisu/v4/sisu_document_make + +_1 ~/.sisu/sisu_document_make + +_1 /etc/sisu/v4/sisu_document_make + +_1 /etc/sisu/sisu_document_make + +A sample sisu_document_make can be found in the _sisu/ directory under along with the provided sisu markup samples. + diff --git a/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_description.sst b/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_description.sst index 06a630e8..9f8fdcd8 100644 --- a/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_description.sst +++ b/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_description.sst @@ -21,24 +21,6 @@ :topic_register: electronic documents;SiSU:document:description;sisu:document:description :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 - :bold: /Debian|Ruby|SiSU|ocn|object citation numbering|granular search|rant|utf-?8|WARNING/ - :italics: /Linux|FreeBSD|Dragonfly|Perl|LaTeX|Postgresql|PostgreSQL|Postgres|sqlite|SQL|Reiserfs|PHP|xml|XML|Ion|g?vim|ascii|pdf|xhtml|pdflatex|pgsql|Postscript|texinfo|metadata|metatags|metaverse|rant|rake|YAML|object citation system|ocn|object citation numbering|granular search|Dublin Core|Lex Mercatoria|Project Gutenberg|Slashdot/i - :A~? @title @creator :B~? SiSU an attempt to describe diff --git a/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_examples.ssi b/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_examples.ssi index ebe4c1ea..cf9df9d5 100644 --- a/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_examples.ssi +++ b/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_examples.ssi @@ -17,9 +17,9 @@ :copyright: Copyright (C) Ralph Amissah 2007 :license: GPL 3 (part of SiSU documentation) -:A~? @title @creator +A~? @title @creator -:B~? SiSU Markup and Output Examples +B~? SiSU Markup and Output Examples 1~examples Markup and Output Examples @@ -28,3 +28,70 @@ Current markup examples and document output samples are provided off http://sisudoc.org or http://www.jus.uio.no/sisu 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. + +2~sisu-markup-samples SiSU Markup Samples + +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 licences that do not permit inclusion in the Debian Project as they have requirements that do not meet the 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. + +/{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 + +/{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 (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}/, 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 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 + +/{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.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 + +/{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 + +/{Viral Spiral}/, David Bollier (2008) \\ +viral_spiral.david_bollier.sst diff --git a/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_faq.sst b/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_faq.sst index 333023eb..966cea5f 100644 --- a/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_faq.sst +++ b/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_faq.sst @@ -21,23 +21,6 @@ :topic_register: electronic documents;SiSU:document:FAQ;sisu:document:FAQ;SiSU:manual:FAQ;electronic documents:SiSU:manual:FAQ :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 - :bold: /Gnu|Debian|Ruby|SiSU/ - :A~? @title @creator 1~faq FAQ - Frequently Asked/Answered Questions diff --git a/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_filetypes.sst b/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_filetypes.sst index e53c96f8..d36acac0 100644 --- a/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_filetypes.sst +++ b/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_filetypes.sst @@ -21,23 +21,6 @@ :topic_register: SiSU:manual:filetypes;electronic documents:SiSU:manual:filetypes :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 - :bold: /Gnu|Debian|Ruby|SiSU/ - :A~? @title @creator 1~filetypes SiSU filetypes @@ -58,10 +41,6 @@ _1 sisu -s [filename] The most common form of document in SiSU, see the section on SiSU markup. -http://www.sisudoc.org/sisu/sisu_markup - -http://www.sisudoc.org/sisu/sisu_manual - 3~ 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. @@ -72,10 +51,6 @@ Note: Master documents may be prepared in a similar way to regular documents, an Note: a secondary file of the composite document is built prior to processing with the same prefix and the suffix ._sst ~{ .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.sisudoc.org/sisu/sisu_markup - -http://www.sisudoc.org/sisu/sisu_manual - 3~ sisu insert files (.ssi) 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 the file should be processed on its own. @@ -102,67 +77,67 @@ http://www.sisudoc.org/sisu/sisu_commands http://www.sisudoc.org/sisu/sisu_manual -1~alt Experimental Alternative Input Representations - -2~ Alternative XML - -SiSU offers alternative XML input representations of documents as a proof of concept, experimental feature. They are however not strictly maintained, and incomplete and should be handled with care. - -!_ convert from sst to simple xml representations (sax, dom and node): - -_1 sisu --to-sax [filename/wildcard] or sisu --to-sxs [filename/wildcard] - -_1 sisu --to-dom [filename/wildcard] or sisu --to-sxd [filename/wildcard] - -_1 sisu --to-node [filename/wildcard] or sisu --to-sxn [filename/wildcard] - -!_ convert to sst from any sisu xml representation (sax, dom and node): - -_1 sisu --from-xml2sst [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]] - -or the same: - -_1 sisu --from-sxml [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]] - -3~ XML SAX representation - -To convert from sst to simple xml (sax) representation: - -_1 sisu --to-sax [filename/wildcard] or sisu --to-sxs [filename/wildcard] - -To convert from any sisu xml representation back to sst - -_1 sisu --from-xml2sst [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]] - -or the same: - -_1 sisu --from-sxml [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]] - -3~ XML DOM representation - -To convert from sst to simple xml (dom) representation: - -_1 sisu --to-dom [filename/wildcard] or sisu --to-sxd [filename/wildcard] - -To convert from any sisu xml representation back to sst - -_1 sisu --from-xml2sst [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]] - -or the same: - -_1 sisu --from-sxml [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]] - -3~ XML Node representation - -To convert from sst to simple xml (node) representation: - -_1 sisu --to-node [filename/wildcard] or sisu --to-sxn [filename/wildcard] - -To convert from any sisu xml representation back to sst - -_1 sisu --from-xml2sst [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]] - -or the same: - -_1 sisu --from-sxml [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]] +% 1~alt Experimental Alternative Input Representations +% +% 2~ Alternative XML +% +% SiSU offers alternative XML input representations of documents as a proof of concept, experimental feature. They are however not strictly maintained, and incomplete and should be handled with care. +% +% !_ convert from sst to simple xml representations (sax, dom and node): +% +% _1 sisu --to-sax [filename/wildcard] or sisu --to-sxs [filename/wildcard] +% +% _1 sisu --to-dom [filename/wildcard] or sisu --to-sxd [filename/wildcard] +% +% _1 sisu --to-node [filename/wildcard] or sisu --to-sxn [filename/wildcard] +% +% !_ convert to sst from any sisu xml representation (sax, dom and node): +% +% _1 sisu --from-xml2sst [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]] +% +% or the same: +% +% _1 sisu --from-sxml [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]] +% +% 3~ XML SAX representation +% +% To convert from sst to simple xml (sax) representation: +% +% _1 sisu --to-sax [filename/wildcard] or sisu --to-sxs [filename/wildcard] +% +% To convert from any sisu xml representation back to sst +% +% _1 sisu --from-xml2sst [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]] +% +% or the same: +% +% _1 sisu --from-sxml [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]] +% +% 3~ XML DOM representation +% +% To convert from sst to simple xml (dom) representation: +% +% _1 sisu --to-dom [filename/wildcard] or sisu --to-sxd [filename/wildcard] +% +% To convert from any sisu xml representation back to sst +% +% _1 sisu --from-xml2sst [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]] +% +% or the same: +% +% _1 sisu --from-sxml [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]] +% +% 3~ XML Node representation +% +% To convert from sst to simple xml (node) representation: +% +% _1 sisu --to-node [filename/wildcard] or sisu --to-sxn [filename/wildcard] +% +% To convert from any sisu xml representation back to sst +% +% _1 sisu --from-xml2sst [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]] +% +% or the same: +% +% _1 sisu --from-sxml [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]] diff --git a/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_help.sst b/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_help.sst index 99c0922a..ce6627b7 100644 --- a/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_help.sst +++ b/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_help.sst @@ -21,23 +21,6 @@ :topic_register: SiSU:manual:help;electronic documents:manual:SiSU:help :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 - :bold: /Gnu|Debian|Ruby|SiSU/ - :A~? @title @creator :B~? SiSU Help diff --git a/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_help_sources.sst b/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_help_sources.sst index a96e09cf..bee5ed78 100644 --- a/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_help_sources.sst +++ b/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_help_sources.sst @@ -21,23 +21,6 @@ :topic_register: SiSU:manual:help sources;electronic documents:SiSU:manual:help sources :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 - :bold: /Gnu|Debian|Ruby|SiSU/ - :A~? @title @creator :B~? SiSU Help Sources diff --git a/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_howto.sst b/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_howto.sst index 5e137eb4..dab3e8a4 100644 --- a/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_howto.sst +++ b/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_howto.sst @@ -21,23 +21,6 @@ :topic_register: SiSU:manual:howto;electronic documents:SiSU:manual:howto;SiSU:document:howto;sisu:document:howto :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 - :bold: /Gnu|Debian|Ruby|SiSU/ - :A~? @title @creator :B~? SiSU some technical information diff --git a/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_introduction.sst b/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_introduction.sst index 08b1578d..8978ace6 100644 --- a/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_introduction.sst +++ b/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_introduction.sst @@ -20,23 +20,6 @@ @classify: :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 - :bold: /Gnu|Debian|Ruby|SiSU/ - :A~? @title @creator :B~? What is SiSU? diff --git a/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_manual.ssm b/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_manual.ssm index 312e9286..90e8a323 100644 --- a/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_manual.ssm +++ b/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_manual.ssm @@ -21,23 +21,6 @@ :topic_register: SiSU:manual;electronic documents:SiSU:manual :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 - :bold: /Gnu|Debian|Ruby|SiSU/ - :A~ @title @creator :B~ What is SiSU? 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 7a10bb94..9027817a 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 @@ -21,23 +21,6 @@ :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 - :bold: /Gnu|Debian|Ruby|SiSU/i - :A~? @title @creator :B~? SiSU Markup @@ -146,6 +129,8 @@ code{ :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] @@ -241,13 +226,20 @@ code{ :description: :keywords: :abstract: - :isbn: [ISBN] :loc: [Library of Congress classification] :dewey: [Dewey classification - :pg: [Project Gutenberg text number] }code +code{ + +@identify: + :isbn: [ISBN] + :oclc: + +}code + + code{ @links: { SiSU }http://www.sisudoc.org @@ -265,6 +257,8 @@ code{ :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 @@ -1271,232 +1265,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/v4/sisu_manual/sisu_markup_syntax_history.sst b/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_markup_syntax_history.sst new file mode 100644 index 00000000..a5b56f1f --- /dev/null +++ b/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_markup_syntax_history.sst @@ -0,0 +1,260 @@ +% SiSU 4.0 + +@title: SiSU + :subtitle: Markup + +@creator: + :author: Amissah, Ralph + +@date: + :created: 2002-08-28 + :issued: 2002-08-28 + :available: 2002-08-28 + :published: 2008-05-22 + :modified: 2012-10-03 + +@rights: + :copyright: Copyright (C) Ralph Amissah 2007 + :license: GPL 3 (part of SiSU documentation) + +@classify: + :topic_register: electronic documents:SiSU:document:markup;SiSU:document:markup;SiSU:document:markup;SiSU:manual:markup;electronic documents:SiSU:manual:markup + :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +:A~? @title @creator + +:B~? SiSU Markup 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 + +4.0 introduced additional headers and drops the use of skins replacing them with additions to the @make: header, and having a common _sisu/sisu_document_make file that uses @make: header syntax to provide a default @make: (it will parse 2.0 but igore skins, markup is otherwise the same as version 2.0 with version 3.0's minor additions) + +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_output_overview.sst b/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_output_overview.sst index 7abe9f25..332f4aae 100644 --- a/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_output_overview.sst +++ b/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_output_overview.sst @@ -21,23 +21,6 @@ :topic_register: electronic documents:SiSU:document:markup table;SiSU:manual:output overview;electronic documents:SiSU:manual:output overview;SiSU:document:output overview;SiSU:document:output overview :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 -% :bold: /Gnu|Debian|Ruby|SiSU/ - :A~? @title @creator :B~? SiSU overview of status of features available in various outputs diff --git a/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_postgresql.sst b/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_postgresql.sst index 2bfc8c65..574e307c 100644 --- a/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_postgresql.sst +++ b/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_postgresql.sst @@ -21,22 +21,7 @@ :topic_register: electronic documents:SiSU:document:postgresql;SiSU:manual:postgresql;electronic documents:SiSU:manual:postgresql;SiSU:document:postgresql;SiSU:document:postgresql; :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 - :bold: /Gnu|Debian|Ruby|SiSU/ :manpage: section=7; name=sisu - package to install what sisu needs to to populate a postgresql database (postgresql dependency component); synopsis=sisu -Dv [filename/wildcard ]\n sisu -Dv [instruction] :A~? @title @creator diff --git a/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_quickstart.sst b/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_quickstart.sst index f62237e1..ae95f528 100644 --- a/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_quickstart.sst +++ b/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_quickstart.sst @@ -21,23 +21,6 @@ :topic_register: electronic documents:SiSU:document:quickstart;SiSU:manual:quickstart;electronic documents:SiSU:manual:quickstart;SiSU:document:quickstart;SiSU:document:quickstart :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 - :bold: /Gnu|Debian|Ruby|SiSU/ - :A~? @title @creator :B~? Quickstart - SiSU installation and use diff --git a/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_remote.sst b/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_remote.sst index ca2d4028..959fbcf6 100644 --- a/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_remote.sst +++ b/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_remote.sst @@ -21,23 +21,6 @@ :topic_register: electronic documents:SiSU:document:remote;SiSU:manual:remote;electronic documents:SiSU:manual:remote;SiSU:document:remote;SiSU:document:remote :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 - :bold: /Gnu|Debian|Ruby|SiSU/ - :A~? @title @creator :B~? SiSU Remote Operations diff --git a/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_search.ssm b/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_search.ssm index 5cfa539d..9c40a8bf 100644 --- a/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_search.ssm +++ b/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_search.ssm @@ -20,23 +20,6 @@ @classify: :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 - :bold: /Gnu|Debian|Ruby|SiSU/ - :A~? @title @creator :B~? SiSU Search diff --git a/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_search_intro.ssi b/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_search_intro.ssi index 22563bcd..d5da379f 100644 --- a/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_search_intro.ssi +++ b/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_search_intro.ssi @@ -17,11 +17,6 @@ :copyright: Copyright (C) Ralph Amissah 2007 :license: GPL 3 (part of SiSU documentation) -@make: - :num_top: 1 - :breaks: new=C; break=1 - :bold: /Gnu|Debian|Ruby|SiSU/ - :A~? @title @creator :B~? SiSU Search diff --git a/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_short_feature_summary.ssi b/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_short_feature_summary.ssi index c8099fb0..294644af 100644 --- a/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_short_feature_summary.ssi +++ b/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_short_feature_summary.ssi @@ -33,21 +33,21 @@ _* markup defines document structure (this may be done once in a header pattern- _* 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: -_1* html - both as a single scrollable text and a segmented document +_* HTML - both as a single scrollable text and a segmented document -_1* xhtml +_* XHTML -_1* epub +_* EPUB -_1* XML - both in sax and dom style xml structures for further development as required +_* XML - both in sax and dom style xml structures for further development as required -_1* ODF - open document format, the iso standard for document storage +_* ODT - Open Document Format text, the iso standard for document storage -_1* LaTeX - used to generate pdf +_* LaTeX - used to generate pdf -_1* pdf (via LaTeX) +_* PDF (via LaTeX) -_1* sql - population of an sql database, (at the same object level that is used to cite text within a document) +_* 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)) diff --git a/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_sqlite.sst b/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_sqlite.sst index 3e462cc1..a73ae16c 100644 --- a/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_sqlite.sst +++ b/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_sqlite.sst @@ -21,22 +21,7 @@ :topic_register: electronic documents:SiSU:document:sqlite;SiSU:manual:sqlite;electronic documents:SiSU:manual:sqlite;SiSU:document:sqlite;SiSU:document:sqlite :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 - :bold: /Gnu|Debian|Ruby|SiSU/ :manpage: section=7; name=sisu - package to install what sisu needs to to populate a postgresql database (postgresql dependency component); synopsis=sisu -dv [filename/wildcard ]\n sisu -dv [instruction] :A~? @title @creator diff --git a/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_syntax_highlighting.sst b/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_syntax_highlighting.sst index 21879106..12a70fb8 100644 --- a/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_syntax_highlighting.sst +++ b/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_syntax_highlighting.sst @@ -21,23 +21,6 @@ :topic_register: electronic documents:SiSU:document:syntax highlighting;SiSU:manual:syntax highlighting;electronic documents:SiSU:manual:syntax highlighting;SiSU:document:syntax highlighting;SiSU:document:syntax highlighting :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 - :bold: /Gnu|Debian|Ruby|SiSU/ - :A~? @title @creator :B~? SiSU Syntax Highlighting diff --git a/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_webrick.sst b/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_webrick.sst index b229ea9c..6e56e53a 100644 --- a/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_webrick.sst +++ b/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_webrick.sst @@ -21,22 +21,7 @@ :topic_register: electronic documents:SiSU:document:webrick;SiSU:manual:webrick;electronic documents:SiSU:manual:webrick;SiSU:document:webrick;SiSU:document:webrick :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 - :bold: /Gnu|Debian|Ruby|SiSU/ :manpage: section=7; name=sisu - documents: structuring, publishing in multiple formats, and search; synopsis=sisu -W :A~? @title @creator @@ -72,20 +57,3 @@ where no port is given and settings are unchanged the default port is 8081 2~ 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 been changed in ~/.sisu/sisurc.yaml then on port 8081 - -2~ Further information - -For more information on SiSU see: http://www.sisudoc.org/ or http://www.jus.uio.no/sisu - -or man sisu - -2~ Author - -Ralph Amissah ralph@amissah.com or ralph.amissah@gmail.com - -2~ SEE ALSO - -_1 sisu(1) - -_1 sisu_vim(7) - diff --git a/lib/sisu/v4/help.rb b/lib/sisu/v4/help.rb index 0ab87fdd..391e722d 100644 --- a/lib/sisu/v4/help.rb +++ b/lib/sisu/v4/help.rb @@ -158,7 +158,7 @@ module SiSU_Help end end def summary - print < old form end def example help_markup end def example_v1 - print < <#{@cX.blue}http://www.gnu.org/licenses/gpl.html#{@cX.off}> - <#{@cX.blue}http://www.jus.uio.no/sisu/gpl.fsf#{@cX.off}> * SiSU uses: * Standard SiSU markup syntax, @@ -1806,20 +1765,21 @@ WOK * Standard SiSU object citation numbering and system * Hompages: - <#{@cX.blue}http://www.jus.uio.no/sisu#{@cX.off}> <#{@cX.blue}http://www.sisudoc.org#{@cX.off}> + <#{@cX.blue}http://www.jus.uio.no/sisu#{@cX.off}> * Download: - <#{@cX.blue}http://www.jus.uio.no/sisu/SiSU/download.html#{@cX.off}> + <#{@cX.blue}http://sources.sisudoc.org#{@cX.off}> + <#{@cX.blue}http://www.jus.uio.no/sisu/en/html/SiSU/download.html#{@cX.off}> Ralph Amissah <#{@cX.blue}ralph@amissah.com#{@cX.off}> <#{@cX.blue}ralph.amissah@gmail.com#{@cX.off}> -WOK + WOK end def standards - print < More information to be provided later. @@ -1839,10 +1799,10 @@ More information to be provided later. * Ralph Amissah ralph@amissah.com Ralph Amissah ralph.amissah@gmail.com -WOK + WOK end def conversion - print < +.SH HOMEPAGE + More information about SiSU can be found at or .TP -at: <#{vz.url_site}> +.SH SOURCE + .TP -#{sc} -.TP -* #{generator} -.TP -* #{rubyv} -.TP -* #{lastdone} -.TP -* SiSU #{vz.url_sisu} +.SH AUTHOR + SiSU is written by Ralph Amissah WOK end def manpage_structure(dob='',hname='') #% Used to extract the structure of a document @@ -254,10 +259,10 @@ WOK @data_mod,@endnotes,@level,@cont,@copen,@manpage_contents_close=Array.new(6){[]} (0..6).each { |x| @cont[x]=@level[x]=false } (4..6).each { |x| @manpage_contents_close[x]='' } - manpage_tail #($1,$2) + #manpage_tail #stop call table_message='[table omitted, see other document formats]' fix=[] - manpage_metadata + #manpage_metadata data.each do |dob| if dob.is==:comment \ || dob.is==:heading_insert diff --git a/man/man1/sisu.1 b/man/man1/sisu.1 index 4f82611f..ccf359c0 100644 --- a/man/man1/sisu.1 +++ b/man/man1/sisu.1 @@ -1,30 +1,33 @@ -.TH "sisu" "1" "2012-11-05" "4.0.0" "SiSU" +.TH "sisu" "1" "2012-10-03" "4.0.0" "SiSU" .br .SH NAME .br sisu \- documents: markup, structuring, publishing in multiple standard formats, and search .br .SH SYNOPSIS +.br +sisu [\-short\-options|\-\-long\-options] [filename/wildcard] + .br sisu [\-abCcDdeFGghIikLMmNnoPpQqRrSsTtUuVvWwXxYyZ_0\-9] [filename/wildcard] .br -sisu [\-Ddcv] [instruction] [filename/wildcard] +sisu \-\-txt \-\-html \-\-epub \-\-odt \-\-pdf \-\-wordmap \-\-sqlite \-\-manpage \-\-texinfo \-\-sisupod \-\-source \-\-qrcode [filename/wildcard] .br -sisu [\-CcFLSVvW] +sisu [\-Ddcv] [instruction] [filename/wildcard] .br -sisu [operations] +sisu \-\-pg (\-\-createdb|update [filename/wildcard]|\-\-dropall) .br -sisu \-\-v3 [operations] +sisu [operations] .br -sisu \-\-v2 [operations] +sisu [\-CcFLSVvW] .br -sisu2 [operations] +sisu (\-\-configure|\-\-webrick|\-\-sample\-search\-form) .SH SISU \- MANUAL, RALPH AMISSAH .br @@ -32,7 +35,7 @@ RALPH AMISSAH .SH WHAT IS SISU? .br -.SH 1. INTRODUCTION \- WHAT IS SISU? +.SH INTRODUCTION \- WHAT IS SISU? .br .br @@ -47,11 +50,12 @@ text within a document. .br .B SiSU -is developed under an open source, software libre license (GPL3). 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 +is developed under an open source, software libre license ( +.I 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. .br @@ -66,12 +70,20 @@ 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 .B SiSU -markup is more sparse than html and outputs which include html, EPUB, LaTeX, -landscape and portrait pdfs, Open Document Format (ODF), all of which can be -added to and updated. +markup is more sparse than html and outputs which include +.I HTML, +.I EPUB, +.I ODT +(Open Document Format text), +.I LaTeX, +landscape and portrait +.I PDF, +all of which can be added to and updated. .B 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. +is also able to populate +.I SQL +type databases at an object level, which means that searches can be made with +that degree of granularity. .br Source document preparation and output generation is a two step process: (i) @@ -84,15 +96,24 @@ markup applied to a document, .B SiSU custom builds (to take advantage of the strengths of different ways of representing documents) various standard open output formats including plain -text, HTML, XHTML, XML, EPUB, OpenDocument, LaTeX or PDF files, and populate an -SQL 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 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. +text, +.I HTML, +.I XHTML, +.I XML, +.I EPUB, +.I ODT, +.I LaTeX +or +.I PDF +files, and populate an +.I SQL +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 +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 In preparing a @@ -131,7 +152,16 @@ 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 -open formats including html, pdf[^5] ODF,[^6] and EPUB.[^7] Whilst +open formats including +.I HTML, +.I EPUB, +[^5] +.I ODT, +[^6] +.I PDF +[^7] +.I ODF, +[^8]. Whilst .B 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 @@ -140,19 +170,29 @@ easily converted to other formats, which means documents prepared in can be migrated to other document formats. Further security is provided by the fact that the software itself, .B SiSU -is available under GPL3 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 is to keep up with a moving target. +is available under +.I 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 is to +keep up with a moving target. .B SiSU permits new forms of output to be added as they become important, (Open Document Format text was added in 2006 when it became an ISO standard for -office applications and the archival of documents), EPUB was introduced in -2009; and allows the technical representations existing output to be updated -(html has evolved and the 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). +office applications and the archival of documents), +.I EPUB +was introduced in 2009; and allows the technical representations existing +output to be updated ( +.I HTML +has evolved and the related module has been updated repeatedly over the years, +presumably when the World Wide Web Consortium (w3c) finalises +.I HTML +5 which is currently under development, the +.I HTML +module will again be updated allowing all existing documents to be regenerated +as +.I HTML +5). .br The document formats are written to the file\-system and available for indexing @@ -185,29 +225,50 @@ content prepared in .br -.SH 2. COMMANDS SUMMARY +.SH COMMANDS SUMMARY .br -.SH 2.1 DESCRIPTION +.SH DESCRIPTION .br .B 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 (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: +produces multiple output formats including: +.I plaintext, +.I HTML, +.I XHTML, +.I XML, +.I EPUB, +.I ODT +( +.I OpenDocument +( +.I ODF +) text), +.I LaTeX, +.I PDF, +info, and +.I SQL +( +.I PostgreSQL +and +.I SQLite +) , which share text object numbers ("object citation numbering") and the same +document structure information. For more see: or + -.SH 2.2 DOCUMENT PROCESSING COMMAND FLAGS +.SH DOCUMENT PROCESSING COMMAND FLAGS .TP .B \-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 \ 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) +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) .TP .B \-b [filename/wildcard] @@ -290,23 +351,28 @@ produces an epub document, [sisu \ version \ >=2 \ ] (filename.epub). Alias \-e .TP .B \-\-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\- +.I 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, +scroll), concordance (minitoc forced on to provide seg navigation)); +\-\-exc\-segsubtoc (exclude sub table of contents, affects html (seg), epub) ; +see also \-\-inc\-* .TP .B \-F [\-\-webserv=webrick] @@ -460,17 +526,20 @@ see \-\-pdf .TP .B \-\-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 +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 .TP .B \-\-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 +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 .TP .B \-\-po [language_directory/filename \ language_directory] @@ -538,11 +607,15 @@ see \-\-source .TP .B \-\-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 +generate examples of (naive) cgi search form for +.I SQLite +and PgSQL depends on your already having used sisu to populate an +.I SQLite +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 @@ -557,14 +630,19 @@ that you have your "keys" and ssh agent in place. Also see \-\-rsync. Alias \-r .TP .B \-\-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 +database type set to +.I SQLite, +this produces one of two possible databases, without additional database +related instructions it produces a discreet +.I 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 +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 .TP .B \-\-sisupod @@ -612,12 +690,14 @@ produces texinfo and info file, (view with pinfo). Alias \-I .TP .B \-\-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 \ 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 +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 .TP .B \-U [filename/wildcard] @@ -659,14 +739,13 @@ version information see \-\-verbose .TP -.B \-\-v2 [filename/wildcard] -invokes the sisu v2 document parser/generator. This is the default and is -normally omitted. +.B \-\-v3 [filename/wildcard] +invokes the sisu v3 document parser/generator. You may run sisu3 instead. .TP -.B \-\-v3 [filename/wildcard] -invokes the sisu v3 document parser/generator. Currently under development and -incomplete, v3 requires >= ruby1.9.2p180. You may run sisu3 instead. +.B \-\-v4 [filename/wildcard] +invokes the sisu v4 document parser/generator. This is the default and is +normally omitted. .TP .B \-\-verbose [filename/wildcard] @@ -684,7 +763,7 @@ see \-\-concordance .TP .B \-\-webrick -starts ruby's webrick webserver points at sisu output directories, the default +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 \ @@ -696,16 +775,21 @@ see \-\-concordance .TP .B \-\-xhtml [filename/wildcard] -produces xhtml/XML output for browser viewing (sax parsing). Alias \-b +produces xhtml/ +.I XML +output for browser viewing (sax parsing). Alias \-b .TP .B \-\-xml\-dom [filename/wildcard] -produces XML output with deep document structure, in the nature of dom. Alias -\-X +produces +.I XML +output with deep document structure, in the nature of dom. Alias \-X .TP .B \-\-xml\-sax [filename/wildcard] -produces XML output shallow structure (sax parsing). Alias \-x +produces +.I XML +output shallow structure (sax parsing). Alias \-x .TP .B \-X [filename/wildcard] @@ -738,14 +822,17 @@ 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 3. COMMAND LINE MODIFIERS +.SH COMMAND LINE MODIFIERS .br .TP -.B \-\-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. +.B \-\-no\- +.I 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 @@ -760,51 +847,66 @@ strips output text of editor endnotes[^*2] denoted by asterisk sign .B \-\-no\-dagger strips output text of editor endnotes[^+1] denoted by dagger/plus sign -.SH 4. DATABASE COMMANDS +.SH DATABASE COMMANDS .br .br -dbi \- database interface +.B dbi \- database interface .br -\-D or \-\-pgsql set for postgresql \-d or \-\-sqlite default set for sqlite -\-d is modifiable with \-\-db=[database \ type \ (pgsql \ or \ sqlite)] +.B \-D or \-\-pgsql +set for +.I PostgreSQL +.B \-d or \-\-sqlite +default set for +.I SQLite +\-d is modifiable with \-\-db=[database \ type \ (PgSQL \ or \ .I \ SQLite \ ) +\ ] .TP .B \-\-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 \ -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 'createdb [database \ name]' -where database name would be SiSU_[present \ working \ directory \ name \ -(without \ path)]. Please use only alphanumerics and underscores. +.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 +.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. .TP .B \-\-pg \-v \-\-import -[filename/wildcard] imports data specified to postgresql db (rb.dbi) [ \ \-dv \ -\-\-import \ sqlite \ equivalent] +[filename/wildcard] imports data specified to +.I PostgreSQL +db (rb.dbi) [ \ \-dv \ \-\-import \ .I \ SQLite \ equivalent] .TP .B \-\-pg \-v \-\-update -[filename/wildcard] updates/imports specified data to postgresql db (rb.dbi) [ -\ \-dv \ \-\-update \ sqlite \ equivalent] +[filename/wildcard] updates/imports specified data to +.I PostgreSQL +db (rb.dbi) [ \ \-dv \ \-\-update \ .I \ SQLite \ equivalent] .TP .B \-\-pg \-\-remove -[filename/wildcard] removes specified data to postgresql db (rb.dbi) [ \ \-d \ -\-\-remove \ sqlite \ equivalent] +[filename/wildcard] removes specified data to +.I PostgreSQL +db (rb.dbi) [ \ \-d \ \-\-remove \ .I \ SQLite \ equivalent] .TP .B \-\-pg \-\-dropall -kills data" and drops (postgresql or sqlite) db, tables & indexes [ \ \-d \ -\-\-dropall \ sqlite \ equivalent] +kills data" and drops ( +.I PostgreSQL +or +.I SQLite +) db, tables & indexes [ \ \-d \ \-\-dropall \ .I \ SQLite \ equivalent] .br The \-v is for verbose output. -.SH 5. SHORTCUTS, SHORTHAND FOR MULTIPLE FLAGS +.SH SHORTCUTS, SHORTHAND FOR MULTIPLE FLAGS .br .TP @@ -852,7 +954,7 @@ add \-v for verbose mode and \-c to toggle color state, e.g. sisu \-2vc .br consider \-u for appended url info or \-v for verbose output -.SH 5.1 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 @@ -863,10 +965,10 @@ 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 6. HELP +.SH HELP .br -.SH 6.1 SISU MANUAL +.SH SISU MANUAL .br The most up to date information on sisu should be contained in the sisu_manual, @@ -892,7 +994,7 @@ move to the respective directory and type e.g.: .br sisu sisu_manual.ssm -.SH 6.2 SISU MAN PAGES +.SH SISU MAN PAGES .br If @@ -932,12 +1034,12 @@ Available man pages are converted back to html using man2html: An online version of the sisu man page is available here: .br -* various sisu man pages [^8] +* various sisu man pages [^9] .br -* sisu.1 [^9] +* sisu.1 [^10] -.SH 6.3 SISU BUILT\-IN INTERACTIVE HELP +.SH SISU BUILT\-IN INTERACTIVE HELP .br This is particularly useful for getting the current sisu setup/environment @@ -957,7 +1059,7 @@ information: .br sisu \-\-help env [for \ feedback \ on \ the \ way \ your \ system \ is \ - setup \ with \ regard \ to \ sisu] + setup \ with \ regard \ to \ sisu \ ] .br sisu \-V [environment \ information, \ same \ as \ above \ command] @@ -976,14 +1078,18 @@ 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 7. INTRODUCTION TO SISU MARKUP[^10] +.SH INTRODUCTION TO SISU MARKUP[^11] .br -.SH 7.1 SUMMARY +.SH SUMMARY .br .B SiSU -source documents are plaintext (UTF\-8)[^11] files +source documents are +.I plaintext +( +.I UTF\-8 +)[^12] files .br All paragraphs are separated by an empty line. @@ -1042,9 +1148,9 @@ or if for a particular version: .br sisu \-\-query\-0.38 -.SH 7.2 MARKUP EXAMPLES +.SH MARKUP EXAMPLES -.SH 7.2.1 ONLINE +.SH ONLINE .br Online markup examples are available together with the respective outputs @@ -1060,16 +1166,16 @@ markup and the respective output produced: an alternative presentation of markup syntax: /usr/share/doc/sisu/on_markup.txt.gz -.SH 7.2.2 INSTALLED +.SH INSTALLED .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: +equivalent directory) and if sisu \-markup\-samples is installed also under: /usr/share/doc/sisu/markup\-samples\-non\-free -.SH 8. MARKUP OF HEADERS +.SH MARKUP OF HEADERS .br .br @@ -1086,7 +1192,7 @@ a space and the comment: % this would be a comment .fi -.SH 8.1 SAMPLE HEADER +.SH SAMPLE HEADER .br This current document is loaded by a master document that has a header similar @@ -1095,57 +1201,60 @@ to this one: .nf % SiSU master 2.0 @title: SiSU - :subtitle: Manual +:subtitle: Manual @creator: - :author: Amissah, Ralph -@publisher: \ [publisher \ name] -@rights: Copyright (C) Ralph Amissah 2007, License GPL 3 +: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; - synopsis=sisu \ [\-abcDdeFhIiMmNnopqRrSsTtUuVvwXxYyZz0\-9] \ [filename/wildcard \ ] - . sisu \ [\-Ddcv] \ [instruction] - . sisu \ [\-CcFLSVvW] - . sisu \-\-v2 \ [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 8.2 AVAILABLE HEADERS +.SH AVAILABLE HEADERS .br 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 +on the document (such as the +.I 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 +.I Dublin Core +meta tags are available .br .B @indentifier: @@ -1164,56 +1273,60 @@ structure, and can be useful to know. 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: - :isbn: \ [ISBN] - :loc: \ [Library \ of \ Congress \ classification] - :dewey: \ [Dewey \ classification] - :pg: \ [Project \ Gutenberg \ text \ number] +: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: .fi .nf @@ -1223,33 +1336,28 @@ This is a sample header .nf @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] +: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 9. MARKUP OF SUBSTANTIVE TEXT +.SH MARKUP OF SUBSTANTIVE TEXT .br -.SH 9.1 HEADING LEVELS +.SH HEADING LEVELS .br Heading levels are :A~ ,:B~ ,:C~ ,1~ ,2~ ,3~ \... :A \- :C being part / section @@ -1282,7 +1390,7 @@ 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, +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. @@ -1293,12 +1401,10 @@ 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) +% 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 9.2 FONT ATTRIBUTES +.SH FONT ATTRIBUTES .br .B markup example: @@ -1307,25 +1413,15 @@ be marked 1.1.1 or 1.1.2 or 1.2.1 or 2.1.1 etc. in a document normal text, *{emphasis}*, !{bold text}!, /{italics}/, _{underscore}_, "{citation}", ^{superscript}^, ,{subscript},, +{inserted text}+, \-{strikethrough}\-, #{monospace}# normal text -.br -*{emphasis}* \ [note: \ can \ be \ configured \ to \ be \ represented \ by \ bold, \ italics \ or \ underscore] -.br +*{emphasis}* [note: \ can \ be \ configured \ to \ be \ represented \ by \ bold, \ italics \ or \ underscore] !{bold text}! -.br -_{underscore}_ -.br /{italics}/ -.br +_{underscore}_ "{citation}" -.br ^{superscript}^ -.br ,{subscript}, -.br +{inserted text}+ -.br \-{strikethrough}\- -.br #{monospace}# .fi @@ -1335,7 +1431,8 @@ _{underscore}_ .br normal text, .B emphasis, -.B bold text, +.B bold text +, .I italics, .I underscore, "citation", ^superscript^, [subscript], ++inserted text++, @@ -1376,18 +1473,15 @@ or \ underscore] .br monospace -.SH 9.3 INDENTATION AND BULLETS +.SH INDENTATION AND BULLETS .br .B markup example: .nf ordinary paragraph -.br _1 indent paragraph one step -.br _2 indent paragraph two steps -.br _9 indent paragraph nine steps .fi @@ -1411,9 +1505,7 @@ ordinary paragraph .nf _* bullet text -.br _1* bullet text, first indent -.br _2* bullet text, two step indent .fi @@ -1437,11 +1529,10 @@ Numbered List (not to be confused with headings/titles, (document structure)) .nf # numbered list numbered list 1., 2., 3, etc. -.br _# numbered list numbered list indented a., b., c., d., etc. .fi -.SH 9.4 HANGING INDENTS +.SH HANGING INDENTS .br .B markup example: @@ -1466,7 +1557,7 @@ first line indented, rest of paragraph no indent .br in each case level may be 0\-9 -.SH 9.5 FOOTNOTES / ENDNOTES +.SH FOOTNOTES / ENDNOTES .br Footnotes and endnotes are marked up at the location where they would be @@ -1484,7 +1575,7 @@ determines whether footnotes or endnotes will be produced .B resulting output: .br -[^12] +[^13] .br .B markup example: @@ -1497,14 +1588,13 @@ normal text~{ self contained endnote marker & endnote in one }~ continues .B resulting output: .br -normal text[^13] continues +normal text[^14] continues .br .B markup example: .nf normal text ~{* unnumbered asterisk footnote/endnote, insert multiple asterisks if required }~ continues -.br normal text ~{** another unnumbered asterisk footnote/endnote }~ continues .fi @@ -1522,7 +1612,6 @@ normal text [^**] continues .nf normal text ~[* \ editors \ notes, \ numbered \ asterisk \ footnote/endnote \ series \ ]~ continues -.br normal text ~[+ \ editors \ notes, \ numbered \ asterisk \ footnote/endnote \ series \ ]~ continues .fi @@ -1541,16 +1630,15 @@ normal text [^+2] continues .nf % note the endnote marker "~^" normal text~^ continues -.br ^~ endnote text following the paragraph in which the marker occurs .fi .br the standard and pair notation cannot be mixed in the same document -.SH 9.6 LINKS +.SH LINKS -.SH 9.6.1 NAKED URLS WITHIN TEXT, DEALING WITH URLS +.SH NAKED URLS WITHIN TEXT, DEALING WITH URLS .br urls found within text are marked up automatically. A url within text is @@ -1601,11 +1689,10 @@ blocks are discussed later in this document .nf deb http://www.jus.uio.no/sisu/archive unstable main non\-free -.br deb\-src http://www.jus.uio.no/sisu/archive unstable main non\-free .fi -.SH 9.6.2 LINKING TEXT +.SH LINKING TEXT .br To link text or an image to a url the markup is as follows @@ -1638,27 +1725,45 @@ about {~^ SiSU }http://url.org markup .B resulting output: .br -about SiSU [^14] markup +aboutSiSU [^15] markup .br -Internal document links to a tagged location, including an ocn +Internal document links to a tagged location, including an +.I ocn .br .B markup example: .nf - { tux.png 64x80 }image -.br - % various url linked images +about { text links }#link_text +.fi + .br - {tux.png 64x80 "a better way" }http://www.sisudoc.org/ +.B resulting output: + .br +about ⌠text links⌡⌈link_text⌋ + .br - {GnuDebianLinuxRubyBetterWay.png 100x101 "Way Better \- with Gnu/Linux, Debian and Ruby" }http://www.sisudoc.org/ +Shared document collection link + .br +.B markup example: + +.nf +about { SiSU book markup examples }:SiSU/examples.html +.fi + .br - {~^ ruby_logo.png "Ruby" }http://www.ruby\-lang.org/en/ +.B resulting output: + .br +about ⌠ +.B SiSU +book markup examples⌡⌈:SiSU/examples.html⌋ + +.SH LINKING IMAGES + .br .B markup example: @@ -1684,16 +1789,15 @@ GnuDebianLinuxRubyBetterWay.png 100x101 "Way Better \- with Gnu/Linux, Debian and Ruby" .br -[ \ ruby_logo \ (png \ missing) \ ] [^15] +ruby_logo.png 70x90 "Ruby" [^16] .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 @@ -1705,9 +1809,41 @@ 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. -.SH 9.7 GROUPED TEXT +.SH LINK SHORTCUT FOR MULTIPLE VERSIONS OF A SISU DOCUMENT IN THE SAME DIRECTORY +TREE -.SH 9.7.1 TABLES +.br +.B markup example: + +.nf +!_ /{"Viral Spiral"}/, David Bollier +{ "Viral Spiral", David Bollier [3sS]}viral_spiral.david_bollier.sst +.fi + +.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」 + ⌠html, scroll, document in one⌡「http://corundum/sisu_manual/en/html/viral_spiral.david_bollier.html」 + ⌠epub⌡「http://corundum/sisu_manual/en/epub/viral_spiral.david_bollier.epub」 + ⌠pdf, landscape⌡「http://corundum/sisu_manual/en/pdf/viral_spiral.david_bollier.pdf」 + ⌠pdf, portrait⌡「http://corundum/sisu_manual/en/pdf/viral_spiral.david_bollier.pdf」 + ⌠odf: odt, open document text⌡「http://corundum/sisu_manual/en/odt/viral_spiral.david_bollier.odt」 + ⌠xhtml scroll⌡「http://corundum/sisu_manual/en/xhtml/viral_spiral.david_bollier.xhtml」 + ⌠xml, sax⌡「http://corundum/sisu_manual/en/xml/viral_spiral.david_bollier.xml」 + ⌠xml, dom⌡「http://corundum/sisu_manual/en/xml/viral_spiral.david_bollier.xml」 + ⌠concordance⌡「http://corundum/sisu_manual/en/html/viral_spiral.david_bollier.html」 + ⌠dcc, document content certificate (digests)⌡「http://corundum/sisu_manual/en/digest/viral_spiral.david_bollier.txt」 + ⌠markup source text⌡「http://corundum/sisu_manual/en/src/viral_spiral.david_bollier.sst」 + ⌠markup source (zipped) pod⌡「http://corundum/sisu_manual/en/pod/viral_spiral.david_bollier.sst.zip」 + +.SH GROUPED TEXT + +.SH TABLES .br Tables may be prepared in two either of two forms @@ -1729,7 +1865,7 @@ column three of row two, and so on .br .B resulting output: - [table omitted, see other document formats] +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 a second form may be easier to work with in cases where there is not much @@ -1737,7 +1873,7 @@ information in each column .br .B markup example: -[^17] +[^18] .nf !_ Table 3.1: Contributors to Wikipedia, January 2001 \- June 2005 @@ -1757,13 +1893,13 @@ No. of articles, all languages | 25| 19,000| 138,000| 490,000| 862,0 .br .B Table 3.1: Contributors to Wikipedia, January 2001 \- June 2005 - [table omitted, see other document formats] +|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 * Contributed at least ten times; ** at least 5 times in last month; *** more than 100 times in last month. -.SH 9.7.2 POEM +.SH POEM .br .B basic markup: @@ -1831,106 +1967,59 @@ poem{ .B resulting output: `Fury said to a -.br mouse, That he -.br met in the -.br house, -.br "Let us -.br both go to -.br law: I will -.br prosecute -.br YOU. \-\-Come, -.br I'll take no -.br denial; We -.br must have a -.br trial: For -.br really this -.br morning I've -.br nothing -.br to do." -.br Said the -.br mouse to the -.br cur, "Such -.br a trial, -.br dear Sir, -.br With -.br no jury -.br or judge, -.br would be -.br wasting -.br our -.br breath." -.br "I'll be -.br judge, I'll -.br be jury," -.br Said -.br cunning -.br old Fury: -.br "I'll -.br try the -.br whole -.br cause, -.br and -.br condemn -.br you -.br to -.br death."' -.br -.SH 9.7.3 GROUP +.SH GROUP .br .B basic markup: .nf group{ -.br Your grouped text here -.br }group -.br A group is treated as an object and given a single object number. .fi @@ -1939,7 +2028,7 @@ A group is treated as an object and given a single object number. .nf group{ - 'Fury said to a + `Fury said to a mouse, That he met in the house, @@ -1990,95 +2079,51 @@ group{ .B resulting output: `Fury said to a -.br mouse, That he -.br met in the -.br house, -.br "Let us -.br both go to -.br law: I will -.br prosecute -.br YOU. \-\-Come, -.br I'll take no -.br denial; We -.br must have a -.br trial: For -.br really this -.br morning I've -.br nothing -.br to do." -.br Said the -.br mouse to the -.br cur, "Such -.br a trial, -.br dear Sir, -.br With -.br no jury -.br or judge, -.br would be -.br wasting -.br our -.br breath." -.br "I'll be -.br judge, I'll -.br be jury," -.br Said -.br cunning -.br old Fury: -.br "I'll -.br try the -.br whole -.br cause, -.br and -.br condemn -.br you -.br to -.br death."' -.br -.SH 9.7.4 CODE +.SH CODE .br Code tags code{ \... }code (used as with other group tags described above) are @@ -2196,9 +2241,9 @@ code{# as demonstrated here: 44 | death."' .fi -.SH 9.8 ADDITIONAL BREAKS \- LINEBREAKS WITHIN OBJECTS, COLUMN AND PAGE\-BREAKS +.SH ADDITIONAL BREAKS \- LINEBREAKS WITHIN OBJECTS, COLUMN AND PAGE\-BREAKS -.SH 9.8.1 LINE\-BREAKS +.SH LINE\-BREAKS .br To break a line within a "paragraph object", two backslashes \e\e @@ -2217,14 +2262,23 @@ 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 9.8.2 PAGE BREAKS +.SH PAGE BREAKS .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 +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, +else breaks the page, starts a new page. + .nf +\-\e\e\- +or <:pb> .fi @@ -2232,17 +2286,12 @@ its own: or .nf +=\e\e= +or <:pn> .fi -.br -page new <:pn> breaks the page, starts a new page. - -.br -page break <:pb> breaks a column, starts a new column, if using columns, else -breaks the page, starts a new page. - -.SH 9.9 BOOK INDEX +.SH BOOK INDEX .br To make an index append to paragraph the book index term relates to it, using @@ -2307,7 +2356,7 @@ additional paragraph. The logical structure of the resulting index would be: second sub\-term, 1, .fi -.SH 10. COMPOSITE DOCUMENTS MARKUP +.SH COMPOSITE DOCUMENTS MARKUP .br .br @@ -2338,901 +2387,457 @@ basic markup for importing a document into a master document .fi .br -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. +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. -.nf -<< filename.ssi -<<{filename.ssi} -% using textlink alternatives -<< |filename.ssi|@|^| -.fi - -.SH 11. MARKUP SYNTAX HISTORY +.SH SISU FILETYPES .br -.SH 11.1 NOTES RELATED TO FILES\-TYPES AND MARKUP SYNTAX .br +.B SiSU +has +.I plaintext +and binary filetypes, and can process either type of document. -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) - -.br -0.38 is substantially current for version 1.0 +.SH .SST \.SSM \.SSI MARKED UP PLAIN TEXT -.br -depreciated 0.16 supported, though file names were changed at 0.37 +.TP +.B SiSU¤b〕 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. .br -* sisu \-\-query=[sisu \ version \ [0.38] or 'history] +.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 -provides a short history of changes to .B SiSU -markup +source markup can be shared with the command: .br -.B 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. + sisu \-s [filename] -.nf -@title: - :subtitle: +.SH SISU TEXT \- REGULAR FILES (.SST) -@creator: - :author: - :translator: - :illustrator: +.br +The most common form of document in +.B SiSU, +see the section on +.B SiSU +markup. -@rights: - :text: - :illustrations: -.fi +.SH SISU MASTER FILES (.SSM) .br -see document markup samples, and sisu \-\-help headers +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 +the purpose of being incorporated into one or more master documents. .br -the monospace tag takes the form of a hash '#' - -.nf -#{ this enclosed text would be monospaced }# -.fi +The mechanism by which master files incorporate other documents is described as +one of the headings under under +.B SiSU +markup in the +.B SiSU +manual. .br -.B 1.0 -(2009\-12\-19:50/6) same as 0.69 +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. .br -.B 0.69 -(2008\-09\-16:37/2) (same as 1.0) and as previous (0.57) with the addition of -book index tags +Note: a secondary file of the composite document is built prior to processing +with the same prefix and the suffix \._sst [^19] -.nf -/^={.+?}$/ -.fi +.SH SISU INSERT FILES (.SSI) .br -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" - -.nf -={GNU/Linux community distribution:Debian+2|Fedora|Gentoo;Free Software Foundation+5} -.fi +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 +that it is not intended that the file should be processed on its own. -.nf -Free Software Foundation, 1\-6 -GNU/Linux community distribution, 1 - Debian, 1\-3 - Fedora, 1 - Gentoo, -.fi +.SH SISUPOD, ZIPPED BINARY CONTAINER (SISUPOD.ZIP, \.SSP) .br -.B 0.66 -(2008\-02\-24:07/7) same as previous, adds semantic tags, [experimental \ and \ -not\-used] +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) -.nf -/[:;]{.+?}[:;][a\-z+]/ -.fi +.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 +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 -.B 0.57 -(2007w34/4) +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 .B 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:] - -.nf -:A~ @title by @author -.fi +documents. .br -.B 0.52 -(2007w14/6) declared document type identifier at start of text/document: - -.br - .B SiSU -0.52 - -.br -or, backward compatible using the comment marker: - -.br - % -.B SiSU -0.38 +The command to create a sisupod is: .br -variations include ' -.B SiSU -(text|master|insert) [version]' and 'sisu\-[version]' + sisu \-S [filename] .br -.B 0.51 -(2007w13/6) skins changed (simplified), markup unchanged +Alternatively, make a pod of the contents of a whole directory: .br -.B 0.42 -(2006w27/4) * (asterisk) type endnotes, used e.g. in relation to author + sisu \-S .br .B SiSU -0.42 is the same as 0.38 with the introduction of some additional endnote -types, - -.br -Introduces some variations on endnotes, in particular the use of the asterisk - -.nf -~{* for example for describing an author }~ and ~{** for describing a second author }~ -.fi - -.br -* for example for describing an author +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 -** for describing a second author + .br -and - -.nf -~[* \ my \ note \ ]~ or ~[+ \ another \ note \ ]~ -.fi + +.SH CONFIGURATION .br -which numerically increments an asterisk and plus respectively -.br -*1 my note +1 another note +.SH CONFIGURATION FILES -.br -.B 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) +.SH CONFIG.YML .br .B SiSU -0.38 introduced alternative experimental header and heading/structure markers, - -.nf -@headername: and headers :A~ :B~ :C~ 1~ 2~ 3~ -.fi - -.br -as the equivalent of: - -.nf -0~headername and headers 1~ 2~ 3~ 4~ 5~ 6~ -.fi +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 -The internal document markup of -.B SiSU -0.16 remains valid and standard Though note that +The .B SiSU -0.37 introduced a new file naming convention +configuration file is a yaml file, which means indentation is significant. .br .B 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 -.B 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 +resource configuration is determined by looking at the following files if they +exist: .br -.B 0.37 -(2006w09/7) introduced new file naming convention, \.sst (text), \.ssm -(master), \.ssi (insert), markup syntax unchanged + ./_sisu/v4/sisurc.yml .br -.B 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 + ./_sisu/sisurc.yml .br -this is captured by the following file 'rename' instruction: - -.nf -rename 's/\e.s[123]$/\e.sst/' *.s{1,2,3} -rename 's/\e.r[123]$/\e.ssm/' *.r{1,2,3} -rename 's/\e.si$/\e.ssi/' *.si -.fi + ~/.sisu/v4/sisurc.yml .br -The internal document markup remains unchanged, from -.B SiSU -0.16 + ~/.sisu/sisurc.yml .br -.B 0.35 -(2005w52/3) sisupod, zipped content file introduced + /etc/sisu/v4/sisurc.yml .br -.B 0.23 -(2005w36/2) utf\-8 for markup file + /etc/sisu/sisurc.yml .br -.B 0.22 -(2005w35/3) image dimensions may be omitted if rmagick is available to be -relied upon +The search is in the order listed, and the first one found is used. .br -.B 0.20.4 -(2005w33/4) header 0~links +In the absence of instructions in any of these it falls back to the internal +program defaults. .br -.B 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 +Configuration determines the output and processing directories and the database +access details. .br +If .B SiSU -0.16 (0.15 development branch) introduced the use of - -.br -the header 0~ and headings/structure 1~ 2~ 3~ 4~ 5~ 6~ - -.br -in place of the 0.1 header, heading/structure notation +is installed a sample sisurc.yml may be found in /etc/sisu/sisurc.yml -.br -.B SiSU -0.1 headers and headings structure represented by header 0{~ and -headings/structure 1{ 2{ 3{ 4{~ 5{ 6{ +.SH SISU_DOCUMENT_MAKE -.SH 12. SISU FILETYPES .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 -.B SiSU -has plaintext and binary filetypes, and can process either type of document. - -.SH 12.1 \.SST \.SSM \.SSI MARKED UP PLAIN TEXT +The search order is as for resource configuration: .br -.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 -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/v4/sisu_document_make .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. + ./_sisu/sisu_document_make .br -.B SiSU -source markup can be shared with the command: + ~/.sisu/v4/sisu_document_make .br - sisu \-s [filename] - -.SH 12.1.1 SISU TEXT \- REGULAR FILES (.SST) + ~/.sisu/sisu_document_make .br -The most common form of document in -.B SiSU, -see the section on -.B SiSU -markup. + /etc/sisu/v4/sisu_document_make .br - + /etc/sisu/sisu_document_make .br - - -.SH 12.1.2 SISU MASTER FILES (.SSM) +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 -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 -the purpose of being incorporated into one or more master documents. .br -The mechanism by which master files incorporate other documents is described as -one of the headings under under -.B SiSU -markup in the +CSS files to modify the appearance of .B SiSU -manual. - -.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 -contain other documents. - -.br -Note: a secondary file of the composite document is built prior to processing -with the same prefix and the suffix \._sst [^18] - -.br - - -.br - - -.SH 12.1.3 SISU INSERT FILES (.SSI) +html, +.I XHTML +or +.I 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. .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 -that it is not intended that the file should be processed on its own. - -.SH 12.2 SISUPOD, ZIPPED BINARY CONTAINER (SISUPOD.ZIP, \.SSP) +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 -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) +.I HTML: +html. css .br -.B 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 with a document. A sisupod -automatically bundles all associated files with the document that is turned -into a pod. +.I XML +DOM: dom.css .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 -prepared -.B SiSU -documents. +.I XML +SAX: sax.css .br -The command to create a sisupod is: +.I XHTML: +xhtml. css .br - sisu \-S [filename] +The default homepage may use homepage.css or html. css .br -Alternatively, make a pod of the contents of a whole directory: +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 - sisu \-S .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 - - -.SH 13. EXPERIMENTAL ALTERNATIVE INPUT REPRESENTATIONS -.br +v3 has new options for the source directory tree, and output directory +structures of which there are 3 alternatives. -.SH 13.1 ALTERNATIVE XML +.SH DOCUMENT SOURCE DIRECTORY .br -.B SiSU -offers alternative XML input representations of documents as a proof of -concept, experimental feature. They are however not strictly maintained, and -incomplete and should be handled with care. +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. -.br -.B convert from sst to simple xml representations (sax, dom and node): +.SH GENERAL DIRECTORIES -.br - sisu \-\-to\-sax [filename/wildcard] or sisu \-\-to\-sxs [filename/wildcard] +.nf +./subject_name/ +% files stored at this level e.g. sisu_manual.sst or +% 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 +.fi -.br - sisu \-\-to\-dom [filename/wildcard] or sisu \-\-to\-sxd [filename/wildcard] +.SH DOCUMENT OUTPUT DIRECTORY STRUCTURES -.br - sisu \-\-to\-node [filename/wildcard] or sisu \-\-to\-sxn [filename/wildcard] +.SH OUTPUT DIRECTORY ROOT .br -.B convert to sst from any sisu xml representation (sax, dom and node): +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) .br - sisu \-\-from\-xml2sst [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]] +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. -.br -or the same: +.SH ALTERNATIVE OUTPUT STRUCTURES .br - sisu \-\-from\-sxml [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]] - -.SH 13.1.1 XML SAX REPRESENTATION +There are 3 possibile output structures described as being, by language, by +filetype or by filename, the selection is made in sisurc.yml -.br -To convert from sst to simple xml (sax) representation: +.nf +#% output_dir_structure_by: language; filetype; or filename +output_dir_structure_by: language #(language & filetype, preferred?) +#output_dir_structure_by: filetype +#output_dir_structure_by: filename #(default, closest to original v1 & v2) +.fi -.br - sisu \-\-to\-sax [filename/wildcard] or sisu \-\-to\-sxs [filename/wildcard] +.SH BY LANGUAGE .br -To convert from any sisu xml representation back to sst +The by language directory structure places output files .br - sisu \-\-from\-xml2sst [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]] +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 -or the same: +Its selection is configured in sisurc.yml .br - sisu \-\-from\-sxml [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]] +output_dir_structure_by: language -.SH 13.1.2 XML DOM REPRESENTATION +.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 +.fi .br -To convert from sst to simple xml (dom) representation: +#by: language subject_dir/en/manifest/filename.html -.br - sisu \-\-to\-dom [filename/wildcard] or sisu \-\-to\-sxd [filename/wildcard] +.SH BY FILETYPE .br -To convert from any sisu xml representation back to sst +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 - sisu \-\-from\-xml2sst [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]] +Its selection is configured in sisurc.yml .br -or the same: - -.br - sisu \-\-from\-sxml [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]] - -.SH 13.1.3 XML NODE REPRESENTATION - -.br -To convert from sst to simple xml (node) representation: - -.br - sisu \-\-to\-node [filename/wildcard] or sisu \-\-to\-sxn [filename/wildcard] - -.br -To convert from any sisu xml representation back to sst - -.br - sisu \-\-from\-xml2sst [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]] - -.br -or the same: - -.br - sisu \-\-from\-sxml [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]] - -.SH 14. CONFIGURATION -.br - -.SH 14.1 DETERMINING THE CURRENT CONFIGURATION - -.br -Information on the current configuration of -.B SiSU -should be available with the help command: - -.br - sisu \-v - -.br -which is an alias for: - -.br - sisu \-\-help env - -.br -Either of these should be executed from within a directory that contains sisu -markup source documents. - -.SH 14.2 CONFIGURATION FILES (CONFIG.YML) - -.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 -The -.B SiSU -configuration file is a yaml file, which means indentation is significant. - -.br -.B SiSU -resource configuration is determined by looking at the following files if they -exist: - -.br - ./_sisu/sisurc.yml - -.br - ~/.sisu/sisurc.yml - -.br - /etc/sisu/sisurc.yml - -.br -The search is in the order listed, and the first one found is used. - -.br -In the absence of instructions in any of these it falls back to the internal -program defaults. - -.br -Configuration determines the output and processing directories and the database -access details. - -.br -If -.B SiSU -is installed a sample sisurc.yml may be found in /etc/sisu/sisurc.yml - -.SH 15. SKINS -.br - -.br -Skins modify the default appearance of document output on a document, -directory, or site wide basis. Skins are looked for in the following locations: - -.br - ./_sisu/skin - -.br - ~/.sisu/skin - -.br - /etc/sisu/skin - -.br -.B Within the skin directory -are the following the default sub\-directories for document skins: - -.br - ./skin/doc - -.br - ./skin/dir - -.br - ./skin/site - -.br -A skin is placed in the appropriate directory and the file named skin_[name].rb - -.br -The skin itself is a ruby file which modifies the default appearances set in -the program. - -.SH 15.1 DOCUMENT SKIN - -.br -Documents take on a document skin, if the header of the document specifies a -skin to be used. - -.nf -@skin: skin_united_nations -.fi - -.SH 15.2 DIRECTORY SKIN - -.br -A directory may be mapped on to a particular skin, so all documents within that -directory take on a particular appearance. If a skin exists in the skin/dir -with the same name as the document directory, it will automatically be used for -each of the documents in that directory, (except where a document specifies the -use of another skin, in the skin/doc directory). - -.br -A personal habit is to place all skins within the doc directory, and symbolic -links as needed from the site, or dir directories as required. - -.SH 15.3 SITE SKIN - -.br -A site skin, modifies the program default skin. - -.SH 15.4 SAMPLE SKINS - -.br -With -.B SiSU -installed sample skins may be found in: - -.br - /etc/sisu/skin/doc and - /usr/share/doc/sisu/markup\-samples/samples/_sisu/skin/doc - -.br -(or equivalent directory) and if sisu\-markup\-samples is installed also under: - -.br - /usr/share/doc/sisu/markup\-samples\-non\-free/samples/_sisu/skin/doc - -.br -Samples of list.yml and promo.yml (which are used to create the right column -list) may be found in: - -.br - /usr/share/doc/sisu/markup\-samples\-non\-free/samples/_sisu/skin/yml (or - equivalent directory) - -.SH 16. CSS \- CASCADING STYLE SHEETS (FOR HTML, XHTML AND XML) -.br - -.br -CSS files to modify the appearance of -.B 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. - -.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 -HTML: html.css - -.br -XML DOM: dom.css - -.br -XML SAX: sax.css - -.br -XHTML: xhtml.css - -.br -The default homepage may use homepage.css or html.css - -.br -Under consideration is to permit the placement of a CSS file with a different -name in directory _sisu/css directory or equivalent, and change the default CSS -file that is looked for in a skin.[^19] - -.SH 17. 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 17.1 DOCUMENT SOURCE DIRECTORY - -.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. - -.SH 17.1.1 GENERAL DIRECTORIES +output_dir_structure_by: filetype .nf -./subject_name/ -% files stored at this level e.g. sisu_manual.sst or -% for sisu v3 may be under language sub\-directories -% e.g. -./subject_name/en -./subject_name/fr -./subject_name/es -./subject_name/_sisu -% configuration file e.g. sisurc.yml -./subject_name/_sisu/skin -% skins in various skin directories doc, dir, site, yml -./subject_name/_sisu/css -./subject_name/_sisu/image + |\-\- 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 -.SH 17.2 DOCUMENT OUTPUT DIRECTORY STRUCTURES - -.SH 17.2.1 OUTPUT DIRECTORY ROOT - -.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 -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) - -.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 -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. - -.SH 17.2.2 ALTERNATIVE OUTPUT STRUCTURES - .br -There are 3 possibile output structures described as being, by language, by -filetype or by filename, the selection is made in sisurc.yml - -.nf -#% output_dir_structure_by: language; filetype; or filename -output_dir_structure_by: language #(language & filetype, preferred?) -#output_dir_structure_by: filetype -#output_dir_structure_by: filename #(default, closest to original v1 & v2) -.fi - -.SH 17.2.3 BY LANGUAGE +#by: filetype subject_dir/html/filename/manifest.en.html -.br -The by language directory structure places output files +.SH BY FILENAME .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. +The by filename directory structure places most output of a particular file +(the different filetypes) in a common directory. .br Its selection is configured in sisurc.yml .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 -.fi - -.br -#by: language subject_dir/en/manifest/filename.html - -.SH 17.2.4 BY FILETYPE - -.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 -Its selection is configured in sisurc.yml - -.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 -.fi - -.br -#by: filetype subject_dir/html/filename/manifest.en.html - -.SH 17.2.5 BY FILENAME - -.br -The by filename directory structure places most output of a particular file -(the different filetypes) in a common directory. - -.br -Its selection is configured in sisurc.yml - -.br -output_dir_structure_by: filename +output_dir_structure_by: filename .nf |\-\- epub @@ -3251,1235 +2856,648 @@ output_dir_structure_by: filename | `\-\- xsd |\-\- sitemaps |\-\- src - |\-\- pod - `\-\- viral_spiral.david_bollier -.fi - -.br -#by: filename subject_dir/filename/manifest.en.html - -.SH 17.2.6 REMOTE DIRECTORIES - -.nf -\./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 - \./subject_name/_sisu -% configuration file e.g. sisurc.yml - \./subject_name/_sisu/skin -% skins in various skin directories doc, dir, site, yml - \./subject_name/_sisu/css - \./subject_name/_sisu/image -% images for documents contained in this directory - \./subject_name/_sisu/mm -.fi - -.SH 17.2.7 SISUPOD - -.nf -\./sisupod/ -% files stored at this level e.g. sisu_manual.sst - \./sisupod/_sisu -% configuration file e.g. sisurc.yml - \./sisupod/_sisu/skin -% skins in various skin directories doc, dir, site, yml - \./sisupod/_sisu/css - \./sisupod/_sisu/image -% images for documents contained in this directory - \./sisupod/_sisu/mm -.fi - -.SH 17.3 ORGANISING CONTENT - -.SH 18. HOMEPAGES -.br - -.br -.B SiSU -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, -.B 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: - -.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 -2. through providing what you want as the home page in a skin, - -.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 18.1 HOME PAGE AND OTHER CUSTOM BUILT PAGES IN A SUB\-DIRECTORY - -.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 -there they are copied to the root of the output directory with the command: - -.br - sisu \-CC - -.SH 18.2 HOME PAGE WITHIN A SKIN - -.br -Skins are described in a separate section, but basically are a file written in -the programming language -.B Ruby -that may be provided to change the defaults that are provided with sisu with -respect to individual documents, a directories contents or for a site. - -.br -If you wish to provide a homepage within a skin the skin should be in the -directory _sisu/skin/dir and have the name of the directory for which it is to -become the home page. Documents in the directory commercial_law would have the -homepage modified in skin_commercial law.rb; or the directory poems in -skin_poems.rb - -.nf - class Home - def homepage - # place the html content of your homepage here, this will become index.html - < - - -

    this is my new homepage.

    -     - -HOME - end - end -.fi - -.SH 19. MARKUP AND OUTPUT EXAMPLES -.br - -.SH 19.1 MARKUP EXAMPLES - -.br -Current markup examples and document output samples are provided at - - -.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 20. 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 -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. - -.br -In addition to this -.B 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. - -.SH 21. SQL -.br - -.SH 21.1 POPULATING SQL TYPE DATABASES - -.br -.B SiSU -feeds sisu markupd documents into sql type databases PostgreSQL[^20] and/or -SQLite[^21] database together with information related to document structure. - -.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 - * one containing semantic (and other) headers, including, title, author, - subject, (the Dublin Core...); - -.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 - which they are referenced (both in formatted and clean text versions for - searching). - -.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 ascii. - -.br -There is of course the possibility to add further structures. - -.br -At this level -.B 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. - -.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 -.B 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). - -.SH 22. POSTGRESQL -.br - -.SH 22.1 NAME - -.br -.B SiSU -\- Structured information, Serialized Units \- a document publishing system, -postgresql dependency package - -.SH 22.2 DESCRIPTION - -.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). - -.SH 22.3 SYNOPSIS - -.br - sisu \-D [instruction] [filename/wildcard \ if \ required] - -.br - sisu \-D \-\-pg \-\-[instruction] [filename/wildcard \ if \ required] - -.SH 22.4 COMMANDS - -.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 - -.br -.B \-D or \-\-pgsql -may be used interchangeably. - -.SH 22.4.1 CREATE AND DESTROY DATABASE - -.TP -.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 -creates database where no database existed before - -.TP -.B sisu \-D \-\-create -creates database tables where no database tables existed before - -.TP -.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 -destroys existing database and builds a new empty database structure - -.SH 22.4.2 IMPORT AND REMOVE DOCUMENTS - -.TP -.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] -updates file contents in database - -.TP -.B sisu \-D \-\-remove \-v [filename/wildcard] -removes specified document from postgresql database. - -.SH 23. SQLITE -.br - -.SH 23.1 NAME - -.br -.B SiSU -\- Structured information, Serialized Units \- a document publishing system. - -.SH 23.2 DESCRIPTION - -.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). - -.SH 23.3 SYNOPSIS - -.br - sisu \-d [instruction] [filename/wildcard \ if \ required] - -.br - sisu \-d \-\-(sqlite|pg) \-\-[instruction] [filename/wildcard \ if \ - required] - -.SH 23.4 COMMANDS - -.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 - -.br -.B \-d or \-\-sqlite -may be used interchangeably. - -.SH 23.4.1 CREATE AND DESTROY DATABASE - -.TP -.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 -creates database where no database existed before - -.TP -.B sisu \-d \-\-create -creates database tables where no database tables existed before - -.TP -.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 -destroys existing database and builds a new empty database structure - -.SH 23.4.2 IMPORT AND REMOVE DOCUMENTS - -.TP -.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] -updates file contents in database - -.TP -.B sisu \-d \-\-remove \-v [filename/wildcard] -removes specified document from sqlite database. - -.SH 24. INTRODUCTION -.br - -.SH 24.1 SEARCH \- DATABASE FRONTEND SAMPLE, UTILISING DATABASE AND SISU FEATURES, -INCLUDING OBJECT CITATION NUMBERING (BACKEND CURRENTLY POSTGRESQL) - -.br -Sample search frontend [^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] - -.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 -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. - -.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.[^24] - -.TP -.B sisu \-F \-\-webserv\-webrick -builds a cgi web search frontend for the database created - -.br -The following is feedback on the setup on a machine provided by the help -command: - -.br - sisu \-\-help sql - -.nf -Postgresql - user: ralph - current db set: SiSU_sisu - port: 5432 - dbi connect: DBI:Pg:database=SiSU_sisu;port=5432 -sqlite - current db set: /home/ralph/sisu_www/sisu/sisu_sqlite.db - dbi connect DBI:SQLite:/home/ralph/sisu_www/sisu/sisu_sqlite.db -.fi - -.br -Note on databases built - -.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] - -.SH 24.2 SEARCH FORM - -.TP -.B sisu \-F -generates a sample search form, which must be copied to the web\-server cgi -directory - -.TP -.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 - -.TP -.B sisu \-Fv -as above, and provides some information on setting up hyperestraier - -.TP -.B sisu \-W -starts the webrick server which should be available wherever sisu is properly -installed - -.br -The generated search form must be copied manually to the webserver directory as -instructed - -.SH 25. SISU_WEBRICK -.br - -.SH 25.1 NAME - -.br -.B SiSU -\- Structured information, Serialized Units \- a document publishing system - -.SH 25.2 SYNOPSIS - -.br -sisu_webrick [port] - -.br -or - -.br -sisu \-W [port] - -.SH 25.3 DESCRIPTION - -.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 -.B SiSU -output is written, providing a list of these directories (assuming -.B SiSU -is in use and they exist). - -.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 25.4 SUMMARY OF MAN PAGE - -.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] - -.br -where no port is given and settings are unchanged the default port is 8081 - -.SH 25.5 DOCUMENT PROCESSING COMMAND FLAGS - -.br -sisu \-W [port] starts -.B Ruby -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 25.6 FURTHER INFORMATION - -.br -For more information on -.B SiSU -see: or - -.br -or man sisu - -.SH 25.7 AUTHOR - -.br -Ralph Amissah or - -.SH 25.8 SEE ALSO - -.br - sisu(1) - -.br - sisu_vim(7) - -.SH 26. REMOTE SOURCE DOCUMENTS -.br - -.br -.B SiSU -processing instructions can be run against remote source documents by providing -the url of the documents against which the processing instructions are to be -carried out. The remote -.B SiSU -documents can either be sisu marked up files in plaintext \.sst or \.ssm or; -zipped sisu files, sisupod.zip or filename.ssp - -.br -.B \.sst / \.ssm \- sisu text files - -.br -.B SiSU -can be run against source text files on a remote machine, provide the -processing instruction and the url. The source file and any associated parts -(such as images) will be downloaded and generated locally. - -.nf -sisu \-3 http://[provide \ url \ to \ valid \ \.sst \ or \ \.ssm \ file] -.fi - -.br -Any of the source documents in the sisu examples page can be used in this way, -see and use the url to the - \.sst for the desired document. - -.br -NOTE: to set up a remote machine to serve -.B SiSU -documents in this way, images should be in the directory relative to the -document source \../_sisu/image - -.br -.B sisupod \- zipped sisu files - -.br -A sisupod is the zipped content of a sisu marked up text or texts and any other -associated parts to the document such as images. - -.br -.B SiSU -can be run against a sisupod on a (local or) remote machine, provide the -processing instruction and the url, the sisupod will be downloaded and the -documents it contains generated locally. - -.nf -sisu \-3 http://[provide \ url \ to \ valid \ sisupod.zip \ or \ \.ssp \ file] -.fi - -.br -Any of the source documents in the sisu examples page can be used in this way, -see and use the url for the -desired document. - -.SH REMOTE DOCUMENT OUTPUT -.br - -.SH 27. REMOTE OUTPUT -.br - -.br -Once properly configured -.B SiSU -output can be automatically posted once generated to a designated remote -machine using either rsync, or scp. - -.br -In order to do this some ssh authentication agent and keychain or similar tool -will need to be configured. Once that is done the placement on a remote host -can be done seamlessly with the \-r (for scp) or \-R (for rsync) flag, which -may be used in conjunction with other processing flags, e.g. - -.nf -sisu \-3R sisu_remote.sst -.fi - -.SH 27.1 COMMANDS - -.TP -.B \-R [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 \-r - -.TP -.B \-r [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 \-R - -.SH 27.2 CONFIGURATION - -.br -[expand \ on \ the \ setting \ up \ of \ an \ ssh\-agent \ / \ keychain] - -.SH 28. REMOTE SERVERS -.br - -.br -As -.B SiSU -is generally operated using the command line, and works within a Unix type -environment, -.B SiSU -the program and all documents can just as easily be on a remote server, to -which you are logged on using a terminal, and commands and operations would be -pretty much the same as they would be on your local machine. - -.SH 29. QUICKSTART \- GETTING STARTED HOWTO -.br - -.SH 29.1 INSTALLATION - -.br -Installation is currently most straightforward and tested on the -.B Debian -platform, as there are packages for the installation of sisu and all -requirements for what it does. - -.SH 29.1.1 DEBIAN INSTALLATION - -.br -.B SiSU -is available directly from the -.B Debian -Sid and testing archives (and possibly Ubuntu), assuming your -/etc/apt/sources.list is set accordingly: - -.nf - aptitude update - aptitude install sisu\-complete -.fi - -.br -The following /etc/apt/sources.list setting permits the download of additional -markup samples: - -.nf - #/etc/apt/sources.list -.br - deb http://ftp.fi.debian.org/debian/ unstable main non\-free contrib -.br - deb\-src http://ftp.fi.debian.org/debian/ unstable main non\-free contrib -.br - -.fi - -.br -The aptitude commands become: - -.nf - aptitude update -.br - aptitude install sisu\-complete sisu\-markup\-samples -.fi - -.br -If there are newer versions of -.B SiSU -upstream of the -.B Debian -archives, they will be available by adding the following to your -/etc/apt/sources.list - -.nf -#/etc/apt/sources.list - 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 - -.br -repeat the aptitude commands - -.nf - aptitude update - aptitude install sisu\-complete sisu\-markup\-samples -.fi - -.br -Note however that it is not necessary to install sisu\-complete if not all -components of sisu are to be used. Installing just the package sisu will -provide basic functionality. - -.SH 29.1.2 RPM INSTALLATION - -.br -RPMs are provided though untested, they are prepared by running alien against -the source package, and against the debs. - -.br -They may be downloaded from: - -.br - - -.br -as root type: + |\-\- pod + `\-\- viral_spiral.david_bollier +.fi .br - rpm \-i [rpm \ package \ name] +#by: filename subject_dir/filename/manifest.en.html -.SH 29.1.3 INSTALLATION FROM SOURCE +.SH REMOTE DIRECTORIES -.br -To install -.B SiSU -from source check information at: +.nf +./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 + \./subject_name/_sisu +% configuration file e.g. sisurc.yml + \./subject_name/_sisu/skin +% skins in various skin directories doc, dir, site, yml + \./subject_name/_sisu/css + \./subject_name/_sisu/image +% images for documents contained in this directory + \./subject_name/_sisu/mm +.fi -.br - +.SH SISUPOD -.br -* download the source package +.nf +./sisupod/ +% files stored at this level e.g. sisu_manual.sst + \./sisupod/_sisu +% configuration file e.g. sisurc.yml + \./sisupod/_sisu/skin +% skins in various skin directories doc, dir, site, yml + \./sisupod/_sisu/css + \./sisupod/_sisu/image +% images for documents contained in this directory + \./sisupod/_sisu/mm +.fi -.br -* Unpack the source +.SH ORGANISING CONTENT +.SH HOMEPAGES .br -Two alternative modes of installation from source are provided, setup.rb (by -Minero Aoki) and a rant(by Stefan Lang) built install file, in either case: the -first steps are the same, download and unpack the source file: .br -For basic use .B SiSU -is only dependent on the programming language in which it is written -.B Ruby, -and +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, .B SiSU -will be able to generate html, EPUB, various XMLs, including ODF (and will also -produce LaTeX). Dependencies required for further actions, though it relies on -the installation of additional dependencies which the source tarball does not -take care of, for things like using a database (postgresql or sqlite)[^25] or -converting LaTeX to pdf. +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 -.B setup.rb +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 -This is a standard ruby installer, using setup.rb is a three step process. In -the root directory of the unpacked -.B SiSU -as root type: - -.nf - ruby setup.rb config - ruby setup.rb setup - #[and \ as \ root:] - ruby setup.rb install -.fi +2. through providing what you want as the home page in a skin, .br -further information on setup.rb is available from: +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. -.br - +.SH HOME PAGE AND OTHER CUSTOM BUILT PAGES IN A SUB\-DIRECTORY .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 +there they are copied to the root of the output directory with the command: .br -.B "install" + sisu \-CC +.SH MARKUP AND OUTPUT EXAMPLES .br -The "install" file provided is an installer prepared using "rant". In the root -directory of the unpacked -.B SiSU -as root type: -.br - ruby install base +.SH MARKUP EXAMPLES .br -or for a more complete installation: +Current markup examples and document output samples are provided off + or and in the sisu +\-markup\-sample package available off .br - ruby install +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. -.br -or +.SH SISU MARKUP SAMPLES .br - ruby install base +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 +.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. .br -This makes use of Rant (by Stefan Lang) and the provided Rantfile. It has been -configured to do post installation setup setup configuration and generation of -first test file. Note however, that additional external package dependencies, -such as tetex\-extra are not taken care of for you. +.I Accelerando, +Charles Stross (2005) +accelerando.charles_stross.sst .br -Further information on "rant" is available from: +.I Alice's Adventures in Wonderland, +Lewis Carroll (1865) +alices_adventures_in_wonderland.lewis_carroll.sst .br - +.I CONTENT, +Cory Doctorow (2008) +content.cory_doctorow.sst .br - +.I Democratizing Innovation, +Eric von Hippel (2005) +democratizing_innovation.eric_von_hippel.sst .br -For a list of alternative actions you may type: +.I Down and Out in the Magic Kingdom, +Cory Doctorow (2003) +down_and_out_in_the_magic_kingdom.cory_doctorow.sst .br - ruby install help +.I For the Win, +Cory Doctorow (2010) +for_the_win.cory_doctorow.sst .br - ruby install \-T - -.SH 29.2 TESTING SISU, GENERATING OUTPUT +.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 -To check which version of sisu is installed: +.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 -sisu \-v +.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 -Depending on your mode of installation one or a number of markup sample files -may be found either in the directory: +.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 -... +.I GNU GENERAL PUBLIC LICENSE v2, +Free Software Foundation (1991) +gpl2.fsf.sst .br -or +.I GNU GENERAL PUBLIC LICENSE v3, +Free Software Foundation (2007) +gpl3.fsf.sst .br -... +.I Gulliver's Travels, +Jonathan Swift (1726 / 1735) +gullivers_travels.jonathan_swift.sst .br -change directory to the appropriate one: +.I Little Brother, +Cory Doctorow (2008) +little_brother.cory_doctorow.sst .br -cd /usr/share/doc/sisu/markup\-samples/samples - -.SH 29.2.1 BASIC TEXT, PLAINTEXT, HTML, XML, ODF, EPUB +.I The Cathederal and the Bazaar, +Eric Raymond (2000) +the_cathedral_and_the_bazaar.eric_s_raymond.sst .br -Having moved to the directory that contains the markup samples (see -instructions above if necessary), choose a file and run sisu against it +.I The Public Domain \- Enclosing the Commons of the Mind, +James Boyle (2008) +the_public_domain.james_boyle.sst .br -sisu \-NhwoabxXyv free_as_in_freedom.rms_and_free_software.sam_williams.sst +.I The Wealth of Networks \- How Social Production Transforms Markets and +Freedom, +Yochai Benkler (2006) +the_wealth_of_networks.yochai_benkler.sst .br -this will generate html including a concordance file, opendocument text format, -plaintext, XHTML and various forms of XML, and OpenDocument text - -.SH 29.2.2 LATEX / PDF +.I Through the Looking Glass, +Lewis Carroll (1871) +through_the_looking_glass.lewis_carroll.sst .br -Assuming a LaTeX engine such as tetex or texlive is installed with the required -modules (done automatically on selection of sisu\-pdf in -.B Debian -) +.I Two Bits \- The Cultural Significance of Free Software, +Christopher Kelty (2008) +two_bits.christopher_kelty.sst .br -Having moved to the directory that contains the markup samples (see -instructions above if necessary), choose a file and run sisu against it +.I UN Contracts for International Sale of Goods, +UN (1980) +un_contracts_international_sale_of_goods_convention_1980.sst .br -sisu \-pv free_as_in_freedom.rms_and_free_software.sam_williams.sst +.I Viral Spiral, +David Bollier (2008) +viral_spiral.david_bollier.sst +.SH SISU SEARCH \- INTRODUCTION .br -sisu \-3 free_as_in_freedom.rms_and_free_software.sam_williams.sst .br -should generate most available output formats: html including a concordance -file, opendocument text format, plaintext, XHTML and various forms of XML, and -OpenDocument text and pdf - -.SH 29.2.3 RELATIONAL DATABASE \- POSTGRESQL, SQLITE +.B SiSU +output can easily and conveniently be indexed by a number of standalone +indexing tools, such as Lucene, Hyperestraier. .br -Relational databases need some setting up \- you must have permission to create -the database and write to it when you run sisu. +Because the document structure of sites created is clearly defined, and the +text +.I 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. .br -Assuming you have the database installed and the requisite permissions +In addition to this +.B 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. +.SH SQL .br -sisu \-\-sqlite \-\-recreate -.br -sisu \-\-sqlite \-v \-\-import -free_as_in_freedom.rms_and_free_software.sam_williams.sst +.SH POPULATING SQL TYPE DATABASES .br -sisu \-\-pgsql \-\-recreate +.B SiSU +feeds sisu markupd documents into sql type databases +.I PostgreSQL +[^21] and/or +.I SQLite +[^22] database together with information related to document structure. .br -sisu \-\-pgsql \-v \-\-import -free_as_in_freedom.rms_and_free_software.sam_williams.sst - -.SH 29.3 GETTING HELP - -.SH 29.3.1 THE MAN PAGES +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 -Type: + * one containing semantic (and other) headers, including, title, author, + subject, (the + .I Dublin Core. + ..); .br - man sisu + * 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 -The man pages are also available online, though not always kept as up to date -as within the package itself: + * 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 -* sisu.1 [^26] + * 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 -* sisu.8 [^27] +There is of course the possibility to add further structures. .br -* man directory [^28] - -.SH 29.3.2 BUILT IN HELP +At this level +.B 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. .br -sisu \-\-help +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 +.B 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 +.I Dublin Core +is incorporated it is easy to make use of that as well). +.SH POSTGRESQL .br -sisu \-\-help \-\-env -.br -sisu \-\-help \-\-commands +.SH NAME .br -sisu \-\-help \-\-markup +.B SiSU +\- Structured information, Serialized Units \- a document publishing system, +postgresql dependency package -.SH 29.3.3 THE HOME PAGE +.SH DESCRIPTION .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) . -.br - +.SH SYNOPSIS .br - - -.SH 29.4 MARKUP SAMPLES + sisu \-D [instruction] [filename/wildcard \ if \ required] .br -A number of markup samples (along with output) are available off: + sisu \-D \-\-pg \-\-[instruction] [filename/wildcard \ if \ required] -.br - +.SH COMMANDS .br -Additional markup samples are packaged separately in the file: +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 .br -*** +.B \-D or \-\-pgsql +may be used interchangeably. -.br -On -.B Debian -they are available in non\-free[^29] to include them it is necessary to include -non\-free in your /etc/apt/source.list or obtain them from the sisu home site. +.SH CREATE AND DESTROY DATABASE -.SH 30. EDITOR FILES, SYNTAX HIGHLIGHTING -.br +.TP +.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) -.br -The directory: +.TP +.B sisu \-D \-\-createdb +creates database where no database existed before -.br - ./data/sisu/v2/conf/editor\-syntax\-etc/ +.TP +.B sisu \-D \-\-create +creates database tables where no database tables existed before -.br - ./data/sisu/v3/conf/editor\-syntax\-etc/ +.TP +.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). -.br - /usr/share/sisu/v2/conf/editor\-syntax\-etc +.TP +.B sisu \-D \-\-recreate +destroys existing database and builds a new empty database structure -.br - /usr/share/sisu/v3/conf/editor\-syntax\-etc +.SH IMPORT AND REMOVE DOCUMENTS -.br -contains rudimentary sisu syntax highlighting files for: +.TP +.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). -.br -* (g)vim +.TP +.B sisu \-D \-\-update \-v [filename/wildcard] +updates file contents in database -.br - package: sisu\-vim +.TP +.B sisu \-D \-\-remove \-v [filename/wildcard] +removes specified document from postgresql database. +.SH SQLITE .br -status: largely done -.br - there is a vim syntax highlighting and folds component +.SH NAME .br -* gedit +.B SiSU +\- Structured information, Serialized Units \- a document publishing system. -.br -* gobby +.SH DESCRIPTION .br - file: sisu.lang +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) . -.br -place in: +.SH SYNOPSIS .br - /usr/share/gtksourceview\-1.0/language\-specs + sisu \-d [instruction] [filename/wildcard \ if \ required] .br -or + sisu \-d \-\-(sqlite|pg) \-\-[instruction] [filename/wildcard \ if \ + required] -.br - ~/.gnome2/gtksourceview\-1.0/language\-specs +.SH COMMANDS .br - status: very basic syntax highlighting +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 .br - comments: this editor features display line wrap and is used by Goby! +.B \-d or \-\-sqlite +may be used interchangeably. -.br -* nano +.SH CREATE AND DESTROY DATABASE -.br - file: nanorc +.TP +.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) -.br -save as: +.TP +.B sisu \-d \-\-createdb +creates database where no database existed before -.br - ~/.nanorc +.TP +.B sisu \-d \-\-create +creates database tables where no database tables existed before -.br - status: basic syntax highlighting +.TP +.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). -.br - comments: assumes dark background; no display line\-wrap; does line breaks +.TP +.B sisu \-d \-\-recreate +destroys existing database and builds a new empty database structure -.br -* diakonos (an editor written in ruby) +.SH IMPORT AND REMOVE DOCUMENTS -.br -file: diakonos.conf +.TP +.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). -.br -save as: +.TP +.B sisu \-d \-\-update \-v [filename/wildcard] +updates file contents in database -.br - ~/.diakonos/diakonos.conf +.TP +.B sisu \-d \-\-remove \-v [filename/wildcard] +removes specified document from sqlite database. +.SH INTRODUCTION .br -includes: -.br - status: basic syntax highlighting +.SH SEARCH \- DATABASE FRONTEND SAMPLE, UTILISING DATABASE AND SISU FEATURES, +INCLUDING OBJECT CITATION NUMBERING (BACKEND CURRENTLY POSTGRESQL) .br -comments: assumes dark background; no display line\-wrap +Sample search frontend [^23] A small database and +sample query front\-end (search from) that makes use of the citation system, +.I object citation numbering +to demonstrates functionality.[^24] .br -* kate & kwrite +.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 +all outputs using +.I object citation numbering, +which includes html, +.I XML, +.I EPUB, +.I LaTeX, +.I PDF +and indeed the +.I SQL +database. You can then refer to one of the other outputs or in the +.I SQL +database expand the text within the matched objects (paragraphs) in the +documents matched. .br - file: sisu.xml +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] -.br - place in: +.TP +.B sisu \-F \-\-webserv\-webrick +builds a cgi web search frontend for the database created .br - /usr/share/apps/katepart/syntax +The following is feedback on the setup on a machine provided by the help +command: .br - or + sisu \-\-help sql -.br - ~/.kde/share/apps/katepart/syntax +.nf +Postgresql + user: ralph + current db set: SiSU_sisu + port: 5432 + dbi connect: DBI:Pg:database=SiSU_sisu;port=5432 +sqlite + current db set: /home/ralph/sisu_www/sisu/sisu_sqlite.db + dbi connect DBI:SQLite:/home/ralph/sisu_www/sisu/sisu_sqlite.db +.fi .br - [settings::configure \ kate::{highlighting,filetypes}] +Note on databases built .br - [tools::highlighting::{markup,scripts}:: \ .B \ SiSU \ ] +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] -.br -* nedit +.SH SEARCH FORM -.br - file: sisu_nedit.pats +.TP +.B sisu \-F +generates a sample search form, which must be copied to the web\-server cgi +directory -.br - nedit \-import sisu_nedit.pats +.TP +.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 -.br - status: a very clumsy first attempt [not \ really \ done] +.TP +.B sisu \-W +starts the webrick server which should be available wherever sisu is properly +installed .br - comments: this editor features display line wrap +The generated search form must be copied manually to the webserver directory as +instructed +.SH SISU_WEBRICK .br -* emacs -.br - files: sisu\-mode.el +.SH NAME .br - to file ~/.emacs add the following 2 lines: +.B SiSU +\- Structured information, Serialized Units \- a document publishing system -.br - (add\-to\-list 'load\-path - "/usr/share/sisu/v2/conf/editor\-syntax\-etc/emacs") +.SH SYNOPSIS .br - (require 'sisu\-mode.el) +sisu_webrick [port] .br - [not \ done \ / \ not \ yet \ included] +or .br -* vim & gvim +sisu \-W [port] -.br - files: +.SH DESCRIPTION .br - package is the most comprehensive sisu syntax highlighting and editor - environment provided to date (is for vim/ gvim, and is separate from the - contents of this directory) +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 +.B SiSU +output is written, providing a list of these directories (assuming +.B SiSU +is in use and they exist). .br - status: this includes: syntax highlighting; vim folds; some error checking +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). -.br - comments: this editor features display line wrap +.SH SUMMARY OF MAN PAGE .br -NOTE: +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] .br -[ \ .B \ SiSU \ parses \ files \ with \ long \ lines \ or \ line \ breaks, \ -but, \ display \ linewrap \ (without \ line\-breaks) \ is \ a \ convenient \ -editor \ feature \ to \ have \ for \ sisu \ markup] +where no port is given and settings are unchanged the default port is 8081 -.SH 31. HOW DOES SISU WORK? -.br +.SH DOCUMENT PROCESSING COMMAND FLAGS .br +sisu \-W [port] starts +.B Ruby +Webrick web\-server, serving .B SiSU -markup is fairly minimalistic, it consists of: a (largely optional) document -header, made up of information about the document (such as when it was -published, who authored it, and granting what rights) and any processing -instructions; and markup within the substantive text of the document, which is -related to document structure and typeface. -.B SiSU -must be able to discern the structure of a document, (text headings and their -levels in relation to each other), either from information provided in the -document header or from markup within the text (or from a combination of both). -Processing is done against an abstraction of the document comprising of -information on the document's structure and its objects,[2] which the program -serializes (providing the object numbers) and which are assigned hash sum -values based on their content. This abstraction of information about document -structure, objects, (and hash sums), provides considerable flexibility in -representing documents different ways and for different purposes (e.g. search, -document layout, publishing, content certification, concordance etc.), and -makes it possible to take advantage of some of the strengths of established -ways of representing documents, (or indeed to create new ones). +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 32. SUMMARY OF FEATURES +.SH SUMMARY OF FEATURES .br .br * 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. +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 * 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]. +and more sparse than the most basic +.I HTML +) , [this \ may \ also \ be \ converted \ to \ .I \ XML \ representations \ of +\ the \ same \ input/source \ document]. .br * markup defines document structure (this may be done once in a header @@ -4502,38 +3520,59 @@ different strengths of various standard formats for representing documents, amongst the output formats currently supported are: .br - * html \- both as a single scrollable text and a segmented document +* +.I HTML +\- both as a single scrollable text and a segmented document .br - * xhtml +* +.I XHTML .br - * epub +* +.I EPUB .br - * XML \- both in sax and dom style xml structures for further development as - required +* +.I XML +\- both in sax and dom style xml structures for further development as required .br - * ODF \- open document format, the iso standard for document storage +* +.I ODT +\- Open Document Format text, the iso standard for document storage .br - * LaTeX \- used to generate pdf +* +.I LaTeX +\- used to generate pdf .br - * pdf (via LaTeX) +* +.I PDF +(via +.I LaTeX +) .br - * sql \- population of an sql database, (at the same object level that is - used to cite text within a document) +* +.I SQL +\- 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 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, +different output types, (e.g. PDFs produced using typesetting of +.I LaTeX, databases populated with documents at an individual object/paragraph level, -making possible granular search (and related possibilities)) +making possible +.I granular search +(and related possibilities)) .br * ensuring content can be cited in a meaningful way regardless of selected @@ -4544,17 +3583,21 @@ browsers and formats. sisu seeks to provide a common way of pinpoint the text within a document, (which can be utilized for citation and by 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. +oriented, (pdf, +.I HTML, +.I EPUB, +xml, sqlite, postgresql) , this numbering system can be used to reference +content. .br -* 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]. +* 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]. .br * long term maintainability of document collections in a world of changing @@ -4565,8 +3608,9 @@ considerable degree of future\-proofing, output representations are sometime in future, without modification of existing prepared texts .br -* SQL search aside, documents are generated as required and static once -generated. +* +.I SQL +search aside, documents are generated as required and static once generated. .br * documents produced are static files, and may be batch processed, this needs @@ -4575,8 +3619,10 @@ to be done only once but may be repeated for various reasons as desired presentations/representations) .br -* 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 ( +.I plaintext +utf\-8) if shared on the net may be used as input and processed locally to +produce the different document outputs .br * document source may be bundled together (automatically) with associated @@ -4590,8 +3636,15 @@ may be processed locally to produce the desired document outputs .br * for basic document generation, the only software dependency is .B 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 +and a few standard Unix tools (this covers +.I plaintext, +.I HTML, +.I EPUB, +.I XML, +.I ODF, +.I LaTeX +) . To use a database you of course need that, and to convert the +.I LaTeX generated to pdf, a latex processor like tetex or texlive. .br @@ -4615,8 +3668,8 @@ 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)... +say of files made up of objects), online viewing (e.g. html, xml, pdf) , or +paper publication (e.g. pdf) \... .br the solution arrived at is by extracting structural information about the @@ -4627,155 +3680,64 @@ 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. -.SH 33. HELP SOURCES -.br - -.SH 33.1 MAN PAGES - -.br - man sisu - -.br - man sisu\-concordance - -.br - man sisu\-epub - -.br - man sisu\-git - -.br - man sisu\-harvest - -.br - man sisu\-html - -.br - man sisu\-odf - -.br - man sisu\-pdf - -.br - man sisu\-pg - -.br - man sisu\-po - -.br - man sisu\-sqlite - -.br - man sisu\-txt - -.br - man 7 sisu_complete - -.br - man 7 sisu_pdf - -.br - man 7 sisu_postgresql - -.br - man 7 sisu_sqlite - -.br - man sisu_termsheet - -.br - man sisu_webrick - -.SH 33.2 SISU GENERATED OUTPUT \- LINKS TO HTML - -.br -Note -.B SiSU -documentation is prepared in -.B SiSU -and output is available in multiple formats including amongst others html, pdf, -odf and epub, which may be also be accessed via the html pages[^30] - -.SH 33.2.1 WWW.SISUDOC.ORG - -.br - - -.br - - -.SH 33.3 MAN2HTML - -.SH 33.3.1 LOCALLY INSTALLED - -.br -file:///usr/share/doc/sisu/html/sisu.1.html - -.br - file:///usr/share/doc/sisu/html/sisu.1.html - -.br - /usr/share/doc/sisu/html/sisu_pdf.7.html - -.br - /usr/share/doc/sisu/html/sisu_postgresql.7.html +.TP +.BI 1. +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 - /usr/share/doc/sisu/html/sisu_sqlite.7.html +.TP +.BI 2. +i.e. the .br - /usr/share/doc/sisu/html/sisu_webrick.1.html - -.SH 33.3.2 WWW.JUS.UIO.NO/SISU +.I HTML, .br - +.I PDF, .br - +.I EPUB, .br - +.I ODT .br - +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 - +.TP +.BI 3. +the different heading levels .br - +.TP +.BI 4. +units of text, primarily paragraphs and headings, also any tables, poems, +code-blocks .br - - .TP -.BI 1. -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. +.BI 5. +An open standard format for e-books .br .TP -.BI 2. -i.e. the html, pdf, epub, odf 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. +.BI 6. +Open Document Format ( .br -.TP -.BI 3. -the different heading levels +.I ODF .br -.TP -.BI 4. -units of text, primarily paragraphs and headings, also any tables, poems, -code-blocks +) text .br .TP -.BI 5. +.BI 7. Specification submitted by Adobe to ISO to become a full open ISO specification @@ -4784,14 +3746,9 @@ specification .br .TP -.BI 6. +.BI 8. ISO standard ISO/IEC 26300:2006 -.br -.TP -.BI 7. -An open standard format for e-books - .br .TP .BI *1. @@ -4809,33 +3766,39 @@ square brackets .br .TP -.BI 8. +.BI 9. .br .TP -.BI 9. +.BI 10. .br .TP -.BI 10. +.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 .TP -.BI 11. -files should be prepared using UTF-8 character encoding +.BI 12. +files should be prepared using + +.br +.I UTF-8 + +.br +character encoding .br .TP -.BI 12. +.BI 13. a footnote or endnote .br .TP -.BI 13. +.BI 14. self contained endnote marker & endnote in one .br @@ -4860,17 +3823,17 @@ editors notes, numbered asterisk footnote/endnote series .br .TP -.BI 14. +.BI 15. .br .TP -.BI 15. +.BI 16. .br .TP -.BI 17. +.BI 18. Table from the Wealth of Networks by Yochai Benkler .br @@ -4878,7 +3841,7 @@ Table from the Wealth of Networks by Yochai Benkler .br .TP -.BI 18. +.BI 19. \.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 @@ -4887,35 +3850,38 @@ appropriate suffix to use. .br .TP -.BI 20. +.BI 21. .br + .br + .br .TP -.BI 21. +.BI 22. .br + .br .TP -.BI 22. +.BI 23. .br .TP -.BI 23. +.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 .TP -.BI 24. +.BI 25. 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 @@ -4924,62 +3890,25 @@ way we can tell you without opening each document where within each your matches are found. .br -.TP -.BI 25. -There is nothing to stop MySQL support being added in future. - -.br -.TP -.BI 26. - - -.br -.TP -.BI 27. - -.br .TP -.BI 28. - - -.br -29. the -.B Debian -Free Software guidelines require that everything distributed within -.B Debian -can be changed \- and the documents are authors' works that while freely -distributable are not freely changeable. - -.br -30. named index.html or more extensively through sisu_manifest.html -.br - .SH SEE ALSO -.br -\fIsisu\fR(1), -.br -\fIsisu\-epub\fR(1), -.br -\fIsisu\-harvest\fR(1), -.br -\fIsisu\-html\fR(1), -.br -\fIsisu\-odf\fR(1), -.br -\fIsisu\-pdf\fR(1), -.br -\fIsisu\-pg\fR(1), -.br -\fIsisu\-sqlite\fR(1), -.br -\fIsisu\-txt\fR(1). -.br -\fIsisu_vim\fR(7) - + sisu(1), + sisu-epub(1), + sisu-harvest(1), + sisu-html(1), + sisu-odf(1), + sisu-pdf(1), + sisu-pg(1), + sisu-sqlite(1), + sisu-txt(1). + sisu_vim(7) +.TP .SH HOMEPAGE -.br -More information about \fBSiSU\fR can be found at <\fIhttp://www.sisudoc.org/\fR> or <\fIhttp://www.jus.uio.no/sisu/\fR>. - + More information about SiSU can be found at or +.TP +.SH SOURCE + +.TP .SH AUTHOR -\fBSiSU\fR is written by Ralph Amissah <\fIralph@amissah.com\fR>. + SiSU is written by Ralph Amissah -- cgit v1.2.3