diff options
| author | Ralph Amissah <ralph@amissah.com> | 2011-10-03 21:20:32 -0400 |
|---|---|---|
| committer | Ralph Amissah <ralph@amissah.com> | 2011-10-03 21:20:32 -0400 |
| commit | 34d683d8857adab360c75edffe5a1af410c3a373 (patch) | |
| tree | c85e5ad32a6e54431d36ad99f7f4b93544bdfd6b | |
| parent | debian/changelog (3.0.19-1) (diff) | |
| parent | v2 v3: documenation, html, man2html (sisu.1) (diff) | |
Merge commit 'sisu_3.1.0' into debian/sid
39 files changed, 1171 insertions, 303 deletions
@@ -29,8 +29,12 @@ current version #{e['RUBY_PROGRAM_VERSION']}p#{e['PATCHLEVEL']} WOK end end + def check_sisu_legacy_ruby_version? + rbv_sisu_legacy='1.9.2' #'1.8.7' + ruby_version_ok?(rbv_sisu_legacy) + end def check_sisu_stable_ruby_version? - rbv_sisu_stable='1.8.7' + rbv_sisu_stable='1.9.2' ruby_version_ok?(rbv_sisu_stable) end def check_sisu_dev_ruby_version? @@ -42,17 +46,17 @@ WOK argv=$* SiSU_version_dir=case argv.inspect when /--v2/ - check_sisu_stable_ruby_version? + check_sisu_legacy_ruby_version? 'v2' when /--v3/ - check_sisu_dev_ruby_version? + check_sisu_stable_ruby_version? 'v3' when /--dev/ check_sisu_dev_ruby_version? 'v3' else check_sisu_stable_ruby_version? - 'v2' + 'v3' end SiSU_lib="sisu/#{SiSU_version_dir}" require "#{SiSU_lib}/hub" @@ -29,8 +29,12 @@ current version #{e['RUBY_PROGRAM_VERSION']}p#{e['PATCHLEVEL']} WOK end end + def check_sisu_legacy_ruby_version? + rbv_sisu_legacy='1.9.2' #'1.8.7' + ruby_version_ok?(rbv_sisu_legacy) + end def check_sisu_stable_ruby_version? - rbv_sisu_stable='1.8.7' + rbv_sisu_stable='1.9.2' ruby_version_ok?(rbv_sisu_stable) end def check_sisu_dev_ruby_version? @@ -42,16 +46,16 @@ WOK argv=$* SiSU_version_dir=case argv.inspect when /--v2/ - check_sisu_stable_ruby_version? + check_sisu_legacy_ruby_version? 'v2' when /--v3/ - check_sisu_dev_ruby_version? + check_sisu_stable_ruby_version? 'v3' when /--dev/ check_sisu_dev_ruby_version? 'v3' else - check_sisu_stable_ruby_version? + check_sisu_legacy_ruby_version? 'v2' end SiSU_lib="sisu/#{SiSU_version_dir}" @@ -29,8 +29,12 @@ current version #{e['RUBY_PROGRAM_VERSION']}p#{e['PATCHLEVEL']} WOK end end + def check_sisu_legacy_ruby_version? + rbv_sisu_legacy='1.9.2' #'1.8.7' + ruby_version_ok?(rbv_sisu_legacy) + end def check_sisu_stable_ruby_version? - rbv_sisu_stable='1.8.7' + rbv_sisu_stable='1.9.2' ruby_version_ok?(rbv_sisu_stable) end def check_sisu_dev_ruby_version? @@ -42,16 +46,16 @@ WOK argv=$* SiSU_version_dir=case argv.inspect when /--v2/ - check_sisu_stable_ruby_version? + check_sisu_legacy_ruby_version? 'v2' when /--v3/ - check_sisu_dev_ruby_version? + check_sisu_stable_ruby_version? 'v3' when /--dev/ check_sisu_dev_ruby_version? 'v3' else - check_sisu_dev_ruby_version? + check_sisu_stable_ruby_version? 'v3' end SiSU_lib="sisu/#{SiSU_version_dir}" diff --git a/bin/sisu_termsheet b/bin/sisu_termsheet index 5566a962..a127d615 100644 --- a/bin/sisu_termsheet +++ b/bin/sisu_termsheet @@ -29,8 +29,12 @@ current version #{e['RUBY_PROGRAM_VERSION']}p#{e['PATCHLEVEL']} WOK end end + def check_sisu_legacy_ruby_version? + rbv_sisu_legacy='1.9.2' #'1.8.7' + ruby_version_ok?(rbv_sisu_legacy) + end def check_sisu_stable_ruby_version? - rbv_sisu_stable='1.8.7' + rbv_sisu_stable='1.9.2' ruby_version_ok?(rbv_sisu_stable) end def check_sisu_dev_ruby_version? @@ -41,17 +45,17 @@ WOK argv=$* SiSU_version_dir=case argv.inspect when /--v2/ - check_sisu_stable_ruby_version? + check_sisu_legacy_ruby_version? 'v2' when /--v3/ - check_sisu_dev_ruby_version? + check_sisu_stable_ruby_version? 'v3' when /--dev/ check_sisu_dev_ruby_version? 'v3' else check_sisu_stable_ruby_version? - 'v2' + 'v3' end SiSU_lib="sisu/#{SiSU_version_dir}" require "#{SiSU_lib}/termsheet" diff --git a/bin/sisu_webrick b/bin/sisu_webrick index b9ac031a..52d95e41 100644 --- a/bin/sisu_webrick +++ b/bin/sisu_webrick @@ -18,7 +18,7 @@ begin def check_incompatible_ruby_build? require 'rbconfig' e=Config::CONFIG - if RUBY_VERSION == '1.9.2' \ + if RUBY_VERSION == '1.9.2' \ && e['PATCHLEVEL'].to_i < 180 raise <<WOK There are known issues with early versions of ruby1.9.2. @@ -29,8 +29,12 @@ current version #{e['RUBY_PROGRAM_VERSION']}p#{e['PATCHLEVEL']} WOK end end + def check_sisu_legacy_ruby_version? + rbv_sisu_legacy='1.9.2' #'1.8.7' + ruby_version_ok?(rbv_sisu_legacy) + end def check_sisu_stable_ruby_version? - rbv_sisu_stable='1.8.7' + rbv_sisu_stable='1.9.2' ruby_version_ok?(rbv_sisu_stable) end def check_sisu_dev_ruby_version? @@ -41,17 +45,17 @@ WOK argv=$* SiSU_version_dir=case argv.inspect when /--v2/ - check_sisu_stable_ruby_version? + check_sisu_legacy_ruby_version? 'v2' when /--v3/ - check_sisu_dev_ruby_version? + check_sisu_stable_ruby_version? 'v3' when /--dev/ check_sisu_dev_ruby_version? 'v3' else check_sisu_stable_ruby_version? - 'v2' + 'v3' end SiSU_lib="sisu/#{SiSU_version_dir}" require "#{SiSU_lib}/webrick" diff --git a/conf/sisu/v2/sisurc.yml b/conf/sisu/v2/sisurc.yml index 1b1437f4..86545f32 100644 --- a/conf/sisu/v2/sisurc.yml +++ b/conf/sisu/v2/sisurc.yml @@ -53,7 +53,7 @@ flag: i: '-Nhewpoty' # -m run by default ii: '-NhewpotbxX' # -m run by default iii: '-NhewpotbxXY' # -m run by default - iv: '-NhwepoabxXYD --update' # -m run by default + iv: '-NhewpoabxXYD --update' # -m run by default v: '-NhewpotbxXYDv --update' # -m run by default; includes verbose #% papersize, (LaTeX/pdf) available values: A4, US_letter, book_b5, book_a5, US_legal diff --git a/conf/sisu/v3/sisurc.yml b/conf/sisu/v3/sisurc.yml index 9d69f0c2..0d95d4c6 100644 --- a/conf/sisu/v3/sisurc.yml +++ b/conf/sisu/v3/sisurc.yml @@ -60,7 +60,8 @@ flag: default: papersize: 'A4,letter' #language: 'en' - #texpdf_font: 'Liberation Serif' # 'Liberation Sans' 'Liberation Serif' + #texpdf_font: 'Liberation Sans' # 'Liberation Sans' 'Liberation Serif' + #texpdf_font_mono: 'Liberation Mono' #'Inconsolata' #text_wrap: 78 #emphasis: 'bold' #make *{emphasis}* 'bold', 'italics' or 'underscore', default if not configured is 'bold' #digest: 'sha' #sha is sha256, default is md5 diff --git a/data/doc/sisu/CHANGELOG_v2 b/data/doc/sisu/CHANGELOG_v2 index dc571770..eab6996e 100644 --- a/data/doc/sisu/CHANGELOG_v2 +++ b/data/doc/sisu/CHANGELOG_v2 @@ -12,7 +12,16 @@ Reverse Chronological: %% STABLE Branch -%% 2.9.8.orig.tar.gz (2011-09-24:38/6) [see 3.0.19] +%% 2.9.9 (2011-10-03:40/1) [see 3.1.0.orig.tar.xz] +http://git.sisudoc.org/?p=code/sisu.git;a=log;h=refs/tags/sisu_3.1.0 +http://git.sisudoc.org/?p=code/sisu.git;a=log;h=refs/tags/debian/sisu_3.1.0-1 + + * bin/sisu, default sisu version 3 + + * documentation, small update, see v3 changelog + * sisu source + +%% 2.9.8 (2011-09-24:38/6) [see 3.0.19.orig.tar.gz] http://git.sisudoc.org/?p=code/sisu.git;a=log;h=refs/tags/sisu-3.0.19 http://git.sisudoc.org/?p=code/sisu.git;a=log;h=refs/tags/debian/sisu_3.0.19-1 @@ -20,7 +29,7 @@ http://git.sisudoc.org/?p=code/sisu.git;a=log;h=refs/tags/debian/sisu_3.0.19-1 * remote, image source url fix -%% 2.9.7.orig.tar.gz (2011-06-26:25/7) [see 3.0.13] +%% 2.9.7 (2011-06-26:25/7) [see 3.0.13.orig.tar.gz] http://git.sisudoc.org/?p=code/sisu.git;a=shortlog;h=refs/tags/debian/3.0.13-1 * dal_syntax, linebreak within regular objects is \\ (<br> depreciated) @@ -36,17 +45,17 @@ http://git.sisudoc.org/?p=code/sisu.git;a=shortlog;h=refs/tags/debian/3.0.13-1 * sisurc.yml, config settings -%% 2.9.6.orig.tar.gz (2011-06-07:23/2) [see 3.0.12] +%% 2.9.6 (2011-06-07:23/2) [see 3.0.12.orig.tar.gz] http://git.sisudoc.org/?p=code/sisu.git;a=shortlog;h=refs/tags/debian/3.0.12-1 * help, s/Bul garian/Bulgarian/ (Closes: #619068) -%% 2.9.5.orig.tar.gz (2011-05-17:20/2) [see 3.0.10] +%% 2.9.5 (2011-05-17:20/2) [see 3.0.10.orig.tar.gz] http://git.sisudoc.org/?p=code/sisu.git;a=shortlog;h=refs/tags/debian/3.0.10-1 * copyright (minor) touch, dates for setup.rb -%% 2.9.4.orig.tar.gz (2011-05-15:19/7) [see 3.0.9] +%% 2.9.4 (2011-05-15:19/7) [see 3.0.9.orig.tar.gz] http://git.sisudoc.org/?p=code/sisu.git;a=shortlog;h=refs/tags/debian/3.0.9-1 * bin/sisu2 introduced (to complement bin/sisu3), currently same as bin/sisu @@ -57,7 +66,7 @@ http://git.sisudoc.org/?p=code/sisu.git;a=shortlog;h=refs/tags/debian/3.0.9-1 * copyright file, softlink, make more visible in tarball and update * sisu-mode.el assigned to FSF (GNU EMACS) -%% 2.9.3.orig.tar.gz (2011-04-27:17/3) [see 3.0.8] +%% 2.9.3 (2011-04-27:17/3) [see 3.0.8.orig.tar.gz] http://git.sisudoc.org/?p=code/sisu.git;a=shortlog;h=refs/tags/debian/3.0.8-1 * bin/sisu3 bin/sisu /bin/sisu_webrick bin/sisu_termsheet @@ -106,7 +115,7 @@ http://git.sisudoc.org/?p=code/sisu.git;a=shortlog;h=refs/tags/debian/3.0.8-1 * vim colors colorscheme sparse-* frugal-* Slate minor changes -%% 2.9.2.orig.tar.gz (2011-04-20:16/3) [see 3.0.7] +%% 2.9.2 (2011-04-20:16/3) [see 3.0.7.orig.tar.gz] http://git.sisudoc.org/?p=code/sisu.git;a=shortlog;h=refs/tags/debian/3.0.7-1 * options, maintenance -M (--maintenance, new alias --keep-processing-files) @@ -127,7 +136,7 @@ http://git.sisudoc.org/?p=code/sisu.git;a=shortlog;h=refs/tags/debian/3.0.7-1 (GNU EMACS) * url to sisu git repo source (when possible also track GNU EMACS location) -%% 2.9.1.orig.tar.gz (2011-03-30:13/3) [see 3.0.6] +%% 2.9.1 (2011-03-30:13/3) [see 3.0.6.orig.tar.gz] http://git.sisudoc.org/?p=code/sisu.git;a=shortlog;h=refs/tags/debian/3.0.6-1 * (ruby 1.9.2 (transition related) fixes) @@ -146,7 +155,7 @@ http://git.sisudoc.org/?p=code/sisu.git;a=shortlog;h=refs/tags/debian/3.0.6-1 * for console use color names instead of numbers * rearrange -%% 2.9.0.orig.tar.gz (2011-03-24:12/4) [see 3.0.5] +%% 2.9.0 (2011-03-24:12/4) [see 3.0.5.orig.tar.gz] http://git.sisudoc.org/?p=code/sisu.git;a=shortlog;h=refs/tags/debian/3.0.5-1 * move to ruby >=1.9.2p180: simplify development of v3 and maintenance of v2 @@ -164,7 +173,7 @@ http://git.sisudoc.org/?p=code/sisu.git;a=shortlog;h=refs/tags/debian/3.0.5-1 * vim syntax highlighting, fix typo -%% 2.8.2.orig.tar.gz (2011-03-11:10/5) [see 3.0.3] +%% 2.8.2 (2011-03-11:10/5) [see 3.0.3.orig.tar.gz] http://git.sisudoc.org/?p=code/sisu.git;a=shortlog;h=refs/tags/debian/3.0.3-1 * dal_syntax and affected downstream output modules, revised pattern match @@ -201,7 +210,7 @@ http://git.sisudoc.org/?p=code/sisu.git;a=shortlog;h=refs/tags/debian/3.0.3-1 * emacs sisu headers updated (subheaders omitted for now) sisu-mode.el * vim cleaning sisu.vim -%% 2.8.1.orig.tar.gz (2011-03-05:09/6) [see 3.0.2] +%% 2.8.1 (2011-03-05:09/6) [see 3.0.2.orig.tar.gz] http://git.sisudoc.org/?p=code/sisu.git;a=shortlog;h=refs/tags/debian/3.0.2-1 * make sisu: v2 require >=ruby1.8.7; v3 require >=ruby1.9.2 @@ -217,7 +226,7 @@ http://git.sisudoc.org/?p=code/sisu.git;a=shortlog;h=refs/tags/debian/3.0.2-1 * tidy * small fixes -%% 2.8.0.orig.tar.gz (2011-02-01:05/2) [see 3.0.0] +%% 2.8.0 (2011-02-01:05/2) [see 3.0.0.orig.tar.gz] http://git.sisudoc.org/?p=code/sisu.git;a=shortlog;h=refs/tags/debian/3.0.0-1 [post Debian Squeeze] diff --git a/data/doc/sisu/CHANGELOG_v3 b/data/doc/sisu/CHANGELOG_v3 index abb354d3..8c9faace 100644 --- a/data/doc/sisu/CHANGELOG_v3 +++ b/data/doc/sisu/CHANGELOG_v3 @@ -13,13 +13,46 @@ Reverse Chronological: %% Development branch UNSTABLE v3 branch once stable will supersede & replace current stable v2 branch -%% 3.0.19.orig.tar.xz (2011-01-24:38/6) +%% 3.1.0.orig.tar.xz (2011-10-03:40/1) +http://git.sisudoc.org/?p=code/sisu.git;a=log;h=refs/tags/sisu_3.1.0 +http://git.sisudoc.org/?p=code/sisu.git;a=log;h=refs/tags/debian/sisu_3.1.0-1 +http://www.jus.uio.no/sisu/pkg/src/sisu_3.1.0.orig.tar.xz + sisu_3.1.0.orig.tar.xz + sisu_3.1.0-1.dsc + sisu_3.1.0-1.debian.tar.gz + + * bin/sisu, default sisu version 3 + + * sysenv, rc_path adds ./.sisu/ (to existing ./_sisu/ & ~/.sisu/) + + * defaults, (sisu) home page + * link to git repo + * minor fixes + + * sysenv, output_structure_by: filename, fix to output directories created + + * texpdf, fonts, Liberation series default (Sans for main) + * (mono) improved with selection of Liberation Mono as default + * font (main font, mono) configurable in sisurc.yml under + default: (texpdf_font:|texpdf_font_mono:) + or within document under @make: (:texpdf_font:|:texpdf_font_mono:) + + * sisrc.yml, texpdf_font (main, mono) Liberation series (main default Sans) + + * vim syntax, :texpdf_font_mono: added to @make: + + * documentation, small update + * sisu source + * manpage + * man2html html + +%% 3.0.19.orig.tar.xz (2011-09-24:38/6) http://git.sisudoc.org/?p=code/sisu.git;a=log;h=refs/tags/sisu-3.0.19 http://git.sisudoc.org/?p=code/sisu.git;a=log;h=refs/tags/debian/sisu_3.0.19-1 http://www.jus.uio.no/sisu/pkg/src/sisu_3.0.19.orig.tar.xz - sisu_3.0.19.orig.tar.xz - sisu_3.0.19-1.dsc - sisu_3.0.19-1.debian.tar.gz + d2252448ba66aa3ac0cba7b031e43efbd824f6aa74d7a0fdeaaae5cc43ec79be 1180092 sisu_3.0.19.orig.tar.xz + bfc7b80ea996ed752ff865921057686230d6b797b6a980759254d038f2ea770d 1389 sisu_3.0.19-1.dsc + 9edeb33db7d2a8205e1db3c6dea9db74d972a476a0ad95fc784157caf041a8c4 288288 sisu_3.0.19-1.debian.tar.gz * hub, processing options, remove cruft diff --git a/data/doc/sisu/html/sisu-concordance.1.html b/data/doc/sisu/html/sisu-concordance.1.html index adf6d102..b4e53653 100644 --- a/data/doc/sisu/html/sisu-concordance.1.html +++ b/data/doc/sisu/html/sisu-concordance.1.html @@ -53,8 +53,8 @@ for <b>sisu --concordance</b> (or <b>sisu -w</b>) which produces an HTML concord More information about <b>SiSU</b> can be found at <<a href='http://www.sisudoc.org/'><i>http://www.sisudoc.org/</i></a> > or <<a href='http://www.jus.uio.no/sisu/'><i>http://www.jus.uio.no/sisu/</i></a> ->. -<p> +>. +<p> <h2><a name='sect5' href='#toc5'>Author</a></h2> <b>SiSU</b> is written by Ralph Amissah <<i>ralph@amissah.com</i>>. <p> diff --git a/data/doc/sisu/html/sisu-epub.1.html b/data/doc/sisu/html/sisu-epub.1.html index f7ebeb73..fe853f62 100644 --- a/data/doc/sisu/html/sisu-epub.1.html +++ b/data/doc/sisu/html/sisu-epub.1.html @@ -53,8 +53,8 @@ The <b>sisu-epub</b> command is an alias for More information about <b>SiSU</b> can be found at <<a href='http://www.sisudoc.org/'><i>http://www.sisudoc.org/</i></a> > or <<a href='http://www.jus.uio.no/sisu/'><i>http://www.jus.uio.no/sisu/</i></a> ->. -<p> +>. +<p> <h2><a name='sect5' href='#toc5'>Author</a></h2> <b>SiSU</b> is written by Ralph Amissah <<i>ralph@amissah.com</i>>. <p> diff --git a/data/doc/sisu/html/sisu-git.1.html b/data/doc/sisu/html/sisu-git.1.html index ef879ed5..b2955f6e 100644 --- a/data/doc/sisu/html/sisu-git.1.html +++ b/data/doc/sisu/html/sisu-git.1.html @@ -51,8 +51,8 @@ document and associated parts (images, ). More information about <b>SiSU</b> can be found at <<a href='http://www.sisudoc.org/'><i>http://www.sisudoc.org/</i></a> > or <<a href='http://www.jus.uio.no/sisu/'><i>http://www.jus.uio.no/sisu/</i></a> ->. -<p> +>. +<p> <h2><a name='sect5' href='#toc5'>Author</a></h2> <b>SiSU</b> is written by Ralph Amissah <<i>ralph@amissah.com</i>>. <p> diff --git a/data/doc/sisu/html/sisu-harvest.1.html b/data/doc/sisu/html/sisu-harvest.1.html index 37f28b46..ac5d3034 100644 --- a/data/doc/sisu/html/sisu-harvest.1.html +++ b/data/doc/sisu/html/sisu-harvest.1.html @@ -55,8 +55,8 @@ Also</a></h2> More information about <b>SiSU</b> can be found at <<a href='http://www.sisudoc.org/'><i>http://www.sisudoc.org/</i></a> > or <<a href='http://www.jus.uio.no/sisu/'><i>http://www.jus.uio.no/sisu/</i></a> ->. -<p> +>. +<p> <h2><a name='sect5' href='#toc5'>Author</a></h2> <b>SiSU</b> is written by Ralph Amissah <<i>ralph@amissah.com</i>>. <p> diff --git a/data/doc/sisu/html/sisu-html.1.html b/data/doc/sisu/html/sisu-html.1.html index 0af45521..3114567e 100644 --- a/data/doc/sisu/html/sisu-html.1.html +++ b/data/doc/sisu/html/sisu-html.1.html @@ -53,8 +53,8 @@ The <b>sisu-html</b> command is an alias for More information about <b>SiSU</b> can be found at <<a href='http://www.sisudoc.org/'><i>http://www.sisudoc.org/</i></a> > or <<a href='http://www.jus.uio.no/sisu/'><i>http://www.jus.uio.no/sisu/</i></a> ->. -<p> +>. +<p> <h2><a name='sect5' href='#toc5'>Author</a></h2> <b>SiSU</b> is written by Ralph Amissah <<i>ralph@amissah.com</i>>. <p> diff --git a/data/doc/sisu/html/sisu-odf.1.html b/data/doc/sisu/html/sisu-odf.1.html index 504ed3d2..f2e32f3f 100644 --- a/data/doc/sisu/html/sisu-odf.1.html +++ b/data/doc/sisu/html/sisu-odf.1.html @@ -53,8 +53,8 @@ file. More information about <b>SiSU</b> can be found at <<a href='http://www.sisudoc.org/'><i>http://www.sisudoc.org/</i></a> > or <<a href='http://www.jus.uio.no/sisu/'><i>http://www.jus.uio.no/sisu/</i></a> ->. -<p> +>. +<p> <h2><a name='sect5' href='#toc5'>Author</a></h2> <b>SiSU</b> is written by Ralph Amissah <<i>ralph@amissah.com</i>>. <p> diff --git a/data/doc/sisu/html/sisu-pdf.1.html b/data/doc/sisu/html/sisu-pdf.1.html index d46f7e4f..2394a227 100644 --- a/data/doc/sisu/html/sisu-pdf.1.html +++ b/data/doc/sisu/html/sisu-pdf.1.html @@ -8,22 +8,22 @@ <body bgcolor='white'> <a href='#toc'>Table of Contents</a><p> -<p> +<p> <h2><a name='sect0' href='#toc0'>Name</a></h2> <b>SiSU</b> - Structured information, Serialized Units - a document publishing -<p>system -<p> +<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> +<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> +<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> @@ -53,8 +53,8 @@ Also</a></h2> More information about <b>SiSU</b> can be found at <<a href='http://www.sisudoc.org/'><i>http://www.sisudoc.org/</i></a> > or <<a href='http://www.jus.uio.no/sisu/'><i>http://www.jus.uio.no/sisu/</i></a> ->. -<p> +>. +<p> <h2><a name='sect5' href='#toc5'>Author</a></h2> <b>SiSU</b> is written by Ralph Amissah <<i>ralph@amissah.com</i>>. <p> diff --git a/data/doc/sisu/html/sisu-pg.1.html b/data/doc/sisu/html/sisu-pg.1.html index 01e6a6ea..98aa2070 100644 --- a/data/doc/sisu/html/sisu-pg.1.html +++ b/data/doc/sisu/html/sisu-pg.1.html @@ -53,8 +53,8 @@ The <b>sisu-pq</b> command is an alias for <b>sisu More information about <b>SiSU</b> can be found at <<a href='http://www.sisudoc.org/'><i>http://www.sisudoc.org/</i></a> > or <<a href='http://www.jus.uio.no/sisu/'><i>http://www.jus.uio.no/sisu/</i></a> ->. -<p> +>. +<p> <h2><a name='sect5' href='#toc5'>Author</a></h2> <b>SiSU</b> is written by Ralph Amissah <<i>ralph@amissah.com</i>>. <p> diff --git a/data/doc/sisu/html/sisu-po.1.html b/data/doc/sisu/html/sisu-po.1.html index acefe6a6..3c87cce1 100644 --- a/data/doc/sisu/html/sisu-po.1.html +++ b/data/doc/sisu/html/sisu-po.1.html @@ -54,8 +54,8 @@ Experimental, and under development. More information about <b>SiSU</b> can be found at <<a href='http://www.sisudoc.org/'><i>http://www.sisudoc.org/</i></a> > or <<a href='http://www.jus.uio.no/sisu/'><i>http://www.jus.uio.no/sisu/</i></a> ->. -<p> +>. +<p> <h2><a name='sect5' href='#toc5'>Author</a></h2> <b>SiSU</b> is written by Ralph Amissah <<i>ralph@amissah.com</i>>. diff --git a/data/doc/sisu/html/sisu-sqlite.1.html b/data/doc/sisu/html/sisu-sqlite.1.html index d9ef7376..218dbc81 100644 --- a/data/doc/sisu/html/sisu-sqlite.1.html +++ b/data/doc/sisu/html/sisu-sqlite.1.html @@ -53,8 +53,8 @@ The <b>sisu-sqlite</b> command is an alias for More information about <b>SiSU</b> can be found at <<a href='http://www.sisudoc.org/'><i>http://www.sisudoc.org/</i></a> > or <<a href='http://www.jus.uio.no/sisu/'><i>http://www.jus.uio.no/sisu/</i></a> ->. -<p> +>. +<p> <h2><a name='sect5' href='#toc5'>Author</a></h2> <b>SiSU</b> is written by Ralph Amissah <<i>ralph@amissah.com</i>>. <p> diff --git a/data/doc/sisu/html/sisu-txt.1.html b/data/doc/sisu/html/sisu-txt.1.html index 122fa2d9..fb96ed17 100644 --- a/data/doc/sisu/html/sisu-txt.1.html +++ b/data/doc/sisu/html/sisu-txt.1.html @@ -53,8 +53,8 @@ file. More information about <b>SiSU</b> can be found at <<a href='http://www.sisudoc.org/'><i>http://www.sisudoc.org/</i></a> > or <<a href='http://www.jus.uio.no/sisu/'><i>http://www.jus.uio.no/sisu/</i></a> ->. -<p> +>. +<p> <h2><a name='sect5' href='#toc5'>Author</a></h2> <b>SiSU</b> is written by Ralph Amissah <<i>ralph@amissah.com</i>>. <p> diff --git a/data/doc/sisu/html/sisu.1.html b/data/doc/sisu/html/sisu.1.html index 33529bfc..e973641b 100644 --- a/data/doc/sisu/html/sisu.1.html +++ b/data/doc/sisu/html/sisu.1.html @@ -16,17 +16,20 @@ and search <br> <h2><a name='sect1' href='#toc1'>Synopsis</a></h2> <br> -sisu [-abcDdFehIiMmNnopqRrSsTtUuVvwXxYyZz0-9] [filename/wildcard] +sisu [-abCcDdeFGghIikLMmNnoPpQqRrSsTtUuVvWwXxYyZ_0-9] [filename/wildcard] + <p> <br> sisu [-Ddcv] [instruction] [filename/wildcard] <p> <br> sisu [-CcFLSVvW] <p> <br> -sisu --v2 [operations] +sisu [operations] <p> <br> sisu --v3 [operations] <p> <br> -sisu3 [operations] +sisu --v2 [operations] +<p> <br> +sisu2 [operations] <h2><a name='sect2' href='#toc2'>Sisu - Manual,</a></h2> RALPH AMISSAH <br> @@ -185,7 +188,7 @@ for endnotes --footnotes for footnotes at the end of each paragraph --unix for unix linefeed (default) --msdos for msdos linefeed) <p> </dd> -<dt><b>-b [filename/wildcard]</b> </dt> +<dt><b>-b [filename/wildcard]</b></dt> <dd>see --xhtml <p> </dd> @@ -352,16 +355,16 @@ file (scroll.html). Alias -h <dd>see --dal (document abstraction level/layer) <p> </dd> -<dt><b>--maintenance [filename/wildcard/url]</b> </dt> +<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 <p> </dd> -<dt><b>--manpage [filename/wildcard]</b> </dt> +<dt><b>--manpage [filename/wildcard]</b></dt> <dd>produces man page of file, not suitable for all outputs. Alias -i <p> </dd> -<dt><b>-M [filename/wildcard/url]</b> </dt> +<dt><b>-M [filename/wildcard/url]</b></dt> <dd>see --maintenance <p> </dd> @@ -472,7 +475,7 @@ it is not). Also see --scp. Alias -R <dd>see --rsync <p> </dd> -<dt><b>-r [filename/wildcard]</b> </dt> +<dt><b>-r [filename/wildcard]</b></dt> <dd>see --scp <p> </dd> @@ -490,7 +493,7 @@ work directory which must be writable, (with screen instructions given that they be copied to the cgi-bin directory). Alias -F <p> </dd> -<dt><b>--scp [filename/wildcard]</b> </dt> +<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 @@ -559,9 +562,9 @@ file to output directory. Alias -s </dt> <dd>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 (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 +[ -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 <p> </dd> <dt><b>-T [filename/wildcard (*.termsheet.rb)]</b> </dt> @@ -572,7 +575,7 @@ are omitted), has footnotes at end of each paragraph that contains them <dd>see --txt <p> </dd> -<dt><b>--urls [filename/wildcard]</b> </dt> +<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 @@ -660,11 +663,11 @@ can be changed in the resource configuration files. [tip: the webric deep document structure, in the nature of dom. Alias -X <p> </dd> -<dt><b>--xml-sax [filename/wildcard]</b> </dt> +<dt><b>--xml-sax [filename/wildcard]</b></dt> <dd>produces XML output shallow structure (sax parsing). Alias -x <p> </dd> -<dt><b>-X [filename/wildcard]</b> </dt> +<dt><b>-X [filename/wildcard]</b></dt> <dd>see --xml-dom <p> </dd> @@ -2194,11 +2197,11 @@ documents under consideration, and occasionally supported have been. << |filename.ssi|@|^| </pre> <p> -<h2><a name='sect43' href='#toc43'>Markup Syntax History</a></h2> +<h2><a name='sect43' href='#toc43'>11. Markup Syntax History</a></h2> <br> <p> -<h2><a name='sect44' href='#toc44'>11. Notes Related to Files-types and Markup Syntax</a></h2> +<h2><a name='sect44' href='#toc44'>11.1 Notes Related to Files-types and Markup Syntax</a></h2> <br> <p> 2.0 introduced new headers and is therefore incompatible with 1.0 though @@ -2762,11 +2765,47 @@ Under consideration is to permit the placement of a CSS file with a different name in directory _sisu/css directory or equivalent, and change the default CSS file that is looked for in a skin.[^18] <p> -<h2><a name='sect65' href='#toc65'>17. Organising Content</a></h2> +<h2><a name='sect65' href='#toc65'>17. Organising Content - Directory Structure and Mapping</a></h2> <br> +<p> <br> +<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='sect66' href='#toc66'>17.1 Document Source Directory</a></h2> <p> -<h2><a name='sect66' href='#toc66'>17.1 Directory Structure and Mapping</a></h2> +<br> +The document source directory is the directory in which sisu processing +commands are given. It contains the sisu source files (.sst .ssm .ssi), or +(for sisu v3 may contain) subdirectories with language codes which contain +the sisu source files, so all English files would go in subdirectory en/, +French in fr/, Spanish in es/ and so on. ISO ... codes are usedr. 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='sect67' href='#toc67'>17.1.1 General Directories</a></h2> + +<p> <br> +<pre> ./subject_name/ + % files stored at this level e.g. sisu_manual.sst or + % for sisu v3 may be under language sub-directories + % e.g. + ./subject_name/en + ./subject_name/fr + ./subject_name/es + ./subject_name/_sisu + % configuration file e.g. sisurc.yml + ./subject_name/_sisu/skin + % skins in various skin directories doc, dir, site, yml + ./subject_name/_sisu/css + ./subject_name/_sisu/image +</pre> +<p> +<h2><a name='sect68' href='#toc68'>17.2 Document Output Directory Structures</a></h2> + +<p> +<h2><a name='sect69' href='#toc69'>17.2.1 Output Directory Root</a></h2> <p> <br> The output directory root can be set in the sisurc.yml file. Under the root, @@ -2793,7 +2832,103 @@ 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='sect67' href='#toc67'>18. Homepages</a></h2> +<h2><a name='sect70' href='#toc70'>17.2.2 Alternative Output Structures</a></h2> + +<p> <br> +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 & filetype, preferred?) + #output_dir_structure_by: filetype + #output_dir_structure_by: filename #(default, closest to original v1 +& v2) +</pre> +<p> +<h2><a name='sect71' href='#toc71'>17.2.3 by Language</a></h2> + +<p> <br> + +<p>The by language directory structure places output files +<p> <br> +The by language directory structure separates output files by language +code (all files of a given language), and within the language directory +by filetype. +<p> <br> + +<p>Its selection is configured in sisurc.yml +<p> <br> +output_dir_structure_by: language +<p> <br> +#by: language subject_dir/en/manifest/filename.html +<p> +<h2><a name='sect72' href='#toc72'>17.2.4 by Filetype</a></h2> + +<p> <br> +The by filetype directory structure separates output files by filetype, +all html files in one directory pdfs in another and so on. Filenames are +given a language extension. +<p> <br> + +<p>Its selection is configured in sisurc.yml +<p> <br> +output_dir_structure_by: filetype +<p> <br> +#by: filetype subject_dir/html/filename/manifest.en.html +<p> +<h2><a name='sect73' href='#toc73'>17.2.5 by Filename</a></h2> + +<p> +<br> +The by filename directory structure places most output of a particular +file (the different filetypes) in a common directory. +<p> <br> + +<p>Its selection is configured in sisurc.yml +<p> <br> +output_dir_structure_by: filename +<p> <br> +#by: filename subject_dir/filename/manifest.en.html +<p> +<h2><a name='sect74' href='#toc74'>17.2.6 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='sect75' href='#toc75'>17.2.7 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='sect76' href='#toc76'>17.3 Organising Content</a></h2> + +<p> +<h2><a name='sect77' href='#toc77'>18. Homepages</a></h2> <br> <p> <br> @@ -2813,7 +2948,7 @@ 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='sect68' href='#toc68'>18.1 Home Page and Other +<h2><a name='sect78' href='#toc78'>18.1 Home Page and Other Custom Built Pages in a Sub-directory</a></h2> <p> <br> @@ -2826,7 +2961,7 @@ command: sisu -CC<br> <p> -<h2><a name='sect69' href='#toc69'>18.2 Home Page Within a Skin</a></h2> +<h2><a name='sect79' href='#toc79'>18.2 Home Page Within a Skin</a></h2> <p> <br> Skins are described in a separate section, but basically are a file written @@ -2856,11 +2991,11 @@ index.html end </pre> <p> -<h2><a name='sect70' href='#toc70'>19. Markup and Output Examples</a></h2> +<h2><a name='sect80' href='#toc80'>19. Markup and Output Examples</a></h2> <br> <p> -<h2><a name='sect71' href='#toc71'>19.1 Markup Examples</a></h2> +<h2><a name='sect81' href='#toc81'>19.1 Markup Examples</a></h2> <p> <br> Current markup examples and document output samples are provided at <<a href='http://www.jus.uio.no/sisu/SiSU/examples.html'>http://www.jus.uio.no/sisu/SiSU/examples.html</a> @@ -2871,7 +3006,7 @@ 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'>20. Sisu Search - Introduction</a></h2> +<h2><a name='sect82' href='#toc82'>20. Sisu Search - Introduction</a></h2> <br> <p> <br> @@ -2891,11 +3026,11 @@ 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='sect73' href='#toc73'>21. Sql</a></h2> +<h2><a name='sect83' href='#toc83'>21. Sql</a></h2> <br> <p> -<h2><a name='sect74' href='#toc74'>21.1 Populating Sql Type Databases</a></h2> +<h2><a name='sect84' href='#toc84'>21.1 Populating Sql Type Databases</a></h2> <p> <br> <b>SiSU</b> feeds sisu markupd documents into sql type databases PostgreSQL[^19] @@ -2952,18 +3087,18 @@ database and have headings in which search content appears, or to search only headings etc. (as the Dublin Core is incorporated it is easy to make use of that as well). <p> -<h2><a name='sect75' href='#toc75'>22. Postgresql</a></h2> +<h2><a name='sect85' href='#toc85'>22. Postgresql</a></h2> <br> <p> -<h2><a name='sect76' href='#toc76'>22.1 Name</a></h2> +<h2><a name='sect86' href='#toc86'>22.1 Name</a></h2> <p> <br> <b>SiSU</b> - Structured information, Serialized Units - a document publishing system, <p>postgresql dependency package <p> -<h2><a name='sect77' href='#toc77'>22.2 Description</a></h2> +<h2><a name='sect87' href='#toc87'>22.2 Description</a></h2> <p> <br> Information related to using postgresql with sisu (and related to the sisu_postgresql @@ -2971,7 +3106,7 @@ 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='sect78' href='#toc78'>22.3 Synopsis</a></h2> +<h2><a name='sect88' href='#toc88'>22.3 Synopsis</a></h2> <p> <br> sisu -D [instruction] [filename/wildcard if required]<br> @@ -2980,7 +3115,7 @@ sisu). sisu -D --pg --[instruction] [filename/wildcard if required]<br> <p> -<h2><a name='sect79' href='#toc79'>22.4 Commands</a></h2> +<h2><a name='sect89' href='#toc89'>22.4 Commands</a></h2> <p> <br> Mappings to two databases are provided by default, postgresql and sqlite, @@ -2991,7 +3126,7 @@ however -d (lowercase) denotes sqlite and -D (uppercase) denotes postgresql, <p> <br> <b>-D or --pgsql</b> may be used interchangeably. <p> -<h2><a name='sect80' href='#toc80'>22.4.1 Create and Destroy Database</a></h2> +<h2><a name='sect90' href='#toc90'>22.4.1 Create and Destroy Database</a></h2> <p> @@ -3028,7 +3163,7 @@ of the same name). <p> </dd> </dl> -<h2><a name='sect81' href='#toc81'>22.4.2 Import and Remove Documents</a></h2> +<h2><a name='sect91' href='#toc91'>22.4.2 Import and Remove Documents</a></h2> <p> <dl> @@ -3051,17 +3186,17 @@ database. <p> </dd> </dl> -<h2><a name='sect82' href='#toc82'>23. Sqlite</a></h2> +<h2><a name='sect92' href='#toc92'>23. Sqlite</a></h2> <br> <p> -<h2><a name='sect83' href='#toc83'>23.1 Name</a></h2> +<h2><a name='sect93' href='#toc93'>23.1 Name</a></h2> <p> <br> <b>SiSU</b> - Structured information, Serialized Units - a document publishing system. <p> -<h2><a name='sect84' href='#toc84'>23.2 Description</a></h2> +<h2><a name='sect94' href='#toc94'>23.2 Description</a></h2> <p> <br> Information related to using sqlite with sisu (and related to the sisu_sqlite @@ -3069,7 +3204,7 @@ 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='sect85' href='#toc85'>23.3 Synopsis</a></h2> +<h2><a name='sect95' href='#toc95'>23.3 Synopsis</a></h2> <p> <br> sisu -d [instruction] [filename/wildcard if required]<br> @@ -3079,7 +3214,7 @@ for <b>SiSU</b> to populate an sqlite database, this being part of <b>SiSU</b> - required]<br> <p> -<h2><a name='sect86' href='#toc86'>23.4 Commands</a></h2> +<h2><a name='sect96' href='#toc96'>23.4 Commands</a></h2> <p> <br> Mappings to two databases are provided by default, postgresql and sqlite, @@ -3090,7 +3225,7 @@ however -d (lowercase) denotes sqlite and -D (uppercase) denotes postgresql, <p> <br> <b>-d or --sqlite</b> may be used interchangeably. <p> -<h2><a name='sect87' href='#toc87'>23.4.1 Create and Destroy Database</a></h2> +<h2><a name='sect97' href='#toc97'>23.4.1 Create and Destroy Database</a></h2> <p> @@ -3127,7 +3262,7 @@ of the same name). <p> </dd> </dl> -<h2><a name='sect88' href='#toc88'>23.4.2 Import and Remove Documents</a></h2> +<h2><a name='sect98' href='#toc98'>23.4.2 Import and Remove Documents</a></h2> <p> <dl> @@ -3150,11 +3285,11 @@ database. <p> </dd> </dl> -<h2><a name='sect89' href='#toc89'>24. Introduction</a></h2> +<h2><a name='sect99' href='#toc99'>24. Introduction</a></h2> <br> <p> -<h2><a name='sect90' href='#toc90'>24.1 Search - Database Frontend Sample, Utilising Database and Sisu Features,</a></h2> +<h2><a name='sect100' href='#toc100'>24.1 Search - Database Frontend Sample, Utilising Database and Sisu Features,</a></h2> INCLUDING OBJECT CITATION NUMBERING (BACKEND CURRENTLY POSTGRESQL) <p> <br> @@ -3209,7 +3344,7 @@ SiSU_ebook is used. [otherwise a manual mapping for &nbs <p> </dd> </dl> -<h2><a name='sect91' href='#toc91'>24.2 +<h2><a name='sect101' href='#toc101'>24.2 Search Form</a></h2> <p> @@ -3246,17 +3381,17 @@ search form for use with the webrick server, which must be copied to the <p> </dd> </dl> -<h2><a name='sect92' href='#toc92'>25. Sisu_webrick</a></h2> +<h2><a name='sect102' href='#toc102'>25. Sisu_webrick</a></h2> <br> <p> -<h2><a name='sect93' href='#toc93'>25.1 Name</a></h2> +<h2><a name='sect103' href='#toc103'>25.1 Name</a></h2> <p> <br> <b>SiSU</b> - Structured information, Serialized Units - a document publishing system <p> -<h2><a name='sect94' href='#toc94'>25.2 Synopsis</a></h2> +<h2><a name='sect104' href='#toc104'>25.2 Synopsis</a></h2> <p> <br> sisu_webrick [port] @@ -3266,7 +3401,7 @@ sisu_webrick [port] <p> <br> sisu -W [port] <p> -<h2><a name='sect95' href='#toc95'>25.3 Description</a></h2> +<h2><a name='sect105' href='#toc105'>25.3 Description</a></h2> <p> <br> sisu_webrick is part of <b>SiSU</b> (man sisu) sisu_webrick starts <b>Ruby</b> <b>SiSU</b> @@ -3277,7 +3412,7 @@ 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='sect96' href='#toc96'>25.4 Summary of Man Page</a></h2> +<h2><a name='sect106' href='#toc106'>25.4 Summary of Man Page</a></h2> <p> <br> @@ -3288,7 +3423,7 @@ sisu_webrick, may be started on it’s own with the command: sisu_webrick <p>where no port is given and settings are unchanged the default port is 8081 <p> -<h2><a name='sect97' href='#toc97'>25.5 Document Processing Command Flags</a></h2> +<h2><a name='sect107' href='#toc107'>25.5 Document Processing Command Flags</a></h2> <p> <br> sisu -W [port] starts <b>Ruby</b> Webrick web-server, serving <b>SiSU</b> output directories, @@ -3296,7 +3431,7 @@ on the port provided, or if no port is provided and the defaults have not <p>been changed in ~/.sisu/sisurc.yaml then on port 8081 <p> -<h2><a name='sect98' href='#toc98'>25.6 Further Information</a></h2> +<h2><a name='sect108' href='#toc108'>25.6 Further Information</a></h2> <p> <br> @@ -3308,12 +3443,12 @@ For more information on <b>SiSU</b> see: <<a href='http://www.sisudoc.org/'>h <p>or man sisu <p> -<h2><a name='sect99' href='#toc99'>25.7 Author</a></h2> +<h2><a name='sect109' href='#toc109'>25.7 Author</a></h2> <p> <br> Ralph Amissah <ralph@amissah.com> or <ralph.amissah@gmail.com> <p> -<h2><a name='sect100' href='#toc100'>25.8 See Also</a></h2> +<h2><a name='sect110' href='#toc110'>25.8 See Also</a></h2> <p> <br> <a href='http:~/bin/man2html?sisu:1'>sisu(1)</a> @@ -3324,7 +3459,7 @@ Ralph Amissah <ralph@amissah.com> or <ralph.amissah@gmail.com> <br> <p> -<h2><a name='sect101' href='#toc101'>26. Remote Source Documents</a></h2> +<h2><a name='sect111' href='#toc111'>26. Remote Source Documents</a></h2> <br> <p> <br> @@ -3371,11 +3506,11 @@ way, see <<a href='http://www.jus.uio.no/sisu/SiSU/examples.html'>http://www. > and use the url for the desired document. <p> -<h2><a name='sect102' href='#toc102'>Remote Document Output</a></h2> +<h2><a name='sect112' href='#toc112'>Remote Document Output</a></h2> <br> <p> -<h2><a name='sect103' href='#toc103'>27. Remote Output</a></h2> +<h2><a name='sect113' href='#toc113'>27. Remote Output</a></h2> <br> <p> <br> @@ -3390,7 +3525,7 @@ which may be used in conjunction with other processing flags, e.g. <pre> sisu -3R sisu_remote.sst </pre> <p> -<h2><a name='sect104' href='#toc104'>27.1 Commands</a></h2> +<h2><a name='sect114' href='#toc114'>27.1 Commands</a></h2> <p> <dl> @@ -3413,12 +3548,12 @@ ssh agent in place. Also see -R <p> </dd> </dl> -<h2><a name='sect105' href='#toc105'>27.2 Configuration</a></h2> +<h2><a name='sect115' href='#toc115'>27.2 Configuration</a></h2> <p> <br> [expand on the setting up of an ssh-agent / keychain] <p> -<h2><a name='sect106' href='#toc106'>28. Remote Servers</a></h2> +<h2><a name='sect116' href='#toc116'>28. Remote Servers</a></h2> <br> <p> <br> @@ -3428,18 +3563,18 @@ easily be on a remote server, to which you are logged on using a terminal, and commands and operations would be pretty much the same as they would be on your local machine. <p> -<h2><a name='sect107' href='#toc107'>29. Quickstart - Getting Started Howto</a></h2> +<h2><a name='sect117' href='#toc117'>29. Quickstart - Getting Started Howto</a></h2> <br> <p> -<h2><a name='sect108' href='#toc108'>29.1 Installation</a></h2> +<h2><a name='sect118' href='#toc118'>29.1 Installation</a></h2> <p> <br> Installation is currently most straightforward and tested on the <b>Debian</b> platform, as there are packages for the installation of sisu and all requirements for what it does. <p> -<h2><a name='sect109' href='#toc109'>29.1.1 Debian Installation</a></h2> +<h2><a name='sect119' href='#toc119'>29.1.1 Debian Installation</a></h2> <p> <br> <b>SiSU</b> is available directly from the <b>Debian</b> Sid and testing archives (and @@ -3489,7 +3624,7 @@ Note however that it is not necessary to install sisu-complete if not all components of sisu are to be used. Installing just the package sisu will provide basic functionality. <p> -<h2><a name='sect110' href='#toc110'>29.1.2 Rpm Installation</a></h2> +<h2><a name='sect120' href='#toc120'>29.1.2 Rpm Installation</a></h2> <p> <br> RPMs are provided though untested, they are prepared by running alien against @@ -3506,7 +3641,7 @@ as root type: rpm -i [rpm package name]<br> <p> -<h2><a name='sect111' href='#toc111'>29.1.3 Installation from Source</a></h2> +<h2><a name='sect121' href='#toc121'>29.1.3 Installation from Source</a></h2> <p> <br> To install <b>SiSU</b> from source check information at: @@ -3597,7 +3732,7 @@ For a list of alternative actions you may type: ruby install -T<br> <p> -<h2><a name='sect112' href='#toc112'>29.2 Testing Sisu, Generating Output</a></h2> +<h2><a name='sect122' href='#toc122'>29.2 Testing Sisu, Generating Output</a></h2> <p> <br> To check which version of sisu is installed: @@ -3620,7 +3755,7 @@ change directory to the appropriate one: <p>cd /usr/share/doc/sisu/markup-samples/samples <p> -<h2><a name='sect113' href='#toc113'>29.2.1 Basic Text, Plaintext, +<h2><a name='sect123' href='#toc123'>29.2.1 Basic Text, Plaintext, Html, Xml, Odf, Epub</a></h2> <p> <br> @@ -3635,7 +3770,7 @@ this will generate html including a concordance file, opendocument text format, plaintext, XHTML and various forms of XML, and OpenDocument text <p> -<h2><a name='sect114' href='#toc114'>29.2.2 LaTeX / Pdf</a></h2> +<h2><a name='sect124' href='#toc124'>29.2.2 LaTeX / Pdf</a></h2> <p> <br> Assuming a LaTeX engine such as tetex or texlive is installed with the @@ -3656,7 +3791,7 @@ file, opendocument text format, plaintext, XHTML and various forms of XML, <p>and OpenDocument text and pdf <p> -<h2><a name='sect115' href='#toc115'>29.2.3 Relational Database - Postgresql, Sqlite</a></h2> +<h2><a name='sect125' href='#toc125'>29.2.3 Relational Database - Postgresql, Sqlite</a></h2> <p> <br> @@ -3681,10 +3816,10 @@ create the database and write to it when you run sisu. <p>sisu --pgsql -v --import free_as_in_freedom.rms_and_free_software.sam_williams.sst <p> -<h2><a name='sect116' href='#toc116'>29.3 Getting Help</a></h2> +<h2><a name='sect126' href='#toc126'>29.3 Getting Help</a></h2> <p> -<h2><a name='sect117' href='#toc117'>29.3.1 the Man Pages</a></h2> +<h2><a name='sect127' href='#toc127'>29.3.1 the Man Pages</a></h2> <p> <br> Type: @@ -3704,7 +3839,7 @@ date as within the package itself: * man directory <<a href='http://www.jus.uio.no/sisu/man'>http://www.jus.uio.no/sisu/man</a> > [^27] <p> -<h2><a name='sect118' href='#toc118'>29.3.2 Built in Help</a></h2> +<h2><a name='sect128' href='#toc128'>29.3.2 Built in Help</a></h2> <p> <br> @@ -3719,7 +3854,7 @@ date as within the package itself: <p>sisu --help --markup <p> -<h2><a name='sect119' href='#toc119'>29.3.3 the Home Page</a></h2> +<h2><a name='sect129' href='#toc129'>29.3.3 the Home Page</a></h2> <p> <br> <<a href='http://www.sisudoc.org/'>http://www.sisudoc.org/</a> @@ -3731,7 +3866,7 @@ date as within the package itself: <<a href='http://www.jus.uio.no/sisu/SiSU'>http://www.jus.uio.no/sisu/SiSU</a> > <p> -<h2><a name='sect120' href='#toc120'>29.4 Markup Samples</a></h2> +<h2><a name='sect130' href='#toc130'>29.4 Markup Samples</a></h2> <p> <br> A number of markup samples (along with output) are available off: @@ -3747,7 +3882,7 @@ On <b>Debian</b> they are available in non-free[^28] to include them it is neces to include non-free in your /etc/apt/source.list or obtain them from the sisu home site. <p> -<h2><a name='sect121' href='#toc121'>30. Editor Files, Syntax Highlighting</a></h2> +<h2><a name='sect131' href='#toc131'>30. Editor Files, Syntax Highlighting</a></h2> <br> <p> <br> @@ -3920,7 +4055,7 @@ NOTE: (without line-breaks) is a convenient editor feature to have for sisu markup] <p> -<h2><a name='sect122' href='#toc122'>31. How Does Sisu Work?</a></h2> +<h2><a name='sect132' href='#toc132'>31. How Does Sisu Work?</a></h2> <br> <p> <br> @@ -3942,7 +4077,7 @@ layout, publishing, content certification, concordance etc.), and makes it possible to take advantage of some of the strengths of established ways of representing documents, (or indeed to create new ones). <p> -<h2><a name='sect123' href='#toc123'>32. Summary of +<h2><a name='sect133' href='#toc133'>32. Summary of Features</a></h2> <br> @@ -4086,11 +4221,11 @@ 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> -<h2><a name='sect124' href='#toc124'>33. Help Sources</a></h2> +<h2><a name='sect134' href='#toc134'>33. Help Sources</a></h2> <br> <p> -<h2><a name='sect125' href='#toc125'>33.1 Man Pages</a></h2> +<h2><a name='sect135' href='#toc135'>33.1 Man Pages</a></h2> <p> <br> man sisu<br> @@ -4147,14 +4282,14 @@ to form a document. man sisu_webrick<br> <p> -<h2><a name='sect126' href='#toc126'>33.2 Sisu Generated Output - Links to HTML</a></h2> +<h2><a name='sect136' href='#toc136'>33.2 Sisu Generated Output - Links to HTML</a></h2> <p> <br> Note <b>SiSU</b> documentation is prepared in <b>SiSU</b> and output is available in multiple formats including amongst others html, pdf, odf and epub, which may be also be accessed via the html pages[^29] <p> -<h2><a name='sect127' href='#toc127'>33.2.1 Www.sisudoc.org</a></h2> +<h2><a name='sect137' href='#toc137'>33.2.1 Www.sisudoc.org</a></h2> <p> <br> <<a href='http://sisudoc.org/sisu/sisu_manual/index.html'>http://sisudoc.org/sisu/sisu_manual/index.html</a> @@ -4164,10 +4299,10 @@ may be also be accessed via the html pages[^29] ><br> <p> -<h2><a name='sect128' href='#toc128'>33.3 Man2html</a></h2> +<h2><a name='sect138' href='#toc138'>33.3 Man2html</a></h2> <p> -<h2><a name='sect129' href='#toc129'>33.3.1 Locally Installed</a></h2> +<h2><a name='sect139' href='#toc139'>33.3.1 Locally Installed</a></h2> <p> <br> @@ -4188,7 +4323,7 @@ may be also be accessed via the html pages[^29] /usr/share/doc/sisu/html/sisu_webrick.1.html<br> <p> -<h2><a name='sect130' href='#toc130'>33.3.2 Www.jus.uio.no/Sisu</a></h2> +<h2><a name='sect140' href='#toc140'>33.3.2 Www.jus.uio.no/Sisu</a></h2> <p> <br> <<a href='http://www.jus.uio.no/sisu/man/sisu.1.html'>http://www.jus.uio.no/sisu/man/sisu.1.html</a> @@ -4365,7 +4500,7 @@ while freely distributable are not freely changeable. <p> </li> </ol> -<h2><a name='sect131' href='#toc131'>See Also</a></h2> +<h2><a name='sect141' href='#toc141'>See Also</a></h2> <br> <a href='http:~/bin/man2html?sisu:1'><i>sisu</i>(1)</a> , <br> @@ -4388,14 +4523,14 @@ while freely distributable are not freely changeable. <a href='http:~/bin/man2html?sisu_vim:7'><i>sisu_vim</i>(7)</a> <p> -<h2><a name='sect132' href='#toc132'>Homepage</a></h2> +<h2><a name='sect142' href='#toc142'>Homepage</a></h2> <br> More information about <b>SiSU</b> can be found at <<a href='http://www.sisudoc.org/'><i>http://www.sisudoc.org/</i></a> > or <<a href='http://www.jus.uio.no/sisu/'><i>http://www.jus.uio.no/sisu/</i></a> >. <p> -<h2><a name='sect133' href='#toc133'>Author</a></h2> +<h2><a name='sect143' href='#toc143'>Author</a></h2> <b>SiSU</b> is written by Ralph Amissah <<i>ralph@amissah.com</i>>. <p> <hr><p> @@ -4444,8 +4579,8 @@ More information about <b>SiSU</b> can be found at <<a href='http://www.sisud <li><a name='toc40' href='#sect40'>9.8.2 Page Breaks</a></li> <li><a name='toc41' href='#sect41'>9.9 Book Index</a></li> <li><a name='toc42' href='#sect42'>10. Composite Documents Markup</a></li> -<li><a name='toc43' href='#sect43'>Markup Syntax History</a></li> -<li><a name='toc44' href='#sect44'>11. Notes Related to Files-types and Markup Syntax</a></li> +<li><a name='toc43' href='#sect43'>11. Markup Syntax History</a></li> +<li><a name='toc44' href='#sect44'>11.1 Notes Related to Files-types and Markup Syntax</a></li> <li><a name='toc45' href='#sect45'>12. Sisu Filetypes</a></li> <li><a name='toc46' href='#sect46'>12.1 .sst .ssm .ssi Marked Up Plain Text</a></li> <li><a name='toc47' href='#sect47'>12.1.1 Sisu Text - Regular Files (.sst)</a></li> @@ -4466,75 +4601,85 @@ More information about <b>SiSU</b> can be found at <<a href='http://www.sisud <li><a name='toc62' href='#sect62'>15.3 Site Skin</a></li> <li><a name='toc63' href='#sect63'>15.4 Sample Skins</a></li> <li><a name='toc64' href='#sect64'>16. Css - Cascading Style Sheets (for Html, Xhtml and Xml)</a></li> -<li><a name='toc65' href='#sect65'>17. Organising Content</a></li> -<li><a name='toc66' href='#sect66'>17.1 Directory Structure and Mapping</a></li> -<li><a name='toc67' href='#sect67'>18. Homepages</a></li> -<li><a name='toc68' href='#sect68'>18.1 Home Page and Other Custom Built Pages in a Sub-directory</a></li> -<li><a name='toc69' href='#sect69'>18.2 Home Page Within a Skin</a></li> -<li><a name='toc70' href='#sect70'>19. Markup and Output Examples</a></li> -<li><a name='toc71' href='#sect71'>19.1 Markup Examples</a></li> -<li><a name='toc72' href='#sect72'>20. Sisu Search - Introduction</a></li> -<li><a name='toc73' href='#sect73'>21. Sql</a></li> -<li><a name='toc74' href='#sect74'>21.1 Populating Sql Type Databases</a></li> -<li><a name='toc75' href='#sect75'>22. Postgresql</a></li> -<li><a name='toc76' href='#sect76'>22.1 Name</a></li> -<li><a name='toc77' href='#sect77'>22.2 Description</a></li> -<li><a name='toc78' href='#sect78'>22.3 Synopsis</a></li> -<li><a name='toc79' href='#sect79'>22.4 Commands</a></li> -<li><a name='toc80' href='#sect80'>22.4.1 Create and Destroy Database</a></li> -<li><a name='toc81' href='#sect81'>22.4.2 Import and Remove Documents</a></li> -<li><a name='toc82' href='#sect82'>23. Sqlite</a></li> -<li><a name='toc83' href='#sect83'>23.1 Name</a></li> -<li><a name='toc84' href='#sect84'>23.2 Description</a></li> -<li><a name='toc85' href='#sect85'>23.3 Synopsis</a></li> -<li><a name='toc86' href='#sect86'>23.4 Commands</a></li> -<li><a name='toc87' href='#sect87'>23.4.1 Create and Destroy Database</a></li> -<li><a name='toc88' href='#sect88'>23.4.2 Import and Remove Documents</a></li> -<li><a name='toc89' href='#sect89'>24. Introduction</a></li> -<li><a name='toc90' href='#sect90'>24.1 Search - Database Frontend Sample, Utilising Database and Sisu Features,</a></li> -<li><a name='toc91' href='#sect91'>24.2 Search Form</a></li> -<li><a name='toc92' href='#sect92'>25. Sisu_webrick</a></li> -<li><a name='toc93' href='#sect93'>25.1 Name</a></li> -<li><a name='toc94' href='#sect94'>25.2 Synopsis</a></li> -<li><a name='toc95' href='#sect95'>25.3 Description</a></li> -<li><a name='toc96' href='#sect96'>25.4 Summary of Man Page</a></li> -<li><a name='toc97' href='#sect97'>25.5 Document Processing Command Flags</a></li> -<li><a name='toc98' href='#sect98'>25.6 Further Information</a></li> -<li><a name='toc99' href='#sect99'>25.7 Author</a></li> -<li><a name='toc100' href='#sect100'>25.8 See Also</a></li> -<li><a name='toc101' href='#sect101'>26. Remote Source Documents</a></li> -<li><a name='toc102' href='#sect102'>Remote Document Output</a></li> -<li><a name='toc103' href='#sect103'>27. Remote Output</a></li> -<li><a name='toc104' href='#sect104'>27.1 Commands</a></li> -<li><a name='toc105' href='#sect105'>27.2 Configuration</a></li> -<li><a name='toc106' href='#sect106'>28. Remote Servers</a></li> -<li><a name='toc107' href='#sect107'>29. Quickstart - Getting Started Howto</a></li> -<li><a name='toc108' href='#sect108'>29.1 Installation</a></li> -<li><a name='toc109' href='#sect109'>29.1.1 Debian Installation</a></li> -<li><a name='toc110' href='#sect110'>29.1.2 Rpm Installation</a></li> -<li><a name='toc111' href='#sect111'>29.1.3 Installation from Source</a></li> -<li><a name='toc112' href='#sect112'>29.2 Testing Sisu, Generating Output</a></li> -<li><a name='toc113' href='#sect113'>29.2.1 Basic Text, Plaintext, Html, Xml, Odf, Epub</a></li> -<li><a name='toc114' href='#sect114'>29.2.2 LaTeX / Pdf</a></li> -<li><a name='toc115' href='#sect115'>29.2.3 Relational Database - Postgresql, Sqlite</a></li> -<li><a name='toc116' href='#sect116'>29.3 Getting Help</a></li> -<li><a name='toc117' href='#sect117'>29.3.1 the Man Pages</a></li> -<li><a name='toc118' href='#sect118'>29.3.2 Built in Help</a></li> -<li><a name='toc119' href='#sect119'>29.3.3 the Home Page</a></li> -<li><a name='toc120' href='#sect120'>29.4 Markup Samples</a></li> -<li><a name='toc121' href='#sect121'>30. Editor Files, Syntax Highlighting</a></li> -<li><a name='toc122' href='#sect122'>31. How Does Sisu Work?</a></li> -<li><a name='toc123' href='#sect123'>32. Summary of Features</a></li> -<li><a name='toc124' href='#sect124'>33. Help Sources</a></li> -<li><a name='toc125' href='#sect125'>33.1 Man Pages</a></li> -<li><a name='toc126' href='#sect126'>33.2 Sisu Generated Output - Links to HTML</a></li> -<li><a name='toc127' href='#sect127'>33.2.1 Www.sisudoc.org</a></li> -<li><a name='toc128' href='#sect128'>33.3 Man2html</a></li> -<li><a name='toc129' href='#sect129'>33.3.1 Locally Installed</a></li> -<li><a name='toc130' href='#sect130'>33.3.2 Www.jus.uio.no/Sisu</a></li> -<li><a name='toc131' href='#sect131'>See Also</a></li> -<li><a name='toc132' href='#sect132'>Homepage</a></li> -<li><a name='toc133' href='#sect133'>Author</a></li> +<li><a name='toc65' href='#sect65'>17. Organising Content - Directory Structure and Mapping</a></li> +<li><a name='toc66' href='#sect66'>17.1 Document Source Directory</a></li> +<li><a name='toc67' href='#sect67'>17.1.1 General Directories</a></li> +<li><a name='toc68' href='#sect68'>17.2 Document Output Directory Structures</a></li> +<li><a name='toc69' href='#sect69'>17.2.1 Output Directory Root</a></li> +<li><a name='toc70' href='#sect70'>17.2.2 Alternative Output Structures</a></li> +<li><a name='toc71' href='#sect71'>17.2.3 by Language</a></li> +<li><a name='toc72' href='#sect72'>17.2.4 by Filetype</a></li> +<li><a name='toc73' href='#sect73'>17.2.5 by Filename</a></li> +<li><a name='toc74' href='#sect74'>17.2.6 Remote Directories</a></li> +<li><a name='toc75' href='#sect75'>17.2.7 Sisupod</a></li> +<li><a name='toc76' href='#sect76'>17.3 Organising Content</a></li> +<li><a name='toc77' href='#sect77'>18. Homepages</a></li> +<li><a name='toc78' href='#sect78'>18.1 Home Page and Other Custom Built Pages in a Sub-directory</a></li> +<li><a name='toc79' href='#sect79'>18.2 Home Page Within a Skin</a></li> +<li><a name='toc80' href='#sect80'>19. Markup and Output Examples</a></li> +<li><a name='toc81' href='#sect81'>19.1 Markup Examples</a></li> +<li><a name='toc82' href='#sect82'>20. Sisu Search - Introduction</a></li> +<li><a name='toc83' href='#sect83'>21. Sql</a></li> +<li><a name='toc84' href='#sect84'>21.1 Populating Sql Type Databases</a></li> +<li><a name='toc85' href='#sect85'>22. Postgresql</a></li> +<li><a name='toc86' href='#sect86'>22.1 Name</a></li> +<li><a name='toc87' href='#sect87'>22.2 Description</a></li> +<li><a name='toc88' href='#sect88'>22.3 Synopsis</a></li> +<li><a name='toc89' href='#sect89'>22.4 Commands</a></li> +<li><a name='toc90' href='#sect90'>22.4.1 Create and Destroy Database</a></li> +<li><a name='toc91' href='#sect91'>22.4.2 Import and Remove Documents</a></li> +<li><a name='toc92' href='#sect92'>23. Sqlite</a></li> +<li><a name='toc93' href='#sect93'>23.1 Name</a></li> +<li><a name='toc94' href='#sect94'>23.2 Description</a></li> +<li><a name='toc95' href='#sect95'>23.3 Synopsis</a></li> +<li><a name='toc96' href='#sect96'>23.4 Commands</a></li> +<li><a name='toc97' href='#sect97'>23.4.1 Create and Destroy Database</a></li> +<li><a name='toc98' href='#sect98'>23.4.2 Import and Remove Documents</a></li> +<li><a name='toc99' href='#sect99'>24. Introduction</a></li> +<li><a name='toc100' href='#sect100'>24.1 Search - Database Frontend Sample, Utilising Database and Sisu Features,</a></li> +<li><a name='toc101' href='#sect101'>24.2 Search Form</a></li> +<li><a name='toc102' href='#sect102'>25. Sisu_webrick</a></li> +<li><a name='toc103' href='#sect103'>25.1 Name</a></li> +<li><a name='toc104' href='#sect104'>25.2 Synopsis</a></li> +<li><a name='toc105' href='#sect105'>25.3 Description</a></li> +<li><a name='toc106' href='#sect106'>25.4 Summary of Man Page</a></li> +<li><a name='toc107' href='#sect107'>25.5 Document Processing Command Flags</a></li> +<li><a name='toc108' href='#sect108'>25.6 Further Information</a></li> +<li><a name='toc109' href='#sect109'>25.7 Author</a></li> +<li><a name='toc110' href='#sect110'>25.8 See Also</a></li> +<li><a name='toc111' href='#sect111'>26. Remote Source Documents</a></li> +<li><a name='toc112' href='#sect112'>Remote Document Output</a></li> +<li><a name='toc113' href='#sect113'>27. Remote Output</a></li> +<li><a name='toc114' href='#sect114'>27.1 Commands</a></li> +<li><a name='toc115' href='#sect115'>27.2 Configuration</a></li> +<li><a name='toc116' href='#sect116'>28. Remote Servers</a></li> +<li><a name='toc117' href='#sect117'>29. Quickstart - Getting Started Howto</a></li> +<li><a name='toc118' href='#sect118'>29.1 Installation</a></li> +<li><a name='toc119' href='#sect119'>29.1.1 Debian Installation</a></li> +<li><a name='toc120' href='#sect120'>29.1.2 Rpm Installation</a></li> +<li><a name='toc121' href='#sect121'>29.1.3 Installation from Source</a></li> +<li><a name='toc122' href='#sect122'>29.2 Testing Sisu, Generating Output</a></li> +<li><a name='toc123' href='#sect123'>29.2.1 Basic Text, Plaintext, Html, Xml, Odf, Epub</a></li> +<li><a name='toc124' href='#sect124'>29.2.2 LaTeX / Pdf</a></li> +<li><a name='toc125' href='#sect125'>29.2.3 Relational Database - Postgresql, Sqlite</a></li> +<li><a name='toc126' href='#sect126'>29.3 Getting Help</a></li> +<li><a name='toc127' href='#sect127'>29.3.1 the Man Pages</a></li> +<li><a name='toc128' href='#sect128'>29.3.2 Built in Help</a></li> +<li><a name='toc129' href='#sect129'>29.3.3 the Home Page</a></li> +<li><a name='toc130' href='#sect130'>29.4 Markup Samples</a></li> +<li><a name='toc131' href='#sect131'>30. Editor Files, Syntax Highlighting</a></li> +<li><a name='toc132' href='#sect132'>31. How Does Sisu Work?</a></li> +<li><a name='toc133' href='#sect133'>32. Summary of Features</a></li> +<li><a name='toc134' href='#sect134'>33. Help Sources</a></li> +<li><a name='toc135' href='#sect135'>33.1 Man Pages</a></li> +<li><a name='toc136' href='#sect136'>33.2 Sisu Generated Output - Links to HTML</a></li> +<li><a name='toc137' href='#sect137'>33.2.1 Www.sisudoc.org</a></li> +<li><a name='toc138' href='#sect138'>33.3 Man2html</a></li> +<li><a name='toc139' href='#sect139'>33.3.1 Locally Installed</a></li> +<li><a name='toc140' href='#sect140'>33.3.2 Www.jus.uio.no/Sisu</a></li> +<li><a name='toc141' href='#sect141'>See Also</a></li> +<li><a name='toc142' href='#sect142'>Homepage</a></li> +<li><a name='toc143' href='#sect143'>Author</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 index 35ab209f..d4f2b698 100644 --- a/data/doc/sisu/html/sisu_termsheet.1.html +++ b/data/doc/sisu/html/sisu_termsheet.1.html @@ -52,8 +52,8 @@ or <i><ralph.amissah@gmail.com></i> More information about <b>SiSU</b> can be found at <<a href='http://www.sisudoc.org/'><i>http://www.sisudoc.org/</i></a> > or <<a href='http://www.jus.uio.no/sisu/'><i>http://www.jus.uio.no/sisu/</i></a> ->. -<p> +>. +<p> <h2><a name='sect9' href='#toc9'>Author</a></h2> <b>SiSU</b> is written by Ralph Amissah <<i>ralph@amissah.com</i>>. <p> diff --git a/data/doc/sisu/html/sisu_webrick.1.html b/data/doc/sisu/html/sisu_webrick.1.html index 6b99d01e..c1efc98d 100644 --- a/data/doc/sisu/html/sisu_webrick.1.html +++ b/data/doc/sisu/html/sisu_webrick.1.html @@ -75,8 +75,8 @@ directories, on the port provided, or if no port is provided and the defaults More information about <b>SiSU</b> can be found at <<a href='http://www.sisudoc.org/'><i>http://www.sisudoc.org/</i></a> > or <<a href='http://www.jus.uio.no/sisu/'><i>http://www.jus.uio.no/sisu/</i></a> ->. -<p> +>. +<p> <h2><a name='sect3' href='#toc3'>Author</a></h2> <b>SiSU</b> is written by Ralph Amissah <<i>ralph@amissah.com</i>>. <p> diff --git a/data/doc/sisu/markup-samples/sisu_manual/_sisu/v3/sisurc.yml b/data/doc/sisu/markup-samples/sisu_manual/_sisu/v3/sisurc.yml index ed452402..3ef1a6db 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/_sisu/v3/sisurc.yml +++ b/data/doc/sisu/markup-samples/sisu_manual/_sisu/v3/sisurc.yml @@ -49,12 +49,12 @@ show_output_on: 'filesystem_url' #% flag - set (non-default) processing flag shortcuts -1, -2 etc. (here adding colour and verbosity as default) flag: color: true # making colour default -c is toggle, and will now toggle colour off - default: '-NhewpotbxXyYv' # -m run by default; includes verbose - i: '-Nhewpoty' # -m run by default - ii: '-NhewpotbxX' # -m run by default - iii: '-NhewpotbxXY' # -m run by default - iv: '-NhewpotbxXiIY' # -m run by default - v: '-NhewpotbxXYDv --update' # -m run by default; includes verbose +# default: '-NhewpotbxXyYv' # -m run by default; includes verbose +# i: '-Nhewpoty' # -m run by default +# ii: '-NhewpotbxX' # -m run by default +# iii: '-NhewpotbxXY' # -m run by default +# iv: '-NhewpotbxXiIY' # -m run by default +# v: '-NhewpotbxXYDv --update' # -m run by default; includes verbose #% papersize, (LaTeX/pdf) current values A4, US_letter, book_b5, book_a5, US_legal, easily extensible default: diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu.ssm b/data/doc/sisu/markup-samples/sisu_manual/sisu.ssm index 89d8556a..aed55649 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu.ssm +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu.ssm @@ -5,7 +5,7 @@ @creator: :author: Amissah, Ralph -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 +@rights: Copyright (C) Ralph Amissah 2011, part of SiSU documentation, License GPL 3 @classify: :type: information @@ -19,14 +19,14 @@ :created: 2002-08-28 :issued: 2002-08-28 :available: 2002-08-28 - :modified: 2011-03-09 + :modified: 2011-09-18 @make: :num_top: 1 :breaks: new=C; break=1 :skin: skin_sisu_manual :bold: /Gnu|Debian|Ruby|SiSU/ - :manpage: name=sisu - documents: markup, structuring, publishing in multiple standard formats, and search; synopsis=sisu [-abcDdFehIiMmNnopqRrSsTtUuVvwXxYyZz0-9] [filename/wildcard] . sisu [-Ddcv] [instruction] [filename/wildcard] . sisu [-CcFLSVvW] . sisu --v2 [operations] . sisu --v3 [operations] . sisu3 [operations] + :manpage: name=sisu - documents: markup, structuring, publishing in multiple standard formats, and search; synopsis=sisu [-abCcDdeFGghIikLMmNnoPpQqRrSsTtUuVvWwXxYyZ_0-9] [filename/wildcard] . sisu [-Ddcv] [instruction] [filename/wildcard] . sisu [-CcFLSVvW] . sisu [operations] . sisu --v3 [operations] . sisu --v2 [operations] . sisu2 [operations] @links: { SiSU Homepage }http://www.sisudoc.org/ diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_commands.sst b/data/doc/sisu/markup-samples/sisu_manual/sisu_commands.sst index 86ac41cf..b24abde7 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_commands.sst +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_commands.sst @@ -21,7 +21,7 @@ :issued: 2002-08-28 :available: 2002-08-28 :published: 2007-09-16 - :modified: 2011-03-04 + :modified: 2011-09-18 @make: :num_top: 1 diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_content_directories.ssi b/data/doc/sisu/markup-samples/sisu_manual/sisu_content_directories.ssi index dedd38f4..b7e09434 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_content_directories.ssi +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_content_directories.ssi @@ -22,13 +22,13 @@ :B~? Content Directories -1~organising_content Organising Content +1~organising_content Organising Content - Directory Structure and Mapping -2~ Directory Structure and Mapping +SiSU v3 has new options for the source directory tree, and output directory structures of which there are 3 alternatives. -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) +2~ Document Source Directory -The last part of a directory path, representing the sub-directory in which a document set resides, is the directory name that will be used for the output directory. This has implications for the organisation of document collections as it could make sense to place documents of a particular subject, or type within a directory identifying them. This grouping as suggested could be by subject (sales_law, english_literature); or just as conveniently by some other classification (X University). The mapping means it is also possible to place in the same output directory documents that are for organisational purposes kept separately, for example documents on a given subject of two different institutions may be kept in two different directories of the same name, under a directory named after each institution, and these would be output to the same output directory. Skins could be associated with each institution on a directory basis and resulting documents will take on the appropriate different appearance. +The 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. 3~ General Directories @@ -36,7 +36,15 @@ code{ ./subject_name/ -% files stored at this level e.g. sisu_manual.sst +% 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 @@ -50,12 +58,154 @@ code{ ./subject_name/_sisu/image -% images for documents contained in this directory +}code -./subject_name/_sisu/mm +2~ Document Output Directory Structures + +3~ Output Directory Root + +The output directory root can be set in the sisurc.yml file. Under the root, subdirectories are made for each directory in which a document set resides. If you have a directory named poems or conventions, that directory will be created under the output directory root and the output for all documents contained in the directory of a particular name will be generated to subdirectories beneath that directory (poem or conventions). A document will be placed in a subdirectory of the same name as the document with the filetype identifier stripped (.sst .ssm) + +The last part of a directory path, representing the sub-directory in which a document set resides, is the directory name that will be used for the output directory. This has implications for the organisation of document collections as it could make sense to place documents of a particular subject, or type within a directory identifying them. This grouping as suggested could be by subject (sales_law, english_literature); or just as conveniently by some other classification (X University). The mapping means it is also possible to place in the same output directory documents that are for organisational purposes kept separately, for example documents on a given subject of two different institutions may be kept in two different directories of the same name, under a directory named after each institution, and these would be output to the same output directory. Skins could be associated with each institution on a directory basis and resulting documents will take on the appropriate different appearance. + +3~ Alternative Output Structures + +There are 3 possibile output structures described as being, by language, by filetype or by filename, the selection is made in sisurc.yml + +code{ + +#% output_dir_structure_by: language; filetype; or filename +output_dir_structure_by: language #(language & filetype, preferred?) +#output_dir_structure_by: filetype +#output_dir_structure_by: filename #(default, closest to original v1 & v2) }code +3~ By Language + +The by language directory structure places output files + +The by language directory structure separates output files by language code (all files of a given language), and within the language directory by filetype. + +Its selection is configured in sisurc.yml + +output_dir_structure_by: language + +% works for html epub odf, pdf, sortof for info NOT for man pages + +code{ + + ├── en + │  ├── epub + │  ├── hashes + │  ├── html + │  │  └── viral_spiral.david_bollier + │  ├── manifest + │  │  └── qrcode + │  ├── odt + │  ├── pdf + │  ├── sitemaps + │  ├── txt + │  ├── xhtml + │  └── xml + ├── po4a + │  └── live-manual + │  ├── po + │  │  └── fr + │  └── pot + └── _sisu + ├── css + ├── image + ├── image_sys -> ../../_sisu/image_sys + └── xml + ├── rnc + ├── rng + └── xsd + +}code + +#by: language +subject_dir/en/manifest/filename.html + +3~ By Filetype + +The by filetype directory structure separates output files by filetype, all html files in one directory pdfs in another and so on. Filenames are given a language extension. + +Its selection is configured in sisurc.yml + +output_dir_structure_by: filetype + +% works for html epub odf, pdf, sortof for info NOT for man pages + +code{ + + ├── epub + ├── hashes + ├── html + │  └── viral_spiral.david_bollier + ├── manifest + │  └── qrcode + ├── odt + ├── pdf + ├── po4a + │  └── live-manual + │  ├── po + │  │  └── fr + │  └── pot + ├── _sisu + │  ├── css + │  ├── image + │  ├── image_sys -> ../../_sisu/image_sys + │  └── xml + │  ├── rnc + │  ├── rng + │  └── xsd + ├── sitemaps + ├── txt + ├── xhtml + └── xml + +}code + +#by: filetype +subject_dir/html/filename/manifest.en.html + +3~ By Filename + +The by filename directory structure places most output of a particular file (the different filetypes) in a common directory. + +Its selection is configured in sisurc.yml + +output_dir_structure_by: filename + +% works for html epub odf, pdf, sortof for info NOT for man pages + +code{ + + ├── epub + ├── po4a + │  └── live-manual + │  ├── po + │  │  └── fr + │  └── pot + ├── _sisu + │  ├── css + │  ├── image + │  ├── image_sys -> ../../_sisu/image_sys + │  └── xml + │  ├── rnc + │  ├── rng + │  └── xsd + ├── sitemaps + ├── src + │  └── pod + └── viral_spiral.david_bollier + +}code + +#by: filename +subject_dir/filename/manifest.en.html + 3~ Remote Directories code{ diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_introduction.sst b/data/doc/sisu/markup-samples/sisu_manual/sisu_introduction.sst index a94e9145..4908b68f 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_introduction.sst +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_introduction.sst @@ -7,7 +7,7 @@ :author: Amissah, Ralph @rights: - :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + :copyright: Copyright (C) Ralph Amissah 2011, part of SiSU documentation, License GPL 3 % used_by: manual @@ -20,7 +20,7 @@ :created: 2002-08-28 :issued: 2002-08-28 :available: 2002-08-28 - :modified: 2011-02-07 + :modified: 2011-09-18 @make: :num_top: 1 diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_markup.sst b/data/doc/sisu/markup-samples/sisu_manual/sisu_markup.sst index 735f00ea..046b1f2b 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_markup.sst +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_markup.sst @@ -1266,9 +1266,9 @@ code{ }code -:C~ Markup Syntax History +1~syntax_history Markup Syntax History -1~ Notes related to Files-types and Markup Syntax +2~ Notes related to Files-types and Markup Syntax 2.0 introduced new headers and is therefore incompatible with 1.0 though otherwise the same with the addition of a couple of tags (i.e. a superset) diff --git a/data/sisu/v2/v/version.yml b/data/sisu/v2/v/version.yml index 95fdfff7..62e59e16 100644 --- a/data/sisu/v2/v/version.yml +++ b/data/sisu/v2/v/version.yml @@ -1,5 +1,5 @@ --- -:version: 2.9.8 -:date_stamp: 2011w38/6 -:date: "2011-09-24" +:version: 2.9.9 +:date_stamp: 2011w40/1 +:date: "2011-10-03" :project: SiSU diff --git a/data/sisu/v3/conf/editor-syntax-etc/vim/syntax/sisu.vim b/data/sisu/v3/conf/editor-syntax-etc/vim/syntax/sisu.vim index 7416f809..bfcfc3e6 100644 --- a/data/sisu/v3/conf/editor-syntax-etc/vim/syntax/sisu.vim +++ b/data/sisu/v3/conf/editor-syntax-etc/vim/syntax/sisu.vim @@ -1,7 +1,7 @@ " SiSU Vim syntax file " SiSU Maintainer: Ralph Amissah <ralph@amissah.com> -" SiSU Markup: SiSU (sisu-3.0.14) -" Last Change: 2011-07-24 +" SiSU Markup: SiSU (sisu-3.1.0) +" Last Change: 2011-10-03 " URL: <http://git.sisudoc.org/?p=code/sisu.git;a=blob;f=data/sisu/v3/conf/editor-syntax-etc/vim/syntax/sisu.vim;hb=HEAD> "(originally looked at Ruby Vim by Mirko Nasato) @@ -44,7 +44,7 @@ if !exists("sisu_no_identifiers") syn match sisu_sub_header_classify "^\s\+:\(topic_register\|coverage\|format\|identifier\|keywords\|relation\|subject\|type\|dewey\|loc\|oclc\|pg\|isbn\):\s" syn match sisu_sub_header_date "^\s\+:\(added_to_site\|available\|created\|issued\|modified\|published\|valid\|translated\|original_publication\):\s" syn match sisu_sub_header_original "^\s\+:\(publisher\|date\|language\|lang_char\|institution\|nationality\|source\):\s" - syn match sisu_sub_header_make "^\s\+:\(headings\|num_top\|breaks\|language\|italics\|bold\|emphasis\|plaintext_wrap\|texpdf_font\|skin\|stamp\|promo\|ad\|manpage\):\s" + syn match sisu_sub_header_make "^\s\+:\(headings\|num_top\|breaks\|language\|italics\|bold\|emphasis\|plaintext_wrap\|texpdf_font_mono\|texpdf_font\|skin\|stamp\|promo\|ad\|manpage\):\s" syn match sisu_sub_header_notes "^\s\+:\(abstract\|comment\|description\|history\|prefix\|prefix_[ab]\|suffix\):\s" "% "semantic markers: (ignore) diff --git a/data/sisu/v3/conf/editor-syntax-etc/vim/syntax/sisu_next.vim b/data/sisu/v3/conf/editor-syntax-etc/vim/syntax/sisu_next.vim new file mode 100644 index 00000000..61504dbd --- /dev/null +++ b/data/sisu/v3/conf/editor-syntax-etc/vim/syntax/sisu_next.vim @@ -0,0 +1,277 @@ +" SiSU Vim syntax file +" SiSU Maintainer: Ralph Amissah <ralph@amissah.com> +" SiSU Markup: SiSU (sisu-3.1.0) +" Last Change: 2011-10-03 +" URL: <http://git.sisudoc.org/?p=code/sisu.git;a=blob;f=data/sisu/v3/conf/editor-syntax-etc/vim/syntax/sisu.vim;hb=HEAD> +"(originally looked at Ruby Vim by Mirko Nasato) + +if version < 600 + syntax clear +elseif exists("b:current_syntax") + finish +else +endif + +"% "Errors: +syn match sisu_error contains=sisu_link,sisu_error_wspace "<![^ei]\S\+!>" + +"% "Markers Identifiers: +if !exists("sisu_no_identifiers") + syn match sisu_mark_endnote "\~^" + syn match sisu_break contains=@NoSpell " \\\\\( \|$\)" + syn match sisu_break contains=@NoSpell "<br>\|<br />" + syn match sisu_control contains=@NoSpell "^<:p[bn]>\s*$" + "syn match sisu_control contains=@NoSpell "^<\(br\)\?:\(pg\|pgn\|pn\)>\s*$" + "syn match sisu_control contains=@NoSpell "^\[\(br\)\?:\(pg\|pgn\|pn\)\]\s*$" + syn match sisu_control contains=@NoSpell "^<:\(bo\|---\)>\s*$" + "syn match sisu_control contains=@NoSpell "^<\(br\)\?:\(pr\|o\)>\s*$" + "syn match sisu_control contains=@NoSpell "^\[\(br\)\?:\(pr\|o\)\]\s*$" + syn match sisu_marktail "[~-]#" + syn match sisu_control "\"" + syn match sisu_underline "\(^\| \)_[a-zA-Z0-9]\+_\([ .,]\|$\)" + syn match sisu_number contains=@NoSpell "[0-9a-f]\{32\}\|[0-9a-f]\{64\}" + syn match sisu_link contains=@NoSpell "\(_\?https\?://\|\.\.\/\)\S\+" + syn match sisu_link " \*\~\S\+" + syn match sisu_action "^<:insert\d\+>" + syn match sisu_require contains=@NoSpell "^<<\s*[a-zA-Z0-9^._-]\+\.ss[it]$" + syn match sisu_require contains=@NoSpell "^<<{[a-zA-Z0-9^._-]\+\.ss[it]}$" + syn match sisu_structure "^:A\~$" + +"% "Document Sub Headers: + syn match sisu_sub_header_title "^\s\+:\(subtitle\|short\|edition\|language\|lang_char\|note\):\s" "group=sisu_header_content + syn match sisu_sub_header_creator "^\s\+:\(author\|editor\):\s" " &hon &institution + syn match sisu_sub_header_contributor "^\s\+:\(editor\|translator\|illustrator\|photographer\|audio\|video\|prepared_by\|digitized_by\):\s" + syn match sisu_sub_header_rights "^\s\+:\(copyright\|text\|translation\|illustrations\|photographs\|preparation\|digitization\|audio\|video\|license\|all\):\s" " access_rights license + syn match sisu_sub_header_classify "^\s\+:\(topic_register\|coverage\|identifier\|keywords\|relation\|subject\|type\|dewey\|loc\):\s" + syn match sisu_sub_header_identify "^\s\+:\(isbn\|urn\|oclc\|pg\):\s" + syn match sisu_sub_header_format "^\s\+:\(mimetype\):\s" + syn match sisu_sub_header_date "^\s\+:\(added_to_site\|available\|created\|issued\|modified\|published\|valid\|translated\|original_publication\):\s" + syn match sisu_sub_header_original "^\s\+:\(publisher\|date\|language\|lang_char\|institution\|nationality\|source\):\s" + syn match sisu_sub_header_make "^\s\+:\(headings\|num_top\|breaks\|language\|italics\|bold\|emphasis\|plaintext_wrap\|texpdf_font_mono\|texpdf_font\|skin\|stamp\|promo\|ad\|manpage\):\s" + syn match sisu_sub_header_notes "^\s\+:\(abstract\|comment\|description\|history\|prefix\|prefix_[ab]\|suffix\):\s" + +"% "semantic markers: (ignore) + syn match sisu_sem_marker ";{\|};[a-z._]*[a-z]" + syn match sisu_sem_marker_block "\([a-z][a-z._]*\|\):{\|}:[a-z._]*[a-z]" + syn match sisu_sem_ex_marker ";\[\|\];[a-z._]*[a-z]" + syn match sisu_sem_ex_marker_block "\([a-z][a-z._]*\|\):\[\|\]:[a-z._]*[a-z]" + syn match sisu_sem_block contains=sisu_error,sisu_error_wspace,sisu_content_alt,sisu_link,sisu_linked,sisu_break,sisu_sem_block,sisu_sem_content,sisu_sem_marker_block,sisu_sem_marker,sisu_sem_ex_marker_block,sisu_sem_ex_marker,sisu_mark_endnote,sisu_content_endnote "\([a-z]*\):{[^}].\{-}}:\1" + syn match sisu_sem_content contains=sisu_error,sisu_error_wspace,sisu_content_alt,sisu_link,sisu_linked,sisu_break,sisu_sem_marker_block,sisu_sem_marker,sisu_sem_ex_marker_block,sisu_sem_ex_marker ";{[^}].\{-}};[a-z]\+" + syn match sisu_sem_ex_block contains=sisu_error,sisu_error_wspace,sisu_content_alt,sisu_link,sisu_linked,sisu_break,sisu_sem_block,sisu_sem_content,sisu_sem_marker_block,sisu_sem_marker,sisu_sem_ex_marker_block,sisu_sem_ex_marker,sisu_mark_endnote,sisu_content_endnote "\([a-z]*\):\[[^}].\{-}\]:\1" + syn match sisu_sem_ex_content contains=sisu_error,sisu_error_wspace,sisu_content_alt,sisu_link,sisu_linked,sisu_break,sisu_sem_marker_block,sisu_sem_marker,sisu_sem_ex_marker_block,sisu_sem_ex_marker ";\[[^}].\{-}\];[a-z]\+" +endif + +"% "URLs Numbers And ASCII Codes: +syn match sisu_number "\<\(0x\x\+\|0b[01]\+\|0\o\+\|0\.\d\+\|0\|[1-9][\.0-9_]*\)\>" +syn match sisu_number "?\(\\M-\\C-\|\\c\|\\C-\|\\M-\)\=\(\\\o\{3}\|\\x\x\{2}\|\\\=\w\)" + +"% "Tuned Error: (is error if not already matched) +syn match sisu_error contains=sisu_error "[\~/\*!_]{\|}[\~/\*!_]" +syn match sisu_error contains=sisu_error "<a href\|</a>]" + +"% "Simple Paired Enclosed Markup: +"url/link +syn region sisu_link contains=sisu_error,sisu_error_wspace matchgroup=sisu_action start="^<<\s*|[a-zA-Z0-9^._-]\+|@|[a-zA-Z0-9^._-]\+|"rs=s+2 end="$" + +"% "Document Header: +" title +syn region sisu_header_content contains=sisu_error,sisu_comment,sisu_break,sisu_link,sisu_sub_header_title matchgroup=sisu_header start="^[@]title:[+-]\?\(\s\|\n\)"rs=e-1 end="\n$" +" creator +syn region sisu_header_content contains=sisu_error,sisu_comment,sisu_break,sisu_link,sisu_sub_header_creator matchgroup=sisu_header start="^[@]creator:[+-]\?\(\s\|\n\)"rs=e-1 end="\n$" +" contributor +syn region sisu_header_content contains=sisu_error,sisu_comment,sisu_break,sisu_link,sisu_sub_header_contributor matchgroup=sisu_header start="^[@]contributor:[+-]\?\(\s\|\n\)"rs=e-1 end="\n$" +" dates +syn region sisu_header_content contains=sisu_error,sisu_comment,sisu_break,sisu_link,sisu_sub_header_date matchgroup=sisu_header start="^[@]date:[+-]\?\(\s\|\n\)"rs=e-1 end="\n$" +" publisher +syn region sisu_header_content contains=sisu_error,sisu_comment,sisu_break,sisu_link,sisu_sub_header_publisher matchgroup=sisu_header start="^[@]publisher:[+-]\?\(\s\|\n\)"rs=e-1 end="\n$" +" rights +syn region sisu_header_content contains=sisu_error,sisu_comment,sisu_break,sisu_link,sisu_sub_header_rights matchgroup=sisu_header start="^[@]rights:[+-]\?\(\s\|\n\)"rs=e-1 end="\n$" +" classify document +syn region sisu_header_content contains=sisu_error,sisu_comment,sisu_break,sisu_link,sisu_sub_header_classify matchgroup=sisu_header start="^[@]classify:[+-]\?\(\s\|\n\)"rs=e-1 end="\n$" +" identifier +syn region sisu_header_content contains=sisu_error,sisu_comment,sisu_break,sisu_link,sisu_sub_header_identifier matchgroup=sisu_header start="^[@]identifier:[+-]\?\(\s\|\n\)"rs=e-1 end="\n$" +" format +syn region sisu_header_content contains=sisu_error,sisu_comment,sisu_break,sisu_link,sisu_sub_header_format matchgroup=sisu_header start="^[@]format:[+-]\?\(\s\|\n\)"rs=e-1 end="\n$" +" original language (depreciated) +syn region sisu_header_content contains=sisu_error,sisu_comment,sisu_break,sisu_link,sisu_sub_header_original matchgroup=sisu_header start="^[@]original:[+-]\?\(\s\|\n\)"rs=e-1 end="\n$" +" notes +syn region sisu_header_content contains=sisu_error,sisu_comment,sisu_break,sisu_link,sisu_sub_header_notes matchgroup=sisu_header start="^[@]notes:[+-]\?\(\s\|\n\)"rs=e-1 end="\n$" +" links of interest +syn region sisu_header_content contains=sisu_error,sisu_comment,sisu_break,sisu_linked,sisu_sub_header_links matchgroup=sisu_header start="^[@]links:[+-]\?\(\s\|\n\)"rs=e-1 end="\n$" +" make, processing instructions +syn region sisu_header_content contains=sisu_error,sisu_comment,sisu_break,sisu_link,sisu_sub_header_make matchgroup=sisu_header start="^[@]make:[+-]\?\(\s\|\n\)"rs=e-1 end="\n$" + +"% "Headings: +syn region sisu_heading contains=sisu_mark_endnote,sisu_content_endnote,sisu_marktail,sisu_strikeout,sisu_number,sisu_bold,sisu_control,sisu_identifier,sisu_ocn,sisu_error,sisu_error_wspace matchgroup=sisu_structure start="^\([1-8]\|:\?[A-C]\)\~\(\S\+\|[^-]\)" end="$" + +"% "Block Group Text: +" table +syn region sisu_content_alt contains=sisu_strikeout,sisu_number,sisu_bold,sisu_control,sisu_identifier,sisu_error matchgroup=sisu_contain start="^table{.\+" end="}table" +" table +syn region sisu_content_alt contains=sisu_strikeout,sisu_number,sisu_bold,sisu_control,sisu_identifier,sisu_error matchgroup=sisu_contain start="^{\(t\|table\)\(\~h\)\?\(\sc[0-9]\+;\)\?[0-9; ]*}" end="\n$" +" block, group, poem, alt +syn region sisu_content_alt contains=sisu_mark_endnote,sisu_content_endnote,sisu_link,sisu_mark,sisu_strikeout,sisu_number,sisu_control,sisu_identifier,sisu_error matchgroup=sisu_contain start="^\(block\|group\|poem\|alt\){" end="^}\(block\|group\|poem\|alt\)" +" code +syn region sisu_content_alt contains=sisu_error matchgroup=sisu_contain start="^code{" end="^}code" + +"% "Endnotes: +" regular endnote or asterisk or plus sign endnote +syn region sisu_content_endnote contains=sisu_link,sisu_strikeout,sisu_underline,sisu_number,sisu_bold,sisu_control,sisu_identifier,sisu_error,sisu_error_wspace,sisu_mark,sisu_break,sisu_sem_block,sisu_sem_content,sisu_sem_marker_block,sisu_sem_marker,sisu_sem_ex_marker_block,sisu_sem_ex_marker matchgroup=sisu_mark_endnote start="\~{[*+]*" end="}\~" skip="\n" +" numbered asterisk or plus sign endnote +syn region sisu_content_endnote contains=sisu_link,sisu_strikeout,sisu_underline,sisu_number,sisu_bold,sisu_control,sisu_identifier,sisu_error,sisu_error_wspace,sisu_mark,sisu_break,sisu_sem_block,sisu_sem_content,sisu_sem_marker matchgroup=sisu_mark_endnote start="\~\[[*+]*" end="\]\~" skip="\n" +" endnote content marker (for binary content marking) +syn region sisu_content_endnote contains=sisu_strikeout,sisu_number,sisu_bold,sisu_control,sisu_link,sisu_identifier,sisu_error,sisu_error_wspace,sisu_mark,sisu_break matchgroup=sisu_mark_endnote start="\^\~" end="\n$" + +"% "Links And Images: +" image with url link (and possibly footnote of url) +syn region sisu_linked contains=sisu_fontface,sisu_strikeout,sisu_number,sisu_bold,sisu_control,sisu_identifier,sisu_sem_block,sisu_sem_content,sisu_sem_marker_block,sisu_sem_marker,sisu_sem_ex_marker_block,sisu_sem_ex_marker,sisu_sem_block,sisu_error matchgroup=sisu_link start="{\(\~^\s\)\?" end="}\(https\?:/\/\|:\|\.\.\/\|#\)\S\+" oneline +" sisu outputs, short notation +syn region sisu_linked contains=sisu_fontface,sisu_strikeout,sisu_number,sisu_bold,sisu_control,sisu_identifier,sisu_sem_block,sisu_sem_content,sisu_sem_marker_block,sisu_sem_marker,sisu_sem_ex_marker_block,sisu_sem_ex_marker,sisu_sem_block,sisu_error matchgroup=sisu_link start="{\(\~^\s\)\?" end="\[[1-5][sS]*\]}\S\+\.ss[tm]" oneline +" image +syn region sisu_linked contains=sisu_fontface,sisu_strikeout,sisu_number,sisu_bold,sisu_control,sisu_identifier,sisu_error matchgroup=sisu_link start="{" end="}image" oneline + +"% "Some Line Operations: +" bold line +syn region sisu_bold contains=sisu_strikeout,sisu_identifier,sisu_content_endnote,sisu_mark_endnote,sisu_error,sisu_error_wspace matchgroup=sisu_markpara start="^!_ " end=" \\\\\|$" +" indent and bullet paragraph +syn region sisu_normal contains=sisu_fontface,sisu_bold,sisu_control,sisu_identifier,sisu_content_endnote,sisu_mark_endnote,sisu_link,sisu_sem_block,sisu_sem_content,sisu_sem_marker_block,sisu_sem_marker,sisu_sem_ex_marker_block,sisu_sem_ex_marker,sisu_linked,sisu_error,sisu_error_wspace matchgroup=sisu_markpara start="^_\([1-9*]\|[1-9]\*\) " end="$" +" indent and bullet (bold start) paragraph +syn region sisu_bold contains=sisu_fontface,sisu_bold,sisu_control,sisu_identifier,sisu_content_endnote,sisu_mark_endnote,sisu_link,sisu_sem_block,sisu_sem_content,sisu_sem_marker_block,sisu_sem_marker,sisu_sem_ex_marker_block,sisu_sem_ex_marker,sisu_linked,sisu_error,sisu_error_wspace matchgroup=sisu_markpara start="^_\([1-9*]\|[1-9]\*\)!_\? " end=" \\\\\|$" +" hanging indent paragraph [proposed] +syn region sisu_normal contains=sisu_fontface,sisu_bold,sisu_control,sisu_identifier,sisu_content_endnote,sisu_mark_endnote,sisu_link,sisu_sem_block,sisu_sem_content,sisu_sem_marker_block,sisu_sem_marker,sisu_sem_ex_marker_block,sisu_sem_ex_marker,sisu_linked,sisu_error,sisu_error_wspace matchgroup=sisu_markpara start="^_[0-9]\?_[0-9] " end="$" +" hanging indent (bold start/ definition) paragraph [proposed] +syn region sisu_bold contains=sisu_fontface,sisu_bold,sisu_control,sisu_identifier,sisu_content_endnote,sisu_mark_endnote,sisu_link,sisu_sem_block,sisu_sem_content,sisu_sem_marker_block,sisu_sem_marker,sisu_sem_ex_marker_block,sisu_sem_ex_marker,sisu_linked,sisu_error,sisu_error_wspace matchgroup=sisu_markpara start="^_[0-9]\?_[0-9]!_\? " end=" \\\\\|$" +" list numbering +syn region sisu_normal contains=sisu_strikeout,sisu_identifier,sisu_content_endnote,sisu_mark_endnote,sisu_link,sisu_linked,sisu_error,sisu_error_wspace matchgroup=sisu_markpara start="^\(#[ 1]\|_# \)" end="$" + +"% "Font Face Curly Brackets: +"syn region sisu_identifier contains=sisu_strikeout,sisu_number,sisu_control,sisu_identifier,sisu_error matchgroup=sisu_sem start="\S\+:{" end="}:[^<>,.!?:; ]\+" oneline +" book index: +syn region sisu_index matchgroup=sisu_index_block start="^={" end="}" +" emphasis: +syn region sisu_bold contains=sisu_strikeout,sisu_number,sisu_bold,sisu_control,sisu_identifier,sisu_error matchgroup=sisu_fontface start="\*{" end="}\*" +" bold: +syn region sisu_bold contains=sisu_strikeout,sisu_number,sisu_bold,sisu_control,sisu_identifier,sisu_error matchgroup=sisu_fontface start="!{" end="}!" +" underscore: +syn region sisu_underline contains=sisu_strikeout,sisu_number,sisu_bold,sisu_control,sisu_identifier,sisu_error matchgroup=sisu_fontface start="_{" end="}_" +" italics: +syn region sisu_identifier contains=sisu_strikeout,sisu_number,sisu_bold,sisu_control,sisu_identifier,sisu_error matchgroup=sisu_fontface start="/{" end="}/" +" added: +syn region sisu_underline contains=sisu_strikeout,sisu_number,sisu_bold,sisu_control,sisu_identifier,sisu_error matchgroup=sisu_fontface start="+{" end="}+" +" superscript: +syn region sisu_identifier contains=sisu_strikeout,sisu_number,sisu_bold,sisu_control,sisu_identifier,sisu_error matchgroup=sisu_fontface start="\^{" end="}\^" +" subscript: +syn region sisu_identifier contains=sisu_strikeout,sisu_number,sisu_bold,sisu_control,sisu_identifier,sisu_error matchgroup=sisu_fontface start=",{" end="}," +" monospace: +syn region sisu_identifier contains=sisu_strikeout,sisu_number,sisu_bold,sisu_control,sisu_identifier,sisu_error matchgroup=sisu_fontface start="#{" end="}#" +" strikethrough: +syn region sisu_strikeout contains=sisu_error matchgroup=sisu_fontface start="-{" end="}-" +" (depreciated remove, consider marking as error): +" syn region sisu_html contains=sisu_error contains=sisu_strikeout matchgroup=sisu_contain start="<a href=\".\{-}\">" end="</a>" oneline + +"% "Single Words Bold Italicise Etc: (depreciated) +syn region sisu_bold contains=sisu_error matchgroup=sisu_bold start="\([ (]\|^\)\*[^\|{\n\~\\]"hs=e-1 end="\*"he=e-0 skip="[a-zA-Z0-9']" oneline +syn region sisu_identifier contains=sisu_error matchgroup=sisu_content_alt start="\([ ]\|^\)/[^{ \|\n\\]"hs=e-1 end="/\[ \.\]" skip="[a-zA-Z0-9']" oneline +"misc +syn region sisu_identifier contains=sisu_error matchgroup=sisu_fontface start="\^[^ {\|\n\\]"rs=s+1 end="\^[ ,.;:'})\\\n]" skip="[a-zA-Z0-9']" oneline + +"% "Expensive Mode: +if !exists("sisu_no_expensive") +else " not Expensive + syn region sisu_content_alt matchgroup=sisu_control start="^\s*def\s" matchgroup=NONE end="[?!]\|\>" skip="\.\|\(::\)" oneline +endif " Expensive? + +"% "Headers And Headings: (Document Instructions) +syn match sisu_control contains=sisu_error,sisu_error_wspace "4\~! \S\+" +syn region sisu_markpara contains=sisu_error,sisu_error_wspace start="^=begin" end="^=end.*$" + +"% "Errors: +syn match sisu_error_wspace contains=sisu_error_wspace "^\s\+[^:]" +syn match sisu_error_wspace contains=sisu_error_wspace "\s\s\+" +"syn match sisu_error_wspace contains=sisu_error_wspace "\s\s\+\|\t\+" +syn match sisu_error_wspace contains=sisu_error_wspace "\s\+$" +syn match sisu_error contains=sisu_error_wspace "\t\+" +syn match sisu_error contains=sisu_error,sisu_error_wspace "\([^ (][_\\]\||[^ (}]\)https\?:\S\+" +syn match sisu_error contains=sisu_error "_\?https\?:\S\+[}><]" +syn match sisu_error contains=sisu_error "\([!*/_\+,^]\){\([^(\}\1)]\)\{-}\n$" +syn match sisu_error contains=sisu_error "^[\~]{[^{]\{-}\n$" +syn match sisu_error contains=sisu_error "\s\+.{{" +syn match sisu_error contains=sisu_error "^\~\s*$" +syn match sisu_error contains=sisu_error "^0\~.*" +syn match sisu_error contains=sisu_error "^[1-9]\~\s*$" +syn match sisu_error contains=sisu_error "^[1-9]\~\S\+\s*$" +syn match sisu_error contains=sisu_error "[^{]\~\^[^ \)]" +syn match sisu_error contains=sisu_error "\~\^\s\+\.\s*" +syn match sisu_error contains=sisu_error "{\~^\S\+" +syn match sisu_error contains=sisu_error "[_/\*!^]{[ .,:;?><]*}[_/\*!^]" +syn match sisu_error contains=sisu_error "[^ (\"'(\[][_/\*!]{\|}[_/\*!][a-zA-Z0-9)\]\"']" +syn match sisu_error contains=sisu_error "<dir>" +"errors for filetype sisu, though not error in 'metaverse': +syn match sisu_error contains=sisu_error,sisu_match,sisu_strikeout,sisu_contain,sisu_content_alt,sisu_mark,sisu_break,sisu_number "<[a-zA-Z\/]\+>" +syn match sisu_error "/\?<\([biu]\)>[^(</\1>)]\{-}\n$" + +"% "Error Exceptions: +syn match sisu_control "\n$" "contains=ALL +"syn match sisu_control " //" +syn match sisu_error "%{" +syn match sisu_error "<br>_\?https\?:\S\+\|_\?https\?:\S\+<br>" +syn match sisu_error "[><]_\?https\?:\S\+\|_\?https\?:\S\+[><]" +syn match sisu_comment "^%\{1,2\}.\+" + +"% "Definitions Default Highlighting: +hi def link sisu_normal Normal +hi def link sisu_bold Statement +hi def link sisu_header PreProc +hi def link sisu_header_content Normal +hi def link sisu_sub_header_title Statement +hi def link sisu_sub_header_creator Statement +hi def link sisu_sub_header_date Statement +hi def link sisu_sub_header_publisher Statement +hi def link sisu_sub_header_rights Statement +hi def link sisu_sub_header_classify Statement +hi def link sisu_sub_header_original Statement +hi def link sisu_sub_header_links Statement +hi def link sisu_sub_header_notes Statement +hi def link sisu_sub_header_make Statement +hi def link sisu_heading Title +hi def link sisu_structure Operator +hi def link sisu_contain Include +hi def link sisu_mark_endnote Delimiter +"hi def link sisu_mark_endnote Include +hi def link sisu_require NonText +hi def link sisu_link NonText +hi def link sisu_linked String +hi def link sisu_fontface Delimiter +"hi def link sisu_fontface Include +hi def link sisu_strikeout DiffDelete +hi def link sisu_content_alt Special +hi def link sisu_sem_content SpecialKey +hi def link sisu_sem_block Special +hi def link sisu_sem_marker Visual +"hi def link sisu_sem_marker Structure +hi def link sisu_sem_marker_block MatchParen +hi def link sisu_sem_ex_marker FoldColumn +hi def link sisu_sem_ex_marker_block Folded +hi def link sisu_sem_ex_content Comment +"hi def link sisu_sem_ex_content SpecialKey +hi def link sisu_sem_ex_block Comment +hi def link sisu_index SpecialKey +hi def link sisu_index_block Visual +hi def link sisu_content_endnote Special +hi def link sisu_control Delimiter +"hi def link sisu_control Define +hi def link sisu_ocn Include +hi def link sisu_number Number +hi def link sisu_identifier Function +hi def link sisu_underline Underlined +hi def link sisu_markpara Include +hi def link sisu_marktail Include +hi def link sisu_mark Identifier +hi def link sisu_break Structure +hi def link sisu_html Type +hi def link sisu_action Identifier +hi def link sisu_comment Comment +hi def link sisu_error_sem_marker Error +hi def link sisu_error_wspace Error +hi def link sisu_error Error +let b:current_syntax = "sisu" diff --git a/data/sisu/v3/v/version.yml b/data/sisu/v3/v/version.yml index e3e17c44..8510a9e5 100644 --- a/data/sisu/v3/v/version.yml +++ b/data/sisu/v3/v/version.yml @@ -1,5 +1,5 @@ --- -:version: 3.0.19 -:date_stamp: 2011w38/6 -:date: "2011-09-24" +:version: 3.1.0 +:date_stamp: 2011w40/1 +:date: "2011-10-03" :project: SiSU diff --git a/lib/sisu/v3/defaults.rb b/lib/sisu/v3/defaults.rb index 97c2b263..cefab8a1 100644 --- a/lib/sisu/v3/defaults.rb +++ b/lib/sisu/v3/defaults.rb @@ -1746,12 +1746,12 @@ WOK <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html> <head> +<meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> <title>SiSU information Structuring Universe - Structured information, Serialized Units - software for electronic texts, documents, books, digital libraries in plaintext, html, XHTML, XML, ODF (OpenDocument), EPUB, LaTeX, PDF, SQL (PostgreSQL and SQLite), and for search</title> -<meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> <meta name="dc.title" content="SiSU information Structuring Universe, Structured information Serialised Units, #{@date.year_static}" /> <meta name="dc.creator" content="Ralph Amissah" /> @@ -1769,7 +1769,7 @@ for search</title> <body> <div id="top_band"> <p class="top_band_image"> - <a href="http://www.sisudoc.org/sisu/SiSU" target="_top" > + <a href="http://www.sisudoc.org/sisu/SiSU" target="_top"> <img border="0" src="./_sisu/image/sisu.png" alt="SiSU >>"> </a> </p> @@ -1779,11 +1779,11 @@ for search</title> <h2 class="top_band_tiny"> Structured information, Serialized Units - <a href="http://www.sisudoc.org" target="_top" > + <a href="http://www.sisudoc.org" target="_top"> <www.sisudoc.org> </a> or - <a href="http://www.jus.uio.no/sisu/" target="_top" > + <a href="http://www.jus.uio.no/sisu/" target="_top"> <www.jus.uio.no/sisu/> </a> </h2> @@ -1801,7 +1801,7 @@ outputs include: plaintext, html, XHTML, XML, ODF (OpenDocument), EPUB, LaTeX, P </div> <div id="column_left"> <p class="bold"> - <a href="http://www.sisudoc.org/sisu/SiSU" target="_top" > + <a href="http://www.sisudoc.org/sisu/SiSU" target="_top"> SiSU </a> </p> @@ -1809,7 +1809,7 @@ outputs include: plaintext, html, XHTML, XML, ODF (OpenDocument), EPUB, LaTeX, P --- </p> <p class="small"> - <a href="http://www.sisudoc.org/sisu/sisu_manual/" target="_top" > + <a href="http://www.sisudoc.org/sisu/sisu_manual/" target="_top"> SiSU Manual </a> </p> @@ -1817,7 +1817,7 @@ outputs include: plaintext, html, XHTML, XML, ODF (OpenDocument), EPUB, LaTeX, P --- </p> <p class="small"> - <a href="http://www.sisudoc.org/sisu/SiSU/1.html#summary" target="_top" > + <a href="http://www.sisudoc.org/sisu/SiSU/1.html#summary" target="_top"> What does SiSU do? Summary </a> </p> @@ -1825,17 +1825,17 @@ outputs include: plaintext, html, XHTML, XML, ODF (OpenDocument), EPUB, LaTeX, P --- </p> <p class="small"> - <a href="http://www.sisudoc.org/sisu/SiSU/examples.html" target="_top" > + <a href="http://www.sisudoc.org/sisu/SiSU/examples.html" target="_top"> Book Samples and Markup Examples </a> </p> <p class="small"> - <a href="http://www.sisudoc.org/sisu/sisu_site_metadata/harvest_authors.html" target="_top" > + <a href="http://www.sisudoc.org/sisu/sisu_site_metadata/harvest_authors.html" target="_top"> sorted by Author (sisu metadata) </a> </p> <p class="small"> - <a href="http://www.sisudoc.org/sisu/sisu_site_metadata/harvest_topics.html" target="_top" > + <a href="http://www.sisudoc.org/sisu/sisu_site_metadata/harvest_topics.html" target="_top"> sorted by Topic (sisu metadata) </a> </p> @@ -1843,7 +1843,7 @@ outputs include: plaintext, html, XHTML, XML, ODF (OpenDocument), EPUB, LaTeX, P --- </p> <p class="small"> - <a href="http://www.sisudoc.org/sisu/SiSU/1.html#ocn" target="_top" > + <a href="http://www.sisudoc.org/sisu/SiSU/1.html#ocn" target="_top"> Object Citation Numbering - <i>ocn</i> </a> </p> @@ -1852,12 +1852,13 @@ outputs include: plaintext, html, XHTML, XML, ODF (OpenDocument), EPUB, LaTeX, P --- </p> <p class="small"> - <a href="http://www.sisudoc.org/sisu/SiSU/1.html#search" target="_top" > + <a href="http://www.sisudoc.org/sisu/SiSU/1.html#search" target="_top"> Search - "<i>granular</i>" </a> +</p> <p class="tiny"> Of interest is the ease of streaming documents to a relational database, at an object (roughly paragraph) level and the potential for increased precision in the presentation of matches that results thereby. The ability to serialise html, LaTeX, XML, SQL, (whatever) is also inherent in / incidental to the design. For a description see the - <a href="http://www.sisudoc.org/sisu/sisu_provisional_patent_application_200408" target="_top" > + <a href="http://www.sisudoc.org/sisu/sisu_provisional_patent_application_200408" target="_top"> abandoned U.S. provisional patent application </a> </p> @@ -1865,15 +1866,23 @@ outputs include: plaintext, html, XHTML, XML, ODF (OpenDocument), EPUB, LaTeX, P --- </p> <p class="small"> - <a href="http://www.sisudoc.org/sisu/SiSU/download.html" target="_top" > - <b>Download</b> + <a href="http://git.sisudoc.org/" target="_top"> + <b>Development, SCM - Git</b> + </a><br /> + <a href="http://git.sisudoc.org/" target="_top"> + <http://git.sisudoc.org> + </a> +</p> +<p class="small"> + <a href="http://www.sisudoc.org/sisu/SiSU/download.html" target="_top"> + <b>Download</b> alternatives </a> </p> <p class="tiny"> --- </p> <p class="small"> - <a href="http://www.sisudoc.org/sisu/SiSU/changelog.html" target="_top" > + <a href="http://www.sisudoc.org/sisu/SiSU/changelog.html" target="_top"> Changelog </a> </p> @@ -1882,7 +1891,7 @@ outputs include: plaintext, html, XHTML, XML, ODF (OpenDocument), EPUB, LaTeX, P </p> <p class="small"> License, SiSU is licensed under - <a href="http://www.gnu.org/licenses/gpl.html" target="_top" > + <a href="http://www.gnu.org/licenses/gpl.html" target="_top"> GPLv3 or later </a> </p> @@ -1909,7 +1918,7 @@ SiSU is an Open Source project initiated and led by Ralph Amissah <a href="mailt <p class="bold"> For less markup than the most elementary HTML you can have more. </p> -<p><a href="http://www.sisudoc.org/sisu/SiSU" target="_top" ><b>SiSU</b> - Structured information, Serialized Units</a> for electronic documents, is an information structuring, transforming, publishing and search framework with the following features:</p> +<p><a href="http://www.sisudoc.org/sisu/SiSU" target="_top"><b>SiSU</b> - Structured information, Serialized Units</a> for electronic documents, is an information structuring, transforming, publishing and search framework with the following features:</p> <p> <b>(i)</b> markup syntax: <b>(a)</b> @@ -1965,6 +1974,7 @@ document content certification and comparison considerations: the document and each object within it stamped with an md5 hash making it possible to easily check or guarantee that the substantive content of a document is unchanged, <b>(b)</b> version control, documents integrated with time based source control system, default RCS or CVS with use of $Id$ tag, which SiSU checks +</p> <p> <b>(x)</b> SiSU's minimalist markup makes for meaningful "diffing" of the substantive content of markup-files,</p> @@ -2035,7 +2045,7 @@ as a developers tool it is flexible and extensible <input type="hidden" name="a" value="1" /> <input type="radio" name="view" value="index" checked="checked" /> idx <input type="radio" name="view" value="text" /> txt -<a href="http://search.sisudoc.org" target="_top" ><search.sisudoc.org></a> +<a href="http://search.sisudoc.org" target="_top"><search.sisudoc.org></a> </form> <!-- Search SiSU --> </p> @@ -2061,6 +2071,7 @@ SiSU markup is fairly minimalistic, it consists of: a (largely optional) documen <a href="http://www.sisudoc.org/sisu/SiSU/"> <www.sisudoc.org/sisu/SiSU> </a> +</p> <p class="tiny"> SiSU was developed in relation to legal documents, and is strong across a wide variety of texts (law, literature...(humanities, law and part of the social sciences)). SiSU handles images but is not suitable for formulae/ statistics, or for technical writing at this time.</p> <p class="tiny"> diff --git a/lib/sisu/v3/param.rb b/lib/sisu/v3/param.rb index e2cffa9b..674b8cba 100644 --- a/lib/sisu/v3/param.rb +++ b/lib/sisu/v3/param.rb @@ -814,9 +814,31 @@ module SiSU_Param end end def texpdf_font - @h['texpdf_font'] && (@h['texpdf_font']=~/\S{3,}/) \ - ? @h['texpdf_font'] - : @env.font.texpdf + def main + @h['texpdf_font'] \ + && (@h['texpdf_font']=~/\S{3,}/) \ + ? @h['texpdf_font'] + : @env.font.texpdf.main + end + def sans # not used + @h['texpdf_font_sans'] \ + && (@h['texpdf_font_sans']=~/\S{3,}/) \ + ? @h['texpdf_font_sans'] + : @env.font.texpdf.sans + end + def serif # not used + @h['texpdf_font_serif'] \ + && (@h['texpdf_font_serif']=~/\S{3,}/) \ + ? @h['texpdf_font_serif'] + : @env.font.texpdf.serif + end + def mono + @h['texpdf_font_mono'] \ + && (@h['texpdf_font_mono']=~/\S{3,}/) \ + ? @h['texpdf_font_mono'] + : @env.font.texpdf.mono + end + self end def skin @h['skin'] diff --git a/lib/sisu/v3/sysenv.rb b/lib/sisu/v3/sysenv.rb index ed2d74dc..3ef176ec 100644 --- a/lib/sisu/v3/sysenv.rb +++ b/lib/sisu/v3/sysenv.rb @@ -216,13 +216,26 @@ module SiSU_Env @@default_dir=DEFAULT_DIR m=/.+\/(?:src\/)?(\S+)/m # m=/.+?\/(?:src\/)?([^\/]+)$/im # m=/.+\/(\S+)/m stub_pwd=@@pwd[m,1] - @@rc_path=["#{@@pwd}/_sisu/#{SiSU_version_dir}","#{@@pwd}/_sisu","#{@@home}/.sisu/#{SiSU_version_dir}","#{@@home}/.sisu","#{@@sisu_etc}/#{SiSU_version_dir}"] - @@yamlrc_path=["#{@@pwd}/_sisu/#{SiSU_version_dir}","#{@@pwd}/_sisu","#{@@home}/.sisu/#{SiSU_version_dir}","#{@@home}/.sisu","#{@@sisu_etc}/#{SiSU_version_dir}"] + @@rc_path=[ + "#{@@pwd}/.sisu/#{SiSU_version_dir}", + "#{@@pwd}/.sisu", + "#{@@pwd}/_sisu/#{SiSU_version_dir}", + "#{@@pwd}/_sisu", + "#{@@home}/.sisu/#{SiSU_version_dir}", + "#{@@home}/.sisu", + "#{@@sisu_etc}/#{SiSU_version_dir}", + ] + @@yamlrc_path=@@rc_path #@@yamlrc_path=(stub_pwd !~/^sisupod$/) \ #? (["#{@@pwd}/_sisu/#{SiSU_version_dir}","#{@@pwd}/_sisu","#{@@home}/.sisu/#{SiSU_version_dir}","#{@@home}/.sisu","#{@@sisu_etc}/#{SiSU_version_dir}"]) #: ["#{@@home}/.sisu/#{SiSU_version_dir}","#{@@home}/.sisu","#{@@sisu_etc}/#{SiSU_version_dir}"] #security policy: prevent reading of sisurc.yml in sisupod @@ad_path=(stub_pwd !~/^sisupod$/) \ - ? (["#{@@pwd}/_sisu/skin/yml","#{@@home}/.sisu/skin/yml","#{@@sisu_etc}/skin/yml"]) + ? ([ + "#{@@pwd}/.sisu/skin/yml", + "#{@@pwd}/_sisu/skin/yml", + "#{@@home}/.sisu/skin/yml", + "#{@@sisu_etc}/skin/yml", + ]) : ["#{@@home}/.sisu",@@sisu_etc] attr_accessor :user,:home,:hostname,:pwd,:host,:arch,:rbver,:dir_arch,:dir_sitearch,:dir_bin,:locale,:webserv_path,:webserv_host_cgi,:webserv_port_cgi,:default_dir,:rc_path,:yamlrc_path,:ad_path def initialize @@ -1516,10 +1529,31 @@ WOK end def font def texpdf - (defined? @rc['default']['texpdf_font']) \ - && (@rc['default']['texpdf_font']=~/\S{3,}/) \ - ? @rc['default']['texpdf_font'] - : 'Liberation Sans' #'Liberation Sans' #'Liberation Serif' + def main + (defined? @rc['default']['texpdf_font']) \ + && (@rc['default']['texpdf_font']=~/\S{3,}/) \ + ? @rc['default']['texpdf_font'] + : 'Liberation Sans' + end + def sans # not used + (defined? @rc['default']['texpdf_font_sans']) \ + && (@rc['default']['texpdf_font_sans']=~/\S{3,}/) \ + ? @rc['default']['texpdf_font_sans'] + : 'Liberation Sans' + end + def serif # not used + (defined? @rc['default']['texpdf_font_serif']) \ + && (@rc['default']['texpdf_font_serif']=~/\S{3,}/) \ + ? @rc['default']['texpdf_font_serif'] + : 'Liberation Serif' + end + def mono + (defined? @rc['default']['texpdf_font_mono']) \ + && (@rc['default']['texpdf_font_mono']=~/\S{3,}/) \ + ? @rc['default']['texpdf_font_mono'] + : 'Liberation Mono' + end + self end self end @@ -3363,13 +3397,19 @@ WOK @@filename_html_scroll=File.new(p_fn,'w+') end def html_seg_index - pth,fn="#{output_path.html.dir}/#{@md.fnb}",base_filename.html_seg_index + pth=(by_filename?) \ + ? "#{output_path.html.dir}" + : "#{output_path.html.dir}/#{@md.fnb}" + fn=base_filename.html_seg_index make_path(pth) p_fn=place_file.html_seg_index.dir @@filename_html_index=File.new(p_fn,'w+') end def html_segtoc - pth,fn="#{output_path.html.dir}/#{@md.fnb}",base_filename.html_segtoc + pth=(by_filename?) \ + ? "#{output_path.html.dir}" + : "#{output_path.html.dir}/#{@md.fnb}" + fn=base_filename.html_segtoc make_path(pth) p_fn=place_file.html_segtoc.dir @@filename_html_index=File.new(p_fn,'w+') diff --git a/lib/sisu/v3/texpdf_format.rb b/lib/sisu/v3/texpdf_format.rb index bf1c2a37..34169892 100644 --- a/lib/sisu/v3/texpdf_format.rb +++ b/lib/sisu/v3/texpdf_format.rb @@ -789,12 +789,32 @@ module SiSU_TeX_Pdf { mainlang: mainlang, otherlang: otherlang } end def tex_head_encode - texpdf_font=if defined? @md.make.texpdf_font \ - and not @md.make.texpdf_font.nil? \ - and @md.make.texpdf_font=~/\S{3,}/ - @md.make.texpdf_font - else @env.font.texpdf + texpdf_font=if defined? @md.make.texpdf_font.main \ + and not @md.make.texpdf_font.main.nil? \ + and @md.make.texpdf_font.main=~/\S{3,}/ + @md.make.texpdf_font.main + else @env.font.texpdf.main end + texpdf_font_sans=if defined? @md.make.texpdf_font.sans \ + and not @md.make.texpdf_font.sans.nil? \ + and @md.make.texpdf_font.sans=~/\S{3,}/ # not used + @md.make.texpdf_font.sans + else @env.font.texpdf.sans + end + texpdf_font_serif=if defined? @md.make.texpdf_font.serif \ + and not @md.make.texpdf_font.serif.nil? \ + and @md.make.texpdf_font.serif=~/\S{3,}/ # not used + @md.make.texpdf_font.serif + else @env.font.texpdf.serif + end + texpdf_font_mono=if defined? @md.make.texpdf_font.mono \ + and not @md.make.texpdf_font.mono.nil? \ + and @md.make.texpdf_font.mono=~/\S{3,}/ + @md.make.texpdf_font.mono + else @env.font.texpdf.mono + end + # you may wish to check selected font against avaiable fonts: + # fc-list :outline -f "%{family}\n" case @tex2pdf when /xe/ <<WOK @@ -802,6 +822,9 @@ module SiSU_TeX_Pdf \\setmainlanguage{#{tex_head_lang[:mainlang]}} \\setotherlanguage{#{tex_head_lang[:otherlang]}} \\setmainfont{#{texpdf_font}} +\\setmonofont[Scale=0.85]{#{texpdf_font_mono}} +% \\setsansfont{#{texpdf_font_sans}} +% \\setromanfont{#{texpdf_font_serif}} WOK when /pdf/ if @md.file_encoding =~ /iso-?8859/i #% iso8859 diff --git a/man/man1/sisu.1 b/man/man1/sisu.1 index 0b9a2fce..9a3e5535 100644 --- a/man/man1/sisu.1 +++ b/man/man1/sisu.1 @@ -1,4 +1,4 @@ -.TH "sisu" "1" "2011-07-26" "3.0.14-beta-rb1.9.2p180" "SiSU" +.TH "sisu" "1" "2011-10-03" "3.1.0" "SiSU" .br .SH NAME .br @@ -6,7 +6,7 @@ sisu \- documents: markup, structuring, publishing in multiple standard formats, .br .SH SYNOPSIS .br -sisu [\-abcDdFehIiMmNnopqRrSsTtUuVvwXxYyZz0\-9] [filename/wildcard] +sisu [\-abCcDdeFGghIikLMmNnoPpQqRrSsTtUuVvWwXxYyZ_0\-9] [filename/wildcard] .br sisu [\-Ddcv] [instruction] [filename/wildcard] @@ -15,13 +15,16 @@ sisu [\-Ddcv] [instruction] [filename/wildcard] sisu [\-CcFLSVvW] .br -sisu \-\-v2 [operations] +sisu [operations] .br sisu \-\-v3 [operations] .br -sisu3 [operations] +sisu \-\-v2 [operations] + +.br +sisu2 [operations] .SH SISU \- MANUAL, RALPH AMISSAH .br @@ -2277,10 +2280,10 @@ documents under consideration, and occasionally supported have been. << |filename.ssi|@|^| .fi -.SH MARKUP SYNTAX HISTORY +.SH 11. MARKUP SYNTAX HISTORY .br -.SH 11. NOTES RELATED TO FILES\-TYPES AND MARKUP SYNTAX +.SH 11.1 NOTES RELATED TO FILES\-TYPES AND MARKUP SYNTAX .br 2.0 introduced new headers and is therefore incompatible with 1.0 though @@ -2977,10 +2980,47 @@ Under consideration is to permit the placement of a CSS file with a different name in directory _sisu/css directory or equivalent, and change the default CSS file that is looked for in a skin.[^18] -.SH 17. ORGANISING CONTENT +.SH 17. ORGANISING CONTENT \- DIRECTORY STRUCTURE AND MAPPING .br -.SH 17.1 DIRECTORY STRUCTURE AND MAPPING +.br +.B SiSU +v3 has new options for the source directory tree, and output directory +structures of which there are 3 alternatives. + +.SH 17.1 DOCUMENT SOURCE DIRECTORY + +.br +The document source directory is the directory in which sisu processing +commands are given. It contains the sisu source files (.sst \.ssm \.ssi), or +(for sisu v3 may contain) subdirectories with language codes which contain the +sisu source files, so all English files would go in subdirectory en/, French in +fr/, Spanish in es/ and so on. ISO \... codes are usedr. A list of available +languages (and possible sub\-directory names) can be obtained with the command +"sisu \-\-help lang" The list of languages is limited to langagues supported by +XeTeX polyglosia. + +.SH 17.1.1 GENERAL DIRECTORIES + +.nf + ./subject_name/ + % files stored at this level e.g. sisu_manual.sst or + % for sisu v3 may be under language sub\-directories + % e.g. + ./subject_name/en + ./subject_name/fr + ./subject_name/es + ./subject_name/_sisu + % configuration file e.g. sisurc.yml + ./subject_name/_sisu/skin + % skins in various skin directories doc, dir, site, yml + ./subject_name/_sisu/css + ./subject_name/_sisu/image +.fi + +.SH 17.2 DOCUMENT OUTPUT DIRECTORY STRUCTURES + +.SH 17.2.1 OUTPUT DIRECTORY ROOT .br The output directory root can be set in the sisurc.yml file. Under the root, @@ -3008,6 +3048,102 @@ output directory. Skins could be associated with each institution on a directory basis and resulting documents will take on the appropriate different appearance. +.SH 17.2.2 ALTERNATIVE OUTPUT STRUCTURES + +.br +There are 3 possibile output structures described as being, by language, by +filetype or by filename, the selection is made in sisurc.yml + +.nf + #% output_dir_structure_by: language; filetype; or filename + output_dir_structure_by: language #(language & filetype, preferred?) + #output_dir_structure_by: filetype + #output_dir_structure_by: filename #(default, closest to original v1 & v2) +.fi + +.SH 17.2.3 BY LANGUAGE + +.br +The by language directory structure places output files + +.br +The by language directory structure separates output files by language code +(all files of a given language), and within the language directory by filetype. + +.br +Its selection is configured in sisurc.yml + +.br +output_dir_structure_by: language + +.br +#by: language subject_dir/en/manifest/filename.html + +.SH 17.2.4 BY FILETYPE + +.br +The by filetype directory structure separates output files by filetype, all +html files in one directory pdfs in another and so on. Filenames are given a +language extension. + +.br +Its selection is configured in sisurc.yml + +.br +output_dir_structure_by: filetype + +.br +#by: filetype subject_dir/html/filename/manifest.en.html + +.SH 17.2.5 BY FILENAME + +.br +The by filename directory structure places most output of a particular file +(the different filetypes) in a common directory. + +.br +Its selection is configured in sisurc.yml + +.br +output_dir_structure_by: filename + +.br +#by: filename subject_dir/filename/manifest.en.html + +.SH 17.2.6 REMOTE DIRECTORIES + +.nf + ./subject_name/ + % containing sub_directories named after the generated files from which they are made + ./subject_name/src + % contains shared source files text and binary e.g. sisu_manual.sst and sisu_manual.sst.zip + ./subject_name/_sisu + % configuration file e.g. sisurc.yml + ./subject_name/_sisu/skin + % skins in various skin directories doc, dir, site, yml + ./subject_name/_sisu/css + ./subject_name/_sisu/image + % images for documents contained in this directory + ./subject_name/_sisu/mm +.fi + +.SH 17.2.7 SISUPOD + +.nf + ./sisupod/ + % files stored at this level e.g. sisu_manual.sst + ./sisupod/_sisu + % configuration file e.g. sisurc.yml + ./sisupod/_sisu/skin + % skins in various skin directories doc, dir, site, yml + ./sisupod/_sisu/css + ./sisupod/_sisu/image + % images for documents contained in this directory + ./sisupod/_sisu/mm +.fi + +.SH 17.3 ORGANISING CONTENT + .SH 18. HOMEPAGES .br diff --git a/man/man1/sisu2.1 b/man/man1/sisu2.1 new file mode 120000 index 00000000..09708b31 --- /dev/null +++ b/man/man1/sisu2.1 @@ -0,0 +1 @@ +sisu.1
\ No newline at end of file |