From 074d3109fd6cdc96b8363e173bb861e82005b0b8 Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Sun, 1 Jul 2007 11:19:20 +0100 Subject: primarily gpl3 changes, license changed, license included, images added skins cleaned a bit and output info on sisu modified, esp. in html html no link to concordance if generated on document above word count 260k odf url match bug fix dal text block fix for dealing with url to be followed by
minor cosmetic stuff --- data/doc/sisu/html/sisu.1.html | 496 ++++++++++++++++--------------- data/doc/sisu/html/sisu.8.html | 27 +- data/doc/sisu/html/sisu_termsheet.1.html | 8 +- data/doc/sisu/html/sisu_vim.7.html | 2 +- data/doc/sisu/html/sisu_webrick.1.html | 30 +- 5 files changed, 282 insertions(+), 281 deletions(-) (limited to 'data/doc/sisu/html') diff --git a/data/doc/sisu/html/sisu.1.html b/data/doc/sisu/html/sisu.1.html index 4922bab1..61d0ab0d 100644 --- a/data/doc/sisu/html/sisu.1.html +++ b/data/doc/sisu/html/sisu.1.html @@ -46,19 +46,19 @@ other information.
-A [filename/wildcard]
-
produces plaintext with dos linefeeds and without markup, (object numbers +
produces plaintext with dos linefeeds and without markup, (object numbers are omitted), has footnotes at end of each paragraph that contains them [ -a for equivalent Unix (linefeed) output file] [see -E for endnotes].
-a [filename/wildcard]
-
produces plaintext with Unix linefeeds and without markup, (object numbers +
produces plaintext with Unix linefeeds and without markup, (object numbers are omitted), has footnotes at end of each paragraph that contains them [ -A for equivalent dos (linefeed) output file] [see -e for endnotes].
-b [filename/wildcard]
-
produces xhtml/XML output for browser viewing (sax parsing).
+
produces xhtml/XML output for browser viewing (sax parsing).
-C [--init=site]
@@ -67,10 +67,10 @@ 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. +updated if this modifier is used.
-c [filename/wildcard]
-
screen toggle ansi +
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 @@ -78,59 +78,59 @@ output will be without colour).
-D [instruction] [filename]
database postgresql -( --pgsql may be used instead) possible instructions, include: --createdb; +( --pgsql may be used instead) possible instructions, include: --createdb; --create; --dropall; --import  [filename]; --update  [filename]; --remove  [filename]; see database section below.
-d [--db-[database type (sqlite|pg)]] --[instruction] [filename]
-
database type default set to sqlite, (for which --sqlite may be used instead) +
database type default set to sqlite, (for which --sqlite may be used instead) or to specify another database --db-[pgsql, sqlite] (however see -D) possible instructions include: --createdb; --create; --dropall; --import  [filename]; --update  [filename]; --remove  [filename]; see database section below.
-E [filename/wildcard]
-
produces plaintext with dos linefeeds, and without markup, endnotes follow -the main text (in -a endnotes follow the paragraphs that contain them). -There are no object numbers [see -e for Unix (linefeed) output file] [see --A for footnotes].
+
produces plaintext with dos linefeeds, and without markup, endnotes follow +the main text (in -a endnotes follow the paragraphs that contain them). There +are no object numbers [see -e for Unix (linefeed) output file] [see -A for +footnotes].
-e [filename/wildcard]
-
produces plaintext with Unix linefeeds, +
produces plaintext with Unix linefeeds, and without markup, endnotes follow the main text. Object numbers are omitted. [ -E for equivalent dos (linefeed) output file] [ -a for footnotes].
-F [--webserv=webrick]
-
generate examples of (naive) cgi search form for sqlite and pgsql depends +
generate examples of (naive) cgi search form for sqlite and pgsql depends on your already having used sisu to populate an sqlite and/or pgsql database, (the sqlite version scans the output directories for existing sisu_sqlite databases, so it is first necessary to create them, before generating the -search form) see -d -D and the database section below. If the optional -parameter --webserv=webrick is passed, the cgi examples created will be set -up to use the default port set for use by the webrick server, (otherwise -the port is left blank and the system setting used, usually 80). The samples -are dumped in the present work directory which must be writable, (with -screen instructions given that they be copied to the cgi-bin directory). --Fv (in addition to the above) provides some information on setting up -hyperestraier for sisu
+search form) see -d -D and the database section below. If the optional parameter +--webserv=webrick is passed, the cgi examples created will be set up to use +the default port set for use by the webrick server, (otherwise the port +is left blank and the system setting used, usually 80). The samples are +dumped in the present work directory which must be writable, (with screen +instructions given that they be copied to the cgi-bin directory). -Fv (in +addition to the above) provides some information on setting up hyperestraier +for sisu
-H [filename/wildcard]
-
produces html without -link suffixes (.html .pdf etc.) ("Hide"). Requires an appropriately configured -web server. [behaviour switched after 0.35 see -h].
+
produces html without link suffixes +(.html .pdf etc.) ("Hide"). Requires an appropriately configured web server. +[behaviour switched after 0.35 see -h].
-h [filename/wildcard]
-
produces - html (with hardlinks i.e. with name suffixes in links/local urls). html, -with internal document links that include the document suffix, i.e. whether -it is .html or .pdf (required for browsing directly off a file system, and -works with most web servers). [behaviour switched after 0.35 see -H].
+
produces html +(with hardlinks i.e. with name suffixes in links/local urls). html, with internal +document links that include the document suffix, i.e. whether it is .html +or .pdf (required for browsing directly off a file system, and works with +most web servers). [behaviour switched after 0.35 see -H].
-I [filename/wildcard]
-
produces texinfo file.
+
produces texinfo file.
-L
prints license information.
@@ -155,7 +155,7 @@ for the document, and digests for each object contained within the document
-n [filename/wildcard/url]
skip meta-markup -(building of "metaverse"), this skips the equivalent of -m which is otherwise +(building of "metaverse"), this skips the equivalent of -m which is otherwise assumed by most processing flags.
-o [filename/wildcard/url]
@@ -164,7 +164,7 @@ document in opendocument file format (opendocument.odt).
-p [filename/wildcard]
-
produces LaTeX pdf (portrait.pdf & landscape.pdf). Default paper size is set +
produces LaTeX pdf (portrait.pdf & landscape.pdf). Default paper size is set in config file, or document header, or provided with additional command line parameter, e.g. --papersize-a4 preset sizes include: ’A4’, U.S. ’letter’ and ’legal’ and book sizes ’A5’ and ’B5’ (system defaults to A4).
@@ -175,7 +175,7 @@ line parameter, e.g. --papersize-a4 preset sizes include: ’A4&rsquo
-R [filename/wildcard]
copies sisu output files -to remote host using rsync. This requires that sisurc.yml has been provided +to remote host using rsync. This requires that sisurc.yml has been provided with information on hostname and username, and that you have your "keys" and ssh agent in place. Note the behavior of rsync different if -R is used with other flags from if used alone. Alone the rsync --delete parameter is @@ -184,27 +184,27 @@ 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 +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
-S
produces a sisupod a zipped -sisu directory of markup files including sisu markup source files and -the directories local configuration file, images and skins. Note: this -only includes the configuration files or skins contained in ./_sisu not -those in ~/.sisu -S  [filename/wildcard] option. Note: (this option is tested -only with zsh).
+sisu directory of markup files including sisu markup source files and the +directories local configuration file, images and skins. Note: this only +includes the configuration files or skins contained in ./_sisu not those +in ~/.sisu -S  [filename/wildcard] option. Note: (this option is tested only +with zsh).
-S [filename/wildcard]
-
produces a zipped file of the prepared -document specified along with associated images, by default named sisupod.zip -they may alternatively be named with the filename extension .ssp This provides +
produces a zipped file of the prepared document +specified along with associated images, by default named sisupod.zip they +may alternatively be named with the filename extension .ssp This provides a quick way of gathering the relevant parts of a sisu document which can -then for example be emailed. A sisupod includes sisu markup source file, - (along with associated documents if a master file, or available in multilingual -versions), together with related images and skin. SiSU commands can be -run directly against a sisupod contained in a local directory, or provided +then for example be emailed. A sisupod includes sisu markup source file, +(along with associated documents if a master file, or available in multilingual +versions), together with related images and skin. SiSU commands can be run +directly against a sisupod contained in a local directory, or provided as a url on a remote site. As there is a security issue with skins provided by other users, they are not applied unless the flag --trust or --trusted is added to the command instruction, it is recommended that file that are @@ -212,7 +212,7 @@ not your own are treated as untrusted. The directory structure of the unzipped file is understood by sisu, and sisu commands can be run within it. Note: if you wish to send multiple files, it quickly becomes more space efficient to zip the sisu markup directory, rather than the individual files for -sending). See the -S option without [filename/wildcard].
+sending). See the -S option without [filename/wildcard].
-s [filename/wildcard]
@@ -224,78 +224,79 @@ sending). See the -S option without [filename/wildcard].
-U [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
- -
-u [filename/wildcard] -
-
provides url mapping of output files for the flags requested for processing, -also see -U
+
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
+ +
-u [filename/wildcard]
+
provides url mapping +of output files for the flags requested for processing, also see -U
-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. -(also see -M)
+
even more verbose than the -v flag. (also see -M)
-v
-
on its own, provides SiSU version information
+
on +its own, provides SiSU version information
-
-v [filename/wildcard] -
-
provides verbose output of what is being built, where it is being built -(and error messages if any), as with -u flag provides a url mapping of -files created for each of the processing flag requests. See also -V
+
-v [filename/wildcard]
+
provides +verbose output of what is being built, where it is being built (and error +messages if any), as with -u flag provides a url mapping of files created +for each of the processing flag requests. See also -V
-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 -].
- -
-w [filename/wildcard]
-
produces concordance (wordmap) a rudimentary -index of all the words in a document.
- -
-X [filename/wildcard]
-
produces XML -output with deep document structure, in the nature of dom.
- -
-x [filename/wildcard] -
-
produces XML output shallow structure (sax parsing).
+
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 ].
-
-Y [filename/wildcard] +
-w [filename/wildcard]
-
produces a short sitemap entry for the document, based on html output and -the sisu_manifest. --sitemaps generates/updates the sitemap index of existing -sitemaps. (Experimental, [g,y,m announcement this week])
+
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)
-
-y [filename/wildcard] +
-X [filename/wildcard]
-
produces an html summary of output generated (hyperlinked to content) and -document specific metadata (sisu_manifest.html). This step is assumed for -most processing flags.
+
produces XML output with deep document structure, in the nature of dom. +
+ +
-x [filename/wildcard]
+
produces XML output shallow structure (sax parsing). +
+ +
-Y [filename/wildcard]
+
produces a short sitemap entry for the document, based +on html output and the sisu_manifest. --sitemaps generates/updates the sitemap +index of existing sitemaps. (Experimental, [g,y,m announcement this week]) +
+ +
-y [filename/wildcard]
+
produces an html summary of output generated (hyperlinked +to content) and document specific metadata (sisu_manifest.html). This step +is assumed for most processing flags.
-Z [filename/wildcard]
-
Zap, if used with other processing -flags deletes output files of the type about to be processed, prior to -processing. If -Z is used as the lone processing related flag (or in conjunction -with a combination of -[mMvVq]), will remove the related document output -directory.
+
Zap, if used +with other processing flags deletes output files of the type about to be +processed, prior to processing. If -Z is used as the lone processing related +flag (or in conjunction with a combination of -[mMvVq]), will remove the +related document output directory.
-z [filename/wildcard]
-
produces php (zend) [this feature is disabled -for the time being]
+
produces php (zend) +[this feature is disabled for the time being]

