From 0c872f4f046c394e15ab9b802c4226a0e9838aa3 Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Sat, 5 Mar 2011 15:10:16 -0500 Subject: html manpages, re-run man2html --- data/doc/sisu/html/sisu.1.html | 1509 +++++++++++++++++++++------------------- 1 file changed, 774 insertions(+), 735 deletions(-) (limited to 'data/doc/sisu/html/sisu.1.html') diff --git a/data/doc/sisu/html/sisu.1.html b/data/doc/sisu/html/sisu.1.html index 67867294..1a598784 100644 --- a/data/doc/sisu/html/sisu.1.html +++ b/data/doc/sisu/html/sisu.1.html @@ -18,20 +18,20 @@ sisu [-abcDdFehIiMmNnopqRrSsTtUuVvwXxYyZz0-9]

sisu [-CcFLSVvW]

sisu --v2 [operations] -

sisu --v1 [operations] SISU - MANUAL, -RALPH AMISSAH +

sisu --v3 [operations] +

sisu3 [operations] +SISU - MANUAL, RALPH AMISSAH

WHAT IS SISU?

1. INTRODUCTION - WHAT IS SISU? -

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

SiSU is developed under an -open source, software libre license (GPL3). Its use case for development +

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

SiSU is developed under +an open source, software libre license (GPL3). Its use case for development is work with medium to large document sets and cope with evolving document formats/ representation technologies. Documents are prepared once, and generated as need be to update the technical presentation or add additional output @@ -128,158 +128,159 @@ system to reliably reference its documents. SiSU works well in a compleme manner with such collaborative technologies as Wikis, which can take advantage of and be used to discuss the substance of content prepared in SiSU

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

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

2. COMMANDS SUMMARY -

2.1 DESCRIPTION -

SiSU SiSU -is a document publishing system, that from a simple single marked-up document, -produces multiple of output formats including: plaintext, html, xhtml, -XML, epub, odt (odf text), LaTeX, pdf, info, and SQL (PostgreSQL and SQLite), -which share numbered text objects ("object citation numbering") and the -same document structure information. For more see: <http://www.jus.uio.no/sisu +

2.1 + +

DESCRIPTION +

SiSU SiSU is a document publishing system, that from a simple +single marked-up document, produces multiple of output formats including: +plaintext, html, xhtml, XML, epub, odt (odf text), LaTeX, pdf, info, and +SQL (PostgreSQL and SQLite), which share numbered text objects ("object +citation numbering") and the same document structure information. For more +see: <http://www.jus.uio.no/sisu > -

2.2 DOCUMENT PROCESSING COMMAND FLAGS

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

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

-
--color-toggle -[filename/wildcard]
-
screen toggle ansi screen colour on or off depending -on default set (unless -c flag is used: if sisurc colour default is set -to ’true’, output to screen will be with colour, if sisurc colour default -is set to ’false’ or is undefined screen output will be without colour). Alias +
--color-toggle [filename/wildcard]
+
screen toggle +ansi screen colour on or off depending on default set (unless -c flag is +used: if sisurc colour default is set to ’true’, output to screen will be +with colour, if sisurc colour default is set to ’false’ or is undefined screen +output will be without colour). Alias -c +

-

- -

c +

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

-
--concordance [filename/wildcard]
-
produces concordance (wordmap) a rudimentary -index of all the words in a document. (Concordance files are not generated -for documents of over 260,000 words unless this limit is increased in the -file sisurc.yml). Alias -w +
-C +[--init-site]
+
configure/initialise shared output directory files initialize +shared output directory (config files such as css and dtd files are not +updated if they already exist unless modifier is used). -C --init-site configure/initialise +site more extensive than -C on its own, shared output directory files/force +update, existing shared output config files such as css and dtd files are +updated if this modifier is used.

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

-
-CC
-
configure/initialise shared output directory files initialize -shared output directory (config files such as css and dtd files are not -updated if they already exist unless modifier is used). The equivalent of: --C --init-site configure/initialise site, more extensive than -C on its own, -shared output directory files/force update, existing shared output config -files such as css and dtd files are updated if -CC is used. +
-c [filename/wildcard]
+
see --color-toggle

-
-c [filename/wildcard] +
--dal [filename/wildcard/url]
-
-

see --color-toggle +

assumed for most other flags, creates new intermediate files for processing +(document abstraction) that is used in all subsequent processing of other +output. This step is assumed for most processing flags. To skip it see -n. + +

Alias -m

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

-
--delete [filename/wildcard] +
-D [instruction] [filename]
-

see --zap +

see --pg

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

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

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

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

-
-e [filename/wildcard] +
-F [--webserv=webrick]
-

see --epub +

see --sample-search-form

-
-F [--webserv=webrick]
-
see --sample-search-form -

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

Alias -g

-g [filename/wildcard]
see --git

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

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

license +

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

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

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

-
-I [filename/wildcard] +
-h [filename/wildcard]
-

see --texinfo +

see --html +

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

-i [filename/wildcard]
@@ -288,83 +289,102 @@ file (scroll.html). Alias -h
-L
prints license information. -

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

-
--maintenance [filename/wildcard/url]
-
maintenance mode files created for -processing preserved and their locations indicated. (also see -V). Alias -M - +
--maintenance [filename/wildcard/url] +
+
maintenance mode files created for processing preserved and their locations +indicated. (also see -V). Alias -M

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

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

see --maintenance

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

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

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

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

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

see --odt +

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

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

- +

o

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

--pdf [filename/wildcard]
-
produces LaTeX pdf (portrait.pdf & landscape.pdf). -Default paper size is set in config file, or document header, or provided -with additional command line parameter, e.g. --papersize-a4 preset sizes include: -’A4’, U.S. ’letter’ and +
produces +LaTeX pdf (portrait.pdf & landscape.pdf). Default paper size is set in config +file, or document header, or provided with additional command line parameter, +e.g. --papersize-a4 preset sizes include: ’A4’, U.S. ’letter’ and +

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

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

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

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

