diff options
authorRalph Amissah <>2011-10-04 01:19:05 +0000
committerRalph Amissah <>2011-10-04 01:19:05 +0000
commit85bd72367f0ef44287b7043598f8db60c090f1a1 (patch)
parentv2 v3: documentation, html, minor (removal of trailing whitespaces) (diff)
v2 v3: documenation, html, man2html (sisu.1)sisu_3.1.0
2 files changed, 303 insertions, 157 deletions
diff --git a/data/doc/sisu/CHANGELOG_v3 b/data/doc/sisu/CHANGELOG_v3
index f34737d..8c9faac 100644
--- a/data/doc/sisu/CHANGELOG_v3
+++ b/data/doc/sisu/CHANGELOG_v3
@@ -44,6 +44,7 @@
* documentation, small update
* sisu source
* manpage
+ * man2html html
%% 3.0.19.orig.tar.xz (2011-09-24:38/6);a=log;h=refs/tags/sisu-3.0.19
diff --git a/data/doc/sisu/html/sisu.1.html b/data/doc/sisu/html/sisu.1.html
index 33529bf..e973641 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>
-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>
@@ -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
<dd>produces plaintext with Unix linefeeds and without markup, (object numbers
are omitted), has footnotes at end of each paragraph that contains them
-[ &nbsp;-A &nbsp;for &nbsp;equivalent &nbsp;dos &nbsp;(linefeed) &nbsp;output &nbsp;file] [see &nbsp;-e &nbsp;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
+[ &nbsp;-A for &nbsp;equivalent &nbsp;dos &nbsp;(linefeed) &nbsp;output &nbsp;file] [see &nbsp;-e &nbsp;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 &nbsp;(*.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: &nbsp;the &nbsp;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.
&lt;&lt; |filename.ssi|@|^|
-<h2><a name='sect43' href='#toc43'>Markup Syntax History</a></h2>
+<h2><a name='sect43' href='#toc43'>11. Markup Syntax History</a></h2>
-<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>
<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]
-<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>
+<p> <br>
+<b>SiSU</b> v3 has new options for the source directory tree, and output directory
+structures of which there are 3 alternatives.
+<h2><a name='sect66' href='#toc66'>17.1 Document Source Directory</a></h2>
-<h2><a name='sect66' href='#toc66'>17.1 Directory Structure and Mapping</a></h2>
+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.
+<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
+<h2><a name='sect68' href='#toc68'>17.2 Document Output Directory Structures</a></h2>
+<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.
-<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 &amp; filetype, preferred?)
+ #output_dir_structure_by: filetype
+ #output_dir_structure_by: filename #(default, closest to original v1
+&amp; v2)
+<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
+<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
+<h2><a name='sect73' href='#toc73'>17.2.5 by Filename</a></h2>
+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
+<h2><a name='sect74' href='#toc74'>17.2.6 Remote Directories</a></h2>
+<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
+ ./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
+<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
+<h2><a name='sect76' href='#toc76'>17.3 Organising Content</a></h2>
+<h2><a name='sect77' href='#toc77'>18. Homepages</a></h2>
<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.
-<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>
-<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
-<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>
-<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 &lt;<a href=''></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.
-<h2><a name='sect72' href='#toc72'>20. Sisu Search - Introduction</a></h2>
+<h2><a name='sect82' href='#toc82'>20. Sisu Search - Introduction</a></h2>
<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.
-<h2><a name='sect73' href='#toc73'>21. Sql</a></h2>
+<h2><a name='sect83' href='#toc83'>21. Sql</a></h2>
-<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).
-<h2><a name='sect75' href='#toc75'>22. Postgresql</a></h2>
+<h2><a name='sect85' href='#toc85'>22. Postgresql</a></h2>
-<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
-<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
-<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 &nbsp;if &nbsp;required]<br>
@@ -2980,7 +3115,7 @@ sisu).
sisu -D --pg --[instruction] [filename/wildcard &nbsp;if &nbsp;required]<br>
-<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.
-<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>
@@ -3028,7 +3163,7 @@ of the same name).
<p> </dd>
-<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>
@@ -3051,17 +3186,17 @@ database.
<p> </dd>
-<h2><a name='sect82' href='#toc82'>23. Sqlite</a></h2>
+<h2><a name='sect92' href='#toc92'>23. Sqlite</a></h2>
-<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.
-<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).
-<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 &nbsp;if &nbsp;required]<br>
@@ -3079,7 +3214,7 @@ for <b>SiSU</b> to populate an sqlite database, this being part of <b>SiSU</b> -
-<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.
-<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>
@@ -3127,7 +3262,7 @@ of the same name).
<p> </dd>
-<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>
@@ -3150,11 +3285,11 @@ database.
<p> </dd>
-<h2><a name='sect89' href='#toc89'>24. Introduction</a></h2>
+<h2><a name='sect99' href='#toc99'>24. Introduction</a></h2>
-<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>
<p> <br>
@@ -3209,7 +3344,7 @@ SiSU_ebook is used. [otherwise &nbsp;a &nbsp;manual &nbsp;mapping &nbsp;for &nbs
<p> </dd>
-<h2><a name='sect91' href='#toc91'>24.2
+<h2><a name='sect101' href='#toc101'>24.2
Search Form</a></h2>
@@ -3246,17 +3381,17 @@ search form for use with the webrick server, which must be copied to the
<p> </dd>
-<h2><a name='sect92' href='#toc92'>25. Sisu_webrick</a></h2>
+<h2><a name='sect102' href='#toc102'>25. Sisu_webrick</a></h2>
-<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
-<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]
-<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).
-<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>
@@ -3288,7 +3423,7 @@ sisu_webrick, may be started on it&rsquo;s own with the command: sisu_webrick
<p>where no port is given and settings are unchanged the default port is 8081
-<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
-<h2><a name='sect98' href='#toc98'>25.6 Further Information</a></h2>
+<h2><a name='sect108' href='#toc108'>25.6 Further Information</a></h2>
@@ -3308,12 +3443,12 @@ For more information on <b>SiSU</b> see: &lt;<a href=''>h
<p>or man sisu
-<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 &lt;; or &lt;;
-<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 &lt;; or &lt;;
-<h2><a name='sect101' href='#toc101'>26. Remote Source Documents</a></h2>
+<h2><a name='sect111' href='#toc111'>26. Remote Source Documents</a></h2>
<p> <br>
@@ -3371,11 +3506,11 @@ way, see &lt;<a href=''>http://www.
&gt; and use the url for
the desired document.
-<h2><a name='sect102' href='#toc102'>Remote Document Output</a></h2>
+<h2><a name='sect112' href='#toc112'>Remote Document Output</a></h2>
-<h2><a name='sect103' href='#toc103'>27. Remote Output</a></h2>
+<h2><a name='sect113' href='#toc113'>27. Remote Output</a></h2>
<p> <br>
@@ -3390,7 +3525,7 @@ which may be used in conjunction with other processing flags, e.g.
<pre> sisu -3R sisu_remote.sst
-<h2><a name='sect104' href='#toc104'>27.1 Commands</a></h2>
+<h2><a name='sect114' href='#toc114'>27.1 Commands</a></h2>
@@ -3413,12 +3548,12 @@ ssh agent in place. Also see -R
<p> </dd>
-<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 &nbsp;on &nbsp;the &nbsp;setting &nbsp;up &nbsp;of &nbsp;an &nbsp;ssh-agent &nbsp;/ &nbsp;keychain]
-<h2><a name='sect106' href='#toc106'>28. Remote Servers</a></h2>
+<h2><a name='sect116' href='#toc116'>28. Remote Servers</a></h2>
<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.
-<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>
-<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.
-<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.
-<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 &nbsp;package &nbsp;name]<br>
-<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>
-<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
-<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
-<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
-<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>
@@ -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
-<h2><a name='sect116' href='#toc116'>29.3 Getting Help</a></h2>
+<h2><a name='sect126' href='#toc126'>29.3 Getting Help</a></h2>
-<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>
@@ -3704,7 +3839,7 @@ date as within the package itself:
* man directory &lt;<a href=''></a>
&gt; [^27]
-<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
-<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>
&lt;<a href=''></a>
@@ -3731,7 +3866,7 @@ date as within the package itself:
&lt;<a href=''></a>
-<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.
-<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>
<p> <br>
@@ -3920,7 +4055,7 @@ NOTE:
&nbsp;(without &nbsp;line-breaks) &nbsp;is &nbsp;a &nbsp;convenient editor &nbsp;feature &nbsp;to &nbsp;have &nbsp;for &nbsp;sisu &nbsp;markup]
-<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>
<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).
-<h2><a name='sect123' href='#toc123'>32. Summary of
+<h2><a name='sect133' href='#toc133'>32. Summary of
@@ -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.
-<h2><a name='sect124' href='#toc124'>33. Help Sources</a></h2>
+<h2><a name='sect134' href='#toc134'>33. Help Sources</a></h2>
-<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>
-<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]
-<h2><a name='sect127' href='#toc127'>33.2.1</a></h2>
+<h2><a name='sect137' href='#toc137'>33.2.1</a></h2>
<p> <br>
&lt;<a href=''></a>
@@ -4164,10 +4299,10 @@ may be also be accessed via the html pages[^29]
-<h2><a name='sect128' href='#toc128'>33.3 Man2html</a></h2>
+<h2><a name='sect138' href='#toc138'>33.3 Man2html</a></h2>
-<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]
-<h2><a name='sect130' href='#toc130'>33.3.2</a></h2>
+<h2><a name='sect140' href='#toc140'>33.3.2</a></h2>
<p> <br>
&lt;<a href=''></a>
@@ -4365,7 +4500,7 @@ while freely distributable are not freely changeable.
<p> </li>
-<h2><a name='sect131' href='#toc131'>See Also</a></h2>
+<h2><a name='sect141' href='#toc141'>See Also</a></h2>
<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>
-<h2><a name='sect132' href='#toc132'>Homepage</a></h2>
+<h2><a name='sect142' href='#toc142'>Homepage</a></h2>
More information about <b>SiSU</b> can be found at &lt;<a href=''><i></i></a>
&gt; or &lt;<a href=''><i></i></a>
-<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 &lt;<i></i>&gt;. <p>
@@ -4444,8 +4579,8 @@ More information about <b>SiSU</b> can be found at &lt;<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 &lt;<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</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</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</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</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>