modifiers

@@ -303,85 +304,85 @@ for the time being]
--no-ocn
-
[with -h -H or -p] switches off object -citation numbering. Produce output without identifying numbers in margins -of html or LaTeX/pdf output.
+
[with -h -H +or -p] switches off object citation numbering. Produce output without identifying +numbers in margins of html or LaTeX/pdf output.
--no-annotate
-
strips output text of editor endnotes~[* -square brackets ]~ denoted by asterisk or dagger/plus sign
+
strips output +text of editor endnotes~[* square brackets ]~ denoted by asterisk or dagger/plus +sign
--no-asterisk
-
strips -output text of editor endnotes~[* square brackets ]~ denoted by asterisk -sign
+
strips output text of editor endnotes~[* square brackets +]~ denoted by asterisk sign
--no-dagger
-
strips output text of editor endnotes~[+ square brackets -]~ denoted by dagger/plus sign
+
strips output text of editor endnotes~[+ +square brackets ]~ denoted by dagger/plus sign

databases

-
dbi - database interface +
dbi - database +interface
+
-D or --pgsql set for postgresql -d or --sqlite default set for sqlite +-d is modifiable with --db=[database  type  (pgsql  or  sqlite)]
+ +
-Dv --createall
-
-D or --pgsql set for postgresql -d or --sqlite default set for sqlite -d is -modifiable with --db=[database  type  (pgsql  or  sqlite)]
- -
-Dv --createall
-
initial -step, creates required relations (tables, indexes) in existing postgresql -database (a database should be created manually and given the same name -as working directory, as requested) (rb.dbi) [ -dv --createall sqlite equivalent] -it may be necessary to run sisu -Dv --createdb initially
- -
NOTE: at the present -time for postgresql it may be necessary to manually create the database. -The command would be
-
’createdb [database name]’ where database name would -be SiSU_[present working directory name (without path)]. Please use only -alphanumerics and underscores.
- -
-Dv --import
-
[filename/wildcard] imports data -specified to postgresql db (rb.dbi) [ -dv --import sqlite equivalent]
- -
-Dv --update -
-
[filename/wildcard] updates/imports specified data to postgresql db (rb.dbi) -[ -dv --update sqlite equivalent]
+
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.
+ +
-Dv --import
+
[filename/wildcard] imports +data specified to postgresql db (rb.dbi) [ -dv --import sqlite equivalent] +
+ +
-Dv --update
+
[filename/wildcard] updates/imports specified data to postgresql +db (rb.dbi) [ -dv --update sqlite equivalent]
-D --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] +
-
-D --dropall -
-
kills data" and drops (postgresql or sqlite) db, tables & indexes [ -d --dropall -sqlite equivalent]
+
-D --dropall
+
kills data" and drops (postgresql or sqlite) db, tables & indexes +[ -d --dropall sqlite equivalent]
The v in e.g. -Dv is for verbose output.
-