-p [filename/wildcard]
@@ -438,8 +458,8 @@ below. Alias -d files including sisu markup source files and the directories local configuration file, images and skins. Note: this only includes the configuration files or skins contained in ./_sisu not those in ~/.sisu -S [filename/wildcard] -option. Note: (this
- option is tested only with zsh). Alias -S +option. Note: (this option
+ is tested only with zsh). Alias -S

--sisupod [filename/wildcard]
@@ -490,47 +510,43 @@ file to output directory. Alias -s
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  -A endnotes]. (Options +include: --endnotes for endnotes --footnotes for footnotes at the end of each +paragraph --unix for unix linefeed (default) --msdos for msdos linefeed). Alias + +

- +

t

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

-

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

preprocessing feature +

-t [filename/wildcard]
see --txt

-
--urls [filename/wildcard]
-
prints url output -list/map for the available processing flags options and resulting files -that could be requested, (can be used to get a list of processing options -in relation to a file, together with information on the output that would -be produced), -u provides url output mapping for those flags requested for -processing. The default assumes sisu_webrick is running and provides webrick -url mappings where appropriate, but these can be switched to file system -paths in sisurc.yml. Alias -U +
--urls [filename/wildcard] +
+
prints url output list/map for the available processing flags options and +resulting files that could be requested, (can be used to get a list of +processing options in relation to a file, together with information on +the output that would be produced), -u provides url output mapping for those +flags requested for processing. The default assumes sisu_webrick is running +and provides webrick url mappings where appropriate, but these can be switched +to file system paths in sisurc.yml. Alias -U

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

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

also see -U

-
--v1 [filename/wildcard]
-
invokes the sisu v1 document parser/generator. -For use with sisu v1 markup documents. (Markup conversion to v2 involves -the modification of document headers) +
-u [filename/wildcard]
+
provides url mapping of output files for the flags +requested for processing, also see -U

--v2 [filename/wildcard]
@@ -539,75 +555,79 @@ sisu v2 document parser/generator. This is the default and is normally omitted.

-

--verbose [filename/wildcard]
-
provides verbose output of what is being generated, -where output is placed (and error messages if any), as with -u flag provides -a url mapping of files created for each of the processing flag requests. +
--v3 [filename/wildcard]
+
invokes the sisu v3 document parser/generator. Currently +under development and incomplete, v3 requires >= ruby1.9.2p180. You may run +sisu3 instead. +

-

Alias -v +

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

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

-V [filename/wildcard]
-
even more verbose than the -v flag. - +
even more +verbose than the -v flag.

-v
on its own, provides SiSU version information +

-
-v [filename/wildcard] -
-
-

see --verbose +

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

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

-W
see --webrick

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

see --concordance +

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

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

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

-
--xml-dom -[filename/wildcard]
-
produces XML output with deep document structure, in -the nature of dom. Alias -X +
--xhtml [filename/wildcard]
+
produces xhtml/XML output for browser viewing +(sax parsing). Alias -b

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

-
-X [filename/wildcard]
-
see --xml-dom +
--xml-sax [filename/wildcard] +
+
produces XML output shallow structure (sax parsing). Alias -x +

+
-X [filename/wildcard] +
+
+

see --xml-dom

-x [filename/wildcard]
@@ -615,8 +635,8 @@ shallow structure (sax parsing). Alias -x

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

@@ -682,60 +702,60 @@ modifiable with --db=[database  type  (pgsql  or  sqlite)]
initial step, creates required relations (tables, indexes) in existing postgresql database (a database should be created manually and given the same name -as working directory, as requested) (rb.dbi) [  -dv  --createall sqlite  equivalent] -it may be necessary to run sisu -Dv --createdb initially NOTE: at the present -time for postgresql it may be necessary to manually create the database. -The command would be ’createdb [database  name]’ where database name would -be SiSU_[present  working  directory  name (without  path)]. Please use only -alphanumerics and underscores. +as working directory, as requested) (rb.dbi) [  -dv  --createall it may be necessary +to run sisu -Dv --createdb initially NOTE: at the present time for postgresql +it may be necessary to manually create the database. The command would be +’createdb [database  name]’ where database name would be SiSU_[present  working + directory  name  (without  path)]. Please use only alphanumerics and underscores. +

--pg -v --import
-
[filename/wildcard] imports -data specified to postgresql db (rb.dbi) [  -dv  --import  sqlite  equivalent] - +
[filename/wildcard] imports data specified to postgresql db +(rb.dbi) [  -dv  --import  sqlite  equivalent]

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

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

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

The -v is for verbose output.

-5. SHORTCUTS, -SHORTHAND FOR MULTIPLE FLAGS +5. SHORTCUTS, SHORTHAND FOR MULTIPLE FLAGS +

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

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

-0
-
-mNhwpAobxXyYv [this  is  the - default  action  run  when  no  i.e.  on  ’sisu  [filename]’] +
-mNhwpAobxXyYv [this  is  the  default  action  run  when + no  i.e.  on  ’sisu  [filename]’]

-1
@@ -744,7 +764,6 @@ changed/configured in the sisurc.yml file):
-2
-mhewpaoy -

-3
@@ -752,38 +771,43 @@ changed/configured in the sisurc.yml file):

-4
-
-mhewpAobxXDyY --import +
-mhewpAobxXDyY + +

- +

- +

import

-5
-mhewpAobxXDyY --update -

