aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorRalph Amissah <ralph@amissah.com>2014-02-05 01:28:30 -0500
committerRalph Amissah <ralph@amissah.com>2014-02-05 01:28:30 -0500
commitba017314c06829b8d8a92a85d2111a8582c4e1cc (patch)
treeae413a3c2eacce20422b238e0a57c16d5632adf8
parentdebian/changelog (5.3.0-1) (diff)
parentREADME & manpage (sisu.1) update (diff)
Merge tag 'sisu_5.3.1' into debian/sid
SiSU 5.3.1
-rw-r--r--README2469
-rw-r--r--data/doc/sisu/CHANGELOG_v537
-rw-r--r--data/doc/sisu/CHANGELOG_v637
-rw-r--r--data/doc/sisu/html/README6
-rw-r--r--data/doc/sisu/html/sisu-concordance.1.html69
-rw-r--r--data/doc/sisu/html/sisu-epub.1.html69
-rw-r--r--data/doc/sisu/html/sisu-git.1.html69
-rw-r--r--data/doc/sisu/html/sisu-harvest.1.html71
-rw-r--r--data/doc/sisu/html/sisu-html.1.html69
-rw-r--r--data/doc/sisu/html/sisu-odf.1.html69
-rw-r--r--data/doc/sisu/html/sisu-pdf.1.html69
-rw-r--r--data/doc/sisu/html/sisu-pg.1.html69
-rw-r--r--data/doc/sisu/html/sisu-po.1.html73
-rw-r--r--data/doc/sisu/html/sisu-sqlite.1.html69
-rw-r--r--data/doc/sisu/html/sisu-txt.1.html69
-rw-r--r--data/doc/sisu/html/sisu.1.html3290
-rw-r--r--data/doc/sisu/html/sisu_complete.7.html54
-rw-r--r--data/doc/sisu/html/sisu_pdf.7.html171
-rw-r--r--data/doc/sisu/html/sisu_postgresql.7.html198
-rw-r--r--data/doc/sisu/html/sisu_sqlite.7.html196
-rw-r--r--data/doc/sisu/html/sisu_termsheet.1.html76
-rw-r--r--data/doc/sisu/html/sisu_vim.7.html62
-rw-r--r--data/doc/sisu/html/sisu_webrick.1.html93
-rw-r--r--data/doc/sisu/markup-samples/manual/Rakefile (renamed from data/doc/sisu/markup-samples/sisu_manual/Rakefile)0
-rw-r--r--data/doc/sisu/markup-samples/manual/_sisu/image/GnuDebianLinuxRubyBetterWay.png (renamed from data/doc/sisu/markup-samples/sisu_manual/_sisu/image/GnuDebianLinuxRubyBetterWay.png)bin33396 -> 33396 bytes
-rw-r--r--data/doc/sisu/markup-samples/manual/_sisu/image/ruby_logo.png (renamed from data/doc/sisu/markup-samples/sisu_manual/_sisu/image/ruby_logo.png)bin8634 -> 8634 bytes
-rw-r--r--data/doc/sisu/markup-samples/manual/_sisu/image/sisu.png (renamed from data/doc/sisu/markup-samples/sisu_manual/_sisu/image/sisu.png)bin3260 -> 3260 bytes
-rw-r--r--data/doc/sisu/markup-samples/manual/_sisu/image/tux.png (renamed from data/doc/sisu/markup-samples/sisu_manual/_sisu/image/tux.png)bin6297 -> 6297 bytes
-rw-r--r--data/doc/sisu/markup-samples/manual/_sisu/rc/sisurc_by_fn.yml (renamed from data/doc/sisu/markup-samples/sisu_manual/_sisu/rc/sisurc_by_fn.yml)0
-rw-r--r--data/doc/sisu/markup-samples/manual/_sisu/rc/sisurc_by_fn_monolingual.yml (renamed from data/doc/sisu/markup-samples/sisu_manual/_sisu/rc/sisurc_by_fn_monolingual.yml)0
-rw-r--r--data/doc/sisu/markup-samples/manual/_sisu/rc/sisurc_by_ft.yml (renamed from data/doc/sisu/markup-samples/sisu_manual/_sisu/rc/sisurc_by_ft.yml)0
-rw-r--r--data/doc/sisu/markup-samples/manual/_sisu/rc/sisurc_by_ft_monolingual.yml (renamed from data/doc/sisu/markup-samples/sisu_manual/_sisu/rc/sisurc_by_ft_monolingual.yml)0
-rw-r--r--data/doc/sisu/markup-samples/manual/_sisu/rc/sisurc_by_lng.yml (renamed from data/doc/sisu/markup-samples/sisu_manual/_sisu/rc/sisurc_by_lng.yml)0
-rw-r--r--data/doc/sisu/markup-samples/manual/_sisu/sisu_document_make (renamed from data/doc/sisu/markup-samples/sisu_manual/_sisu/sisu_document_make)0
l---------data/doc/sisu/markup-samples/manual/_sisu/v5/sisurc.yml (renamed from data/doc/sisu/markup-samples/sisu_manual/_sisu/v5/sisurc.yml)0
l---------data/doc/sisu/markup-samples/manual/_sisu/v6/sisurc.yml (renamed from data/doc/sisu/markup-samples/sisu_manual/_sisu/v6/sisurc.yml)0
-rw-r--r--data/doc/sisu/markup-samples/manual/en/README.ssm39
-rw-r--r--data/doc/sisu/markup-samples/manual/en/sisu.ssm (renamed from data/doc/sisu/markup-samples/sisu_manual/en/sisu.ssm)4
-rw-r--r--data/doc/sisu/markup-samples/manual/en/sisu_commands.sst (renamed from data/doc/sisu/markup-samples/sisu_manual/en/sisu_commands.sst)13
-rw-r--r--data/doc/sisu/markup-samples/manual/en/sisu_config.ssi (renamed from data/doc/sisu/markup-samples/sisu_manual/en/sisu_config.ssi)0
-rw-r--r--data/doc/sisu/markup-samples/manual/en/sisu_content_directories.ssi (renamed from data/doc/sisu/markup-samples/sisu_manual/en/sisu_content_directories.ssi)0
-rw-r--r--data/doc/sisu/markup-samples/manual/en/sisu_css.ssi (renamed from data/doc/sisu/markup-samples/sisu_manual/en/sisu_css.ssi)0
-rw-r--r--data/doc/sisu/markup-samples/manual/en/sisu_description.sst (renamed from data/doc/sisu/markup-samples/sisu_manual/en/sisu_description.sst)24
-rw-r--r--data/doc/sisu/markup-samples/manual/en/sisu_download.ssi (renamed from data/doc/sisu/markup-samples/sisu_manual/en/sisu_download.ssi)0
-rw-r--r--data/doc/sisu/markup-samples/manual/en/sisu_examples.ssi (renamed from data/doc/sisu/markup-samples/sisu_manual/en/sisu_examples.ssi)0
-rw-r--r--data/doc/sisu/markup-samples/manual/en/sisu_faq.sst (renamed from data/doc/sisu/markup-samples/sisu_manual/en/sisu_faq.sst)0
-rw-r--r--data/doc/sisu/markup-samples/manual/en/sisu_filetypes.sst (renamed from data/doc/sisu/markup-samples/sisu_manual/en/sisu_filetypes.sst)0
-rw-r--r--data/doc/sisu/markup-samples/manual/en/sisu_help.sst (renamed from data/doc/sisu/markup-samples/sisu_manual/en/sisu_help.sst)0
-rw-r--r--data/doc/sisu/markup-samples/manual/en/sisu_help_sources.sst (renamed from data/doc/sisu/markup-samples/sisu_manual/en/sisu_help_sources.sst)0
-rw-r--r--data/doc/sisu/markup-samples/manual/en/sisu_homepages.ssi (renamed from data/doc/sisu/markup-samples/sisu_manual/en/sisu_homepages.ssi)0
-rw-r--r--data/doc/sisu/markup-samples/manual/en/sisu_how.ssi (renamed from data/doc/sisu/markup-samples/sisu_manual/en/sisu_how.ssi)0
-rw-r--r--data/doc/sisu/markup-samples/manual/en/sisu_howto.sst (renamed from data/doc/sisu/markup-samples/sisu_manual/en/sisu_howto.sst)0
-rw-r--r--data/doc/sisu/markup-samples/manual/en/sisu_install_run.sst186
-rw-r--r--data/doc/sisu/markup-samples/manual/en/sisu_installation.ssi (renamed from data/doc/sisu/markup-samples/sisu_manual/en/sisu_installation.ssi)0
-rw-r--r--data/doc/sisu/markup-samples/manual/en/sisu_interesting_to_whom.ssi (renamed from data/doc/sisu/markup-samples/sisu_manual/en/sisu_interesting_to_whom.ssi)0
-rw-r--r--data/doc/sisu/markup-samples/manual/en/sisu_introduction.sst43
-rw-r--r--data/doc/sisu/markup-samples/manual/en/sisu_manual.ssm (renamed from data/doc/sisu/markup-samples/sisu_manual/en/sisu_manual.ssm)6
-rw-r--r--data/doc/sisu/markup-samples/manual/en/sisu_markup.sst (renamed from data/doc/sisu/markup-samples/sisu_manual/en/sisu_markup.sst)0
-rw-r--r--data/doc/sisu/markup-samples/manual/en/sisu_markup_syntax_history.sst (renamed from data/doc/sisu/markup-samples/sisu_manual/en/sisu_markup_syntax_history.sst)0
-rw-r--r--data/doc/sisu/markup-samples/manual/en/sisu_output_overview.sst (renamed from data/doc/sisu/markup-samples/sisu_manual/en/sisu_output_overview.sst)0
-rw-r--r--data/doc/sisu/markup-samples/manual/en/sisu_postgresql.sst (renamed from data/doc/sisu/markup-samples/sisu_manual/en/sisu_postgresql.sst)0
-rw-r--r--data/doc/sisu/markup-samples/manual/en/sisu_quickstart.sst (renamed from data/doc/sisu/markup-samples/sisu_manual/en/sisu_quickstart.sst)0
-rw-r--r--data/doc/sisu/markup-samples/manual/en/sisu_remote.sst (renamed from data/doc/sisu/markup-samples/sisu_manual/en/sisu_remote.sst)0
-rw-r--r--data/doc/sisu/markup-samples/manual/en/sisu_search.ssm (renamed from data/doc/sisu/markup-samples/sisu_manual/en/sisu_search.ssm)0
-rw-r--r--data/doc/sisu/markup-samples/manual/en/sisu_search_cgi.ssi (renamed from data/doc/sisu/markup-samples/sisu_manual/en/sisu_search_cgi.ssi)0
-rw-r--r--data/doc/sisu/markup-samples/manual/en/sisu_search_intro.ssi (renamed from data/doc/sisu/markup-samples/sisu_manual/en/sisu_search_intro.ssi)0
-rw-r--r--data/doc/sisu/markup-samples/manual/en/sisu_short_feature_summary.ssi (renamed from data/doc/sisu/markup-samples/sisu_manual/en/sisu_short_feature_summary.ssi)0
-rw-r--r--data/doc/sisu/markup-samples/manual/en/sisu_sql.ssi (renamed from data/doc/sisu/markup-samples/sisu_manual/en/sisu_sql.ssi)0
-rw-r--r--data/doc/sisu/markup-samples/manual/en/sisu_sqlite.sst (renamed from data/doc/sisu/markup-samples/sisu_manual/en/sisu_sqlite.sst)0
-rw-r--r--data/doc/sisu/markup-samples/manual/en/sisu_synopsis.ssi (renamed from data/doc/sisu/markup-samples/sisu_manual/en/sisu_synopsis.ssi)0
-rw-r--r--data/doc/sisu/markup-samples/manual/en/sisu_syntax_highlighting.sst (renamed from data/doc/sisu/markup-samples/sisu_manual/en/sisu_syntax_highlighting.sst)0
-rw-r--r--data/doc/sisu/markup-samples/manual/en/sisu_webrick.sst (renamed from data/doc/sisu/markup-samples/sisu_manual/en/sisu_webrick.sst)0
-rw-r--r--data/doc/sisu/markup-samples/manual/en/sisu_work_needed_and_wishlist.ssi (renamed from data/doc/sisu/markup-samples/sisu_manual/en/sisu_work_needed_and_wishlist.ssi)0
-rw-r--r--data/doc/sisu/markup-samples/manual/translation_languages (renamed from data/doc/sisu/markup-samples/sisu_manual/translation_languages)0
-rw-r--r--data/doc/sisu/markup-samples/sisu_manual/en/sisu_introduction.sst55
-rw-r--r--data/sisu/v5/v/version.yml6
-rw-r--r--data/sisu/v6/v/version.yml6
-rw-r--r--lib/sisu/v5/ao_doc_str.rb5
-rw-r--r--lib/sisu/v5/ao_hash_digest.rb6
-rw-r--r--lib/sisu/v5/ao_images.rb8
-rw-r--r--lib/sisu/v5/ao_numbering.rb34
-rw-r--r--lib/sisu/v5/cgi_pgsql.rb36
-rw-r--r--lib/sisu/v5/cgi_sqlite.rb28
-rw-r--r--lib/sisu/v5/composite.rb10
-rw-r--r--lib/sisu/v5/concordance.rb9
-rw-r--r--lib/sisu/v5/constants.rb7
-rw-r--r--lib/sisu/v5/db_import.rb1
-rw-r--r--lib/sisu/v5/dbi.rb9
-rw-r--r--lib/sisu/v5/dbi_discrete.rb17
-rw-r--r--lib/sisu/v5/defaults.rb6
-rw-r--r--lib/sisu/v5/digests.rb8
-rw-r--r--lib/sisu/v5/html.rb18
-rw-r--r--lib/sisu/v5/html_format.rb80
-rw-r--r--lib/sisu/v5/html_lite_shared.rb7
-rw-r--r--lib/sisu/v5/html_minitoc.rb5
-rw-r--r--lib/sisu/v5/html_segments.rb6
-rw-r--r--lib/sisu/v5/html_tune.rb25
-rw-r--r--lib/sisu/v5/hub.rb22
-rw-r--r--lib/sisu/v5/options.rb59
-rw-r--r--lib/sisu/v5/param.rb11
-rw-r--r--lib/sisu/v5/particulars.rb6
-rw-r--r--lib/sisu/v5/remote.rb14
-rw-r--r--lib/sisu/v5/rexml.rb12
-rw-r--r--lib/sisu/v5/shared_markup_alt.rb6
-rw-r--r--lib/sisu/v5/src_kdissert_share.rb8
-rw-r--r--lib/sisu/v5/sst_from_xml.rb8
-rw-r--r--lib/sisu/v5/sysenv.rb173
-rw-r--r--lib/sisu/v5/texpdf.rb16
-rw-r--r--lib/sisu/v5/txt_plain.rb3
-rw-r--r--lib/sisu/v5/utils.rb6
-rw-r--r--lib/sisu/v5/webrick.rb22
-rw-r--r--lib/sisu/v5/xhtml_epub2.rb11
-rw-r--r--lib/sisu/v5/xhtml_epub2_format.rb16
-rw-r--r--lib/sisu/v5/xhtml_epub2_segments.rb2
-rw-r--r--lib/sisu/v5/xhtml_epub2_tune.rb20
-rw-r--r--lib/sisu/v5/xml_fictionbook2.rb6
-rw-r--r--lib/sisu/v5/xml_odf_odt.rb20
-rw-r--r--lib/sisu/v5/xml_odf_odt_format.rb19
-rw-r--r--lib/sisu/v6/ao_doc_str.rb5
-rw-r--r--lib/sisu/v6/ao_hash_digest.rb6
-rw-r--r--lib/sisu/v6/ao_images.rb8
-rw-r--r--lib/sisu/v6/ao_numbering.rb34
-rw-r--r--lib/sisu/v6/cgi_pgsql.rb36
-rw-r--r--lib/sisu/v6/cgi_sqlite.rb28
-rw-r--r--lib/sisu/v6/composite.rb10
-rw-r--r--lib/sisu/v6/concordance.rb9
-rw-r--r--lib/sisu/v6/constants.rb7
-rw-r--r--lib/sisu/v6/db_import.rb1
-rw-r--r--lib/sisu/v6/dbi.rb9
-rw-r--r--lib/sisu/v6/dbi_discrete.rb17
-rw-r--r--lib/sisu/v6/defaults.rb6
-rw-r--r--lib/sisu/v6/digests.rb8
-rw-r--r--lib/sisu/v6/html.rb18
-rw-r--r--lib/sisu/v6/html_format.rb80
-rw-r--r--lib/sisu/v6/html_lite_shared.rb7
-rw-r--r--lib/sisu/v6/html_minitoc.rb5
-rw-r--r--lib/sisu/v6/html_segments.rb6
-rw-r--r--lib/sisu/v6/html_tune.rb25
-rw-r--r--lib/sisu/v6/hub.rb22
-rw-r--r--lib/sisu/v6/options.rb59
-rw-r--r--lib/sisu/v6/param.rb11
-rw-r--r--lib/sisu/v6/particulars.rb6
-rw-r--r--lib/sisu/v6/remote.rb14
-rw-r--r--lib/sisu/v6/rexml.rb12
-rw-r--r--lib/sisu/v6/shared_markup_alt.rb6
-rw-r--r--lib/sisu/v6/src_kdissert_share.rb8
-rw-r--r--lib/sisu/v6/sst_from_xml.rb8
-rw-r--r--lib/sisu/v6/sysenv.rb173
-rw-r--r--lib/sisu/v6/texpdf.rb16
-rw-r--r--lib/sisu/v6/txt_plain.rb3
-rw-r--r--lib/sisu/v6/utils.rb6
-rw-r--r--lib/sisu/v6/webrick.rb22
-rw-r--r--lib/sisu/v6/xhtml_epub2.rb11
-rw-r--r--lib/sisu/v6/xhtml_epub2_format.rb16
-rw-r--r--lib/sisu/v6/xhtml_epub2_segments.rb2
-rw-r--r--lib/sisu/v6/xhtml_epub2_tune.rb20
-rw-r--r--lib/sisu/v6/xml_fictionbook2.rb6
-rw-r--r--lib/sisu/v6/xml_odf_odt.rb20
-rw-r--r--lib/sisu/v6/xml_odf_odt_format.rb19
-rw-r--r--man/man1/sisu.1209
-rw-r--r--rbuild4
161 files changed, 3639 insertions, 5980 deletions
diff --git a/README b/README
index 624f370c..e0550c83 100644
--- a/README
+++ b/README
@@ -1,518 +1,2235 @@
-%% SiSU versions 4 & 3, 2011
-Homepage: <http://www.jus.uio.no/sisu>
-* README
-* CHANGELOGS/CHANGELOG_v4
-* CHANGELOGS/CHANGELOG_v3
-* CHANGELOGS/CHANGELOG_v2
-* CHANGELOGS/CHANGELOG_v1
-
-Herein (this package) reside SiSU versions 4 and 3.
-
-%% Description
----------------
-
- SiSU is lightweight markup based document creation and publishing framework
- that is controlled from the command line. Prepare documents for SiSU using
- your text editor of choice, then use SiSU to generate various output document
- formats.
+SISU - README
+=============
- With minimal preparation of a plain-text (UTF-8) file using its native
- markup-syntax, SiSU produces: plain-text, HTML, XHTML, XML, EPUB (v2 only)
- ODF:ODT (Opendocument), LaTeX, PDF, and populates an SQL database (PostgreSQL
- or SQLite) with text objects, roughly, paragraph sized chunks so that
- document searches are done at this level of granularity.
+INTRODUCTION
+************
- Outputs share a common citation numbering system, associated with text
- objects and any semantic meta-data provided about the document.
+INTRODUCTION - WHAT IS SISU?
+----------------------------
- SiSU also provides concordance files, document content certificates and
- manifests of generated output. Book indexes may be made.
+*SiSU* is a lightweight markup based document creation and publishing framework
+that is controlled from the command line. Prepare documents for *SiSU* using
+your text editor of choice, then use *SiSU* to generate various output document
+formats.
- SiSU takes advantage of well established open standard ways of representing
- text, and provides a bridge to take advantage of the strengths of each,
- while retaining minimal markup requirement. SiSU implements a "useful
- common feature set" across document formats [coming from a humanities, law,
- and possibly social sciences perspective, rather than technical or
- scientific writing] ... focus is primarily on content and data integrity
- rather than appearance, (though outputs in the various formats are
- respectable).
+From a single lightly prepared document (plain-text /UTF-8/) 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. *SiSU* produces: plain-text, /HTML/, /XHTML/,
+/XML/, /EPUB/, /ODF/: /ODT/ (Opendocument), /LaTeX/, /PDF/, and populates an
+/SQL/ database (/PostgreSQL/ or /SQLite/) with text objects, roughly, paragraph
+sized chunks so that document searches are done at this level of granularity.
- Syntax highlighting files for a number of editors are provided.
- A vim syntax highlighting file and an ftplugin with folds for sisu markup is
- provided. Vim 7 includes syntax highlighting for SiSU.
+Outputs share a common citation numbering system, associated with text objects
+and any semantic meta-data provided about the document.
- man pages, and interactive help are provided.
+*SiSU* also provides concordance files, document content certificates and
+manifests of generated output. Book indexes may be made.
- Dependencies for various features are taken care of in sisu related packages.
- The package sisu-complete installs the whole of SiSU.
+Some document markup samples are provided in the package sisu -markup-samples.
- Additional document markup samples are provided in the package
- sisu-markup-samples which is found in the non-free archive the licenses for
- the substantive content of the marked up documents provided is that provided
- by the author or original publisher.
+Homepages:
+* <http://www.sisudoc.org/>
+* <http://www.jus.uio.no/sisu>
- Homepage: <http://www.jus.uio.no/sisu>
+INSTALL OR RUN WITHOUT INSTALLATION
+***********************************
-%% Take 2
----------
+SOURCE TARBALL
+--------------
-The ideas behind SiSU evolved working with managing static, published documents
-that needed to be citable, ideally searchable and preferably available in
-multiple formats over a period of time with a rapidly changing World Wide Web.
-Initial experience was in 1993, one issue being that the document content
-remained the same, but presentation needed to be updated with changing formats,
-html in particular has really changed since then.
+RUN OFF SOURCE PACKAGE DIRECTORY TREE (WITHOUT INSTALLING)
+..........................................................
-So the idea was to provide a minimal markup requirement for documents that
-remained the same, and a generator to convert that markup custom producing
-various output types. This made it possible to:
+1. Download the latest source (information available) from:
+<http://www.jus.uio.no/sisu/SiSU/download.html#current>
-* have a marked-up document set and continue improving the presentation, as the
-generators code was updated, e.g. update HTML as it evolves, and improve upon
-LaTeX driven pdf output
+2. Unpack the source
-* have available new document formats/ output types as they came to be of
-interest, e.g. version 2 includes EPUB
+Provided you have *Ruby*, *SiSU* can be run without installation straight from
+the source package directory tree. Run ruby against the full path to bin/sisu
+(in the unzipped source package directory tree)
-* produce a citation system that is available across different output types,
-text based on objects (rather than page numbers), i.e. you can accurately and
-reliably cite text within a document regardless of the document format version
-that is being looked at
+Note however, that additional external package dependencies, such as texlive
+(for pdfs), sqlite3 or postgresql (for search) should you desire to use them
+are not taken care of for you.
-* take advantage of the strengths of disparate technologies representing text,
-each output type being custom generated for that format, the object citation
-system lends itself as a result is that there is little necessity that one
-output type should be based on or related to another, just that the content is
-preserved and presented in a way that is well suited to the output type in
-question
+GEM INSTALL (WITH RAKE)
+.......................
-* produce consistent quality presentation for material, suitable where
-substance/content is more important than appearance, there is some sacrifice of
-flexibility and no concept of wysiwyg, e.g. there is no attempt to make pdf
-output identical to html, rather the system attempts to take advantage of
-making the best presentation it can in each output format taking advantage of
-the strengths of that format available to it given the minimal markup (sisu
-document preparation); the citation system ensures you can pinpoint the same
-text
+Gem install, you need to:
-SiSU works best:
+(i) create the gemspec; (ii) build the gem (from the gemspec); (iii) install
+the gem
-* with published works (e.g. books, articles), static documents the content of
-which is changed rarely, and ideally when they do in the form of a new edition.
+Provided you have ruby & rake, this can be done with the single command:
-* for literature and law related content
+ rake gem_create_build_install # (to build and install sisu v5 & sisu v6,
+ alias gemcbi)
-SiSU uses Unicode, utf-8 where it is available,
------
+separate gems are made/installed for sisu v5 & sisu v6 contained in source:
-SiSU - simple information structuring universe, is a publishing tool, document
-generation and management, (and search enabling) tool primarily for literary,
-academic and legal published works.
+ rake gem_create_build_install_stable # (to build and install sisu v5, alias
+ gem5cbi)
-SiSU can be used for Internet, Intranet, local filesystem or cd publishing.
+ rake gem_create_build_install_unstable # (to build and install sisu v6, alias
+ gem6cbi)
-SiSU can be used directly off the filesystem, or from a database.
+for individual steps (create, build, install) see rake options, rake -T to
+specify sisu version for sisu installed via gem
-SiSU's scalability, is be dependent on your hardware, and filesystem and/or
-database Postgresql.
+ sisu _5.3.0_ --version
-Amongst it's characteristics are:
+ sisu _6.0.0_ --version
-* simple mnemonoic markup style,
+to uninstall sisu installed via gem
-* the ability to produce multiple output formats, including html, XML, EPUB,
-LaTeX, pdf (via LaTeX), stream to a relational database whilst retaining
-document structure - Postgresql and Sqlite,
+ sudo gem uninstall --verbose sisu
-* that all share a common citation system (a simple idea from which much good),
-possibly most exciting, the following: if fed into a relational database (as it
-can be automatically), the document set is searchable, with results displayed
-at a paragraph level, or the possibility of an indexed display of documents
-identifying the paragraph in which the match is found (using the object
-citation numbering system) together with a hyperlinked listing for each of each
-paragraph in which the match is found. In any event citations using this system
-(with or without the relational database) are relevant for all output formats.
+For a list of alternative actions you may type:
-* it is command line driven, and can be set up on a remote server
+ rake help
-* Documents are marked up in SiSU syntax in your favourite editor. SiSU syntax
-may be regarded as a type of smart ascii - which in its basic form is simpler
-than the most elementary html. There is currently a syntax highlighter, and
-folding for Vim. Syntax highlighters for other editors are welcome.
+ rake -T
-Input files should be UTF-8
+Rake: <http://rake.rubyforge.org/> <http://rubyforge.org/frs/?group_id=50>
-Once set up it is simple to use.
+Rant: <http://make.rubyforge.org/> <http://rubyforge.org/frs/?group_id=615>
-%% Information, places to look
----------------
+INSTALLATION WITH SETUP.RB
+..........................
-Within the SiSU tarball:
+It should also be possible to install sisu using setup.rb
- ./data/doc/sisu/v2/sisu_markup_samples/sisu_manual
+this is a three step process, in the root directory of the unpacked *SiSU* as
+root type:
-Once installed, directory equivalent to:
+ruby setup.rb config
+ruby setup.rb setup
+#[as root:]
+ruby setup.rb install
- <file:///usr/share/doc/sisu/v2/sisu_markup_samples/sisu_manual/>
-Available man pages are converted back to html using man2html:
+further information:
+<http://i.loveruby.net/en/projects/setup/>
+<http://i.loveruby.net/en/projects/setup/doc/usage.html>
- <file:///usr/share/doc/sisu/v2/html/>
+ ruby setup.rb config && ruby setup.rb setup && sudo ruby setup.rb install
- ./data/doc/sisu/v2/html/
+UNIX/LINUX DISTRIBUTION
+-----------------------
-%% Online Information, places to look
----------------
+A distribution install should take care of the dependencies of sisu for
+producing various outputs.
- <http://www.jus.uio.no/sisu>
+DEBIAN
+......
-Download Sources:
- <http://www.jus.uio.no/sisu/SiSU/download.html#current>
- <http://www.jus.uio.no/sisu/SiSU/download.html#debian>
+*SiSU* is available off the *Debian* archives. It should necessary only to run
+as root, Using apt-get:
-%% Installation
----------------
-NB. Platform is Unix / Linux.
+ apt-get update
-%% Debian
----------------
-If you use Debian use the Debian packages,
-check the information at:
- <http://www.jus.uio.no/sisu/SiSU/download.html#debian>
+ apt get install sisu-complete
-(A) SiSU is available directly off the Debian archives for Sid and testing. It
-should necessary only to run as root:
- aptitude update
- aptitude install sisu-complete
+(all sisu dependencies should be taken care of)
-(B) 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
+If there are newer versions of *SiSU* upstream, they will be available by
+adding the following to your 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
+#/etc/apt/sources.list
- [the non-free line is for document markup
- samples, for which the substantive text is
- provided under the author or original
- publisher's license and which in most cases will
- not be debian free software guideline compliant]
+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
-Then as root run:
- aptitude update
- aptitude install sisu-complete
-%% RPM
----------------
-RPMs are provided though untested, they are prepared by running alien against the
-source package, and against the debs.
+The non-free section is for sisu markup samples provided, which contain
+authored works the substantive text of which cannot be changed, and which as a
+result do not meet the debian free software guidelines.
-They may be downloaded from:
- <http://www.jus.uio.no/sisu/SiSU/download.html#rpm>
+*SiSU* is developed on *Debian*, and packages are available for *Debian* that
+take care of the dependencies encountered on installation.
-%% Source package .tgz
----------------
-Otherwise to install SiSU from source, check information at:
- <http://www.jus.uio.no/sisu/SiSU/download.html#current>
+The package is divided into the following components:
-alternative modes of installation from source are provided,
-setup.rb (by Minero Aoki),
-rake (by Jim Weirich) built install file,
-rant (by Stefan Lang) built install file,
+ *sisu*, the base code, (the main package on which the others depend), without
+ any dependencies other than ruby (and for convenience the ruby webrick web
+ server), this generates a number of types of output on its own, other
+ packages provide additional functionality, and have their dependencies
-Ruby is the essential dependency for the basic operation of SiSU
+ *sisu-complete*, a dummy package that installs the whole of greater sisu as
+ described below, apart from sisu -examples
-1. Download the latest source (information available) from:
- <http://www.jus.uio.no/sisu/SiSU/download.html#current>
+ *sisu-pdf*, dependencies used by sisu to produce pdf from /LaTeX/ generated
-2. Unpack the source
+ *sisu-postgresql*, dependencies used by sisu to populate postgresql database
+ (further configuration is necessary)
-Note however, that additional external package dependencies,
-such as texlive or postgresql should you desire to use it
-are not taken care of for you.
+ *sisu-sqlite*, dependencies used by sisu to populate sqlite database
+
+ *sisu-markup-samples*, sisu markup samples and other miscellany (under
+ *Debian* Free Software Guidelines non-free)
+
+*SiSU* is available off Debian Unstable and Testing [link:
+<http://packages.debian.org/cgi-bin/search_packages.pl?searchon=names&subword=1&version=all&release=all&keywords=sisu>]
+[^1] install it using apt-get, aptitude or alternative *Debian* install tools.
+
+DEPENDENCIES
+------------
+
+Here is a list of sisu' s current dependencies,[^2] which depend on such
+factors as whether you want to generate pdf, whether you will be using *SiSU*
+with or without a database, ...). sisu_markup-samples may also be of interest.
+
+Package: sisu
+Depends: ruby | ruby-interpreter, openssl, rsync, unzip, zip
+Recommends: sisu-pdf, sisu-sqlite, sisu-postgresql, imagemagick |
+graphicsmagick, keychain, openssh-client | lsh-client, po4a, qrencode, rake,
+ruby-rmagick, tidy, tree, vim-addon-manager
+Suggests: lv, calibre, pinfo, poedit, texinfo, trang
+
+
+Package: sisu-complete
+Depends: ruby | ruby-interpreter, sisu (= ${source:Version}), sisu-pdf (=
+${source:Version}), sisu-postgresql (= ${source:Version}), sisu-sqlite (=
+${source:Version})
+Description-en: installs all SiSU related packages
+
+
+Package: sisu-pdf
+Depends: ruby | ruby-interpreter, sisu (= ${source:Version}),
+texlive-latex-base, texlive-fonts-recommended, texlive-generic-recommended,
+texlive-latex-recommended, texlive-latex-extra, texlive-math-extra,
+texlive-xetex, fonts-liberation, lmodern, latex-cjk-all, texlive-lang-cjk
+Suggests: evince | pdf-viewer
+
+
+Package: sisu-postgresql
+Depends: ruby | ruby-interpreter, sisu (= ${source:Version}), postgresql,
+ruby-dbd-pg, ruby-dbi, ruby-fcgi
+Suggests: postgresql-contrib
+
+
+Package: sisu-sqlite
+Depends: ruby | ruby-interpreter, sisu (= ${source:Version}), sqlite3,
+ruby-sqlite3, ruby-dbd-sqlite3, ruby-dbi, ruby-fcgi
+
+
+Package: sisu-markup-samples
+Depends: sisu
+
+
+COMMANDS
+********
+
+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 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)
+
+*--ao [filename/wildcard/url]*
+assumed for most other flags, creates new intermediate files for processing
+(abstract objects, 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. (sisu v5)
+
+*-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*
+see --color-on
+
+*--color-off*
+turn off color in output to terminal
+
+*--color-on*
+turn on color in output to terminal
+
+*--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
+(abstract objects, 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. Renamed --ao (abstract objects) in sisu v5. Alias -m
+
+*--delete [filename/wildcard]*
+see --zap
+
+*--docbook [filename/wildcard/url]*
+docbook smart text (sisu v5)
+
+*--dump[=directory_path] [filename/wildcard]*
+places output in directory specified, if none is specified in the current
+directory (pwd). Unlike using default settings /HTML/ files have embedded css.
+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
+
+*--fictionbook [filename/wildcard/url]*
+fictionbook smart text (sisu v5)
+
+*--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, in two forms (i) segmented text with table of contents
+(toc.html and index.html) and (ii) the document in a single file (scroll.html).
+Alias -h
+
+*--html-scroll [filename/wildcard]*
+produces html output, the document in a single file (scroll.html) only. Compare
+--html-seg and --html
+
+*--html-seg [filename/wildcard]*
+produces html output, segmented text with table of contents (toc.html and
+index.html). Compare --html-scroll and --html
+
+*--html-strict [filename/wildcard]*
+produces html with --strict option. see --strict
+
+*-I [filename/wildcard]*
+see --texinfo
+
+*-i [filename/wildcard]*
+see --manpage
+
+*--i18n-**
+these flags affect output by filetype and filename): --i18n-mono
+(--monolingual) output filenames without language code for default language
+('en' or as set); --i18n-multi (--multilingual) language code provided as part
+of the output filename, this is the default. Where output is in one language
+only the language code may not be desired. see also --output-by-*
+
+*--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).
+
+*-k*
+see --color-off
+
+*--keep-processing-files [filename/wildcard/url]*
+see --maintenance
+
+*-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.
+
+*--markdown [filename/wildcard/url]*
+markdown smart text (sisu v5)
+
+*--manpage [filename/wildcard]*
+produces man page of file, not suitable for all outputs. Alias -i
+
+*--monolingual*
+see --i18n-*
+
+*--multilingual*
+see --i18n-*
+
+*-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
+
+*--ocn*
+see --inc-ocn and --exc-ocn
+
+*--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
+
+*--papersize-(a4|a5|b5|letter|legal)*
+in conjunction with --pdf set pdf papersize, overriding any configuration
+settings, to set more than one papersize repeat the option --pdf --papersize-a4
+--papersize-letter. See also --papersize=*
+
+*--papersize=a4,a5,b5,letter,legal* in conjunction with --pdf set pdf
+papersize, overriding any configuration settings, to set more than one
+papersize list after the equal sign with a comma separator
+--papersize=a4,letter. See also --papersize-*
+
+*--pdf [filename/wildcard]*
+produces /LaTeX/ pdf (portrait.pdf & landscape.pdf). Orientation and papersize
+may be set on the command-line. 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), and; --landscape or --portrait,
+so: e.g. "sisu --pdf-a4 --pdf-letter --landscape --verbose [filename/wildcard]"
+or "sisu --pdf --landscape --a4 --letter --verbose [filename/wildcard]". --pdf
+defaults to both landscape & portrait output, and a4 if no other papersizes are
+configured. Related options --pdf-landscape --pdf-portrait --pdf-papersize-*
+--pdf-papersize=[list]. Alias -p
+
+*--pdf-l [filename/wildcard]*
+See --pdf-landscape
+
+*--pdf-landscape [filename/wildcard]*
+sets orientation, produces /LaTeX/ 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). Related options
+--pdf --pdf-portrait. See also --papersize-* or --papersize=[list]. Alias
+--pdf-l or in conjunction with --pdf --landscape
+
+*--pdf-p [filename/wildcard]*
+See --pdf-portrait
+
+*--pdf-portrait [filename/wildcard]*
+sets orientation, produces /LaTeX/ pdf portrait.pdf.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). Related
+options --pdf --pdf-landscape. See also --papersize-* or --papersize=[list].
+Alias --pdf-p or in conjunction with --pdf --portrait
+
+*--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). Unlike using default settings
+/HTML/ files have embedded css. Compare --dump
+
+*--rst [filename/wildcard/url]*
+ReST (rST restructured text) smart text (sisu v5)
+
+*--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 [--db=(pgsql|sqlite)] [--webserv=webrick]*
+generate examples of (naive) cgi search form for /SQLite/ or PgSQL depends on
+your already having used sisu to populate an /SQLite/ 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 --sqlite & --pg and the database section below. Optional
+additional parameters include: url location of webserver search form and db:
+--webserv-search='[url]'; location of webserver output:
+--webserv-output='[url]'; cgi search form link name:
+--cgi-search-form-name='[name.cgi]'; for pgsql, database user:
+--db-user='[username]'. 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
+
+*--strict*
+together with --html, produces more w3c compliant html, for example not having
+purely numeric identifiers for text, the location object url#33 becomes url#o33
+
+*-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
+
+*--textile [filename/wildcard/url]*
+textile smart text (sisu v5)
+
+*--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
+
+*--txt-asciitext [filename/wildcard]*
+see --asciitext
+
+*--txt-markdown [filename/wildcard]*
+see --markdown
+
+*--txt-rst [filename/wildcard]*
+see --rst
+
+*--txt-textile [filename/wildcard]*
+see --textile
+
+*-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
+
+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 /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]
+
+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.
+
+INTRODUCTION TO SISU MARKUP[^3]
+-------------------------------
+
+SUMMARY
+.......
+
+*SiSU* source documents are /plaintext/ (/UTF-8/)[^4] 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 4.0
+
+@title: SiSU
+ :subtitle: Manual
+
+@creator:
+ :author: Amissah, Ralph
+
+@publisher: [publisher name]
+
+@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3
+
+@classify:
+ :topic_register: SiSU:manual;electronic documents:SiSU:manual
+ :subject: ebook, epublishing, electronic book, electronic publishing,
+ electronic document, electronic citation, data structure,
+ citation systems, search
+
+% used_by: manual
+
+@date:
+ :published: 2008-05-22
+ :created: 2002-08-28
+ :issued: 2002-08-28
+ :available: 2002-08-28
+ :modified: 2010-03-03
+
+@make:
+ :num_top: 1
+ :breaks: new=C; break=1
+ :bold: /Gnu|Debian|Ruby|SiSU/
+ :home_button_text: {SiSU}http://sisudoc.org; {git}http://git.sisudoc.org
+ :footer: {SiSU}http://sisudoc.org; {git}http://git.sisudoc.org
+ :manpage: name=sisu - documents: markup, structuring, publishing in multiple standard formats, and search;
+ synopsis=sisu [-abcDdeFhIiMmNnopqRrSsTtUuVvwXxYyZz0-9] [filename/wildcard ]
+ . sisu [-Ddcv] [instruction]
+ . sisu [-CcFLSVvW]
+ . 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
+
+*@identifier:* information or instructions
+
+where the "identifier" is a tag recognised by the program, and the
+"information" or "instructions" belong to the tag/identifier specified
+
+Note: a header where used should only be used once; all headers apart from
+@title: are optional; the @structure: header is used to describe document
+structure, and can be useful to know.
+
+This is a sample header
+
+% SiSU 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 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
-%% to use setup.rb
----------------
-this is a three step process,
-in the root directory of the unpacked SiSU as root type:
+_9 indent paragraph nine steps
- ruby setup.rb config
- ruby setup.rb setup
- #[as root:]
- ruby setup.rb install
- further information:
- <http://i.loveruby.net/en/projects/setup/>
- <http://i.loveruby.net/en/projects/setup/doc/usage.html>
+*resulting output:*
-%% to use install (prapared with "Rake")
----------------
-Rake must be installed on your system:
- <http://rake.rubyforge.org/>
- <http://rubyforge.org/frs/?group_id=50>
+ordinary paragraph
-in the root directory of the unpacked SiSU as root type:
- rake
+ 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 no
+ indent, rest of paragraph indented one step; first line no indent, rest of
+ paragraph indented one step; first line no indent, rest of paragraph indented
+ one step; first line no indent, rest of paragraph indented one step; first
+ line no indent, rest of paragraph indented one step; first line no indent,
+ rest of paragraph indented one step; first line no indent, rest of paragraph
+ indented one step; first line no indent, rest of paragraph indented one step;
+
+A regular paragraph.
+
+ first line indented, rest of paragraph no indent first line indented, rest of
+paragraph no indent first line indented, rest of paragraph no indent first line
+indented, rest of paragraph no indent first line indented, rest of paragraph no
+indent first line indented, rest of paragraph no indent first line indented,
+rest of paragraph no indent first line indented, rest of paragraph no indent
+first line indented, rest of paragraph no indent first line indented, rest of
+paragraph no indent first line indented, rest of paragraph no indent
+
+in each case level may be 0-9
+
+*live-build* A collection of scripts used to build customized *Debian*
+ Livesystems. /live-build/ was formerly known as live-helper, and even earlier
+ known as live-package.
+
+*live-build*
+ A collection of scripts used to build customized *Debian* Livesystems.
+ /live-build/ was formerly known as live-helper, and even earlier known as
+ live-package.
+
+FOOTNOTES / 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:*
+
+[^5]
+
+*markup example:*
+
+normal text~{ self contained endnote marker & endnote in one }~ continues
+
+
+*resulting output:*
+
+normal text[^6] 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 plus symbol 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:*
+
+about SiSU [link: <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 [link: <http://www.sisudoc.org/>] [^7] markup
+
+Internal document links to a tagged location, including an ocn
+
+*markup example:*
+
+about { text links }#link_text
+
+
+*resulting output:*
+
+about text links
+
+Shared document collection link
+
+*markup example:*
+
+about { SiSU book markup examples }:SiSU/examples.html
+
+
+*resulting output:*
+
+about *SiSU* book markup examples
+
+
+----------------------------------------
+
+LINKING IMAGES
+..............
+
+*markup example:*
+
+{ tux.png 64x80 }image
+
+% various url linked images
+[image: "a better way"]
+ [image: "Way Better - with Gnu/Linux, Debian and Ruby"]
+
+{~^ ruby_logo.png "Ruby" }http://www.ruby-lang.org/en/
+
+
+*resulting output:*
+
+tux.png 64x80 [link: local image]
+
+tux.png 64x80 "Gnu/Linux - a better way" [link: <http://www.sisudoc.org/>]
+
+GnuDebianLinuxRubyBetterWay.png 100x101 "Way Better - with Gnu/Linux, Debian
+and Ruby" [link: <http://www.sisudoc.org/>]
+
+ruby_logo.png 70x90 "Ruby" [link: <http://www.ruby-lang.org/en/>] [^8]
+
+*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 [link: <http://niu/manual/en/manifest/viral_spiral.david_bollier.html>]
+ document manifest [link: <http://niu/manual/en/manifest/viral_spiral.david_bollier.html>]
+ html, segmented text [link: <http://niu/manual/en/html/viral_spiral.david_bollier/toc.html>]
+ html, scroll, document in one [link: <http://niu/manual/en/html/viral_spiral.david_bollier.html>]
+ epub [link: <http://niu/manual/en/epub/viral_spiral.david_bollier.epub>]
+ pdf, landscape [link: <http://niu/manual/en/pdf/viral_spiral.david_bollier.landscape.a4.pdf>]
+ pdf, portrait [link: <http://niu/manual/en/pdf/viral_spiral.david_bollier.landscape.a4.pdf>]
+ odf: odt, open document text [link: <http://niu/manual/en/odt/viral_spiral.david_bollier.odt>]
+ xhtml scroll [link: <http://niu/manual/en/xhtml/viral_spiral.david_bollier.xhtml>]
+ xml, sax [link: <http://niu/manual/en/xml_sax/viral_spiral.david_bollier.sax.xml>]
+ xml, dom [link: <http://niu/manual/en/xml_dom/viral_spiral.david_bollier.dom.xml>]
+ concordance [link: <http://niu/manual/en/html/viral_spiral.david_bollier/concordance.html>]
+ dcc, document content certificate (digests) [link: <http://niu/manual/en/digest/viral_spiral.david_bollier.hash_digest.txt>]
+ markup source text [link: <http://niu/manual/en/src/viral_spiral.david_bollier.sst>]
+ markup source (zipped) pod [link: <http://niu/manual/en/src/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:*[^10]
+
+!_ 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).
+
+To draw a dividing line dividing paragraphs, see the section on page breaks.
+
+
+----------------------------------------
+
+PAGE BREAKS
+...........
+
+Page breaks are only relevant and honored in some output formats. A page break
+or a new page may be inserted manually using the following markup on a line on
+its own:
+
+page new =\= or ╋ breaks the page, starts a new page.
+
+page break -\- or ┼ breaks a column, starts a new column, if using columns,
+else breaks the page, starts a new page.
+
+page break line across page -..- draws a dividing line, dividing paragraphs
+
+page break:
+
+-\\-
or
- rake base
-This makes use of Rake (by Jim Weirich) and the provided Rakefile
+<:pb>
-For a list of alternative actions you may type:
- rake help
- rake -T
-%% to use install (prapared with "Rant")
----------------
-(you may use the instructions above for rake substituting rant if rant is
-installed on your system, or you may use an independent installer created using
-rant as follows:)
+page (break) new:
-in the root directory of the unpacked SiSU as root type:
- ruby ./sisu-install
+=\\=
or
- ruby ./sisu-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.
+<:pn>
- further information:
- <http://make.rubyforge.org/>
- <http://rubyforge.org/frs/?group_id=615>
-Dependencies
---------------
-Once installed see 'man 8 sisu' for some information on additional programs
-that sisu makes use of, and that you may need or wish to install. (this will
-depend on such factors as whether you want to generate pdf, whether you will be
-using SiSU with or without a database, ...) 'man sisu_markup-samples' may also be of
-interest if the sisu-markup-samples package has also been installed.
-
-The information in man 8 may not be most up to date, and it is possible that
-more useful information can be gleaned from the following notes taken from the
-Debian control file (end edited), gives an idea of additional packages that
-SiSU can make use of if available, (the use/requirement of some of which are
-interdependent for specific actions by SiSU):
+page (break) line across page (dividing paragraphs):
-Package: sisu
-Architecture: all
-Depends: ruby (>= 1.8.2), libwebrick-ruby, unzip, zip
-Conflicts: vim-sisu, sisu-vim, sisu-remote
-Replaces: vim-sisu, sisu-vim
-Recommends: sisu-pdf, sisu-sqlite, sisu-postgresql, librmagick-ruby, trang,
-tidy, librexml-ruby, openssl, rsync, openssh-client | lsh-client, keychain,
-hyperestraier, kdissert, vim-addon-manager
-Suggests: rcs | cvs, lv, texinfo, pinfo
+-..-
-Package: sisu-complete
-Depends: ruby (>= 1.8.4), sisu, sisu-pdf, sisu-postgresql, sisu-sqlite
-Recommends: hyperestraier
-Package: sisu-pdf
-Architecture: all
-Depends: sisu, texlive-latex-base, texlive-fonts-recommended,
-texlive-latex-recommended, texlive-latex-extra
-Suggests: evince, xpdf
+BOOK INDEX
+..........
-Package: sisu-postgresql
-Depends: sisu, postgresql-8.1, libdbi-ruby, libdbm-ruby, libdbd-pg-ruby
-Suggests: pgaccess, libdbd-pgsql, postgresql-contrib-8.1
+To make an index append to paragraph the book index term relates to it, using
+an equal sign and curly braces.
-Package: sisu-sqlite
-Depends: sisu, sqlite, libdbi-ruby, libdbm-ruby, libdbd-sqlite-ruby
-Suggests: libdbd-sqlite
+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.
-Package: sisu-markup-samples
-Depends: sisu
+ Paragraph containing main term and sub-term.
+ ={Main term:sub-term}
-%% Quick start
----------------
-Most of the installation should be taken care of by the aptitude or rant
-install. (The rant install if run in full will also test run the generation of
-the first document).
-After installation of sisu-complete, move to the document samples directory
+The index syntax starts on a new line, but there should not be an empty line
+between paragraph and index markup.
- cd /usr/share/doc/sisu/v2/sisu_markup_samples/dfsg
+The structure of the resulting index would be:
-and run
+ Main term, 1
+ sub-term, 1
- sisu -3 free_as_in_freedom.rms_and_free_software.sam_williams.sst
-[or the same:
- sisu -NhwpoabxXyv free_as_in_freedom.rms_and_free_software.sam_williams.sst
-]
+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.
-look at output results, see the "sisu_manifest" page created for the document
+ Paragraph containing main term, second term and sub-term.
+ ={first term; second term: sub-term}
-or to generate an online document move to a writable directory, as the file
-will be downloaded there and e.g.
-sisu -3 http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/free_culture.lawrence_lessig.sst
+The structure of the resulting index would be:
-the database stuff is extra perhaps, the latex stuff could be considered extra
-perhaps but neither needs to be installed for most of sisu output to work
+ First term, 1,
+ Second term, 1,
+ sub-term, 1
-examine source document, vim has syntax support
-gvim free_as_in_freedom.rms_and_free_software.sam_williams.sst
+If multiple sub-terms appear under one paragraph, they are separated under the
+main term heading from each other by a pipe symbol.
-additional markup samples in
-<http://www.jus.uio.no/sisu/SiSU/2.html>
+ Paragraph containing main term, second term and sub-term.
+ ={Main term:
+ sub-term+2|second sub-term;
+ Another term
+ }
-For help
- man sisu
+ A paragraph that continues discussion of the first sub-term
-%% Configuration files
----------------
-The default configuration/setup is contained within the program and is altered
-by configuration settings in /etc/[sisu version]/sisurc.yml
-or in ~/.sisu/sisurc.yml
+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:
-* configuration file - a yaml file
- /etc/sisu/[sisu version]/sisurc.yml
- ~/.sisu/sisurc.yml
+ Main term, 1,
+ sub-term, 1-3,
+ second sub-term, 1,
+ Another term, 1
-* directory structure - setting up of output and working directory.
-* skins - changing the appearance of a project, directory or individual
-documents within ~/.sisu/skin
- ~/.sisu/skin/doc contains individual skins, with symbolic links from
- ~/.sisu/skin/dir if the contents of a directory are to take a particular
- document skin.
+COMPOSITE DOCUMENTS MARKUP
+--------------------------
-* additional software - eg. Tex and LaTeX (tetex, tetex-base, tetex-extra on
-Debian), Postgresql, [sqlite], trang, tidy, makeinfo, ... none of which are
-required for basic html or XML processing.
+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*
-* if you use Vim as editor there is a syntax highlighter and fold resource
-config file for SiSU. I hope more syntax highlighters follow.
+basic markup for importing a document into a master document
-There are post installation steps (which are really part of the overall
-installation)
+<< filename1.sst
-sisu -C in your marked up document directory, should do some auto-configuring
-provided you have the right permissions for the output directories. (and
-provided the output directories have already been specified if you are not
-using the defaults).
+<< filename2.ssi
-%% Use General Overview
----------------
-Documents are marked up in SiSU syntax and kept in an ordinary text editable
-file, named with the suffix .sst, or .ssm
-Marked up SiSU documents are usually kept in a sub-directory of your choosing
+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.
-%% Help
----------------
+SUBSTITUTIONS
+-------------
-interactive help described below, or man page:
+*markup example:*
- man sisu
+The current Debian is ${debian_stable} the next debian will be ${debian_testing}
- man 8 sisu
- 'man sisu_markup-samples' [if the sisu-markup-samples package is also installed]
+Configure substitution in _sisu/sisu_document_make
-%% Directory Structure
----------------
-Once installed, type:
- sisu -V
+@make:
+:substitute: /${debian_stable}/,'*{Wheezy}*' /${debian_testing}/,'*{Jessie}*'
-%% Configuration File
----------------
-The defaults can be changed via SiSU's configure file sisurc.yml which the
-program expects to find in ./_sisu ~/.sisu or /etc/sisu (searched in that
-order, stopping on the first one found)
+*resulting output:*
-%% Markup
----------------
+The current *Debian* is *Wheezy* the next debian will be *Jessie*
-See man pages.
- man sisu
+Configure substitution in _sisu/sisu_document_make
- man 8 sisu
-Sample marked up document are provided with the download tarball in the
-directory:
- ./data/doc/sisu/v2/sisu_markup_samples/dfsg
+----------------------------------------
-These are installed on the system usually at:
- /usr/share/doc/sisu/v2/sisu_markup_samples/dfsg
-More markup samples are available in the package sisu-markup-samples
- <http://www.jus.uio.no/sisu/SiSU/download.html#sisu-markup-samples>
+----------------------------------------
-Many more are available online off:
- <http://www.jus.uio.no/sisu/SiSU/2.html>
-%% Additional Things
----------------
+ [1]: <http://packages.qa.debian.org/s/sisu.html>
-There is syntax support for some editors provided (together with a README file) in
+ [2]: from the *Debian* control file
- ./data/sisu/v2/conf/editor-syntax-etc
+ [*1]: square brackets
-usually installed to:
+ [*2]: square brackets
- /usr/share/sisu/v2/conf/editor-syntax-etc
+ [+1]: square brackets
-v1, v2 Changes
----------------
+ [3]: 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.
-See changelogs
+ [4]: files should be prepared using /UTF-8/ character encoding
-From a developer's perspective the substantive change between the two versions
-is to the middle layer, (the document abstraction, the intermediate document
-representation used in processing). Version 1 uses strings and relies on
-regular expressions to identify document objects, while Version 2 uses ruby
-objects. The version 1 approach whilst programming language neutral offers less
-control, and leads to complicated code; version 2 approach takes advantage of
-features within the ruby language suited to what the application does.
-Development is curently on version 2, version 1 is likely to remain for some
-time as a reference implementation.
+ [5]: a footnote or endnote
-%% Versions
+ [6]: self contained endnote marker & endnote in one
-* v1 sisu pretty mature in operation and syntax
-* v2 introduces new processing middle layer (document abstraction);
- markup same except for minor changes to document headers;
- epub output introduced
-* v3 introduces alternative (configurable) output structures
-* v4 retires what were referred to as sisu skins
+ [*]: unnumbered asterisk footnote/endnote, insert multiple asterisks if required
-%% License
----------------
+ [**]: another unnumbered asterisk footnote/endnote
-License: GPL 3 or later see the copyright file in
+ [*3]: editors notes, numbered asterisk footnote/endnote series
- ./data/doc/sisu
+ [+2]: editors notes, numbered plus symbol footnote/endnote series
-usually installed to:
+ [7]: <http://www.sisudoc.org/>
- /usr/share/doc/sisu
+ [8]: <http://www.ruby-lang.org/en/>
-%% SiSU Standard
------------------
+ [10]: Table from the Wealth of Networks by Yochai Benkler
+
+ <http://www.jus.uio.no/sisu/the_wealth_of_networks.yochai_benkler>
+
+==============================================================================
+
+ Title: SiSU - README
+
+ Creator: Ralph Amissah
+
+ Rights: Copyright (C) Ralph Amissah 2014;\\ License: GPL 3 (part of SiSU
+ documentation)
+
+ Subject: ebook, epublishing, electronic book, electronic publishing,
+ electronic document, electronic citation, data structure,
+ citation systems, search
+
+ Publisher: SiSU http://www.jus.uio.no/sisu (this copy)
+
+ Date created: 2014-02-02
+
+ Date available: 2014-02-02
+
+ Date modified: 2014-02-02
+
+ Date: 2014-02-02
+
+ Sourcefile: README.ssm.sst
+
+ Filetype: SiSU text insert 5.0,
+
+ Source digest: SHA256(README.ssm.sst)=
+ 5927789066d1eb9cf0321946d46e3ce2a66414557038d5c745bb009233611dd8
+
+ Generated by: Generated by: SiSU 6.0.1 of 2014w05/2 (2014-02-04)
+
+ Ruby version: ruby 2.0.0p353 (2013-11-22) [i386-linux-gnu]
+
+ Document (ao) last generated: 2014-02-04 23:45:41 -0500
+
+==============================================================================
+
+
+plaintext (plain text):
+ http://niu/manual/en/txt/README.txt
+
+Other versions of this document:
-SiSU uses:
+manifest:
+ http://niu/manual/en/manifest/README.html
-* Standard SiSU markup syntax,
-* Standard SiSU meta-markup syntax, and the
-* Standard SiSU object citation numbering and system
+at:
+ http://niu/manual
-© Ralph Amissah 1997, current 2006.
-All Rights Reserved.
-* however note the License section
-CHANGELOG
- ./CHANGELOG
-and see
- <http://www.jus.uio.no/sisu/SiSU/changelog.html>
- <http://www.jus.uio.no/sisu/SiSU/changelog_markup_samples.html>
+* Generated by: SiSU 6.0.1 of 2014w05/2 (2014-02-04)
+* Ruby version: ruby 2.0.0p353 (2013-11-22) [i386-linux-gnu]
+* Last Generated on: 2014-02-04 23:45:43 -0500
+* SiSU http://www.sisudoc.org/
diff --git a/data/doc/sisu/CHANGELOG_v5 b/data/doc/sisu/CHANGELOG_v5
index 55d7a492..15e4ce0d 100644
--- a/data/doc/sisu/CHANGELOG_v5
+++ b/data/doc/sisu/CHANGELOG_v5
@@ -31,6 +31,43 @@ v2 branch is removed; it is available in sisu =< 3.3.2
%% Reverse Chronological:
+%% 5.3.1.orig.tar.xz (2014-02-05:05/3)
+http://sources.sisudoc.org/gitweb/?p=code/sisu.git;a=shortlog;h=refs/tags/sisu_5.3.1
+http://sources.sisudoc.org/gitweb/?p=code/sisu.git;a=shortlog;h=refs/tags/debian/sisu_5.3.1-1
+http://www.jus.uio.no/sisu/pkg/src/sisu_5.3.1.orig.tar.xz
+ sisu_5.3.1.orig.tar.xz
+ sisu_5.3.1-1.dsc
+
+* ao, document tags
+
+* options
+ * --strict html option
+ * ocn switch on/off instructions (& defaults for plaintext & odt)
+
+* html cleaning
+ * --strict html option
+ (various changes, e.g. ocn [url]#37 only available as [url]#o37)
+ * tags
+ * endnote name and nameref (make compliant)
+
+* epub
+ * use same endnote name and nameref as introduced here for html
+ * hash digests used only if availabile (availability check)
+
+* ocn turn on/off rules
+ * txt
+ * odt
+
+* cgi (pgsql, sqlite) fixes
+
+* error/warn messages, including wrappers round require
+
+* documentation, manpage README etc.
+ * sisu manual directory moved
+ * sisu manual updated
+ * README & sisu.1 (manpage) updated
+ * removed html man pages (man2html)
+
%% 5.3.0.orig.tar.xz (2014-01-26:03/7)
http://sources.sisudoc.org/gitweb/?p=code/sisu.git;a=shortlog;h=refs/tags/sisu_5.3.0
http://sources.sisudoc.org/gitweb/?p=code/sisu.git;a=shortlog;h=refs/tags/debian/sisu_5.3.0-1
diff --git a/data/doc/sisu/CHANGELOG_v6 b/data/doc/sisu/CHANGELOG_v6
index 6b755eb0..4454c3e1 100644
--- a/data/doc/sisu/CHANGELOG_v6
+++ b/data/doc/sisu/CHANGELOG_v6
@@ -21,6 +21,43 @@ v2 branch is removed; it is available in sisu =< 3.3.2
%% Reverse Chronological:
+%% 6.0.1.orig.tar.xz (2014-02-05:05/3)
+http://sources.sisudoc.org/gitweb/?p=code/sisu.git;a=shortlog;h=refs/tags/sisu_6.0.1
+http://sources.sisudoc.org/gitweb/?p=code/sisu.git;a=shortlog;h=refs/tags/debian/sisu_6.0.1-1
+http://www.jus.uio.no/sisu/pkg/src/sisu_6.0.1.orig.tar.xz
+ sisu_6.0.1.orig.tar.xz
+ sisu_6.0.1-1.dsc
+
+* ao, document tags
+
+* options
+ * --strict html option
+ * ocn switch on/off instructions (& defaults for plaintext & odt)
+
+* html cleaning
+ * --strict html option
+ (various changes, e.g. ocn [url]#37 only available as [url]#o37)
+ * tags
+ * endnote name and nameref (make compliant)
+
+* epub
+ * use same endnote name and nameref as introduced here for html
+ * hash digests used only if availabile (availability check)
+
+* ocn turn on/off rules
+ * txt
+ * odt
+
+* cgi (pgsql, sqlite) fixes
+
+* error/warn messages, including wrappers round require
+
+* documentation, manpage README etc.
+ * sisu manual directory moved
+ * sisu manual updated
+ * README & sisu.1 (manpage) updated
+ * removed html man pages (man2html)
+
%% 6.0.0.orig.tar.xz (2014-01-26:03/7)
http://sources.sisudoc.org/gitweb/?p=code/sisu.git;a=shortlog;h=refs/tags/sisu_6.0.0
http://sources.sisudoc.org/gitweb/?p=code/sisu.git;a=shortlog;h=refs/tags/debian/sisu_6.0.0-1
diff --git a/data/doc/sisu/html/README b/data/doc/sisu/html/README
deleted file mode 100644
index c8ebc4ad..00000000
--- a/data/doc/sisu/html/README
+++ /dev/null
@@ -1,6 +0,0 @@
-this "html" directory contains SiSU man pages in html
-- generated from man pages using man2html
-
-man pages are either created by sisu from sisu markup documents contained in
-the directory "sisu_markup_samples/sisu_manual"
-or manually crafted
diff --git a/data/doc/sisu/html/sisu-concordance.1.html b/data/doc/sisu/html/sisu-concordance.1.html
deleted file mode 100644
index ef456d75..00000000
--- a/data/doc/sisu/html/sisu-concordance.1.html
+++ /dev/null
@@ -1,69 +0,0 @@
-<!-- manual page source format generated by PolyglotMan v3.2, -->
-<!-- available at http://polyglotman.sourceforge.net/ -->
-
-<html>
-<head>
-<title>SISU-CONCORDANCE(1) manual page</title>
-</head>
-<body bgcolor='white'>
-<a href='#toc'>Table of Contents</a><p>
-
-<p>
-<h2><a name='sect0' href='#toc0'>Name</a></h2>
-<b>SiSU</b> - Structured information, Serialized Units - a document publishing
-
-<p>system
-<p>
-<h2><a name='sect1' href='#toc1'>Synopsis</a></h2>
-<b>sisu-concordance</b> <i>sisu_document.sst</i> | <i>sisu_document.ssm</i>
-<p>
-<h2><a name='sect2' href='#toc2'>Description</a></h2>
-<b>SiSU</b>
-is a lightweight markup based document structuring, publishing and search
-framework for document collections. <p>
-The <b>sisu-concordance</b> command is an alias
-for <b>sisu --concordance</b> (or <b>sisu -w</b>) which produces an HTML concordance file
-(wordlist) of a SiSU markup file.
-<p>
-<h2><a name='sect3' href='#toc3'>See Also</a></h2>
-<a href='http:~/bin/man2html?sisu:1'><i>sisu</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-epub:1'><i>sisu-epub</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-harvest:1'><i>sisu-harvest</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-html:1'><i>sisu-html</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-pdf:1'><i>sisu-pdf</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-odf:1'><i>sisu-odf</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-pg:1'><i>sisu-pg</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-sqlite:1'><i>sisu-sqlite</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-txt:1'><i>sisu-txt</i>(1)</a>
-.
-<p>
-<h2><a name='sect4' href='#toc4'>Homepage</a></h2>
-More information about <b>SiSU</b> can be found at &lt;<a href='http://www.sisudoc.org/'><i>http://www.sisudoc.org/</i></a>
-&gt;
-or &lt;<a href='http://www.jus.uio.no/sisu/'><i>http://www.jus.uio.no/sisu/</i></a>
-&gt;.
-<p>
-<h2><a name='sect5' href='#toc5'>Author</a></h2>
-<b>SiSU</b> is written by Ralph Amissah &lt;<i>ralph@amissah.com</i>&gt;.
-<p>
-
-<hr><p>
-<a name='toc'><b>Table of Contents</b></a><p>
-<ul>
-<li><a name='toc0' href='#sect0'>Name</a></li>
-<li><a name='toc1' href='#sect1'>Synopsis</a></li>
-<li><a name='toc2' href='#sect2'>Description</a></li>
-<li><a name='toc3' href='#sect3'>See Also</a></li>
-<li><a name='toc4' href='#sect4'>Homepage</a></li>
-<li><a name='toc5' href='#sect5'>Author</a></li>
-</ul>
-</body>
-</html>
diff --git a/data/doc/sisu/html/sisu-epub.1.html b/data/doc/sisu/html/sisu-epub.1.html
deleted file mode 100644
index 6a84b876..00000000
--- a/data/doc/sisu/html/sisu-epub.1.html
+++ /dev/null
@@ -1,69 +0,0 @@
-<!-- manual page source format generated by PolyglotMan v3.2, -->
-<!-- available at http://polyglotman.sourceforge.net/ -->
-
-<html>
-<head>
-<title>SISU-EPUB(1) manual page</title>
-</head>
-<body bgcolor='white'>
-<a href='#toc'>Table of Contents</a><p>
-
-<p>
-<h2><a name='sect0' href='#toc0'>Name</a></h2>
-<b>SiSU</b> - Structured information, Serialized Units - a document publishing
-
-<p>system
-<p>
-<h2><a name='sect1' href='#toc1'>Synopsis</a></h2>
-<b>sisu-epub</b> <i>sisu_document.sst</i> | <i>sisu_document.ssm</i>
-<p>
-<h2><a name='sect2' href='#toc2'>Description</a></h2>
-<b>SiSU</b>
-is a lightweight markup based document structuring, publishing and search
-framework for document collections. <p>
-The <b>sisu-epub</b> command is an alias for
-<b>sisu --epub</b> (or <b>sisu -e</b>) which produces EPUB output of a SiSU markup file.
-
-<p>
-<h2><a name='sect3' href='#toc3'>See Also</a></h2>
-<a href='http:~/bin/man2html?sisu:1'><i>sisu</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-concordance:1'><i>sisu-concordance</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-harvest:1'><i>sisu-harvest</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-html:1'><i>sisu-html</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-pdf:1'><i>sisu-pdf</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-odf:1'><i>sisu-odf</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-pg:1'><i>sisu-pg</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-sqlite:1'><i>sisu-sqlite</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-txt:1'><i>sisu-txt</i>(1)</a>
-.
-<p>
-<h2><a name='sect4' href='#toc4'>Homepage</a></h2>
-More information about <b>SiSU</b> can be found at &lt;<a href='http://www.sisudoc.org/'><i>http://www.sisudoc.org/</i></a>
-&gt;
-or &lt;<a href='http://www.jus.uio.no/sisu/'><i>http://www.jus.uio.no/sisu/</i></a>
-&gt;.
-<p>
-<h2><a name='sect5' href='#toc5'>Author</a></h2>
-<b>SiSU</b> is written by Ralph Amissah &lt;<i>ralph@amissah.com</i>&gt;.
-<p>
-
-<hr><p>
-<a name='toc'><b>Table of Contents</b></a><p>
-<ul>
-<li><a name='toc0' href='#sect0'>Name</a></li>
-<li><a name='toc1' href='#sect1'>Synopsis</a></li>
-<li><a name='toc2' href='#sect2'>Description</a></li>
-<li><a name='toc3' href='#sect3'>See Also</a></li>
-<li><a name='toc4' href='#sect4'>Homepage</a></li>
-<li><a name='toc5' href='#sect5'>Author</a></li>
-</ul>
-</body>
-</html>
diff --git a/data/doc/sisu/html/sisu-git.1.html b/data/doc/sisu/html/sisu-git.1.html
deleted file mode 100644
index a23d0118..00000000
--- a/data/doc/sisu/html/sisu-git.1.html
+++ /dev/null
@@ -1,69 +0,0 @@
-<!-- manual page source format generated by PolyglotMan v3.2, -->
-<!-- available at http://polyglotman.sourceforge.net/ -->
-
-<html>
-<head>
-<title>SISU-GIT(1) manual page</title>
-</head>
-<body bgcolor='white'>
-<a href='#toc'>Table of Contents</a><p>
-
-<p>
-<h2><a name='sect0' href='#toc0'>Name</a></h2>
-<b>SiSU</b> - Structured information, Serialized Units - a document publishing
-
-<p>system
-<p>
-<h2><a name='sect1' href='#toc1'>Synopsis</a></h2>
-<b>sisu-git</b> <i>sisu_document.sst</i> | <i>sisu_document.ssm</i>
-<p>
-<h2><a name='sect2' href='#toc2'>Description</a></h2>
-<b>SiSU</b>
-is a lightweight markup based document structuring, publishing and search
-framework for document collections. <p>
-The <b>sisu-git</b> command is an alias for
-<b>sisu --git</b> (or <b>sisu -g</b>) which produces a git repository of the sisu source
-document and associated parts (images, ).
-<p>
-<h2><a name='sect3' href='#toc3'>See Also</a></h2>
-<a href='http:~/bin/man2html?sisu:1'><i>sisu</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-concordance:1'><i>sisu-concordance</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-epub:1'><i>sisu-epub</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-harvest:1'><i>sisu-harvest</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-html:1'><i>sisu-html</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-pdf:1'><i>sisu-pdf</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-pg:1'><i>sisu-pg</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-sqlite:1'><i>sisu-sqlite</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-txt:1'><i>sisu-txt</i>(1)</a>
-.
-<p>
-<h2><a name='sect4' href='#toc4'>Homepage</a></h2>
-More information about <b>SiSU</b> can be found at &lt;<a href='http://www.sisudoc.org/'><i>http://www.sisudoc.org/</i></a>
-&gt;
-or &lt;<a href='http://www.jus.uio.no/sisu/'><i>http://www.jus.uio.no/sisu/</i></a>
-&gt;.
-<p>
-<h2><a name='sect5' href='#toc5'>Author</a></h2>
-<b>SiSU</b> is written by Ralph Amissah &lt;<i>ralph@amissah.com</i>&gt;.
-<p>
-
-<hr><p>
-<a name='toc'><b>Table of Contents</b></a><p>
-<ul>
-<li><a name='toc0' href='#sect0'>Name</a></li>
-<li><a name='toc1' href='#sect1'>Synopsis</a></li>
-<li><a name='toc2' href='#sect2'>Description</a></li>
-<li><a name='toc3' href='#sect3'>See Also</a></li>
-<li><a name='toc4' href='#sect4'>Homepage</a></li>
-<li><a name='toc5' href='#sect5'>Author</a></li>
-</ul>
-</body>
-</html>
diff --git a/data/doc/sisu/html/sisu-harvest.1.html b/data/doc/sisu/html/sisu-harvest.1.html
deleted file mode 100644
index 8d264278..00000000
--- a/data/doc/sisu/html/sisu-harvest.1.html
+++ /dev/null
@@ -1,71 +0,0 @@
-<!-- manual page source format generated by PolyglotMan v3.2, -->
-<!-- available at http://polyglotman.sourceforge.net/ -->
-
-<html>
-<head>
-<title>SISU-HARVEST(1) manual page</title>
-</head>
-<body bgcolor='white'>
-<a href='#toc'>Table of Contents</a><p>
-
-<p>
-<h2><a name='sect0' href='#toc0'>Name</a></h2>
-<b>SiSU</b> - Structured information, Serialized Units - a document publishing
-
-<p>system
-<p>
-<h2><a name='sect1' href='#toc1'>Synopsis</a></h2>
-<b>sisu-harvest</b> <i>sisu_document.sst</i> | <i>sisu_document.ssm</i>
-<p>
-<h2><a name='sect2' href='#toc2'>Description</a></h2>
-<b>SiSU</b>
-is a lightweight markup based document structuring, publishing and search
-framework for document collections. <p>
-The <b>sisu-harvest</b> command is an alias
-for <b>sisu --harvest</b> which based on the @classify: :topic_register: headers
-in each SiSU markup file, produces HTML output in the form of an index
-of authors and their texts and an index of topics and related texts.
-<p>
-<h2><a name='sect3' href='#toc3'>See
-Also</a></h2>
-<a href='http:~/bin/man2html?sisu:1'><i>sisu</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-concordance:1'><i>sisu-concordance</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-epub:1'><i>sisu-epub</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-html:1'><i>sisu-html</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-pdf:1'><i>sisu-pdf</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-odf:1'><i>sisu-odf</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-pg:1'><i>sisu-pg</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-sqlite:1'><i>sisu-sqlite</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-txt:1'><i>sisu-txt</i>(1)</a>
-.
-<p>
-<h2><a name='sect4' href='#toc4'>Homepage</a></h2>
-More information about <b>SiSU</b> can be found at &lt;<a href='http://www.sisudoc.org/'><i>http://www.sisudoc.org/</i></a>
-&gt;
-or &lt;<a href='http://www.jus.uio.no/sisu/'><i>http://www.jus.uio.no/sisu/</i></a>
-&gt;.
-<p>
-<h2><a name='sect5' href='#toc5'>Author</a></h2>
-<b>SiSU</b> is written by Ralph Amissah &lt;<i>ralph@amissah.com</i>&gt;.
-<p>
-
-<hr><p>
-<a name='toc'><b>Table of Contents</b></a><p>
-<ul>
-<li><a name='toc0' href='#sect0'>Name</a></li>
-<li><a name='toc1' href='#sect1'>Synopsis</a></li>
-<li><a name='toc2' href='#sect2'>Description</a></li>
-<li><a name='toc3' href='#sect3'>See Also</a></li>
-<li><a name='toc4' href='#sect4'>Homepage</a></li>
-<li><a name='toc5' href='#sect5'>Author</a></li>
-</ul>
-</body>
-</html>
diff --git a/data/doc/sisu/html/sisu-html.1.html b/data/doc/sisu/html/sisu-html.1.html
deleted file mode 100644
index a95b7796..00000000
--- a/data/doc/sisu/html/sisu-html.1.html
+++ /dev/null
@@ -1,69 +0,0 @@
-<!-- manual page source format generated by PolyglotMan v3.2, -->
-<!-- available at http://polyglotman.sourceforge.net/ -->
-
-<html>
-<head>
-<title>SISU-HTML(1) manual page</title>
-</head>
-<body bgcolor='white'>
-<a href='#toc'>Table of Contents</a><p>
-
-<p>
-<h2><a name='sect0' href='#toc0'>Name</a></h2>
-<b>SiSU</b> - Structured information, Serialized Units - a document publishing
-
-<p>system
-<p>
-<h2><a name='sect1' href='#toc1'>Synopsis</a></h2>
-<b>sisu-html</b> <i>sisu_document.sst</i> | <i>sisu_document.ssm</i>
-<p>
-<h2><a name='sect2' href='#toc2'>Description</a></h2>
-<b>SiSU</b>
-is a lightweight markup based document structuring, publishing and search
-framework for document collections. <p>
-The <b>sisu-html</b> command is an alias for
-<b>sisu --html</b> (or <b>sisu -h</b>) which produces HTML output of a SiSU markup file.
-
-<p>
-<h2><a name='sect3' href='#toc3'>See Also</a></h2>
-<a href='http:~/bin/man2html?sisu:1'><i>sisu</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-concordance:1'><i>sisu-concordance</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-epub:1'><i>sisu-epub</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-harvest:1'><i>sisu-harvest</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-pdf:1'><i>sisu-pdf</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-odf:1'><i>sisu-odf</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-pg:1'><i>sisu-pg</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-sqlite:1'><i>sisu-sqlite</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-txt:1'><i>sisu-txt</i>(1)</a>
-.
-<p>
-<h2><a name='sect4' href='#toc4'>Homepage</a></h2>
-More information about <b>SiSU</b> can be found at &lt;<a href='http://www.sisudoc.org/'><i>http://www.sisudoc.org/</i></a>
-&gt;
-or &lt;<a href='http://www.jus.uio.no/sisu/'><i>http://www.jus.uio.no/sisu/</i></a>
-&gt;.
-<p>
-<h2><a name='sect5' href='#toc5'>Author</a></h2>
-<b>SiSU</b> is written by Ralph Amissah &lt;<i>ralph@amissah.com</i>&gt;.
-<p>
-
-<hr><p>
-<a name='toc'><b>Table of Contents</b></a><p>
-<ul>
-<li><a name='toc0' href='#sect0'>Name</a></li>
-<li><a name='toc1' href='#sect1'>Synopsis</a></li>
-<li><a name='toc2' href='#sect2'>Description</a></li>
-<li><a name='toc3' href='#sect3'>See Also</a></li>
-<li><a name='toc4' href='#sect4'>Homepage</a></li>
-<li><a name='toc5' href='#sect5'>Author</a></li>
-</ul>
-</body>
-</html>
diff --git a/data/doc/sisu/html/sisu-odf.1.html b/data/doc/sisu/html/sisu-odf.1.html
deleted file mode 100644
index fddd3148..00000000
--- a/data/doc/sisu/html/sisu-odf.1.html
+++ /dev/null
@@ -1,69 +0,0 @@
-<!-- manual page source format generated by PolyglotMan v3.2, -->
-<!-- available at http://polyglotman.sourceforge.net/ -->
-
-<html>
-<head>
-<title>SISU-ODF(1) manual page</title>
-</head>
-<body bgcolor='white'>
-<a href='#toc'>Table of Contents</a><p>
-
-<p>
-<h2><a name='sect0' href='#toc0'>Name</a></h2>
-<b>SiSU</b> - Structured information, Serialized Units - a document publishing
-
-<p>system
-<p>
-<h2><a name='sect1' href='#toc1'>Synopsis</a></h2>
-<b>sisu-odf</b> <i>sisu_document.sst</i> | <i>sisu_document.ssm</i>
-<p>
-<h2><a name='sect2' href='#toc2'>Description</a></h2>
-<b>SiSU</b>
-is a lightweight markup based document structuring, publishing and search
-framework for document collections. <p>
-The <b>sisu-odf</b> command is an alias for
-<b>sisu --odt</b> (or <b>sisu -o</b>) which produces OpenDocument output of a SiSU markup
-file.
-<p>
-<h2><a name='sect3' href='#toc3'>See Also</a></h2>
-<a href='http:~/bin/man2html?sisu:1'><i>sisu</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-concordance:1'><i>sisu-concordance</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-epub:1'><i>sisu-epub</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-harvest:1'><i>sisu-harvest</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-html:1'><i>sisu-html</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-pdf:1'><i>sisu-pdf</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-pg:1'><i>sisu-pg</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-sqlite:1'><i>sisu-sqlite</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-txt:1'><i>sisu-txt</i>(1)</a>
-.
-<p>
-<h2><a name='sect4' href='#toc4'>Homepage</a></h2>
-More information about <b>SiSU</b> can be found at &lt;<a href='http://www.sisudoc.org/'><i>http://www.sisudoc.org/</i></a>
-&gt;
-or &lt;<a href='http://www.jus.uio.no/sisu/'><i>http://www.jus.uio.no/sisu/</i></a>
-&gt;.
-<p>
-<h2><a name='sect5' href='#toc5'>Author</a></h2>
-<b>SiSU</b> is written by Ralph Amissah &lt;<i>ralph@amissah.com</i>&gt;.
-<p>
-
-<hr><p>
-<a name='toc'><b>Table of Contents</b></a><p>
-<ul>
-<li><a name='toc0' href='#sect0'>Name</a></li>
-<li><a name='toc1' href='#sect1'>Synopsis</a></li>
-<li><a name='toc2' href='#sect2'>Description</a></li>
-<li><a name='toc3' href='#sect3'>See Also</a></li>
-<li><a name='toc4' href='#sect4'>Homepage</a></li>
-<li><a name='toc5' href='#sect5'>Author</a></li>
-</ul>
-</body>
-</html>
diff --git a/data/doc/sisu/html/sisu-pdf.1.html b/data/doc/sisu/html/sisu-pdf.1.html
deleted file mode 100644
index ec9f39d2..00000000
--- a/data/doc/sisu/html/sisu-pdf.1.html
+++ /dev/null
@@ -1,69 +0,0 @@
-<!-- manual page source format generated by PolyglotMan v3.2, -->
-<!-- available at http://polyglotman.sourceforge.net/ -->
-
-<html>
-<head>
-<title>SISU-PDF(1) manual page</title>
-</head>
-<body bgcolor='white'>
-<a href='#toc'>Table of Contents</a><p>
-
-<p>
-<h2><a name='sect0' href='#toc0'>Name</a></h2>
-<b>SiSU</b> - Structured information, Serialized Units - a document publishing
-
-<p>system
-<p>
-<h2><a name='sect1' href='#toc1'>Synopsis</a></h2>
-<b>sisu-pdf</b> <i>sisu_document.sst</i> | <i>sisu_document.ssm</i>
-<p>
-<h2><a name='sect2' href='#toc2'>Description</a></h2>
-<b>SiSU</b>
-is a lightweight markup based document structuring, publishing and search
-framework for document collections. <p>
-The <b>sisu-pdf</b> command is an alias for
-<b>sisu --pdf</b> (or <b>sisu -p</b>) which produces PDF output of a SiSU markup file.
-<p>
-<h2><a name='sect3' href='#toc3'>See
-Also</a></h2>
-<a href='http:~/bin/man2html?sisu:1'><i>sisu</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-concordance:1'><i>sisu-concordance</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-epub:1'><i>sisu-epub</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-harvest:1'><i>sisu-harvest</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-html:1'><i>sisu-html</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-odf:1'><i>sisu-odf</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-pg:1'><i>sisu-pg</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-sqlite:1'><i>sisu-sqlite</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-txt:1'><i>sisu-txt</i>(1)</a>
-.
-<p>
-<h2><a name='sect4' href='#toc4'>Homepage</a></h2>
-More information about <b>SiSU</b> can be found at &lt;<a href='http://www.sisudoc.org/'><i>http://www.sisudoc.org/</i></a>
-&gt;
-or &lt;<a href='http://www.jus.uio.no/sisu/'><i>http://www.jus.uio.no/sisu/</i></a>
-&gt;.
-<p>
-<h2><a name='sect5' href='#toc5'>Author</a></h2>
-<b>SiSU</b> is written by Ralph Amissah &lt;<i>ralph@amissah.com</i>&gt;.
-<p>
-
-<hr><p>
-<a name='toc'><b>Table of Contents</b></a><p>
-<ul>
-<li><a name='toc0' href='#sect0'>Name</a></li>
-<li><a name='toc1' href='#sect1'>Synopsis</a></li>
-<li><a name='toc2' href='#sect2'>Description</a></li>
-<li><a name='toc3' href='#sect3'>See Also</a></li>
-<li><a name='toc4' href='#sect4'>Homepage</a></li>
-<li><a name='toc5' href='#sect5'>Author</a></li>
-</ul>
-</body>
-</html>
diff --git a/data/doc/sisu/html/sisu-pg.1.html b/data/doc/sisu/html/sisu-pg.1.html
deleted file mode 100644
index 056598f2..00000000
--- a/data/doc/sisu/html/sisu-pg.1.html
+++ /dev/null
@@ -1,69 +0,0 @@
-<!-- manual page source format generated by PolyglotMan v3.2, -->
-<!-- available at http://polyglotman.sourceforge.net/ -->
-
-<html>
-<head>
-<title>SISU-PG(1) manual page</title>
-</head>
-<body bgcolor='white'>
-<a href='#toc'>Table of Contents</a><p>
-
-<p>
-<h2><a name='sect0' href='#toc0'>Name</a></h2>
-<b>SiSU</b> - Structured information, Serialized Units - a document publishing
-
-<p>system
-<p>
-<h2><a name='sect1' href='#toc1'>Synopsis</a></h2>
-<b>sisu-pq</b> <i>sisu_document.sst</i> | <i>sisu_document.ssm</i>
-<p>
-<h2><a name='sect2' href='#toc2'>Description</a></h2>
-<b>SiSU</b>
-is a lightweight markup based document structuring, publishing and search
-framework for document collections. <p>
-The <b>sisu-pq</b> command is an alias for <b>sisu
---pg</b> (or <b>sisu -D</b>) which populates a PostgreSQL database with SiSU content
-(for search) from a SiSU markup file.
-<p>
-<h2><a name='sect3' href='#toc3'>See Also</a></h2>
-<a href='http:~/bin/man2html?sisu:1'><i>sisu</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-concordance:1'><i>sisu-concordance</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-epub:1'><i>sisu-epub</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-harvest:1'><i>sisu-harvest</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-html:1'><i>sisu-html</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-pdf:1'><i>sisu-pdf</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-odf:1'><i>sisu-odf</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-sqlite:1'><i>sisu-sqlite</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-txt:1'><i>sisu-txt</i>(1)</a>
-.
-<p>
-<h2><a name='sect4' href='#toc4'>Homepage</a></h2>
-More information about <b>SiSU</b> can be found at &lt;<a href='http://www.sisudoc.org/'><i>http://www.sisudoc.org/</i></a>
-&gt;
-or &lt;<a href='http://www.jus.uio.no/sisu/'><i>http://www.jus.uio.no/sisu/</i></a>
-&gt;.
-<p>
-<h2><a name='sect5' href='#toc5'>Author</a></h2>
-<b>SiSU</b> is written by Ralph Amissah &lt;<i>ralph@amissah.com</i>&gt;.
-<p>
-
-<hr><p>
-<a name='toc'><b>Table of Contents</b></a><p>
-<ul>
-<li><a name='toc0' href='#sect0'>Name</a></li>
-<li><a name='toc1' href='#sect1'>Synopsis</a></li>
-<li><a name='toc2' href='#sect2'>Description</a></li>
-<li><a name='toc3' href='#sect3'>See Also</a></li>
-<li><a name='toc4' href='#sect4'>Homepage</a></li>
-<li><a name='toc5' href='#sect5'>Author</a></li>
-</ul>
-</body>
-</html>
diff --git a/data/doc/sisu/html/sisu-po.1.html b/data/doc/sisu/html/sisu-po.1.html
deleted file mode 100644
index ea1c5b43..00000000
--- a/data/doc/sisu/html/sisu-po.1.html
+++ /dev/null
@@ -1,73 +0,0 @@
-<!-- manual page source format generated by PolyglotMan v3.2, -->
-<!-- available at http://polyglotman.sourceforge.net/ -->
-
-<html>
-<head>
-<title>SISU-PO(1) manual page</title>
-</head>
-<body bgcolor='white'>
-<a href='#toc'>Table of Contents</a><p>
-
-<p>
-<h2><a name='sect0' href='#toc0'>Name</a></h2>
-<b>SiSU</b> - Structured information, Serialized Units - a document publishing
-
-<p>system
-<p>
-<h2><a name='sect1' href='#toc1'>Synopsis</a></h2>
-<b>sisu-po</b> <i>sisu_document.sst</i> | <i>sisu_document.ssm</i>
-<p>
-<h2><a name='sect2' href='#toc2'>Description</a></h2>
-<b>SiSU</b>
-is a lightweight markup based document structuring, publishing and search
-framework for document collections. <p>
-The <b>sisu-po</b> command is an alias for <b>sisu
---po4a</b> (or <b>sisu -o</b>) which provided two sisu markup files of the same document
-in different languages produces .pot and .po output of a SiSU markup file.
-Experimental, and under development.
-<p>
-<h2><a name='sect3' href='#toc3'>See Also</a></h2>
-<a href='http:~/bin/man2html?sisu:1'><i>sisu</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-concordance:1'><i>sisu-concordance</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-epub:1'><i>sisu-epub</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-harvest:1'><i>sisu-harvest</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-html:1'><i>sisu-html</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-odf:1'><i>sisu-odf</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-pdf:1'><i>sisu-pdf</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-pg:1'><i>sisu-pg</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-sqlite:1'><i>sisu-sqlite</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-txt:1'><i>sisu-txt</i>(1)</a>
-.
-<p>
-<h2><a name='sect4' href='#toc4'>Homepage</a></h2>
-More information about <b>SiSU</b> can be found at &lt;<a href='http://www.sisudoc.org/'><i>http://www.sisudoc.org/</i></a>
-&gt;
-or &lt;<a href='http://www.jus.uio.no/sisu/'><i>http://www.jus.uio.no/sisu/</i></a>
-&gt;.
-<p>
-<h2><a name='sect5' href='#toc5'>Author</a></h2>
-<b>SiSU</b> is written by Ralph Amissah &lt;<i>ralph@amissah.com</i>&gt;.
-
-<p> <p>
-
-<hr><p>
-<a name='toc'><b>Table of Contents</b></a><p>
-<ul>
-<li><a name='toc0' href='#sect0'>Name</a></li>
-<li><a name='toc1' href='#sect1'>Synopsis</a></li>
-<li><a name='toc2' href='#sect2'>Description</a></li>
-<li><a name='toc3' href='#sect3'>See Also</a></li>
-<li><a name='toc4' href='#sect4'>Homepage</a></li>
-<li><a name='toc5' href='#sect5'>Author</a></li>
-</ul>
-</body>
-</html>
diff --git a/data/doc/sisu/html/sisu-sqlite.1.html b/data/doc/sisu/html/sisu-sqlite.1.html
deleted file mode 100644
index f40c3a8b..00000000
--- a/data/doc/sisu/html/sisu-sqlite.1.html
+++ /dev/null
@@ -1,69 +0,0 @@
-<!-- manual page source format generated by PolyglotMan v3.2, -->
-<!-- available at http://polyglotman.sourceforge.net/ -->
-
-<html>
-<head>
-<title>SISU-SQLITE(1) manual page</title>
-</head>
-<body bgcolor='white'>
-<a href='#toc'>Table of Contents</a><p>
-
-<p>
-<h2><a name='sect0' href='#toc0'>Name</a></h2>
-<b>SiSU</b> - Structured information, Serialized Units - a document publishing
-
-<p>system
-<p>
-<h2><a name='sect1' href='#toc1'>Synopsis</a></h2>
-<b>sisu-sqlite</b> <i>sisu_document.sst</i> | <i>sisu_document.ssm</i>
-<p>
-<h2><a name='sect2' href='#toc2'>Description</a></h2>
-<b>SiSU</b>
-is a lightweight markup based document structuring, publishing and search
-framework for document collections. <p>
-The <b>sisu-sqlite</b> command is an alias for
-<b>sisu --sqlite</b> (or <b>sisu -d</b>) which populates a SQLite database with SiSU content
-(for search) from a SiSU markup file.
-<p>
-<h2><a name='sect3' href='#toc3'>See Also</a></h2>
-<a href='http:~/bin/man2html?sisu:1'><i>sisu</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-concordance:1'><i>sisu-concordance</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-epub:1'><i>sisu-epub</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-harvest:1'><i>sisu-harvest</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-html:1'><i>sisu-html</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-pdf:1'><i>sisu-pdf</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-odf:1'><i>sisu-odf</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-pg:1'><i>sisu-pg</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-txt:1'><i>sisu-txt</i>(1)</a>
-.
-<p>
-<h2><a name='sect4' href='#toc4'>Homepage</a></h2>
-More information about <b>SiSU</b> can be found at &lt;<a href='http://www.sisudoc.org/'><i>http://www.sisudoc.org/</i></a>
-&gt;
-or &lt;<a href='http://www.jus.uio.no/sisu/'><i>http://www.jus.uio.no/sisu/</i></a>
-&gt;.
-<p>
-<h2><a name='sect5' href='#toc5'>Author</a></h2>
-<b>SiSU</b> is written by Ralph Amissah &lt;<i>ralph@amissah.com</i>&gt;.
-<p>
-
-<hr><p>
-<a name='toc'><b>Table of Contents</b></a><p>
-<ul>
-<li><a name='toc0' href='#sect0'>Name</a></li>
-<li><a name='toc1' href='#sect1'>Synopsis</a></li>
-<li><a name='toc2' href='#sect2'>Description</a></li>
-<li><a name='toc3' href='#sect3'>See Also</a></li>
-<li><a name='toc4' href='#sect4'>Homepage</a></li>
-<li><a name='toc5' href='#sect5'>Author</a></li>
-</ul>
-</body>
-</html>
diff --git a/data/doc/sisu/html/sisu-txt.1.html b/data/doc/sisu/html/sisu-txt.1.html
deleted file mode 100644
index dbfc71f4..00000000
--- a/data/doc/sisu/html/sisu-txt.1.html
+++ /dev/null
@@ -1,69 +0,0 @@
-<!-- manual page source format generated by PolyglotMan v3.2, -->
-<!-- available at http://polyglotman.sourceforge.net/ -->
-
-<html>
-<head>
-<title>SISU-TXT(1) manual page</title>
-</head>
-<body bgcolor='white'>
-<a href='#toc'>Table of Contents</a><p>
-
-<p>
-<h2><a name='sect0' href='#toc0'>Name</a></h2>
-<b>SiSU</b> - Structured information, Serialized Units - a document publishing
-
-<p>system
-<p>
-<h2><a name='sect1' href='#toc1'>Synopsis</a></h2>
-<b>sisu-txt</b> <i>sisu_document.sst</i> | <i>sisu_document.ssm</i>
-<p>
-<h2><a name='sect2' href='#toc2'>Description</a></h2>
-<b>SiSU</b>
-is a lightweight markup based document structuring, publishing and search
-framework for document collections. <p>
-The <b>sisu-txt</b> command is an alias for
-<b>sisu --txt</b> (or <b>sisu -t</b>) which produces plain text output of a SiSU markup
-file.
-<p>
-<h2><a name='sect3' href='#toc3'>See Also</a></h2>
-<a href='http:~/bin/man2html?sisu:1'><i>sisu</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-concordance:1'><i>sisu-concordance</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-epub:1'><i>sisu-epub</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-harvest:1'><i>sisu-harvest</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-html:1'><i>sisu-html</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-pdf:1'><i>sisu-pdf</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-odf:1'><i>sisu-odf</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-pg:1'><i>sisu-pg</i>(1)</a>
-, <br>
-<a href='http:~/bin/man2html?sisu-sqlite:1'><i>sisu-sqlite</i>(1)</a>
-.
-<p>
-<h2><a name='sect4' href='#toc4'>Homepage</a></h2>
-More information about <b>SiSU</b> can be found at &lt;<a href='http://www.sisudoc.org/'><i>http://www.sisudoc.org/</i></a>
-&gt;
-or &lt;<a href='http://www.jus.uio.no/sisu/'><i>http://www.jus.uio.no/sisu/</i></a>
-&gt;.
-<p>
-<h2><a name='sect5' href='#toc5'>Author</a></h2>
-<b>SiSU</b> is written by Ralph Amissah &lt;<i>ralph@amissah.com</i>&gt;.
-<p>
-
-<hr><p>
-<a name='toc'><b>Table of Contents</b></a><p>
-<ul>
-<li><a name='toc0' href='#sect0'>Name</a></li>
-<li><a name='toc1' href='#sect1'>Synopsis</a></li>
-<li><a name='toc2' href='#sect2'>Description</a></li>
-<li><a name='toc3' href='#sect3'>See Also</a></li>
-<li><a name='toc4' href='#sect4'>Homepage</a></li>
-<li><a name='toc5' href='#sect5'>Author</a></li>
-</ul>
-</body>
-</html>
diff --git a/data/doc/sisu/html/sisu.1.html b/data/doc/sisu/html/sisu.1.html
deleted file mode 100644
index 65a92c9a..00000000
--- a/data/doc/sisu/html/sisu.1.html
+++ /dev/null
@@ -1,3290 +0,0 @@
-<!-- manual page source format generated by PolyglotMan v3.2, -->
-<!-- available at http://polyglotman.sourceforge.net/ -->
-
-<html>
-<head>
-<title>"sisu"("1") manual page</title>
-</head>
-<body bgcolor='white'>
-<a href='#toc'>Table of Contents</a><p>
-<br>
-
-<h2><a name='sect0' href='#toc0'>Name</a></h2>
-<br>
-sisu - documents: markup, structuring, publishing in multiple standard formats,
-and search <br>
-
-<h2><a name='sect1' href='#toc1'>Synopsis</a></h2>
-<br>
-sisu [-short-options|--long-options] [filename/wildcard]
-<p> <br>
-sisu [-abCcDdeFGghIikLMmNnoPpQqRrSsTtUuVvWwXxYyZ_0-9] [filename/wildcard]
-
-<p> <br>
-sisu --txt --html --epub --odt --pdf --wordmap --sqlite --manpage --texinfo --sisupod --source
---qrcode [filename/wildcard]
-<p> <br>
-sisu [-Ddcv] [instruction] [filename/wildcard]
-<p> <br>
-sisu --pg (--createdb|update [filename/wildcard]|--dropall)
-<p> <br>
-sisu [operations]
-<p> <br>
-sisu [-CcFLSVvW]
-<p> <br>
-sisu (--configure|--webrick|--sample-search-form)
-<h2><a name='sect2' href='#toc2'>Sisu - Manual,</a></h2>
-RALPH AMISSAH
-<p>
-<h2><a name='sect3' href='#toc3'>What
-is Sisu?</a></h2>
-
-<p>
-<h2><a name='sect4' href='#toc4'>Introduction - What is Sisu?</a></h2>
-
-<p>
-<p> <b>SiSU</b> 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.
-<p> <b>SiSU</b> is developed under an open source, software
-libre license ( <i>GPLv3</i> ). 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.
-<p> <b>SiSU</b> both defines a markup syntax and provides
-an engine that produces open standards format outputs from documents prepared
-with <b>SiSU</b> 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&rsquo;s
-structure and content from which it is possible to generate different forms
-of representation of the document. Significantly <b>SiSU</b> markup is more sparse
-than html and outputs which include <i>HTML,</i> <i>EPUB,</i> <i>ODT</i> (Open Document Format
-text), <i>LaTeX,</i> landscape and portrait <i>PDF,</i> all of which can be added to
-and updated. <b>SiSU</b> is also able to populate <i>SQL</i> type databases at an object
-level, which means that searches can be made with that degree of granularity.
-
-<p> 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 <b>SiSU</b> markup applied to a document, <b>SiSU</b> custom builds (to
-take advantage of the strengths of different ways of representing documents)
-various standard open output formats including plain text, <i>HTML,</i> <i>XHTML,</i>
-<i>XML,</i> <i>EPUB,</i> <i>ODT,</i> <i>LaTeX</i> or <i>PDF</i> files, and populate an <i>SQL</i> 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.
-<p> In preparing a <b>SiSU</b>
-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.
-<p> <b>SiSU</b> works with an abstraction of
-the document based on its structure which is comprised of its headings[^3]
-and objects[^4], which enables <b>SiSU</b> 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&rsquo;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 <b>SiSU</b> is able to take advantage of.
-<p> 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. <b>SiSU</b> provides the
-flexibility of producing documents in multiple non-proprietary open formats
-including <i>HTML,</i> <i>EPUB,</i> [^5] <i>ODT,</i> [^6] <i>PDF</i> [^7] <i>ODF,</i> [^8]. Whilst <b>SiSU</b> 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 <b>SiSU</b> can
-be migrated to other document formats. Further security is provided by the
-fact that the software itself, <b>SiSU</b> is available under <i>GPLv3</i> 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</b> 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), <i>EPUB</i> was introduced in 2009; and allows the technical
-representations existing output to be updated ( <i>HTML</i> has evolved and the
-related module has been updated repeatedly over the years, presumably when
-the World Wide Web Consortium (w3c) finalises <i>HTML</i> 5 which is currently
-under development, the <i>HTML</i> module will again be updated allowing all existing
-documents to be regenerated as <i>HTML</i> 5).
-<p> 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.
-<p> <b>SiSU</b> 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 <b>SiSU</b> offers great possibilities.
-<p> <b>SiSU</b> is primarily for published works,
-which can take advantage of the citation system to reliably reference its
-documents. <b>SiSU</b> 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 <b>SiSU.</b>
-<p> &lt;<a href='http://www.sisudoc.org/'>http://www.sisudoc.org/</a>
-&gt;
-<p> &lt;<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a>
-&gt;
-
-<h2><a name='sect5' href='#toc5'>Commands Summary</a></h2>
-
-<p>
-<h2><a name='sect6' href='#toc6'>Description</a></h2>
-
-<p> <b>SiSU</b> is a document publishing system, that
-from a simple single marked-up document, produces multiple output formats
-including: <i>plaintext,</i> <i>HTML,</i> <i>XHTML,</i> <i>XML,</i> <i>EPUB,</i> <i>ODT</i> ( <i>OpenDocument</i> ( <i>ODF</i>
-) text), <i>LaTeX,</i> <i>PDF,</i> info, and <i>SQL</i> ( <i>PostgreSQL</i> and <i>SQLite</i> ) , which share
-text object numbers ("object citation numbering") and the same document
-structure information. For more see: &lt;<a href='http://sisudoc.org'>http://sisudoc.org</a>
-&gt; or &lt;<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a>
-&gt;
-
-<h2><a name='sect7' href='#toc7'>Document Processing Command Flags</a></h2>
-
-<p>
-<dl>
-
-<dt><b>-a [filename/wildcard]</b> </dt>
-<dd>produces <i>plaintext</i>
-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) </dd>
-
-<dt><b>-b [filename/wildcard]</b>
-</dt>
-<dd>see --xhtml </dd>
-
-<dt><b>--by-*</b> </dt>
-<dd>see --output-by-* </dd>
-
-<dt><b>-C</b> </dt>
-<dd>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. </dd>
-
-<dt><b>-CC</b>
-</dt>
-<dd>see --configure </dd>
-
-<dt><b>-c [filename/wildcard]</b> </dt>
-<dd>see --color-toggle </dd>
-
-<dt><b>--color</b> </dt>
-<dd>see --color-on </dd>
-
-<dt><b>--color-off</b>
-</dt>
-<dd>turn off color in output to terminal </dd>
-
-<dt><b>--color-on</b> </dt>
-<dd>turn on color in output to
-terminal </dd>
-
-<dt><b>--color-toggle [filename/wildcard]</b> </dt>
-<dd>screen toggle ansi screen colour
-on or off depending on default set (unless -c flag is used: if sisurc colour
-default is set to &rsquo;true&rsquo;, output to screen will be with colour, if sisurc
-colour default is set to &rsquo;false&rsquo; or is undefined screen output will be without
-colour). Alias -c </dd>
-
-<dt><b>--configure</b> </dt>
-<dd>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. </dd>
-
-<dt><b>--concordance [filename/wildcard]</b> </dt>
-<dd>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 </dd>
-
-<dt><b>-D [instruction] [filename]</b> </dt>
-<dd>see
---pg </dd>
-
-<dt><b>-d [--db-[database type (sqlite|pg)]] --[instruction] [filename]</b> </dt>
-<dd>see --sqlite
-</dd>
-
-<dt><b>--dal [filename/wildcard/url]</b> </dt>
-<dd>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 </dd>
-
-<dt><b>--delete [filename/wildcard]</b> </dt>
-<dd>see --zap </dd>
-
-<dt><b>--dump[=directory_path]
-[filename/wildcard]</b> </dt>
-<dd>places output in directory specified, if none is specified
-in the current directory (pwd). Unlike using default settings <i>HTML</i> files
-have embedded css. Compare --redirect </dd>
-
-<dt><b>-e [filename/wildcard]</b> </dt>
-<dd>see --epub </dd>
-
-<dt><b>--epub
-[filename/wildcard]</b> </dt>
-<dd>produces an epub document, [sisu version &gt;=2 ] (filename.epub).
-Alias -e </dd>
-
-<dt><b>--exc-*</b> </dt>
-<dd>exclude output feature, overrides configuration settings --exc-ocn,
-(exclude <i>object</i> citation numbering, (switches off <i>object</i> 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-* </dd>
-
-<dt><b>-F [--webserv=webrick]</b> </dt>
-<dd>see --sample-search-form
-</dd>
-
-<dt><b>-f [optional string part of filename]</b> </dt>
-<dd>see --find </dd>
-
-<dt><b>--find [optional string part
-of filename]</b> </dt>
-<dd>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 </dd>
-
-<dt><b>-G [optional string part of filename]</b> </dt>
-<dd>see --find </dd>
-
-<dt><b>-g [filename/wildcard]</b>
-</dt>
-<dd>see --git </dd>
-
-<dt><b>--git [filename/wildcard]</b> </dt>
-<dd>produces or updates markup source file
-structure in a git repo (experimental and subject to change). Alias -g </dd>
-
-<dt><b>--glob
-[optional string part of filename]</b> </dt>
-<dd>see --find </dd>
-
-<dt><b>-h [filename/wildcard]</b> </dt>
-<dd>see --html
-</dd>
-
-<dt><b>--harvest *.ss[tm]</b> </dt>
-<dd>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. </dd>
-
-<dt><b>--help [topic]</b> </dt>
-<dd>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. </dd>
-
-<dt><b>--html [filename/wildcard]</b> </dt>
-<dd>produces html output, in two forms (i)
-segmented text with table of contents (toc.html and index.html) and (ii)
-the document in a single file (scroll.html). Alias -h </dd>
-
-<dt><b>--html-scroll [filename/wildcard]</b>
-</dt>
-<dd>produces html output, the document in a single file (scroll.html) only. Compare
---html-seg and --html </dd>
-
-<dt><b>--html-seg [filename/wildcard]</b> </dt>
-<dd>produces html output, segmented
-text with table of contents (toc.html and index.html). Compare --html-scroll
-and --html </dd>
-
-<dt><b>-I [filename/wildcard]</b> </dt>
-<dd>see --texinfo </dd>
-
-<dt><b>-i [filename/wildcard]</b> </dt>
-<dd>see --manpage
-</dd>
-
-<dt><b>--i18n-*</b> </dt>
-<dd>these flags affect output by filetype and filename): --i18n-mono (--monolingual)
-output filenames without language code for default language (&rsquo;en&rsquo; or as set);
---i18n-multi (--multilingual) language code provided as part of the output filename,
-this is the default. Where output is in one language only the language code
-may not be desired. see also --output-by-* </dd>
-
-<dt><b>--inc-*</b> </dt>
-<dd>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-* </dd>
-
-<dt><b>-j [filename/wildcard]</b> </dt>
-<dd>copies images associated with a file for use
-by html, xhtml &amp; xml outputs (automatically invoked by --dump &amp; redirect). </dd>
-
-<dt><b>-k</b>
-</dt>
-<dd>see --color-off </dd>
-
-<dt><b>--keep-processing-files [filename/wildcard/url]</b> </dt>
-<dd>see --maintenance
-</dd>
-
-<dt><b>-M [filename/wildcard/url]</b> </dt>
-<dd>see --maintenance </dd>
-
-<dt><b>-m [filename/wildcard/url]</b> </dt>
-<dd>see
---dal (document abstraction level/layer) </dd>
-
-<dt><b>--machine [filename/wildcard/url]</b>
-</dt>
-<dd>see --dal (document abstraction level/layer) </dd>
-
-<dt><b>--maintenance [filename/wildcard/url]</b>
-</dt>
-<dd>maintenance mode, interim processing files are preserved and their locations
-indicated. (also see -V). Aliases -M and --keep-processing-files. </dd>
-
-<dt><b>--manpage [filename/wildcard]</b>
-</dt>
-<dd>produces man page of file, not suitable for all outputs. Alias -i </dd>
-
-<dt><b>--monolingual</b>
-</dt>
-<dd>see --i18n-* </dd>
-
-<dt><b>--multilingual</b> </dt>
-<dd>see --i18n-* </dd>
-
-<dt><b>-N [filename/wildcard/url]</b> </dt>
-<dd>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. </dd>
-
-<dt><b>-n [filename/wildcard/url]</b>
-</dt>
-<dd>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. </dd>
-
-<dt><b>--no-*</b> </dt>
-<dd>see --exc-* </dd>
-
-<dt><b>-o [filename/wildcard/url]</b>
-</dt>
-<dd>see --odt </dd>
-
-<dt><b>--odf [filename/wildcard/url]</b> </dt>
-<dd>see --odt </dd>
-
-<dt><b>--odt [filename/wildcard/url]</b>
-</dt>
-<dd>output basic document in opendocument file format (opendocument.odt). Alias
--o </dd>
-
-<dt><b>--output-by-*</b> </dt>
-<dd>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-*
-</dd>
-
-<dt><b>-P [language_directory/filename language_directory]</b> </dt>
-<dd>see --po4a </dd>
-
-<dt><b>-p [filename/wildcard]</b>
-</dt>
-<dd>see --pdf </dd>
-
-<dt><b>--papersize-(a4|a5|b5|letter|legal)</b> </dt>
-<dd>in conjunction with --pdf set pdf papersize,
-overriding any configuration settings, to set more than one papersize repeat
-the option --pdf --papersize-a4 --papersize-letter. See also --papersize=*
-<p>
-<p> <b>--papersize=a4,a5,b5,letter,legal</b>
-in conjunction with --pdf set pdf papersize, overriding any configuration
-settings, to set more than one papersize list after the equal sign with
-a comma separator --papersize=a4,letter. See also --papersize-* </dd>
-
-<dt><b>--pdf [filename/wildcard]</b>
-</dt>
-<dd>produces <i>LaTeX</i> pdf (portrait.pdf &amp; landscape.pdf). Orientation and papersize
-may be set on the command-line. 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: &rsquo;A4&rsquo;, U.S. &rsquo;letter&rsquo; and &rsquo;legal&rsquo; and book sizes
-&rsquo;A5&rsquo; and &rsquo;B5&rsquo; (system defaults to A4), and; --landscape or --portrait, so: e.g. "sisu
---pdf-a4 --pdf-letter --landscape --verbose [filename/wildcard]" or "sisu --pdf --landscape
---a4 --letter --verbose [filename/wildcard]". --pdf defaults to both landscape &amp;
-portrait output, and a4 if no other papersizes are configured. Related options
---pdf-landscape --pdf-portrait --pdf-papersize-* --pdf-papersize=[list]. Alias -p </dd>
-
-<dt><b>--pdf-l
-[filename/wildcard]</b> </dt>
-<dd>See --pdf-landscape </dd>
-
-<dt><b>--pdf-landscape [filename/wildcard]</b> </dt>
-<dd>sets
-orientation, produces <i>LaTeX</i> 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: &rsquo;A4&rsquo;, U.S. &rsquo;letter&rsquo; and
-&rsquo;legal&rsquo; and book sizes &rsquo;A5&rsquo; and --papersize-* or --papersize=[list]. Alias --pdf-l
-or in conjunction with --pdf --landscape </dd>
-
-<dt><b>--pdf-p [filename/wildcard]</b> </dt>
-<dd>See --pdf-portrait
-</dd>
-
-<dt><b>--pdf-portrait [filename/wildcard]</b> </dt>
-<dd>sets orientation, produces <i>LaTeX</i> pdf portrait.pdf.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:
-&rsquo;A4&rsquo;, U.S. &rsquo;letter&rsquo; and &rsquo;legal&rsquo; and book sizes &rsquo;A5&rsquo; and --papersize-* or --papersize=[list].
-Alias --pdf-p or in conjunction with --pdf --portrait </dd>
-
-<dt><b>--pg [instruction] [filename]</b>
-</dt>
-<dd>database <i>PostgreSQL</i> ( --pgsql may be used instead) possible instructions,
-include: --createdb; --create; --dropall; --import [filename]; --update [filename];
---remove [filename]; see database section below. Alias -D </dd>
-
-<dt><b>--po [language_directory/filename
-language_directory]</b> </dt>
-<dd>see --po4a </dd>
-
-<dt><b>--po4a [language_directory/filename language_directory]</b>
-</dt>
-<dd>produces .pot and po files for the file in the languages specified by the
-language directory. <b>SiSU</b> 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 </dd>
-
-<dt><b>-Q [filename/wildcard]</b>
-</dt>
-<dd>see --qrcode </dd>
-
-<dt><b>-q [filename/wildcard]</b> </dt>
-<dd>see --quiet </dd>
-
-<dt><b>--qrcode [filename/wildcard]</b> </dt>
-<dd>generate
-QR code image of metadata (used in manifest). v3 only. </dd>
-
-<dt><b>--quiet [filename/wildcard]</b>
-</dt>
-<dd>quiet less output to screen. </dd>
-
-<dt><b>-R [filename/wildcard]</b> </dt>
-<dd>see --rsync </dd>
-
-<dt><b>-r [filename/wildcard]</b>
-</dt>
-<dd>see --scp </dd>
-
-<dt><b>--redirect[=directory_path] [filename/wildcard]</b> </dt>
-<dd>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). Unlike using default settings <i>HTML</i> files
-have embedded css. Compare --dump </dd>
-
-<dt><b>--rsync [filename/wildcard]</b> </dt>
-<dd>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 </dd>
-
-<dt><b>-S</b> </dt>
-<dd>see --sisupod </dd>
-
-<dt><b>-S [filename/wildcard]</b>
-</dt>
-<dd>see --sisupod </dd>
-
-<dt><b>-s [filename/wildcard]</b> </dt>
-<dd>see --source </dd>
-
-<dt><b>--sample-search-form [--db=(pgsql|sqlite)]
-[--webserv=webrick]</b> </dt>
-<dd>generate examples of (naive) cgi search form for <i>SQLite</i>
-or PgSQL depends on your already having used sisu to populate an <i>SQLite</i>
-or PgSQL database, (the <i>SQLite</i> version scans the output directories for
-existing sisu_sqlite databases, so it is first necessary to create them,
-before generating the search form) see --sqlite &amp; --pg and the database section
-below. Optional additional parameters include: url location of webserver
-search form and db: --webserv-search=&rsquo;[url]&rsquo;; location of webserver output:
---webserv-output=&rsquo;[url]&rsquo;; cgi search form link name: --cgi-search-form-name=&rsquo;[name.cgi]&rsquo;;
-for pgsql, database user: --db-user=&rsquo;[username]&rsquo;. 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 </dd>
-
-<dt><b>--scp [filename/wildcard]</b>
-</dt>
-<dd>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 </dd>
-
-<dt><b>--sqlite --[instruction]
-[filename]</b> </dt>
-<dd>database type set to <i>SQLite,</i> this produces one of two possible
-databases, without additional database related instructions it produces
-a discreet <i>SQLite</i> file for the document processed; with additional instructions
-it produces a common <i>SQLite</i> 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 </dd>
-
-<dt><b>--sisupod</b> </dt>
-<dd>produces a sisupod a zipped
-sisu directory of markup files including sisu markup source files and the
-directories local configuration file, images and skins. Note: this only
-includes the configuration files or skins contained in is tested only
-with zsh). Alias -S </dd>
-
-<dt><b>--sisupod [filename/wildcard]</b> </dt>
-<dd>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. <b>SiSU</b> 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 </dd>
-
-<dt><b>--source [filename/wildcard]</b> </dt>
-<dd>copies sisu markup file to output directory.
-Alias -s </dd>
-
-<dt><b>-T [filename/wildcard (*.termsheet.rb)]</b> </dt>
-<dd>standard form document builder,
-preprocessing feature </dd>
-
-<dt><b>-t [filename/wildcard]</b> </dt>
-<dd>see --txt </dd>
-
-<dt><b>--texinfo [filename/wildcard]</b>
-</dt>
-<dd>produces texinfo and info file, (view with pinfo). Alias -I </dd>
-
-<dt><b>--txt [filename/wildcard]</b>
-</dt>
-<dd>produces <i>plaintext</i> 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 </dd>
-
-<dt><b>-U [filename/wildcard]</b> </dt>
-<dd>see --urls </dd>
-
-<dt><b>-u [filename/wildcard]</b> </dt>
-<dd>provides url mapping
-of output files for the flags requested for processing, also see -U </dd>
-
-<dt><b>--urls
-[filename/wildcard]</b> </dt>
-<dd>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 </dd>
-
-<dt><b>-V</b> </dt>
-<dd>on its own,
-provides <b>SiSU</b> version and environment information (sisu --help env) </dd>
-
-<dt><b>-V [filename/wildcard]</b>
-</dt>
-<dd>even more verbose than the -v flag. </dd>
-
-<dt><b>-v</b> </dt>
-<dd>on its own, provides <b>SiSU</b> version information
-</dd>
-
-<dt><b>-v [filename/wildcard]</b> </dt>
-<dd>see --verbose </dd>
-
-<dt><b>--v3 [filename/wildcard]</b> </dt>
-<dd>invokes the sisu
-v3 document parser/generator. You may run sisu3 instead. </dd>
-
-<dt><b>--v4 [filename/wildcard]</b>
-</dt>
-<dd>invokes the sisu v4 document parser/generator. This is the default and is
-normally omitted. </dd>
-
-<dt><b>--verbose [filename/wildcard]</b> </dt>
-<dd>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 </dd>
-
-<dt><b>-W</b> </dt>
-<dd>see --webrick </dd>
-
-<dt><b>-w [filename/wildcard]</b>
-</dt>
-<dd>see --concordance </dd>
-
-<dt><b>--webrick</b> </dt>
-<dd>starts ruby&rsquo; 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 </dd>
-
-<dt><b>--wordmap [filename/wildcard]</b> </dt>
-<dd>see --concordance
-</dd>
-
-<dt><b>--xhtml [filename/wildcard]</b> </dt>
-<dd>produces xhtml/ <i>XML</i> output for browser viewing
-(sax parsing). Alias -b </dd>
-
-<dt><b>--xml-dom [filename/wildcard]</b> </dt>
-<dd>produces <i>XML</i> output with
-deep document structure, in the nature of dom. Alias -X </dd>
-
-<dt><b>--xml-sax [filename/wildcard]</b>
-</dt>
-<dd>produces <i>XML</i> output shallow structure (sax parsing). Alias -x </dd>
-
-<dt><b>-X [filename/wildcard]</b>
-</dt>
-<dd>see --xml-dom </dd>
-
-<dt><b>-x [filename/wildcard]</b> </dt>
-<dd>see --xml-sax </dd>
-
-<dt><b>-Y [filename/wildcard]</b> </dt>
-<dd>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]) </dd>
-
-<dt><b>-y [filename/wildcard]</b> </dt>
-<dd>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.
-</dd>
-
-<dt><b>-Z [filename/wildcard]</b> </dt>
-<dd>see --zap </dd>
-
-<dt><b>--zap [filename/wildcard]</b> </dt>
-<dd>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 </dd>
-</dl>
-
-<h2><a name='sect8' href='#toc8'>Command Line Modifiers</a></h2>
-
-<p>
-<dl>
-
-<dt><b>--no-ocn</b> </dt>
-<dd>[with --html
---pdf or --epub] switches off <i>object</i> citation numbering. Produce output without
-identifying numbers in margins of html or <i>LaTeX</i> /pdf output. </dd>
-
-<dt><b>--no-annotate</b>
-</dt>
-<dd>strips output text of editor endnotes[^*1] denoted by asterisk or dagger/plus
-sign </dd>
-
-<dt><b>--no-asterisk</b> </dt>
-<dd>strips output text of editor endnotes[^*2] denoted by asterisk
-sign </dd>
-
-<dt><b>--no-dagger</b> </dt>
-<dd>strips output text of editor endnotes[^+1] denoted by dagger/plus
-sign </dd>
-</dl>
-
-<h2><a name='sect9' href='#toc9'>Database Commands</a></h2>
-
-<p> <b>dbi - database interface</b>
-<p> <b>-D or --pgsql</b> set for <i>PostgreSQL</i>
-<b>-d or --sqlite</b> default set for <i>SQLite</i> -d is modifiable with --db=[database type
-(PgSQL or <i>SQLite</i> ) ]
-<dl>
-
-<dt><b>--pg -v --createall</b> </dt>
-<dd>initial step, creates required relations
-(tables, indexes) in existing <i>PostgreSQL</i> database (a database should be
-created manually and given the same name as working directory, as requested)
-(rb.dbi) [ -dv --createall <i>SQLite</i> equivalent] it may be necessary to run sisu
--Dv --createdb initially NOTE: at the present time for <i>PostgreSQL</i> it may be
-necessary to manually create the database. The command would be directory
-name (without path)]. Please use only alphanumerics and underscores. </dd>
-
-<dt><b>--pg -v
---import</b> </dt>
-<dd>[filename/wildcard] imports data specified to <i>PostgreSQL</i> db (rb.dbi)
-[ -dv --import <i>SQLite</i> equivalent] </dd>
-
-<dt><b>--pg -v --update</b> </dt>
-<dd>[filename/wildcard] updates/imports
-specified data to <i>PostgreSQL</i> db (rb.dbi) [ -dv --update <i>SQLite</i> equivalent]
-</dd>
-
-<dt><b>--pg --remove</b> </dt>
-<dd>[filename/wildcard] removes specified data to <i>PostgreSQL</i> db (rb.dbi)
-[ -d --remove <i>SQLite</i> equivalent] </dd>
-
-<dt><b>--pg --dropall</b> </dt>
-<dd>kills data" and drops ( <i>PostgreSQL</i>
-or <i>SQLite</i> ) db, tables &amp; indexes [ -d --dropall <i>SQLite</i> equivalent]
-<p> The -v
-is for verbose output. </dd>
-</dl>
-
-<h2><a name='sect10' href='#toc10'>Shortcuts, Shorthand for Multiple Flags</a></h2>
-
-<p>
-<dl>
-
-<dt><b>--update [filename/wildcard]</b>
-</dt>
-<dd>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. </dd>
-
-<dt><b>-0 to -5 [filename or wildcard]</b> </dt>
-<dd>Default shorthand mappings (for v3,
-note that the defaults can be changed/configured in the sisurc.yml file):
-</dd>
-
-<dt><b>-0</b> </dt>
-<dd>-NQhewpotbxXyYv [this is the default action run when no options are give,
-i.e. on &rsquo;sisu [filename]&rsquo;] </dd>
-
-<dt><b>-1</b> </dt>
-<dd>-Qhewpoty </dd>
-
-<dt><b>-2</b> </dt>
-<dd>-NQhewpotbxXy </dd>
-
-<dt><b>-3</b> </dt>
-<dd>-NQhewpotbxXyY </dd>
-
-<dt><b>-4</b> </dt>
-<dd>-NQhewpotbxXDyY
---update </dd>
-
-<dt><b>-5</b> </dt>
-<dd>-NQhewpotbxXDyYv --update
-<p> add -v for verbose mode and -c to toggle
-color state, e.g. sisu -2vc [filename or wildcard]
-<p> consider -u for appended
-
-<p>url info or -v for verbose output
-<p> </dd>
-</dl>
-
-<h2><a name='sect11' href='#toc11'>Command Line with Flags - Batch Processing</a></h2>
-
-<p>
- 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.
-<p> 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.
-<h2><a name='sect12' href='#toc12'>Help</a></h2>
-
-<p>
-
-<h2><a name='sect13' href='#toc13'>Sisu Manual</a></h2>
-
-<p> The most up to date information on sisu should be contained
-in the sisu_manual, available at:
-<p> &lt;<a href='http://sisudoc.org/sisu/sisu_manual/'>http://sisudoc.org/sisu/sisu_manual/</a>
-&gt;
-
-<p> The manual can be generated from source, found respectively, either within
-the <b>SiSU</b> tarball or installed locally at:
-<p> ./data/doc/sisu/markup-samples/sisu_manual
-
-<p> /usr/share/doc/sisu/markup-samples/sisu_manual
-<p> move to the respective
-directory and type e.g.:
-<p> sisu sisu_manual.ssm
-<h2><a name='sect14' href='#toc14'>Sisu Man Pages</a></h2>
-
-<p> If <b>SiSU</b> is
-installed on your system usual man commands should be available, try:
-<p>
- man sisu
-<p> Most <b>SiSU</b> 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 <b>SiSU</b> tarball at:
-<p> ./data/doc/sisu/markup-samples/sisu_manual<br>
-
-<p> Once installed, directory equivalent to:
-<p> /usr/share/doc/sisu/markup-samples/sisu_manual<br>
-
-<p> Available man pages are converted back to html using man2html:
-<p> /usr/share/doc/sisu/html/<br>
-
-<p> ./data/doc/sisu/html<br>
-
-<p> An online version of the sisu man page is available here:
-<p> * various
-sisu man pages &lt;<a href='http://www.jus.uio.no/sisu/man/'>http://www.jus.uio.no/sisu/man/</a>
-&gt; [^9]
-<p> * sisu.1 &lt;<a href='http://www.jus.uio.no/sisu/man/sisu.1.html'>http://www.jus.uio.no/sisu/man/sisu.1.html</a>
-&gt;
-[^10]
-<p>
-<h2><a name='sect15' href='#toc15'>Sisu Built-in Interactive Help, [discontinued]</a></h2>
-
-<p> This fell out of date
-and has been discontinued.
-<h2><a name='sect16' href='#toc16'>Introduction to Sisu Markup[^11]</a></h2>
-
-<p>
-<h2><a name='sect17' href='#toc17'>Summary</a></h2>
-
-<p> <b>SiSU</b>
-source documents are <i>plaintext</i> ( <i>UTF-8</i> )[^12] files
-<p> All paragraphs are
-separated by an empty line.
-<p> Markup is comprised of:
-<p> * 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)
-<p> * 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:
-<p> * heading
-levels defines document structure<br>
-
-<p> * text basic attributes, italics, bold etc.<br>
-
-<p> * grouped text (objects), which are to be treated differently, such
-as code<br>
- blocks or poems.<br>
-
-<p> * footnotes/endnotes<br>
-
-<p> * linked text and images
-<p> * paragraph actions, such as indent, bulleted,
-numbered-lists, etc.
-<p> Some interactive help on markup is available, by typing
-
-<p>sisu and selecting markup or sisu --help markup
-<p> To check the markup in
-a file:
-<p> sisu --identify [filename].sst
-<p> For brief descriptive summary of
-
-<p>markup history
-<p> sisu --query-history
-<p> or if for a particular version:
-<p>
-sisu --query-0.38
-<h2><a name='sect18' href='#toc18'>Markup Examples</a></h2>
-
-<p>
-<h2><a name='sect19' href='#toc19'>Online</a></h2>
-
-<p> Online markup examples are available
-together with the respective outputs produced from &lt;<a href='http://www.jus.uio.no/sisu/SiSU/examples.html'>http://www.jus.uio.no/sisu/SiSU/examples.html</a>
-&gt;
-or from &lt;<a href='http://www.jus.uio.no/sisu/sisu_examples/'>http://www.jus.uio.no/sisu/sisu_examples/</a>
-&gt;
-<p> There is of course this
-document, which provides a cursory overview of sisu markup and the respective
-output produced: &lt;<a href='http://www.jus.uio.no/sisu/sisu_markup/'>http://www.jus.uio.no/sisu/sisu_markup/</a>
-&gt;
-<p> an alternative
-presentation of markup syntax: /usr/share/doc/sisu/on_markup.txt.gz
-<p>
-<h2><a name='sect20' href='#toc20'>Installed</a></h2>
-
-<p>
- With <b>SiSU</b> 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:
-
-<p>/usr/share/doc/sisu/markup-samples-non-free
-<p>
-<h2><a name='sect21' href='#toc21'>Markup of Headers</a></h2>
-
-<p>
-<p> Headers contain
-either: semantic meta-data about a document, which can be used by any output
-module of the program, or; processing instructions.
-<p> 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:
-<p> <br>
-<pre>% this would be a comment
-</pre>
-<p>
-<h2><a name='sect22' href='#toc22'>Sample Header</a></h2>
-
-<p> This current document is loaded by a master document that
-has a header similar to this one:
-<p> <br>
-<pre>% SiSU master 4.0
-@title: SiSU
- :subtitle: Manual
-@creator:
- :author: Amissah, Ralph
-@publisher: [publisher name]
-@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation,
-License GPL 3
-@classify:
- :topic_register: SiSU:manual;electronic documents:SiSU:manual
- :subject: ebook, epublishing, electronic book, electronic publishing,
- electronic document, electronic citation, data structure,
- citation systems, search
-% used_by: manual
-@date:
- :published: 2008-05-22
- :created: 2002-08-28
- :issued: 2002-08-28
- :available: 2002-08-28
- :modified: 2010-03-03
-@make:
- :num_top: 1
- :breaks: new=C; break=1
- :bold: /Gnu|Debian|Ruby|SiSU/
- :home_button_text: {SiSU}http://sisudoc.org; {git}http://git.sisudoc.org
- :footer: {SiSU}http://sisudoc.org; {git}http://git.sisudoc.org
- :manpage: name=sisu - documents: markup, structuring, publishing in multiple
-standard formats, and search;
- synopsis=sisu [-abcDdeFhIiMmNnopqRrSsTtUuVvwXxYyZz0-9] [filename/wildcard
-]
- . sisu [-Ddcv] [instruction]
- . sisu [-CcFLSVvW]
- . sisu --v4 [operations]
- . sisu --v3 [operations]
-@links:
- { SiSU Homepage }http://www.sisudoc.org/
- { SiSU Manual }http://www.sisudoc.org/sisu/sisu_manual/
- { Book Samples &amp; 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
-</pre>
-<p>
-<h2><a name='sect23' href='#toc23'>Available Headers</a></h2>
-
-<p> Header tags appear at the beginning of a document and
-provide meta information on the document (such as the <i>Dublin</i> 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</i> Core meta tags are available
-<p>
- <b>@indentifier:</b> information or instructions
-<p> where the "identifier" is
-a tag recognised by the program, and the "information" or "instructions"
-
-<p>belong to the tag/identifier specified
-<p> 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.
-
-<p> This is a sample header
-<p> <br>
-<pre>% SiSU 2.0 [declared file-type identifier with markup version]
-</pre>
-<p> <br>
-<pre>@title: [title text] [this header is the only one that is mandatory]
- :subtitle: [subtitle if any]
- :language: English
-</pre>
-<p> <br>
-<pre>@creator:
- :author: [Lastname, First names]
- :illustrator: [Lastname, First names]
- :translator: [Lastname, First names]
- :prepared_by: [Lastname, First names]
-</pre>
-<p> <br>
-<pre>@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]
-</pre>
-<p> <br>
-<pre>@rights:
- :copyright: Copyright (C) [Year and Holder]
- :license: [Use License granted]
- :text: [Year and Holder]
- :translation: [Name, Year]
- :illustrations: [Name, Year]
-</pre>
-<p> <br>
-<pre>@classify:
- :topic_register: SiSU:markup sample:book;book:novel:fantasy
- :type:
- :subject:
- :description:
- :keywords:
- :abstract:
- :loc: [Library of Congress classification]
- :dewey: [Dewey classification
-</pre>
-<p> <br>
-<pre>@identify:
- :isbn: [ISBN]
- :oclc:
-</pre>
-<p> <br>
-<pre>@links: { SiSU }http://www.sisudoc.org
- { FSF }http://www.fsf.org
-</pre>
-<p> <br>
-<pre>@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
-</pre>
-<p> <br>
-<pre>@original:
- :language: [language]
-</pre>
-<p> <br>
-<pre>@notes:
- :comment:
- :prefix: [prefix is placed just after table of contents]
-</pre>
-<p>
-<h2><a name='sect24' href='#toc24'>Markup of Substantive Text</a></h2>
-
-<p>
-<h2><a name='sect25' href='#toc25'>Heading Levels</a></h2>
-
-<p> 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)
-<p> <b>:A~ [heading
-text]</b> Top level heading [this usually has similar content to the title
-@title: ] NOTE: the heading levels described here are in 0.38 notation,
-
-<p>see heading
-<p> <b>:B~ [heading text]</b> Second level heading [this is a heading
-level divider]
-<p> <b>:C~ [heading text]</b> Third level heading [this is a heading
-level divider]
-<p> <b>1~ [heading text]</b> 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
-
-<p> <b>2~ [heading text]</b> 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.
-<p> <b>3~ [heading text]</b> 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
-<p> <br>
-<pre>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)
-</pre>
-<p>
-<h2><a name='sect26' href='#toc26'>Font Attributes</a></h2>
-
-<p> <b>markup example:</b>
-<p> <br>
-<pre>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}#
-</pre>
-<p> <b>resulting output:</b>
-<p> normal text, <b>emphasis,</b> <b>bold text</b> , <i>italics,</i> <i>underscore,</i>
-"citation", ^superscript^, [subscript], ++inserted text++, --strikethrough--,
-
-<p>monospace
-<p> normal text
-<p> <b>emphasis</b> [note: can be configured to be represented
-by bold, italics or underscore]
-<p> <b>bold text</b>
-<p> <i>italics</i>
-<p> <i>underscore</i>
-<p> "citation"
-
-<p> ^superscript^
-<p> [subscript]
-<p> ++inserted text++
-<p> --strikethrough--
-<p> monospace
-
-<p>
-<h2><a name='sect27' href='#toc27'>Indentation and Bullets</a></h2>
-
-<p> <b>markup example:</b>
-<p> <br>
-<pre>ordinary paragraph
-_1 indent paragraph one step
-_2 indent paragraph two steps
-_9 indent paragraph nine steps
-</pre>
-<p> <b>resulting output:</b>
-<p> ordinary paragraph
-<p> indent paragraph one step<br>
-
-<p> indent paragraph two steps<br>
-
-<p> indent paragraph nine steps<br>
-
-<p> <b>markup example:</b>
-<p> <br>
-<pre>_* bullet text
-_1* bullet text, first indent
-_2* bullet text, two step indent
-</pre>
-<p> <b>resulting output:</b>
-<p> * bullet text
-<p> * bullet text, first indent<br>
-
-<p> * bullet text, two step indent<br>
-
-<p> Numbered List (not to be confused with headings/titles, (document structure))
-
-<p> <b>markup example:</b>
-<p> <br>
-<pre># numbered list numbered list 1., 2., 3, etc.
-_# numbered list numbered list indented a., b., c., d., etc.
-</pre>
-<p>
-<h2><a name='sect28' href='#toc28'>Hanging Indents</a></h2>
-
-<p> <b>markup example:</b>
-<p> <br>
-<pre>_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
-</pre>
-<p> <b>resulting output:</b>
-<p> first line no indent, rest of paragraph indented
-one step; first line no indent, rest of paragraph indented one step;
-first line no indent, rest of<br>
- paragraph indented one step; first line no indent, rest of paragraph
-indented<br>
- one step; first line no indent, rest of paragraph indented one step;
-first<br>
- line no indent, rest of paragraph indented one step; first line no indent,<br>
- rest of paragraph indented one step; first line no indent, rest of paragraph<br>
- indented one step; first line no indent, rest of paragraph indented
-one step;<br>
-
-<p> A regular paragraph.
-<p> first line indented, rest of paragraph no indent
-first line indented, rest of paragraph no indent first line indented, rest
-of paragraph no indent first line indented, rest of paragraph no indent
-first line indented, rest of paragraph no indent first line indented, rest
-of paragraph no indent first line indented, rest of paragraph no indent
-first line indented, rest of paragraph no indent first line indented, rest
-of paragraph no indent first line indented, rest of paragraph no indent
-first line indented, rest of paragraph no indent
-<p> in each case level may
-
-<p>be 0-9
-<p>
-<p> <b>live-build</b> A collection of scripts used to build customized<br>
- <b>Debian</b>
-<p> Livesystems.<br>
- .I live-build<br>
- was formerly known as live-helper, and even earlier known as live-package.<br>
-
-<p>
-<p> <b>live-build</b>
-<p> A collection of scripts used to build customized<br>
- <b>Debian</b> Livesystems.<br>
- <i>live-build</i> was formerly known as live-helper, and even earlier known as
-live-package.<br>
-
-<p>
-<h2><a name='sect29' href='#toc29'>Footnotes / Endnotes</a></h2>
-
-<p> Footnotes and endnotes are marked up at the location
-where they would be indicated within a text. They are automatically numbered.
-
-<p>The output type determines whether footnotes or endnotes will be produced
-
-<p> <b>markup example:</b>
-<p> <br>
-<pre>~{ a footnote or endnote }~
-</pre>
-<p> <b>resulting output:</b>
-<p> [^13]
-<p> <b>markup example:</b>
-<p> <br>
-<pre>normal text~{ self contained endnote marker &amp; endnote in one }~ continues
-</pre>
-<p> <b>resulting output:</b>
-<p> normal text[^14] continues
-<p> <b>markup example:</b>
-<p> <br>
-<pre>normal text ~{* unnumbered asterisk footnote/endnote, insert multiple asterisks
-if required }~ continues
-normal text ~{** another unnumbered asterisk footnote/endnote }~ continues
-</pre>
-<p> <b>resulting output:</b>
-<p> normal text [^*] continues
-<p> normal text [^**] continues
-
-<p> <b>markup example:</b>
-<p> <br>
-<pre>normal text ~[* editors notes, numbered asterisk footnote/endnote series
-]~ continues
-normal text ~[+ editors notes, numbered asterisk footnote/endnote series
-]~ continues
-</pre>
-<p> <b>resulting output:</b>
-<p> normal text [^*3] continues
-<p> normal text [^+2] continues
-
-<p> <b>Alternative endnote pair notation for footnotes/endnotes:</b>
-<p> <br>
-<pre>% note the endnote marker "~^"
-normal text~^ continues
-^~ endnote text following the paragraph in which the marker occurs
-</pre>
-<p> the standard and pair notation cannot be mixed in the same document
-<p>
-
-<h2><a name='sect30' href='#toc30'>Links</a></h2>
-
-<p>
-<h2><a name='sect31' href='#toc31'>Naked Urls Within Text, Dealing with Urls</a></h2>
-
-<p> 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).
-<p> <b>markup example:</b>
-<p> <br>
-<pre>normal text http://www.sisudoc.org/ continues
-</pre>
-<p> <b>resulting output:</b>
-<p> normal text &lt;<a href='http://www.sisudoc.org/'>http://www.sisudoc.org/</a>
-&gt; continues
-<p> An
-
-<p>escaped url without decoration
-<p> <b>markup example:</b>
-<p> <br>
-<pre>normal text _http://www.sisudoc.org/ continues
-deb _http://www.jus.uio.no/sisu/archive unstable main non-free
-</pre>
-<p> <b>resulting output:</b>
-<p> normal text &lt;_<a href='http://www.sisudoc.org/'>http://www.sisudoc.org/</a>
-&gt; continues
-<p> deb
-&lt;_<a href='http://www.jus.uio.no/sisu/archive'>http://www.jus.uio.no/sisu/archive</a>
-&gt; unstable main non-free
-<p> where a code block
-is used there is neither decoration nor hyperlinking, code blocks are discussed
-
-<p>later in this document
-<p> <b>resulting output:</b>
-<p> <br>
-<pre>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
-</pre>
-<p>
-<h2><a name='sect32' href='#toc32'>Linking Text</a></h2>
-
-<p> To link text or an image to a url the markup is as follows
-
-<p> <b>markup example:</b>
-<p> <br>
-<pre>about { SiSU }http://url.org markup
-</pre>
-<p> <b>resulting output:</b>
-<p> aboutSiSU &lt;<a href='http://www.sisudoc.org/'>http://www.sisudoc.org/</a>
-&gt; markup
-<p> A shortcut
-
-<p>notation is available so the url link may also be provided automatically
-
-<p>as a footnote
-<p> <b>markup example:</b>
-<p> <br>
-<pre>about {~^ SiSU }http://url.org markup
-</pre>
-<p> <b>resulting output:</b>
-<p> aboutSiSU &lt;<a href='http://www.sisudoc.org/'>http://www.sisudoc.org/</a>
-&gt; [^15] markup
-<p> Internal
-document links to a tagged location, including an ocn
-<p> <b>markup example:</b>
-
-<p> <br>
-<pre>about { text links }#link_text
-</pre>
-<p> <b>resulting output:</b>
-<p> about ⌠text links⌡⌈link_text⌋
-<p> Shared document
-
-<p>collection link
-<p> <b>markup example:</b>
-<p> <br>
-<pre>about { SiSU book markup examples }:SiSU/examples.html
-</pre>
-<p> <b>resulting output:</b>
-<p> about ⌠ <b>SiSU</b> book markup examples⌡⌈:SiSU/examples.html⌋
-
-<p>
-<h2><a name='sect33' href='#toc33'>Linking Images</a></h2>
-
-<p> <b>markup example:</b>
-<p> <br>
-<pre>{ 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/
-</pre>
-<p> <b>resulting output:</b>
-<p> [ tux.png ]
-<p> tux.png 64x80 "Gnu/Linux - a better way"
-&lt;<a href='http://www.sisudoc.org/'>http://www.sisudoc.org/</a>
-&gt;
-<p> GnuDebianLinuxRubyBetterWay.png 100x101 "Way Better
-- with Gnu/Linux, Debian and Ruby" &lt;<a href='http://www.sisudoc.org/'>http://www.sisudoc.org/</a>
-&gt;
-<p> ruby_logo.png
-70x90 "Ruby" &lt;<a href='http://www.ruby-lang.org/en/'>http://www.ruby-lang.org/en/</a>
-&gt; [^16]
-<p> <b>linked url footnote shortcut</b>
-
-<p> <br>
-<pre>{~^ [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
-</pre>
-<p> <br>
-<pre>text marker *~name
-</pre>
-<p> 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.
-<h2><a name='sect34' href='#toc34'>Link Shortcut for Multiple
-Versions of a Sisu Document in the Same Directory</a></h2>
-TREE
-<p> <b>markup example:</b>
-
-<p> <br>
-<pre>!_ /{"Viral Spiral"}/, David Bollier
-{ "Viral Spiral", David Bollier [3sS]}viral_spiral.david_bollier.sst
-</pre>
-<p> <b></b> <i>Viral Spiral</i>, David Bollier
-<p> "Viral Spiral", David Bollier &lt;<a href='http://corundum/sisu_manual/en/manifest/viral_spiral.david_bollier.html'>http://corundum/sisu_manual/en/manifest/viral_spiral.david_bollier.html</a>
-&gt;
- document manifest &lt;<a href='http://corundum/sisu_manual/en/manifest/viral_spiral.david_bollier.html'>http://corundum/sisu_manual/en/manifest/viral_spiral.david_bollier.html</a>
-&gt;<br>
- ⌠html, segmented text⌡「<a href='http://corundum/sisu_manual/en/html/viral_spiral.david_bollier.html」'>http://corundum/sisu_manual/en/html/viral_spiral.david_bollier.html」</a>
-<br>
- ⌠html, scroll, document in one⌡「<a href='http://corundum/sisu_manual/en/html/viral_spiral.david_bollier.html」'>http://corundum/sisu_manual/en/html/viral_spiral.david_bollier.html」</a>
-<br>
- ⌠epub⌡「<a href='http://corundum/sisu_manual/en/epub/viral_spiral.david_bollier.epub」'>http://corundum/sisu_manual/en/epub/viral_spiral.david_bollier.epub」</a>
-<br>
- ⌠pdf, landscape⌡「<a href='http://corundum/sisu_manual/en/pdf/viral_spiral.david_bollier.pdf」'>http://corundum/sisu_manual/en/pdf/viral_spiral.david_bollier.pdf」</a>
-<br>
- ⌠pdf, portrait⌡「<a href='http://corundum/sisu_manual/en/pdf/viral_spiral.david_bollier.pdf」'>http://corundum/sisu_manual/en/pdf/viral_spiral.david_bollier.pdf」</a>
-<br>
- ⌠odf: odt, open document text⌡「<a href='http://corundum/sisu_manual/en/odt/viral_spiral.david_bollier.odt」'>http://corundum/sisu_manual/en/odt/viral_spiral.david_bollier.odt」</a>
-<br>
- ⌠xhtml scroll⌡「<a href='http://corundum/sisu_manual/en/xhtml/viral_spiral.david_bollier.xhtml」'>http://corundum/sisu_manual/en/xhtml/viral_spiral.david_bollier.xhtml」</a>
-<br>
- ⌠xml, sax⌡「<a href='http://corundum/sisu_manual/en/xml/viral_spiral.david_bollier.xml」'>http://corundum/sisu_manual/en/xml/viral_spiral.david_bollier.xml」</a>
-<br>
- ⌠xml, dom⌡「<a href='http://corundum/sisu_manual/en/xml/viral_spiral.david_bollier.xml」'>http://corundum/sisu_manual/en/xml/viral_spiral.david_bollier.xml」</a>
-<br>
- ⌠concordance⌡「<a href='http://corundum/sisu_manual/en/html/viral_spiral.david_bollier.html」'>http://corundum/sisu_manual/en/html/viral_spiral.david_bollier.html」</a>
-<br>
- ⌠dcc, document content certificate (digests)⌡「<a href='http://corundum/sisu_manual/en/digest/viral_spiral.david_bollier.txt」'>http://corundum/sisu_manual/en/digest/viral_spiral.david_bollier.txt」</a>
-<br>
- ⌠markup source text⌡「<a href='http://corundum/sisu_manual/en/src/viral_spiral.david_bollier.sst」'>http://corundum/sisu_manual/en/src/viral_spiral.david_bollier.sst」</a>
-<br>
- ⌠markup source (zipped) pod⌡「<a href='http://corundum/sisu_manual/en/pod/viral_spiral.david_bollier.sst.zip」'>http://corundum/sisu_manual/en/pod/viral_spiral.david_bollier.sst.zip」</a>
-<br>
-
-<p>
-<h2><a name='sect35' href='#toc35'>Grouped Text</a></h2>
-
-<p>
-<h2><a name='sect36' href='#toc36'>Tables</a></h2>
-
-<p> Tables may be prepared in two either of two forms
-
-<p> <b>markup example:</b>
-<p> <br>
-<pre>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
-</pre>
-<p> <b>resulting output:</b>
-<p> 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』
-<p> a second form may
-
-<p>be easier to work with in cases where there is not much information in
-
-<p>each column
-<p> <b>markup example:</b> [^17] <br>
-<pre>!_ 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.
-</pre>
-<p> <b>resulting output:</b>
-<p> <b>Table 3.1: Contributors to Wikipedia, January 2001
-- June 2005</b> |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』
-<p> * Contributed
-at least ten times; ** at least 5 times in last month; *** more than 100
-times in last month.
-<p>
-<h2><a name='sect37' href='#toc37'>Poem</a></h2>
-
-<p> <b>basic markup:</b>
-<p> <br>
-<pre>poem{
- Your poem here
-}poem
-Each verse in a poem is given an object number.
-</pre>
-<p> <b>markup example:</b>
-<p> <br>
-<pre>poem{
- &lsquo;Fury said to a
- mouse, That he
- met in the
- house,
- "Let us
- both go to
- law: I will
- prosecute
- YOU. --Come,
- I&rsquo;ll take no
- denial; We
- must have a
- trial: For
- really this
- morning I&rsquo;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&rsquo;ll be
- judge, I&rsquo;ll
- be jury,"
- Said
- cunning
- old Fury:
- "I&rsquo;ll
- try the
- whole
- cause,
- and
- condemn
- you
- to
- death."&rsquo;
-}poem
-</pre>
-<p> <b>resulting output:</b>
-<p> &lsquo;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&rsquo;ll take no<br>
- denial; We<br>
- must have a<br>
- trial: For<br>
- really this<br>
- morning I&rsquo;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&rsquo;ll be<br>
- judge, I&rsquo;ll<br>
- be jury,"<br>
- Said<br>
- cunning<br>
- old Fury:<br>
- "I&rsquo;ll<br>
- try the<br>
- whole<br>
- cause,<br>
- and<br>
- condemn<br>
- you<br>
- to<br>
- death."&rsquo;<br>
-
-<p>
-<h2><a name='sect38' href='#toc38'>Group</a></h2>
-
-<p> <b>basic markup:</b>
-<p> <br>
-<pre>group{
- Your grouped text here
-}group
-A group is treated as an object and given a single object number.
-</pre>
-<p> <b>markup example:</b>
-<p> <br>
-<pre>group{
- &lsquo;Fury said to a
- mouse, That he
- met in the
- house,
- "Let us
- both go to
- law: I will
- prosecute
- YOU. --Come,
- I&rsquo;ll take no
- denial; We
- must have a
- trial: For
- really this
- morning I&rsquo;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&rsquo;ll be
- judge, I&rsquo;ll
- be jury,"
- Said
- cunning
- old Fury:
- "I&rsquo;ll
- try the
- whole
- cause,
- and
- condemn
- you
- to
- death."&rsquo;
-}group
-</pre>
-<p> <b>resulting output:</b>
-<p> &lsquo;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&rsquo;ll take no<br>
- denial; We<br>
- must have a<br>
- trial: For<br>
- really this<br>
- morning I&rsquo;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&rsquo;ll be<br>
- judge, I&rsquo;ll<br>
- be jury,"<br>
- Said<br>
- cunning<br>
- old Fury:<br>
- "I&rsquo;ll<br>
- try the<br>
- whole<br>
- cause,<br>
- and<br>
- condemn<br>
- you<br>
- to<br>
- death."&rsquo;<br>
-
-<p>
-<h2><a name='sect39' href='#toc39'>Code</a></h2>
-
-<p> Code tags code{ ... }code (used as with other group tags described
-above) are used to escape regular sisu markup, and have been used extensively
-within this document to provide examples of <b>SiSU</b> markup. You cannot however
-use code tags to escape code tags. They are however used in the same way
-as group or poem tags.
-<p> 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]
-<p> <b>use of code tags instead of poem compared, resulting
-output:</b>
-<p> <br>
-<pre> &lsquo;Fury said to a
- mouse, That he
- met in the
- house,
- "Let us
- both go to
- law: I will
- prosecute
- YOU. --Come,
- I&rsquo;ll take no
- denial; We
- must have a
- trial: For
- really this
- morning I&rsquo;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&rsquo;ll be
- judge, I&rsquo;ll
- be jury,"
- Said
- cunning
- old Fury:
- "I&rsquo;ll
- try the
- whole
- cause,
- and
- condemn
- you
- to
- death."&rsquo;
-</pre>
-<p> From <b>SiSU</b> 2.7.7 on you can number codeblocks by placing a hash after the
-opening code tag code{# as demonstrated here:
-<p> <br>
-<pre>1 | &lsquo;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&rsquo;ll take no
-11 | denial; We
-12 | must have a
-13 | trial: For
-14 | really this
-15 | morning I&rsquo;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&rsquo;ll be
-31 | judge, I&rsquo;ll
-32 | be jury,"
-33 | Said
-34 | cunning
-35 | old Fury:
-36 | "I&rsquo;ll
-37 | try the
-38 | whole
-39 | cause,
-40 | and
-41 | condemn
-42 | you
-43 | to
-44 | death."&rsquo;
-</pre>
-<p>
-<h2><a name='sect40' href='#toc40'>Additional Breaks - Linebreaks Within Objects, Column and Page-breaks</a></h2>
-
-<p>
-<h2><a name='sect41' href='#toc41'>Line-breaks</a></h2>
-
-<p>
- To break a line within a "paragraph object", two backslashes \\ with a space
-before and a space or newline after them may be used.
-<p> <br>
-<pre>To break a line within a "paragraph object",
-two backslashes \\ with a space before
-and a space or newline after them \\
-may be used.
-</pre>
-<p> 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).
-<p>
-<h2><a name='sect42' href='#toc42'>Page Breaks</a></h2>
-
-<p> 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:
-<p> page new =\=
-or breaks the page, starts a new page.
-<p> page break -\- or breaks a column,
-starts a new column, if using columns, else breaks the page, starts a new
-page.
-<p> page break line across page -..- draws a dividing line, dividing paragraphs
-
-<p> page break: <br>
-<pre>-\\-
-or
-&lt;:pb&gt;
-</pre>
-<p>
-<p> page (break) new: <br>
-<pre>=\\=
-or
-&lt;:pn&gt;
-</pre>
-<p>
-<p> page (break) line across page (dividing paragraphs): <br>
-<pre>-..-
-</pre>
-<p>
-<h2><a name='sect43' href='#toc43'>Book Index</a></h2>
-
-<p> To make an index append to paragraph the book index term relates
-to it, using an equal sign and curly braces.
-<p> Currently two levels are
-provided, a main term and if needed a sub-term. Sub-terms are separated from
-the main term by a colon. <br>
-<pre> Paragraph containing main term and sub-term.
- ={Main term:sub-term}
-</pre>
-<p> The index syntax starts on a new line, but there should not be an empty
-line between paragraph and index markup.
-<p> The structure of the resulting
-index would be:
-<p> <br>
-<pre> Main term, 1
- sub-term, 1
-</pre>
-<p> 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.
-
-<p> <br>
-<pre> Paragraph containing main term, second term and sub-term.
- ={first term; second term: sub-term}
-</pre>
-<p> The structure of the resulting index would be:
-<p> <br>
-<pre> First term, 1,
- Second term, 1,
- sub-term, 1
-</pre>
-<p> If multiple sub-terms appear under one paragraph, they are separated under
-the main term heading from each other by a pipe symbol.
-<p> <br>
-<pre> 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
-</pre>
-<p> 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:
-<p> <br>
-<pre> Main term, 1,
- sub-term, 1-3,
- second sub-term, 1,
-</pre>
-<p>
-<h2><a name='sect44' href='#toc44'>Composite Documents Markup</a></h2>
-
-<p> It is possible to build a document by creating
-a master document that requires other documents. The documents required
-may be complete documents that could be generated independently, or they
-could be markup snippets, prepared so as to be easily available to be placed
-within another text. If the calling document is a master document (built
-from other documents), it should be named with the suffix <b>.ssm</b> Within this
-document you would provide information on the other documents that should
-be included within the text. These may be other documents that would be
-processed in a regular way, or markup bits prepared only for inclusion
-within a master document <b>.sst</b> regular markup file, or <b>.ssi</b> (insert/information)
-
-<p>A secondary file of the composite document is built prior to processing
-
-<p>with the same prefix and the suffix <b>._sst</b>
-<p> basic markup for importing a
-
-<p>document into a master document
-<p> <br>
-<pre>&lt;&lt; filename1.sst
-&lt;&lt; filename2.ssi
-</pre>
-<p> The form described above should be relied on. Within the <i>Vim</i> editor it
-results in the text thus linked becoming hyperlinked to the document it
-is calling in which is convenient for editing.
-<p>
-<h2><a name='sect45' href='#toc45'>Sisu Filetypes</a></h2>
-
-<p> <b>SiSU</b> has
-<i>plaintext</i> and binary filetypes, and can process either type of document.
-
-<p>
-<h2><a name='sect46' href='#toc46'>.sst .ssm .ssi Marked Up Plain Text</a></h2>
-
-<p>
-<dl>
-
-<dt><b>SiSU</b> </dt>
-<dd>documents are prepared as plain-text
-(utf-8) files with <b>SiSU</b> 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</i> 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.
-<p> <b>SiSU</b> 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.
-<p> <b>SiSU</b> source markup can be shared
-with the command:
-<p> sisu -s [filename]
-<p> </dd>
-</dl>
-
-<h2><a name='sect47' href='#toc47'>Sisu Text - Regular Files (.sst)</a></h2>
-
-<p>
-The most common form of document in <b>SiSU,</b> see the section on <b>SiSU</b> markup.
-
-<p>
-<h2><a name='sect48' href='#toc48'>Sisu Master Files (.ssm)</a></h2>
-
-<p> Composite documents which incorporate other <b>SiSU</b>
-documents which may be either regular <b>SiSU</b> text .sst which may be generated
-independently, or inserts prepared solely for the purpose of being incorporated
-into one or more master documents.
-<p> The mechanism by which master files
-incorporate other documents is described as one of the headings under under
-<b>SiSU</b> markup in the <b>SiSU</b> manual.
-<p> 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.
-<p> Note:
-a secondary file of the composite document is built prior to processing
-with the same prefix and the suffix ._sst [^19]
-<h2><a name='sect49' href='#toc49'>Sisu Insert Files (.ssi)</a></h2>
-
-<p>
-Inserts are documents prepared solely for the purpose of being incorporated
-into one or more master documents. They resemble regular <b>SiSU</b> text files
-except they are ignored by the <b>SiSU</b> 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.
-<p>
-<h2><a name='sect50' href='#toc50'>Sisupod, Zipped Binary Container
-(sisupod.zip, .ssp)</a></h2>
-
-<p> A sisupod is a zipped <b>SiSU</b> text file or set of <b>SiSU</b>
-text files and any associated images that they contain (this will be extended
-to include sound and multimedia-files)
-<p>
-<dl>
-
-<dt><b>SiSU</b> </dt>
-<dd><i>plaintext</i> 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.
-<p> 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</b> documents.
-
-<p> The command to create a sisupod is:
-<p> sisu -S [filename]
-<p> Alternatively,
-make a pod of the contents of a whole directory:
-<p> sisu -S
-<p> <b>SiSU</b> processing
-can be done directly against a sisupod; which may be located locally or
-on a remote server for which a url is provided.
-<p> &lt;<a href='http://www.sisudoc.org/sisu/sisu_commands'>http://www.sisudoc.org/sisu/sisu_commands</a>
-&gt;
-
-<p> &lt;<a href='http://www.sisudoc.org/sisu/sisu_manual'>http://www.sisudoc.org/sisu/sisu_manual</a>
-&gt;
-<p> </dd>
-</dl>
-
-<h2><a name='sect51' href='#toc51'>Configuration</a></h2>
-
-<p>
-<h2><a name='sect52' href='#toc52'>Configuration Files</a></h2>
-
-<p>
-
-<h2><a name='sect53' href='#toc53'>Config.yml</a></h2>
-
-<p> <b>SiSU</b> 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.
-<p> The <b>SiSU</b> configuration file is
-a yaml file, which means indentation is significant.
-<p> <b>SiSU</b> resource configuration
-is determined by looking at the following files if they exist:
-<p> ./_sisu/v4/sisurc.yml<br>
-
-<p> ./_sisu/sisurc.yml<br>
-
-<p> ~/.sisu/v4/sisurc.yml<br>
-
-<p> ~/.sisu/sisurc.yml<br>
-
-<p> /etc/sisu/v4/sisurc.yml<br>
-
-<p> /etc/sisu/sisurc.yml<br>
-
-<p> The search is in the order listed, and the first one found is used.
-<p>
- In the absence of instructions in any of these it falls back to the internal
-program defaults.
-<p> Configuration determines the output and processing directories
-and the database access details.
-<p> If <b>SiSU</b> is installed a sample sisurc.yml
-
-<p>may be found in /etc/sisu/sisurc.yml
-<p>
-<h2><a name='sect54' href='#toc54'>Sisu_document_make</a></h2>
-
-<p> 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.
-<p> The search order
-is as for resource configuration:
-<p> ./_sisu/v4/sisu_document_make<br>
-
-<p> ./_sisu/sisu_document_make<br>
-
-<p> ~/.sisu/v4/sisu_document_make<br>
-
-<p> ~/.sisu/sisu_document_make<br>
-
-<p> /etc/sisu/v4/sisu_document_make<br>
-
-<p> /etc/sisu/sisu_document_make<br>
-
-<p> A sample sisu_document_make can be found in the _sisu/ directory under
-along with the provided sisu markup samples.
-<p>
-<h2><a name='sect55' href='#toc55'>Css - Cascading Style Sheets
-(for Html, Xhtml and Xml)</a></h2>
-
-<p> CSS files to modify the appearance of <b>SiSU</b> html,
-<i>XHTML</i> or <i>XML</i> 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.
-<p> 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.
-<p> <i>HTML:</i> html. css
-<p> <i>XML</i>
-DOM: dom.css
-<p> <i>XML</i> SAX: sax.css
-<p> <i>XHTML:</i> xhtml. css
-<p> The default homepage
-may use homepage.css or html. css
-<p> Under consideration is to permit the
-placement of a CSS file with a different name in directory _sisu/css directory
-or equivalent.[^20]
-<p>
-<h2><a name='sect56' href='#toc56'>Organising Content - Directory Structure and Mapping</a></h2>
-
-<p>
- <b>SiSU</b> v3 has new options for the source directory tree, and output directory
-structures of which there are 3 alternatives.
-<p>
-<h2><a name='sect57' href='#toc57'>Document Source Directory</a></h2>
-
-<p>
- 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.
-<p>
-<h2><a name='sect58' href='#toc58'>General Directories</a></h2>
-
-<p>
-<br>
-<pre>% 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
-</pre>
-<p>
-<h2><a name='sect59' href='#toc59'>Document Output Directory Structures</a></h2>
-
-<p>
-<h2><a name='sect60' href='#toc60'>Output Directory Root</a></h2>
-
-<p> 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)
-<p> 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.
-<p>
-<h2><a name='sect61' href='#toc61'>Alternative Output Structures</a></h2>
-
-<p>
- There are 3 possibile output structures described as being, by language,
-by filetype or by filename, the selection is made in sisurc.yml
-<p> <br>
-<pre>#% output_dir_structure_by: language; filetype; or filename
-output_dir_structure_by: language #(language &amp; filetype, preferred?)
-#output_dir_structure_by: filetype
-#output_dir_structure_by: filename #(default, closest to original v1 &amp;
-v2)
-</pre>
-<p>
-<h2><a name='sect62' href='#toc62'>by Language</a></h2>
-
-<p> The by language directory structure places output files
-<p>
- The by language directory structure separates output files by language
-code (all files of a given language), and within the language directory
-by filetype.
-<p> Its selection is configured in sisurc.yml
-<p> output_dir_structure_by:
-
-<p>language
-<p> <br>
-<pre> |-- en
- |-- epub
- |-- hashes
- |-- html
- | |-- viral_spiral.david_bollier
- | |-- manifest
- | |-- qrcode
- | |-- odt
- | |-- pdf
- | |-- sitemaps
- | |-- txt
- | |-- xhtml
- | &lsquo;-- xml
- |-- po4a
- | &lsquo;-- live-manual
- | |-- po
- | |-- fr
- | &lsquo;-- pot
- &lsquo;-- _sisu
- |-- css
- |-- image
- |-- image_sys -&gt; ../../_sisu/image_sys
- &lsquo;-- xml
- |-- rnc
- |-- rng
- &lsquo;-- xsd
-</pre>
-<p> #by: language subject_dir/en/manifest/filename.html
-<p>
-<h2><a name='sect63' href='#toc63'>by Filetype</a></h2>
-
-<p> 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.
-<p> Its selection is configured in sisurc.yml
-<p> output_dir_structure_by:
-
-<p>filetype
-<p> <br>
-<pre> |-- epub
- |-- hashes
- |-- html
- |-- viral_spiral.david_bollier
- |-- manifest
- |-- qrcode
- |-- odt
- |-- pdf
- |-- po4a
- |-- live-manual
- | |-- po
- | |-- fr
- | &lsquo;-- pot
- |-- _sisu
- | |-- css
- | |-- image
- | |-- image_sys -&gt; ../../_sisu/image_sys
- | &lsquo;-- xml
- | |-- rnc
- | |-- rng
- | &lsquo;-- xsd
- |-- sitemaps
- |-- txt
- |-- xhtml
- &lsquo;-- xml
-</pre>
-<p> #by: filetype subject_dir/html/filename/manifest.en.html
-<p>
-<h2><a name='sect64' href='#toc64'>by Filename</a></h2>
-
-<p>
-The by filename directory structure places most output of a particular
-file (the different filetypes) in a common directory.
-<p> Its selection is
-
-<p>configured in sisurc.yml
-<p> output_dir_structure_by: filename
-<p> <br>
-<pre> |-- epub
- |-- po4a
- |-- live-manual
- | |-- po
- | |-- fr
- | &lsquo;-- pot
- |-- _sisu
- | |-- css
- | |-- image
- | |-- image_sys -&gt; ../../_sisu/image_sys
- | &lsquo;-- xml
- | |-- rnc
- | |-- rng
- | &lsquo;-- xsd
- |-- sitemaps
- |-- src
- |-- pod
- &lsquo;-- viral_spiral.david_bollier
-</pre>
-<p> #by: filename subject_dir/filename/manifest.en.html
-<p>
-<h2><a name='sect65' href='#toc65'>Remote Directories</a></h2>
-
-<p>
-<br>
-<pre> ./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
-</pre>
-<p>
-<h2><a name='sect66' href='#toc66'>Sisupod</a></h2>
-
-<p> <br>
-<pre> ./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
-</pre>
-<p>
-<h2><a name='sect67' href='#toc67'>Organising Content</a></h2>
-
-<p>
-<h2><a name='sect68' href='#toc68'>Homepages</a></h2>
-
-<p> <b>SiSU</b> is about the ability to auto-generate
-documents. Home pages are regarded as custom built items, and are not created
-by <b>SiSU.</b> More accurately, <b>SiSU</b> 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&rsquo;s configuration,
-these being:
-<p> 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)
-<p> 2. through providing what you want as the
-home page in a skin,
-<p> 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.
-<p>
-<h2><a name='sect69' href='#toc69'>Home
-Page and Other Custom Built Pages in a Sub-directory</a></h2>
-
-<p> 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:
-<p>
- sisu -CC
-<h2><a name='sect70' href='#toc70'>Markup and Output Examples</a></h2>
-
-<p>
-<h2><a name='sect71' href='#toc71'>Markup Examples</a></h2>
-
-<p> Current markup examples
-and document output samples are provided off &lt;<a href='http://sisudoc.org'>http://sisudoc.org</a>
-&gt; or &lt;<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a>
-&gt;
-and in the sisu -markup-sample package available off &lt;<a href='http://sources.sisudoc.org'>http://sources.sisudoc.org</a>
-&gt;
-
-<p> 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.
-<p>
-<h2><a name='sect72' href='#toc72'>Sisu Markup Samples</a></h2>
-
-<p> A few
-additional sample books prepared as sisu markup samples, output formats
-to be generated using <b>SiSU</b> 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</b> Project as they have
-requirements that do not meet the <b>Debian</b> 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.
-
-<p> <i>Accelerando,</i> Charles Stross (2005) accelerando.charles_stross.sst
-<p> <i>Alice&rsquo;s</i>
-Adventures in Wonderland, Lewis Carroll (1865) alices_adventures_in_wonderland.lewis_carroll.sst
-
-<p> <i>CONTENT,</i> Cory Doctorow (2008) content.cory_doctorow.sst
-<p> <i>Democratizing</i>
-Innovation, Eric von Hippel (2005) democratizing_innovation.eric_von_hippel.sst
-
-<p> <i>Down</i> and Out in the Magic Kingdom, Cory Doctorow (2003) down_and_out_in_the_magic_kingdom.cory_doctorow.sst
-
-<p> <i>For</i> the Win, Cory Doctorow (2010) for_the_win.cory_doctorow.sst
-<p> <i>Free</i>
-as in Freedom - Richard Stallman&rsquo;s Crusade for Free Software, Sam Williams
-(2002) free_as_in_freedom.richard_stallman_crusade_for_free_software.sam_williams.sst
-
-<p> <i>Free</i> 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
-
-<p> <i>Free</i> Culture - How Big Media Uses Technology and the Law to Lock Down
-Culture and Control Creativity, Lawrence Lessig (2004) free_culture.lawrence_lessig.sst
-
-<p> <i>Free</i> For All - How Linux and the Free Software Movement Undercut the High
-Tech Titans, Peter Wayner (2002) free_for_all.peter_wayner.sst
-<p> <i>GNU</i> GENERAL
-PUBLIC LICENSE v2, Free Software Foundation (1991) gpl2.fsf.sst
-<p> <i>GNU</i> GENERAL
-PUBLIC LICENSE v3, Free Software Foundation (2007) gpl3.fsf.sst
-<p> <i>Gulliver&rsquo;s</i>
-Travels, Jonathan Swift (1726 / 1735) gullivers_travels.jonathan_swift.sst
-
-<p> <i>Little</i> Brother, Cory Doctorow (2008) little_brother.cory_doctorow.sst
-<p>
- <i>The</i> Cathederal and the Bazaar, Eric Raymond (2000) the_cathedral_and_the_bazaar.eric_s_raymond.sst
-
-<p> <i>The</i> Public Domain - Enclosing the Commons of the Mind, James Boyle (2008)
-
-<p>the_public_domain.james_boyle.sst
-<p> <i>The</i> Wealth of Networks - How Social Production
-Transforms Markets and Freedom, Yochai Benkler (2006) the_wealth_of_networks.yochai_benkler.sst
-
-<p> <i>Through</i> the Looking Glass, Lewis Carroll (1871) through_the_looking_glass.lewis_carroll.sst
-
-<p> <i>Two</i> Bits - The Cultural Significance of Free Software, Christopher Kelty
-(2008) two_bits.christopher_kelty.sst
-<p> <i>UN</i> Contracts for International Sale
-of Goods, UN (1980) un_contracts_international_sale_of_goods_convention_1980.sst
-
-<p> <i>Viral</i> Spiral, David Bollier (2008) viral_spiral.david_bollier.sst
-<p>
-<h2><a name='sect73' href='#toc73'>Sisu
-Search - Introduction</a></h2>
-
-<p> <b>SiSU</b> output can easily and conveniently be indexed
-by a number of standalone indexing tools, such as Lucene, Hyperestraier.
-
-<p> Because the document structure of sites created is clearly defined, and
-the text <i>object</i> 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.
-<p> In addition to this <b>SiSU</b> 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.
-<p>
-<h2><a name='sect74' href='#toc74'>Sql</a></h2>
-
-<p>
-<h2><a name='sect75' href='#toc75'>Populating Sql Type Databases</a></h2>
-
-<p> <b>SiSU</b> feeds
-sisu markupd documents into sql type databases <i>PostgreSQL</i> [^21] and/or <i>SQLite</i>
-[^22] database together with information related to document structure.
-<p>
- 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:
-<p> * one containing semantic (and other) headers,
-including, title, author, subject, (the<br>
- .I Dublin Core.<br>
- ..);<br>
-
-<p> * another the substantive texts by individual "paragraph" (or object)
-- along with structural information, each paragraph being identifiable
-by its<br>
- paragraph number (if it has one which almost all of them do), and the<br>
- substantive text of each paragraph quite naturally being searchable
-(both in<br>
- formatted and clean text versions for searching); and<br>
-
-<p> * a third containing endnotes cross-referenced back to the paragraph
-from which they are referenced (both in formatted and clean text versions
-for<br>
- searching).<br>
-
-<p> * a fourth table with a one to one relation with the headers table contains
- full text versions of output, eg. pdf, html, xml, and<br>
- .I ascii.<br>
-
-<p> There is of course the possibility to add further structures.
-<p> At this
-level <b>SiSU</b> 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.
-<p> Being able to search a relational
-database at an object level with the <b>SiSU</b> citation system is an effective
-way of locating content generated by <b>SiSU.</b> 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</i> Core is incorporated it is easy to make use of that as well).
-<p>
-<h2><a name='sect76' href='#toc76'>Postgresql</a></h2>
-
-<p>
-
-<h2><a name='sect77' href='#toc77'>Name</a></h2>
-
-<p> <b>SiSU</b> - Structured information, Serialized Units - a document publishing
-system, postgresql dependency package
-<p>
-<h2><a name='sect78' href='#toc78'>Description</a></h2>
-
-<p> 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</b>
-to populate a postgresql database, this being part of <b>SiSU</b> - man sisu) .
-
-<p>
-<h2><a name='sect79' href='#toc79'>Synopsis</a></h2>
-
-<p> sisu -D [instruction] [filename/wildcard if required]
-<p> sisu
--D --pg --[instruction] [filename/wildcard if required]
-<p>
-<h2><a name='sect80' href='#toc80'>Commands</a></h2>
-
-<p> 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
-
-<p>-
-<p>-
-<p>sqlite or --pgsql may be used
-<p> <b>-D or --pgsql</b> may be used interchangeably.
-<p>
-<h2><a name='sect81' href='#toc81'>Create
-and Destroy Database</a></h2>
-
-<p>
-<dl>
-
-<dt><b>--pgsql --createall</b> </dt>
-<dd>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)
-<p> </dd>
-
-<dt><b>sisu -D --createdb</b> </dt>
-<dd>creates database where no database existed before
-
-<p> </dd>
-
-<dt><b>sisu -D --create</b> </dt>
-<dd>creates database tables where no database tables existed
-before
-<p> </dd>
-
-<dt><b>sisu -D --Dropall</b> </dt>
-<dd>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).
-<p> </dd>
-
-<dt><b>sisu -D --recreate</b> </dt>
-<dd>destroys existing database
-
-<p>and builds a new empty database structure
-<p> </dd>
-</dl>
-
-<h2><a name='sect82' href='#toc82'>Import and Remove Documents</a></h2>
-
-<p>
-
-<dl>
-
-<dt><b>sisu -D --import -v [filename/wildcard]</b> </dt>
-<dd>populates database with the contents
-of the file. Imports documents(s) specified to a postgresql database (at
-an object level).
-<p> </dd>
-
-<dt><b>sisu -D --update -v [filename/wildcard]</b> </dt>
-<dd>updates file contents
-
-<p>in database
-<p> </dd>
-
-<dt><b>sisu -D --remove -v [filename/wildcard]</b> </dt>
-<dd>removes specified document
-from postgresql database.
-<p> </dd>
-</dl>
-
-<h2><a name='sect83' href='#toc83'>Sqlite</a></h2>
-
-<p>
-<h2><a name='sect84' href='#toc84'>Name</a></h2>
-
-<p> <b>SiSU</b> - Structured information, Serialized
-Units - a document publishing system.
-<p>
-<h2><a name='sect85' href='#toc85'>Description</a></h2>
-
-<p> 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</b> to populate
-an sqlite database, this being part of <b>SiSU</b> - man sisu) .
-<p>
-<h2><a name='sect86' href='#toc86'>Synopsis</a></h2>
-
-<p> sisu
--d [instruction] [filename/wildcard if required]
-<p> sisu -d --(sqlite|pg) --[instruction]
-[filename/wildcard if required]
-<p>
-<h2><a name='sect87' href='#toc87'>Commands</a></h2>
-
-<p> 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
-
-<p>may be used
-<p> <b>-d or --sqlite</b> may be used interchangeably.
-<p>
-<h2><a name='sect88' href='#toc88'>Create and Destroy
-Database</a></h2>
-
-<p>
-<dl>
-
-<dt><b>--sqlite --createall</b> </dt>
-<dd>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)
-<p> </dd>
-
-<dt><b>sisu
--d --createdb</b> </dt>
-<dd>creates database where no database existed before
-<p> </dd>
-
-<dt><b>sisu -d --create</b>
-</dt>
-<dd>
-<p>creates database tables where no database tables existed before
-<p> </dd>
-
-<dt><b>sisu -d
---dropall</b> </dt>
-<dd>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).
-<p> </dd>
-
-<dt><b>sisu -d --recreate</b> </dt>
-<dd>destroys existing database and builds
-a new empty database structure
-<p> </dd>
-</dl>
-
-<h2><a name='sect89' href='#toc89'>Import and Remove Documents</a></h2>
-
-<p>
-<dl>
-
-<dt><b>sisu -d --import
--v [filename/wildcard]</b> </dt>
-<dd>populates database with the contents of the file.
-Imports documents(s) specified to an sqlite database (at an object level).
-
-<p> </dd>
-
-<dt><b>sisu -d --update -v [filename/wildcard]</b> </dt>
-<dd>updates file contents in database
-
-<p> </dd>
-
-<dt><b>sisu -d --remove -v [filename/wildcard]</b> </dt>
-<dd>removes specified document from sqlite
-database.
-<p> </dd>
-</dl>
-
-<h2><a name='sect90' href='#toc90'>Introduction</a></h2>
-
-<p>
-<h2><a name='sect91' href='#toc91'>Search - Database Frontend Sample, Utilising Database
-and Sisu Features,</a></h2>
-INCLUDING OBJECT CITATION NUMBERING (BACKEND CURRENTLY
-POSTGRESQL)
-<p> Sample search frontend &lt;<a href='http://search.sisudoc.org'>http://search.sisudoc.org</a>
-&gt; [^23] A small
-database and sample query front-end (search from) that makes use of the
-citation system, <i>object</i> citation numbering to demonstrates functionality.[^24]
-
-<p> <b>SiSU</b> 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</i> citation numbering, which includes
-html, <i>XML,</i> <i>EPUB,</i> <i>LaTeX,</i> <i>PDF</i> and indeed the <i>SQL</i> database. You can then refer
-to one of the other outputs or in the <i>SQL</i> database expand the text within
-the matched objects (paragraphs) in the documents matched.
-<p> 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]
-<p>
-<dl>
-
-<dt><b>sisu -F --webserv-webrick</b> </dt>
-<dd>builds a cgi web search
-
-<p>frontend for the database created
-<p> The following is feedback on the setup
-on a machine provided by the help command:
-<p> sisu --help sql <br>
-<pre>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
-</pre>
-<p> Note on databases built
-<p> 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] </dd>
-</dl>
-
-<h2><a name='sect92' href='#toc92'>Search Form</a></h2>
-
-<p>
-<dl>
-
-<dt><b>sisu -F</b> </dt>
-<dd>generates a sample search form, which
-
-<p>must be copied to the web-server cgi directory
-<p> </dd>
-
-<dt><b>sisu -F --webserv-webrick</b> </dt>
-<dd>generates
-a sample search form for use with the webrick server, which must be copied
-
-<p>to the web-server cgi directory
-<p> </dd>
-
-<dt><b>sisu -W</b> </dt>
-<dd>starts the webrick server which
-
-<p>should be available wherever sisu is properly installed
-<p> The generated
-
-<p>search form must be copied manually to the webserver directory as instructed
-
-<p> </dd>
-</dl>
-
-<h2><a name='sect93' href='#toc93'>Sisu_webrick</a></h2>
-
-<p>
-<h2><a name='sect94' href='#toc94'>Name</a></h2>
-
-<p> <b>SiSU</b> - Structured information, Serialized Units - a document
-
-<p>publishing system
-<p>
-<h2><a name='sect95' href='#toc95'>Synopsis</a></h2>
-
-<p> sisu_webrick [port]
-<p> or
-<p> sisu -W [port]
-<p>
-
-<h2><a name='sect96' href='#toc96'>Description</a></h2>
-
-<p> sisu_webrick is part of <b>SiSU</b> (man sisu) sisu_webrick starts
-<b>Ruby</b> <b>SiSU</b> output is written, providing a list of these directories (assuming
-<b>SiSU</b> is in use and they exist).
-<p> 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).
-<p>
-<h2><a name='sect97' href='#toc97'>Summary of Man Page</a></h2>
-
-<p> sisu_webrick, may be started on it&rsquo;s
-own with the command: sisu_webrick [port] or using the sisu command with
-the -W flag: sisu -W [port]
-<p> where no port is given and settings are unchanged
-
-<p>the default port is 8081
-<p>
-<h2><a name='sect98' href='#toc98'>Document Processing Command Flags</a></h2>
-
-<p> sisu -W [port]
-starts <b>Ruby</b> Webrick web-server, serving <b>SiSU</b> output directories, on the
-port provided, or if no port is provided and the defaults have not been
-
-<p>changed in ~/.sisu/sisurc.yaml then on port 8081
-<p>
-<h2><a name='sect99' href='#toc99'>Summary of Features</a></h2>
-
-<p> *
-sparse/minimal markup (clean utf-8 source texts). Documents are prepared
-in a single <i>UTF-8</i> file using a minimalistic mnemonic syntax. Typical literature,
-documents like "War and Peace" require almost no markup, and most of the
-headers are optional.
-<p> * markup is easily readable/parsable by the human
-eye, (basic markup is simpler and more sparse than the most basic <i>HTML</i>
-) , [this may also be converted to <i>XML</i> representations of the same input/source
-document].
-<p> * 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. <b>SiSU</b> 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)
-<p> * 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:
-<p> * <i>HTML</i> - both as a single scrollable
-
-<p>text and a segmented document
-<p> * <i>XHTML</i>
-<p> * <i>EPUB</i>
-<p> * <i>XML</i> - both in sax and
-
-<p>dom style xml structures for further development as required
-<p> * <i>ODT</i> - Open
-Document Format text, the iso standard for document storage
-<p> * <i>LaTeX</i> -
-
-<p>used to generate pdf
-<p> * <i>PDF</i> (via <i>LaTeX</i> )
-<p> * <i>SQL</i> - population of an sql
-database ( <i>PostgreSQL</i> or <i>SQLite</i> ) , (at the same object level that is used
-to cite text within a document)
-<p> 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 <i>LaTeX,</i> databases populated with documents at an individual
-object/paragraph level, making possible <i>granular</i> search (and related possibilities))
-
-<p> * 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, <i>HTML,</i> <i>EPUB,</i> xml, sqlite, postgresql) , this
-numbering system can be used to reference content.
-<p> * Granular search within
-documents. <i>SQL</i> 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].
-<p> * 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,
-
-<p>without modification of existing prepared texts
-<p> * <i>SQL</i> search aside, documents
-are generated as required and static once generated.
-<p> * 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)
-
-<p> * document source ( <i>plaintext</i> utf-8) if shared on the net may be used
-
-<p>as input and processed locally to produce the different document outputs
-
-<p> * 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
-
-<p>these too may be processed locally to produce the desired document outputs
-
-<p> * generated document outputs may automatically be posted to remote sites.
-
-<p> * for basic document generation, the only software dependency is <b>Ruby,</b>
-and a few standard Unix tools (this covers <i>plaintext,</i> <i>HTML,</i> <i>EPUB,</i> <i>XML,</i>
-<i>ODF,</i> <i>LaTeX</i> ) . To use a database you of course need that, and to convert
-the <i>LaTeX</i> generated to pdf, a latex processor like tetex or texlive.
-<p> *
-
-<p>as a developers tool it is flexible and extensible
-<p> Syntax highlighting
-for <b>SiSU</b> markup is available for a number of text editors.
-<p> <b>SiSU</b> 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
-<p> 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) ...
-<p> 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.
-<p>
-<ol>
-<b>.</b><li>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.
-<p> </li><b>.</b><li>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.
-<p> </li><b>.</b><li>the different
-
-<p>heading levels
-<p> </li><b>.</b><li>units of text, primarily paragraphs and headings, also
-any tables, poems, code-blocks
-<p> </li><b>.</b><li>An open standard format for e-books
-<p> </li><b>.</b><li>Open
-Document Format ( ODF ) text
-<p> </li><b>.</b><li>Specification submitted by Adobe to ISO
-to become a full open ISO specification &lt;<a href='http://www.linux-watch.com/news/NS7542722606.html'>http://www.linux-watch.com/news/NS7542722606.html</a>
-&gt;
-
-<p> </li><b>.</b><li>ISO standard ISO/IEC 26300:2006
-<p> </dd>
-
-<dt><b>*1.</b> </dt>
-<dd>square brackets
-<p> </dd>
-
-<dt><b>*2.</b> </dt>
-<dd>square brackets
-
-<p> </dd>
-
-<dt><b>+1.</b> </dt>
-<dd>square brackets
-<p> </li><b>.</b><li>&lt;<a href='http://www.jus.uio.no/sisu/man/'>http://www.jus.uio.no/sisu/man/</a>
-&gt;
-<p> </li><b>.</b><li>&lt;<a href='http://www.jus.uio.no/sisu/man/sisu.1.html'>http://www.jus.uio.no/sisu/man/sisu.1.html</a>
-&gt;
-
-<p> </li><b>.</b><li>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.
-<p> </li><b>.</b><li>files
-
-<p>should be prepared using UTF-8 character encoding
-<p> </li><b>.</b><li>a footnote or endnote
-
-<p> </li><b>.</b><li>self contained endnote marker &amp; endnote in one
-<p> </dd>
-
-<dt><b>*.</b> </dt>
-<dd>unnumbered asterisk
-footnote/endnote, insert multiple asterisks if required
-<p> </dd>
-
-<dt><b>**.</b> </dt>
-<dd>another unnumbered
-
-<p>asterisk footnote/endnote
-<p> </dd>
-
-<dt><b>*3.</b> </dt>
-<dd>editors notes, numbered asterisk footnote/endnote
-
-<p>series
-<p> </dd>
-
-<dt><b>+2.</b> </dt>
-<dd>editors notes, numbered asterisk footnote/endnote series
-<p>
-</li><b>.</b><li>&lt;<a href='http://www.sisudoc.org/'>http://www.sisudoc.org/</a>
-&gt;
-<p> </li><b>.</b><li>&lt;<a href='http://www.ruby-lang.org/en/'>http://www.ruby-lang.org/en/</a>
-&gt;
-<p> </li><b>.</b><li>Table from the Wealth
-of Networks by Yochai Benkler &lt;<a href='http://www.jus.uio.no/sisu/the_wealth_of_networks.yochai_benkler'>http://www.jus.uio.no/sisu/the_wealth_of_networks.yochai_benkler</a>
-&gt;
-
-<p> </li><b>.</b><li>.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.
-<p> </li><b>.</b><li>SiSU has worked this way in the past,
-though this was dropped as it was thought the complexity outweighed the
-flexibility, however, the balance was rather fine and this behaviour could
-be reinstated.
-<p> </li><b>.</b><li>&lt;<a href='http://www.postgresql.org/'>http://www.postgresql.org/</a>
-&gt; &lt;<a href='http://advocacy.postgresql.org/'>http://advocacy.postgresql.org/</a>
-&gt;
-&lt;<a href='http://en.wikipedia.org/wiki/Postgresql'>http://en.wikipedia.org/wiki/Postgresql</a>
-&gt;
-<p> </li><b>.</b><li>&lt;<a href='http://www.hwaci.com/sw/sqlite/'>http://www.hwaci.com/sw/sqlite/</a>
-&gt; &lt;<a href='http://en.wikipedia.org/wiki/Sqlite'>http://en.wikipedia.org/wiki/Sqlite</a>
-&gt;
-
-<p> </li><b>.</b><li>&lt;<a href='http://search.sisudoc.org'>http://search.sisudoc.org</a>
-&gt;
-<p> </li><b>.</b><li>(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.
-<p> </li><b>.</b><li>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.
-
-<p>
-<p> </li>
-</ol>
-
-<h2><a name='sect100' href='#toc100'>See Also</a></h2>
- <a href='http:~/bin/man2html?sisu:1'>sisu(1)</a>
-,<br>
- <a href='http:~/bin/man2html?sisu-epub:1'>sisu-epub(1)</a>
-,<br>
- <a href='http:~/bin/man2html?sisu-harvest:1'>sisu-harvest(1)</a>
-,<br>
- <a href='http:~/bin/man2html?sisu-html:1'>sisu-html(1)</a>
-,<br>
- <a href='http:~/bin/man2html?sisu-odf:1'>sisu-odf(1)</a>
-,<br>
- <a href='http:~/bin/man2html?sisu-pdf:1'>sisu-pdf(1)</a>
-,<br>
- <a href='http:~/bin/man2html?sisu-pg:1'>sisu-pg(1)</a>
-,<br>
- <a href='http:~/bin/man2html?sisu-sqlite:1'>sisu-sqlite(1)</a>
-,<br>
- <a href='http:~/bin/man2html?sisu-txt:1'>sisu-txt(1)</a>
-.<br>
- <a href='http:~/bin/man2html?sisu_vim:7'>sisu_vim(7)</a>
-<br>
-
-<h2><a name='sect101' href='#toc101'>Homepage</a></h2>
- More information about SiSU can be found at &lt;<a href='http://www.sisudoc.org/'>http://www.sisudoc.org/</a>
-&gt;
-or &lt;<a href='http://www.jus.uio.no/sisu/'>http://www.jus.uio.no/sisu/</a>
-&gt;<br>
-
-<h2><a name='sect102' href='#toc102'>Source</a></h2>
- &lt;<a href='http://sources.sisudoc.org/'>http://sources.sisudoc.org/</a>
-&gt;<br>
-
-<h2><a name='sect103' href='#toc103'>Author</a></h2>
- SiSU is written by Ralph Amissah &lt;ralph@amissah.com&gt;<br>
- <p>
-
-<hr><p>
-<a name='toc'><b>Table of Contents</b></a><p>
-<ul>
-<li><a name='toc0' href='#sect0'>Name</a></li>
-<li><a name='toc1' href='#sect1'>Synopsis</a></li>
-<li><a name='toc2' href='#sect2'>Sisu - Manual,</a></li>
-<li><a name='toc3' href='#sect3'>What is Sisu?</a></li>
-<li><a name='toc4' href='#sect4'>Introduction - What is Sisu?</a></li>
-<li><a name='toc5' href='#sect5'>Commands Summary</a></li>
-<li><a name='toc6' href='#sect6'>Description</a></li>
-<li><a name='toc7' href='#sect7'>Document Processing Command Flags</a></li>
-<li><a name='toc8' href='#sect8'>Command Line Modifiers</a></li>
-<li><a name='toc9' href='#sect9'>Database Commands</a></li>
-<li><a name='toc10' href='#sect10'>Shortcuts, Shorthand for Multiple Flags</a></li>
-<li><a name='toc11' href='#sect11'>Command Line with Flags - Batch Processing</a></li>
-<li><a name='toc12' href='#sect12'>Help</a></li>
-<li><a name='toc13' href='#sect13'>Sisu Manual</a></li>
-<li><a name='toc14' href='#sect14'>Sisu Man Pages</a></li>
-<li><a name='toc15' href='#sect15'>Sisu Built-in Interactive Help, [discontinued]</a></li>
-<li><a name='toc16' href='#sect16'>Introduction to Sisu Markup[^11]</a></li>
-<li><a name='toc17' href='#sect17'>Summary</a></li>
-<li><a name='toc18' href='#sect18'>Markup Examples</a></li>
-<li><a name='toc19' href='#sect19'>Online</a></li>
-<li><a name='toc20' href='#sect20'>Installed</a></li>
-<li><a name='toc21' href='#sect21'>Markup of Headers</a></li>
-<li><a name='toc22' href='#sect22'>Sample Header</a></li>
-<li><a name='toc23' href='#sect23'>Available Headers</a></li>
-<li><a name='toc24' href='#sect24'>Markup of Substantive Text</a></li>
-<li><a name='toc25' href='#sect25'>Heading Levels</a></li>
-<li><a name='toc26' href='#sect26'>Font Attributes</a></li>
-<li><a name='toc27' href='#sect27'>Indentation and Bullets</a></li>
-<li><a name='toc28' href='#sect28'>Hanging Indents</a></li>
-<li><a name='toc29' href='#sect29'>Footnotes / Endnotes</a></li>
-<li><a name='toc30' href='#sect30'>Links</a></li>
-<li><a name='toc31' href='#sect31'>Naked Urls Within Text, Dealing with Urls</a></li>
-<li><a name='toc32' href='#sect32'>Linking Text</a></li>
-<li><a name='toc33' href='#sect33'>Linking Images</a></li>
-<li><a name='toc34' href='#sect34'>Link Shortcut for Multiple Versions of a Sisu Document in the Same Directory</a></li>
-<li><a name='toc35' href='#sect35'>Grouped Text</a></li>
-<li><a name='toc36' href='#sect36'>Tables</a></li>
-<li><a name='toc37' href='#sect37'>Poem</a></li>
-<li><a name='toc38' href='#sect38'>Group</a></li>
-<li><a name='toc39' href='#sect39'>Code</a></li>
-<li><a name='toc40' href='#sect40'>Additional Breaks - Linebreaks Within Objects, Column and Page-breaks</a></li>
-<li><a name='toc41' href='#sect41'>Line-breaks</a></li>
-<li><a name='toc42' href='#sect42'>Page Breaks</a></li>
-<li><a name='toc43' href='#sect43'>Book Index</a></li>
-<li><a name='toc44' href='#sect44'>Composite Documents Markup</a></li>
-<li><a name='toc45' href='#sect45'>Sisu Filetypes</a></li>
-<li><a name='toc46' href='#sect46'>.sst .ssm .ssi Marked Up Plain Text</a></li>
-<li><a name='toc47' href='#sect47'>Sisu Text - Regular Files (.sst)</a></li>
-<li><a name='toc48' href='#sect48'>Sisu Master Files (.ssm)</a></li>
-<li><a name='toc49' href='#sect49'>Sisu Insert Files (.ssi)</a></li>
-<li><a name='toc50' href='#sect50'>Sisupod, Zipped Binary Container (sisupod.zip, .ssp)</a></li>
-<li><a name='toc51' href='#sect51'>Configuration</a></li>
-<li><a name='toc52' href='#sect52'>Configuration Files</a></li>
-<li><a name='toc53' href='#sect53'>Config.yml</a></li>
-<li><a name='toc54' href='#sect54'>Sisu_document_make</a></li>
-<li><a name='toc55' href='#sect55'>Css - Cascading Style Sheets (for Html, Xhtml and Xml)</a></li>
-<li><a name='toc56' href='#sect56'>Organising Content - Directory Structure and Mapping</a></li>
-<li><a name='toc57' href='#sect57'>Document Source Directory</a></li>
-<li><a name='toc58' href='#sect58'>General Directories</a></li>
-<li><a name='toc59' href='#sect59'>Document Output Directory Structures</a></li>
-<li><a name='toc60' href='#sect60'>Output Directory Root</a></li>
-<li><a name='toc61' href='#sect61'>Alternative Output Structures</a></li>
-<li><a name='toc62' href='#sect62'>by Language</a></li>
-<li><a name='toc63' href='#sect63'>by Filetype</a></li>
-<li><a name='toc64' href='#sect64'>by Filename</a></li>
-<li><a name='toc65' href='#sect65'>Remote Directories</a></li>
-<li><a name='toc66' href='#sect66'>Sisupod</a></li>
-<li><a name='toc67' href='#sect67'>Organising Content</a></li>
-<li><a name='toc68' href='#sect68'>Homepages</a></li>
-<li><a name='toc69' href='#sect69'>Home Page and Other Custom Built Pages in a Sub-directory</a></li>
-<li><a name='toc70' href='#sect70'>Markup and Output Examples</a></li>
-<li><a name='toc71' href='#sect71'>Markup Examples</a></li>
-<li><a name='toc72' href='#sect72'>Sisu Markup Samples</a></li>
-<li><a name='toc73' href='#sect73'>Sisu Search - Introduction</a></li>
-<li><a name='toc74' href='#sect74'>Sql</a></li>
-<li><a name='toc75' href='#sect75'>Populating Sql Type Databases</a></li>
-<li><a name='toc76' href='#sect76'>Postgresql</a></li>
-<li><a name='toc77' href='#sect77'>Name</a></li>
-<li><a name='toc78' href='#sect78'>Description</a></li>
-<li><a name='toc79' href='#sect79'>Synopsis</a></li>
-<li><a name='toc80' href='#sect80'>Commands</a></li>
-<li><a name='toc81' href='#sect81'>Create and Destroy Database</a></li>
-<li><a name='toc82' href='#sect82'>Import and Remove Documents</a></li>
-<li><a name='toc83' href='#sect83'>Sqlite</a></li>
-<li><a name='toc84' href='#sect84'>Name</a></li>
-<li><a name='toc85' href='#sect85'>Description</a></li>
-<li><a name='toc86' href='#sect86'>Synopsis</a></li>
-<li><a name='toc87' href='#sect87'>Commands</a></li>
-<li><a name='toc88' href='#sect88'>Create and Destroy Database</a></li>
-<li><a name='toc89' href='#sect89'>Import and Remove Documents</a></li>
-<li><a name='toc90' href='#sect90'>Introduction</a></li>
-<li><a name='toc91' href='#sect91'>Search - Database Frontend Sample, Utilising Database and Sisu Features,</a></li>
-<li><a name='toc92' href='#sect92'>Search Form</a></li>
-<li><a name='toc93' href='#sect93'>Sisu_webrick</a></li>
-<li><a name='toc94' href='#sect94'>Name</a></li>
-<li><a name='toc95' href='#sect95'>Synopsis</a></li>
-<li><a name='toc96' href='#sect96'>Description</a></li>
-<li><a name='toc97' href='#sect97'>Summary of Man Page</a></li>
-<li><a name='toc98' href='#sect98'>Document Processing Command Flags</a></li>
-<li><a name='toc99' href='#sect99'>Summary of Features</a></li>
-<li><a name='toc100' href='#sect100'>See Also</a></li>
-<li><a name='toc101' href='#sect101'>Homepage</a></li>
-<li><a name='toc102' href='#sect102'>Source</a></li>
-<li><a name='toc103' href='#sect103'>Author</a></li>
-</ul>
-</body>
-</html>
diff --git a/data/doc/sisu/html/sisu_complete.7.html b/data/doc/sisu/html/sisu_complete.7.html
deleted file mode 100644
index 1a1e025d..00000000
--- a/data/doc/sisu/html/sisu_complete.7.html
+++ /dev/null
@@ -1,54 +0,0 @@
- <!-- manual page source format generated by PolyglotMan v3.2, -->
-<!-- available at http://polyglotman.sourceforge.net/ -->
-
-<html>
-<head>
-<title>sisu_complete(7) manual page</title>
-</head>
-<body bgcolor='white'>
-<a href='#toc'>Table of Contents</a><p>
-
-<h2><a name='sect0' href='#toc0'>Name</a></h2>
-<b>SiSU</b> - Structured information, Serialized Units - a document
-publishing system, complete dependency package <p>
-
-<h2><a name='sect1' href='#toc1'>Synopsis</a></h2>
-Dummy package installs
-the whole of SiSU, excluding sisu-examples <p>
-sisu-complete together with sisu-examples
-is the whole of sisu
-<h2><a name='sect2' href='#toc2'>Further Information</a></h2>
-<p>
-For more information on <i>SiSU</i> see:
-<i>&lt;<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a>
-&gt;</i> <p>
-or <i>man</i> sisu
-<h2><a name='sect3' href='#toc3'>Author</a></h2>
-Ralph Amissah <i>&lt;ralph@amissah.com&gt;</i>
-or <i>&lt;ralph.amissah@gmail.com&gt;</i>
-<h2><a name='sect4' href='#toc4'>See</a></h2>
-<a href='http:~/bin/man2html?sisu:1'><b>sisu(1)</a>
-,</b> <a href='http:~/bin/man2html?sisu:8'><b>sisu(8)</a>
-,</b>
-<h2><a name='sect5' href='#toc5'>Also</a></h2>
-<a href='http:~/bin/man2html?sisu_webrick:1'><b>sisu_webrick(1)</a>
-,</b> <a href='http:~/bin/man2html?sisu_pdf:7'><b>sisu_pdf(7)</b></a>
-
-<a href='http:~/bin/man2html?sisu_sqlite:7'><b>sisu_sqlite(7)</b></a>
- <a href='http:~/bin/man2html?sisu_postgresql:7'><b>sisu_postgresql(7)</b></a>
- <a href='http:~/bin/man2html?sisu_vim:7'><b>sisu_vim(7)</b></a>
- <a href='http:~/bin/man2html?sisu_termsheet:1'><b>sisu_termsheet(1)</a>
-,</b> <p>
-
-<hr><p>
-<a name='toc'><b>Table of Contents</b></a><p>
-<ul>
-<li><a name='toc0' href='#sect0'>Name</a></li>
-<li><a name='toc1' href='#sect1'>Synopsis</a></li>
-<li><a name='toc2' href='#sect2'>Further Information</a></li>
-<li><a name='toc3' href='#sect3'>Author</a></li>
-<li><a name='toc4' href='#sect4'>See</a></li>
-<li><a name='toc5' href='#sect5'>Also</a></li>
-</ul>
-</body>
-</html>
diff --git a/data/doc/sisu/html/sisu_pdf.7.html b/data/doc/sisu/html/sisu_pdf.7.html
deleted file mode 100644
index e2e41bda..00000000
--- a/data/doc/sisu/html/sisu_pdf.7.html
+++ /dev/null
@@ -1,171 +0,0 @@
-<!-- manual page source format generated by PolyglotMan v3.2, -->
-<!-- available at http://polyglotman.sourceforge.net/ -->
-
-<html>
-<head>
-<title>"sisu_pdf"("1") manual page</title>
-</head>
-<body bgcolor='white'>
-<a href='#toc'>Table of Contents</a><p>
-
-<h2><a name='sect0' href='#toc0'>Name</a></h2>
-sisu - package to install what sisu needs to generate pdf (latex to
-pdf dependency component)
-<h2><a name='sect1' href='#toc1'>Synopsis</a></h2>
-sisu -pv [filename/wildcard ] SISU - PDF,
-RALPH AMISSAH
-<p> 1. SISU PDF
-<p> 1.1 NAME
-<p> <b>SiSU</b> - Structured information, Serialized
-Units - a document publishing system.
-<p> 1.2 DESCRIPTION
-<p> Information creating
-pdf output with sisu (and related to the sisu_pdf dependency package, which
-is a dummy package to install dependencies needed for <b>SiSU</b> to generate
-pdfs (primarily related to LaTeX), sisu_pdf being part of <b>SiSU</b> - man sisu).
-
-<p> <b>SiSU</b> generates LaTeX which is converted by LaTeX tools to pdf.
-<p> 1.3 SYNOPSIS
-
-<p> sisu -pv &nbsp;[filename/wildcard]<br>
-
-<p> 1.4 COMMANDS
-<p>
-<dl>
-
-<dt><b>&nbsp;sisu &nbsp;-pv &nbsp;&nbsp;[filename/wildcard]</b> </dt>
-<dd>creates two pdf documents: vertical
-(portrait.pdf) and; horizontal (landscape.pdf). <b>SiSU</b> generates LaTeX output
-which is converted to pdf if the appropriate LaTeX dependencies are met
-on the system.
-<p> </dd>
-
-<dt><b>&nbsp;sisu &nbsp;-pv &nbsp;--papersize-a4 &nbsp;&nbsp;[filename/wildcard]</b> </dt>
-<dd>overrides the default
-papersize set to A4. Preset alternative sizes include: &rsquo;A4&rsquo;, U.S. &rsquo;letter&rsquo; and
-&rsquo;legal&rsquo; and book sizes &rsquo;A5&rsquo; and &rsquo;B5&rsquo; (system defaults to A4).
-<p> </dd>
-</dl>
-1.5 SETTING PAPER
-
-<p>SIZE
-<p> The paper-size may be set to any of the following sizes: &rsquo;A4&rsquo;, U.S. &rsquo;letter&rsquo;
-and &rsquo;legal&rsquo; and book sizes: &rsquo;A5&rsquo; and &rsquo;B5&rsquo;
-<p> 1. The preset default if not otherwise
-given in the configuration file or elsewhere is A4.
-<p> 2. The default paper
-size may be set in the configuration file sisurc.yml. See sisu_configuration:
-
-<p>
-<p> <br>
-<pre> #% papersize, (LaTeX/pdf) current values A4, US_letter, book_b5, book_a5,
-US_legal
- default:
- papersize: &rsquo;A4&rsquo;
-</pre>
-<p> 3. Paper size may be set in a document header:
-<p>
-<p> <br>
-<pre> @papersize: (A4|US_letter|book_B5|book_A5|US_legal)
-</pre>
-<p> 4. or provided with additional command line parameter, e.g.
-<p> sisu -pv
---papersize-a4 &nbsp;[filename/wildcard]<br>
-
-<p> DOCUMENT INFORMATION (METADATA)
-<p> METADATA
-<p> Document Manifest @ &lt;<a href='http://sisudoc.org/sisu_manual/sisu_pdf/sisu_manifest.html'>http://sisudoc.org/sisu_manual/sisu_pdf/sisu_manifest.html</a>
-&gt;
-
-<p> <b>Dublin Core</b> (DC)
-<p> <i>DC</i> tags included with this document are provided here.
-
-<p> DC Title: <i>SiSU</i> - PDF
-<p> DC Creator: <i>Ralph</i> Amissah
-<p> DC Rights: <i>Copyright</i>
-(C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3
-<p> DC
-Type: <i>information</i>
-<p> DC Date created: <i>2002-08-28</i>
-<p> DC Date issued: <i>2002-08-28</i>
-
-<p> DC Date available: <i>2002-08-28</i>
-<p> DC Date modified: <i>2007-09-16</i>
-<p> DC Date: <i>2007-09-16</i>
-
-<p> <b>Version Information</b>
-<p> Sourcefile: <i>sisu_pdf.sst</i>
-<p> Filetype: <i>SiSU</i> text 0.58
-
-<p> Sourcefile Digest, MD5(sisu_pdf.sst)= <i>bed13854370b5daf1b1541527e8946b7</i>
-
-<p> Skin_Digest: MD5(skin_sisu_manual.rb)= <i>20fc43cf3eb6590bc3399a1aef65c5a9</i>
-
-<p> <b>Generated</b>
-<p> Document (metaverse) last generated: <i>Sat</i> Sep 29 17:05:37
-
-<p>+0100 2007
-<p> Generated by: <i>SiSU</i> <i>0.59.1</i> of 2007w39/2 (2007-09-25)
-<p> Ruby version:
-<i>ruby</i> 1.8.6 (2007-06-07 patchlevel 36) &nbsp;[i486-linux]
-<p>
-<p>
-<dl>
-
-<dt>Other versions of this
-document: </dt>
-<dd></dd>
-
-<dt>manifest: &lt;<a href='http://www.jus.uio.no/sisu/sisu_pdf/sisu_manifest.html'><a href='http://www.jus.uio.no/sisu/sisu_pdf/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_pdf/sisu_manifest.html</a>
-</a>
-&gt;
-</dt>
-<dd></dd>
-
-<dt>html: &lt;<a href='http://www.jus.uio.no/sisu/sisu_pdf/toc.html'><a href='http://www.jus.uio.no/sisu/sisu_pdf/toc.html'>http://www.jus.uio.no/sisu/sisu_pdf/toc.html</a>
-</a>
-&gt; </dt>
-<dd></dd>
-
-<dt>pdf: &lt;<a href='http://www.jus.uio.no/sisu/sisu_pdf/portrait.pdf'><a href='http://www.jus.uio.no/sisu/sisu_pdf/portrait.pdf'>http://www.jus.uio.no/sisu/sisu_pdf/portrait.pdf</a>
-</a>
-&gt;
-</dt>
-<dd></dd>
-
-<dt>pdf: &lt;<a href='http://www.jus.uio.no/sisu/sisu_pdf/landscape.pdf'><a href='http://www.jus.uio.no/sisu/sisu_pdf/landscape.pdf'>http://www.jus.uio.no/sisu/sisu_pdf/landscape.pdf</a>
-</a>
-&gt; </dt>
-<dd> </dd>
-
-<dt>at: &lt;<a href='http://www.jus.uio.no/sisu'><a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a>
-</a>
-&gt;
-</dt>
-<dd></dd>
-
-<dt>* Generated by: SiSU 0.59.1 of 2007w39/2 (2007-09-25) </dt>
-<dd></dd>
-
-<dt>* Ruby version: ruby
-1.8.6 (2007-06-07 patchlevel 36) [i486-linux] </dt>
-<dd></dd>
-
-<dt>* Last Generated on: Sat Sep 29
-17:05:39 +0100 2007 </dt>
-<dd></dd>
-
-<dt>* SiSU <a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a>
- </dt>
-<dd></dd>
-</dl>
-<p>
-
-<hr><p>
-<a name='toc'><b>Table of Contents</b></a><p>
-<ul>
-<li><a name='toc0' href='#sect0'>Name</a></li>
-<li><a name='toc1' href='#sect1'>Synopsis</a></li>
-</ul>
-</body>
-</html>
diff --git a/data/doc/sisu/html/sisu_postgresql.7.html b/data/doc/sisu/html/sisu_postgresql.7.html
deleted file mode 100644
index 6bc6be80..00000000
--- a/data/doc/sisu/html/sisu_postgresql.7.html
+++ /dev/null
@@ -1,198 +0,0 @@
-<!-- manual page source format generated by PolyglotMan v3.2, -->
-<!-- available at http://polyglotman.sourceforge.net/ -->
-
-<html>
-<head>
-<title>"sisu_postgresql"("1") manual page</title>
-</head>
-<body bgcolor='white'>
-<a href='#toc'>Table of Contents</a><p>
-
-<h2><a name='sect0' href='#toc0'>Name</a></h2>
-sisu - package to install what sisu needs to to populate a postgresql
-database (postgresql dependency component)
-<h2><a name='sect1' href='#toc1'>Synopsis</a></h2>
-sisu -Dv [filename/wildcard
-] sisu -Dv [instruction] SISU - SEARCH, RALPH AMISSAH
-<p> 1. POSTGRESQL
-<p> 1.1
-
-<p>NAME
-<p> <b>SiSU</b> - Structured information, Serialized Units - a document publishing
-system, postgresql dependency package
-<p> 1.2 DESCRIPTION
-<p> 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</b>
-to populate a postgresql database, this being part of <b>SiSU</b> - man sisu).
-<p>
-
-<p>1.3 SYNOPSIS
-<p> sisu -D &nbsp;[instruction] &nbsp;[filename/wildcard &nbsp;if &nbsp;required]<br>
-
-<p> sisu -D --pg --[instruction] &nbsp;[filename/wildcard &nbsp;if &nbsp;required]<br>
-
-<p> 1.4 COMMANDS
-<p> 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
-<p> <b>-D or --pgsql</b> may
-be used interchangeably.
-<p> 1.4.1 CREATE AND DESTROY DATABASE
-<p>
-<dl>
-
-<dt><b>&nbsp;--pgsql &nbsp;--createall</b>
-</dt>
-<dd>&nbsp;initial &nbsp;step, &nbsp;creates &nbsp;required &nbsp;relations &nbsp;(tables, &nbsp;indexes) &nbsp;in &nbsp;existing
-&nbsp;(postgresql) &nbsp;database &nbsp;(a &nbsp;database &nbsp;should &nbsp;be &nbsp;created (postgresql dependency
-component) manually &nbsp;and &nbsp;given &nbsp;the &nbsp;same &nbsp;name &nbsp;as &nbsp;working &nbsp;directory, &nbsp;as requested)
-&nbsp;(rb.dbi) the &nbsp;same &nbsp;name &nbsp;as &nbsp;working &nbsp;directory, &nbsp;as
-<p> </dd>
-
-<dt><b>&nbsp;sisu &nbsp;-D &nbsp;--createdb</b> </dt>
-<dd>&nbsp;creates
-&nbsp;database &nbsp;where &nbsp;no &nbsp;database &nbsp;existed &nbsp;before &nbsp;as
-<p> </dd>
-
-<dt><b>&nbsp;sisu &nbsp;-D &nbsp;--create</b> </dt>
-<dd>&nbsp;creates &nbsp;database
-&nbsp;tables &nbsp;where &nbsp;no &nbsp;database &nbsp;tables &nbsp;existed before &nbsp;database &nbsp;tables &nbsp;where &nbsp;no
-&nbsp;database &nbsp;tables &nbsp;existed
-<p> </dd>
-
-<dt><b>&nbsp;sisu &nbsp;-D &nbsp;--Dropall</b> </dt>
-<dd>&nbsp;destroys &nbsp;database &nbsp;(including &nbsp;all
-&nbsp;its &nbsp;content)! &nbsp;kills &nbsp;data and &nbsp;drops &nbsp;tables, &nbsp;indexes &nbsp;and &nbsp;database &nbsp;associated
-&nbsp;with &nbsp;a given &nbsp;directory &nbsp;(and &nbsp;directories &nbsp;of &nbsp;the &nbsp;same &nbsp;name). &nbsp;a
-<p> </dd>
-
-<dt><b>&nbsp;sisu &nbsp;-D &nbsp;--recreate</b>
-</dt>
-<dd>
-<p>&nbsp;destroys &nbsp;existing &nbsp;database &nbsp;and &nbsp;builds &nbsp;a &nbsp;new &nbsp;empty &nbsp;database &nbsp;structure
-<p> </dd>
-</dl>
-1.4.2
-
-<p>IMPORT AND REMOVE DOCUMENTS
-<p>
-<dl>
-
-<dt><b>&nbsp;sisu &nbsp;-D &nbsp;--import &nbsp;-v &nbsp;&nbsp;[filename/wildcard]</b> </dt>
-<dd>populates
-database with the contents of the file. Imports documents(s) specified to
-a postgresql database (at an object level).
-<p> </dd>
-
-<dt><b>&nbsp;sisu &nbsp;-D &nbsp;--update &nbsp;-v &nbsp;&nbsp;[filename/wildcard]</b>
-</dt>
-<dd>
-<p>updates file contents in database
-<p> </dd>
-
-<dt><b>&nbsp;sisu &nbsp;-D &nbsp;--remove &nbsp;-v &nbsp;&nbsp;[filename/wildcard]</b>
-</dt>
-<dd>removes specified document from postgresql database.
-<p> </dd>
-</dl>
-DOCUMENT INFORMATION
-(METADATA)
-<p> METADATA
-<p> Document Manifest @ &lt;<a href='http://sisudoc.org/sisu_manual/sisu_postgresql/sisu_manifest.html'>http://sisudoc.org/sisu_manual/sisu_postgresql/sisu_manifest.html</a>
-&gt;
-
-<p> <b>Dublin Core</b> (DC)
-<p> <i>DC</i> tags included with this document are provided here.
-
-<p> DC Title: <i>SiSU</i> - Search
-<p> DC Creator: <i>Ralph</i> Amissah
-<p> DC Rights: <i>Copyright</i>
-(C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3
-<p> DC
-Type: <i>information</i>
-<p> DC Date created: <i>2002-08-28</i>
-<p> DC Date issued: <i>2002-08-28</i>
-
-<p> DC Date available: <i>2002-08-28</i>
-<p> DC Date modified: <i>2007-09-16</i>
-<p> DC Date: <i>2007-09-16</i>
-
-<p> <b>Version Information</b>
-<p> Sourcefile: <i>sisu_postgresql.sst</i>
-<p> Filetype: <i>SiSU</i>
-
-<p>text 0.58
-<p> Sourcefile Digest, MD5(sisu_postgresql.sst)= <i>9010e85001c50e30ba2ab69f9097825a</i>
-
-<p> Skin_Digest: MD5(skin_sisu_manual.rb)= <i>20fc43cf3eb6590bc3399a1aef65c5a9</i>
-
-<p> <b>Generated</b>
-<p> Document (metaverse) last generated: <i>Sat</i> Sep 29 17:05:38
-
-<p>+0100 2007
-<p> Generated by: <i>SiSU</i> <i>0.59.1</i> of 2007w39/2 (2007-09-25)
-<p> Ruby version:
-<i>ruby</i> 1.8.6 (2007-06-07 patchlevel 36) &nbsp;[i486-linux]
-<p>
-<p>
-<dl>
-
-<dt>Other versions of this
-document: </dt>
-<dd></dd>
-
-<dt>manifest: &lt;<a href='http://www.jus.uio.no/sisu/sisu_postgresql/sisu_manifest.html'><a href='http://www.jus.uio.no/sisu/sisu_postgresql/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_postgresql/sisu_manifest.html</a>
-</a>
-&gt;
-</dt>
-<dd></dd>
-
-<dt>html: &lt;<a href='http://www.jus.uio.no/sisu/sisu_postgresql/toc.html'><a href='http://www.jus.uio.no/sisu/sisu_postgresql/toc.html'>http://www.jus.uio.no/sisu/sisu_postgresql/toc.html</a>
-</a>
-&gt; </dt>
-<dd></dd>
-
-<dt>pdf: &lt;<a href='http://www.jus.uio.no/sisu/sisu_postgresql/portrait.pdf'><a href='http://www.jus.uio.no/sisu/sisu_postgresql/portrait.pdf'>http://www.jus.uio.no/sisu/sisu_postgresql/portrait.pdf</a>
-</a>
-&gt;
-</dt>
-<dd></dd>
-
-<dt>pdf: &lt;<a href='http://www.jus.uio.no/sisu/sisu_postgresql/landscape.pdf'><a href='http://www.jus.uio.no/sisu/sisu_postgresql/landscape.pdf'>http://www.jus.uio.no/sisu/sisu_postgresql/landscape.pdf</a>
-</a>
-&gt; </dt>
-<dd> </dd>
-
-<dt>at: &lt;<a href='http://www.jus.uio.no/sisu'><a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a>
-</a>
-&gt;
-</dt>
-<dd></dd>
-
-<dt>* Generated by: SiSU 0.59.1 of 2007w39/2 (2007-09-25) </dt>
-<dd></dd>
-
-<dt>* Ruby version: ruby
-1.8.6 (2007-06-07 patchlevel 36) [i486-linux] </dt>
-<dd></dd>
-
-<dt>* Last Generated on: Sat Sep 29
-17:05:39 +0100 2007 </dt>
-<dd></dd>
-
-<dt>* SiSU <a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a>
- </dt>
-<dd></dd>
-</dl>
-<p>
-
-<hr><p>
-<a name='toc'><b>Table of Contents</b></a><p>
-<ul>
-<li><a name='toc0' href='#sect0'>Name</a></li>
-<li><a name='toc1' href='#sect1'>Synopsis</a></li>
-</ul>
-</body>
-</html>
diff --git a/data/doc/sisu/html/sisu_sqlite.7.html b/data/doc/sisu/html/sisu_sqlite.7.html
deleted file mode 100644
index b6f8b59b..00000000
--- a/data/doc/sisu/html/sisu_sqlite.7.html
+++ /dev/null
@@ -1,196 +0,0 @@
-<!-- manual page source format generated by PolyglotMan v3.2, -->
-<!-- available at http://polyglotman.sourceforge.net/ -->
-
-<html>
-<head>
-<title>"sisu_sqlite"("1") manual page</title>
-</head>
-<body bgcolor='white'>
-<a href='#toc'>Table of Contents</a><p>
-
-<h2><a name='sect0' href='#toc0'>Name</a></h2>
-sisu - package to install what sisu needs to to populate a postgresql
-database (postgresql dependency component)
-<h2><a name='sect1' href='#toc1'>Synopsis</a></h2>
-sisu -dv [filename/wildcard
-] sisu -dv [instruction] SISU - SEARCH, RALPH AMISSAH
-<p> 1. SQLITE
-<p> 1.1 NAME
-
-<p> <b>SiSU</b> - Structured information, Serialized Units - a document publishing
-system.
-<p> 1.2 DESCRIPTION
-<p> 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</b> to populate an sqlite database,
-this being part of <b>SiSU</b> - man sisu).
-<p> 1.3 SYNOPSIS
-<p> sisu -d &nbsp;[instruction]
-&nbsp;[filename/wildcard &nbsp;if &nbsp;required]<br>
-
-<p> sisu -d --(sqlite|pg) --[instruction] &nbsp;[filename/wildcard &nbsp;if <br>
- required]<br>
-
-<p> 1.4 COMMANDS
-<p> 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
-<p> <b>-d or --sqlite</b> may
-be used interchangeably.
-<p> 1.4.1 CREATE AND DESTROY DATABASE
-<p>
-<dl>
-
-<dt><b>&nbsp;--sqlite &nbsp;--createall</b>
-</dt>
-<dd>&nbsp;initial &nbsp;step, &nbsp;creates &nbsp;required &nbsp;relations &nbsp;(tables, &nbsp;indexes) &nbsp;in &nbsp;existing
-&nbsp;(sqlite) &nbsp;database &nbsp;(a &nbsp;database &nbsp;should &nbsp;be &nbsp;created &nbsp;as requested) &nbsp;(rb.dbi) the
-&nbsp;same &nbsp;name &nbsp;as &nbsp;working &nbsp;directory, &nbsp;as
-<p> </dd>
-
-<dt><b>&nbsp;sisu &nbsp;-d &nbsp;--createdb</b> </dt>
-<dd>&nbsp;creates &nbsp;database &nbsp;where
-&nbsp;no &nbsp;database &nbsp;existed &nbsp;before &nbsp;as
-<p> </dd>
-
-<dt><b>&nbsp;sisu &nbsp;-d &nbsp;--create</b> </dt>
-<dd>&nbsp;creates &nbsp;database &nbsp;tables &nbsp;where
-&nbsp;no &nbsp;database &nbsp;tables &nbsp;existed before &nbsp;database &nbsp;tables &nbsp;where &nbsp;no &nbsp;database &nbsp;tables
-&nbsp;existed
-<p> </dd>
-
-<dt><b>&nbsp;sisu &nbsp;-d &nbsp;--dropall</b> </dt>
-<dd>&nbsp;destroys &nbsp;database &nbsp;(including &nbsp;all &nbsp;its &nbsp;content)!
-&nbsp;kills &nbsp;data and &nbsp;drops &nbsp;tables, &nbsp;indexes &nbsp;and &nbsp;database &nbsp;associated &nbsp;with &nbsp;a given
-&nbsp;directory &nbsp;(and &nbsp;directories &nbsp;of &nbsp;the &nbsp;same &nbsp;name). &nbsp;a
-<p> </dd>
-
-<dt><b>&nbsp;sisu &nbsp;-d &nbsp;--recreate</b> </dt>
-<dd>&nbsp;destroys
-
-<p>&nbsp;existing &nbsp;database &nbsp;and &nbsp;builds &nbsp;a &nbsp;new &nbsp;empty &nbsp;database &nbsp;structure
-<p> </dd>
-</dl>
-1.4.2 IMPORT
-
-<p>AND REMOVE DOCUMENTS
-<p>
-<dl>
-
-<dt><b>&nbsp;sisu &nbsp;-d &nbsp;--import &nbsp;-v &nbsp;&nbsp;[filename/wildcard]</b> </dt>
-<dd>populates database
-with the contents of the file. Imports documents(s) specified to an sqlite
-database (at an object level).
-<p> </dd>
-
-<dt><b>&nbsp;sisu &nbsp;-d &nbsp;--update &nbsp;-v &nbsp;&nbsp;[filename/wildcard]</b> </dt>
-<dd>updates
-
-<p>file contents in database
-<p> </dd>
-
-<dt><b>&nbsp;sisu &nbsp;-d &nbsp;--remove &nbsp;-v &nbsp;&nbsp;[filename/wildcard]</b> </dt>
-<dd>removes
-specified document from sqlite database.
-<p> </dd>
-</dl>
-DOCUMENT INFORMATION (METADATA)
-
-<p> METADATA
-<p> Document Manifest @ &lt;<a href='http://sisudoc.org/sisu_manual/sisu_sqlite/sisu_manifest.html'>http://sisudoc.org/sisu_manual/sisu_sqlite/sisu_manifest.html</a>
-&gt;
-
-<p> <b>Dublin Core</b> (DC)
-<p> <i>DC</i> tags included with this document are provided here.
-
-<p> DC Title: <i>SiSU</i> - Search
-<p> DC Creator: <i>Ralph</i> Amissah
-<p> DC Rights: <i>Copyright</i>
-(C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3
-<p> DC
-Type: <i>information</i>
-<p> DC Date created: <i>2002-08-28</i>
-<p> DC Date issued: <i>2002-08-28</i>
-
-<p> DC Date available: <i>2002-08-28</i>
-<p> DC Date modified: <i>2007-09-16</i>
-<p> DC Date: <i>2007-09-16</i>
-
-<p> <b>Version Information</b>
-<p> Sourcefile: <i>sisu_sqlite.sst</i>
-<p> Filetype: <i>SiSU</i> text
-
-<p>0.58
-<p> Sourcefile Digest, MD5(sisu_sqlite.sst)= <i>c4717fcab8a43de498d41a916bb99551</i>
-
-<p> Skin_Digest: MD5(skin_sisu_manual.rb)= <i>20fc43cf3eb6590bc3399a1aef65c5a9</i>
-
-<p> <b>Generated</b>
-<p> Document (metaverse) last generated: <i>Sat</i> Sep 29 17:05:38
-
-<p>+0100 2007
-<p> Generated by: <i>SiSU</i> <i>0.59.1</i> of 2007w39/2 (2007-09-25)
-<p> Ruby version:
-<i>ruby</i> 1.8.6 (2007-06-07 patchlevel 36) &nbsp;[i486-linux]
-<p>
-<p>
-<dl>
-
-<dt>Other versions of this
-document: </dt>
-<dd></dd>
-
-<dt>manifest: &lt;<a href='http://www.jus.uio.no/sisu/sisu_sqlite/sisu_manifest.html'><a href='http://www.jus.uio.no/sisu/sisu_sqlite/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_sqlite/sisu_manifest.html</a>
-</a>
-&gt;
-</dt>
-<dd></dd>
-
-<dt>html: &lt;<a href='http://www.jus.uio.no/sisu/sisu_sqlite/toc.html'><a href='http://www.jus.uio.no/sisu/sisu_sqlite/toc.html'>http://www.jus.uio.no/sisu/sisu_sqlite/toc.html</a>
-</a>
-&gt; </dt>
-<dd></dd>
-
-<dt>pdf: &lt;<a href='http://www.jus.uio.no/sisu/sisu_sqlite/portrait.pdf'><a href='http://www.jus.uio.no/sisu/sisu_sqlite/portrait.pdf'>http://www.jus.uio.no/sisu/sisu_sqlite/portrait.pdf</a>
-</a>
-&gt;
-</dt>
-<dd></dd>
-
-<dt>pdf: &lt;<a href='http://www.jus.uio.no/sisu/sisu_sqlite/landscape.pdf'><a href='http://www.jus.uio.no/sisu/sisu_sqlite/landscape.pdf'>http://www.jus.uio.no/sisu/sisu_sqlite/landscape.pdf</a>
-</a>
-&gt; </dt>
-<dd> </dd>
-
-<dt>at: &lt;<a href='http://www.jus.uio.no/sisu'><a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a>
-</a>
-&gt;
-</dt>
-<dd></dd>
-
-<dt>* Generated by: SiSU 0.59.1 of 2007w39/2 (2007-09-25) </dt>
-<dd></dd>
-
-<dt>* Ruby version: ruby
-1.8.6 (2007-06-07 patchlevel 36) [i486-linux] </dt>
-<dd></dd>
-
-<dt>* Last Generated on: Sat Sep 29
-17:05:39 +0100 2007 </dt>
-<dd></dd>
-
-<dt>* SiSU <a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a>
- </dt>
-<dd></dd>
-</dl>
-<p>
-
-<hr><p>
-<a name='toc'><b>Table of Contents</b></a><p>
-<ul>
-<li><a name='toc0' href='#sect0'>Name</a></li>
-<li><a name='toc1' href='#sect1'>Synopsis</a></li>
-</ul>
-</body>
-</html>
diff --git a/data/doc/sisu/html/sisu_termsheet.1.html b/data/doc/sisu/html/sisu_termsheet.1.html
deleted file mode 100644
index d4f2b698..00000000
--- a/data/doc/sisu/html/sisu_termsheet.1.html
+++ /dev/null
@@ -1,76 +0,0 @@
- <!-- manual page source format generated by PolyglotMan v3.2, -->
-<!-- available at http://polyglotman.sourceforge.net/ -->
-
-<html>
-<head>
-<title>sisu_termsheet(1) manual page</title>
-</head>
-<body bgcolor='white'>
-<a href='#toc'>Table of Contents</a><p>
-
-<h2><a name='sect0' href='#toc0'>Name</a></h2>
-<b>SiSU</b> - Structured information, Serialized Units - a document
-publishing system
-<h2><a name='sect1' href='#toc1'>Synopsis</a></h2>
-<p>
-<b>sisu</b> <b>-t</b> <i>[termsheet-name(s)]</i>
-<h2><a name='sect2' href='#toc2'>Description</a></h2>
-<b>sisu_termsheet</b>
-<i>is</i> part of SiSU is <b>invoked</b> <i>through</i> the sisu command (man sisu) <p>
-
-<h2><a name='sect3' href='#toc3'>Summary
-of man page</a></h2>
-<p>
-sisu_termsheet, is started with the command: <b>sisu --termsheet</b>
-<i>[termsheet-name(s)]</i>
-<h2><a name='sect4' href='#toc4'>Document Processing Command Flags</a></h2>
-<p>
-<b>sisu</b><i>&nbsp;-t</i><b>&nbsp;[termsheet-name(s)]</b>
-(runs sisu_termsheet) merges the termsheet(s) specified on the commandline
-with the documents it is instructed to merge in the termsheet(s), and produces
-regular <i>SiSU</i> output documents from the merged results. <p>
-[further documentation
-on termsheets required]
-<h2><a name='sect5' href='#toc5'>Further Information</a></h2>
-<p>
-For more information on <i>SiSU</i>
-see: <i>&lt;<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a>
-&gt;</i> <p>
-or <i>man</i> sisu
-<h2><a name='sect6' href='#toc6'>Author</a></h2>
-Ralph Amissah <i>&lt;ralph@amissah.com&gt;</i>
-or <i>&lt;ralph.amissah@gmail.com&gt;</i>
-<h2><a name='sect7' href='#toc7'>See Also</a></h2>
-<a href='http:~/bin/man2html?sisu:1'><b>sisu(1)</a>
-,</b> <a href='http:~/bin/man2html?sisu:8'><b>sisu(8)</a>
-,</b> <a href='http:~/bin/man2html?sisu_webrick:1'><b>sisu_webrick(1)</a>
-,</b> <a href='http:~/bin/man2html?sisu_vim:7'><b>sisu_vim(7)</b></a>
-
-
-<p>
-<h2><a name='sect8' href='#toc8'>Homepage</a></h2>
-More information about <b>SiSU</b> can be found at &lt;<a href='http://www.sisudoc.org/'><i>http://www.sisudoc.org/</i></a>
-&gt;
-or &lt;<a href='http://www.jus.uio.no/sisu/'><i>http://www.jus.uio.no/sisu/</i></a>
-&gt;.
-<p>
-<h2><a name='sect9' href='#toc9'>Author</a></h2>
-<b>SiSU</b> is written by Ralph Amissah &lt;<i>ralph@amissah.com</i>&gt;.
-<p>
-
-<hr><p>
-<a name='toc'><b>Table of Contents</b></a><p>
-<ul>
-<li><a name='toc0' href='#sect0'>Name</a></li>
-<li><a name='toc1' href='#sect1'>Synopsis</a></li>
-<li><a name='toc2' href='#sect2'>Description</a></li>
-<li><a name='toc3' href='#sect3'>Summary of man page</a></li>
-<li><a name='toc4' href='#sect4'>Document Processing Command Flags</a></li>
-<li><a name='toc5' href='#sect5'>Further Information</a></li>
-<li><a name='toc6' href='#sect6'>Author</a></li>
-<li><a name='toc7' href='#sect7'>See Also</a></li>
-<li><a name='toc8' href='#sect8'>Homepage</a></li>
-<li><a name='toc9' href='#sect9'>Author</a></li>
-</ul>
-</body>
-</html>
diff --git a/data/doc/sisu/html/sisu_vim.7.html b/data/doc/sisu/html/sisu_vim.7.html
deleted file mode 100644
index b7ee2028..00000000
--- a/data/doc/sisu/html/sisu_vim.7.html
+++ /dev/null
@@ -1,62 +0,0 @@
-<!-- manual page source format generated by PolyglotMan v3.2, -->
-<!-- available at http://polyglotman.sourceforge.net/ -->
-
-<html>
-<head>
-<title>"sisu_vim"("1") manual page</title>
-</head>
-<body bgcolor='white'>
-<a href='#toc'>Table of Contents</a><p>
-
-<h2><a name='sect0' href='#toc0'>Name</a></h2>
- sisu_vim - vim syntax and folds file for sisu: markup, structuring,
-publishing in multiple standard formats, and search<br>
- SISU - VIM, RALPH AMISSAH
-<p> SISU VIM
-<p> 1. SISU VIM
-<p> <b>Synopsis</b>
-<p> <b>SiSU</b> has
-syntax highlighting for a number of editors including vim which are documented
-under:
-<p> /usr/share/doc/sisu/markup-samples/sisu_manual/sisu_syntax_highlighting.sst<br>
-
-<p> &lt;<a href='http://www.sisudoc.org/sisu/sisu_manual/sisu_syntax_highlighting/index.html'>http://www.sisudoc.org/sisu/sisu_manual/sisu_syntax_highlighting/index.html</a>
-&gt;<br>
-
-<p> <b>SiSU</b> also provides an ftplugin to provide vim folds for <b>SiSU</b> markup,
-and to set some defaults for <b>SiSU</b> markup in installed by sisu.
-<p> Vim 7 includes
-sisu markup syntax highlighting.
-<p> Vim related files are included in: /usr/share/sisu/conf/editor-syntax-etc/vim
-(including the syntax highlighter, together with an ftplugin which may
-be sourced if so desired from your vimrc).
-<p> sisu-vim actions are activated
-on files with the suffix .sst .ssm .ssi .-sst ._sst (and the same with a further
-.meta extension)<br>
-
-<p>
-<p> <br>
-<pre> &lt;ctrl&gt;F activate folds on headings matched in a document
- (also provides folds when sourced on a ruby program file),
- also :F
- &lt;ctrl&gt;S search and replace down
- &lt;ctrl&gt;G search and replace globally within file
- &lt;ctrl&gt;X ruby regex global search and replace within file
- &lt;ctrl&gt;C set color scheme to slate which is provided
-</pre>
-<p> FURTHER INFORMATION
-<p> For more information on <b>SiSU</b> see:
-<p> &lt;<a href='http://sisudoc.org/'>http://sisudoc.org/</a>
-&gt;
-
-<p> &lt;<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a>
-&gt;
-<p> or man sisu <p>
-
-<hr><p>
-<a name='toc'><b>Table of Contents</b></a><p>
-<ul>
-<li><a name='toc0' href='#sect0'>Name</a></li>
-</ul>
-</body>
-</html>
diff --git a/data/doc/sisu/html/sisu_webrick.1.html b/data/doc/sisu/html/sisu_webrick.1.html
deleted file mode 100644
index c1efc98d..00000000
--- a/data/doc/sisu/html/sisu_webrick.1.html
+++ /dev/null
@@ -1,93 +0,0 @@
-<!-- manual page source format generated by PolyglotMan v3.2, -->
-<!-- available at http://polyglotman.sourceforge.net/ -->
-
-<html>
-<head>
-<title>"sisu_webrick"("1") manual page</title>
-</head>
-<body bgcolor='white'>
-<a href='#toc'>Table of Contents</a><p>
-
-<h2><a name='sect0' href='#toc0'>Name</a></h2>
-sisu - documents: structuring, publishing in multiple formats, and search
-
-<h2><a name='sect1' href='#toc1'>Synopsis</a></h2>
-sisu -W SISU - SISU_WEBRICK, RALPH AMISSAH
-<p> SISU WEBRICK
-<p> 1. SISU_WEBRICK
-
-<p> 1.1 NAME
-<p> <b>SiSU</b> - Structured information, Serialized Units - a document
-
-<p>publishing system
-<p> 1.2 SYNOPSIS
-<p> sisu_webrick &nbsp;[port]
-<p> or
-<p> sisu --Webrick
-&nbsp;[port]
-<p> or
-<p> sisu -W &nbsp;[port]
-<p> 1.3 DESCRIPTION
-<p> sisu_webrick is part of <b>SiSU</b>
-(man sisu) sisu_webrick starts <b>Ruby</b> &rsquo;s Webrick web-server and points it to
-the directories to which <b>SiSU</b> output is written, providing a list of these
-directories (assuming <b>SiSU</b> is in use and they exist).
-<p> 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).
-<p> 1.4 SUMMARY OF MAN PAGE
-<p> sisu_webrick,
-may be started on it&rsquo;s own with the command: sisu_webrick or using the sisu
-command with the -W flag: sisu -W &nbsp;[port]
-<p> where no port is given and settings
-
-<p>are unchanged the default port is 8081
-<p> 1.5 DOCUMENT PROCESSING COMMAND
-
-<p>FLAGS
-<p> sisu -W &nbsp;[port] starts <b>Ruby</b> Webrick web-server, serving <b>SiSU</b> output
-directories, on the port provided, or if no port is provided and the defaults
-
-<p>have not been changed in ~/.sisu/sisurc.yaml then on port 8081
-<p> 1.6 FURTHER
-
-<p>INFORMATION
-<p> For more information on <b>SiSU</b> see: &lt;<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a>
-&gt;
-
-<p> or man sisu
-<p> 1.7 AUTHOR
-<p> Ralph Amissah ralph@amissah.com or ralph.amissah@gmail.com
-
-<p> 1.8 SEE ALSO
-<p> <a href='http:~/bin/man2html?sisu:1'>sisu(1)</a>
-<br>
-
-<p> <a href='http:~/bin/man2html?sisu_vim:7'>sisu_vim(7)</a>
-<br>
-
-<p> <a href='http:~/bin/man2html?sisu:8'>sisu(8)</a>
-<br>
-
-<p>
-<h2><a name='sect2' href='#toc2'>Homepage</a></h2>
-More information about <b>SiSU</b> can be found at &lt;<a href='http://www.sisudoc.org/'><i>http://www.sisudoc.org/</i></a>
-&gt;
-or &lt;<a href='http://www.jus.uio.no/sisu/'><i>http://www.jus.uio.no/sisu/</i></a>
-&gt;.
-<p>
-<h2><a name='sect3' href='#toc3'>Author</a></h2>
-<b>SiSU</b> is written by Ralph Amissah &lt;<i>ralph@amissah.com</i>&gt;.
-<p>
-
-<hr><p>
-<a name='toc'><b>Table of Contents</b></a><p>
-<ul>
-<li><a name='toc0' href='#sect0'>Name</a></li>
-<li><a name='toc1' href='#sect1'>Synopsis</a></li>
-<li><a name='toc2' href='#sect2'>Homepage</a></li>
-<li><a name='toc3' href='#sect3'>Author</a></li>
-</ul>
-</body>
-</html>
diff --git a/data/doc/sisu/markup-samples/sisu_manual/Rakefile b/data/doc/sisu/markup-samples/manual/Rakefile
index 1d9b5414..1d9b5414 100644
--- a/data/doc/sisu/markup-samples/sisu_manual/Rakefile
+++ b/data/doc/sisu/markup-samples/manual/Rakefile
diff --git a/data/doc/sisu/markup-samples/sisu_manual/_sisu/image/GnuDebianLinuxRubyBetterWay.png b/data/doc/sisu/markup-samples/manual/_sisu/image/GnuDebianLinuxRubyBetterWay.png
index ce5b8830..ce5b8830 100644
--- a/data/doc/sisu/markup-samples/sisu_manual/_sisu/image/GnuDebianLinuxRubyBetterWay.png
+++ b/data/doc/sisu/markup-samples/manual/_sisu/image/GnuDebianLinuxRubyBetterWay.png
Binary files differ
diff --git a/data/doc/sisu/markup-samples/sisu_manual/_sisu/image/ruby_logo.png b/data/doc/sisu/markup-samples/manual/_sisu/image/ruby_logo.png
index 829e2458..829e2458 100644
--- a/data/doc/sisu/markup-samples/sisu_manual/_sisu/image/ruby_logo.png
+++ b/data/doc/sisu/markup-samples/manual/_sisu/image/ruby_logo.png
Binary files differ
diff --git a/data/doc/sisu/markup-samples/sisu_manual/_sisu/image/sisu.png b/data/doc/sisu/markup-samples/manual/_sisu/image/sisu.png
index b449fa6b..b449fa6b 100644
--- a/data/doc/sisu/markup-samples/sisu_manual/_sisu/image/sisu.png
+++ b/data/doc/sisu/markup-samples/manual/_sisu/image/sisu.png
Binary files differ
diff --git a/data/doc/sisu/markup-samples/sisu_manual/_sisu/image/tux.png b/data/doc/sisu/markup-samples/manual/_sisu/image/tux.png
index 15fd152b..15fd152b 100644
--- a/data/doc/sisu/markup-samples/sisu_manual/_sisu/image/tux.png
+++ b/data/doc/sisu/markup-samples/manual/_sisu/image/tux.png
Binary files differ
diff --git a/data/doc/sisu/markup-samples/sisu_manual/_sisu/rc/sisurc_by_fn.yml b/data/doc/sisu/markup-samples/manual/_sisu/rc/sisurc_by_fn.yml
index f12e3144..f12e3144 100644
--- a/data/doc/sisu/markup-samples/sisu_manual/_sisu/rc/sisurc_by_fn.yml
+++ b/data/doc/sisu/markup-samples/manual/_sisu/rc/sisurc_by_fn.yml
diff --git a/data/doc/sisu/markup-samples/sisu_manual/_sisu/rc/sisurc_by_fn_monolingual.yml b/data/doc/sisu/markup-samples/manual/_sisu/rc/sisurc_by_fn_monolingual.yml
index b3c49ca1..b3c49ca1 100644
--- a/data/doc/sisu/markup-samples/sisu_manual/_sisu/rc/sisurc_by_fn_monolingual.yml
+++ b/data/doc/sisu/markup-samples/manual/_sisu/rc/sisurc_by_fn_monolingual.yml
diff --git a/data/doc/sisu/markup-samples/sisu_manual/_sisu/rc/sisurc_by_ft.yml b/data/doc/sisu/markup-samples/manual/_sisu/rc/sisurc_by_ft.yml
index 71faa3e0..71faa3e0 100644
--- a/data/doc/sisu/markup-samples/sisu_manual/_sisu/rc/sisurc_by_ft.yml
+++ b/data/doc/sisu/markup-samples/manual/_sisu/rc/sisurc_by_ft.yml
diff --git a/data/doc/sisu/markup-samples/sisu_manual/_sisu/rc/sisurc_by_ft_monolingual.yml b/data/doc/sisu/markup-samples/manual/_sisu/rc/sisurc_by_ft_monolingual.yml
index adf144d5..adf144d5 100644
--- a/data/doc/sisu/markup-samples/sisu_manual/_sisu/rc/sisurc_by_ft_monolingual.yml
+++ b/data/doc/sisu/markup-samples/manual/_sisu/rc/sisurc_by_ft_monolingual.yml
diff --git a/data/doc/sisu/markup-samples/sisu_manual/_sisu/rc/sisurc_by_lng.yml b/data/doc/sisu/markup-samples/manual/_sisu/rc/sisurc_by_lng.yml
index ca1cf424..ca1cf424 100644
--- a/data/doc/sisu/markup-samples/sisu_manual/_sisu/rc/sisurc_by_lng.yml
+++ b/data/doc/sisu/markup-samples/manual/_sisu/rc/sisurc_by_lng.yml
diff --git a/data/doc/sisu/markup-samples/sisu_manual/_sisu/sisu_document_make b/data/doc/sisu/markup-samples/manual/_sisu/sisu_document_make
index 72706d10..72706d10 100644
--- a/data/doc/sisu/markup-samples/sisu_manual/_sisu/sisu_document_make
+++ b/data/doc/sisu/markup-samples/manual/_sisu/sisu_document_make
diff --git a/data/doc/sisu/markup-samples/sisu_manual/_sisu/v5/sisurc.yml b/data/doc/sisu/markup-samples/manual/_sisu/v5/sisurc.yml
index e492f789..e492f789 120000
--- a/data/doc/sisu/markup-samples/sisu_manual/_sisu/v5/sisurc.yml
+++ b/data/doc/sisu/markup-samples/manual/_sisu/v5/sisurc.yml
diff --git a/data/doc/sisu/markup-samples/sisu_manual/_sisu/v6/sisurc.yml b/data/doc/sisu/markup-samples/manual/_sisu/v6/sisurc.yml
index e492f789..e492f789 120000
--- a/data/doc/sisu/markup-samples/sisu_manual/_sisu/v6/sisurc.yml
+++ b/data/doc/sisu/markup-samples/manual/_sisu/v6/sisurc.yml
diff --git a/data/doc/sisu/markup-samples/manual/en/README.ssm b/data/doc/sisu/markup-samples/manual/en/README.ssm
new file mode 100644
index 00000000..fc67fdb8
--- /dev/null
+++ b/data/doc/sisu/markup-samples/manual/en/README.ssm
@@ -0,0 +1,39 @@
+% SiSU master 5.0
+
+@title: SiSU
+ :subtitle: README
+
+@creator:
+ :author: Amissah, Ralph
+
+@date:
+ :published: 2014-02-02
+ :created: 2014-02-02
+ :available: 2014-02-02
+ :modified: 2014-02-02
+
+@rights:
+ :copyright: Copyright (C) Ralph Amissah 2014
+ :license: GPL 3 (part of SiSU documentation)
+
+@classify:
+ :topic_register: SiSU:manual;electronic documents:SiSU:README
+ :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search
+
+:A~ @title
+
+:B~ Introduction
+
+<< sisu_introduction.sst
+
+:B~ Install or Run without Installation
+
+<< sisu_install_run.sst
+
+:B~ Commands
+
+<< sisu_commands.sst
+:B~ Markup
+
+<< sisu_markup.sst
+
diff --git a/data/doc/sisu/markup-samples/sisu_manual/en/sisu.ssm b/data/doc/sisu/markup-samples/manual/en/sisu.ssm
index 79703fef..c8260858 100644
--- a/data/doc/sisu/markup-samples/sisu_manual/en/sisu.ssm
+++ b/data/doc/sisu/markup-samples/manual/en/sisu.ssm
@@ -1,4 +1,4 @@
-% SiSU master 4.0
+% SiSU master 5.0
@title: SiSU
:subtitle: Manual
@@ -11,7 +11,7 @@
:created: 2002-08-28
:issued: 2002-08-28
:available: 2002-08-28
- :modified: 2012-10-03
+ :modified: 2014-02-05
@rights:
:copyright: Copyright (C) Ralph Amissah 2012
diff --git a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_commands.sst b/data/doc/sisu/markup-samples/manual/en/sisu_commands.sst
index 2ca43a43..be491bf8 100644
--- a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_commands.sst
+++ b/data/doc/sisu/markup-samples/manual/en/sisu_commands.sst
@@ -1,4 +1,4 @@
-% SiSU 4.0
+% SiSU 5.0
@title: SiSU
:subtitle: Commands
@@ -11,7 +11,7 @@
:issued: 2002-08-28
:available: 2002-08-28
:published: 2007-09-16
- :modified: 2012-10-03
+ :modified: 2014-02-05
@rights:
:copyright: Copyright (C) Ralph Amissah 2012
@@ -159,6 +159,9 @@ produces html output, the document in a single file (scroll.html) only. Compare
!_ --html-seg [filename/wildcard] \\
produces html output, segmented text with table of contents (toc.html and index.html). Compare --html-scroll and --html
+!_ --html-strict [filename/wildcard] \\
+produces html with --strict option. see --strict
+
!_ -I [filename/wildcard] \\
see --texinfo
@@ -221,6 +224,9 @@ see --exc-*
!_ -o [filename/wildcard/url] \\
see --odt
+!_ --ocn \\
+see --inc-ocn and --exc-ocn
+
!_ --odf [filename/wildcard/url] \\
see --odt
@@ -324,6 +330,9 @@ produces a zipped file of the prepared document specified along with associated
!_ --source [filename/wildcard] \\
copies sisu markup file to output directory. Alias -s
+!_ --strict \\
+together with --html, produces more w3c compliant html, for example not having purely numeric identifiers for text, the location object url#33 becomes url#o33
+
!_ -T [filename/wildcard (*.termsheet.rb)] \\
standard form document builder, preprocessing feature
diff --git a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_config.ssi b/data/doc/sisu/markup-samples/manual/en/sisu_config.ssi
index 3c29f995..3c29f995 100644
--- a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_config.ssi
+++ b/data/doc/sisu/markup-samples/manual/en/sisu_config.ssi
diff --git a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_content_directories.ssi b/data/doc/sisu/markup-samples/manual/en/sisu_content_directories.ssi
index 182b176d..182b176d 100644
--- a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_content_directories.ssi
+++ b/data/doc/sisu/markup-samples/manual/en/sisu_content_directories.ssi
diff --git a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_css.ssi b/data/doc/sisu/markup-samples/manual/en/sisu_css.ssi
index 7ffc654b..7ffc654b 100644
--- a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_css.ssi
+++ b/data/doc/sisu/markup-samples/manual/en/sisu_css.ssi
diff --git a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_description.sst b/data/doc/sisu/markup-samples/manual/en/sisu_description.sst
index 9f8fdcd8..128bfe1e 100644
--- a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_description.sst
+++ b/data/doc/sisu/markup-samples/manual/en/sisu_description.sst
@@ -1,4 +1,4 @@
-% SiSU 4.0
+% SiSU 5.0
@title: SiSU - SiSU information Structuring Universe / Structured information, Serialized Units
:subtitle: Description
@@ -11,7 +11,7 @@
:issued: 2002-11-12
:available: 2002-11-12
:published: 2007-08-30
- :modified: 2012-10-03
+ :modified: 2014-02-05
@rights:
:copyright: Copyright (C) Ralph Amissah 2007
@@ -29,6 +29,26 @@
2~ Outline
+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~{ 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. }~ (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~{ i.e. the HTML, PDF, EPUB, ODT outputs are each built individually and optimised for that form of presentation, rather than for example the html being a saved version of the odf, or the pdf being a saved version of the html. }~ the different forms of output requested.
+
+SiSU works with an abstraction of the document based on its structure which is comprised of its headings~{ the different heading levels }~ and objects~{ units of text, primarily paragraphs and headings, also any tables, poems, code-blocks }~, 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,~{ An open standard format for e-books }~ ODT,~{ Open Document Format (ODF) text }~ PDF~{ Specification submitted by Adobe to ISO to become a full open ISO specification \\ http://www.linux-watch.com/news/NS7542722606.html }~ ODF,~{ ISO standard ISO/IEC 26300:2006 }~. 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).
+
+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.
+
+% SiSU is a way of preparing, publishing, managing and searching documents.
+
SiSU is a flexible document preparation, generation publishing and search system.~{ This information was first placed on the web 12 November 2002; with predating material taken from http://www.jus.uio.no/lm/lm.information/toc.html part of a site started and developed since 1993. See document metadata section http://www.jus.uio.no/sisu/SiSU/metadata.html or manifest page http://www.jus.uio.no/sisu/SiSU/sisu_manifest.html for information on this version. Dates related to the development of SiSU may be tracked in the http://www.jus.uio.no/sisu/SiSU/changelog.html or the Git repository http://git.sisudoc.org/?p=code/sisu.git;a=summary some of the more significant events may be contained within the Chronology section of this document http://www.jus.uio.no/sisu/sisu_chronology }~
SiSU ("SiSU information Structuring Universe" or "Structured information, Serialized Units"),~{ also chosen for the meaning of the Finnish term "sisu". }~ is a Unix command line oriented framework for document structuring, publishing and search. Featuring minimalistic markup, multiple standard outputs, a common citation system, and granular search.
diff --git a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_download.ssi b/data/doc/sisu/markup-samples/manual/en/sisu_download.ssi
index 96c97985..96c97985 100644
--- a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_download.ssi
+++ b/data/doc/sisu/markup-samples/manual/en/sisu_download.ssi
diff --git a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_examples.ssi b/data/doc/sisu/markup-samples/manual/en/sisu_examples.ssi
index cf9df9d5..cf9df9d5 100644
--- a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_examples.ssi
+++ b/data/doc/sisu/markup-samples/manual/en/sisu_examples.ssi
diff --git a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_faq.sst b/data/doc/sisu/markup-samples/manual/en/sisu_faq.sst
index 966cea5f..966cea5f 100644
--- a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_faq.sst
+++ b/data/doc/sisu/markup-samples/manual/en/sisu_faq.sst
diff --git a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_filetypes.sst b/data/doc/sisu/markup-samples/manual/en/sisu_filetypes.sst
index d36acac0..d36acac0 100644
--- a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_filetypes.sst
+++ b/data/doc/sisu/markup-samples/manual/en/sisu_filetypes.sst
diff --git a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_help.sst b/data/doc/sisu/markup-samples/manual/en/sisu_help.sst
index 69535085..69535085 100644
--- a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_help.sst
+++ b/data/doc/sisu/markup-samples/manual/en/sisu_help.sst
diff --git a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_help_sources.sst b/data/doc/sisu/markup-samples/manual/en/sisu_help_sources.sst
index bee5ed78..bee5ed78 100644
--- a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_help_sources.sst
+++ b/data/doc/sisu/markup-samples/manual/en/sisu_help_sources.sst
diff --git a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_homepages.ssi b/data/doc/sisu/markup-samples/manual/en/sisu_homepages.ssi
index 3d8d95d5..3d8d95d5 100644
--- a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_homepages.ssi
+++ b/data/doc/sisu/markup-samples/manual/en/sisu_homepages.ssi
diff --git a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_how.ssi b/data/doc/sisu/markup-samples/manual/en/sisu_how.ssi
index 3372bcd4..3372bcd4 100644
--- a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_how.ssi
+++ b/data/doc/sisu/markup-samples/manual/en/sisu_how.ssi
diff --git a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_howto.sst b/data/doc/sisu/markup-samples/manual/en/sisu_howto.sst
index 4a23bdfe..4a23bdfe 100644
--- a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_howto.sst
+++ b/data/doc/sisu/markup-samples/manual/en/sisu_howto.sst
diff --git a/data/doc/sisu/markup-samples/manual/en/sisu_install_run.sst b/data/doc/sisu/markup-samples/manual/en/sisu_install_run.sst
new file mode 100644
index 00000000..dfd56ec8
--- /dev/null
+++ b/data/doc/sisu/markup-samples/manual/en/sisu_install_run.sst
@@ -0,0 +1,186 @@
+% SiSU insert 5.0
+
+@title: SiSU
+ :subtitle: Installation
+
+@creator:
+ :author: Amissah, Ralph
+
+@date:
+ :published: 2007-09-16
+ :created: 2002-11-12
+ :issued: 2002-11-12
+ :available: 2002-11-12
+ :modified: 2014-02-05
+
+@rights:
+ :copyright: Copyright (C) Ralph Amissah 2007
+ :license: GPL 3 (part of SiSU documentation)
+
+:A~? SiSU Installation notes
+
+1~source_tarball Source tarball
+
+2~ run off source package directory tree (without installing)
+
+1. Download the latest source (information available) from: http://www.jus.uio.no/sisu/SiSU/download.html#current
+
+2. Unpack the source
+
+Provided you have Ruby, SiSU can be run without installation straight from the source package directory tree. Run ruby against the full path to bin/sisu (in the unzipped source package directory tree)
+
+Note however, that additional external package dependencies, such as texlive (for pdfs), sqlite3 or postgresql (for search) should you desire to use them are not taken care of for you.
+
+2~ Gem install (with rake)
+
+Gem install, you need to:
+
+(i) create the gemspec; (ii) build the gem (from the gemspec); (iii) install the gem
+
+Provided you have ruby & rake, this can be done with the single command:
+
+_1 rake gem_create_build_install # (to build and install sisu v5 & sisu v6, alias gemcbi)
+
+separate gems are made/installed for sisu v5 & sisu v6 contained in source:
+
+_1 rake gem_create_build_install_stable # (to build and install sisu v5, alias gem5cbi)
+
+_1 rake gem_create_build_install_unstable # (to build and install sisu v6, alias gem6cbi)
+
+for individual steps (create, build, install) see rake options, rake -T
+to specify sisu version for sisu installed via gem
+
+_1 sisu _5.3.0_ --version
+
+_1 sisu _6.0.0_ --version
+
+to uninstall sisu installed via gem
+
+_1 sudo gem uninstall --verbose sisu
+
+For a list of alternative actions you may type:
+
+_1 rake help
+
+_1 rake -T
+
+Rake: http://rake.rubyforge.org/ http://rubyforge.org/frs/?group_id=50
+
+Rant: http://make.rubyforge.org/ http://rubyforge.org/frs/?group_id=615
+
+2~ installation with setup.rb
+
+It should also be possible to install sisu using setup.rb
+
+this is a three step process, in the root directory of the unpacked SiSU as root type:
+
+``` code
+ruby setup.rb config
+ruby setup.rb setup
+#[as root:]
+ruby setup.rb install
+```
+
+further information: \\
+http://i.loveruby.net/en/projects/setup/ \\
+http://i.loveruby.net/en/projects/setup/doc/usage.html
+
+_1 ruby setup.rb config && ruby setup.rb setup && sudo ruby setup.rb install
+
+1~distribution_install Unix/Linux Distribution
+
+A distribution install should take care of the dependencies of sisu for producing various outputs.
+
+2~ Debian
+
+SiSU is available off the Debian archives. It should necessary only to run as root, Using apt-get:
+
+code{
+
+ apt-get update
+
+ apt get install sisu-complete
+
+}code
+
+(all sisu dependencies should be taken care of)
+
+If there are newer versions of SiSU upstream, they will be available by
+adding the following to your sources list /etc/apt/sources.list *~sources.list
+
+code{
+
+#/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
+
+}code
+
+The non-free section is for sisu markup samples provided, which contain authored works the substantive text of which cannot be changed, and which as a result do not meet the debian free software guidelines.
+
+SiSU is developed on Debian, and packages are available for Debian that take care of the dependencies encountered on installation.
+
+The package is divided into the following components:
+
+_1 *sisu*, the base code, (the main package on which the others depend), without any dependencies other than ruby (and for convenience the ruby webrick web server), this generates a number of types of output on its own, other packages provide additional functionality, and have their dependencies
+
+_1 *sisu-complete*, a dummy package that installs the whole of greater sisu as described below, apart from sisu-examples
+
+_1 *sisu-pdf*, dependencies used by sisu to produce pdf from LaTeX generated
+
+_1 *sisu-postgresql*, dependencies used by sisu to populate postgresql database (further configuration is necessary)
+
+_1 *sisu-sqlite*, dependencies used by sisu to populate sqlite database
+
+_1 *sisu-markup-samples*, sisu markup samples and other miscellany (under Debian Free Software Guidelines non-free)
+
+SiSU is available off { Debian Unstable and Testing }http://packages.debian.org/cgi-bin/search_packages.pl?searchon=names&subword=1&version=all&release=all&keywords=sisu ~{ http://packages.qa.debian.org/s/sisu.html }~ install it using apt-get, aptitude or alternative Debian install tools. *~apt-get
+
+1~dependencies Dependencies
+
+Here is a list of sisu's current dependencies,~{from the Debian control file}~ which depend on such factors as whether you want to generate pdf, whether you will be using SiSU with or without a database, ...). sisu_markup-samples may also be of interest.
+
+``` code
+Package: sisu
+Depends: ruby | ruby-interpreter, openssl, rsync, unzip, zip
+Recommends: sisu-pdf, sisu-sqlite, sisu-postgresql, imagemagick |
+graphicsmagick, keychain, openssh-client | lsh-client, po4a, qrencode, rake,
+ruby-rmagick, tidy, tree, vim-addon-manager
+Suggests: lv, calibre, pinfo, poedit, texinfo, trang
+```
+
+``` code
+Package: sisu-complete
+Depends: ruby | ruby-interpreter, sisu (= ${source:Version}), sisu-pdf (=
+${source:Version}), sisu-postgresql (= ${source:Version}), sisu-sqlite (=
+${source:Version})
+Description-en: installs all SiSU related packages
+```
+
+``` code
+Package: sisu-pdf
+Depends: ruby | ruby-interpreter, sisu (= ${source:Version}),
+texlive-latex-base, texlive-fonts-recommended, texlive-generic-recommended,
+texlive-latex-recommended, texlive-latex-extra, texlive-math-extra,
+texlive-xetex, fonts-liberation, lmodern, latex-cjk-all, texlive-lang-cjk
+Suggests: evince | pdf-viewer
+```
+
+``` code
+Package: sisu-postgresql
+Depends: ruby | ruby-interpreter, sisu (= ${source:Version}), postgresql,
+ruby-dbd-pg, ruby-dbi, ruby-fcgi
+Suggests: postgresql-contrib
+```
+
+``` code
+Package: sisu-sqlite
+Depends: ruby | ruby-interpreter, sisu (= ${source:Version}), sqlite3,
+ruby-sqlite3, ruby-dbd-sqlite3, ruby-dbi, ruby-fcgi
+```
+
+``` code
+Package: sisu-markup-samples
+Depends: sisu
+```
diff --git a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_installation.ssi b/data/doc/sisu/markup-samples/manual/en/sisu_installation.ssi
index f908bb6e..f908bb6e 100644
--- a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_installation.ssi
+++ b/data/doc/sisu/markup-samples/manual/en/sisu_installation.ssi
diff --git a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_interesting_to_whom.ssi b/data/doc/sisu/markup-samples/manual/en/sisu_interesting_to_whom.ssi
index 750c46ea..750c46ea 100644
--- a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_interesting_to_whom.ssi
+++ b/data/doc/sisu/markup-samples/manual/en/sisu_interesting_to_whom.ssi
diff --git a/data/doc/sisu/markup-samples/manual/en/sisu_introduction.sst b/data/doc/sisu/markup-samples/manual/en/sisu_introduction.sst
new file mode 100644
index 00000000..1fc14d9a
--- /dev/null
+++ b/data/doc/sisu/markup-samples/manual/en/sisu_introduction.sst
@@ -0,0 +1,43 @@
+% SiSU 5.0
+
+@title: SiSU
+ :subtitle: Introduction
+
+@creator:
+ :author: Amissah, Ralph
+
+@date:
+ :published: 2007-09-16
+ :created: 2002-08-28
+ :issued: 2002-08-28
+ :available: 2002-08-28
+ :modified: 2014-02-05
+
+@rights:
+ :copyright: Copyright (C) Ralph Amissah 2011
+ :license: GPL 3 (part of SiSU documentation)
+
+@classify:
+ :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search
+
+:A~? @title @creator
+
+:B~? What is SiSU?
+
+1~sisu_intro Introduction - What is SiSU?
+
+SiSU is a lightweight markup based document creation and publishing framework that is controlled from the command line. Prepare documents for SiSU using your text editor of choice, then use SiSU to generate various output document formats.
+
+From a single lightly prepared document (plain-text UTF-8) 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. SiSU produces: plain-text, HTML, XHTML, XML, EPUB, ODF:ODT (Opendocument), LaTeX, PDF, and populates an SQL database (PostgreSQL or SQLite) with text objects, roughly, paragraph sized chunks so that document searches are done at this level of granularity.
+
+Outputs share a common citation numbering system, associated with text objects and any semantic meta-data provided about the document.
+
+SiSU also provides concordance files, document content certificates and manifests of generated output. Book indexes may be made.
+
+Some document markup samples are provided in the package sisu-markup-samples.
+
+``` group
+Homepages:
+* http://www.sisudoc.org/
+* http://www.jus.uio.no/sisu
+```
diff --git a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_manual.ssm b/data/doc/sisu/markup-samples/manual/en/sisu_manual.ssm
index 90e8a323..46d80198 100644
--- a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_manual.ssm
+++ b/data/doc/sisu/markup-samples/manual/en/sisu_manual.ssm
@@ -1,4 +1,4 @@
-% SiSU master 4.0
+% SiSU master 5.0
@title: SiSU
:subtitle: Manual
@@ -11,7 +11,7 @@
:created: 2002-08-28
:issued: 2002-08-28
:available: 2002-08-28
- :modified: 2012-10-03
+ :modified: 2014-02-05
@rights:
:copyright: Copyright (C) Ralph Amissah 2007
@@ -77,7 +77,7 @@
<< sisu_download.ssi
-<< sisu_installation.ssi
+<< sisu_install_run.sst
<< sisu_quickstart.sst
diff --git a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_markup.sst b/data/doc/sisu/markup-samples/manual/en/sisu_markup.sst
index 69293637..69293637 100644
--- a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_markup.sst
+++ b/data/doc/sisu/markup-samples/manual/en/sisu_markup.sst
diff --git a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_markup_syntax_history.sst b/data/doc/sisu/markup-samples/manual/en/sisu_markup_syntax_history.sst
index c6da0a14..c6da0a14 100644
--- a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_markup_syntax_history.sst
+++ b/data/doc/sisu/markup-samples/manual/en/sisu_markup_syntax_history.sst
diff --git a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_output_overview.sst b/data/doc/sisu/markup-samples/manual/en/sisu_output_overview.sst
index 332f4aae..332f4aae 100644
--- a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_output_overview.sst
+++ b/data/doc/sisu/markup-samples/manual/en/sisu_output_overview.sst
diff --git a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_postgresql.sst b/data/doc/sisu/markup-samples/manual/en/sisu_postgresql.sst
index 574e307c..574e307c 100644
--- a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_postgresql.sst
+++ b/data/doc/sisu/markup-samples/manual/en/sisu_postgresql.sst
diff --git a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_quickstart.sst b/data/doc/sisu/markup-samples/manual/en/sisu_quickstart.sst
index ae95f528..ae95f528 100644
--- a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_quickstart.sst
+++ b/data/doc/sisu/markup-samples/manual/en/sisu_quickstart.sst
diff --git a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_remote.sst b/data/doc/sisu/markup-samples/manual/en/sisu_remote.sst
index 959fbcf6..959fbcf6 100644
--- a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_remote.sst
+++ b/data/doc/sisu/markup-samples/manual/en/sisu_remote.sst
diff --git a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_search.ssm b/data/doc/sisu/markup-samples/manual/en/sisu_search.ssm
index 9c40a8bf..9c40a8bf 100644
--- a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_search.ssm
+++ b/data/doc/sisu/markup-samples/manual/en/sisu_search.ssm
diff --git a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_search_cgi.ssi b/data/doc/sisu/markup-samples/manual/en/sisu_search_cgi.ssi
index 03eef9ff..03eef9ff 100644
--- a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_search_cgi.ssi
+++ b/data/doc/sisu/markup-samples/manual/en/sisu_search_cgi.ssi
diff --git a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_search_intro.ssi b/data/doc/sisu/markup-samples/manual/en/sisu_search_intro.ssi
index d5da379f..d5da379f 100644
--- a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_search_intro.ssi
+++ b/data/doc/sisu/markup-samples/manual/en/sisu_search_intro.ssi
diff --git a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_short_feature_summary.ssi b/data/doc/sisu/markup-samples/manual/en/sisu_short_feature_summary.ssi
index 294644af..294644af 100644
--- a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_short_feature_summary.ssi
+++ b/data/doc/sisu/markup-samples/manual/en/sisu_short_feature_summary.ssi
diff --git a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_sql.ssi b/data/doc/sisu/markup-samples/manual/en/sisu_sql.ssi
index 6e54275b..6e54275b 100644
--- a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_sql.ssi
+++ b/data/doc/sisu/markup-samples/manual/en/sisu_sql.ssi
diff --git a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_sqlite.sst b/data/doc/sisu/markup-samples/manual/en/sisu_sqlite.sst
index a73ae16c..a73ae16c 100644
--- a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_sqlite.sst
+++ b/data/doc/sisu/markup-samples/manual/en/sisu_sqlite.sst
diff --git a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_synopsis.ssi b/data/doc/sisu/markup-samples/manual/en/sisu_synopsis.ssi
index 98e5d4f3..98e5d4f3 100644
--- a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_synopsis.ssi
+++ b/data/doc/sisu/markup-samples/manual/en/sisu_synopsis.ssi
diff --git a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_syntax_highlighting.sst b/data/doc/sisu/markup-samples/manual/en/sisu_syntax_highlighting.sst
index ef881aae..ef881aae 100644
--- a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_syntax_highlighting.sst
+++ b/data/doc/sisu/markup-samples/manual/en/sisu_syntax_highlighting.sst
diff --git a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_webrick.sst b/data/doc/sisu/markup-samples/manual/en/sisu_webrick.sst
index 6e56e53a..6e56e53a 100644
--- a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_webrick.sst
+++ b/data/doc/sisu/markup-samples/manual/en/sisu_webrick.sst
diff --git a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_work_needed_and_wishlist.ssi b/data/doc/sisu/markup-samples/manual/en/sisu_work_needed_and_wishlist.ssi
index 20e774ac..20e774ac 100644
--- a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_work_needed_and_wishlist.ssi
+++ b/data/doc/sisu/markup-samples/manual/en/sisu_work_needed_and_wishlist.ssi
diff --git a/data/doc/sisu/markup-samples/sisu_manual/translation_languages b/data/doc/sisu/markup-samples/manual/translation_languages
index d84a94e8..d84a94e8 100644
--- a/data/doc/sisu/markup-samples/sisu_manual/translation_languages
+++ b/data/doc/sisu/markup-samples/manual/translation_languages
diff --git a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_introduction.sst b/data/doc/sisu/markup-samples/sisu_manual/en/sisu_introduction.sst
deleted file mode 100644
index 8978ace6..00000000
--- a/data/doc/sisu/markup-samples/sisu_manual/en/sisu_introduction.sst
+++ /dev/null
@@ -1,55 +0,0 @@
-% SiSU 4.0
-
-@title: SiSU
- :subtitle: Introduction
-
-@creator:
- :author: Amissah, Ralph
-
-@date:
- :published: 2007-09-16
- :created: 2002-08-28
- :issued: 2002-08-28
- :available: 2002-08-28
- :modified: 2012-10-03
-
-@rights:
- :copyright: Copyright (C) Ralph Amissah 2011
- :license: GPL 3 (part of SiSU documentation)
-
-@classify:
- :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search
-
-:A~? @title @creator
-
-:B~? What is SiSU?
-
-:C~? Description
-
-1~sisu_intro 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~{ 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. }~ (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~{ i.e. the HTML, PDF, EPUB, ODT outputs are each built individually and optimised for that form of presentation, rather than for example the html being a saved version of the odf, or the pdf being a saved version of the html. }~ the different forms of output requested.
-
-SiSU works with an abstraction of the document based on its structure which is comprised of its headings~{ the different heading levels }~ and objects~{ units of text, primarily paragraphs and headings, also any tables, poems, code-blocks }~, 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,~{ An open standard format for e-books }~ ODT,~{ Open Document Format (ODF) text }~ PDF~{ Specification submitted by Adobe to ISO to become a full open ISO specification <br> http://www.linux-watch.com/news/NS7542722606.html }~ ODF,~{ ISO standard ISO/IEC 26300:2006 }~. 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
-
-% SiSU is a way of preparing, publishing, managing and searching documents.
diff --git a/data/sisu/v5/v/version.yml b/data/sisu/v5/v/version.yml
index 61977c11..f5c89bbf 100644
--- a/data/sisu/v5/v/version.yml
+++ b/data/sisu/v5/v/version.yml
@@ -1,5 +1,5 @@
---
:project: SiSU
-:version: 5.3.0
-:date_stamp: 2014w03/7
-:date: "2014-01-26"
+:version: 5.3.1
+:date_stamp: 2014w05/3
+:date: "2014-02-05"
diff --git a/data/sisu/v6/v/version.yml b/data/sisu/v6/v/version.yml
index fef96251..109b2123 100644
--- a/data/sisu/v6/v/version.yml
+++ b/data/sisu/v6/v/version.yml
@@ -1,5 +1,5 @@
---
:project: SiSU
-:version: 6.0.0
-:date_stamp: 2014w03/7
-:date: "2014-01-26"
+:version: 6.0.1
+:date_stamp: 2014w05/3
+:date: "2014-02-05"
diff --git a/lib/sisu/v5/ao_doc_str.rb b/lib/sisu/v5/ao_doc_str.rb
index f7168c26..dd7f32f3 100644
--- a/lib/sisu/v5/ao_doc_str.rb
+++ b/lib/sisu/v5/ao_doc_str.rb
@@ -163,10 +163,13 @@ module SiSU_AO_DocumentStructureExtract
str=str.gsub(/(^|[ ])\*~([a-z0-9._-]+)(?=[ #{Mx[:br_nl]}]|$)/i,
"\\1#{Mx[:tag_o]}\\2#{Mx[:tag_c]}").
gsub(/ [ ]+/i,' ')
- tags=str.scan(/#{Mx[:tag_o]}(\S+?)#{Mx[:tag_c]}/).flatten
+ tags=str.scan(/#{Mx[:tag_o]}(\S+?)#{Mx[:tag_c]}/).flatten.uniq
str=str.gsub(/[ ]?#{Mx[:tag_o]}\S+?#{Mx[:tag_c]}[ ]?/,' ') #may be issues with spaces would leave one, but "code" blocks?
end
tags=nametag ? (tags << nametag) : tags
+ tags.each do |t|
+ t.gsub!(/[^a-z0-9._-]/,'')
+ end
end
[str,tags]
end
diff --git a/lib/sisu/v5/ao_hash_digest.rb b/lib/sisu/v5/ao_hash_digest.rb
index 585ff659..3f372893 100644
--- a/lib/sisu/v5/ao_hash_digest.rb
+++ b/lib/sisu/v5/ao_hash_digest.rb
@@ -75,7 +75,11 @@ module SiSU_AO_Hash
data=@data.compact
@tuned_file=[]
sha_ =(@env.digest.type=='sha256' ? true : false)
- sha_ ? (require 'digest/sha2') : (require 'digest/md5')
+ begin
+ sha_ ? (require 'digest/sha2') : (require 'digest/md5')
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error((sha_ ? 'digest/sha2' : 'digest/md5') + ' NOT FOUND')
+ end
data.each do |t_o|
unless t_o.obj.is_a?(Array)
t_o.obj=t_o.obj.strip
diff --git a/lib/sisu/v5/ao_images.rb b/lib/sisu/v5/ao_images.rb
index ab42034d..d01c98b8 100644
--- a/lib/sisu/v5/ao_images.rb
+++ b/lib/sisu/v5/ao_images.rb
@@ -62,8 +62,12 @@
=end
module SiSU_AO_Images
class Images
- #require 'RMagick'
- #include Magick
+ #begin
+ # require 'RMagick'
+ # include Magick
+ #rescue LoadError
+ # SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('RMagic NOT FOUND (LoadError)')
+ #end
def initialize(md,data)
@md,@data=md,data
end
diff --git a/lib/sisu/v5/ao_numbering.rb b/lib/sisu/v5/ao_numbering.rb
index 8caa5ccc..984675cc 100644
--- a/lib/sisu/v5/ao_numbering.rb
+++ b/lib/sisu/v5/ao_numbering.rb
@@ -78,6 +78,14 @@ module SiSU_AO_Numbering
data=set_heading_top(data) unless @md.set_heading_top
[data,tags_map,ocn_html_seg_map]
end
+ def set_tags(tags,tag)
+ tags=if not tag.empty? \
+ and tag !~/^\d+$/
+ tag=tag.gsub(/[^a-z0-9._-]/,'')
+ [tag,tags].flatten
+ else tags
+ end
+ end
def number_plaintext_para(data)
@tuned_file=[]
data.each do |dob|
@@ -168,10 +176,10 @@ module SiSU_AO_Numbering
and not @md.seg_names.include?(title_no)
if dob.ln==no1
dob.name="#{title_no}" if not dob.name
- dob.tags=[title_no,dob.tags].flatten if title_no !~/^\d+$/ #check whether will work across file types with stop signs
+ dob.tags=set_tags(dob.tags,title_no)
tag=dob.obj.gsub(/(Article|Clause|Section|Chapter)\s+/,"\\1_#{title_no}").downcase
tag=heading_tag_clean(tag)
- dob.tags=[tag,dob.tags].flatten if tag !~/^\d+$/ #check whether will work across file types with stop signs
+ dob.tags=set_tags(dob.tags,tag)
dob.obj=(dob.obj =~/(Article|Clause|Section)\s+/) \
? (dob.obj.gsub(/(Article|Clause|Section)\s+/,"\\1 #{title_no} "))
: (dob.obj.gsub(/^/,"#{title_no}. ")) #fix stop later
@@ -179,7 +187,7 @@ module SiSU_AO_Numbering
if dob.ln !=no1 \
and dob.obj =~/^[\d.]+\s/ #fix -> if the title starts with a numbering scheme, do not auto-number, review
dob.name ="#{title_no}" if not dob.name
- dob.tags=[title_no,dob.tags].flatten if title_no !~/^\d+$/ #check whether will work across file types with stop signs
+ dob.tags=set_tags(dob.tags,title_no)
dob.obj=dob.obj.gsub(/^/,"#{title_no}. ")
end
@md.seg_names << title_no
@@ -187,28 +195,28 @@ module SiSU_AO_Numbering
if dob.ln!=no1 \
and dob.name!~/^[a-z_\.]+$/ \
and dob.obj !~/[A-Z]\.?\s/ #bug -> tmp fix, excludes A. B. C. lettering, but not roman numerals, is arbitrary, review required # not fixed, work on
- dob.tags=[title_no,dob.tags].flatten if title_no !~/^\d+$/ #check whether will work across file types with stop signs
+ dob.tags=set_tags(dob.tags,title_no)
dob.obj=dob.obj.gsub(/^/i,"#{title_no}. ")
end
end
if dob.ln==no1 #watch because here you change dob.name
- dob.tags=["h#{title_no}",dob.tags].flatten #check whether will work across file types with stop signs
+ dob.tags=set_tags(dob.tags,"h#{title_no}")
end
if dob.ln==no2 #watch because here you change dob.name
t_no2+=1; t_no3=0
title_no="#{t_no1}.#{t_no2}"
- dob.tags=["h#{title_no}",dob.tags].flatten #check whether will work across file types with stop signs
+ dob.tags=set_tags(dob.tags,"h#{title_no}")
dob=number_sub_heading(dob,no2,title_no)
end
if dob.ln==no3 #watch because here you change dob.name
t_no3+=1
title_no="#{t_no1}.#{t_no2}.#{t_no3}"
- dob.tags=["h#{title_no}",dob.tags].flatten #check whether will work across file types with stop signs
+ dob.tags=set_tags(dob.tags,"h#{title_no}")
dob=number_sub_heading(dob,no3,title_no)
end
elsif dob.ln.to_s =~/^[0-6]/ \
and dob.name =~ /^[\w-]+-/ # endnotes, watch2005# endnotes, watch2005
- dob.tags=[dob.name,dob.tags].flatten if dob.name !~/^\d+$/ #check whether will work across file types with stop signs
+ dob.tags=set_tags(dob.tags,dob.name)
dob.name.gsub(/^([a-z_\.]+)-$/,'\1')
end
elsif dob.is ==:heading \
@@ -219,13 +227,13 @@ module SiSU_AO_Numbering
and dob.ln.to_s =~/^[0-9]/ \
and dob.obj =~ /^([\d\.]+)/ #risky (must be unique) consider output to 4~~\d instead of 4~\d
dob.name=$1
- dob.tags=[dob.name,dob.tags].flatten if dob.name !~/^\d+$/ #check whether will work across file types with stop signs
+ dob.tags=set_tags(dob.tags,dob.name)
end
if @md.toc_lev_limit
end
elsif defined? dob.name \
and dob.name
- dob.tags=[dob.name,dob.tags].flatten if dob.name !~/^\d+$/ #check whether will work across file types with stop signs
+ dob.tags=set_tags(dob.tags,dob.name)
end
dob.tags=dob.tags.uniq if defined? dob.tags
@tuned_file << dob
@@ -312,7 +320,7 @@ module SiSU_AO_Numbering
if @md.seg_names.is_a?(Array) \
and not @md.seg_names.include?(possible_seg_name)
dob.name=possible_seg_name
- dob.tags=[dob.name,dob.tags].flatten if dob.name !~/^\d+$/
+ dob.tags=set_tags(dob.tags,dob.name)
@md.seg_names << possible_seg_name
elsif (@md.opt.act[:verbose_plus][:set]==:on \
or @md.opt.act[:maintenance][:set]==:on)
@@ -323,7 +331,7 @@ module SiSU_AO_Numbering
and dob.name #extract segment name from embedded document structure info
if @md.seg_names.is_a?(Array) \
and not @md.seg_names.include?(dob.name)
- dob.tags=[dob.name,dob.tags].flatten if dob.name !~/^\d+$/
+ dob.tags=set_tags(dob.tags,dob.name)
@md.seg_names << dob.name
end
end
@@ -334,7 +342,7 @@ module SiSU_AO_Numbering
if @md.seg_names.is_a?(Array) \
and not @md.seg_names.include?(segn_auto)
dob.name=segn_auto
- dob.tags=[dob.name,dob.tags].flatten if dob.name !~/^\d+$/ #check whether will work across file types with stop signs
+ dob.tags=set_tags(dob.tags,dob.name)
@md.seg_names << segn_auto
else puts 'segment name (numbering) error'
end
diff --git a/lib/sisu/v5/cgi_pgsql.rb b/lib/sisu/v5/cgi_pgsql.rb
index 33e43b46..4281d9d3 100644
--- a/lib/sisu/v5/cgi_pgsql.rb
+++ b/lib/sisu/v5/cgi_pgsql.rb
@@ -74,12 +74,12 @@ module SiSU_CGI_PgSQL
get_init=SiSU_Env::GetInit.new
@rc=get_init.sisu_yaml.rc
@name_of={}
- @name_of[:output_dir_structure]=if @opt.dir_structure_by.to_s =~/(?:language|filetype|filename)/
- @opt.dir_structure_by.to_s
+ @name_of[:output_dir_structure]=if opt.dir_structure_by.to_s =~/(?:language|filetype|filename)/
+ opt.dir_structure_by.to_s
else 'language'
end
- @name_of[:lingual]=if @opt.lingual.to_s =~/(?:mono|multi)/
- @opt.lingual.to_s
+ @name_of[:lingual]=if opt.lingual.to_s =~/(?:mono|multi)/
+ opt.lingual.to_s
else 'multi'
end
if defined? @rc['search'] \
@@ -93,13 +93,13 @@ module SiSU_CGI_PgSQL
@name_of[:db]=@env.path.stub_pwd #'sisu' #breaks if not present
false
end
- @name_of[:host_url_cgi]="#{@env.url.webserv_base_cgi(@opt)}/cgi-bin"
- @name_of[:host_url_docs]=@env.url.webserv_files_from_db(@opt)
- @name_of[:cgi_script]=@env.url.cgi_sample_search_form_name(@opt)
- @name_of[:user]=@db.psql.user(@opt)
+ @name_of[:host_url_cgi]="#{@env.url.webserv_base_cgi(opt)}/cgi-bin"
+ @name_of[:host_url_docs]=@env.url.webserv_files_from_db(opt)
+ @name_of[:cgi_script]=@env.url.cgi_sample_search_form_name(opt)
+ @name_of[:user]=@db.psql.user(opt)
@cgi_file_name=@name_of[:cgi_script]
- @image_src="#{@env.url.webserv_base_cgi(@opt)}/_sisu/image_sys"
- @common=SiSU_CGI_SQL::CGI_Common.new(@webserv,@opt,@image_src,@env)
+ @image_src="#{@env.url.webserv_base_cgi(opt)}/_sisu/image_sys"
+ @common=SiSU_CGI_SQL::CGI_Common.new(@webserv,opt,@image_src,@env)
end
def pgsql
serve=[]
@@ -174,13 +174,13 @@ module SiSU_CGI_PgSQL
sudo chmod -v 755 /usr/lib/cgi-bin/#{@cgi_file_name}
WOK
end
- SiSU_Screen::Ansi.new(opt.act[:color_state][:set],a).warn
+ SiSU_Screen::Ansi.new(@opt.act[:color_state][:set],a).warn
a=<<-WOK
#{@env.webserv_base_cgi(@opt)}/cgi-bin/#{@cgi_file_name}
WOK
- SiSU_Screen::Ansi.new(opt.act[:color_state][:set],a).print_blue
+ SiSU_Screen::Ansi.new(@opt.act[:color_state][:set],a).print_blue
a="\n\t(to create and populate postgresql database see 'man sisu' and in particular the --pg option)\n\t[the database to be used for this directory (#{@db.psql.db}) will have to be created manually if it does not exist,\n\tusing postgresql tools directly: 'createdb #{@db.psql.db}' for a list of existing databases try 'psql --list']"
- SiSU_Screen::Ansi.new(opt.act[:color_state][:set],a).txt_grey
+ SiSU_Screen::Ansi.new(@opt.act[:color_state][:set],a).txt_grey
else puts 'failed in attempt to write #{@cgi_file_name} to present directory, is directory writable?'
end
end
@@ -192,9 +192,13 @@ module SiSU_CGI_PgSQL
* Description: generates naive cgi search form for search of sisu database (pgsql)
#{gpl}
=end
- require 'cgi'
- require 'fcgi'
- require 'dbi'
+ begin
+ require 'cgi'
+ require 'fcgi'
+ require 'dbi'
+ rescue LoadError
+ puts 'cgi, fcgi or dbi NOT FOUND (LoadError)'
+ end
@stub_default='#{@name_of[:db]}'
@image_src='#{@image_src}'
@hosturl_cgi='#{@name_of[:host_url_cgi]}'
diff --git a/lib/sisu/v5/cgi_sqlite.rb b/lib/sisu/v5/cgi_sqlite.rb
index 8ebe0c16..c4222ecb 100644
--- a/lib/sisu/v5/cgi_sqlite.rb
+++ b/lib/sisu/v5/cgi_sqlite.rb
@@ -69,18 +69,18 @@ module SiSU_CGI_SQLite
@opt,@webserv=opt,webserv
@cX=SiSU_Screen::Ansi.new(opt.act[:color_state][:set]).cX
@env=SiSU_Env::InfoEnv.new('',opt)
- @image_src="#{@env.url.webserv_cgi(@opt)}/_sisu/image_sys"
+ @image_src="#{@env.url.webserv_cgi(opt)}/_sisu/image_sys"
@name_of={}
- @name_of[:output_dir_structure]=if @opt.dir_structure_by.to_s =~/(?:language|filetype|filename)/
- @opt.dir_structure_by.to_s
+ @name_of[:output_dir_structure]=if opt.dir_structure_by.to_s =~/(?:language|filetype|filename)/
+ opt.dir_structure_by.to_s
else 'language'
end
- @name_of[:lingual]=if @opt.lingual.to_s =~/(?:mono|multi)/
- @opt.lingual.to_s
+ @name_of[:lingual]=if opt.lingual.to_s =~/(?:mono|multi)/
+ opt.lingual.to_s
else 'multi'
end
- @common=SiSU_CGI_SQL::CGI_Common.new(@webserv,@opt,@image_src,@env)
- @cgi_file_name=@env.url.cgi_sample_search_form_name(@opt)
+ @common=SiSU_CGI_SQL::CGI_Common.new(@webserv,opt,@image_src,@env)
+ @cgi_file_name=@env.url.cgi_sample_search_form_name(opt)
@name_of_sqlite_db_file='sisu_sqlite.db'
end
def sqlite
@@ -147,13 +147,13 @@ module SiSU_CGI_SQLite
WOK
end
b='(to create and populate sisu sqlite database see "man sisu" and in particular the -d flag)'
- SiSU_Screen::Ansi.new(opt.act[:color_state][:set],a,b).warn
+ SiSU_Screen::Ansi.new(@opt.act[:color_state][:set],a,b).warn
a=<<-WOK
#{@env.webserv_base_cgi(@opt)}/cgi-bin/#{@cgi_file_name}
WOK
- SiSU_Screen::Ansi.new(opt.act[:color_state][:set],a).print_blue
+ SiSU_Screen::Ansi.new(@opt.act[:color_state][:set],a).print_blue
else puts "failed in attempt to write #{@cgi_file_name} to present directory, is directory writable?"
end
end
@@ -165,9 +165,13 @@ module SiSU_CGI_SQLite
* Description: generates naive cgi search form for search of sisu database (sqlite)
#{gpl}
=end
- require 'cgi'
- require 'fcgi'
- require 'dbi'
+ begin
+ require 'cgi'
+ require 'fcgi'
+ require 'dbi'
+ rescue LoadError
+ puts 'cgi, fcgi or dbi NOT FOUND (LoadError)'
+ end
@stub_default='sisu_sqlite'
@image_src='#{@image_src}'
@hosturl_cgi='#{@env.url.webserv_base_cgi(@opt)}/cgi-bin'
diff --git a/lib/sisu/v5/composite.rb b/lib/sisu/v5/composite.rb
index c1457779..9e7ccb5c 100644
--- a/lib/sisu/v5/composite.rb
+++ b/lib/sisu/v5/composite.rb
@@ -178,10 +178,14 @@ module SiSU_Assemble
end
tuned_file << if loadfile =~ /(?:https?|file):\/\/\S+?\.ss[ti]$/ # and NetTest
imagedir = /((?:https?|file):\/\/\S+?)\/[^\/]+?\.ss[ti]$/.match(loadfile).captures.join + '/_sisu/image' #watch
- require 'uri'
+ begin
+ require 'uri'
+ require 'open-uri'
+ require 'pp'
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('uri, open-uri or pp NOT FOUND (LoadError)')
+ end
image_uri=URI.parse(imagedir)
- require 'open-uri'
- require 'pp'
insert=open(loadfile)
insert_array=insert.dup
insert.close
diff --git a/lib/sisu/v5/concordance.rb b/lib/sisu/v5/concordance.rb
index 55892ab7..b9030123 100644
--- a/lib/sisu/v5/concordance.rb
+++ b/lib/sisu/v5/concordance.rb
@@ -240,12 +240,13 @@ WOK
end
end
protected
- def location_scroll(wordlocation,show)
- %{<a href="doc#{@md.lang_code_insert}#{Sfx[:html]}\##{wordlocation}">#{wordlocation}</a>; }
+ def location_scroll(wordlocation,show) # not used
+ %{<a href="doc#{@md.lang_code_insert}#{Sfx[:html]}\##{Mx[:ocn_id_char]}#{wordlocation}">#{wordlocation}</a>; }
end
- def location_seg(wordlocation,show) ##fix
+ def location_seg(wordlocation,show)
unless wordlocation.nil?
- wl=wordlocation.gsub(/(.+?)\#(\d+)/,"\\1#{@md.lang_code_insert}#{Sfx[:html]}#\\2")
+ wl=wordlocation.gsub(/(.+?)\#(\d+)/,
+ "\\1#{@md.lang_code_insert}#{Sfx[:html]}##{Mx[:ocn_id_char]}\\2") # id="o\d+" always available; a name="\d+" not available if html strict used
case wordlocation
when /#{@rxp_t1}|@rxp_t2}|#{@rxp_t3}/
%{[<a href="doc#{@md.lang_code_insert}#{Sfx[:html]}##{show}">H</a>]#{show}, }
diff --git a/lib/sisu/v5/constants.rb b/lib/sisu/v5/constants.rb
index e84c0901..a9be54f0 100644
--- a/lib/sisu/v5/constants.rb
+++ b/lib/sisu/v5/constants.rb
@@ -101,6 +101,13 @@ Xx={
html_relative1: '※',
}
Mx={
+ ocn_id_char: 'o',
+ note: 'note_',
+ note_ref: 'noteref_',
+ note_astx: 'note_astx_',
+ note_ref_astx: 'noteref_astx_',
+ note_plus: 'note_plus_',
+ note_ref_plus: 'noteref_plus_',
meta_o: '〔@', meta_c: '〕',
lv_o_0: 0,
lv_o_1: 1,
diff --git a/lib/sisu/v5/db_import.rb b/lib/sisu/v5/db_import.rb
index 8d9fc229..0dc5a29b 100644
--- a/lib/sisu/v5/db_import.rb
+++ b/lib/sisu/v5/db_import.rb
@@ -66,7 +66,6 @@ module SiSU_DbImport
require_relative 'db_load_tuple' # db_load_tuple.rb
require_relative 'db_sqltxt' # db_sqltxt.rb
require_relative 'html_lite_shared' # html_lite_shared.rb
- require 'sqlite3'
class Import < SiSU_DbText::Prepare
include SiSU_Param
include SiSU_Screen
diff --git a/lib/sisu/v5/dbi.rb b/lib/sisu/v5/dbi.rb
index d92f1964..1ab9bc9c 100644
--- a/lib/sisu/v5/dbi.rb
+++ b/lib/sisu/v5/dbi.rb
@@ -120,9 +120,12 @@ manually create the database: "#{cX.green}#{@db.db}#{cX.off}" if it does not yet
end
def read_sqlite
begin
- @conn=@db.sqlite.conn_sqlite3
- rescue
- ensure
+ begin
+ require 'sqlite3'
+ @conn=@db.sqlite.conn_sqlite3
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('sqlite3 NOT FOUND (LoadError)')
+ end
end
end
def connect
diff --git a/lib/sisu/v5/dbi_discrete.rb b/lib/sisu/v5/dbi_discrete.rb
index 0981455c..cd8c7de1 100644
--- a/lib/sisu/v5/dbi_discrete.rb
+++ b/lib/sisu/v5/dbi_discrete.rb
@@ -69,8 +69,12 @@ module SiSU_DBI_Discrete #% database building
include SiSU_DbDBI
require_relative 'html_lite_shared' # html_lite_shared.rb
include SiSU_FormatShared
- require 'fileutils'
- include FileUtils::Verbose
+ begin
+ require 'fileutils'
+ include FileUtils::Verbose
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('fileutils NOT FOUND (LoadError)')
+ end
class SQL
def initialize(opt)
SiSU_Env::Load.new('dbi',true).prog
@@ -145,9 +149,12 @@ module SiSU_DBI_Discrete #% database building
end
def read_sqlite
begin
- @conn=@db.sqlite.conn_sqlite3
- rescue
- ensure
+ begin
+ require 'sqlite3'
+ @conn=@db.sqlite.conn_sqlite3
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('sqlite3 not available')
+ end
end
end
def connect
diff --git a/lib/sisu/v5/defaults.rb b/lib/sisu/v5/defaults.rb
index fd56c2c4..25dd270a 100644
--- a/lib/sisu/v5/defaults.rb
+++ b/lib/sisu/v5/defaults.rb
@@ -62,7 +62,11 @@
=end
$latex_run=nil
module SiSU_Viz
- require 'uri'
+ begin
+ require 'uri'
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('uri NOT FOUND (LoadError)')
+ end
require_relative 'sysenv' # sysenv.rb
include SiSU_Env
require_relative 'css' # css.rb
diff --git a/lib/sisu/v5/digests.rb b/lib/sisu/v5/digests.rb
index 2b010374..7099b646 100644
--- a/lib/sisu/v5/digests.rb
+++ b/lib/sisu/v5/digests.rb
@@ -91,9 +91,13 @@ module SiSU_DigestView
if @opt.act[:verbose_plus][:set]==:on \
or @opt.act[:maintenance][:set]==:on
SiSU_Screen::Ansi.new(@opt.act[:color_state][:set],@opt.fns,"file://#{@md.file.output_path.hash_digest.dir}/#{@md.file.base_filename.hash_digest}").flow
+ end
+ end
+ if SiSU_Env::SystemCall.new.openssl
+ SiSU_DigestView::Source::Scroll.new(@particulars).songsheet
+ else
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('*EXITED* hash digests will not run without openssl')
end
- end
- SiSU_DigestView::Source::Scroll.new(@particulars).songsheet
rescue
SiSU_Errors::Rescued.new($!,$@,@opt.cmd,@opt.fns).location do
__LINE__.to_s + ':' + __FILE__
diff --git a/lib/sisu/v5/html.rb b/lib/sisu/v5/html.rb
index f473f1b7..4a911d2c 100644
--- a/lib/sisu/v5/html.rb
+++ b/lib/sisu/v5/html.rb
@@ -61,7 +61,11 @@
=end
module SiSU_HTML
- require 'pstore'
+ begin
+ require 'pstore'
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('pstore NOT FOUND (LoadError)')
+ end
require_relative 'particulars' # particulars.rb
include SiSU_Particulars
require_relative 'defaults' # defaults.rb
@@ -241,6 +245,7 @@ module SiSU_HTML
def initialize(md=nil,data='')
@data,@md=data,md
@vz=SiSU_Viz::Defaults.new
+ @ocn_html_identifier=SiSU_Env::ProcessingSettings.new(@md).ocn_html_identifier
@tell=SiSU_Screen::Ansi.new(@md.opt.act[:color_state][:set]) if @md
end
def songsheet #extracts toc for scroll & seg
@@ -352,7 +357,7 @@ WOK
title=if dob.ocn ==0 then linkname
else
@@toc[:scr] << '<br />'
- %{<b><a href="##{dob.ocn}">#{linkname}</a></b>}
+ %{<b><a href="##{@ocn_html_identifier}#{dob.ocn}">#{linkname}</a></b>}
end
txt_obj={ txt: title }
format_toc=SiSU_HTML_Format::FormatToc.new(@md,txt_obj)
@@ -394,7 +399,7 @@ WOK
end
else
@@toc[:scr] << '<br />'
- %{<b><a href="##{dob.ocn}">#{linkname}</a></b>}
+ %{<b><a href="##{@ocn_html_identifier}#{dob.ocn}">#{linkname}</a></b>}
end
txt_obj={ txt: title }
format_toc=SiSU_HTML_Format::FormatToc.new(@md,txt_obj)
@@ -511,7 +516,7 @@ WOK
}
f=@md.file.base_filename.html_seg(fnh)
p_num=SiSU_HTML_Format::ParagraphNumber.new(@md,ocn)
- lnk_n_txt=%{ <a href="#{f}##{ocn}">
+ lnk_n_txt=%{ <a href="#{f}##{@ocn_html_identifier}#{ocn}">
#{linkname}
</a>}
txt_obj={ txt: lnk_n_txt }
@@ -536,7 +541,7 @@ WOK
}
f=@md.file.base_filename.html_seg(fnh)
p_num=SiSU_HTML_Format::ParagraphNumber.new(@md,ocn)
- lnk_n_txt=%{ <a href="#{f}##{ocn}">
+ lnk_n_txt=%{ <a href="#{f}##{@ocn_html_identifier}#{ocn}">
#{linkname}
</a>}
txt_obj={ txt: lnk_n_txt }
@@ -618,7 +623,8 @@ WOK
toc_shared << format_txt_obj.center_bold
@segtoc << format_txt_obj.center_bold
if defined? @md.creator.author
- creator_endnote=@md.creator.author.gsub(/(\*+)/,
+ creator=SiSU_HTML_Tune::CleanHTML.new(@md.creator.author).clean_for_html
+ creator_endnote=creator.gsub(/(\*+)/,
%{&nbsp;<sup><a href="#notes">\\1</a></sup>})
tmp_head=creator_endnote + "\n"
txt_obj={ txt: tmp_head }
diff --git a/lib/sisu/v5/html_format.rb b/lib/sisu/v5/html_format.rb
index 3b15502f..e244bbb8 100644
--- a/lib/sisu/v5/html_format.rb
+++ b/lib/sisu/v5/html_format.rb
@@ -66,30 +66,36 @@ module SiSU_HTML_Format
def initialize(md,ocn)
@md,@ocn=md,ocn.to_s
@ocn ||=''
+ @ocn_html_identifier=SiSU_Env::ProcessingSettings.new(@md).ocn_html_identifier
+ @make=SiSU_Env::ProcessingSettings.new(@md)
end
def ocn_display
- make=SiSU_Env::ProcessingSettings.new(@md)
- if make.build.ocn?
- ocn_class='ocn'
+ if @make.build.ocn?
if @ocn.to_i==0 \
or @ocn.empty?
- %{<label class="ocn_off">&nbsp;</label>}
+ ''
else
+ name=(@make.build.html_strict?) ? '' : %{ name="#{@ocn}"}
@ocn.gsub(/^(\d+|)$/,
- %{<label class="#{ocn_class}"><a name="#{@ocn}" href="##{@ocn}" class="lnk#{ocn_class}">\\1</a></label>})
+ %{<label class="ocn"><a#{name} href="##{@ocn_html_identifier}#{@ocn}" class="lnkocn">\\1</a></label>})
end
else
- %{<label class="ocn_off">&nbsp;</label>}
+ ''
end
end
def name
- (@ocn==nil || @ocn.empty?) ? '' : %{<a name="#{@ocn}"></a>}
+ if @make.build.html_strict? \
+ or @ocn==(nil || @ocn.empty?)
+ ''
+ else
+ %{<a name="#{@ocn}"></a>}
+ end
end
def id #w3c? "tidy" complains about numbers as identifiers ! annoying
(@ocn==nil || @ocn.empty?) ? '' : %{id="o#{@ocn}"}
end
def goto
- (@ocn==nil || @ocn.empty?) ? '' : %{<a href="##{@ocn}">}
+ (@ocn==nil || @ocn.empty?) ? '' : %{<a href="##{@ocn_html_identifier}#{@ocn}">}
end
end
class HeadInformation
@@ -271,24 +277,6 @@ module SiSU_HTML_Format
else ''
end
end
- def pdf #retired 2.7.9
- pdf=if @md.programs[:pdf] \
- and @cf_defaults.cf_0 =~/p/
- %{
-<td align="center" bgcolor=#{@vz.color_band2}>
- <a href="#{Xx[:html_relative1]}pdf/#{@file.base_filename.pdf_p}" target="_top">
- #{@vz.nav_txt_pdf_portrait}
- </a>
-</td>
-<td align="center" bgcolor=#{@vz.color_band2}>
- <a href="#{Xx[:html_relative1]}pdf/#{@file.base_filename.pdf_l}" target="_top">
- #{@vz.nav_txt_pdf_landscape}
- </a>
-</td>
-}
- else ''
- end
- end
end
class XML
end
@@ -514,7 +502,8 @@ WOK
end
def rights
def all
- rights=@md.rights.all.gsub(/^\s*Copyright\s+\(C\)/,'Copyright <sup>&copy;</sup>&nbsp;')
+ rights=SiSU_HTML_Tune::CleanHTML.new(@md.rights.all).clean_for_html
+ rights=rights.gsub(/^\s*Copyright\s+\(C\)/,'Copyright <sup>&copy;</sup>&nbsp;')
%{<p class="small_left">Rights: #{rights}</p>
<p />}
end
@@ -648,8 +637,6 @@ WOK
def initialize(md)
super(md)
end
- def title_banner(title,subtitle,creator)
- end
def dot_control_pre_next
pre="#{@seg_name_html[@seg_name_html_tracker-1]}#{@md.lang_code_insert}#{Sfx[:html]}"
up=@toc
@@ -894,6 +881,7 @@ WOK
attr_accessor :md,:t_o,:txt,:ocn,:format,:table,:link,:linkname,:paranum,:p_num,:headname,:banner,:url
def initialize(md,t_o)
@md,@t_o=md,t_o
+ @make=SiSU_Env::ProcessingSettings.new(@md)
if t_o.is_a?(Hash)
@txt =t_o[:txt] || nil
@ocn =t_o[:ocn] || nil
@@ -917,19 +905,19 @@ WOK
p caller
end
end
- @headnamed= (@headname ? %{<a name="h#{@headname}" id="h#{@headname}"></a>} : nil)
+ @headnamed=(@headname ? %{<a id="h#{@headname}"></a>} : nil)
if @txt and not @txt.empty?
@txt=@txt.gsub(/#{Mx[:mk_o]}[-~]##{Mx[:mk_c]}/,'')
end
@p_num=ParagraphNumber.new(@md,@ocn)
@vz=SiSU_Viz::Defaults.new
- @make=SiSU_Env::ProcessingSettings.new(@md)
end
def nametags_scroll(dob)
tags=''
if defined? dob.tags \
and dob.tags.length > 0 # insert tags "hypertargets"
dob.tags.each do |t|
+ t=t.gsub(/[^a-z0-9._-]/,'') #use for all html tags? consider limiting to strict? or implementing earlier
tags=tags << %{<named id="#{t}" />}
end
end
@@ -940,7 +928,16 @@ WOK
if defined? dob.tags \
and dob.tags.length > 0 # insert tags "hypertargets"
dob.tags.each do |t|
- tags=tags << %{<a name="#{t}" ></a>}
+ t=t.gsub(/[^a-z0-9._-]/,'') #use for all html tags? consider limiting to strict? or implementing earlier
+ if @make.build.html_strict?
+ tags=(t =~/^[#{Mx[:ocn_id_char]}]?[0-9.]+$/) \
+ ? tags #check what can be sorted in ao
+ : (tags << %{<a name="#{t}" ></a>})
+ else
+ tags=(t =~/^[#{Mx[:ocn_id_char]}][0-9.]+$/) \
+ ? tags #check what can be sorted in ao
+ : (tags << %{<a name="#{t}" ></a>})
+ end
end
end
tags
@@ -949,8 +946,8 @@ WOK
hn=if @t_o.is ==:heading \
and not @t_o.name.empty? #determine use
hn=(@t_o.is ==:heading) \
- ? (%{<a name="h#{@t_o.name}" id="h#{@t_o.name}"></a>})
- : (%{<a name="#{@t_o.name}" id="#{@t_o.name}"></a>})
+ ? (%{<a id="h#{@t_o.name}"></a>})
+ : (%{<a id="#{@t_o.name}"></a>})
else nil
end
hn
@@ -981,7 +978,9 @@ WOK
end
def para_form_css(tag,attrib) # regular paragraphs shaped here
ul=ulc=''
- ul,ulc="<ul>\n ","\n </ul>" if @tag =~/li/
+ if tag =~/li/
+ ul,ulc="<ul>\n ","\n </ul>"
+ end
%{
<div class="substance">
#{@p_num.ocn_display}
@@ -1037,7 +1036,7 @@ WOK
<div class="substance">
#{@p_num.ocn_display}
<#{tag} class="#{attrib}" #{@p_num.id}>#{@p_num.name}
- #{@named}<a name="h#{@headname}">#{@txt}</a>
+ #{@named}#{@txt}
</#{tag}>
</div>
}
@@ -1151,8 +1150,6 @@ WOK
#{@vz.table_close}}
end
def bold_heading
- @txt=@txt.gsub(/[1-9]~(\S+)/,'<a name="\1"></a>').
- gsub(/[1-9]~/,'')
%{<p class="bold">
#{@txt}
</p>
@@ -1245,6 +1242,7 @@ WOK
end
def subtoc_lev(tag,attrib)
@txt=clean(@txt)
+ @ocn_html_identifier=SiSU_Env::ProcessingSettings.new(@md).ocn_html_identifier
txt=if @txt \
and @txt =~/<\/?i>|<a\s+name="\S+?">/mi
@txt.gsub(/<\/?i>|<a\s+name="\S+?">/mi,'') #removes name markers from subtoc, go directly to substantive text
@@ -1253,12 +1251,12 @@ WOK
note=''
if txt =~/(#{Mx[:en_a_o]}.+?#{Mx[:en_a_c]}|#{Mx[:en_b_o]}.+?#{Mx[:en_b_c]})/m # had \s* at end
note=$1
- note=note.gsub(/[\n\s]+/m,' ')
+ note=note.gsub(/[\s]+/m,' ')
txt=txt.gsub(/(?:#{Mx[:en_a_o]}.+?#{Mx[:en_a_c]}|#{Mx[:en_b_o]}.+?#{Mx[:en_b_c]})\s*/m,' ').
- gsub(/<a[\n\s]+name="-\d+"[\n\s]+href="#_\d+">&nbsp;<sup>\d+<\/sup>&nbsp;/m,'')
+ gsub(/<a[\s]+name="-\d+"[\s]+href="#_\d+">&nbsp;<sup>\d+<\/sup>&nbsp;/m,'')
end
%{<#{tag} class="#{attrib}">
- <a href="##{@ocn}"><i>#{txt}</i></a> #{note}
+ <a href="##{@ocn_html_identifier}#{@ocn}"><i>#{txt}</i></a> #{note}
</#{tag}>}
end
def subtoc_lev5
diff --git a/lib/sisu/v5/html_lite_shared.rb b/lib/sisu/v5/html_lite_shared.rb
index 8c447352..e109debc 100644
--- a/lib/sisu/v5/html_lite_shared.rb
+++ b/lib/sisu/v5/html_lite_shared.rb
@@ -83,6 +83,7 @@ module SiSU_FormatShared
end
@tab="\t"
@brace_url=SiSU_Viz::Defaults.new.url_decoration
+ @ocn_html_identifier=SiSU_Env::ProcessingSettings.new(@md).ocn_html_identifier
@@tablehead,@@tablefoot=[],[]
@vz=SiSU_Viz::Defaults.new
@env=SiSU_Env::InfoEnv.new(@md.fns)
@@ -205,7 +206,7 @@ GSUB
%{<p class="#{h[:class]}" type="#{h[:type]}">#{h[:txt]}</a></p>\n} << "\n"
end
def lev_toc_hname
- %{<p class="toc#{@lv}" header="#{@hname}"><a href="##{@ocn}">#{@txt}</a></p>\n} #<< "\n"
+ %{<p class="toc#{@lv}" header="#{@hname}"><a href="##{@ocn_html_identifier}#{@ocn}">#{@txt}</a></p>\n} #<< "\n"
end
def lev_toc
h={ txt: txt, class: "toc#{@lv}", type: 'toc' }
@@ -309,10 +310,10 @@ GSUB
def paragraph
attrib=%{class="#{@attrib}" }
if @ocn
- id=%{id="#{@ocn}" }
+ id=%{id="#{Mx[:ocn_id_char]}#{@ocn}" }
type=%{type="substantive" }
else
- id=%{id="none" }
+ id=''
type=%{type="comment" }
end
header=%{header="#{@hname}" } if @hname
diff --git a/lib/sisu/v5/html_minitoc.rb b/lib/sisu/v5/html_minitoc.rb
index dae74c46..5366b127 100644
--- a/lib/sisu/v5/html_minitoc.rb
+++ b/lib/sisu/v5/html_minitoc.rb
@@ -71,6 +71,7 @@
def initialize(md,data)
@md,@data=md,data
@pat_strip_heading_name=/<a name="h?\d.*?">(.+?)<\/a>/
+ @ocn_html_identifier=SiSU_Env::ProcessingSettings.new(@md).ocn_html_identifier
@tell=SiSU_Screen::Ansi.new(@md.opt.act[:color_state][:set]) if @md
end
def songsheet
@@ -204,7 +205,7 @@
fn: @@seg_url,
}
f=@md.file.base_filename.html_seg(fnh)
- lnk_n_txt=%{ <a href="#{f}##{txt.ocn}">
+ lnk_n_txt=%{ <a href="#{f}##{@ocn_html_identifier}#{txt.ocn}">
#{txt.obj}
</a>}
txt_obj={ txt: lnk_n_txt }
@@ -223,7 +224,7 @@
fn: @@seg_url,
}
f=@md.file.base_filename.html_seg(fnh)
- lnk_n_txt=%{ <a href="#{f}##{txt.ocn}">
+ lnk_n_txt=%{ <a href="#{f}##{@ocn_html_identifier}#{txt.ocn}">
#{txt.obj}
</a>}
txt_obj={ txt: lnk_n_txt }
diff --git a/lib/sisu/v5/html_segments.rb b/lib/sisu/v5/html_segments.rb
index b710db81..7a368b9d 100644
--- a/lib/sisu/v5/html_segments.rb
+++ b/lib/sisu/v5/html_segments.rb
@@ -502,7 +502,7 @@ module SiSU_HTML_Seg
'<br /><hr width=90% /><br />'
end
if @md.flag_separate_endnotes
- dob.obj=dob.obj.gsub(/"\s+href="#_(\d+)">/,%{" href=\"endnotes#{Sfx[:html]}#_\\1">}) #endnote- twice #removed file type
+ dob.obj=dob.obj.gsub(/"\s+href="#(#{Mx[:note]}\d+)">/,%{" href=\"endnotes#{Sfx[:html]}#\\1">}) #endnote- twice #removed file type
end
if dob.obj !~/#{@vz.margin_txt_w1}|#{@vz.margin_txt_w2}/
if (dob.is==:heading \
@@ -600,7 +600,7 @@ module SiSU_HTML_Seg
@@seg_subtoc_array << subtoc
end
if @md.flag_auto_endnotes
- if (dob.obj =~/(?:#{Mx[:en_a_o]}|#{Mx[:en_b_o]})[\d*+]+ <a name="_[\d*+]+"/) \
+ if (dob.obj =~/(?:#{Mx[:en_a_o]}|#{Mx[:en_b_o]})[\d*+]+ <a name="#{Mx[:note]}[\d*+]+"/) \
&& dob.is !=:code # endnote-
endnote_array=[]
if dob.obj=~/#{Mx[:en_a_o]}.+?#{Mx[:en_a_c]}/m
@@ -629,7 +629,7 @@ module SiSU_HTML_Seg
end
try.join('<br \/>')
#% creation of separate end segment/page of all endnotes referenced back to reference segment
- m=/(?:#{Mx[:en_a_o]}[\d*+]+|#{Mx[:en_b_o]}[*+]\d+)\s+(.+?href=")(#-[\d*+]+".+)(?:#{Mx[:en_a_c]}|#{Mx[:en_b_c]})/mi
+ m=/(?:#{Mx[:en_a_o]}[\d*+]+|#{Mx[:en_b_o]}[*+]\d+)\s+(.+?href=")(##{Mx[:note_ref]}[\d*+]+".+)(?:#{Mx[:en_a_c]}|#{Mx[:en_b_c]})/mi
endnote_part_a=note_match_seg[m,1]
endnote_part_b=note_match_seg[m,2]
txt_obj={ endnote_part_a: endnote_part_a, endnote_part_b: endnote_part_b }
diff --git a/lib/sisu/v5/html_tune.rb b/lib/sisu/v5/html_tune.rb
index e9392ca8..39cbb708 100644
--- a/lib/sisu/v5/html_tune.rb
+++ b/lib/sisu/v5/html_tune.rb
@@ -104,6 +104,16 @@ module SiSU_HTML_Tune
def initialize(html='')
@html=html
end
+ def clean_for_html
+ html=@html
+ str=if html.is_a?(String)
+ html
+ else html.obj
+ end
+ str=str.gsub(/#{Mx[:gl_o]}(#[0-9]{3})#{Mx[:gl_c]}/u,'&\1;').
+ gsub(/#{Mx[:gl_o]}#([a-z]{2,4})#{Mx[:gl_c]}/u,'&\1;').
+ gsub(/[<]/m,'&lt;').gsub(/[>]/m,'&gt;')
+ end
def clean
html=@html
str=if html.is_a?(String)
@@ -111,7 +121,8 @@ module SiSU_HTML_Tune
else html.obj
end
str=str.gsub(/#{Mx[:gl_o]}(#[0-9]{3})#{Mx[:gl_c]}/u,'&\1;').
- gsub(/#{Mx[:gl_o]}#([a-z]{2,4})#{Mx[:gl_c]}/u,'&\1;')
+ gsub(/#{Mx[:gl_o]}#([a-z]{2,4})#{Mx[:gl_c]}/u,'&\1;').
+ gsub(/[\\]{2}/m,'<br />')
end
end
class Tune
@@ -256,14 +267,14 @@ module SiSU_HTML_Tune
def endnotes_html(dob)
unless dob.is ==:code
dob.obj=dob.obj.gsub(/(#{Mx[:en_a_o]}|#{Mx[:en_b_o]})(\d+)\s+(.+?)(#{Mx[:en_a_c]}|#{Mx[:en_b_c]})/,
- '&nbsp;<a name="-\2" href="#_\2">&nbsp;<sup>\2</sup>&nbsp;</a> ' + #note- endnote-
- '\1\2 <a name="_\2" href="#-\2">&nbsp;<sup>\2.</sup></a> \3 \4'). #endnote- note- (careful may have switched)
+ %{&nbsp;<a name="#{Mx[:note_ref]}\\2" href="##{Mx[:note]}\\2">&nbsp;<sup>\\2</sup>&nbsp;</a> } +
+ %{\\1\\2 <a name="#{Mx[:note]}\\2" href="##{Mx[:note_ref]}\\2">&nbsp;<sup>\\2.</sup></a> \\3 \\4}).
gsub(/(#{Mx[:en_b_o]})([*+]\d+)\s+(.+?)(#{Mx[:en_b_c]})/,
- '&nbsp;<a name="-\2" href="#_\2">&nbsp;<sup>\2</sup>&nbsp;</a> ' + #note- endnote-
- '\1\2 <a name="_\2" href="#-\2">&nbsp;<sup>\2.</sup></a> \3 \4'). #endnote- note- (careful may have switched)
+ %{&nbsp;<a name="#{Mx[:note_ref]}\\2" href="##{Mx[:note]}\\2">&nbsp;<sup>\\2</sup>&nbsp;</a> } +
+ %{\\1\\2 <a name="#{Mx[:note]}\\2" href="##{Mx[:note_ref]}\\2">&nbsp;<sup>\\2.</sup></a> \\3 \\4}).
gsub(/(#{Mx[:en_a_o]})([*+]+)\s+(.+?)(#{Mx[:en_a_c]})/,
- '&nbsp;<a name="-\2" href="#_\2">&nbsp;<sup>\2</sup>&nbsp;</a> ' + #note- endnote-
- '\1\2 <a name="_\2" href="#-\2">&nbsp;<sup>\2</sup></a> \3 \4') #endnote- note- (careful may have switched)
+ %{&nbsp;<a name="#{Mx[:note_ref]}\\2" href="##{Mx[:note]}\\2">&nbsp;<sup>\\2</sup>&nbsp;</a> } +
+ %{\\1\\2 <a name="#{Mx[:note]}\\2" href="##{Mx[:note_ref]}\\2">&nbsp;<sup>\\2</sup></a> \\3 \\4})
end
dob
end
diff --git a/lib/sisu/v5/hub.rb b/lib/sisu/v5/hub.rb
index d0393a3b..8a430e71 100644
--- a/lib/sisu/v5/hub.rb
+++ b/lib/sisu/v5/hub.rb
@@ -72,7 +72,11 @@ module SiSU
require_relative 'defaults' # defaults.rb
include SiSU_Viz
require_relative 'utils' # utils.rb
- require 'uri'
+ begin
+ require 'uri'
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('uri NOT FOUND (LoadError)')
+ end
class HubMaster
def initialize(argv)
pwd_the=Dir.pwd
@@ -246,8 +250,12 @@ module SiSU
end
end
class Processing
- require 'fileutils'
- include FileUtils
+ begin
+ require 'fileutils'
+ include FileUtils
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('fileutils NOT FOUND (LoadError)')
+ end
@@env=nil
attr_accessor :op
def initialize(opt)
@@ -645,7 +653,11 @@ module SiSU
end
def actions
if @opt.act[:profile][:set]==:on
- require 'profile'
+ begin
+ require 'profile'
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('profile NOT FOUND (LoadError)')
+ end
end
action_on_file_ =if @opt.act[:rsync][:set]==:on \
&& @opt.act[:site_init][:set]==:on
@@ -748,7 +760,7 @@ module SiSU
STDERR.puts %{requested action requires valid sisu markup file [filename (.sst .ssm)] or wildcard (that includes a valid filename)}
if (@opt.act[:verbose_plus][:set]==:on \
|| @opt.act[:maintenance][:set]==:on)
- SiSU_Utils::CodeMarker.new(__LINE__,__FILE__).mark(:fuchsia)
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__).warn(:fuchsia)
end
end
elsif @opt.mod.inspect =~/--query/
diff --git a/lib/sisu/v5/options.rb b/lib/sisu/v5/options.rb
index 65af15b4..bce0a8a4 100644
--- a/lib/sisu/v5/options.rb
+++ b/lib/sisu/v5/options.rb
@@ -62,7 +62,11 @@
=end
module SiSU_Commandline
- require 'pathname'
+ begin
+ require 'pathname'
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('pathname NOT FOUND (LoadError)')
+ end
require_relative 'sysenv' # sysenv.rb
require_relative 'param_make' # param_make.rb
@@sisu_call_origin_path=nil
@@ -662,9 +666,9 @@ module SiSU_Commandline
{ set: :filetype }
else { set: :na }
end
- act[:ocn]=if mod.inspect =~/"--inc-ocn"/
+ act[:ocn]=if mod.inspect =~/"--ocn"|"--inc-ocn"/
{ bool: true, set: :on }
- elsif mod.inspect =~/"--(?:exc|no)-ocn"/ \
+ elsif mod.inspect =~/"--no-ocn"|"--exc-ocn"/ \
|| act[:switch][:off].inspect =~/"ocn"/
{ bool: false, set: :off }
else { bool: true, set: :na }
@@ -765,12 +769,23 @@ module SiSU_Commandline
{ bool: false, set: :off }
else { bool: true, set: :na }
end
- act[:html]=if (cmd =~/h/ \
+ act[:html]=if mod.inspect =~/"--html-strict"/ \
+ or ((cmd =~/h/ || mod.inspect =~/"--html"/) \
+ && mod.inspect =~/"--strict"/)
+ act[:html_strict]={ bool: true, set: :on }
+ act[:html_scroll]={ bool: true, set: :on }
+ act[:html_seg]={ bool: true, set: :on }
+ { bool: true, set: :on }
+ elsif (cmd =~/h/ \
|| mod.inspect =~/"--html"/)
+ act[:html_strict]={ bool: false, set: :off }
act[:html_scroll]={ bool: true, set: :on }
act[:html_seg]={ bool: true, set: :on }
{ bool: true, set: :on }
else
+ act[:html_strict]=(mod.inspect =~/"--strict"/) \
+ ? { bool: true, set: :on }
+ : { bool: false, set: :na }
act[:html_scroll]=(mod.inspect =~/"--html-scroll"/) \
? { bool: true, set: :on }
: { bool: false, set: :na }
@@ -850,10 +865,20 @@ module SiSU_Commandline
|| mod.inspect =~/"--epub"/) \
? { bool: true, set: :on }
: { bool: false, set: :na }
- act[:odt]=(cmd =~/o/ \
- || mod.inspect =~/"--odt"|"--odf"/) \
- ? { bool: true, set: :on }
- : { bool: false, set: :na }
+ act[:odt]=if cmd =~/o/ \
+ or mod.inspect =~/"--odt"|"--odf"|"--odt-ocn"|"--odf-ocn"/
+ act[:odt_ocn]=if (mod.inspect =~/"--odt-ocn"|"--odf-ocn"/ \
+ or mod.inspect =~/"--ocn"|"--inc-ocn"/)
+ { bool: true, set: :on }
+ elsif mod.inspect =~/"--no-ocn"|"--exc-ocn"/
+ { bool: false, set: :off }
+ else
+ { bool: false, set: :na }
+ end
+ { bool: true, set: :on }
+ else
+ { bool: false, set: :na }
+ end
act[:xml_sax]=(cmd =~/x/ \
|| mod.inspect =~/"--xml-sax"/) \
? { bool: true, set: :on }
@@ -879,10 +904,20 @@ module SiSU_Commandline
|| mod.inspect =~/"--xhtml"/) \
? { bool: true, set: :on }
: { bool: false, set: :na }
- act[:txt]=(cmd =~/[at]/ \
- || mod.inspect =~/"--txt"/) \
- ? { bool: true, set: :on }
- : { bool: false, set: :na }
+ act[:txt]=if cmd =~/[at]/ \
+ or mod.inspect =~/"--txt"|"--text"|"--plaintext"|"--txt-ocn"|"--text-ocn"|"--plaintext-ocn"/
+ act[:txt_ocn]=if (mod.inspect =~/"--txt-ocn"|"--text-ocn"|"--plaintext-ocn"/ \
+ or mod.inspect =~/"--ocn"|"--inc-ocn"/)
+ { bool: true, set: :on }
+ elsif mod.inspect =~/"--no-ocn"|"--exc-ocn"/
+ { bool: false, set: :off }
+ else
+ { bool: false, set: :na }
+ end
+ { bool: true, set: :on }
+ else
+ { bool: false, set: :na }
+ end
act[:txt_textile]=(mod.inspect =~/"--textile"/) \
? { bool: true, set: :on }
: { bool: false, set: :na }
diff --git a/lib/sisu/v5/param.rb b/lib/sisu/v5/param.rb
index e8eb3fc6..ba75bfb0 100644
--- a/lib/sisu/v5/param.rb
+++ b/lib/sisu/v5/param.rb
@@ -61,8 +61,12 @@
=end
module SiSU_Param
- require 'uri'
- require 'pstore'
+ begin
+ require 'uri'
+ require 'pstore'
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('uri or pstore NOT FOUND (LoadError)')
+ end
require_relative 'sysenv' # sysenv.rb
include SiSU_Env
require_relative 'param_make' # param_make.rb
@@ -95,8 +99,7 @@ module SiSU_Param
# you may need to change Dir.pwd to @opt.f_pth[:pth] where the latter
# has a path value that is different, however, f_pth is not always set!
Dir.chdir(@opt.f_pth[:pth])
- p '-- bug alert -- '
- p __FILE__ + ':' + __LINE__.to_s
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('-- bug alert --')
p 'f_pth ' + @opt.f_pth[:pth]
p 'pwd ' + Dir.pwd
end
diff --git a/lib/sisu/v5/particulars.rb b/lib/sisu/v5/particulars.rb
index 0687150a..6efbc94c 100644
--- a/lib/sisu/v5/particulars.rb
+++ b/lib/sisu/v5/particulars.rb
@@ -62,7 +62,11 @@
=end
module SiSU_Particulars
- require 'singleton'
+ begin
+ require 'singleton'
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('singleton NOT FOUND (LoadError)')
+ end
require_relative 'sysenv' # sysenv.rb
include SiSU_Env
require_relative 'param' # param.rb
diff --git a/lib/sisu/v5/remote.rb b/lib/sisu/v5/remote.rb
index 145ec9b2..e06e7b33 100644
--- a/lib/sisu/v5/remote.rb
+++ b/lib/sisu/v5/remote.rb
@@ -112,8 +112,12 @@ module SiSU_Remote
@tell=lambda { SiSU_Screen::Ansi.new(@opt.act[:color_state][:set],@msg,"#{@msgs.inspect if @msgs}") }
end
def fns
- require 'open-uri'
- require 'pp'
+ begin
+ require 'open-uri'
+ require 'pp'
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('open-uri or pp NOT FOUND (LoadError)')
+ end
require_relative 'composite' # composite.rb
@rgx_image=/(?:^|[^_\\])\{\s*(\S+?\.(?:png|jpg|gif))/
threads=[]
@@ -158,7 +162,11 @@ module SiSU_Remote
def sisupod
get_p=@get_s
if get_p.length > 0 #% remote sisupod
- require 'net/http'
+ begin
+ require 'net/http'
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('net/http NOT FOUND (LoadError)')
+ end
for requested_pod in get_p
pod_info=RemoteDownload.new(requested_pod)
Net::HTTP.start(pod_info.pod.site) do |http|
diff --git a/lib/sisu/v5/rexml.rb b/lib/sisu/v5/rexml.rb
index c00797a3..bc9f7541 100644
--- a/lib/sisu/v5/rexml.rb
+++ b/lib/sisu/v5/rexml.rb
@@ -62,14 +62,22 @@
=end
module SiSU_Rexml
# load XML file for REXML parsing
- require 'rexml/document' if FileTest.directory?("#{Config::CONFIG['rubylibdir']}/rexml") #Config::CONFIG['sitedir']
+ begin
+ require 'rexml/document' if FileTest.directory?("#{Config::CONFIG['rubylibdir']}/rexml") #Config::CONFIG['sitedir']
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('rexml/document NOT FOUND (LoadError)')
+ end
require_relative 'param' # param.rb
include SiSU_Param
require_relative 'sysenv' # sysenv.rb
include SiSU_Env
include SiSU_Viz
class Rexml
- require 'rexml/document' if FileTest.directory?("#{Config::CONFIG['rubylibdir']}/rexml") #Config::CONFIG['sitedir']
+ begin
+ require 'rexml/document' if FileTest.directory?("#{Config::CONFIG['rubylibdir']}/rexml") #Config::CONFIG['sitedir']
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('rexml/document NOT FOUND (LoadError)')
+ end
def initialize(md,fno)
@md,@fno=md,fno
@env=SiSU_Env::InfoEnv.new(@md.fns)
diff --git a/lib/sisu/v5/shared_markup_alt.rb b/lib/sisu/v5/shared_markup_alt.rb
index 4a1959e8..5a37c934 100644
--- a/lib/sisu/v5/shared_markup_alt.rb
+++ b/lib/sisu/v5/shared_markup_alt.rb
@@ -208,7 +208,11 @@ module SiSU_TextRepresentation
end
@env ||=SiSU_Env::InfoEnv.new(@md.fns)
@sha_ =((@env.digest.type =='sha256') ? true : false)
- @sha_ ? (require 'digest/sha2') : (require 'digest/md5')
+ begin
+ @sha_ ? (require 'digest/sha2') : (require 'digest/md5')
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error((@sha_ ? 'digest/sha2' : 'digest/md5') + ' NOT FOUND')
+ end
end
def digest(txt)
d=nil
diff --git a/lib/sisu/v5/src_kdissert_share.rb b/lib/sisu/v5/src_kdissert_share.rb
index f91aec55..8ccb9708 100644
--- a/lib/sisu/v5/src_kdissert_share.rb
+++ b/lib/sisu/v5/src_kdissert_share.rb
@@ -64,8 +64,12 @@ module SiSU_KdiSource
require_relative 'sysenv' # sysenv.rb
include SiSU_Env
class Source
- require 'fileutils'
- include FileUtils
+ begin
+ require 'fileutils'
+ include FileUtils
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('fileutils NOT FOUND (LoadError)')
+ end
def initialize(opt)
@opt=opt
@env=SiSU_Env::InfoEnv.new(@opt.fns)
diff --git a/lib/sisu/v5/sst_from_xml.rb b/lib/sisu/v5/sst_from_xml.rb
index 110d7df5..c969ac31 100644
--- a/lib/sisu/v5/sst_from_xml.rb
+++ b/lib/sisu/v5/sst_from_xml.rb
@@ -64,8 +64,12 @@
module SiSU_sstFromXML
require_relative 'sysenv' # sysenv.rb
class Convert
- require 'rexml/document'
- include REXML
+ begin
+ require 'rexml/document'
+ include REXML
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('rexml/document NOT FOUND (LoadError)')
+ end
def initialize(opt)
@opt=opt
@sisu,@sisu_base=[],[]
diff --git a/lib/sisu/v5/sysenv.rb b/lib/sisu/v5/sysenv.rb
index a8fcbd7a..f2b5bd27 100644
--- a/lib/sisu/v5/sysenv.rb
+++ b/lib/sisu/v5/sysenv.rb
@@ -66,12 +66,20 @@
module SiSU_Env
require_relative 'constants' # constants.rb
require_relative 'utils' # utils.rb
- require 'fileutils'
- include FileUtils::Verbose
- require 'singleton'
+ begin
+ require 'singleton'
+ require 'fileutils'
+ include FileUtils::Verbose
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('singleton or fileutils NOT FOUND (LoadError)')
+ end
@@noyaml=false
class InfoDate
- require 'date'
+ begin
+ require 'date'
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('date NOT FOUND (LoadError)')
+ end
attr_accessor :dt,:t
def initialize
@dt,@t=Date.today.to_s,Time.now
@@ -97,7 +105,11 @@ module SiSU_Env
end
end
class InfoSystemGen
- require 'rbconfig'
+ begin
+ require 'rbconfig'
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('rbconfig NOT FOUND (LoadError)')
+ end
@@user,@@home,@@hostname,@@pwd,@@sisu_etc,@@host,@@arch,@@rbver,@@dir_arch,@@dir_sitearch,@@dir_bin,@@locale,@@rc,@@sisurc_path,@@ad=ENV['USER'],ENV['HOME'],ENV['HOSTNAME'],ENV['PWD'],Config::CONFIG['sysconfdir'] + '/sisu',Config::CONFIG['host'],Config::CONFIG['arch'],%x{ruby -v}.strip,Config::CONFIG['archdir'],Config::CONFIG['sitearchdir'],Config::CONFIG['bindir'],%x{locale charmap}.strip,nil,nil,{} # %x{ruby -v}.strip # Config::CONFIG['rb_ver']
out=Config::CONFIG['localstatedir']
etc=Config::CONFIG['sysconfdir'] + '/sisu'
@@ -242,10 +254,18 @@ module SiSU_Env
end
if load_prog \
and @prog=~/dbi/
- require 'dbi' #revisit
+ begin
+ require 'dbi'
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('dbi NOT FOUND (LoadError)')
+ end
end
if load_prog
- require @prog
+ begin
+ require @prog
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error("#{@prog} NOT FOUND (LoadError)")
+ end
else
@mandatory \
? (SiSU_Screen::Ansi.new(@prog,"*WARN* module required: #{@prog}").warn)
@@ -330,7 +350,11 @@ module SiSU_Env
f=S_CONF[:rc_yml]
p_f="#{v}/#{f}"
if FileTest.exist?(p_f)
- require 'yaml'
+ begin
+ require 'yaml'
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('yaml NOT FOUND (LoadError)')
+ end
@@sisurc_path=v
@@rc=YAML::load(File::open(p_f))
break
@@ -339,7 +363,11 @@ module SiSU_Env
f='sisurc.yaml'
p_f="#{v}/#{f}"
if FileTest.exist?(p_f)
- require 'yaml'
+ begin
+ require 'yaml'
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('yaml NOT FOUND (LoadError)')
+ end
@@sisurc_path=v
@@rc=YAML::load(File::open(p_f))
break
@@ -378,7 +406,11 @@ module SiSU_Env
else
if FileTest.exist?("#{v}/list.yml")
unless @@ad[:promo_list]
- require 'yaml'
+ begin
+ require 'yaml'
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('yaml NOT FOUND (LoadError)')
+ end
@@ad[:promo_list] ||= YAML::load(File::open("#{v}/list.yml"))
end
@@ad[:flag_promo]=true
@@ -396,7 +428,11 @@ module SiSU_Env
else
if FileTest.exist?("#{v}/promo.yml")
unless @@ad[:promo]
- require 'yaml'
+ begin
+ require 'yaml'
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('yaml NOT FOUND (LoadError)')
+ end
@@ad[:promo] ||= YAML::load(File::open("#{v}/promo.yml"))
end
@@ad[:flag_promo]=true
@@ -716,7 +752,7 @@ module SiSU_Env
program='rcs'
program_ref="\n\t\tdocument version information requested"
if program_found?(program); true
- else STDERR.puts "\t*WARN* #{program} is not installed #{program_ref}" #if @cmd =~/v/
+ else SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).warn("#{program} is not installed #{program_ref}")
false
end
end
@@ -724,7 +760,15 @@ module SiSU_Env
program='cvs'
program_ref="\n\t\tdocument version information requested"
if program_found?(program); true
- else STDERR.puts "\t*WARN* #{program} is not installed #{program_ref}" #if @cmd =~/v/
+ else SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).warn("#{program} is not installed #{program_ref}")
+ false
+ end
+ end
+ def zip #zip
+ program='zip'
+ program_ref="\n\t\tused to in the making of number of file formats, odf, epub"
+ if program_found?(program); true
+ else SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).mark("*WARN* #{program} is not installed #{program_ref}")
false
end
end
@@ -732,7 +776,7 @@ module SiSU_Env
program='openssl'
program_ref="\n\t\tused to generate requested source document identification digest"
if program_found?(program); true
- else STDERR.puts "\t*WARN* #{program} is not installed #{program_ref}" #if @cmd =~/v/
+ else SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).warn("#{program} is not installed #{program_ref}")
false
end
end
@@ -745,7 +789,7 @@ module SiSU_Env
dgst=%x{openssl dgst -md5 #{File.basename(filename)}}.strip #use file name without file path
Dir.chdir(pwd)
dgst.scan(/\S+/)
- else STDERR.puts "\t*WARN* #{program} is not installed #{program_ref}" #if @cmd =~/v/
+ else SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).warn("#{program} is not installed #{program_ref}")
false
end
end
@@ -758,7 +802,7 @@ module SiSU_Env
dgst=%x{openssl dgst -sha256 #{File.basename(filename)}}.strip #use file name without file path
Dir.chdir(pwd)
dgst.scan(/\S+/)
- else STDERR.puts "\t*WARN* #{program} is not installed #{program_ref}" #if @cmd =~/v/
+ else SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).warn("#{program} is not installed #{program_ref}")
false
end
end
@@ -766,7 +810,7 @@ module SiSU_Env
program='psql'
program_ref="\n\t\tpsql requested"
if program_found?(program); true
- else STDERR.puts "\t*WARN* #{program} is not installed #{program_ref}" #if @cmd =~/v/
+ else SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).warn("#{program} is not installed #{program_ref}")
false
end
end
@@ -1030,9 +1074,13 @@ module SiSU_Env
end
end
class InfoEnv < EnvCall
- require 'pathname'
- require 'fileutils'
- include FileUtils
+ begin
+ require 'pathname'
+ require 'fileutils'
+ include FileUtils
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('pathname or fileutils NOT FOUND (LoadError)')
+ end
attr_accessor :filename,:sys,:home,:hostname,:user,:env,:rc,:www,:fnb,:fnn,:fnt,:flv,:webserv_path,:stub_pwd,:stub_src,:webserv_host_cgi,:webserv_port_cgi,:processing,:processing_git,:etc,:yamlrc_dir
@@image_flag,@@local_image=true,true #warning on @@image_flag
@@fb,@@man_path=nil,nil
@@ -1080,7 +1128,7 @@ module SiSU_Env
elsif output_dir_structure.by_filename?
''
else
- SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).mark('set output type, by: language, filetype or filename')
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).warn('set output type, by: language, filetype or filename')
end
@stub_set_manifest=stub + '/manifest'
end
@@ -3169,8 +3217,12 @@ WOK
end
end
class CleanOutput
- require 'fileutils'
- include FileUtils::Verbose
+ begin
+ require 'fileutils'
+ include FileUtils::Verbose
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('fileutils NOT FOUND (LoadError)')
+ end
def initialize(opt)
@opt=opt
z=SiSU_Env::FileMap.new(opt)
@@ -3326,7 +3378,11 @@ WOK
end
class InfoRemote < FileMap
@@flag_remote=false
- require 'socket'
+ begin
+ require 'socket'
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('socket NOT FOUND (LoadError)')
+ end
def initialize(opt)
super(opt) #
@opt=opt
@@ -3674,8 +3730,12 @@ WOK
end
class InfoVersion <InfoEnv
include Singleton
- require 'rbconfig'
- require 'yaml'
+ begin
+ require 'rbconfig'
+ require 'yaml'
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('rbconfig or yaml NOT FOUND (LoadError)')
+ end
@@lib_path=nil
def get_version
@version={}
@@ -3845,6 +3905,53 @@ WOK
true
end
end
+ def plaintext_ocn?
+ if cmd_rc_act[:txt_ocn][:set]==:on \
+ or cmd_rc_act[:ocn][:set]==:on
+ true
+ elsif cmd_rc_act[:txt_ocn][:set]==:off \
+ or cmd_rc_act[:ocn][:set]==:off
+ false
+ elsif doc_rc.is_a?(Method) \
+ and defined? doc_rc.ocn? \
+ and doc_rc.toc? ==:off
+ false
+ elsif env_rc.build.ocn? ==:off
+ false
+ else
+ false
+ end
+ end
+ def odt_ocn?
+ if cmd_rc_act[:odt_ocn][:set]==:on \
+ or cmd_rc_act[:ocn][:set]==:on
+ true
+ elsif cmd_rc_act[:odt_ocn][:set]==:off \
+ or cmd_rc_act[:ocn][:set]==:off
+ false
+ elsif doc_rc.is_a?(Method) \
+ and defined? doc_rc.ocn? \
+ and doc_rc.toc? ==:off
+ false
+ elsif env_rc.build.ocn? ==:off
+ false
+ else
+ false
+ end
+ end
+ def html_strict?
+ if cmd_rc_act[:html_strict][:set]==:on
+ true
+ elsif cmd_rc_act[:html_strict][:set]==:off
+ false
+ elsif doc_rc.is_a?(Method) \
+ and defined? doc_rc.html_strict? \
+ and doc_rc.html_strict? ==:on
+ true
+ else
+ false
+ end
+ end
def toc?
if cmd_rc_act[:toc][:set]==:on
true
@@ -4081,6 +4188,11 @@ WOK
end
self
end
+ def ocn_html_identifier
+ (build.html_strict?) \
+ ? Mx[:ocn_id_char]
+ : ''
+ end
def output_dir_structure
def by_language_code?
if cmd_rc_act[:output_by][:set] == :language
@@ -4291,7 +4403,14 @@ WOK
DBI.connect(sqlite_discrete.dbi)
end
def conn_sqlite3
- SQLite3::Database.new(sqlite_discrete.sqlite3)
+ begin
+ $sqlite3=:yes
+ require 'sqlite3'
+ SQLite3::Database.new(sqlite_discrete.sqlite3)
+ rescue LoadError
+ $sqlite3=:no
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('sqlite3 NOT FOUND (LoadError)')
+ end
end
self
end
diff --git a/lib/sisu/v5/texpdf.rb b/lib/sisu/v5/texpdf.rb
index d0d88886..b67bb545 100644
--- a/lib/sisu/v5/texpdf.rb
+++ b/lib/sisu/v5/texpdf.rb
@@ -61,7 +61,11 @@
=end
module SiSU_TeX
- require 'pstore'
+ begin
+ require 'pstore'
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('pstore NOT FOUND (LoadError)')
+ end
require_relative 'defaults' # defaults.rb
include SiSU_Viz
require_relative 'particulars' # particulars.rb
@@ -78,7 +82,11 @@ module SiSU_TeX
@@n=@@tableheader=@@rights=nil
@@date ||=SiSU_Env::InfoDate.new
class Source
- require 'pstore'
+ begin
+ require 'pstore'
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('pstore NOT FOUND (LoadError)')
+ end
require_relative 'sysenv' # sysenv.rb
include SiSU_Env
include SiSU_Viz
@@ -270,7 +278,7 @@ module SiSU_TeX
and File.size(texfile) > 0
#@tex_f_no+=1
else
- SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).mark("\tzero file size #{@env.processing_path.tex}/#{texfile}")
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error("\tzero file size #{@env.processing_path.tex}/#{texfile}")
end
end
end
@@ -365,7 +373,7 @@ module SiSU_TeX
elsif @md.opt.act[:pdf_p][:set]==:on
'pdfTex portrait'
else
- SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).mark('error: neither landscape nor portrait')
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('error: neither landscape nor portrait')
end
if (@md.opt.act[:verbose][:set]==:on \
|| @md.opt.act[:verbose_plus][:set]==:on \
diff --git a/lib/sisu/v5/txt_plain.rb b/lib/sisu/v5/txt_plain.rb
index ca944a1f..e27e9231 100644
--- a/lib/sisu/v5/txt_plain.rb
+++ b/lib/sisu/v5/txt_plain.rb
@@ -400,7 +400,8 @@ WOK
@@endnotes[:para]=[]
end
def ocn_display(dob)
- if @env.plaintext_ocn?
+ make=SiSU_Env::ProcessingSettings.new(@md)
+ if make.build.plaintext_ocn?
if defined? dob.ocn \
and dob.ocn.is_a?(Fixnum)
(defined? dob.ocn) ? "\n#{Dx[:ocn_o]}#{dob.ocn}#{Dx[:ocn_c]}" : ''
diff --git a/lib/sisu/v5/utils.rb b/lib/sisu/v5/utils.rb
index 97ca24be..1c04d886 100644
--- a/lib/sisu/v5/utils.rb
+++ b/lib/sisu/v5/utils.rb
@@ -127,6 +127,12 @@ module SiSU_Utils
def mark(v=nil,x=nil)
puts set(v,x)
end
+ def warn(v=nil,x=nil)
+ STDERR.puts set(v,'*WARN* ' + x)
+ end
+ def error(v=nil,x=nil)
+ STDERR.puts set(v,'*ERROR* ' + x)
+ end
end
class Path
def initialize(dir=Dir.pwd)
diff --git a/lib/sisu/v5/webrick.rb b/lib/sisu/v5/webrick.rb
index baf468c2..e43d8cd1 100644
--- a/lib/sisu/v5/webrick.rb
+++ b/lib/sisu/v5/webrick.rb
@@ -63,12 +63,16 @@
=end
module SiSU_Webserv
class WebrickStart
+ begin
+ require 'time'
require 'webrick'
include WEBrick
- require 'time'
- require_relative 'sysenv' # sysenv.rb
- include SiSU_Env
- include SiSU_Screen
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('time or webrick NOT FOUND (LoadError)')
+ end
+ require_relative 'sysenv' # sysenv.rb
+ include SiSU_Env
+ include SiSU_Screen
def initialize
begin #%
@cX=SiSU_Screen::Ansi.new('yes').cX
@@ -97,9 +101,13 @@ module SiSU_Webserv
#% wb_top
wb_top=%q(#!/usr/bin/env ruby
# * arch-tag: webrick info on environment, mounted directories, and contents of pwd
- require 'time'
- require 'cgi'
- require 'fcgi'
+ begin
+ require 'time'
+ require 'cgi'
+ require 'fcgi'
+ rescue LoadError
+ puts 'time, cgi or fcgi NOT FOUND (LoadError)'
+ end
ls=Dir.entries('./')
dir_contents=[]
ls.each { |x| dir_contents << "<a href=\"./#{x}/\">#{x}</a><br>" unless x =~/^(\.)+$/ }
diff --git a/lib/sisu/v5/xhtml_epub2.rb b/lib/sisu/v5/xhtml_epub2.rb
index 33e3a529..40033101 100644
--- a/lib/sisu/v5/xhtml_epub2.rb
+++ b/lib/sisu/v5/xhtml_epub2.rb
@@ -61,7 +61,11 @@
=end
module SiSU_XHTML_EPUB2
- require 'pstore'
+ begin
+ require 'pstore'
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('pstore NOT FOUND (LoadError)')
+ end
require_relative 'particulars' # particulars.rb
include SiSU_Particulars
require_relative 'defaults' # defaults.rb
@@ -744,7 +748,8 @@ module SiSU_XHTML_EPUB2
end
def output_zip
FileUtils::mkdir_p(@md.file.output_path.epub.dir) unless FileTest.directory?(@md.file.output_path.epub.dir)
- if FileTest.directory?(@md.env.processing_path.epub)
+ if FileTest.directory?(@md.env.processing_path.epub) \
+ and SiSU_Env::SystemCall.new.zip
pwd=Dir.pwd
Dir.chdir(@md.env.processing_path.epub)
system("
@@ -755,6 +760,8 @@ module SiSU_XHTML_EPUB2
unless @md.opt.act[:maintenance][:set]==:on
FileUtils::rm_r(@md.env.processing_path.epub)
end
+ else
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).mark('*EXITED epub* zip program not found') unless SiSU_Env::SystemCall.new.zip
end
end
def make_cover_image
diff --git a/lib/sisu/v5/xhtml_epub2_format.rb b/lib/sisu/v5/xhtml_epub2_format.rb
index 8dd8a88e..6522378b 100644
--- a/lib/sisu/v5/xhtml_epub2_format.rb
+++ b/lib/sisu/v5/xhtml_epub2_format.rb
@@ -1362,12 +1362,13 @@ output_epub_cont_seg.close
depth=@md.lvs[1] + @md.lvs[2] + @md.lvs[3] + @md.lvs[4]
title=SanitizeXML.xml(@md.title.full)
author=SanitizeXML.xml(@md.author)
+ dgst=(@md.dgst.is_a?(Array) and @md.dgst.length > 1) ? @md.dgst[1] : 'na'
<<-WOK
<!-- four required metadata items (for all NCX documents,
(including the relaxed constraints of OPS 2.0) -->
<title>#{title} by #{author}</title>
<link href="css/xhtml.css" rel="stylesheet" type="text/css" id="main-css" />
- <meta name="dtb:uid" content="urn:uuid:#{@md.dgst[1]}" />
+ <meta name="dtb:uid" content="urn:uuid:#{dgst}" />
<!-- <meta name="epub-creator" content="#{@md.publisher}" /> -->
<meta name="dtb:depth" content="#{depth}" />
<meta name="dtb:totalPageCount" content="0" />
@@ -1579,18 +1580,19 @@ output_epub_cont_seg.close
else ''
end
f=SiSU_Env::FileOp.new(@md)
+ dgst=(@md.dgst.is_a?(Array) and @md.dgst.length > 1) ? @md.dgst[1] : 'na'
<<-WOK
<#{$ep[:o]}metadata
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:opf="http://www.idpf.org/2007/opf"
xmlns:dcterms="http://purl.org/dc/terms/"
xmlns:dc="http://purl.org/dc/elements/1.1/"
- unique-identifier="urn:uuid:#{@md.dgst[1]}" version="2.0">
+ unique-identifier="urn:uuid:#{dgst}" version="2.0">
<dc:title>#{@md.title.full}</dc:title>
#{cover_image}#{author}#{editor}#{translator}#{illustrator}#{language}#{date_published}#{subject}#{rights}
<dc:identifier opf:scheme="URI">#{f.output_path.epub.url.gsub(/http:\/\//,'')}/#{f.base_filename.epub}</dc:identifier>
- <dc:identifier id="bookid">urn:uuid:#{@md.dgst[1]}</dc:identifier>
- <!-- <dc:identifier id="EPB-UUID">urn:uuid:#{@md.dgst[1]}</dc:identifier> -->
+ <dc:identifier id="bookid">urn:uuid:#{dgst}</dc:identifier>
+ <!-- <dc:identifier id="EPB-UUID">urn:uuid:#{dgst}</dc:identifier> -->
</#{$ep[:o]}metadata>
WOK
end
@@ -2132,10 +2134,10 @@ output_epub_cont_seg.close
note=''
if txt =~/(#{Mx[:en_a_o]}.+?#{Mx[:en_a_c]}|#{Mx[:en_b_o]}.+?#{Mx[:en_b_c]})/m # had \s* at end
note=$1
- note=note.gsub(/[\n\s]+/m,' ')
+ note=note.gsub(/[\s]+/m,' ')
txt=txt.gsub(/(?:#{Mx[:en_a_o]}.+?#{Mx[:en_a_c]}|#{Mx[:en_b_o]}.+?#{Mx[:en_b_c]})\s*/m,' ').
- gsub(/<a[\n\s]+"[\n\s]+href="#note_ref\d+">#{$ep[:hsp]}<sup id="note\d+">\d+<\/sup>#{$ep[:hsp]}/m,'').
- gsub(/<a[\n\s]+"[\n\s]+href="#note_ref\d+">#{$ep[:hsp]}<sup id="note\d+">\d+<\/sup>#{$ep[:hsp]}/m,'') #remove
+ gsub(/<a[\n\s]+"[\n\s]+href="##{Mx[:note_ref]}\d+">#{$ep[:hsp]}<sup id="#{Mx[:note]}\d+">\d+<\/sup>#{$ep[:hsp]}/m,'').
+ gsub(/<a[\n\s]+"[\n\s]+href="##{Mx[:note_ref]}\d+">#{$ep[:hsp]}<sup id="#{Mx[:note]}\d+">\d+<\/sup>#{$ep[:hsp]}/m,'') #remove
end
%{<#{tag} class="#{attrib}">
<a href="#o#{@ocn}"><i>#{txt}</i></a> #{note}
diff --git a/lib/sisu/v5/xhtml_epub2_segments.rb b/lib/sisu/v5/xhtml_epub2_segments.rb
index 764fcc17..8612696f 100644
--- a/lib/sisu/v5/xhtml_epub2_segments.rb
+++ b/lib/sisu/v5/xhtml_epub2_segments.rb
@@ -401,7 +401,7 @@ WOK
sto.break
end
if @md.flag_separate_endnotes # may need to revisit, check
- dob.obj=dob.obj.gsub(/"\s+href="#note_ref(\d+)">/,%{" href=\"endnotes#{Sfx[:epub_xhtml]}#note_ref\\1">}) #endnote- twice #removed file type
+ dob.obj=dob.obj.gsub(/"\s+href="##{Mx[:note_ref]}(\d+)">/,%{" href=\"endnotes#{Sfx[:epub_xhtml]}##{Mx[:note_ref]}\\1">}) #endnote- twice #removed file type
end
if (dob.is ==:heading \
|| dob.is==:heading_insert \
diff --git a/lib/sisu/v5/xhtml_epub2_tune.rb b/lib/sisu/v5/xhtml_epub2_tune.rb
index 6ac53c39..82f90366 100644
--- a/lib/sisu/v5/xhtml_epub2_tune.rb
+++ b/lib/sisu/v5/xhtml_epub2_tune.rb
@@ -298,22 +298,22 @@ module SiSU_XHTML_EPUB2_Tune
data.each do |dob|
unless dob.is ==:code
dob.obj=dob.obj.gsub(/(#{Mx[:en_a_o]}|#{Mx[:en_b_o]})(\d+)\s+(.+?)(#{Mx[:en_a_c]}|#{Mx[:en_b_c]})/,
- %{#{Mx[:nbsp]}<a href="#note\\2">#{Mx[:nbsp]}<sup id="note_ref\\2">\\2</sup>#{Mx[:nbsp]}</a> } + #note- endnote-
- %{\\1\\2 <a href="#note_ref\\2">#{Mx[:nbsp]}<sup id="note\\2">\\2.</sup></a> \\3 \\4}). #endnote- note- (careful may have switched)
+ %{#{Mx[:nbsp]}<a href="##{Mx[:note]}\\2">#{Mx[:nbsp]}<sup id="#{Mx[:note_ref]}\\2">\\2</sup>#{Mx[:nbsp]}</a> } + #note- endnote-
+ %{\\1\\2 <a href="##{Mx[:note_ref]}\\2">#{Mx[:nbsp]}<sup id="#{Mx[:note]}\\2">\\2.</sup></a> \\3 \\4}). #endnote- note- (careful may have switched)
gsub(/(#{Mx[:en_b_o]})[*](\d+)\s+(.+?)(#{Mx[:en_b_c]})/,
- %{#{Mx[:nbsp]}<a href="#note_astx\\2">#{Mx[:nbsp]}<sup id="note_ref_astx\\2">#{ast}\\2</sup>#{Mx[:nbsp]}</a> } + #note- endnote-
- %{\\1#{ast}\\2 <a href="#note_ref_astx\\2">#{Mx[:nbsp]}<sup id="note_astx\\2">#{ast}\\2.</sup></a> \\3 \\4}). #endnote- note- (careful may have switched)
+ %{#{Mx[:nbsp]}<a href="##{Mx[:note_astx]}\\2">#{Mx[:nbsp]}<sup id="#{Mx[:note_ref_astx]}\\2">#{ast}\\2</sup>#{Mx[:nbsp]}</a> } + #note- endnote-
+ %{\\1#{ast}\\2 <a href="##{Mx[:note_ref_astx]}\\2">#{Mx[:nbsp]}<sup id="#{Mx[:note_astx]}\\2">#{ast}\\2.</sup></a> \\3 \\4}). #endnote- note- (careful may have switched)
gsub(/(#{Mx[:en_b_o]})[+](\d+)\s+(.+?)(#{Mx[:en_b_c]})/,
- %{#{Mx[:nbsp]}<a href="#note_plus\\2">#{Mx[:nbsp]}<sup id="note_ref_plus\\2">#{pls}\\2</sup>#{Mx[:nbsp]}</a> } + #note- endnote-
- %{\\1#{pls}\\2 <a href="#note_ref_plus\\2">#{Mx[:nbsp]}<sup id="note_plus\\2">#{pls}\\2.</sup></a> \\3 \\4}) #endnote- note- (careful may have switched) # double-check there may here be a bug
+ %{#{Mx[:nbsp]}<a href="##{Mx[:note_plus]}\\2">#{Mx[:nbsp]}<sup id="#{Mx[:note_ref_plus]}\\2">#{pls}\\2</sup>#{Mx[:nbsp]}</a> } + #note- endnote-
+ %{\\1#{pls}\\2 <a href="##{Mx[:note_ref_plus]}\\2">#{Mx[:nbsp]}<sup id="#{Mx[:note_plus]}\\2">#{pls}\\2.</sup></a> \\3 \\4}) #endnote- note- (careful may have switched) # double-check there may here be a bug
if dob.obj =~/#{Mx[:en_a_o]}([*+]+)\s+.+?#{Mx[:en_a_c]}/
m=$1.length.to_i
dob.obj=dob.obj.gsub(/(#{Mx[:en_a_o]})[*]+\s+(.+?)(#{Mx[:en_a_c]})/,
- %{#{Mx[:nbsp]}<a href="#note#{a*m}">#{Mx[:nbsp]}<sup id="note_ref#{a*m}">#{ast*m}</sup>#{Mx[:nbsp]}</a> } + #note- endnote-
- %{\\1#{ast*m} <a href="#note_ref#{a*m}">#{Mx[:nbsp]}<sup id="note#{a*m}">#{ast*m}</sup></a> \\2 \\3}). #endnote- note- (careful may have switched)
+ %{#{Mx[:nbsp]}<a href="##{Mx[:note]}#{a*m}">#{Mx[:nbsp]}<sup id="#{Mx[:note_ref]}#{a*m}">#{ast*m}</sup>#{Mx[:nbsp]}</a> } + #note- endnote-
+ %{\\1#{ast*m} <a href="##{Mx[:note_ref]}#{a*m}">#{Mx[:nbsp]}<sup id="#{Mx[:note]}#{a*m}">#{ast*m}</sup></a> \\2 \\3}). #endnote- note- (careful may have switched)
gsub(/(#{Mx[:en_a_o]})([+]+)\s+(.+?)(#{Mx[:en_a_c]})/,
- %{#{Mx[:nbsp]}<a href="#note#{s*m}">#{Mx[:nbsp]}<sup id="note_ref#{s*m}">#{pls*m}</sup>#{Mx[:nbsp]}</a> } + #note- endnote-
- %{\\1#{pls*m} <a href="#note_ref#{s*m}">#{Mx[:nbsp]}<sup id="note#{s*m}">#{pls*m}</sup></a> \\2 \\3}) #endnote- note- (careful may have switched)
+ %{#{Mx[:nbsp]}<a href="##{Mx[:note]}#{s*m}">#{Mx[:nbsp]}<sup id="#{Mx[:note_ref]}#{s*m}">#{pls*m}</sup>#{Mx[:nbsp]}</a> } + #note- endnote-
+ %{\\1#{pls*m} <a href="##{Mx[:note_ref]}#{s*m}">#{Mx[:nbsp]}<sup id="#{Mx[:note]}#{s*m}">#{pls*m}</sup></a> \\2 \\3}) #endnote- note- (careful may have switched)
end
end
@tuned_file << dob
diff --git a/lib/sisu/v5/xml_fictionbook2.rb b/lib/sisu/v5/xml_fictionbook2.rb
index 6549fa12..c72332bb 100644
--- a/lib/sisu/v5/xml_fictionbook2.rb
+++ b/lib/sisu/v5/xml_fictionbook2.rb
@@ -227,7 +227,11 @@ module SiSU_XML_Fictionbook
endnotes
end
def extract_images #work on
- require "base64"
+ begin
+ require 'base64'
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('base64 NOT FOUND (LoadError)')
+ end
images_raw,images_base64_fb2=[],[]
images_base64={}
if defined? @md.make.cover_image[:cover]
diff --git a/lib/sisu/v5/xml_odf_odt.rb b/lib/sisu/v5/xml_odf_odt.rb
index a6a7a127..d2ab0477 100644
--- a/lib/sisu/v5/xml_odf_odt.rb
+++ b/lib/sisu/v5/xml_odf_odt.rb
@@ -73,8 +73,12 @@ module SiSU_XML_ODF_ODT
require_relative 'txt_shared' # txt_shared.rb
@@alt_id_count,@@alt_id_count,@@tablehead,@@number_of_cols=0,0,0,0
class Source
- require 'zlib'
- require 'find'
+ begin
+ require 'zlib'
+ require 'find'
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('zlib or find NOT FOUND (LoadError)')
+ end
def initialize(opt)
@opt=opt
@particulars=SiSU_Particulars::CombinedSingleton.instance.get_all(opt)
@@ -117,6 +121,7 @@ module SiSU_XML_ODF_ODT
@@fns=nil
def initialize(particulars)
@md,@env,@ao_array=particulars.md,particulars.env,particulars.ao_array
+ @make=SiSU_Env::ProcessingSettings.new(@md)
@vz=SiSU_Viz::Defaults.new
@tab="\t"
@brace_url=SiSU_Viz::Defaults.new.url_decoration
@@ -552,10 +557,10 @@ module SiSU_XML_ODF_ODT
end
p_num={ display: '', set_ref: '' }
if dob.is !~/(^#{Rx[:meta]}|#{Mx[:br_eof]}|#{Mx[:br_endnotes]})/
- if @env.odt_ocn?
+ if @make.build.odt_ocn?
if defined? dob.ocn \
and dob.ocn.is_a?(Fixnum)
- p_num=SiSU_XML_ODF_ODT_Format::ParagraphNumber.new(dob.ocn).set_bookmark_and_display
+ p_num=SiSU_XML_ODF_ODT_Format::ParagraphNumber.new(@make,dob.ocn).set_bookmark_and_display
end
end
end
@@ -678,7 +683,7 @@ module SiSU_XML_ODF_ODT
and (dob.obj =~/~metadata/ or dob =~/#{Mx[:lv_o]}1:meta#{Mx[:lv_x]}\s*Document Information/) #fix Mx[:lv_o]
if dob.is !~/(^#{Rx[:meta]}|#{Mx[:br_eof]}|#{Mx[:br_endnotes]})/ #check
if defined? dob.ocn and dob.ocn =~/\d+/
- @p_num=SiSU_XML_ODF_ODT_Format::ParagraphNumber.new(dob.ocn)
+ @p_num=SiSU_XML_ODF_ODT_Format::ParagraphNumber.new(@make,dob.ocn)
end
if dob.is ==:heading \
|| dob.is ==:para \
@@ -805,7 +810,8 @@ WOK
od.close
opendoc=@md.file.base_filename.odt #watch where output by language
FileUtils::mkdir_p(@md.file.output_path.odt.dir) unless FileTest.directory?(@md.file.output_path.odt.dir)
- if FileTest.directory?(@env.processing_path.odt)
+ if FileTest.directory?(@env.processing_path.odt) \
+ and SiSU_Env::SystemCall.new.zip
pwd=Dir.pwd
Dir.chdir(@env.processing_path.odt)
system("
@@ -813,6 +819,8 @@ WOK
")
FileUtils::mv(opendoc, @md.file.place_file.odt.dir)
Dir.chdir(pwd)
+ else
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).mark('*EXITED odf* zip program not found') unless SiSU_Env::SystemCall.new.zip
end
end
end
diff --git a/lib/sisu/v5/xml_odf_odt_format.rb b/lib/sisu/v5/xml_odf_odt_format.rb
index 2a092011..b56e4284 100644
--- a/lib/sisu/v5/xml_odf_odt_format.rb
+++ b/lib/sisu/v5/xml_odf_odt_format.rb
@@ -65,17 +65,26 @@ module SiSU_XML_ODF_ODT_Format
include SiSU_Param
include SiSU_Viz
class ParagraphNumber
- def initialize(paranum)
+ def initialize(make,paranum)
+ @make=make
@paranum=/(\d+)/m.match(paranum.to_s)[1]
end
def set_ref_and_display
- set_ref=@paranum.gsub(/(\d+)/,' <text:span text:style-name="Span_subscript"><text:reference-mark-start text:name="\1"/><text:reference-mark-end text:name="\1"/></text:span>')
- disp=@paranum.gsub(/(\d+)/,%{ <text:span text:style-name="Span_subscript">#{Dx[:ocn_o]}\\1#{Dx[:ocn_c]}</text:span>})
+ set_ref=@paranum.gsub(/(\d+)/,
+ ' <text:span text:style-name="Span_subscript"><text:reference-mark-start text:name="\1"/><text:reference-mark-end text:name="\1"/></text:span>')
+ disp=@paranum.gsub(/(\d+)/,
+ (@make.build.odt_ocn?) \
+ ? %{ <text:span text:style-name="Span_subscript">#{Dx[:ocn_o]}\\1#{Dx[:ocn_c]}</text:span>}
+ : '')
{ display: disp, set_ref: set_ref }
end
def set_bookmark_and_display
- set_ref=@paranum.gsub(/(\d+)/,' <text:span text:style-name="Span_subscript"><text:bookmark-start text:name="\1"/><text:bookmark-end text:name="\1"/></text:span>')
- disp=@paranum.gsub(/(\d+)/,%{ <text:span text:style-name="Span_subscript">#{Dx[:ocn_o]}\\1#{Dx[:ocn_c]}</text:span>})
+ set_ref=@paranum.gsub(/(\d+)/,
+ ' <text:span text:style-name="Span_subscript"><text:bookmark-start text:name="\1"/><text:bookmark-end text:name="\1"/></text:span>')
+ disp=@paranum.gsub(/(\d+)/,
+ (@make.build.odt_ocn?) \
+ ? %{ <text:span text:style-name="Span_subscript">#{Dx[:ocn_o]}\\1#{Dx[:ocn_c]}</text:span>}
+ : '')
{ display: disp, set_ref: set_ref }
end
def name
diff --git a/lib/sisu/v6/ao_doc_str.rb b/lib/sisu/v6/ao_doc_str.rb
index 0cdd553b..d8c012fd 100644
--- a/lib/sisu/v6/ao_doc_str.rb
+++ b/lib/sisu/v6/ao_doc_str.rb
@@ -163,10 +163,13 @@ module SiSU_AO_DocumentStructureExtract
str=str.gsub(/(^|[ ])\*~([a-z0-9._-]+)(?=[ #{Mx[:br_nl]}]|$)/i,
"\\1#{Mx[:tag_o]}\\2#{Mx[:tag_c]}").
gsub(/ [ ]+/i,' ')
- tags=str.scan(/#{Mx[:tag_o]}(\S+?)#{Mx[:tag_c]}/).flatten
+ tags=str.scan(/#{Mx[:tag_o]}(\S+?)#{Mx[:tag_c]}/).flatten.uniq
str=str.gsub(/[ ]?#{Mx[:tag_o]}\S+?#{Mx[:tag_c]}[ ]?/,' ') #may be issues with spaces would leave one, but "code" blocks?
end
tags=nametag ? (tags << nametag) : tags
+ tags.each do |t|
+ t.gsub!(/[^a-z0-9._-]/,'')
+ end
end
[str,tags]
end
diff --git a/lib/sisu/v6/ao_hash_digest.rb b/lib/sisu/v6/ao_hash_digest.rb
index b2fd8bfd..ce45b9e4 100644
--- a/lib/sisu/v6/ao_hash_digest.rb
+++ b/lib/sisu/v6/ao_hash_digest.rb
@@ -75,7 +75,11 @@ module SiSU_AO_Hash
data=@data.compact
@tuned_file=[]
sha_ =(@env.digest.type=='sha256' ? true : false)
- sha_ ? (require 'digest/sha2') : (require 'digest/md5')
+ begin
+ sha_ ? (require 'digest/sha2') : (require 'digest/md5')
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error((sha_ ? 'digest/sha2' : 'digest/md5') + ' NOT FOUND')
+ end
data.each do |t_o|
unless t_o.obj.is_a?(Array)
t_o.obj=t_o.obj.strip
diff --git a/lib/sisu/v6/ao_images.rb b/lib/sisu/v6/ao_images.rb
index 76721d63..0279994d 100644
--- a/lib/sisu/v6/ao_images.rb
+++ b/lib/sisu/v6/ao_images.rb
@@ -62,8 +62,12 @@
=end
module SiSU_AO_Images
class Images
- #require 'RMagick'
- #include Magick
+ #begin
+ # require 'RMagick'
+ # include Magick
+ #rescue LoadError
+ # SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('RMagic NOT FOUND (LoadError)')
+ #end
def initialize(md,data)
@md,@data=md,data
end
diff --git a/lib/sisu/v6/ao_numbering.rb b/lib/sisu/v6/ao_numbering.rb
index 23d9fd73..acb2351a 100644
--- a/lib/sisu/v6/ao_numbering.rb
+++ b/lib/sisu/v6/ao_numbering.rb
@@ -78,6 +78,14 @@ module SiSU_AO_Numbering
data=set_heading_top(data) unless @md.set_heading_top
[data,tags_map,ocn_html_seg_map]
end
+ def set_tags(tags,tag)
+ tags=if not tag.empty? \
+ and tag !~/^\d+$/
+ tag=tag.gsub(/[^a-z0-9._-]/,'')
+ [tag,tags].flatten
+ else tags
+ end
+ end
def number_plaintext_para(data)
@tuned_file=[]
data.each do |dob|
@@ -168,10 +176,10 @@ module SiSU_AO_Numbering
and not @md.seg_names.include?(title_no)
if dob.ln==no1
dob.name="#{title_no}" if not dob.name
- dob.tags=[title_no,dob.tags].flatten if title_no !~/^\d+$/ #check whether will work across file types with stop signs
+ dob.tags=set_tags(dob.tags,title_no)
tag=dob.obj.gsub(/(Article|Clause|Section|Chapter)\s+/,"\\1_#{title_no}").downcase
tag=heading_tag_clean(tag)
- dob.tags=[tag,dob.tags].flatten if tag !~/^\d+$/ #check whether will work across file types with stop signs
+ dob.tags=set_tags(dob.tags,tag)
dob.obj=(dob.obj =~/(Article|Clause|Section)\s+/) \
? (dob.obj.gsub(/(Article|Clause|Section)\s+/,"\\1 #{title_no} "))
: (dob.obj.gsub(/^/,"#{title_no}. ")) #fix stop later
@@ -179,7 +187,7 @@ module SiSU_AO_Numbering
if dob.ln !=no1 \
and dob.obj =~/^[\d.]+\s/ #fix -> if the title starts with a numbering scheme, do not auto-number, review
dob.name ="#{title_no}" if not dob.name
- dob.tags=[title_no,dob.tags].flatten if title_no !~/^\d+$/ #check whether will work across file types with stop signs
+ dob.tags=set_tags(dob.tags,title_no)
dob.obj=dob.obj.gsub(/^/,"#{title_no}. ")
end
@md.seg_names << title_no
@@ -187,28 +195,28 @@ module SiSU_AO_Numbering
if dob.ln!=no1 \
and dob.name!~/^[a-z_\.]+$/ \
and dob.obj !~/[A-Z]\.?\s/ #bug -> tmp fix, excludes A. B. C. lettering, but not roman numerals, is arbitrary, review required # not fixed, work on
- dob.tags=[title_no,dob.tags].flatten if title_no !~/^\d+$/ #check whether will work across file types with stop signs
+ dob.tags=set_tags(dob.tags,title_no)
dob.obj=dob.obj.gsub(/^/i,"#{title_no}. ")
end
end
if dob.ln==no1 #watch because here you change dob.name
- dob.tags=["h#{title_no}",dob.tags].flatten #check whether will work across file types with stop signs
+ dob.tags=set_tags(dob.tags,"h#{title_no}")
end
if dob.ln==no2 #watch because here you change dob.name
t_no2+=1; t_no3=0
title_no="#{t_no1}.#{t_no2}"
- dob.tags=["h#{title_no}",dob.tags].flatten #check whether will work across file types with stop signs
+ dob.tags=set_tags(dob.tags,"h#{title_no}")
dob=number_sub_heading(dob,no2,title_no)
end
if dob.ln==no3 #watch because here you change dob.name
t_no3+=1
title_no="#{t_no1}.#{t_no2}.#{t_no3}"
- dob.tags=["h#{title_no}",dob.tags].flatten #check whether will work across file types with stop signs
+ dob.tags=set_tags(dob.tags,"h#{title_no}")
dob=number_sub_heading(dob,no3,title_no)
end
elsif dob.ln.to_s =~/^[0-6]/ \
and dob.name =~ /^[\w-]+-/ # endnotes, watch2005# endnotes, watch2005
- dob.tags=[dob.name,dob.tags].flatten if dob.name !~/^\d+$/ #check whether will work across file types with stop signs
+ dob.tags=set_tags(dob.tags,dob.name)
dob.name.gsub(/^([a-z_\.]+)-$/,'\1')
end
elsif dob.is ==:heading \
@@ -219,13 +227,13 @@ module SiSU_AO_Numbering
and dob.ln.to_s =~/^[0-9]/ \
and dob.obj =~ /^([\d\.]+)/ #risky (must be unique) consider output to 4~~\d instead of 4~\d
dob.name=$1
- dob.tags=[dob.name,dob.tags].flatten if dob.name !~/^\d+$/ #check whether will work across file types with stop signs
+ dob.tags=set_tags(dob.tags,dob.name)
end
if @md.toc_lev_limit
end
elsif defined? dob.name \
and dob.name
- dob.tags=[dob.name,dob.tags].flatten if dob.name !~/^\d+$/ #check whether will work across file types with stop signs
+ dob.tags=set_tags(dob.tags,dob.name)
end
dob.tags=dob.tags.uniq if defined? dob.tags
@tuned_file << dob
@@ -312,7 +320,7 @@ module SiSU_AO_Numbering
if @md.seg_names.is_a?(Array) \
and not @md.seg_names.include?(possible_seg_name)
dob.name=possible_seg_name
- dob.tags=[dob.name,dob.tags].flatten if dob.name !~/^\d+$/
+ dob.tags=set_tags(dob.tags,dob.name)
@md.seg_names << possible_seg_name
elsif (@md.opt.act[:verbose_plus][:set]==:on \
or @md.opt.act[:maintenance][:set]==:on)
@@ -323,7 +331,7 @@ module SiSU_AO_Numbering
and dob.name #extract segment name from embedded document structure info
if @md.seg_names.is_a?(Array) \
and not @md.seg_names.include?(dob.name)
- dob.tags=[dob.name,dob.tags].flatten if dob.name !~/^\d+$/
+ dob.tags=set_tags(dob.tags,dob.name)
@md.seg_names << dob.name
end
end
@@ -334,7 +342,7 @@ module SiSU_AO_Numbering
if @md.seg_names.is_a?(Array) \
and not @md.seg_names.include?(segn_auto)
dob.name=segn_auto
- dob.tags=[dob.name,dob.tags].flatten if dob.name !~/^\d+$/ #check whether will work across file types with stop signs
+ dob.tags=set_tags(dob.tags,dob.name)
@md.seg_names << segn_auto
else puts 'segment name (numbering) error'
end
diff --git a/lib/sisu/v6/cgi_pgsql.rb b/lib/sisu/v6/cgi_pgsql.rb
index 2bcd42e3..26db0341 100644
--- a/lib/sisu/v6/cgi_pgsql.rb
+++ b/lib/sisu/v6/cgi_pgsql.rb
@@ -74,12 +74,12 @@ module SiSU_CGI_PgSQL
get_init=SiSU_Env::GetInit.new
@rc=get_init.sisu_yaml.rc
@name_of={}
- @name_of[:output_dir_structure]=if @opt.dir_structure_by.to_s =~/(?:language|filetype|filename)/
- @opt.dir_structure_by.to_s
+ @name_of[:output_dir_structure]=if opt.dir_structure_by.to_s =~/(?:language|filetype|filename)/
+ opt.dir_structure_by.to_s
else 'language'
end
- @name_of[:lingual]=if @opt.lingual.to_s =~/(?:mono|multi)/
- @opt.lingual.to_s
+ @name_of[:lingual]=if opt.lingual.to_s =~/(?:mono|multi)/
+ opt.lingual.to_s
else 'multi'
end
if defined? @rc['search'] \
@@ -93,13 +93,13 @@ module SiSU_CGI_PgSQL
@name_of[:db]=@env.path.stub_pwd #'sisu' #breaks if not present
false
end
- @name_of[:host_url_cgi]="#{@env.url.webserv_base_cgi(@opt)}/cgi-bin"
- @name_of[:host_url_docs]=@env.url.webserv_files_from_db(@opt)
- @name_of[:cgi_script]=@env.url.cgi_sample_search_form_name(@opt)
- @name_of[:user]=@db.psql.user(@opt)
+ @name_of[:host_url_cgi]="#{@env.url.webserv_base_cgi(opt)}/cgi-bin"
+ @name_of[:host_url_docs]=@env.url.webserv_files_from_db(opt)
+ @name_of[:cgi_script]=@env.url.cgi_sample_search_form_name(opt)
+ @name_of[:user]=@db.psql.user(opt)
@cgi_file_name=@name_of[:cgi_script]
- @image_src="#{@env.url.webserv_base_cgi(@opt)}/_sisu/image_sys"
- @common=SiSU_CGI_SQL::CGI_Common.new(@webserv,@opt,@image_src,@env)
+ @image_src="#{@env.url.webserv_base_cgi(opt)}/_sisu/image_sys"
+ @common=SiSU_CGI_SQL::CGI_Common.new(@webserv,opt,@image_src,@env)
end
def pgsql
serve=[]
@@ -174,13 +174,13 @@ module SiSU_CGI_PgSQL
sudo chmod -v 755 /usr/lib/cgi-bin/#{@cgi_file_name}
WOK
end
- SiSU_Screen::Ansi.new(opt.act[:color_state][:set],a).warn
+ SiSU_Screen::Ansi.new(@opt.act[:color_state][:set],a).warn
a=<<-WOK
#{@env.webserv_base_cgi(@opt)}/cgi-bin/#{@cgi_file_name}
WOK
- SiSU_Screen::Ansi.new(opt.act[:color_state][:set],a).print_blue
+ SiSU_Screen::Ansi.new(@opt.act[:color_state][:set],a).print_blue
a="\n\t(to create and populate postgresql database see 'man sisu' and in particular the --pg option)\n\t[the database to be used for this directory (#{@db.psql.db}) will have to be created manually if it does not exist,\n\tusing postgresql tools directly: 'createdb #{@db.psql.db}' for a list of existing databases try 'psql --list']"
- SiSU_Screen::Ansi.new(opt.act[:color_state][:set],a).txt_grey
+ SiSU_Screen::Ansi.new(@opt.act[:color_state][:set],a).txt_grey
else puts 'failed in attempt to write #{@cgi_file_name} to present directory, is directory writable?'
end
end
@@ -192,9 +192,13 @@ module SiSU_CGI_PgSQL
* Description: generates naive cgi search form for search of sisu database (pgsql)
#{gpl}
=end
- require 'cgi'
- require 'fcgi'
- require 'dbi'
+ begin
+ require 'cgi'
+ require 'fcgi'
+ require 'dbi'
+ rescue LoadError
+ puts 'cgi, fcgi or dbi NOT FOUND (LoadError)'
+ end
@stub_default='#{@name_of[:db]}'
@image_src='#{@image_src}'
@hosturl_cgi='#{@name_of[:host_url_cgi]}'
diff --git a/lib/sisu/v6/cgi_sqlite.rb b/lib/sisu/v6/cgi_sqlite.rb
index fff0f98f..6db31b48 100644
--- a/lib/sisu/v6/cgi_sqlite.rb
+++ b/lib/sisu/v6/cgi_sqlite.rb
@@ -69,18 +69,18 @@ module SiSU_CGI_SQLite
@opt,@webserv=opt,webserv
@cX=SiSU_Screen::Ansi.new(opt.act[:color_state][:set]).cX
@env=SiSU_Env::InfoEnv.new('',opt)
- @image_src="#{@env.url.webserv_cgi(@opt)}/_sisu/image_sys"
+ @image_src="#{@env.url.webserv_cgi(opt)}/_sisu/image_sys"
@name_of={}
- @name_of[:output_dir_structure]=if @opt.dir_structure_by.to_s =~/(?:language|filetype|filename)/
- @opt.dir_structure_by.to_s
+ @name_of[:output_dir_structure]=if opt.dir_structure_by.to_s =~/(?:language|filetype|filename)/
+ opt.dir_structure_by.to_s
else 'language'
end
- @name_of[:lingual]=if @opt.lingual.to_s =~/(?:mono|multi)/
- @opt.lingual.to_s
+ @name_of[:lingual]=if opt.lingual.to_s =~/(?:mono|multi)/
+ opt.lingual.to_s
else 'multi'
end
- @common=SiSU_CGI_SQL::CGI_Common.new(@webserv,@opt,@image_src,@env)
- @cgi_file_name=@env.url.cgi_sample_search_form_name(@opt)
+ @common=SiSU_CGI_SQL::CGI_Common.new(@webserv,opt,@image_src,@env)
+ @cgi_file_name=@env.url.cgi_sample_search_form_name(opt)
@name_of_sqlite_db_file='sisu_sqlite.db'
end
def sqlite
@@ -147,13 +147,13 @@ module SiSU_CGI_SQLite
WOK
end
b='(to create and populate sisu sqlite database see "man sisu" and in particular the -d flag)'
- SiSU_Screen::Ansi.new(opt.act[:color_state][:set],a,b).warn
+ SiSU_Screen::Ansi.new(@opt.act[:color_state][:set],a,b).warn
a=<<-WOK
#{@env.webserv_base_cgi(@opt)}/cgi-bin/#{@cgi_file_name}
WOK
- SiSU_Screen::Ansi.new(opt.act[:color_state][:set],a).print_blue
+ SiSU_Screen::Ansi.new(@opt.act[:color_state][:set],a).print_blue
else puts "failed in attempt to write #{@cgi_file_name} to present directory, is directory writable?"
end
end
@@ -165,9 +165,13 @@ module SiSU_CGI_SQLite
* Description: generates naive cgi search form for search of sisu database (sqlite)
#{gpl}
=end
- require 'cgi'
- require 'fcgi'
- require 'dbi'
+ begin
+ require 'cgi'
+ require 'fcgi'
+ require 'dbi'
+ rescue LoadError
+ puts 'cgi, fcgi or dbi NOT FOUND (LoadError)'
+ end
@stub_default='sisu_sqlite'
@image_src='#{@image_src}'
@hosturl_cgi='#{@env.url.webserv_base_cgi(@opt)}/cgi-bin'
diff --git a/lib/sisu/v6/composite.rb b/lib/sisu/v6/composite.rb
index 044f31c4..ebbd14f6 100644
--- a/lib/sisu/v6/composite.rb
+++ b/lib/sisu/v6/composite.rb
@@ -178,10 +178,14 @@ module SiSU_Assemble
end
tuned_file << if loadfile =~ /(?:https?|file):\/\/\S+?\.ss[ti]$/ # and NetTest
imagedir = /((?:https?|file):\/\/\S+?)\/[^\/]+?\.ss[ti]$/.match(loadfile).captures.join + '/_sisu/image' #watch
- require 'uri'
+ begin
+ require 'uri'
+ require 'open-uri'
+ require 'pp'
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('uri, open-uri or pp NOT FOUND (LoadError)')
+ end
image_uri=URI.parse(imagedir)
- require 'open-uri'
- require 'pp'
insert=open(loadfile)
insert_array=insert.dup
insert.close
diff --git a/lib/sisu/v6/concordance.rb b/lib/sisu/v6/concordance.rb
index a20178ab..5422056f 100644
--- a/lib/sisu/v6/concordance.rb
+++ b/lib/sisu/v6/concordance.rb
@@ -240,12 +240,13 @@ WOK
end
end
protected
- def location_scroll(wordlocation,show)
- %{<a href="doc#{@md.lang_code_insert}#{Sfx[:html]}\##{wordlocation}">#{wordlocation}</a>; }
+ def location_scroll(wordlocation,show) # not used
+ %{<a href="doc#{@md.lang_code_insert}#{Sfx[:html]}\##{Mx[:ocn_id_char]}#{wordlocation}">#{wordlocation}</a>; }
end
- def location_seg(wordlocation,show) ##fix
+ def location_seg(wordlocation,show)
unless wordlocation.nil?
- wl=wordlocation.gsub(/(.+?)\#(\d+)/,"\\1#{@md.lang_code_insert}#{Sfx[:html]}#\\2")
+ wl=wordlocation.gsub(/(.+?)\#(\d+)/,
+ "\\1#{@md.lang_code_insert}#{Sfx[:html]}##{Mx[:ocn_id_char]}\\2") # id="o\d+" always available; a name="\d+" not available if html strict used
case wordlocation
when /#{@rxp_t1}|@rxp_t2}|#{@rxp_t3}/
%{[<a href="doc#{@md.lang_code_insert}#{Sfx[:html]}##{show}">H</a>]#{show}, }
diff --git a/lib/sisu/v6/constants.rb b/lib/sisu/v6/constants.rb
index 34ff92e7..e70a2f98 100644
--- a/lib/sisu/v6/constants.rb
+++ b/lib/sisu/v6/constants.rb
@@ -101,6 +101,13 @@ Xx={
html_relative1: '※',
}
Mx={
+ ocn_id_char: 'o',
+ note: 'note_',
+ note_ref: 'noteref_',
+ note_astx: 'note_astx_',
+ note_ref_astx: 'noteref_astx_',
+ note_plus: 'note_plus_',
+ note_ref_plus: 'noteref_plus_',
meta_o: '〔@', meta_c: '〕',
lv_o_0: 0,
lv_o_1: 1,
diff --git a/lib/sisu/v6/db_import.rb b/lib/sisu/v6/db_import.rb
index e9fc4d5c..e1342b1d 100644
--- a/lib/sisu/v6/db_import.rb
+++ b/lib/sisu/v6/db_import.rb
@@ -66,7 +66,6 @@ module SiSU_DbImport
require_relative 'db_load_tuple' # db_load_tuple.rb
require_relative 'db_sqltxt' # db_sqltxt.rb
require_relative 'html_lite_shared' # html_lite_shared.rb
- require 'sqlite3'
class Import < SiSU_DbText::Prepare
include SiSU_Param
include SiSU_Screen
diff --git a/lib/sisu/v6/dbi.rb b/lib/sisu/v6/dbi.rb
index 6804ab97..acb75e0f 100644
--- a/lib/sisu/v6/dbi.rb
+++ b/lib/sisu/v6/dbi.rb
@@ -120,9 +120,12 @@ manually create the database: "#{cX.green}#{@db.db}#{cX.off}" if it does not yet
end
def read_sqlite
begin
- @conn=@db.sqlite.conn_sqlite3
- rescue
- ensure
+ begin
+ require 'sqlite3'
+ @conn=@db.sqlite.conn_sqlite3
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('sqlite3 NOT FOUND (LoadError)')
+ end
end
end
def connect
diff --git a/lib/sisu/v6/dbi_discrete.rb b/lib/sisu/v6/dbi_discrete.rb
index b842c767..0ac84db4 100644
--- a/lib/sisu/v6/dbi_discrete.rb
+++ b/lib/sisu/v6/dbi_discrete.rb
@@ -69,8 +69,12 @@ module SiSU_DBI_Discrete #% database building
include SiSU_DbDBI
require_relative 'html_lite_shared' # html_lite_shared.rb
include SiSU_FormatShared
- require 'fileutils'
- include FileUtils::Verbose
+ begin
+ require 'fileutils'
+ include FileUtils::Verbose
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('fileutils NOT FOUND (LoadError)')
+ end
class SQL
def initialize(opt)
SiSU_Env::Load.new('dbi',true).prog
@@ -145,9 +149,12 @@ module SiSU_DBI_Discrete #% database building
end
def read_sqlite
begin
- @conn=@db.sqlite.conn_sqlite3
- rescue
- ensure
+ begin
+ require 'sqlite3'
+ @conn=@db.sqlite.conn_sqlite3
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('sqlite3 not available')
+ end
end
end
def connect
diff --git a/lib/sisu/v6/defaults.rb b/lib/sisu/v6/defaults.rb
index ca3c0c04..a26edae9 100644
--- a/lib/sisu/v6/defaults.rb
+++ b/lib/sisu/v6/defaults.rb
@@ -62,7 +62,11 @@
=end
$latex_run=nil
module SiSU_Viz
- require 'uri'
+ begin
+ require 'uri'
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('uri NOT FOUND (LoadError)')
+ end
require_relative 'sysenv' # sysenv.rb
include SiSU_Env
require_relative 'css' # css.rb
diff --git a/lib/sisu/v6/digests.rb b/lib/sisu/v6/digests.rb
index 954185d9..e708e4e9 100644
--- a/lib/sisu/v6/digests.rb
+++ b/lib/sisu/v6/digests.rb
@@ -91,9 +91,13 @@ module SiSU_DigestView
if @opt.act[:verbose_plus][:set]==:on \
or @opt.act[:maintenance][:set]==:on
SiSU_Screen::Ansi.new(@opt.act[:color_state][:set],@opt.fns,"file://#{@md.file.output_path.hash_digest.dir}/#{@md.file.base_filename.hash_digest}").flow
+ end
+ end
+ if SiSU_Env::SystemCall.new.openssl
+ SiSU_DigestView::Source::Scroll.new(@particulars).songsheet
+ else
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('*EXITED* hash digests will not run without openssl')
end
- end
- SiSU_DigestView::Source::Scroll.new(@particulars).songsheet
rescue
SiSU_Errors::Rescued.new($!,$@,@opt.cmd,@opt.fns).location do
__LINE__.to_s + ':' + __FILE__
diff --git a/lib/sisu/v6/html.rb b/lib/sisu/v6/html.rb
index 8a909677..8c9869e2 100644
--- a/lib/sisu/v6/html.rb
+++ b/lib/sisu/v6/html.rb
@@ -61,7 +61,11 @@
=end
module SiSU_HTML
- require 'pstore'
+ begin
+ require 'pstore'
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('pstore NOT FOUND (LoadError)')
+ end
require_relative 'particulars' # particulars.rb
include SiSU_Particulars
require_relative 'defaults' # defaults.rb
@@ -241,6 +245,7 @@ module SiSU_HTML
def initialize(md=nil,data='')
@data,@md=data,md
@vz=SiSU_Viz::Defaults.new
+ @ocn_html_identifier=SiSU_Env::ProcessingSettings.new(@md).ocn_html_identifier
@tell=SiSU_Screen::Ansi.new(@md.opt.act[:color_state][:set]) if @md
end
def songsheet #extracts toc for scroll & seg
@@ -352,7 +357,7 @@ WOK
title=if dob.ocn ==0 then linkname
else
@@toc[:scr] << '<br />'
- %{<b><a href="##{dob.ocn}">#{linkname}</a></b>}
+ %{<b><a href="##{@ocn_html_identifier}#{dob.ocn}">#{linkname}</a></b>}
end
txt_obj={ txt: title }
format_toc=SiSU_HTML_Format::FormatToc.new(@md,txt_obj)
@@ -394,7 +399,7 @@ WOK
end
else
@@toc[:scr] << '<br />'
- %{<b><a href="##{dob.ocn}">#{linkname}</a></b>}
+ %{<b><a href="##{@ocn_html_identifier}#{dob.ocn}">#{linkname}</a></b>}
end
txt_obj={ txt: title }
format_toc=SiSU_HTML_Format::FormatToc.new(@md,txt_obj)
@@ -511,7 +516,7 @@ WOK
}
f=@md.file.base_filename.html_seg(fnh)
p_num=SiSU_HTML_Format::ParagraphNumber.new(@md,ocn)
- lnk_n_txt=%{ <a href="#{f}##{ocn}">
+ lnk_n_txt=%{ <a href="#{f}##{@ocn_html_identifier}#{ocn}">
#{linkname}
</a>}
txt_obj={ txt: lnk_n_txt }
@@ -536,7 +541,7 @@ WOK
}
f=@md.file.base_filename.html_seg(fnh)
p_num=SiSU_HTML_Format::ParagraphNumber.new(@md,ocn)
- lnk_n_txt=%{ <a href="#{f}##{ocn}">
+ lnk_n_txt=%{ <a href="#{f}##{@ocn_html_identifier}#{ocn}">
#{linkname}
</a>}
txt_obj={ txt: lnk_n_txt }
@@ -618,7 +623,8 @@ WOK
toc_shared << format_txt_obj.center_bold
@segtoc << format_txt_obj.center_bold
if defined? @md.creator.author
- creator_endnote=@md.creator.author.gsub(/(\*+)/,
+ creator=SiSU_HTML_Tune::CleanHTML.new(@md.creator.author).clean_for_html
+ creator_endnote=creator.gsub(/(\*+)/,
%{&nbsp;<sup><a href="#notes">\\1</a></sup>})
tmp_head=creator_endnote + "\n"
txt_obj={ txt: tmp_head }
diff --git a/lib/sisu/v6/html_format.rb b/lib/sisu/v6/html_format.rb
index bf1703a1..de5a7144 100644
--- a/lib/sisu/v6/html_format.rb
+++ b/lib/sisu/v6/html_format.rb
@@ -66,30 +66,36 @@ module SiSU_HTML_Format
def initialize(md,ocn)
@md,@ocn=md,ocn.to_s
@ocn ||=''
+ @ocn_html_identifier=SiSU_Env::ProcessingSettings.new(@md).ocn_html_identifier
+ @make=SiSU_Env::ProcessingSettings.new(@md)
end
def ocn_display
- make=SiSU_Env::ProcessingSettings.new(@md)
- if make.build.ocn?
- ocn_class='ocn'
+ if @make.build.ocn?
if @ocn.to_i==0 \
or @ocn.empty?
- %{<label class="ocn_off">&nbsp;</label>}
+ ''
else
+ name=(@make.build.html_strict?) ? '' : %{ name="#{@ocn}"}
@ocn.gsub(/^(\d+|)$/,
- %{<label class="#{ocn_class}"><a name="#{@ocn}" href="##{@ocn}" class="lnk#{ocn_class}">\\1</a></label>})
+ %{<label class="ocn"><a#{name} href="##{@ocn_html_identifier}#{@ocn}" class="lnkocn">\\1</a></label>})
end
else
- %{<label class="ocn_off">&nbsp;</label>}
+ ''
end
end
def name
- (@ocn==nil || @ocn.empty?) ? '' : %{<a name="#{@ocn}"></a>}
+ if @make.build.html_strict? \
+ or @ocn==(nil || @ocn.empty?)
+ ''
+ else
+ %{<a name="#{@ocn}"></a>}
+ end
end
def id #w3c? "tidy" complains about numbers as identifiers ! annoying
(@ocn==nil || @ocn.empty?) ? '' : %{id="o#{@ocn}"}
end
def goto
- (@ocn==nil || @ocn.empty?) ? '' : %{<a href="##{@ocn}">}
+ (@ocn==nil || @ocn.empty?) ? '' : %{<a href="##{@ocn_html_identifier}#{@ocn}">}
end
end
class HeadInformation
@@ -271,24 +277,6 @@ module SiSU_HTML_Format
else ''
end
end
- def pdf #retired 2.7.9
- pdf=if @md.programs[:pdf] \
- and @cf_defaults.cf_0 =~/p/
- %{
-<td align="center" bgcolor=#{@vz.color_band2}>
- <a href="#{Xx[:html_relative1]}pdf/#{@file.base_filename.pdf_p}" target="_top">
- #{@vz.nav_txt_pdf_portrait}
- </a>
-</td>
-<td align="center" bgcolor=#{@vz.color_band2}>
- <a href="#{Xx[:html_relative1]}pdf/#{@file.base_filename.pdf_l}" target="_top">
- #{@vz.nav_txt_pdf_landscape}
- </a>
-</td>
-}
- else ''
- end
- end
end
class XML
end
@@ -514,7 +502,8 @@ WOK
end
def rights
def all
- rights=@md.rights.all.gsub(/^\s*Copyright\s+\(C\)/,'Copyright <sup>&copy;</sup>&nbsp;')
+ rights=SiSU_HTML_Tune::CleanHTML.new(@md.rights.all).clean_for_html
+ rights=rights.gsub(/^\s*Copyright\s+\(C\)/,'Copyright <sup>&copy;</sup>&nbsp;')
%{<p class="small_left">Rights: #{rights}</p>
<p />}
end
@@ -648,8 +637,6 @@ WOK
def initialize(md)
super(md)
end
- def title_banner(title,subtitle,creator)
- end
def dot_control_pre_next
pre="#{@seg_name_html[@seg_name_html_tracker-1]}#{@md.lang_code_insert}#{Sfx[:html]}"
up=@toc
@@ -894,6 +881,7 @@ WOK
attr_accessor :md,:t_o,:txt,:ocn,:format,:table,:link,:linkname,:paranum,:p_num,:headname,:banner,:url
def initialize(md,t_o)
@md,@t_o=md,t_o
+ @make=SiSU_Env::ProcessingSettings.new(@md)
if t_o.is_a?(Hash)
@txt =t_o[:txt] || nil
@ocn =t_o[:ocn] || nil
@@ -917,19 +905,19 @@ WOK
p caller
end
end
- @headnamed= (@headname ? %{<a name="h#{@headname}" id="h#{@headname}"></a>} : nil)
+ @headnamed=(@headname ? %{<a id="h#{@headname}"></a>} : nil)
if @txt and not @txt.empty?
@txt=@txt.gsub(/#{Mx[:mk_o]}[-~]##{Mx[:mk_c]}/,'')
end
@p_num=ParagraphNumber.new(@md,@ocn)
@vz=SiSU_Viz::Defaults.new
- @make=SiSU_Env::ProcessingSettings.new(@md)
end
def nametags_scroll(dob)
tags=''
if defined? dob.tags \
and dob.tags.length > 0 # insert tags "hypertargets"
dob.tags.each do |t|
+ t=t.gsub(/[^a-z0-9._-]/,'') #use for all html tags? consider limiting to strict? or implementing earlier
tags=tags << %{<named id="#{t}" />}
end
end
@@ -940,7 +928,16 @@ WOK
if defined? dob.tags \
and dob.tags.length > 0 # insert tags "hypertargets"
dob.tags.each do |t|
- tags=tags << %{<a name="#{t}" ></a>}
+ t=t.gsub(/[^a-z0-9._-]/,'') #use for all html tags? consider limiting to strict? or implementing earlier
+ if @make.build.html_strict?
+ tags=(t =~/^[#{Mx[:ocn_id_char]}]?[0-9.]+$/) \
+ ? tags #check what can be sorted in ao
+ : (tags << %{<a name="#{t}" ></a>})
+ else
+ tags=(t =~/^[#{Mx[:ocn_id_char]}][0-9.]+$/) \
+ ? tags #check what can be sorted in ao
+ : (tags << %{<a name="#{t}" ></a>})
+ end
end
end
tags
@@ -949,8 +946,8 @@ WOK
hn=if @t_o.is ==:heading \
and not @t_o.name.empty? #determine use
hn=(@t_o.is ==:heading) \
- ? (%{<a name="h#{@t_o.name}" id="h#{@t_o.name}"></a>})
- : (%{<a name="#{@t_o.name}" id="#{@t_o.name}"></a>})
+ ? (%{<a id="h#{@t_o.name}"></a>})
+ : (%{<a id="#{@t_o.name}"></a>})
else nil
end
hn
@@ -981,7 +978,9 @@ WOK
end
def para_form_css(tag,attrib) # regular paragraphs shaped here
ul=ulc=''
- ul,ulc="<ul>\n ","\n </ul>" if @tag =~/li/
+ if tag =~/li/
+ ul,ulc="<ul>\n ","\n </ul>"
+ end
%{
<div class="substance">
#{@p_num.ocn_display}
@@ -1037,7 +1036,7 @@ WOK
<div class="substance">
#{@p_num.ocn_display}
<#{tag} class="#{attrib}" #{@p_num.id}>#{@p_num.name}
- #{@named}<a name="h#{@headname}">#{@txt}</a>
+ #{@named}#{@txt}
</#{tag}>
</div>
}
@@ -1151,8 +1150,6 @@ WOK
#{@vz.table_close}}
end
def bold_heading
- @txt=@txt.gsub(/[1-9]~(\S+)/,'<a name="\1"></a>').
- gsub(/[1-9]~/,'')
%{<p class="bold">
#{@txt}
</p>
@@ -1245,6 +1242,7 @@ WOK
end
def subtoc_lev(tag,attrib)
@txt=clean(@txt)
+ @ocn_html_identifier=SiSU_Env::ProcessingSettings.new(@md).ocn_html_identifier
txt=if @txt \
and @txt =~/<\/?i>|<a\s+name="\S+?">/mi
@txt.gsub(/<\/?i>|<a\s+name="\S+?">/mi,'') #removes name markers from subtoc, go directly to substantive text
@@ -1253,12 +1251,12 @@ WOK
note=''
if txt =~/(#{Mx[:en_a_o]}.+?#{Mx[:en_a_c]}|#{Mx[:en_b_o]}.+?#{Mx[:en_b_c]})/m # had \s* at end
note=$1
- note=note.gsub(/[\n\s]+/m,' ')
+ note=note.gsub(/[\s]+/m,' ')
txt=txt.gsub(/(?:#{Mx[:en_a_o]}.+?#{Mx[:en_a_c]}|#{Mx[:en_b_o]}.+?#{Mx[:en_b_c]})\s*/m,' ').
- gsub(/<a[\n\s]+name="-\d+"[\n\s]+href="#_\d+">&nbsp;<sup>\d+<\/sup>&nbsp;/m,'')
+ gsub(/<a[\s]+name="-\d+"[\s]+href="#_\d+">&nbsp;<sup>\d+<\/sup>&nbsp;/m,'')
end
%{<#{tag} class="#{attrib}">
- <a href="##{@ocn}"><i>#{txt}</i></a> #{note}
+ <a href="##{@ocn_html_identifier}#{@ocn}"><i>#{txt}</i></a> #{note}
</#{tag}>}
end
def subtoc_lev5
diff --git a/lib/sisu/v6/html_lite_shared.rb b/lib/sisu/v6/html_lite_shared.rb
index b675fbd3..88510f04 100644
--- a/lib/sisu/v6/html_lite_shared.rb
+++ b/lib/sisu/v6/html_lite_shared.rb
@@ -83,6 +83,7 @@ module SiSU_FormatShared
end
@tab="\t"
@brace_url=SiSU_Viz::Defaults.new.url_decoration
+ @ocn_html_identifier=SiSU_Env::ProcessingSettings.new(@md).ocn_html_identifier
@@tablehead,@@tablefoot=[],[]
@vz=SiSU_Viz::Defaults.new
@env=SiSU_Env::InfoEnv.new(@md.fns)
@@ -205,7 +206,7 @@ GSUB
%{<p class="#{h[:class]}" type="#{h[:type]}">#{h[:txt]}</a></p>\n} << "\n"
end
def lev_toc_hname
- %{<p class="toc#{@lv}" header="#{@hname}"><a href="##{@ocn}">#{@txt}</a></p>\n} #<< "\n"
+ %{<p class="toc#{@lv}" header="#{@hname}"><a href="##{@ocn_html_identifier}#{@ocn}">#{@txt}</a></p>\n} #<< "\n"
end
def lev_toc
h={ txt: txt, class: "toc#{@lv}", type: 'toc' }
@@ -309,10 +310,10 @@ GSUB
def paragraph
attrib=%{class="#{@attrib}" }
if @ocn
- id=%{id="#{@ocn}" }
+ id=%{id="#{Mx[:ocn_id_char]}#{@ocn}" }
type=%{type="substantive" }
else
- id=%{id="none" }
+ id=''
type=%{type="comment" }
end
header=%{header="#{@hname}" } if @hname
diff --git a/lib/sisu/v6/html_minitoc.rb b/lib/sisu/v6/html_minitoc.rb
index 0bb2794f..13045b0d 100644
--- a/lib/sisu/v6/html_minitoc.rb
+++ b/lib/sisu/v6/html_minitoc.rb
@@ -71,6 +71,7 @@
def initialize(md,data)
@md,@data=md,data
@pat_strip_heading_name=/<a name="h?\d.*?">(.+?)<\/a>/
+ @ocn_html_identifier=SiSU_Env::ProcessingSettings.new(@md).ocn_html_identifier
@tell=SiSU_Screen::Ansi.new(@md.opt.act[:color_state][:set]) if @md
end
def songsheet
@@ -204,7 +205,7 @@
fn: @@seg_url,
}
f=@md.file.base_filename.html_seg(fnh)
- lnk_n_txt=%{ <a href="#{f}##{txt.ocn}">
+ lnk_n_txt=%{ <a href="#{f}##{@ocn_html_identifier}#{txt.ocn}">
#{txt.obj}
</a>}
txt_obj={ txt: lnk_n_txt }
@@ -223,7 +224,7 @@
fn: @@seg_url,
}
f=@md.file.base_filename.html_seg(fnh)
- lnk_n_txt=%{ <a href="#{f}##{txt.ocn}">
+ lnk_n_txt=%{ <a href="#{f}##{@ocn_html_identifier}#{txt.ocn}">
#{txt.obj}
</a>}
txt_obj={ txt: lnk_n_txt }
diff --git a/lib/sisu/v6/html_segments.rb b/lib/sisu/v6/html_segments.rb
index efe37024..0586cdf6 100644
--- a/lib/sisu/v6/html_segments.rb
+++ b/lib/sisu/v6/html_segments.rb
@@ -502,7 +502,7 @@ module SiSU_HTML_Seg
'<br /><hr width=90% /><br />'
end
if @md.flag_separate_endnotes
- dob.obj=dob.obj.gsub(/"\s+href="#_(\d+)">/,%{" href=\"endnotes#{Sfx[:html]}#_\\1">}) #endnote- twice #removed file type
+ dob.obj=dob.obj.gsub(/"\s+href="#(#{Mx[:note]}\d+)">/,%{" href=\"endnotes#{Sfx[:html]}#\\1">}) #endnote- twice #removed file type
end
if dob.obj !~/#{@vz.margin_txt_w1}|#{@vz.margin_txt_w2}/
if (dob.is==:heading \
@@ -600,7 +600,7 @@ module SiSU_HTML_Seg
@@seg_subtoc_array << subtoc
end
if @md.flag_auto_endnotes
- if (dob.obj =~/(?:#{Mx[:en_a_o]}|#{Mx[:en_b_o]})[\d*+]+ <a name="_[\d*+]+"/) \
+ if (dob.obj =~/(?:#{Mx[:en_a_o]}|#{Mx[:en_b_o]})[\d*+]+ <a name="#{Mx[:note]}[\d*+]+"/) \
&& dob.is !=:code # endnote-
endnote_array=[]
if dob.obj=~/#{Mx[:en_a_o]}.+?#{Mx[:en_a_c]}/m
@@ -629,7 +629,7 @@ module SiSU_HTML_Seg
end
try.join('<br \/>')
#% creation of separate end segment/page of all endnotes referenced back to reference segment
- m=/(?:#{Mx[:en_a_o]}[\d*+]+|#{Mx[:en_b_o]}[*+]\d+)\s+(.+?href=")(#-[\d*+]+".+)(?:#{Mx[:en_a_c]}|#{Mx[:en_b_c]})/mi
+ m=/(?:#{Mx[:en_a_o]}[\d*+]+|#{Mx[:en_b_o]}[*+]\d+)\s+(.+?href=")(##{Mx[:note_ref]}[\d*+]+".+)(?:#{Mx[:en_a_c]}|#{Mx[:en_b_c]})/mi
endnote_part_a=note_match_seg[m,1]
endnote_part_b=note_match_seg[m,2]
txt_obj={ endnote_part_a: endnote_part_a, endnote_part_b: endnote_part_b }
diff --git a/lib/sisu/v6/html_tune.rb b/lib/sisu/v6/html_tune.rb
index 384a19b0..42568a36 100644
--- a/lib/sisu/v6/html_tune.rb
+++ b/lib/sisu/v6/html_tune.rb
@@ -104,6 +104,16 @@ module SiSU_HTML_Tune
def initialize(html='')
@html=html
end
+ def clean_for_html
+ html=@html
+ str=if html.is_a?(String)
+ html
+ else html.obj
+ end
+ str=str.gsub(/#{Mx[:gl_o]}(#[0-9]{3})#{Mx[:gl_c]}/u,'&\1;').
+ gsub(/#{Mx[:gl_o]}#([a-z]{2,4})#{Mx[:gl_c]}/u,'&\1;').
+ gsub(/[<]/m,'&lt;').gsub(/[>]/m,'&gt;')
+ end
def clean
html=@html
str=if html.is_a?(String)
@@ -111,7 +121,8 @@ module SiSU_HTML_Tune
else html.obj
end
str=str.gsub(/#{Mx[:gl_o]}(#[0-9]{3})#{Mx[:gl_c]}/u,'&\1;').
- gsub(/#{Mx[:gl_o]}#([a-z]{2,4})#{Mx[:gl_c]}/u,'&\1;')
+ gsub(/#{Mx[:gl_o]}#([a-z]{2,4})#{Mx[:gl_c]}/u,'&\1;').
+ gsub(/[\\]{2}/m,'<br />')
end
end
class Tune
@@ -256,14 +267,14 @@ module SiSU_HTML_Tune
def endnotes_html(dob)
unless dob.is ==:code
dob.obj=dob.obj.gsub(/(#{Mx[:en_a_o]}|#{Mx[:en_b_o]})(\d+)\s+(.+?)(#{Mx[:en_a_c]}|#{Mx[:en_b_c]})/,
- '&nbsp;<a name="-\2" href="#_\2">&nbsp;<sup>\2</sup>&nbsp;</a> ' + #note- endnote-
- '\1\2 <a name="_\2" href="#-\2">&nbsp;<sup>\2.</sup></a> \3 \4'). #endnote- note- (careful may have switched)
+ %{&nbsp;<a name="#{Mx[:note_ref]}\\2" href="##{Mx[:note]}\\2">&nbsp;<sup>\\2</sup>&nbsp;</a> } +
+ %{\\1\\2 <a name="#{Mx[:note]}\\2" href="##{Mx[:note_ref]}\\2">&nbsp;<sup>\\2.</sup></a> \\3 \\4}).
gsub(/(#{Mx[:en_b_o]})([*+]\d+)\s+(.+?)(#{Mx[:en_b_c]})/,
- '&nbsp;<a name="-\2" href="#_\2">&nbsp;<sup>\2</sup>&nbsp;</a> ' + #note- endnote-
- '\1\2 <a name="_\2" href="#-\2">&nbsp;<sup>\2.</sup></a> \3 \4'). #endnote- note- (careful may have switched)
+ %{&nbsp;<a name="#{Mx[:note_ref]}\\2" href="##{Mx[:note]}\\2">&nbsp;<sup>\\2</sup>&nbsp;</a> } +
+ %{\\1\\2 <a name="#{Mx[:note]}\\2" href="##{Mx[:note_ref]}\\2">&nbsp;<sup>\\2.</sup></a> \\3 \\4}).
gsub(/(#{Mx[:en_a_o]})([*+]+)\s+(.+?)(#{Mx[:en_a_c]})/,
- '&nbsp;<a name="-\2" href="#_\2">&nbsp;<sup>\2</sup>&nbsp;</a> ' + #note- endnote-
- '\1\2 <a name="_\2" href="#-\2">&nbsp;<sup>\2</sup></a> \3 \4') #endnote- note- (careful may have switched)
+ %{&nbsp;<a name="#{Mx[:note_ref]}\\2" href="##{Mx[:note]}\\2">&nbsp;<sup>\\2</sup>&nbsp;</a> } +
+ %{\\1\\2 <a name="#{Mx[:note]}\\2" href="##{Mx[:note_ref]}\\2">&nbsp;<sup>\\2</sup></a> \\3 \\4})
end
dob
end
diff --git a/lib/sisu/v6/hub.rb b/lib/sisu/v6/hub.rb
index 7e2a009d..35e9140d 100644
--- a/lib/sisu/v6/hub.rb
+++ b/lib/sisu/v6/hub.rb
@@ -72,7 +72,11 @@ module SiSU
require_relative 'defaults' # defaults.rb
include SiSU_Viz
require_relative 'utils' # utils.rb
- require 'uri'
+ begin
+ require 'uri'
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('uri NOT FOUND (LoadError)')
+ end
class HubMaster
def initialize(argv)
pwd_the=Dir.pwd
@@ -246,8 +250,12 @@ module SiSU
end
end
class Processing
- require 'fileutils'
- include FileUtils
+ begin
+ require 'fileutils'
+ include FileUtils
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('fileutils NOT FOUND (LoadError)')
+ end
@@env=nil
attr_accessor :op
def initialize(opt)
@@ -645,7 +653,11 @@ module SiSU
end
def actions
if @opt.act[:profile][:set]==:on
- require 'profile'
+ begin
+ require 'profile'
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('profile NOT FOUND (LoadError)')
+ end
end
action_on_file_ =if @opt.act[:rsync][:set]==:on \
&& @opt.act[:site_init][:set]==:on
@@ -748,7 +760,7 @@ module SiSU
STDERR.puts %{requested action requires valid sisu markup file [filename (.sst .ssm)] or wildcard (that includes a valid filename)}
if (@opt.act[:verbose_plus][:set]==:on \
|| @opt.act[:maintenance][:set]==:on)
- SiSU_Utils::CodeMarker.new(__LINE__,__FILE__).mark(:fuchsia)
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__).warn(:fuchsia)
end
end
elsif @opt.mod.inspect =~/--query/
diff --git a/lib/sisu/v6/options.rb b/lib/sisu/v6/options.rb
index 632ac5a8..6f4cce37 100644
--- a/lib/sisu/v6/options.rb
+++ b/lib/sisu/v6/options.rb
@@ -62,7 +62,11 @@
=end
module SiSU_Commandline
- require 'pathname'
+ begin
+ require 'pathname'
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('pathname NOT FOUND (LoadError)')
+ end
require_relative 'sysenv' # sysenv.rb
require_relative 'param_make' # param_make.rb
@@sisu_call_origin_path=nil
@@ -662,9 +666,9 @@ module SiSU_Commandline
{ set: :filetype }
else { set: :na }
end
- act[:ocn]=if mod.inspect =~/"--inc-ocn"/
+ act[:ocn]=if mod.inspect =~/"--ocn"|"--inc-ocn"/
{ bool: true, set: :on }
- elsif mod.inspect =~/"--(?:exc|no)-ocn"/ \
+ elsif mod.inspect =~/"--no-ocn"|"--exc-ocn"/ \
|| act[:switch][:off].inspect =~/"ocn"/
{ bool: false, set: :off }
else { bool: true, set: :na }
@@ -765,12 +769,23 @@ module SiSU_Commandline
{ bool: false, set: :off }
else { bool: true, set: :na }
end
- act[:html]=if (cmd =~/h/ \
+ act[:html]=if mod.inspect =~/"--html-strict"/ \
+ or ((cmd =~/h/ || mod.inspect =~/"--html"/) \
+ && mod.inspect =~/"--strict"/)
+ act[:html_strict]={ bool: true, set: :on }
+ act[:html_scroll]={ bool: true, set: :on }
+ act[:html_seg]={ bool: true, set: :on }
+ { bool: true, set: :on }
+ elsif (cmd =~/h/ \
|| mod.inspect =~/"--html"/)
+ act[:html_strict]={ bool: false, set: :off }
act[:html_scroll]={ bool: true, set: :on }
act[:html_seg]={ bool: true, set: :on }
{ bool: true, set: :on }
else
+ act[:html_strict]=(mod.inspect =~/"--strict"/) \
+ ? { bool: true, set: :on }
+ : { bool: false, set: :na }
act[:html_scroll]=(mod.inspect =~/"--html-scroll"/) \
? { bool: true, set: :on }
: { bool: false, set: :na }
@@ -850,10 +865,20 @@ module SiSU_Commandline
|| mod.inspect =~/"--epub"/) \
? { bool: true, set: :on }
: { bool: false, set: :na }
- act[:odt]=(cmd =~/o/ \
- || mod.inspect =~/"--odt"|"--odf"/) \
- ? { bool: true, set: :on }
- : { bool: false, set: :na }
+ act[:odt]=if cmd =~/o/ \
+ or mod.inspect =~/"--odt"|"--odf"|"--odt-ocn"|"--odf-ocn"/
+ act[:odt_ocn]=if (mod.inspect =~/"--odt-ocn"|"--odf-ocn"/ \
+ or mod.inspect =~/"--ocn"|"--inc-ocn"/)
+ { bool: true, set: :on }
+ elsif mod.inspect =~/"--no-ocn"|"--exc-ocn"/
+ { bool: false, set: :off }
+ else
+ { bool: false, set: :na }
+ end
+ { bool: true, set: :on }
+ else
+ { bool: false, set: :na }
+ end
act[:xml_sax]=(cmd =~/x/ \
|| mod.inspect =~/"--xml-sax"/) \
? { bool: true, set: :on }
@@ -879,10 +904,20 @@ module SiSU_Commandline
|| mod.inspect =~/"--xhtml"/) \
? { bool: true, set: :on }
: { bool: false, set: :na }
- act[:txt]=(cmd =~/[at]/ \
- || mod.inspect =~/"--txt"/) \
- ? { bool: true, set: :on }
- : { bool: false, set: :na }
+ act[:txt]=if cmd =~/[at]/ \
+ or mod.inspect =~/"--txt"|"--text"|"--plaintext"|"--txt-ocn"|"--text-ocn"|"--plaintext-ocn"/
+ act[:txt_ocn]=if (mod.inspect =~/"--txt-ocn"|"--text-ocn"|"--plaintext-ocn"/ \
+ or mod.inspect =~/"--ocn"|"--inc-ocn"/)
+ { bool: true, set: :on }
+ elsif mod.inspect =~/"--no-ocn"|"--exc-ocn"/
+ { bool: false, set: :off }
+ else
+ { bool: false, set: :na }
+ end
+ { bool: true, set: :on }
+ else
+ { bool: false, set: :na }
+ end
act[:txt_textile]=(mod.inspect =~/"--textile"/) \
? { bool: true, set: :on }
: { bool: false, set: :na }
diff --git a/lib/sisu/v6/param.rb b/lib/sisu/v6/param.rb
index b74e0dc1..e3eaebae 100644
--- a/lib/sisu/v6/param.rb
+++ b/lib/sisu/v6/param.rb
@@ -61,8 +61,12 @@
=end
module SiSU_Param
- require 'uri'
- require 'pstore'
+ begin
+ require 'uri'
+ require 'pstore'
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('uri or pstore NOT FOUND (LoadError)')
+ end
require_relative 'sysenv' # sysenv.rb
include SiSU_Env
require_relative 'param_make' # param_make.rb
@@ -95,8 +99,7 @@ module SiSU_Param
# you may need to change Dir.pwd to @opt.f_pth[:pth] where the latter
# has a path value that is different, however, f_pth is not always set!
Dir.chdir(@opt.f_pth[:pth])
- p '-- bug alert -- '
- p __FILE__ + ':' + __LINE__.to_s
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('-- bug alert --')
p 'f_pth ' + @opt.f_pth[:pth]
p 'pwd ' + Dir.pwd
end
diff --git a/lib/sisu/v6/particulars.rb b/lib/sisu/v6/particulars.rb
index 44fa536a..7e850f4c 100644
--- a/lib/sisu/v6/particulars.rb
+++ b/lib/sisu/v6/particulars.rb
@@ -62,7 +62,11 @@
=end
module SiSU_Particulars
- require 'singleton'
+ begin
+ require 'singleton'
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('singleton NOT FOUND (LoadError)')
+ end
require_relative 'sysenv' # sysenv.rb
include SiSU_Env
require_relative 'param' # param.rb
diff --git a/lib/sisu/v6/remote.rb b/lib/sisu/v6/remote.rb
index 3c4982c8..ed5d7fba 100644
--- a/lib/sisu/v6/remote.rb
+++ b/lib/sisu/v6/remote.rb
@@ -112,8 +112,12 @@ module SiSU_Remote
@tell=lambda { SiSU_Screen::Ansi.new(@opt.act[:color_state][:set],@msg,"#{@msgs.inspect if @msgs}") }
end
def fns
- require 'open-uri'
- require 'pp'
+ begin
+ require 'open-uri'
+ require 'pp'
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('open-uri or pp NOT FOUND (LoadError)')
+ end
require_relative 'composite' # composite.rb
@rgx_image=/(?:^|[^_\\])\{\s*(\S+?\.(?:png|jpg|gif))/
threads=[]
@@ -158,7 +162,11 @@ module SiSU_Remote
def sisupod
get_p=@get_s
if get_p.length > 0 #% remote sisupod
- require 'net/http'
+ begin
+ require 'net/http'
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('net/http NOT FOUND (LoadError)')
+ end
for requested_pod in get_p
pod_info=RemoteDownload.new(requested_pod)
Net::HTTP.start(pod_info.pod.site) do |http|
diff --git a/lib/sisu/v6/rexml.rb b/lib/sisu/v6/rexml.rb
index f9b94cee..63e70a42 100644
--- a/lib/sisu/v6/rexml.rb
+++ b/lib/sisu/v6/rexml.rb
@@ -62,14 +62,22 @@
=end
module SiSU_Rexml
# load XML file for REXML parsing
- require 'rexml/document' if FileTest.directory?("#{Config::CONFIG['rubylibdir']}/rexml") #Config::CONFIG['sitedir']
+ begin
+ require 'rexml/document' if FileTest.directory?("#{Config::CONFIG['rubylibdir']}/rexml") #Config::CONFIG['sitedir']
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('rexml/document NOT FOUND (LoadError)')
+ end
require_relative 'param' # param.rb
include SiSU_Param
require_relative 'sysenv' # sysenv.rb
include SiSU_Env
include SiSU_Viz
class Rexml
- require 'rexml/document' if FileTest.directory?("#{Config::CONFIG['rubylibdir']}/rexml") #Config::CONFIG['sitedir']
+ begin
+ require 'rexml/document' if FileTest.directory?("#{Config::CONFIG['rubylibdir']}/rexml") #Config::CONFIG['sitedir']
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('rexml/document NOT FOUND (LoadError)')
+ end
def initialize(md,fno)
@md,@fno=md,fno
@env=SiSU_Env::InfoEnv.new(@md.fns)
diff --git a/lib/sisu/v6/shared_markup_alt.rb b/lib/sisu/v6/shared_markup_alt.rb
index b84d167a..4971dde0 100644
--- a/lib/sisu/v6/shared_markup_alt.rb
+++ b/lib/sisu/v6/shared_markup_alt.rb
@@ -208,7 +208,11 @@ module SiSU_TextRepresentation
end
@env ||=SiSU_Env::InfoEnv.new(@md.fns)
@sha_ =((@env.digest.type =='sha256') ? true : false)
- @sha_ ? (require 'digest/sha2') : (require 'digest/md5')
+ begin
+ @sha_ ? (require 'digest/sha2') : (require 'digest/md5')
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error((@sha_ ? 'digest/sha2' : 'digest/md5') + ' NOT FOUND')
+ end
end
def digest(txt)
d=nil
diff --git a/lib/sisu/v6/src_kdissert_share.rb b/lib/sisu/v6/src_kdissert_share.rb
index ecf559fb..9624e460 100644
--- a/lib/sisu/v6/src_kdissert_share.rb
+++ b/lib/sisu/v6/src_kdissert_share.rb
@@ -64,8 +64,12 @@ module SiSU_KdiSource
require_relative 'sysenv' # sysenv.rb
include SiSU_Env
class Source
- require 'fileutils'
- include FileUtils
+ begin
+ require 'fileutils'
+ include FileUtils
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('fileutils NOT FOUND (LoadError)')
+ end
def initialize(opt)
@opt=opt
@env=SiSU_Env::InfoEnv.new(@opt.fns)
diff --git a/lib/sisu/v6/sst_from_xml.rb b/lib/sisu/v6/sst_from_xml.rb
index 728f3f54..ee864b03 100644
--- a/lib/sisu/v6/sst_from_xml.rb
+++ b/lib/sisu/v6/sst_from_xml.rb
@@ -64,8 +64,12 @@
module SiSU_sstFromXML
require_relative 'sysenv' # sysenv.rb
class Convert
- require 'rexml/document'
- include REXML
+ begin
+ require 'rexml/document'
+ include REXML
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('rexml/document NOT FOUND (LoadError)')
+ end
def initialize(opt)
@opt=opt
@sisu,@sisu_base=[],[]
diff --git a/lib/sisu/v6/sysenv.rb b/lib/sisu/v6/sysenv.rb
index 46bb30ca..db1bdc91 100644
--- a/lib/sisu/v6/sysenv.rb
+++ b/lib/sisu/v6/sysenv.rb
@@ -66,12 +66,20 @@
module SiSU_Env
require_relative 'constants' # constants.rb
require_relative 'utils' # utils.rb
- require 'fileutils'
- include FileUtils::Verbose
- require 'singleton'
+ begin
+ require 'singleton'
+ require 'fileutils'
+ include FileUtils::Verbose
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('singleton or fileutils NOT FOUND (LoadError)')
+ end
@@noyaml=false
class InfoDate
- require 'date'
+ begin
+ require 'date'
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('date NOT FOUND (LoadError)')
+ end
attr_accessor :dt,:t
def initialize
@dt,@t=Date.today.to_s,Time.now
@@ -97,7 +105,11 @@ module SiSU_Env
end
end
class InfoSystemGen
- require 'rbconfig'
+ begin
+ require 'rbconfig'
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('rbconfig NOT FOUND (LoadError)')
+ end
@@user,@@home,@@hostname,@@pwd,@@sisu_etc,@@host,@@arch,@@rbver,@@dir_arch,@@dir_sitearch,@@dir_bin,@@locale,@@rc,@@sisurc_path,@@ad=ENV['USER'],ENV['HOME'],ENV['HOSTNAME'],ENV['PWD'],Config::CONFIG['sysconfdir'] + '/sisu',Config::CONFIG['host'],Config::CONFIG['arch'],%x{ruby -v}.strip,Config::CONFIG['archdir'],Config::CONFIG['sitearchdir'],Config::CONFIG['bindir'],%x{locale charmap}.strip,nil,nil,{} # %x{ruby -v}.strip # Config::CONFIG['rb_ver']
out=Config::CONFIG['localstatedir']
etc=Config::CONFIG['sysconfdir'] + '/sisu'
@@ -242,10 +254,18 @@ module SiSU_Env
end
if load_prog \
and @prog=~/dbi/
- require 'dbi' #revisit
+ begin
+ require 'dbi'
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('dbi NOT FOUND (LoadError)')
+ end
end
if load_prog
- require @prog
+ begin
+ require @prog
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error("#{@prog} NOT FOUND (LoadError)")
+ end
else
@mandatory \
? (SiSU_Screen::Ansi.new(@prog,"*WARN* module required: #{@prog}").warn)
@@ -330,7 +350,11 @@ module SiSU_Env
f=S_CONF[:rc_yml]
p_f="#{v}/#{f}"
if FileTest.exist?(p_f)
- require 'yaml'
+ begin
+ require 'yaml'
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('yaml NOT FOUND (LoadError)')
+ end
@@sisurc_path=v
@@rc=YAML::load(File::open(p_f))
break
@@ -339,7 +363,11 @@ module SiSU_Env
f='sisurc.yaml'
p_f="#{v}/#{f}"
if FileTest.exist?(p_f)
- require 'yaml'
+ begin
+ require 'yaml'
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('yaml NOT FOUND (LoadError)')
+ end
@@sisurc_path=v
@@rc=YAML::load(File::open(p_f))
break
@@ -378,7 +406,11 @@ module SiSU_Env
else
if FileTest.exist?("#{v}/list.yml")
unless @@ad[:promo_list]
- require 'yaml'
+ begin
+ require 'yaml'
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('yaml NOT FOUND (LoadError)')
+ end
@@ad[:promo_list] ||= YAML::load(File::open("#{v}/list.yml"))
end
@@ad[:flag_promo]=true
@@ -396,7 +428,11 @@ module SiSU_Env
else
if FileTest.exist?("#{v}/promo.yml")
unless @@ad[:promo]
- require 'yaml'
+ begin
+ require 'yaml'
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('yaml NOT FOUND (LoadError)')
+ end
@@ad[:promo] ||= YAML::load(File::open("#{v}/promo.yml"))
end
@@ad[:flag_promo]=true
@@ -716,7 +752,7 @@ module SiSU_Env
program='rcs'
program_ref="\n\t\tdocument version information requested"
if program_found?(program); true
- else STDERR.puts "\t*WARN* #{program} is not installed #{program_ref}" #if @cmd =~/v/
+ else SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).warn("#{program} is not installed #{program_ref}")
false
end
end
@@ -724,7 +760,15 @@ module SiSU_Env
program='cvs'
program_ref="\n\t\tdocument version information requested"
if program_found?(program); true
- else STDERR.puts "\t*WARN* #{program} is not installed #{program_ref}" #if @cmd =~/v/
+ else SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).warn("#{program} is not installed #{program_ref}")
+ false
+ end
+ end
+ def zip #zip
+ program='zip'
+ program_ref="\n\t\tused to in the making of number of file formats, odf, epub"
+ if program_found?(program); true
+ else SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).mark("*WARN* #{program} is not installed #{program_ref}")
false
end
end
@@ -732,7 +776,7 @@ module SiSU_Env
program='openssl'
program_ref="\n\t\tused to generate requested source document identification digest"
if program_found?(program); true
- else STDERR.puts "\t*WARN* #{program} is not installed #{program_ref}" #if @cmd =~/v/
+ else SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).warn("#{program} is not installed #{program_ref}")
false
end
end
@@ -745,7 +789,7 @@ module SiSU_Env
dgst=%x{openssl dgst -md5 #{File.basename(filename)}}.strip #use file name without file path
Dir.chdir(pwd)
dgst.scan(/\S+/)
- else STDERR.puts "\t*WARN* #{program} is not installed #{program_ref}" #if @cmd =~/v/
+ else SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).warn("#{program} is not installed #{program_ref}")
false
end
end
@@ -758,7 +802,7 @@ module SiSU_Env
dgst=%x{openssl dgst -sha256 #{File.basename(filename)}}.strip #use file name without file path
Dir.chdir(pwd)
dgst.scan(/\S+/)
- else STDERR.puts "\t*WARN* #{program} is not installed #{program_ref}" #if @cmd =~/v/
+ else SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).warn("#{program} is not installed #{program_ref}")
false
end
end
@@ -766,7 +810,7 @@ module SiSU_Env
program='psql'
program_ref="\n\t\tpsql requested"
if program_found?(program); true
- else STDERR.puts "\t*WARN* #{program} is not installed #{program_ref}" #if @cmd =~/v/
+ else SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).warn("#{program} is not installed #{program_ref}")
false
end
end
@@ -1030,9 +1074,13 @@ module SiSU_Env
end
end
class InfoEnv < EnvCall
- require 'pathname'
- require 'fileutils'
- include FileUtils
+ begin
+ require 'pathname'
+ require 'fileutils'
+ include FileUtils
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('pathname or fileutils NOT FOUND (LoadError)')
+ end
attr_accessor :filename,:sys,:home,:hostname,:user,:env,:rc,:www,:fnb,:fnn,:fnt,:flv,:webserv_path,:stub_pwd,:stub_src,:webserv_host_cgi,:webserv_port_cgi,:processing,:processing_git,:etc,:yamlrc_dir
@@image_flag,@@local_image=true,true #warning on @@image_flag
@@fb,@@man_path=nil,nil
@@ -1080,7 +1128,7 @@ module SiSU_Env
elsif output_dir_structure.by_filename?
''
else
- SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).mark('set output type, by: language, filetype or filename')
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).warn('set output type, by: language, filetype or filename')
end
@stub_set_manifest=stub + '/manifest'
end
@@ -3169,8 +3217,12 @@ WOK
end
end
class CleanOutput
- require 'fileutils'
- include FileUtils::Verbose
+ begin
+ require 'fileutils'
+ include FileUtils::Verbose
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('fileutils NOT FOUND (LoadError)')
+ end
def initialize(opt)
@opt=opt
z=SiSU_Env::FileMap.new(opt)
@@ -3326,7 +3378,11 @@ WOK
end
class InfoRemote < FileMap
@@flag_remote=false
- require 'socket'
+ begin
+ require 'socket'
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('socket NOT FOUND (LoadError)')
+ end
def initialize(opt)
super(opt) #
@opt=opt
@@ -3674,8 +3730,12 @@ WOK
end
class InfoVersion <InfoEnv
include Singleton
- require 'rbconfig'
- require 'yaml'
+ begin
+ require 'rbconfig'
+ require 'yaml'
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('rbconfig or yaml NOT FOUND (LoadError)')
+ end
@@lib_path=nil
def get_version
@version={}
@@ -3845,6 +3905,53 @@ WOK
true
end
end
+ def plaintext_ocn?
+ if cmd_rc_act[:txt_ocn][:set]==:on \
+ or cmd_rc_act[:ocn][:set]==:on
+ true
+ elsif cmd_rc_act[:txt_ocn][:set]==:off \
+ or cmd_rc_act[:ocn][:set]==:off
+ false
+ elsif doc_rc.is_a?(Method) \
+ and defined? doc_rc.ocn? \
+ and doc_rc.toc? ==:off
+ false
+ elsif env_rc.build.ocn? ==:off
+ false
+ else
+ false
+ end
+ end
+ def odt_ocn?
+ if cmd_rc_act[:odt_ocn][:set]==:on \
+ or cmd_rc_act[:ocn][:set]==:on
+ true
+ elsif cmd_rc_act[:odt_ocn][:set]==:off \
+ or cmd_rc_act[:ocn][:set]==:off
+ false
+ elsif doc_rc.is_a?(Method) \
+ and defined? doc_rc.ocn? \
+ and doc_rc.toc? ==:off
+ false
+ elsif env_rc.build.ocn? ==:off
+ false
+ else
+ false
+ end
+ end
+ def html_strict?
+ if cmd_rc_act[:html_strict][:set]==:on
+ true
+ elsif cmd_rc_act[:html_strict][:set]==:off
+ false
+ elsif doc_rc.is_a?(Method) \
+ and defined? doc_rc.html_strict? \
+ and doc_rc.html_strict? ==:on
+ true
+ else
+ false
+ end
+ end
def toc?
if cmd_rc_act[:toc][:set]==:on
true
@@ -4081,6 +4188,11 @@ WOK
end
self
end
+ def ocn_html_identifier
+ (build.html_strict?) \
+ ? Mx[:ocn_id_char]
+ : ''
+ end
def output_dir_structure
def by_language_code?
if cmd_rc_act[:output_by][:set] == :language
@@ -4291,7 +4403,14 @@ WOK
DBI.connect(sqlite_discrete.dbi)
end
def conn_sqlite3
- SQLite3::Database.new(sqlite_discrete.sqlite3)
+ begin
+ $sqlite3=:yes
+ require 'sqlite3'
+ SQLite3::Database.new(sqlite_discrete.sqlite3)
+ rescue LoadError
+ $sqlite3=:no
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('sqlite3 NOT FOUND (LoadError)')
+ end
end
self
end
diff --git a/lib/sisu/v6/texpdf.rb b/lib/sisu/v6/texpdf.rb
index 496f77fe..97961701 100644
--- a/lib/sisu/v6/texpdf.rb
+++ b/lib/sisu/v6/texpdf.rb
@@ -61,7 +61,11 @@
=end
module SiSU_TeX
- require 'pstore'
+ begin
+ require 'pstore'
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('pstore NOT FOUND (LoadError)')
+ end
require_relative 'defaults' # defaults.rb
include SiSU_Viz
require_relative 'particulars' # particulars.rb
@@ -78,7 +82,11 @@ module SiSU_TeX
@@n=@@tableheader=@@rights=nil
@@date ||=SiSU_Env::InfoDate.new
class Source
- require 'pstore'
+ begin
+ require 'pstore'
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('pstore NOT FOUND (LoadError)')
+ end
require_relative 'sysenv' # sysenv.rb
include SiSU_Env
include SiSU_Viz
@@ -270,7 +278,7 @@ module SiSU_TeX
and File.size(texfile) > 0
#@tex_f_no+=1
else
- SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).mark("\tzero file size #{@env.processing_path.tex}/#{texfile}")
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error("\tzero file size #{@env.processing_path.tex}/#{texfile}")
end
end
end
@@ -365,7 +373,7 @@ module SiSU_TeX
elsif @md.opt.act[:pdf_p][:set]==:on
'pdfTex portrait'
else
- SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).mark('error: neither landscape nor portrait')
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('error: neither landscape nor portrait')
end
if (@md.opt.act[:verbose][:set]==:on \
|| @md.opt.act[:verbose_plus][:set]==:on \
diff --git a/lib/sisu/v6/txt_plain.rb b/lib/sisu/v6/txt_plain.rb
index bb97f679..1aa08f0e 100644
--- a/lib/sisu/v6/txt_plain.rb
+++ b/lib/sisu/v6/txt_plain.rb
@@ -400,7 +400,8 @@ WOK
@@endnotes[:para]=[]
end
def ocn_display(dob)
- if @env.plaintext_ocn?
+ make=SiSU_Env::ProcessingSettings.new(@md)
+ if make.build.plaintext_ocn?
if defined? dob.ocn \
and dob.ocn.is_a?(Fixnum)
(defined? dob.ocn) ? "\n#{Dx[:ocn_o]}#{dob.ocn}#{Dx[:ocn_c]}" : ''
diff --git a/lib/sisu/v6/utils.rb b/lib/sisu/v6/utils.rb
index b0efb3bc..60925f22 100644
--- a/lib/sisu/v6/utils.rb
+++ b/lib/sisu/v6/utils.rb
@@ -127,6 +127,12 @@ module SiSU_Utils
def mark(v=nil,x=nil)
puts set(v,x)
end
+ def warn(v=nil,x=nil)
+ STDERR.puts set(v,'*WARN* ' + x)
+ end
+ def error(v=nil,x=nil)
+ STDERR.puts set(v,'*ERROR* ' + x)
+ end
end
class Path
def initialize(dir=Dir.pwd)
diff --git a/lib/sisu/v6/webrick.rb b/lib/sisu/v6/webrick.rb
index 7a66a1af..97e6548d 100644
--- a/lib/sisu/v6/webrick.rb
+++ b/lib/sisu/v6/webrick.rb
@@ -63,12 +63,16 @@
=end
module SiSU_Webserv
class WebrickStart
+ begin
+ require 'time'
require 'webrick'
include WEBrick
- require 'time'
- require_relative 'sysenv' # sysenv.rb
- include SiSU_Env
- include SiSU_Screen
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('time or webrick NOT FOUND (LoadError)')
+ end
+ require_relative 'sysenv' # sysenv.rb
+ include SiSU_Env
+ include SiSU_Screen
def initialize
begin #%
@cX=SiSU_Screen::Ansi.new('yes').cX
@@ -97,9 +101,13 @@ module SiSU_Webserv
#% wb_top
wb_top=%q(#!/usr/bin/env ruby
# * arch-tag: webrick info on environment, mounted directories, and contents of pwd
- require 'time'
- require 'cgi'
- require 'fcgi'
+ begin
+ require 'time'
+ require 'cgi'
+ require 'fcgi'
+ rescue LoadError
+ puts 'time, cgi or fcgi NOT FOUND (LoadError)'
+ end
ls=Dir.entries('./')
dir_contents=[]
ls.each { |x| dir_contents << "<a href=\"./#{x}/\">#{x}</a><br>" unless x =~/^(\.)+$/ }
diff --git a/lib/sisu/v6/xhtml_epub2.rb b/lib/sisu/v6/xhtml_epub2.rb
index 6447431f..3164e575 100644
--- a/lib/sisu/v6/xhtml_epub2.rb
+++ b/lib/sisu/v6/xhtml_epub2.rb
@@ -61,7 +61,11 @@
=end
module SiSU_XHTML_EPUB2
- require 'pstore'
+ begin
+ require 'pstore'
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('pstore NOT FOUND (LoadError)')
+ end
require_relative 'particulars' # particulars.rb
include SiSU_Particulars
require_relative 'defaults' # defaults.rb
@@ -744,7 +748,8 @@ module SiSU_XHTML_EPUB2
end
def output_zip
FileUtils::mkdir_p(@md.file.output_path.epub.dir) unless FileTest.directory?(@md.file.output_path.epub.dir)
- if FileTest.directory?(@md.env.processing_path.epub)
+ if FileTest.directory?(@md.env.processing_path.epub) \
+ and SiSU_Env::SystemCall.new.zip
pwd=Dir.pwd
Dir.chdir(@md.env.processing_path.epub)
system("
@@ -755,6 +760,8 @@ module SiSU_XHTML_EPUB2
unless @md.opt.act[:maintenance][:set]==:on
FileUtils::rm_r(@md.env.processing_path.epub)
end
+ else
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).mark('*EXITED epub* zip program not found') unless SiSU_Env::SystemCall.new.zip
end
end
def make_cover_image
diff --git a/lib/sisu/v6/xhtml_epub2_format.rb b/lib/sisu/v6/xhtml_epub2_format.rb
index d5b7e85e..626eb79f 100644
--- a/lib/sisu/v6/xhtml_epub2_format.rb
+++ b/lib/sisu/v6/xhtml_epub2_format.rb
@@ -1362,12 +1362,13 @@ output_epub_cont_seg.close
depth=@md.lvs[1] + @md.lvs[2] + @md.lvs[3] + @md.lvs[4]
title=SanitizeXML.xml(@md.title.full)
author=SanitizeXML.xml(@md.author)
+ dgst=(@md.dgst.is_a?(Array) and @md.dgst.length > 1) ? @md.dgst[1] : 'na'
<<-WOK
<!-- four required metadata items (for all NCX documents,
(including the relaxed constraints of OPS 2.0) -->
<title>#{title} by #{author}</title>
<link href="css/xhtml.css" rel="stylesheet" type="text/css" id="main-css" />
- <meta name="dtb:uid" content="urn:uuid:#{@md.dgst[1]}" />
+ <meta name="dtb:uid" content="urn:uuid:#{dgst}" />
<!-- <meta name="epub-creator" content="#{@md.publisher}" /> -->
<meta name="dtb:depth" content="#{depth}" />
<meta name="dtb:totalPageCount" content="0" />
@@ -1579,18 +1580,19 @@ output_epub_cont_seg.close
else ''
end
f=SiSU_Env::FileOp.new(@md)
+ dgst=(@md.dgst.is_a?(Array) and @md.dgst.length > 1) ? @md.dgst[1] : 'na'
<<-WOK
<#{$ep[:o]}metadata
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:opf="http://www.idpf.org/2007/opf"
xmlns:dcterms="http://purl.org/dc/terms/"
xmlns:dc="http://purl.org/dc/elements/1.1/"
- unique-identifier="urn:uuid:#{@md.dgst[1]}" version="2.0">
+ unique-identifier="urn:uuid:#{dgst}" version="2.0">
<dc:title>#{@md.title.full}</dc:title>
#{cover_image}#{author}#{editor}#{translator}#{illustrator}#{language}#{date_published}#{subject}#{rights}
<dc:identifier opf:scheme="URI">#{f.output_path.epub.url.gsub(/http:\/\//,'')}/#{f.base_filename.epub}</dc:identifier>
- <dc:identifier id="bookid">urn:uuid:#{@md.dgst[1]}</dc:identifier>
- <!-- <dc:identifier id="EPB-UUID">urn:uuid:#{@md.dgst[1]}</dc:identifier> -->
+ <dc:identifier id="bookid">urn:uuid:#{dgst}</dc:identifier>
+ <!-- <dc:identifier id="EPB-UUID">urn:uuid:#{dgst}</dc:identifier> -->
</#{$ep[:o]}metadata>
WOK
end
@@ -2132,10 +2134,10 @@ output_epub_cont_seg.close
note=''
if txt =~/(#{Mx[:en_a_o]}.+?#{Mx[:en_a_c]}|#{Mx[:en_b_o]}.+?#{Mx[:en_b_c]})/m # had \s* at end
note=$1
- note=note.gsub(/[\n\s]+/m,' ')
+ note=note.gsub(/[\s]+/m,' ')
txt=txt.gsub(/(?:#{Mx[:en_a_o]}.+?#{Mx[:en_a_c]}|#{Mx[:en_b_o]}.+?#{Mx[:en_b_c]})\s*/m,' ').
- gsub(/<a[\n\s]+"[\n\s]+href="#note_ref\d+">#{$ep[:hsp]}<sup id="note\d+">\d+<\/sup>#{$ep[:hsp]}/m,'').
- gsub(/<a[\n\s]+"[\n\s]+href="#note_ref\d+">#{$ep[:hsp]}<sup id="note\d+">\d+<\/sup>#{$ep[:hsp]}/m,'') #remove
+ gsub(/<a[\n\s]+"[\n\s]+href="##{Mx[:note_ref]}\d+">#{$ep[:hsp]}<sup id="#{Mx[:note]}\d+">\d+<\/sup>#{$ep[:hsp]}/m,'').
+ gsub(/<a[\n\s]+"[\n\s]+href="##{Mx[:note_ref]}\d+">#{$ep[:hsp]}<sup id="#{Mx[:note]}\d+">\d+<\/sup>#{$ep[:hsp]}/m,'') #remove
end
%{<#{tag} class="#{attrib}">
<a href="#o#{@ocn}"><i>#{txt}</i></a> #{note}
diff --git a/lib/sisu/v6/xhtml_epub2_segments.rb b/lib/sisu/v6/xhtml_epub2_segments.rb
index 2be4afd9..d249b0ff 100644
--- a/lib/sisu/v6/xhtml_epub2_segments.rb
+++ b/lib/sisu/v6/xhtml_epub2_segments.rb
@@ -401,7 +401,7 @@ WOK
sto.break
end
if @md.flag_separate_endnotes # may need to revisit, check
- dob.obj=dob.obj.gsub(/"\s+href="#note_ref(\d+)">/,%{" href=\"endnotes#{Sfx[:epub_xhtml]}#note_ref\\1">}) #endnote- twice #removed file type
+ dob.obj=dob.obj.gsub(/"\s+href="##{Mx[:note_ref]}(\d+)">/,%{" href=\"endnotes#{Sfx[:epub_xhtml]}##{Mx[:note_ref]}\\1">}) #endnote- twice #removed file type
end
if (dob.is ==:heading \
|| dob.is==:heading_insert \
diff --git a/lib/sisu/v6/xhtml_epub2_tune.rb b/lib/sisu/v6/xhtml_epub2_tune.rb
index 12f70fcf..fd90ae54 100644
--- a/lib/sisu/v6/xhtml_epub2_tune.rb
+++ b/lib/sisu/v6/xhtml_epub2_tune.rb
@@ -298,22 +298,22 @@ module SiSU_XHTML_EPUB2_Tune
data.each do |dob|
unless dob.is ==:code
dob.obj=dob.obj.gsub(/(#{Mx[:en_a_o]}|#{Mx[:en_b_o]})(\d+)\s+(.+?)(#{Mx[:en_a_c]}|#{Mx[:en_b_c]})/,
- %{#{Mx[:nbsp]}<a href="#note\\2">#{Mx[:nbsp]}<sup id="note_ref\\2">\\2</sup>#{Mx[:nbsp]}</a> } + #note- endnote-
- %{\\1\\2 <a href="#note_ref\\2">#{Mx[:nbsp]}<sup id="note\\2">\\2.</sup></a> \\3 \\4}). #endnote- note- (careful may have switched)
+ %{#{Mx[:nbsp]}<a href="##{Mx[:note]}\\2">#{Mx[:nbsp]}<sup id="#{Mx[:note_ref]}\\2">\\2</sup>#{Mx[:nbsp]}</a> } + #note- endnote-
+ %{\\1\\2 <a href="##{Mx[:note_ref]}\\2">#{Mx[:nbsp]}<sup id="#{Mx[:note]}\\2">\\2.</sup></a> \\3 \\4}). #endnote- note- (careful may have switched)
gsub(/(#{Mx[:en_b_o]})[*](\d+)\s+(.+?)(#{Mx[:en_b_c]})/,
- %{#{Mx[:nbsp]}<a href="#note_astx\\2">#{Mx[:nbsp]}<sup id="note_ref_astx\\2">#{ast}\\2</sup>#{Mx[:nbsp]}</a> } + #note- endnote-
- %{\\1#{ast}\\2 <a href="#note_ref_astx\\2">#{Mx[:nbsp]}<sup id="note_astx\\2">#{ast}\\2.</sup></a> \\3 \\4}). #endnote- note- (careful may have switched)
+ %{#{Mx[:nbsp]}<a href="##{Mx[:note_astx]}\\2">#{Mx[:nbsp]}<sup id="#{Mx[:note_ref_astx]}\\2">#{ast}\\2</sup>#{Mx[:nbsp]}</a> } + #note- endnote-
+ %{\\1#{ast}\\2 <a href="##{Mx[:note_ref_astx]}\\2">#{Mx[:nbsp]}<sup id="#{Mx[:note_astx]}\\2">#{ast}\\2.</sup></a> \\3 \\4}). #endnote- note- (careful may have switched)
gsub(/(#{Mx[:en_b_o]})[+](\d+)\s+(.+?)(#{Mx[:en_b_c]})/,
- %{#{Mx[:nbsp]}<a href="#note_plus\\2">#{Mx[:nbsp]}<sup id="note_ref_plus\\2">#{pls}\\2</sup>#{Mx[:nbsp]}</a> } + #note- endnote-
- %{\\1#{pls}\\2 <a href="#note_ref_plus\\2">#{Mx[:nbsp]}<sup id="note_plus\\2">#{pls}\\2.</sup></a> \\3 \\4}) #endnote- note- (careful may have switched) # double-check there may here be a bug
+ %{#{Mx[:nbsp]}<a href="##{Mx[:note_plus]}\\2">#{Mx[:nbsp]}<sup id="#{Mx[:note_ref_plus]}\\2">#{pls}\\2</sup>#{Mx[:nbsp]}</a> } + #note- endnote-
+ %{\\1#{pls}\\2 <a href="##{Mx[:note_ref_plus]}\\2">#{Mx[:nbsp]}<sup id="#{Mx[:note_plus]}\\2">#{pls}\\2.</sup></a> \\3 \\4}) #endnote- note- (careful may have switched) # double-check there may here be a bug
if dob.obj =~/#{Mx[:en_a_o]}([*+]+)\s+.+?#{Mx[:en_a_c]}/
m=$1.length.to_i
dob.obj=dob.obj.gsub(/(#{Mx[:en_a_o]})[*]+\s+(.+?)(#{Mx[:en_a_c]})/,
- %{#{Mx[:nbsp]}<a href="#note#{a*m}">#{Mx[:nbsp]}<sup id="note_ref#{a*m}">#{ast*m}</sup>#{Mx[:nbsp]}</a> } + #note- endnote-
- %{\\1#{ast*m} <a href="#note_ref#{a*m}">#{Mx[:nbsp]}<sup id="note#{a*m}">#{ast*m}</sup></a> \\2 \\3}). #endnote- note- (careful may have switched)
+ %{#{Mx[:nbsp]}<a href="##{Mx[:note]}#{a*m}">#{Mx[:nbsp]}<sup id="#{Mx[:note_ref]}#{a*m}">#{ast*m}</sup>#{Mx[:nbsp]}</a> } + #note- endnote-
+ %{\\1#{ast*m} <a href="##{Mx[:note_ref]}#{a*m}">#{Mx[:nbsp]}<sup id="#{Mx[:note]}#{a*m}">#{ast*m}</sup></a> \\2 \\3}). #endnote- note- (careful may have switched)
gsub(/(#{Mx[:en_a_o]})([+]+)\s+(.+?)(#{Mx[:en_a_c]})/,
- %{#{Mx[:nbsp]}<a href="#note#{s*m}">#{Mx[:nbsp]}<sup id="note_ref#{s*m}">#{pls*m}</sup>#{Mx[:nbsp]}</a> } + #note- endnote-
- %{\\1#{pls*m} <a href="#note_ref#{s*m}">#{Mx[:nbsp]}<sup id="note#{s*m}">#{pls*m}</sup></a> \\2 \\3}) #endnote- note- (careful may have switched)
+ %{#{Mx[:nbsp]}<a href="##{Mx[:note]}#{s*m}">#{Mx[:nbsp]}<sup id="#{Mx[:note_ref]}#{s*m}">#{pls*m}</sup>#{Mx[:nbsp]}</a> } + #note- endnote-
+ %{\\1#{pls*m} <a href="##{Mx[:note_ref]}#{s*m}">#{Mx[:nbsp]}<sup id="#{Mx[:note]}#{s*m}">#{pls*m}</sup></a> \\2 \\3}) #endnote- note- (careful may have switched)
end
end
@tuned_file << dob
diff --git a/lib/sisu/v6/xml_fictionbook2.rb b/lib/sisu/v6/xml_fictionbook2.rb
index 9cd7909e..0498a7f0 100644
--- a/lib/sisu/v6/xml_fictionbook2.rb
+++ b/lib/sisu/v6/xml_fictionbook2.rb
@@ -227,7 +227,11 @@ module SiSU_XML_Fictionbook
endnotes
end
def extract_images #work on
- require "base64"
+ begin
+ require 'base64'
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('base64 NOT FOUND (LoadError)')
+ end
images_raw,images_base64_fb2=[],[]
images_base64={}
if defined? @md.make.cover_image[:cover]
diff --git a/lib/sisu/v6/xml_odf_odt.rb b/lib/sisu/v6/xml_odf_odt.rb
index bf9d8df8..0457ad7d 100644
--- a/lib/sisu/v6/xml_odf_odt.rb
+++ b/lib/sisu/v6/xml_odf_odt.rb
@@ -73,8 +73,12 @@ module SiSU_XML_ODF_ODT
require_relative 'txt_shared' # txt_shared.rb
@@alt_id_count,@@alt_id_count,@@tablehead,@@number_of_cols=0,0,0,0
class Source
- require 'zlib'
- require 'find'
+ begin
+ require 'zlib'
+ require 'find'
+ rescue LoadError
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).error('zlib or find NOT FOUND (LoadError)')
+ end
def initialize(opt)
@opt=opt
@particulars=SiSU_Particulars::CombinedSingleton.instance.get_all(opt)
@@ -117,6 +121,7 @@ module SiSU_XML_ODF_ODT
@@fns=nil
def initialize(particulars)
@md,@env,@ao_array=particulars.md,particulars.env,particulars.ao_array
+ @make=SiSU_Env::ProcessingSettings.new(@md)
@vz=SiSU_Viz::Defaults.new
@tab="\t"
@brace_url=SiSU_Viz::Defaults.new.url_decoration
@@ -552,10 +557,10 @@ module SiSU_XML_ODF_ODT
end
p_num={ display: '', set_ref: '' }
if dob.is !~/(^#{Rx[:meta]}|#{Mx[:br_eof]}|#{Mx[:br_endnotes]})/
- if @env.odt_ocn?
+ if @make.build.odt_ocn?
if defined? dob.ocn \
and dob.ocn.is_a?(Fixnum)
- p_num=SiSU_XML_ODF_ODT_Format::ParagraphNumber.new(dob.ocn).set_bookmark_and_display
+ p_num=SiSU_XML_ODF_ODT_Format::ParagraphNumber.new(@make,dob.ocn).set_bookmark_and_display
end
end
end
@@ -678,7 +683,7 @@ module SiSU_XML_ODF_ODT
and (dob.obj =~/~metadata/ or dob =~/#{Mx[:lv_o]}1:meta#{Mx[:lv_x]}\s*Document Information/) #fix Mx[:lv_o]
if dob.is !~/(^#{Rx[:meta]}|#{Mx[:br_eof]}|#{Mx[:br_endnotes]})/ #check
if defined? dob.ocn and dob.ocn =~/\d+/
- @p_num=SiSU_XML_ODF_ODT_Format::ParagraphNumber.new(dob.ocn)
+ @p_num=SiSU_XML_ODF_ODT_Format::ParagraphNumber.new(@make,dob.ocn)
end
if dob.is ==:heading \
|| dob.is ==:para \
@@ -805,7 +810,8 @@ WOK
od.close
opendoc=@md.file.base_filename.odt #watch where output by language
FileUtils::mkdir_p(@md.file.output_path.odt.dir) unless FileTest.directory?(@md.file.output_path.odt.dir)
- if FileTest.directory?(@env.processing_path.odt)
+ if FileTest.directory?(@env.processing_path.odt) \
+ and SiSU_Env::SystemCall.new.zip
pwd=Dir.pwd
Dir.chdir(@env.processing_path.odt)
system("
@@ -813,6 +819,8 @@ WOK
")
FileUtils::mv(opendoc, @md.file.place_file.odt.dir)
Dir.chdir(pwd)
+ else
+ SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).mark('*EXITED odf* zip program not found') unless SiSU_Env::SystemCall.new.zip
end
end
end
diff --git a/lib/sisu/v6/xml_odf_odt_format.rb b/lib/sisu/v6/xml_odf_odt_format.rb
index bc7fadea..b2539dfd 100644
--- a/lib/sisu/v6/xml_odf_odt_format.rb
+++ b/lib/sisu/v6/xml_odf_odt_format.rb
@@ -65,17 +65,26 @@ module SiSU_XML_ODF_ODT_Format
include SiSU_Param
include SiSU_Viz
class ParagraphNumber
- def initialize(paranum)
+ def initialize(make,paranum)
+ @make=make
@paranum=/(\d+)/m.match(paranum.to_s)[1]
end
def set_ref_and_display
- set_ref=@paranum.gsub(/(\d+)/,' <text:span text:style-name="Span_subscript"><text:reference-mark-start text:name="\1"/><text:reference-mark-end text:name="\1"/></text:span>')
- disp=@paranum.gsub(/(\d+)/,%{ <text:span text:style-name="Span_subscript">#{Dx[:ocn_o]}\\1#{Dx[:ocn_c]}</text:span>})
+ set_ref=@paranum.gsub(/(\d+)/,
+ ' <text:span text:style-name="Span_subscript"><text:reference-mark-start text:name="\1"/><text:reference-mark-end text:name="\1"/></text:span>')
+ disp=@paranum.gsub(/(\d+)/,
+ (@make.build.odt_ocn?) \
+ ? %{ <text:span text:style-name="Span_subscript">#{Dx[:ocn_o]}\\1#{Dx[:ocn_c]}</text:span>}
+ : '')
{ display: disp, set_ref: set_ref }
end
def set_bookmark_and_display
- set_ref=@paranum.gsub(/(\d+)/,' <text:span text:style-name="Span_subscript"><text:bookmark-start text:name="\1"/><text:bookmark-end text:name="\1"/></text:span>')
- disp=@paranum.gsub(/(\d+)/,%{ <text:span text:style-name="Span_subscript">#{Dx[:ocn_o]}\\1#{Dx[:ocn_c]}</text:span>})
+ set_ref=@paranum.gsub(/(\d+)/,
+ ' <text:span text:style-name="Span_subscript"><text:bookmark-start text:name="\1"/><text:bookmark-end text:name="\1"/></text:span>')
+ disp=@paranum.gsub(/(\d+)/,
+ (@make.build.odt_ocn?) \
+ ? %{ <text:span text:style-name="Span_subscript">#{Dx[:ocn_o]}\\1#{Dx[:ocn_c]}</text:span>}
+ : '')
{ display: disp, set_ref: set_ref }
end
def name
diff --git a/man/man1/sisu.1 b/man/man1/sisu.1
index a692a9f4..f6bb6b5b 100644
--- a/man/man1/sisu.1
+++ b/man/man1/sisu.1
@@ -1,4 +1,4 @@
-.TH "sisu" "1" "2013-11-27" "5.1.0" "SiSU"
+.TH "sisu" "1" "2014-02-05" "6.0.1" "SiSU"
.br
.SH NAME
.br
@@ -37,197 +37,68 @@ RALPH AMISSAH
.BR
-.B SiSU
-is a framework for document structuring, publishing (in multiple open standard
-formats) and search, comprising of: (a) a lightweight document structure and
-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.
-
-.BR
-.B SiSU
-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
.B SiSU
-both defines a markup syntax and provides an engine that produces open
-standards format outputs from documents prepared with
+is a lightweight markup based document creation and publishing framework that
+is controlled from the command line. Prepare documents for
.B 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
+using your text editor of choice, then use
.B SiSU
-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
-.I SQL
-type databases at an object level, which means that searches can be made with
-that degree of granularity.
+to generate various output document formats.
.BR
-Source document preparation and output generation is a two step process: (i)
-document source is prepared, that is, marked up in sisu markup syntax and (ii)
-the desired output subsequently generated by running the sisu engine against
-document source. Output representations if updated (in the sisu engine) can be
-generated by re-running the engine against the prepared source. Using
-.B SiSU
-markup applied to a document,
+From a single lightly prepared document (plain-text
+.I UTF-8
+) 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.
.B SiSU
-custom builds (to take advantage of the strengths of different ways of
-representing documents) various standard open output formats including plain
-text,
+produces: plain-text,
.I HTML,
.I XHTML,
.I XML,
.I EPUB,
-.I ODT,
-.I LaTeX
-or
-.I PDF
-files, and populate an
+.I ODF:
+.I ODT
+(Opendocument),
+.I LaTeX,
+.I PDF,
+and populates 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.
+database (
+.I PostgreSQL
+or
+.I SQLite
+) with text objects, roughly, paragraph sized chunks so that document searches
+are done at this level of granularity.
.BR
-In preparing a
-.B 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.
+Outputs share a common citation numbering system, associated with text objects
+and any semantic meta-data provided about the document.
.BR
-.B SiSU
-works with an abstraction of the document based on its structure which is
-comprised of its headings[^3] and objects[^4], which enables
-.B 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
-.B SiSU
-is able to take advantage of.
-.BR
-One of the challenges of maintaining documents is to keep them in a format that
-allows use of them independently of proprietary platforms. Consider issues
-related to dealing with legacy proprietary formats today and what guarantee you
-have that old proprietary formats will remain (or can be read without
-proprietary software/equipment) in 15 years time, or the way the way in which
-html has evolved over its relatively short span of existence.
-.B SiSU
-provides the flexibility of producing documents in multiple non-proprietary
-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
-easily converted to other formats, which means documents prepared in
-.B SiSU
-can be migrated to other document formats. Further security is provided by the
-fact that the software itself,
-.B SiSU
-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),
-.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).
+also provides concordance files, document content certificates and manifests of
+generated output. Book indexes may be made.
.BR
-The document formats are written to the file-system and available for indexing
-by independent indexing tools, whether off the web like Google and Yahoo or on
-the site like Lucene and Hyperestraier.
+Some document markup samples are provided in the package sisu -markup-samples.
+Homepages:
-.BR
-.B SiSU
-also provides other features such as concordance files and document content
-certificates, and the working against an abstraction of document structure has
-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
-.B SiSU
-offers great possibilities.
+* <http://www.sisudoc.org/>
-.BR
-.B SiSU
-is primarily for published works, which can take advantage of the citation
-system to reliably reference its documents.
-.B 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
-.B SiSU.
-
-.BR
-<http://www.sisudoc.org/>
+* <http://www.jus.uio.no/sisu>
-.BR
-<http://www.jus.uio.no/sisu>
.SH COMMANDS SUMMARY
.SH DESCRIPTION
.BR
+
.B SiSU
is a document publishing system, that from a simple single marked-up document,
produces multiple output formats including:
@@ -428,6 +299,9 @@ produces html output, the document in a single file (scroll.html) only. Compare
produces html output, segmented text with table of contents (toc.html and
index.html). Compare --html-scroll and --html
.TP
+.B --html-strict [filename/wildcard]
+produces html with --strict option. see --strict
+.TP
.B -I [filename/wildcard]
see --texinfo
.TP
@@ -498,6 +372,9 @@ see --exc-*
.B -o [filename/wildcard/url]
see --odt
.TP
+.B --ocn
+see --inc-ocn and --exc-ocn
+.TP
.B --odf [filename/wildcard/url]
see --odt
.TP
@@ -702,6 +579,10 @@ for sending). See the -S option without [filename/wildcard]. Alias -S
.B --source [filename/wildcard]
copies sisu markup file to output directory. Alias -s
.TP
+.B --strict
+together with --html, produces more w3c compliant html, for example not having
+purely numeric identifiers for text, the location object url#33 becomes url#o33
+.TP
.B -T [filename/wildcard (*.termsheet.rb)]
standard form document builder, preprocessing feature
.TP
@@ -2279,6 +2160,8 @@ 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).
+.BR
+To draw a dividing line dividing paragraphs, see the section on page breaks.
.SH PAGE BREAKS
.BR
diff --git a/rbuild b/rbuild
index fab9770b..060ffafe 100644
--- a/rbuild
+++ b/rbuild
@@ -37,8 +37,8 @@
#require 'mkmf'
#create_makefile("sisu")
#% manual settings, edit/update as required (note current default settings are obtained from sisu version yml file)
-SiSU_version_next_stable = '5.3.0'
-SiSU_version_next_unstable = '6.0.0'
+SiSU_version_next_stable = '5.3.1'
+SiSU_version_next_unstable = '6.0.1'
#% rake file
SiSU_version_generic_next_stable = '5.3.x'
SiSU_version_generic_next_unstable = '6.0.x'