Shortcuts, Shorthand -for multiple flags

+

Shortcuts, +Shorthand for multiple flags

--update [filename/wildcard]
-
Checks existing file output -and runs the flags required to update this output. This means that if only -html and pdf output was requested on previous runs, only the -hp files will -be applied, and only these will be generated this time, together with the -summary. This can be very convenient, if you offer different outputs of -different files, and just want to do the same again.
- -
-0 to -5 [filename or -wildcard]
+
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):
@@ -395,20 +396,20 @@ default action run when no options are give, i.e. on ’sisu [filename]&rsqu -4 -mNhwpAobxXDyY  --import

-5 -mNhwpAobxXDyY  --update

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

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

Document Markup

SiSU -Markup an incomplete summary.

-Note: files should be marked up for SiSU -using UTF-8 encoding.

-Some interactive help on markup is available, by typing - sisu and selecting markup or sisu --help markup +Markup an incomplete summary.

+Note: files should be marked up for SiSU using +UTF-8 encoding.

+Some interactive help on markup is available, by typing sisu +and selecting markup or sisu --help markup

-
Sample markup files can -be used as examples:
+
Sample markup files can be used +as examples:
<http://www.jus.uio.no/sisu/sample >
@@ -495,12 +496,12 @@ the shortcut:

{~^ [text to link] }http://url.org