add -v -for verbose mode and -c for color, e.g. sisu -2vc [filename  or -

consider -u +

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

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

for appended url info or -v for verbose output +

output

-5.1 COMMAND LINE WITH FLAGS -- BATCH PROCESSING -

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

Running sisu (alone without any flags, filenames or wildcards) -brings up the interactive help, as does any sisu command that is not recognised. -Enter to escape. +5.1 COMMAND LINE WITH FLAGS - BATCH PROCESSING +

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

Running sisu (alone without +any flags, filenames or wildcards) brings up the interactive help, as does +any sisu command that is not recognised. Enter to escape.

6. HELP -

6.1 SISU MANUAL -

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

6.1 SISU + +

MANUAL +

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

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

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

./data/doc/sisu/v2/sisu_markup_samples/sisu_manual/
+

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

/usr/share/doc/sisu/v2/sisu_markup_samples/sisu_manual/
+

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

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

sisu sisu_manual.ssm
@@ -800,15 +824,15 @@ should be available, try:

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

./data/doc/sisu/v2/sisu_markup_samples/sisu_manual/
+

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

Once installed, directory equivalent to: -

/usr/share/doc/sisu/sisu_manual/
+

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

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

/usr/share/doc/sisu/v2/html/
+

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

./data/doc/sisu/v2/html/
+

./data/doc/sisu/html

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

* various @@ -851,6 +875,9 @@ see:

man2html

/usr/share/doc/sisu/v2/html/sisu.1.html
+

sisu generated html +

/usr/share/doc/sisu/html/sisu_help_sources/index.html
+

<http://sisudoc.org/sisu/sisu_help_sources/index.html >
@@ -982,17 +1009,18 @@ that has a header similar to this one:

Header tags appear at the beginning of a document and provide meta information on the document (such as the Dublin Core), or information as to how the document as a whole is to be processed. All -header instructions take either the form @headername: or 0~headername. All +header instructions take the form @headername: or on the next line and +indented by once space :subheadername: All Dublin Core meta tags are available -

Dublin Core meta tags are available

@indentifier: information or instructions +

where the "identifier" is +a tag recognised by the program, and the "information" or "instructions" + +

belong to the tag/indentifier specified +

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

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

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

This is a sample header


@@ -1040,7 +1068,7 @@ and can be useful to know. :pg:  [Project  Gutenberg  text  number]


-

  @links: { SiSU }http://www.jus.uio.no/sisu/
+
  @links: { SiSU }http://www.sisudoc.org
     { FSF }http://www.fsf.org
 


@@ -1072,21 +1100,22 @@ by other heading levels, and 1 -6 being headings followed by substantive text or sub-headings. :A~ usually the title :A~? conditional level 1 heading (used where a stand-alone document may be imported into another)

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

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

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

1~ [heading  text] Top level heading preceding substantive text of document -or sub-heading 2, the heading level that would normally be marked 1. or 2. -or 3. etc. in a document, and the level on which sisu by default would break -html output into named segments, names are provided automatically if none -are given (a number), otherwise takes the form 1~my_filename_for_this_segment + text] Top level heading [this  usually  has  similar  content  to  the title + @title:  ] NOTE: the heading levels described here are in 0.38 notation, + +

see heading +

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

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

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

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

3~ [heading  text] Third level heading preceding substantive text of document, that would normally be @@ -1106,13 +1135,14 @@ html


  normal text,  *{emphasis}*, !{bold text}!, /{italics}/, _{underscore}_,
 "{citation}",
-  ^{superscript}^, ,{subscript},, +{inserted text}+, -{strikethrough}- #{monospace}#
+  ^{superscript}^, ,{subscript},, +{inserted text}+, -{strikethrough}-, #{monospace}#
   normal text
-  !{emphasis}!
-  *{bold text}*
+  *{emphasis}*  [note:  can  be  configured  to  be  represented  by  bold,  italics
+ or  underscore]
+  !{bold text}!
   _{underscore}_
   /{italics}/
-
+  "{citation}"
   ^{superscript}^
   ,{subscript},
   +{inserted text}+
@@ -1120,12 +1150,13 @@ html
   #{monospace}#
 

resulting output: -

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

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

monospace

normal text -

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

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

bold text

italics

underscore @@ -1177,10 +1208,11 @@ html _# numbered list numbered list indented a., b., c., d., etc.

9.4 FOOTNOTES / ENDNOTES -

Footnotes and endnotes not distinguished in -markup. They are automatically numbered. Depending on the output file format -(html, EPUB, odf, pdf etc.), the document output selected will have either -footnotes or endnotes. +

Footnotes and endnotes are marked up at the +location where they would be indicated within a text. They are automatically +numbered. The output type determines whether footnotes or endnotes will + +

be produced

markup example:


@@ -1221,7 +1253,7 @@ asterisks if required }~ continues

Alternative endnote pair notation for footnotes/endnotes:


-

  % note the endnote marker
+
  % note the endnote marker "~^"
   normal text~^ continues
   ^~ endnote text following the paragraph in which the marker occurs
 
@@ -1239,10 +1271,10 @@ is omitted).

markup example:


-

  normal text http://www.jus.uio.no/sisu continues
+
  normal text http://www.sisudoc.org/ continues
 

resulting output: -

normal text <http://www.jus.uio.no/sisu +

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

An @@ -1250,70 +1282,74 @@ is omitted).

markup example:


-

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

resulting output: -

normal text <_http://www.jus.uio.no/sisu +

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

-deb <_http://www.jus.uio.no/sisu/archive +

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

where a code -block is used there is neither decoration nor hyperlinking, code blocks +

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

are discussed later in this document +

later in this document

resulting output:


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

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

markup example: +

9.5.2 LINKING TEXT +

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

follows +

markup example:


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

9.5.2 LINKING TEXT

resulting output: -

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

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

A shortcut -

markup -

A shortcut notation is available so the url link may also be provided +

notation is available so the url link may also be provided automatically -

automatically as a footnote +

as a footnote

markup example:


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

resulting output: -

abou tSiSU <http://www.jus.uio.no/sisu/ +

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

+

9.5.3 -

9.5.3 LINKING IMAGES +

LINKING IMAGES

markup example:


  { tux.png 64x80 }image
   % various url linked images
-  {tux.png 64x80
-  {GnuDebianLinuxRubyBetterWay.png 100x101
-  {~^ ruby_logo.png
+  {tux.png 64x80 "a better way" }http://www.sisudoc.org/
+  {GnuDebianLinuxRubyBetterWay.png 100x101 "Way Better - with Gnu/Linux,
+Debian and Ruby" }http://www.sisudoc.org/
+  {~^ ruby_logo.png "Ruby" }http://www.ruby-lang.org/en/
 

resulting output:

[ tux.png ] -

tux.png 64x80 -

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

GnuDebianLinuxRubyBetterWay.png 100x101 and Ruby -

linked url footnote +

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

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

GnuDebianLinuxRubyBetterWay.png +100x101 "Way Better - with Gnu/Linux, Debian and Ruby" <http://www.jus.uio.no/sisu/ +> -

shortcut +

linked url footnote shortcut


  {~^  [text  to  link] }http://url.org
@@ -1347,7 +1383,7 @@ auto-heading numbering, without further intervention.
   }table
 

resulting output: -

 [table  omitted,  see  other  document  formats]
+

[table omitted, see other document formats]

a second form may be easier to work with in cases where there is not @@ -1375,7 +1411,7 @@ auto-heading numbering, without further intervention.

resulting output:

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

 [table  omitted,  see  other  document  formats]
+

[table omitted, see other document formats]

* Contributed at least ten times; ** at least 5 times in last month; *** more than 100 times in last month. @@ -1386,7 +1422,7 @@ auto-heading numbering, without further intervention.

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

markup example:

@@ -1396,7 +1432,7 @@ auto-heading numbering, without further intervention. mouse, That he met in the house, - + "Let us both go to law: I will prosecute @@ -1408,10 +1444,10 @@ auto-heading numbering, without further intervention. really this morning I’ve nothing - to do. + to do." Said the mouse to the - cur, + cur, "Such a trial, dear Sir, With @@ -1420,14 +1456,14 @@ auto-heading numbering, without further intervention. would be wasting our - breath. - + breath." + "I’ll be judge, I’ll - be jury, + be jury," Said cunning old Fury: - + "I’ll try the whole cause, @@ -1435,15 +1471,15 @@ auto-heading numbering, without further intervention. condemn you to - death. + death."’ }poem

resulting output: -

’Fury said to a
+

‘Fury said to a
mouse, That he
met in the
house,
-
+ "Let us
both go to
law: I will
prosecute
@@ -1455,10 +1491,10 @@ auto-heading numbering, without further intervention. really this
morning I’ve
nothing
- to do.
+ to do."
Said the
mouse to the
- cur,
+ cur, "Such
a trial,
dear Sir,
With
@@ -1467,14 +1503,14 @@ auto-heading numbering, without further intervention. would be
wasting
our
- breath.
-
+ breath."
+ "I’ll be
judge, I’ll
- be jury,
+ be jury,"
Said
cunning
old Fury:
-
+ "I’ll
try the
whole
cause,
@@ -1482,7 +1518,7 @@ auto-heading numbering, without further intervention. condemn
you
to
- death.
+ death."’

9.6.3 GROUP

basic markup: @@ -1501,7 +1537,7 @@ auto-heading numbering, without further intervention. mouse, That he met in the house, - + "Let us both go to law: I will prosecute @@ -1513,10 +1549,10 @@ auto-heading numbering, without further intervention. really this morning I’ve nothing - to do. + to do." Said the mouse to the - cur, + cur, "Such a trial, dear Sir, With @@ -1525,14 +1561,14 @@ auto-heading numbering, without further intervention. would be wasting our - breath. - + breath." + "I’ll be judge, I’ll - be jury, + be jury," Said cunning old Fury: - + "I’ll try the whole cause, @@ -1540,15 +1576,15 @@ auto-heading numbering, without further intervention. condemn you to - death. + death."’ }group

resulting output: -

’Fury said to a
+

‘Fury said to a
mouse, That he
met in the
house,
-
+ "Let us
both go to
law: I will
prosecute
@@ -1560,10 +1596,10 @@ auto-heading numbering, without further intervention. really this
morning I’ve
nothing
- to do.
+ to do."
Said the
mouse to the
- cur,
+ cur, "Such
a trial,
dear Sir,
With
@@ -1572,14 +1608,14 @@ auto-heading numbering, without further intervention. would be
wasting
our
- breath.
-
+ breath."
+ "I’ll be
judge, I’ll
- be jury,
+ be jury,"
Said
cunning
old Fury:
-
+ "I’ll
try the
whole
cause,
@@ -1587,26 +1623,25 @@ auto-heading numbering, without further intervention. condemn
you
to
- death.
+ death."’

9.6.4 CODE -

Code tags are used to escape regular sisu markup, and have -been used extensively within this document to provide examples of SiSU -markup. You cannot however use code tags to escape code tags. They are however -used in the same way as group or poem tags. -

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

Code tags code{ ... }code (used as with other group tags described +above) are used to escape regular sisu markup, and have been used extensively +within this document to provide examples of SiSU markup. You cannot however +use code tags to escape code tags. They are however used in the same way +as group or poem tags. +

A code-block is treated as an object and given a +single object number. [an some  later  time]

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


-

                      ’Fury said to a
+
                      ‘Fury said to a
                      mouse, That he
                    met in the
                  house,
-
+              "Let us
                 both go to
                   law:  I will
                     prosecute
@@ -1618,10 +1653,10 @@ poem compared, resulting output:
                 really this
              morning I’ve
             nothing
-           to do.
+           to do."
              Said the
                mouse to the
-                 cur,
+                 cur, "Such
                    a trial,
                      dear Sir,
                            With
@@ -1630,14 +1665,14 @@ poem compared, resulting output:
                   would be
                 wasting
                our
-                breath.
-
+                breath."
+                 "I’ll be
                    judge, I’ll
-                     be jury,
+                     be jury,"
                            Said
                       cunning
                         old Fury:
-
+                       "I’ll
                         try the
                            whole
                             cause,
@@ -1645,7 +1680,56 @@ poem compared, resulting output:
                           condemn
                          you
                         to
-                         death.
+                         death."’
+
+

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

+


+

1  |                      ‘Fury said to a
+2  |                     mouse, That he
+3  |                   met in the
+4  |                 house,
+5  |              "Let us
+6  |                both go to
+7  |                  law:  I will
+8  |                    prosecute
+9  |                      YOU.  --Come,
+10 |                         I’ll take no
+11 |                          denial; We
+12 |                       must have a
+13 |                   trial:  For
+14 |                really this
+15 |             morning I’ve
+16 |            nothing
+17 |           to do."
+18 |             Said the
+19 |               mouse to the
+20 |                 cur, "Such
+21 |                   a trial,
+22 |                     dear Sir,
+23 |                           With
+24 |                       no jury
+25 |                    or judge,
+26 |                  would be
+27 |                wasting
+28 |               our
+29 |                breath."
+30 |                 "I’ll be
+31 |                   judge, I’ll
+32 |                     be jury,"
+33 |                           Said
+34 |                      cunning
+35 |                        old Fury:
+36 |                       "I’ll
+37 |                        try the
+38 |                           whole
+39 |                            cause,
+40 |                               and
+41 |                          condemn
+42 |                         you
+43 |                        to
+44 |                         death."’
 

9.7 BOOK INDEX

To make an index append to paragraph the book index term @@ -1737,16 +1821,17 @@ of documents under consideration, and occasionally supported have been.

MARKUP SYNTAX HISTORY

11. NOTES RELATED TO FILES-TYPES AND MARKUP SYNTAX -

0.38 is substantially current, depreciated 0.16 supported, though file - -

names were changed at 0.37 -

* sisu --query=[sisu  version  [0.38] or ’history] +

2.0 introduced new headers and is therefore incompatible with 1.0 though +otherwise the same with the addition of a couple of tags (i.e. a superset) +

0.38 is substantially current for version 1.0 +

* sisu --query=[sisu  version + [0.38] or ’history]

provides a short history of changes to SiSU markup -

0.57 (2007w34/4) -SiSU 0.57 is the same as 0.42 with the introduction of some a shortcut to -use the headers @title and @creator in the first heading [expanded  using - the  and  @author:] + +

0.57 (2007w34/4) SiSU 0.57 is the same as 0.42 with the introduction of +some a shortcut to use the headers @title and @creator in the first heading +[expanded  using  the  and  @author:]


  :A~ @title by @author
@@ -1876,30 +1961,30 @@ may be located locally or on a remote server for which a url is provided.
 

12.1.1 SISU TEXT - REGULAR FILES (.SST)

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

<http://www.jus.uio.no/sisu/sisu_markup +

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

<http://www.jus.uio.no/sisu/sisu_manual +

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

12.1.2 SISU MASTER FILES (.SSM) -

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

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

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

Note: a secondary file of the composite document -is built prior to processing with the same prefix and the suffix ._sst [^17] - -

<http://www.jus.uio.no/sisu/sisu_markup +

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

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

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

Note: a secondary file +of the composite document is built prior to processing with the same prefix +and the suffix ._sst [^17] +

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

<http://www.jus.uio.no/sisu/sisu_manual +

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

12.1.3 SISU INSERT FILES (.SSI) @@ -1935,10 +2020,10 @@ sisu -S

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

<http://www.jus.uio.no/sisu/sisu_commands +

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

<http://www.jus.uio.no/sisu/sisu_manual +

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

13. EXPERIMENTAL ALTERNATIVE INPUT REPRESENTATIONS @@ -2082,17 +2167,17 @@ and symbolic links as needed from the site, or dir directories as required.

With SiSU installed sample skins may be found in:

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

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

/usr/share/doc/sisu-markup-samples/v2/samples/_sisu/skin/doc
+

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

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

/usr/share/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/yml -(or equivalent
- directory)
+

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

16. CSS - CASCADING STYLE SHEETS (FOR HTML, XHTML AND XML)

CSS files @@ -2201,47 +2286,42 @@ index.html and document output samples are provided at <http://www.jus.uio.no/sisu/SiSU/examples.html > -

Some markup with syntax highlighting may be found under <http://www.jus.uio.no/sisu/sample/syntax -> -but is not as up to date. -

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

20. -SISU SEARCH - INTRODUCTION -

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

Because the document structure of sites created is clearly defined, and -the text object citation system is available hypothetically at least, for -all forms of output, it is possible to search the sql database, and either -read results from that database, or just as simply map the results to the -html output, which has richer text markup. -

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

21. SQL +

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

20. SISU SEARCH - INTRODUCTION + +

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

Because the document structure +of sites created is clearly defined, and the text object citation system +is available hypothetically at least, for all forms of output, it is possible +to search the sql database, and either read results from that database, +or just as simply map the results to the html output, which has richer +text markup. +

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

21. +SQL

21.1 POPULATING SQL TYPE DATABASES - -

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

This is one of the more interesting output forms, as all the -structural data of the documents are retained (though can be ignored by -the user of the database should they so choose). All site texts/documents -are (currently) streamed to four tables: -

* one containing semantic -(and other) headers, including, title, author,
+

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

This is one of the more +interesting output forms, as all the structural data of the documents are +retained (though can be ignored by the user of the database should they +so choose). All site texts/documents are (currently) streamed to four tables: + +

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

* another the substantive texts by individual "paragraph" (or object) --
- along with structural information, each paragraph being identifiable -by its
+- along
+ with structural information, each paragraph being identifiable by its
paragraph number (if it has one which almost all of them do), and the
substantive text of each paragraph quite naturally being searchable (both in
@@ -2371,8 +2451,7 @@ to populate an sqlite database, this being part of SiSU - man sisu).

SYNOPSIS

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

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

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

23.4 COMMANDS

Mappings to two databases are provided by default, postgresql @@ -2560,8 +2639,8 @@ be desirable to exclude files ’plain.txt’, ’toc.html’ an these duplicate information held in other html output e.g.

find /home/ralph/sisu_www -type f | egrep
- ’/sisu_www/(sisu|bookmarks)/.+?.html$’ | egrep -v
- ’(doc|concordance).html$’ |estcmd gather -sd casket -
+ ’/sisu_www/(sisu|bookmarks)/.+?.html$’ | egrep -v ’(doc|concordance).html$’
+ |estcmd gather -sd casket -

from your current document preparation/markup directory, you would construct a rune along the following lines: @@ -2585,7 +2664,7 @@ and set file permissions to 755:

[see  estraier  documentation  for  paths]

(ii) edit estseek.conf, with attention to the lines starting ’indexname:’ -and ’replace:’: +and

indexname: /home/ralph/sisu_www/casket

replace: ^file:///home/ralph/sisu_www{{!}}http://localhost @@ -2611,37 +2690,38 @@ and ’replace:’:

26.3 DESCRIPTION

sisu_webrick is part of SiSU (man sisu) sisu_webrick -starts Ruby ’s Webrick web-server and points it to the directories to which -SiSU output is written, providing a list of these directories (assuming -SiSU is in use and they exist). -

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

The default port for sisu_webrick +is set to 8081, this may be modified in the yaml file: ~/.sisu/sisurc.yml +a sample of which is provided as /etc/sisu/sisurc.yml (or in the equivalent +directory on your system).

26.4 SUMMARY OF MAN PAGE -

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

where no port is given and settings are +

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

where no port is given and -

unchanged the default port is 8081 -

26.5 DOCUMENT PROCESSING COMMAND FLAGS +

settings are unchanged the default port is 8081 +

26.5 DOCUMENT PROCESSING -

sisu -W [port] starts Ruby Webrick web-server, serving SiSU output directories, -on the port provided, or if no port is provided and the defaults have not +

COMMAND FLAGS +

sisu -W [port] starts Ruby Webrick web-server, serving SiSU +output directories, on the port provided, or if no port is provided and -

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

26.6 FURTHER INFORMATION +

the defaults have not been changed in ~/.sisu/sisurc.yaml then on port 8081 -

For more information on SiSU see: <http://www.jus.uio.no/sisu +

26.6 FURTHER INFORMATION +

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

or man sisu -

26.7 AUTHOR -

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

+

Ralph Amissah ralph@amissah.com -

26.8 SEE ALSO +

or ralph.amissah@gmail.com +

26.8 SEE ALSO

sisu(1)
@@ -2669,19 +2749,19 @@ parts (such as images) will be downloaded and generated locally.

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

NOTE: to set up a remote machine to serve SiSU -documents in this way, images should be in the directory relative to the +to the .sst for the desired document.
+ +

NOTE: to set up a remote machine to serve SiSU documents in this way, + +

images should be in the directory relative to the document source ../_sisu/image -

document source ../_sisu/image

sisupod - zipped sisu files -

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

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

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

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


  sisu -3 http://[provide  url  to  valid  sisupod.zip  or  .ssp  file]
@@ -2711,40 +2791,40 @@ may be used in conjunction with other processing flags, e.g.
 
-R [filename/wildcard]
copies sisu output files to remote host using rsync. This requires that sisurc.yml has been provided with information -on hostname and username, and that you have your different if -R is used -with other flags from if used alone. Alone the rsync --delete parameter is -sent, useful for cleaning the remote directory (when -R is used together -with other flags, it is not). Also see -r +on hostname and username, and that you have your "keys" and ssh agent in +place. Note the behavior of rsync different if -R is used with other flags +from if used alone. Alone the rsync --delete parameter is sent, useful for +cleaning the remote directory (when -R is used together with other flags, +it is not). Also see -r

-r [filename/wildcard]
-
copies sisu -output files to remote host using scp. This requires that sisurc.yml has -been provided with information on hostname and username, and that you have - -

your +

copies sisu output files to +remote host using scp. This requires that sisurc.yml has been provided with +information on hostname and username, and that you have your "keys" and +ssh agent in place. Also see -R

28.2 CONFIGURATION -

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

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

29. REMOTE SERVERS -

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

30. QUICKSTART - GETTING STARTED HOWTO - +

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

30. +QUICKSTART - GETTING STARTED HOWTO

30.1 INSTALLATION -

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

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

30.1.1 DEBIAN INSTALLATION - -

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

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


    aptitude update
@@ -2757,7 +2837,6 @@ markup samples:
 
  #/etc/apt/sources.list
     deb http://ftp.fi.debian.org/debian/ unstable main non-free contrib
     deb-src http://ftp.fi.debian.org/debian/ unstable main non-free contrib
-  d
 

The aptitude commands become:

@@ -2832,10 +2911,11 @@ the root directory of the unpacked SiSU as root type:

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

-

The root directory of the unpacked SiSU as root type: -

ruby install -base
+

install +

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

ruby +install base

or for a more complete installation:

ruby install
@@ -2848,8 +2928,7 @@ has been configured to do post installation setup setup configuration and generation of first test file. Note however, that additional external package dependencies, such as tetex-extra are not taken care of for you.

Further - -

information on +information on "rant" is available from:

<http://make.rubyforge.org/ >
@@ -2921,10 +3000,10 @@ create the database and write to it when you run sisu.

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

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

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

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

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

* man directory <http://www.jus.uio.no/sisu/man @@ -2940,29 +3019,35 @@ to date as within the package itself:

sisu --help --markup

30.3.3 THE HOME PAGE

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

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

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

30.4 MARKUP SAMPLES -

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

30.4 MARKUP SAMPLES +

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

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

Additional markup samples are packaged separately in the file: +

Additional +markup samples are packaged separately in the file:

* -

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

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

31. EDITOR FILES, SYNTAX HIGHLIGHTING

The directory: -

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

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

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

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

contains rudimentary sisu syntax highlighting files for:

* (g)vim <http://www.vim.org @@ -3047,6 +3132,7 @@ breaks

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

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

(require ’sisu-mode.el)
@@ -3092,29 +3178,29 @@ create new ones).