-is equivalent to:

+is equivalent to:

{ [text to link] }http://url.org ~{ http://url.org - }~ -

-(which produces hyper-linked text within a document/paragraph, with an endnote + }~

+(which +produces hyper-linked text within a document/paragraph, with an endnote providing the url for the text location used in the hyperlink)

url example:

@@ -537,7 +538,7 @@ citation numbering -# unnumbered paragraph, delete when not required (place marker at end of paragraph) [used in dummy headings, eg. for segmented html]

It is convenient -to mention here that the -0 flag generates html and latex/pdf output without +to mention here that the -0 flag generates html and latex/pdf output without visible object character numbers.

sisu -0 [filename.sst]

Page breaks (LaTeX/pdf)

@@ -560,7 +561,7 @@ line

for folding by vim folds

Special characters

special characters can be escaped -with a backslash { } < > are contextual special characters, (in combination +with a backslash { } < > are contextual special characters, (in combination with other characters). ~ - _ / % ^ and occasionally ! # + , are special characters in particular circumstances, see the syntax chart. [note that SiSU is not optimised for technical writing] @@ -586,8 +587,8 @@ see example below]

column one row three
and so on
here
-
- }table + +

}table

whole table gets an object citation number

Other Grouped or @@ -628,7 +629,7 @@ be other documents that would be processed in a regular way, or markup bits prepared only for inclusion within a master document .sst regular markup file, or .ssi (insert/information) .sst A secondary file of the composite document is built prior to processing with the same prefix and the suffix - ._sst and ._sst There are a number of alternative syntaxes for requiring +._sst and ._sst There are a number of alternative syntaxes for requiring external documents in order to permit use of ascii hypertext linking available in the vim editor. They are as follows:

@@ -670,29 +671,29 @@ thlnk syntax (or regular sisu syntax), e.g.

Document Headers

Header tags appear at the beginning of a document and provide meta information on the document (such as the Dublin Core), or -information as to how the document as a whole is to be processed. -

All -header instructions may take either form: @headername: [introduced in 0.38] +information as to how the document as a whole is to be processed. +

All header +instructions may take either form: @headername: [introduced in 0.38] or -

or 0~headername All Dublin Core meta tags are available -

@indentifier: -information or instructions [introduced in 0.38] +

0~headername All Dublin Core meta tags are available +

@indentifier: information +or instructions [introduced in 0.38]

or -

0~indentifier information -or instructions, old equivalent, depreciated -

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: (0~title) are optional; -the @structure: (0~toc) header is used to describe document structure, -and can be useful to know. -

@structure: PART; CHAPTER; SECTION; ARTICLE; -none; none; -

structure can be defined by a match words or regular expression -(the regular expression is assumed to start at the beginning of a line -of text i.e. ^) -

For help see one of the following (and markup samples):
+

0~indentifier information or instructions, +old equivalent, depreciated +

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: (0~title) are optional; the @structure: (0~toc) header +is used to describe document structure, and can be useful to know. +

@structure: +PART; CHAPTER; SECTION; ARTICLE; none; none; +

structure can be defined +by a match words or regular expression (the regular expression is assumed +to start at the beginning of a line of text i.e. ^) +

For help see one of +the following (and markup samples):

* interactive help - type ’sisu --help headers’
@@ -728,16 +729,16 @@ markup version]

@format:

@identifier:

@source: -

@language: [or @language.document:] -language in which current version of document is published. Some country -settings result in processing adjustments, e.g. in LaTeX hyphenation, some -country codes are recognized, but the language name in Engish is preferred. -English is the default setting. (en - English, fr - French, de - German, it -- Italian, es - Spanish, pt - Portuguese, sv - Swedish, da - Danish, fi - Finnish, -no - Norwegian, is - Icelandic, nl - Dutch, ee - Estonian, hu - Hungarian, pl -- Polish, ro - Romanian, ru - Russian, gl - Greek, uk - Ukranian, tr - Turkish, -si - Slovene, sk - Slovak, hr - Croatian, cs - Czech, bg - Bulgarian ) [however, -encodings are not available for all of the languages listed.] +

@language: [or @language.document:] language +in which current version of document is published. Some country settings +result in processing adjustments, e.g. in LaTeX hyphenation, some country +codes are recognized, but the language name in Engish is preferred. English +is the default setting. (en - English, fr - French, de - German, it - Italian, +es - Spanish, pt - Portuguese, sv - Swedish, da - Danish, fi - Finnish, no - +Norwegian, is - Icelandic, nl - Dutch, ee - Estonian, hu - Hungarian, pl - Polish, +ro - Romanian, ru - Russian, gl - Greek, uk - Ukranian, tr - Turkish, si - Slovene, +sk - Slovak, hr - Croatian, cs - Czech, bg - Bulgarian ) [however, encodings +are not available for all of the languages listed.]

@language.original:

original language in which the work was published @@ -769,7 +770,7 @@ classification]; isbn=[ISBN]; pg=[Project Gutenberg text number]

@prefix_b: or @prefix: [prefix is placed just after table of contents]

@rcs: $Id$ -[or @cvs: used by rcs or cvs to embed version (revision control) information +[or @cvs: used by rcs or cvs to embed version (revision control) information into document, rcs or cvs can usefully provide a history of updates to a document ]

@structure: PART; CHAPTER; SECTION; ARTICLE; none; none; @@ -795,21 +796,23 @@ new=A,B,C; break=1; num_top=1 [or newpage=A,B,C; breakpage=1; num_top=1] see headings]