33. SUMMARY OF FEATURES

* sparse/minimal markup (clean utf-8 source texts). Documents are prepared in a single UTF-8 file using a -minimalistic mnemonic syntax. Typical literature, documents like headers -are optional. -

* markup is easily readable/parsable by the human eye, (basic -markup is simpler and more sparse than the most basic HTML), [this  may - also  be  converted  to  XML  representations  of  the  same  input/source  document]. - -

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

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

* html - both as a single scrollable text and a segmented -document
+minimalistic mnemonic syntax. Typical literature, documents like "War and +Peace" require almost no markup, and most of the headers are optional. +

+ * markup is easily readable/parsable by the human eye, (basic markup is +simpler and more sparse than the most basic HTML), [this  may  also  be  converted + to  XML  representations  of  the  same  input/source  document]. +

* markup defines +document structure (this may be done once in a header pattern-match description, +or for heading levels individually); basic text attributes (bold, italics, +underscore, strike-through etc.) as required; and semantic information related +to the document (header information, extended beyond the Dublin core and +easily further extended as required); the headers may also contain processing +instructions. SiSU markup is primarily an abstraction of document structure +and document metadata to permit taking advantage of the basic strengths +of existing alternative practical standard ways of representing documents +[be  that  paper  publication,  sql  search  etc.] (html, epub, xml, odf, latex, +pdf, sql) +

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

* html +- both as a single scrollable text and a segmented document

* xhtml
@@ -3131,8 +3217,8 @@ as

* pdf (via LaTeX)

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

Also produces: concordance files; document content certificates (md5 or sha256 digests of headings, paragraphs, images etc.) and html manifests @@ -3158,62 +3244,66 @@ the output information provides the object/paragraph numbers which are relevant across all generated outputs; it is also possible to look at just the matching paragraphs of the documents in the database; [output  indexing  also  work  well  with  search  indexing tools  like  hyperestraier]. -

*longtermmaintainabilityofdocumentcollectionsinaworldofchanging -formats, having a very sparsely marked-up source document base. there is -a considerable degree of future-proofing, output representations are upgradeable -(open document text) module in 2006, epub in 2009 and in future html5 output -sometime in future, without modification of existing prepared texts -

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

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

* document source (plaintext utf-8) if - -

shared on the net may be used as input and processed locally to produce - -

the different document outputs -

* document source may be bundled together -(automatically) with associated documents (multiple language versions or -master document with inclusions) and images and sent as a zip file called -a sisupod, if shared on the net these too may be processed locally to produce - -

the desired document outputs -

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

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

* as a developers tool it is flexible and extensible -

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

SiSU is less about document layout than about finding a way with little -markup to be able to construct an abstract representation of a document -that makes it possible to produce multiple representations of it which -may be rather different from each other and used for different purposes, -whether layout and publishing, or search of content -