@bold: [regular expression of words/phrases to be made bold] -

@italics: [regular expression of words/phrases to italicise]
- @vocabulary: name of taxonomy/vocabulary/wordlist to use against document +

@italics: [regular expression of words/phrases to italicise] +

@vocabulary: -

@skin: skin_doc_[name_of_desired_document_skin] -

@links: { SiSU }http://www.jus.uio.no/sisu/ +

name of taxonomy/vocabulary/wordlist to use against document +

@skin: skin_doc_[name_of_desired_document_skin] -{ FSF }http://www.fsf.org +

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

@promo: sisu, ruby, search_libre_docs, open_society -[places content in right pane in html, makes use of list.yml and promo.yml, -commented out sample in document sample: free_as_in_freedom.richard_stallman_crusade_for_free_software.sam_williams.sst] +

@promo: +sisu, ruby, search_libre_docs, open_society [places content in right pane +in html, makes use of list.yml and promo.yml, commented out sample in document +sample: free_as_in_freedom.richard_stallman_crusade_for_free_software.sam_williams.sst]

:A~ 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~ Second level heading [this is a heading level divider]

:C~ Third level heading [this is a heading level divider] @@ -916,7 +919,7 @@ of their own.

-
would map to
+
would map to

@@ -1015,7 +1018,7 @@ The last part of a directory path is used to create a sub-directory into which generated documents are placed, in a database of the same name, unless overridden.

Documents within -the directory ~/ebook

+the directory ~/ebook

~/ebook/free_culture.sst

would be placed in tables @@ -1044,9 +1047,9 @@ all documents within that directory take on a particular appearance. If a skin exists in the skin/dir with the same name as the document directory, it will automatically be used for each of the documents in that directory, (except where a document specifies the use of another skin, in the skin/doc -directory). when end

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

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

A site skin, modifies the program default skin.

Sample skins @@ -1058,7 +1061,7 @@ directory)

Document Naming Convention

SiSU documents are named with the -suffix ss followed by a third distinguishing letter, usually t for ordinary +suffix ss followed by a third distinguishing letter, usually t for ordinary text files.

.sst is used by regular documents, and for most purposes is all you need to be aware of

@@ -1117,7 +1120,7 @@ are not amongst the options considered. For basic use only a fraction of the information provided here is required. There may be a bit of an information management problem in determining what though. For the markup of a book -see the samples provided in <http://www.jus.uio.no/sisu/sample +see the samples provided in <http://www.jus.uio.no/sisu/sample > and referred to in the text <http://www.jus.uio.no/sisu/SiSU > The flags to generate html @@ -1139,31 +1142,31 @@ markup file will not appear in subsequently generated text unless this flag is used: sisu -m [filename or wildcard]

to create html and pdf output, with verbose output of samplefile1.sst and samplefile2.sst sisu -mhpv samplefile1.sst -samplefile2.sst

Note: -m does initial processing, and -H omits filename -suffixes and requires a properly configured web server. -h is used to include -filename suffixes for file system viewing
-

-generate html, a word map and -pdf with verbose output for all marked up documents in a directory: sisu --mhwpv *

-generate html, word map, pdf, plaintext, xhtml, xml sax and xml -dom versions with verbose output for all marked up documents in a directory: -sisu -mhwpabxXv *

-to create html, pdf, xml, plaintext and a concordance -file (wordmap) as output, with verbose output of all marked up files in -a directory sisu -mhpxXawv *.{r,s}?

-generate html, word map and pdf and place -on remote server with verbose output 2 named example files in a directory -(assumes has been set up, and first time must be run without other flags -ie sisu -mrv [filenames/wildcard]): sisu -mhwprv example_file.sst other_example_file.sst +samplefile2.sst

Note: -m does initial processing, and -H omits filename suffixes +and requires a properly configured web server. -h is used to include filename +suffixes for file system viewing

-to process a remote sisu marked up file (html,pdf,concordance), provide -the url(s) (works for text only files, will be downloaded and processed -locally): sisu -mhwpv http://www.jus.uio.no/sisu/sample/markup/gpl2.fsf.sst - http://www.jus.uio.no/sisu/sample/markup/autonomy_markup0.sst +generate html, a word map and pdf with +verbose output for all marked up documents in a directory: sisu -mhwpv *