i.e. to be able to -take advantage from this minimal preparation starting point of some of -the strengths of rather different established ways of representing documents -for different purposes, whether for search (relational database, or indexed -flat files generated for that purpose whether of complete documents, or -say of files made up of objects), online viewing (e.g. html, xml, pdf), or -paper publication (e.g. pdf)... -

the solution arrived at is by extracting structural -information about the document (about headings within the document) and -by tracking objects (which are serialized and also given hash values) in -the manner described. It makes possible representations that are quite different -from those offered at present. For example objects could be saved individually -and identified by their hashes, with an index of how the objects relate -to each other to form a document. +

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

without modification of existing prepared texts +

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

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

* document source (plaintext utf-8) if shared on the net may be used as + +

input and processed locally to produce the different document outputs +

+ * document source may be bundled together (automatically) with associated +documents (multiple language versions or master document with inclusions) +and images and sent as a zip file called a sisupod, if shared on the net + +

these too may be processed locally to produce the desired document outputs + +

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

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

* as + +

a developers tool it is flexible and extensible +

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

SiSU is less about +document layout than about finding a way with little markup to be able +to construct an abstract representation of a document that makes it possible +to produce multiple representations of it which may be rather different +from each other and used for different purposes, whether layout and publishing, + +

or search of content +

i.e. to be able to take advantage from this minimal +preparation starting point of some of the strengths of rather different +established ways of representing documents for different purposes, whether +for search (relational database, or indexed flat files generated for that +purpose whether of complete documents, or say of files made up of objects), +online viewing (e.g. html, xml, pdf), or paper publication (e.g. pdf)... +

the +solution arrived at is by extracting structural information about the document +(about headings within the document) and by tracking objects (which are +serialized and also given hash values) in the manner described. It makes +possible representations that are quite different from those offered at +present. For example objects could be saved individually and identified +by their hashes, with an index of how the objects relate to each other +to form a document.

34. HELP SOURCES -

For a summary of alternative -ways to get help on SiSU try one of the following: +

For a summary of alternative ways +to get help on SiSU try one of the following:

man page

man sisu_help
@@ -3237,6 +3327,28 @@ listed here:

34.1.1 MAN

man sisu
+

man sisu-concordance
+ +

man sisu-epub
+ +

man sisu-git
+ +

man sisu-harvest
+ +

man sisu-html
+ +

man sisu-odf
+ +

man sisu-pdf
+ +

man sisu-pg
+ +

man sisu-po
+ +

man sisu-sqlite
+ +

man sisu-txt
+

man 7 sisu_complete

man 7 sisu_pdf
@@ -3252,8 +3364,8 @@ listed here:

34.2 SISU GENERATED OUTPUT - LINKS TO HTML

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

34.2.1 WWW.SISUDOC.ORG

<http://sisudoc.org/sisu/sisu_manual/index.html > @@ -3261,94 +3373,19 @@ the html pages[^28]

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

34.3 MAN2HTML

34.3.1 LOCALLY INSTALLED -

<file:///usr/share/doc/sisu/v2/html/sisu.1.html> - -

<file:///usr/share/doc/sisu/v2/html/sisu_help.1.html> -

<file:///usr/share/doc/sisu/v2/html/sisu_help_sources.1.html> +

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

/usr/share/doc/sisu/v2/html/sisu.1.html
+

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

/usr/share/doc/sisu/v2/html/sisu_pdf.7.html
+

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

/usr/share/doc/sisu/v2/html/sisu_postgresql.7.html
+

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

/usr/share/doc/sisu/v2/html/sisu_sqlite.7.html
+

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

/usr/share/doc/sisu/v2/html/sisu_webrick.1.html
+

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

34.3.2 WWW.JUS.UIO.NO/SISU

<http://www.jus.uio.no/sisu/man/sisu.1.html @@ -3417,47 +3454,51 @@ insert multiple asterisks if required

+2.
editors -notes, numbered asterisk footnote/endnote series .
  • <http://www.jus.uio.no/sisu/ +notes, numbered asterisk footnote/endnote series
  • .
  • <http://www.sisudoc.org/ > -
  • .
  • <http://www.ruby-lang.org/en/ ->
  • .
  • Table from the Wealth of Networks by Yochai Benkler -<http://www.jus.uio.no/sisu/the_wealth_of_networks.yochai_benkler ->
  • .
  • .ssc (for composite) -is under consideration but ._sst makes clear that this is not a regular -file to be worked on, and thus less likely that people will have processing. -It may be however that when the resulting file is shared .ssc is an appropriate -suffix to use.
  • .
  • <http://www.postgresql.org/ + +

  • .
  • <http://www.ruby-lang.org/en/ +>
  • .
  • Table from the Wealth of Networks by Yochai +Benkler <http://www.jus.uio.no/sisu/the_wealth_of_networks.yochai_benkler +>
  • .
  • .ssc +(for composite) is under consideration but ._sst makes clear that this is +not a regular file to be worked on, and thus less likely that people will +have "accidents", working on a .ssc file that is overwritten by subsequent +processing. It may be however that when the resulting file is shared .ssc +is an appropriate suffix to use.
  • .
  • <http://www.postgresql.org/ > <http://advocacy.postgresql.org/ -> <http://en.wikipedia.org/wiki/Postgresql > -
  • .
  • <http://www.hwaci.com/sw/sqlite/ +<http://en.wikipedia.org/wiki/Postgresql +>
  • .
  • <http://www.hwaci.com/sw/sqlite/ > <http://en.wikipedia.org/wiki/Sqlite ->
  • .
  • <http://search.sisudoc.org > -
  • .
  • (which could be extended further with current back-end). As regards scaling -of the database, it is as scalable as the database (here Postgresql) and -hardware allow.
  • .
  • of this feature when demonstrated to an IBM software innovations -evaluator in 2004 he said to paraphrase: this could be of interest to us. -We have large document management systems, you can search hundreds of thousands -of documents and we can tell you which documents meet your search criteria, -but there is no way we can tell you without opening each document where -within each your matches are found.
  • .
  • There is nothing to stop MySQL support -being added in future.
  • .
  • <http://www.jus.uio.no/sisu/man/sisu.1 ->
  • .
  • <http://www.jus.uio.no/sisu/man/sisu.8 +
  • .
  • <http://search.sisudoc.org +>
  • .
  • (which could be extended further with current back-end). +As regards scaling of the database, it is as scalable as the database (here +Postgresql) and hardware allow.
  • .
  • of this feature when demonstrated to an +IBM software innovations evaluator in 2004 he said to paraphrase: this +could be of interest to us. We have large document management systems, you +can search hundreds of thousands of documents and we can tell you which +documents meet your search criteria, but there is no way we can tell you +without opening each document where within each your matches are found. +
  • .
  • There is nothing to stop MySQL support being added in future.
  • .
  • <http://www.jus.uio.no/sisu/man/sisu.1.html +> + +

  • .
  • <http://www.jus.uio.no/sisu/man/sisu.8.html > -
  • .
  • <http://www.jus.uio.no/sisu/man ->
  • .
  • the Debian Free Software guidelines require -that everything distributed within Debian can be changed - and the documents -are authors’ works that while freely distributable are not freely changeable. -
  • .
  • -

    named index.html or more extensively through sisu_manifest.html +

  • .
  • <http://www.jus.uio.no/sisu/man +>
  • . +
  • the Debian Free Software guidelines require that everything distributed +within Debian can be changed - and the documents are authors’ works that +while freely distributable are not freely changeable.
  • .
  • named index.html or + +

    more extensively through sisu_manifest.html

  • See Also

    sisu(1) -, -
    +,
    sisu-epub(1) ,
    sisu-harvest(1) @@ -3475,12 +3516,10 @@ are authors’ works that while freely distributable are not freely changeab sisu-txt(1) .
    sisu_vim(7) -
    -sisu(8)

    Homepage

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

    -- cgit v1.2.3