-one file is local the other remote process (html,pdf,concordance,plaintext -and place on pre-set remote destination): sisu -mhwparv gpl2.fsf.sst http://www.jus.uio.no/sisu/sample/markup/autonomy_markup0.sst +generate html, word map, pdf, plaintext, xhtml, xml sax and xml dom versions +with verbose output for all marked up documents in a directory: sisu -mhwpabxXv +*

+to create html, pdf, xml, plaintext and a concordance file (wordmap) +as output, with verbose output of all marked up files in a directory sisu +-mhpxXawv *.{r,s}?

+generate html, word map and pdf and place on remote server +with verbose output 2 named example files in a directory (assumes has been +set up, and first time must be run without other flags ie sisu -mrv [filenames/wildcard]): +sisu -mhwprv example_file.sst other_example_file.sst

+to process a remote sisu +marked up file (html,pdf,concordance), provide the url(s) (works for text +only files, will be downloaded and processed locally): sisu -mhwpv http://www.jus.uio.no/sisu/gpl3.fsf/gpl3.fsf.sst + +http://www.jus.uio.no/sisu/sample/markup/autonomy_markup0.sst

+one file is local +the other remote process (html,pdf,concordance,plaintext and place on pre-set +remote destination): sisu -mhwparv gpl3.fsf.sst http://www.jus.uio.no/sisu/sample/markup/autonomy_markup0.sst

initialize database, create relations (first manually create database with @@ -1180,8 +1183,7 @@ has an interactive help, which is accessed by typing just "sisu" at the command line, or as described below: sisu commands, document preparation, customisation, installation etc. 

try:
-sisu --help  
-  sisu help
+sisu --help  sisu help
     help             sisu --help
     commands         sisu --help commands
     environment      sisu --help env
@@ -1252,7 +1254,7 @@ dom and node):
 
 sisu --from-kdi [kdissert filename] attempts to convert a kdissert file (.kdi)
 
 
to sisu markup 
-
 sisu --identify [filename/wildcard]  attempts to identify
+
 sisu --identify [filename/wildcard] attempts to identify
 
 
the markup version of the file 
 
 sisu --query=[version number] and sisu --query=history
diff --git a/data/doc/sisu/html/sisu.8.html b/data/doc/sisu/html/sisu.8.html
index 755d1d32..b79b71b1 100644
--- a/data/doc/sisu/html/sisu.8.html
+++ b/data/doc/sisu/html/sisu.8.html
@@ -23,7 +23,7 @@ include its’ simple syntax; the semantic identification of documents using
 the Dublin Core; document management; built to be associated with a revision
 control system; text object numbering for the identification of a texts
 location in any of the output formats, easy skinning on a site wide, or
-per document basis, ... for more see  man 1 sisu or  <http://www.jus.uio.no/sisu
+per document basis, ... for more see man 1 sisu or <http://www.jus.uio.no/sisu
 >
 

 SiSU is an alternative way of publishing and managing documents.  
@@ -44,13 +44,13 @@ online at <http://
 with syntax highlighting from <http://www.jus.uio.no/sisu/sample/syntax
 > 

 A syntax
-table is provided at  /usr/share/doc/sisu/on_markup.txt or equivalent, and
+table is provided at /usr/share/doc/sisu/on_markup.txt or equivalent, and
 online at <http://www.jus.uio.no/sisu/sample/on_markup.txt
 > 

 man 1 sisu has a
 syntax table along with processing commands. 

 SiSU also provides some help
-via the command:  sisu --help and selecting an appropriate subject, e.g. 

+via the command: sisu --help and selecting an appropriate subject, e.g. 

 sisu
 --help commands 

 sisu --help markup 

@@ -76,7 +76,7 @@ look at output results, see the "sisu_manifest" page created for the document
 To generate an online document move to a writable directory, (create a
 work directory and cd into it) as the file will be downloaded there and
 e.g. 

-sisu -1 http://www.jus.uio.no/sisu/gpl2.fsf/gpl2.fsf.sst
+sisu -1 http://www.jus.uio.no/sisu/gpl3.fsf/gpl3.fsf.sst
  

 sisu -3 http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/free_culture.lawrence_lessig.sst
 
@@ -115,13 +115,13 @@ structure (and document samples) provided in the document sample directory:
 cp -a /usr/share/doc/sisu/sisu_markup_samples/dfsg/*
 ~/sisu_test/. 

 ---------- 

-Tip:  the markup syntax examples may be of interest  <http://www.jus.uio.no/sisu/sample/
+Tip: the markup syntax examples may be of interest <http://www.jus.uio.no/sisu/sample/
 >
 

 Tip: sisu -U [sisu markup filename] should printout the different possible
 outputs and where sisu would place them. 

-Tip:  if you want to toggle ansi
-color add  c to your flags. 

+Tip: if you want to toggle ansi
+color add c to your flags. 

 ---------- 

  SiSU configuration file search path is: 

 ./_sisu/sisurc.yaml
@@ -193,23 +193,22 @@ from other skin directories as required.
 
Further Information

 

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

 or man sisu  
 
Author

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

 sisu(1)
 , sisu_examples(1)
+, sisu_webrick(1)
 ,
-sisu_webrick(1)
-, sisu_pdf(1)
+sisu_pdf(1)
  sisu_sqlite(1)
  sisu_postgresql(1)
  sisu_termsheet(1)
-,
-

+, 

 
 

 Table of Contents

diff --git a/data/doc/sisu/html/sisu_termsheet.1.html b/data/doc/sisu/html/sisu_termsheet.1.html
index 14a904d3..e91cd9d7 100644
--- a/data/doc/sisu/html/sisu_termsheet.1.html
+++ b/data/doc/sisu/html/sisu_termsheet.1.html
@@ -16,24 +16,24 @@ publishing system
 sisu -t [termsheet-name(s)]  
 
Description

 sisu_termsheet
-is part of SiSU is  invoked through the sisu command (man sisu) 

+is part of SiSU is invoked through the sisu command (man sisu) 

  
 
Summary
 of man page

 

-sisu_termsheet, is started with the command: sisu -t  [termsheet-name(s)]
+sisu_termsheet, is started with the command: sisu -t [termsheet-name(s)]
  
 
Document Processing Command Flags

 

 sisu -t [termsheet-name(s)] (runs sisu_termsheet)
 merges the termsheet(s) specified on the commandline with the documents
-it is instructed to merge in the termsheet(s), and produces regular  SiSU
+it is instructed to merge in the termsheet(s), and produces regular SiSU
 output documents from the merged results. 

 [further documentation on termsheets
 required]  
 
Further Information

 

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

 or man sisu 
diff --git a/data/doc/sisu/html/sisu_vim.7.html b/data/doc/sisu/html/sisu_vim.7.html
index 0909ce6a..f0c475c5 100644
--- a/data/doc/sisu/html/sisu_vim.7.html
+++ b/data/doc/sisu/html/sisu_vim.7.html
@@ -34,7 +34,7 @@ set color scheme to slate which is provided
 
Further Information

 

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

 or man sisu 
 
Author

diff --git a/data/doc/sisu/html/sisu_webrick.1.html b/data/doc/sisu/html/sisu_webrick.1.html
index f82412e2..917c176d 100644
--- a/data/doc/sisu/html/sisu_webrick.1.html
+++ b/data/doc/sisu/html/sisu_webrick.1.html
@@ -18,17 +18,17 @@ or 

 
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.yaml a sample of which is provided as /etc/sisu/sisurc.yaml
+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.yaml a sample of which is provided as /etc/sisu/sisurc.yaml
 (or in the equivalent directory on your system).  
 
Summary of man page

 

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

+the sisu command with the -W flag: sisu -W [port] 

 where no port is given
 and settings are unchanged the default port is 8081  
 
Document Processing
@@ -36,21 +36,21 @@ Command Flags

 

 sisu -W [port] starts Ruby Webrick web-server, serving SiSU output
 directories, on the port provided, or if no port is provided and the defaults
-have not been changed in  ~/.sisu/sisurc.yaml then on port 8081  
-
Further
-Information

+have not been changed in ~/.sisu/sisurc.yaml then on port 8081  
+
Further Information

 

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

-or
-man sisu 
+or man sisu 
 
Author

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

 sisu(1)
 , sisu_vim(7)
- sisu(8)
+
+sisu(8)
 , 

 
 

-- 
cgit v1.2.3