summaryrefslogtreecommitdiffstats
path: root/man
diff options
context:
space:
mode:
authorRalph Amissah <ralph@amissah.com>2011-03-05 20:06:52 +0000
committerRalph Amissah <ralph@amissah.com>2011-03-05 20:06:52 +0000
commitcce96b70741fa159c1ceb010ff417cfb8ebaba37 (patch)
tree23739509e3964a3d9d18748fac95934dc56aaf24 /man
parentmarkup samples, manual, headers: links and other details (diff)
downloadsisu-cce96b70741fa159c1ceb010ff417cfb8ebaba37.zip
sisu-cce96b70741fa159c1ceb010ff417cfb8ebaba37.tar.xz
manpages: sisu.1 update; sisu_vim.7 cleaning
Diffstat (limited to 'man')
-rw-r--r--man/man1/sisu.11565
-rw-r--r--man/man7/sisu_vim.7129
2 files changed, 812 insertions, 882 deletions
diff --git a/man/man1/sisu.1 b/man/man1/sisu.1
index 3dd8f71..a1036e8 100644
--- a/man/man1/sisu.1
+++ b/man/man1/sisu.1
@@ -1,22 +1,25 @@
-.TH "sisu" "1" "2010-09-17" "2.6.3" "SiSU"
+.TH "sisu" "1" "2011-03-04" "2.8.1" "SiSU"
.SH NAME
-sisu \- documents: markup, structuring, publishing in multiple standard formats, and search
+sisu - documents: markup, structuring, publishing in multiple standard formats, and search
.SH SYNOPSIS
-sisu [\-abcDdFehIiMmNnopqRrSsTtUuVvwXxYyZz0\-9] [filename/wildcard]
+sisu [-abcDdFehIiMmNnopqRrSsTtUuVvwXxYyZz0-9] [filename/wildcard]
.BR
-sisu [\-Ddcv] [instruction] [filename/wildcard]
+sisu [-Ddcv] [instruction] [filename/wildcard]
.BR
-sisu [\-CcFLSVvW]
+sisu [-CcFLSVvW]
.BR
-sisu \-\-v2 [operations]
+sisu --v2 [operations]
.BR
-sisu \-\-v1 [operations]
+sisu --v3 [operations]
+
+.BR
+sisu3 [operations]
.SH
-SISU \- MANUAL,
+SISU - MANUAL,
RALPH AMISSAH
.BR
@@ -25,7 +28,7 @@ WHAT IS SISU?
.BR
.SH
-1. INTRODUCTION \- WHAT IS SISU?
+1. INTRODUCTION - WHAT IS SISU?
.BR
.BR
@@ -45,7 +48,7 @@ case for development is work with medium to large document sets and cope with
evolving document formats/ representation technologies. Documents are prepared
once, and generated as need be to update the technical presentation or add
additional output formats. Various output formats (including search related
-output) share a common mechanism for cross\-output\-format citation.
+output) share a common mechanism for cross-output-format citation.
.BR
.B SiSU
@@ -71,21 +74,20 @@ Source document preparation and output generation is a two step process: (i)
document source is prepared, that is, marked up in sisu markup syntax and (ii)
the desired output subsequently generated by running the sisu engine against
document source. Output representations if updated (in the sisu engine) can be
-generated by re\-running the engine against the prepared source. Using
+generated by re-running the engine against the prepared source. Using
.B SiSU
markup applied to a document,
.B SiSU
custom builds (to take advantage of the strengths of different ways of
representing documents) various standard open output formats including plain
text, HTML, XHTML, XML, EPUB, OpenDocument, LaTeX or PDF files, and populate an
-SQL database with objects[^1] (equating generally to paragraph\-sized chunks)
-so searches may be performed and matches returned with that degree of
-granularity ( e.g. your search criteria is met by these documents and at these
-locations within each document). Document output formats share a common object
-numbering system for locating content. This is particularly suitable for
-"published" works (finalized texts as opposed to works that are frequently
-changed or updated) for which it provides a fixed means of reference of
-content.
+SQL database with objects[^1] (equating generally to paragraph-sized chunks) so
+searches may be performed and matches returned with that degree of granularity
+( e.g. your search criteria is met by these documents and at these locations
+within each document). Document output formats share a common object numbering
+system for locating content. This is particularly suitable for "published"
+works (finalized texts as opposed to works that are frequently changed or
+updated) for which it provides a fixed means of reference of content.
.BR
In preparing a
@@ -123,7 +125,7 @@ have that old proprietary formats will remain (or can be read without
proprietary software/equipment) in 15 years time, or the way the way in which
html has evolved over its relatively short span of existence.
.B SiSU
-provides the flexibility of producing documents in multiple non\-proprietary
+provides the flexibility of producing documents in multiple non-proprietary
open formats including html, pdf[^5] ODF,[^6] and EPUB.[^7] Whilst
.B SiSU
relies on software, the markup is uncomplicated and minimalistic which
@@ -148,7 +150,7 @@ which is currently under development, the html module will again be updated
allowing all existing documents to be regenerated as html 5).
.BR
-The document formats are written to the file\-system and available for indexing
+The document formats are written to the file-system and available for indexing
by independent indexing tools, whether off the web like Google and Yahoo or on
the site like Lucene and Hyperestraier.
@@ -174,6 +176,9 @@ content prepared in
.
.BR
+<http://www.sisudoc.org/>
+
+.BR
<http://www.jus.uio.no/sisu>
.SH
@@ -186,7 +191,7 @@ content prepared in
.BR
.B SiSU
.B SiSU
-is a document publishing system, that from a simple single marked\-up
+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
@@ -197,104 +202,104 @@ the same document structure information. For more see:
2.2 DOCUMENT PROCESSING COMMAND FLAGS
.TP
-.B \-a [filename/wildcard]
+.B -a [filename/wildcard]
produces plaintext with Unix linefeeds and without markup, (object numbers
-are omitted), has footnotes at end of each paragraph that contains them [ \ \-A
-\ for \ equivalent \ dos \ (linefeed) \ output \ file] [see \ \-e \ for \
-endnotes]. (Options include: \-\-endnotes for endnotes \-\-footnotes for
-footnotes at the end of each paragraph \-\-unix for unix linefeed (default)
-\-\-msdos for msdos linefeed)
+are omitted), has footnotes at end of each paragraph that contains them [ \ -A
+\ for \ equivalent \ dos \ (linefeed) \ output \ file] [see \ -e \ for \
+endnotes]. (Options include: --endnotes for endnotes --footnotes for footnotes
+at the end of each paragraph --unix for unix linefeed (default) --msdos for
+msdos linefeed)
.TP
-.B \-b [filename/wildcard]
-see \-\-xhtml
+.B -b [filename/wildcard]
+see --xhtml
.TP
-.B \-\-color\-toggle [filename/wildcard]
+.B --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
+-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
+screen output will be without colour). Alias -c
.TP
-.B \-\-concordance [filename/wildcard]
+.B --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
+words unless this limit is increased in the file sisurc.yml). Alias -w
.TP
-.B \-C [\-\-init\-site]
+.B -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
+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.
.TP
-.B \-CC
+.B -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
+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.
+and dtd files are updated if -CC is used.
.TP
-.B \-c [filename/wildcard]
-see \-\-color\-toggle
+.B -c [filename/wildcard]
+see --color-toggle
.TP
-.B \-\-dal [filename/wildcard/url]
+.B --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
+output. This step is assumed for most processing flags. To skip it see -n.
+Alias -m
.TP
-.B \-\-delete [filename/wildcard]
-see \-\-zap
+.B --delete [filename/wildcard]
+see --zap
.TP
-.B \-D [instruction] [filename]
-see \-\-pg
+.B -D [instruction] [filename]
+see --pg
.TP
-.B \-d [\-\-db\-[database \ type \ (sqlite|pg)]] \-\-[instruction] [filename]
-see \-\-sqlite
+.B -d [--db-[database \ type \ (sqlite|pg)]] --[instruction] [filename]
+see --sqlite
.TP
-.B \-\-epub [filename/wildcard]
+.B --epub [filename/wildcard]
produces an epub document, [sisu \ version \ 2 \ only] (filename.epub). Alias
-\-e
+-e
.TP
-.B \-e [filename/wildcard]
-see \-\-epub
+.B -e [filename/wildcard]
+see --epub
.TP
-.B \-F [\-\-webserv=webrick]
-see \-\-sample\-search\-form
+.B -F [--webserv=webrick]
+see --sample-search-form
.TP
-.B \-\-git [filename/wildcard]
+.B --git [filename/wildcard]
produces or updates markup source file structure in a git repo (experimental
-and subject to change). Alias \-g
+and subject to change). Alias -g
.TP
-.B \-g [filename/wildcard]
-see \-\-git
+.B -g [filename/wildcard]
+see --git
.TP
-.B \-\-harvest *.ss[tm]
+.B --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.
+title, date, topic_register). Can be used with maintenance (-M) and remote
+placement (-R) flags.
.TP
-.B \-\-help [topic]
+.B --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,
@@ -302,160 +307,175 @@ headings, endnotes, tables, example, customise, skin, (dir)ectories, path,
features, license
.TP
-.B \-\-html [filename/wildcard]
+.B --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
+index.html) and the document in a single file (scroll.html). Alias -h
.TP
-.B \-h [filename/wildcard]
-see \-\-html
+.B -h [filename/wildcard]
+see --html
.TP
-.B \-I [filename/wildcard]
-see \-\-texinfo
+.B -I [filename/wildcard]
+see --texinfo
.TP
-.B \-i [filename/wildcard]
-see \-\-manpage
+.B -i [filename/wildcard]
+see --manpage
.TP
-.B \-L
+.B -L
prints license information.
.TP
-.B \-\-machine [filename/wildcard/url]
-see \-\-dal (document abstraction level/layer)
+.B --machine [filename/wildcard/url]
+see --dal (document abstraction level/layer)
.TP
-.B \-\-maintenance [filename/wildcard/url]
+.B --maintenance [filename/wildcard/url]
maintenance mode files created for processing preserved and their locations
-indicated. (also see \-V). Alias \-M
+indicated. (also see -V). Alias -M
.TP
-.B \-\-manpage [filename/wildcard]
-produces man page of file, not suitable for all outputs. Alias \-i
+.B --manpage [filename/wildcard]
+produces man page of file, not suitable for all outputs. Alias -i
.TP
-.B \-M [filename/wildcard/url]
-see \-\-maintenance
+.B -M [filename/wildcard/url]
+see --maintenance
.TP
-.B \-m [filename/wildcard/url]
-see \-\-dal (document abstraction level/layer)
+.B -m [filename/wildcard/url]
+see --dal (document abstraction level/layer)
.TP
-.B \-\-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.
+.B --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.
.TP
-.B \-N [filename/wildcard/url]
+.B -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.
+that produced it) (digest.txt). -NV for verbose digest output to screen.
.TP
-.B \-n [filename/wildcard/url]
+.B -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
+they already exist, this skips the equivalent of -m which is otherwise assumed
by most processing flags.
.TP
-.B \-\-odf [filename/wildcard/url]
-see \-\-odt
+.B --odf [filename/wildcard/url]
+see --odt
.TP
-.B \-\-odt [filename/wildcard/url]
+.B --odt [filename/wildcard/url]
output basic document in opendocument file format (opendocument.odt). Alias
-\-o
+-o
.TP
-.B \-o [filename/wildcard/url]
-see \-\-odt
+.B -o [filename/wildcard/url]
+see --odt
.TP
-.B \-\-pdf [filename/wildcard]
+.B --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
-'legal' and book sizes 'A5' and 'B5' (system defaults to A4). Alias \-p
+parameter, e.g. --papersize-a4 preset sizes include: 'A4', U.S. 'letter' and
+'legal' and book sizes 'A5' and 'B5' (system defaults to A4). Alias -p
+
+.TP
+.B --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
+
+.TP
+.B --po [language_directory/filename \ language_directory]
+see --po4a
.TP
-.B \-\-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
+.B --po4a [language_directory/filename \ language_directory]
+produces \.pot and po files for the file in the languages specified by the
+language directory.
+.B 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
+
+.TP
+.B -P [language_directory/filename \ language_directory]
+see --po4a
.TP
-.B \-p [filename/wildcard]
-see \-\-pdf
+.B -p [filename/wildcard]
+see --pdf
.TP
-.B \-\-quiet [filename/wildcard]
+.B --quiet [filename/wildcard]
quiet less output to screen.
.TP
-.B \-q [filename/wildcard]
-see \-\-quiet
+.B -q [filename/wildcard]
+see --quiet
.TP
-.B \-\-rsync [filename/wildcard]
+.B --rsync [filename/wildcard]
copies sisu output files to remote host using rsync. This requires that
sisurc.yml has been provided with information on hostname and username, and
that you have your "keys" and ssh agent in place. Note the behavior of rsync
-different if \-R is used with other flags from if used alone. Alone the rsync
-\-\-delete parameter is sent, useful for cleaning the remote directory (when
-\-R is used together with other flags, it is not). Also see \-\-scp. Alias \-R
+different if -R is used with other flags from if used alone. Alone the rsync
+--delete parameter is sent, useful for cleaning the remote directory (when -R
+is used together with other flags, it is not). Also see --scp. Alias -R
.TP
-.B \-R [filename/wildcard]
-see \-\-rsync
+.B -R [filename/wildcard]
+see --rsync
.TP
-.B \-r [filename/wildcard]
-see \-\-scp
+.B -r [filename/wildcard]
+see --scp
.TP
-.B \-\-sample\-search\-form [\-\-webserv=webrick]
+.B --sample-search-form [--webserv=webrick]
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
+-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. Alias \-F
+that they be copied to the cgi-bin directory). -Fv (in addition to the above)
+provides some information on setting up hyperestraier for sisu. Alias -F
.TP
-.B \-\-scp [filename/wildcard]
+.B --scp [filename/wildcard]
copies sisu output files to remote host using scp. This requires that
sisurc.yml has been provided with information on hostname and username, and
-that you have your "keys" and ssh agent in place. Also see \-\-rsync. Alias \-r
+that you have your "keys" and ssh agent in place. Also see --rsync. Alias -r
.TP
-.B \-\-sqlite \-\-[instruction] [filename]
-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. Alias \-d
+.B --sqlite --[instruction] [filename]
+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. Alias -d
.TP
-.B \-\-sisupod
+.B --sisupod
produces a sisupod a zipped sisu directory of markup files including sisu
markup source files and the directories local configuration file, images and
skins. Note: this only includes the configuration files or skins contained in
- \./_sisu not those in ~/.sisu \-S [filename/wildcard] option. Note: (this
-option is tested only with zsh). Alias \-S
+ \./_sisu not those in ~/.sisu -S [filename/wildcard] option. Note: (this option
+is tested only with zsh). Alias -S
.TP
-.B \-\-sisupod [filename/wildcard]
+.B --sisupod [filename/wildcard]
produces a zipped file of the prepared document specified along with
associated images, by default named sisupod.zip they may alternatively be named
with the filename extension \.ssp This provides a quick way of gathering the
@@ -467,192 +487,191 @@ images and skin.
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
+--trust or --trusted is added to the command instruction, it is recommended
that file that are not your own are treated as untrusted. The directory
structure of the unzipped file is understood by sisu, and sisu commands can be
run within it. Note: if you wish to send multiple files, it quickly becomes
more space efficient to zip the sisu markup directory, rather than the
-individual files for sending). See the \-S option without [filename/wildcard].
-Alias \-S
+individual files for sending). See the -S option without [filename/wildcard].
+Alias -S
.TP
-.B \-\-source [filename/wildcard]
-copies sisu markup file to output directory. Alias \-s
+.B --source [filename/wildcard]
+copies sisu markup file to output directory. Alias -s
.TP
-.B \-S
-see \-\-sisupod
+.B -S
+see --sisupod
.TP
-.B \-S [filename/wildcard]
-see \-\-sisupod
+.B -S [filename/wildcard]
+see --sisupod
.TP
-.B \-s [filename/wildcard]
-see \-\-source
+.B -s [filename/wildcard]
+see --source
.TP
-.B \-\-texinfo [filename/wildcard]
-produces texinfo and info file, (view with pinfo). Alias \-I
+.B --texinfo [filename/wildcard]
+produces texinfo and info file, (view with pinfo). Alias -I
.TP
-.B \-\-txt [filename/wildcard]
+.B --txt [filename/wildcard]
produces plaintext with Unix linefeeds and without markup, (object numbers
-are omitted), has footnotes at end of each paragraph that contains them [ \ \-A
-\ for \ equivalent \ dos \ (linefeed) \ output \ file] [see \ \-e \ for \
-endnotes]. (Options include: \-\-endnotes for endnotes \-\-footnotes for
-footnotes at the end of each paragraph \-\-unix for unix linefeed (default)
-\-\-msdos for msdos linefeed). Alias \-t
+are omitted), has footnotes at end of each paragraph that contains them [ \ -A
+\ for \ equivalent \ dos \ (linefeed) \ output \ file] [see \ -e \ for \
+endnotes]. (Options include: --endnotes for endnotes --footnotes for footnotes
+at the end of each paragraph --unix for unix linefeed (default) --msdos for
+msdos linefeed). Alias -t
.TP
-.B \-T [filename/wildcard \ (*.termsheet.rb)]
+.B -T [filename/wildcard \ (*.termsheet.rb)]
standard form document builder, preprocessing feature
.TP
-.B \-t [filename/wildcard]
-see \-\-txt
+.B -t [filename/wildcard]
+see --txt
.TP
-.B \-\-urls [filename/wildcard]
+.B --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
+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
+file system paths in sisurc.yml. Alias -U
.TP
-.B \-U [filename/wildcard]
-see \-\-urls
+.B -U [filename/wildcard]
+see --urls
.TP
-.B \-u [filename/wildcard]
+.B -u [filename/wildcard]
provides url mapping of output files for the flags requested for processing,
-also see \-U
-
-.TP
-.B \-\-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)
+also see -U
.TP
-.B \-\-v2 [filename/wildcard]
+.B --v2 [filename/wildcard]
invokes the sisu v2 document parser/generator. This is the default and is
normally omitted.
.TP
-.B \-\-verbose [filename/wildcard]
+.B --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.
+
+.TP
+.B --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
+(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
.TP
-.B \-V
+.B -V
on its own, provides
.B SiSU
-version and environment information (sisu \-\-help env)
+version and environment information (sisu --help env)
.TP
-.B \-V [filename/wildcard]
-even more verbose than the \-v flag.
+.B -V [filename/wildcard]
+even more verbose than the -v flag.
.TP
-.B \-v
+.B -v
on its own, provides
.B SiSU
version information
.TP
-.B \-v [filename/wildcard]
-see \-\-verbose
+.B -v [filename/wildcard]
+see --verbose
.TP
-.B \-\-webrick
+.B --webrick
starts ruby's webrick webserver points at sisu output directories, the
default port is set to 8081 and can be changed in the resource configuration
files. [tip: \ the \ webrick \ server \ requires \ link \ suffixes, \ so \ html
-\ output \ should \ be \ created \ using \ the \ \-h \ option \ rather \ than \
-\-H \ ; \ also, \ note \ \-F \ webrick \ ]. Alias \-W
+\ output \ should \ be \ created \ using \ the \ -h \ option \ rather \ than \
+-H \ ; \ also, \ note \ -F \ webrick \ ]. Alias -W
.TP
-.B \-W
-see \-\-webrick
+.B -W
+see --webrick
.TP
-.B \-\-wordmap [filename/wildcard]
-see \-\-concordance
+.B --wordmap [filename/wildcard]
+see --concordance
.TP
-.B \-w [filename/wildcard]
-see \-\-concordance
+.B -w [filename/wildcard]
+see --concordance
.TP
-.B \-\-xhtml [filename/wildcard]
-produces xhtml/XML output for browser viewing (sax parsing). Alias \-b
+.B --xhtml [filename/wildcard]
+produces xhtml/XML output for browser viewing (sax parsing). Alias -b
.TP
-.B \-\-xml\-dom [filename/wildcard]
+.B --xml-dom [filename/wildcard]
produces XML output with deep document structure, in the nature of dom. Alias
-\-X
+-X
.TP
-.B \-\-xml\-sax [filename/wildcard]
-produces XML output shallow structure (sax parsing). Alias \-x
+.B --xml-sax [filename/wildcard]
+produces XML output shallow structure (sax parsing). Alias -x
.TP
-.B \-X [filename/wildcard]
-see \-\-xml\-dom
+.B -X [filename/wildcard]
+see --xml-dom
.TP
-.B \-x [filename/wildcard]
-see \-\-xml\-sax
+.B -x [filename/wildcard]
+see --xml-sax
.TP
-.B \-Y [filename/wildcard]
+.B -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
+sisu_manifest. --sitemaps generates/updates the sitemap index of existing
sitemaps. (Experimental, [g,y,m \ announcement \ this \ week])
.TP
-.B \-y [filename/wildcard]
+.B -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.
.TP
-.B \-\-zap [filename/wildcard]
+.B --zap [filename/wildcard]
Zap, if used with other processing flags deletes output files of the type
-about to be processed, prior to processing. If \-Z is used as the lone
-processing related flag (or in conjunction with a combination of \-[mMvVq]),
-will remove the related document output directory. Alias \-Z
+about to be processed, prior to processing. If -Z is used as the lone
+processing related flag (or in conjunction with a combination of -[mMvVq]),
+will remove the related document output directory. Alias -Z
.TP
-.B \-Z [filename/wildcard]
-see \-\-zap
+.B -Z [filename/wildcard]
+see --zap
.SH
3. COMMAND LINE MODIFIERS
.BR
.TP
-.B \-\-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.
+.B --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.
.TP
-.B \-\-no\-annotate
+.B --no-annotate
strips output text of editor endnotes[^*1] denoted by asterisk or dagger/plus
sign
.TP
-.B \-\-no\-asterisk
+.B --no-asterisk
strips output text of editor endnotes[^*2] denoted by asterisk sign
.TP
-.B \-\-no\-dagger
+.B --no-dagger
strips output text of editor endnotes[^+1] denoted by dagger/plus sign
.SH
@@ -660,101 +679,101 @@ strips output text of editor endnotes[^+1] denoted by dagger/plus sign
.BR
.BR
-dbi \- database interface
+dbi - database interface
.BR
-\-D or \-\-pgsql set for postgresql \-d or \-\-sqlite default set for sqlite
-\-d is modifiable with \-\-db=[database \ type \ (pgsql \ or \ sqlite)]
+-D or --pgsql set for postgresql -d or --sqlite default set for sqlite -d is
+modifiable with --db=[database \ type \ (pgsql \ or \ sqlite)]
.TP
-.B \-\-pg \-v \-\-createall
+.B --pg -v --createall
initial step, creates required relations (tables, indexes) in existing
postgresql database (a database should be created manually and given the same
-name as working directory, as requested) (rb.dbi) [ \ \-dv \ \-\-createall \
-sqlite \ equivalent] it may be necessary to run sisu \-Dv \-\-createdb
-initially NOTE: at the present time for postgresql it may be necessary to
-manually create the database. The command would be 'createdb [database \ name]'
-where database name would be SiSU_[present \ working \ directory \ name \
-(without \ path)]. Please use only alphanumerics and underscores.
+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.
.TP
-.B \-\-pg \-v \-\-import
-[filename/wildcard] imports data specified to postgresql db (rb.dbi) [ \ \-dv
-\ \-\-import \ sqlite \ equivalent]
+.B --pg -v --import
+[filename/wildcard] imports data specified to postgresql db (rb.dbi) [ \ -dv
+\ --import \ sqlite \ equivalent]
.TP
-.B \-\-pg \-v \-\-update
+.B --pg -v --update
[filename/wildcard] updates/imports specified data to postgresql db (rb.dbi)
-[ \ \-dv \ \-\-update \ sqlite \ equivalent]
+[ \ -dv \ --update \ sqlite \ equivalent]
.TP
-.B \-\-pg \-\-remove
-[filename/wildcard] removes specified data to postgresql db (rb.dbi) [ \ \-d
-\ \-\-remove \ sqlite \ equivalent]
+.B --pg --remove
+[filename/wildcard] removes specified data to postgresql db (rb.dbi) [ \ -d \
+--remove \ sqlite \ equivalent]
.TP
-.B \-\-pg \-\-dropall
-kills data" and drops (postgresql or sqlite) db, tables & indexes [ \ \-d \
-\-\-dropall \ sqlite \ equivalent]
+.B --pg --dropall
+kills data" and drops (postgresql or sqlite) db, tables & indexes [ \ -d \
+--dropall \ sqlite \ equivalent]
.BR
-The \-v is for verbose output.
+The -v is for verbose output.
.SH
5. SHORTCUTS, SHORTHAND FOR MULTIPLE FLAGS
.BR
.TP
-.B \-\-update [filename/wildcard]
+.B --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
+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.
.TP
-.B \-0 to \-5 [filename \ or \ wildcard]
+.B -0 to -5 [filename \ or \ wildcard]
Default shorthand mappings (note that the defaults can be changed/configured
in the sisurc.yml file):
.TP
-.B \-0
-\-mNhwpAobxXyYv [this \ is \ the \ default \ action \ run \ when \ no \
+.B -0
+-mNhwpAobxXyYv [this \ is \ the \ default \ action \ run \ when \ no \
options \ are \ give, \ i.e. \ on \ 'sisu \ [filename]']
.TP
-.B \-1
-\-mhewpy
+.B -1
+-mhewpy
.TP
-.B \-2
-\-mhewpaoy
+.B -2
+-mhewpaoy
.TP
-.B \-3
-\-mhewpAobxXyY
+.B -3
+-mhewpAobxXyY
.TP
-.B \-4
-\-mhewpAobxXDyY \-\-import
+.B -4
+-mhewpAobxXDyY --import
.TP
-.B \-5
-\-mhewpAobxXDyY \-\-update
+.B -5
+-mhewpAobxXDyY --update
.BR
-add \-v for verbose mode and \-c for color, e.g. sisu \-2vc [filename \ or \
+add -v for verbose mode and -c for color, e.g. sisu -2vc [filename \ or \
wildcard]
.BR
-consider \-u for appended url info or \-v for verbose output
+consider -u for appended url info or -v for verbose output
.SH
-5.1 COMMAND LINE WITH FLAGS \- BATCH PROCESSING
+5.1 COMMAND LINE WITH FLAGS - BATCH PROCESSING
.BR
-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.
+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.
.BR
Running sisu (alone without any flags, filenames or wildcards) brings up the
@@ -781,10 +800,10 @@ The manual can be generated from source, found respectively, either within the
tarball or installed locally at:
.BR
- ./data/doc/sisu/v2/sisu_markup_samples/sisu_manual/
+ ./data/doc/sisu/markup-samples/sisu_manual
.BR
- /usr/share/doc/sisu/v2/sisu_markup_samples/sisu_manual/
+ /usr/share/doc/sisu/markup-samples/sisu_manual
.BR
move to the respective directory and type e.g.:
@@ -818,22 +837,22 @@ the sisu manual, the sources files for which are located within the
tarball at:
.BR
- ./data/doc/sisu/v2/sisu_markup_samples/sisu_manual/
+ ./data/doc/sisu/markup-samples/sisu_manual
.BR
Once installed, directory equivalent to:
.BR
- /usr/share/doc/sisu/sisu_manual/
+ /usr/share/doc/sisu/markup-samples/sisu_manual
.BR
Available man pages are converted back to html using man2html:
.BR
- /usr/share/doc/sisu/v2/html/
+ /usr/share/doc/sisu/html/
.BR
- ./data/doc/sisu/v2/html/
+ ./data/doc/sisu/html
.BR
An online version of the sisu man page is available here:
@@ -845,38 +864,38 @@ An online version of the sisu man page is available here:
* sisu.1 <http://www.jus.uio.no/sisu/man/sisu.1.html> [^9]
.SH
-6.3 SISU BUILT\-IN INTERACTIVE HELP
+6.3 SISU BUILT-IN INTERACTIVE HELP
.BR
This is particularly useful for getting the current sisu setup/environment
information:
.BR
- sisu \-\-help
+ sisu --help
.BR
- sisu \-\-help [subject]
+ sisu --help [subject]
.BR
- sisu \-\-help commands
+ sisu --help commands
.BR
- sisu \-\-help markup
+ sisu --help markup
.BR
- sisu \-\-help env [for \ feedback \ on \ the \ way \ your \ system \ is \
+ sisu --help env [for \ feedback \ on \ the \ way \ your \ system \ is \
setup \ with \ regard \ to \ sisu]
.BR
- sisu \-V [environment \ information, \ same \ as \ above \ command]
+ sisu -V [environment \ information, \ same \ as \ above \ command]
.BR
sisu (on its own provides version and some help information)
.BR
-Apart from real\-time information on your current configuration the
+Apart from real-time information on your current configuration the
.B SiSU
-manual and man pages are likely to contain more up\-to\-date information than
+manual and man pages are likely to contain more up-to-date information than
the sisu interactive help (for example on commands and markup).
.BR
@@ -903,6 +922,12 @@ For lists of alternative help sources, see:
/usr/share/doc/sisu/v2/html/sisu.1.html
.BR
+.B sisu generated html
+
+.BR
+ /usr/share/doc/sisu/html/sisu_help_sources/index.html
+
+.BR
<http://sisudoc.org/sisu/sisu_help_sources/index.html>
.SH
@@ -914,7 +939,7 @@ For lists of alternative help sources, see:
.BR
.B SiSU
-source documents are plaintext (UTF\-8)[^11] files
+source documents are plaintext (UTF-8)[^11] files
.BR
All paragraphs are separated by an empty line.
@@ -923,7 +948,7 @@ All paragraphs are separated by an empty line.
Markup is comprised of:
.BR
-* at the top of a document, the document header made up of semantic meta\-data
+* at the top of a document, the document header made up of semantic meta-data
about the document and if desired additional processing instructions (such an
instruction to automatically number headings from a particular level down)
@@ -949,29 +974,29 @@ primary outline of the document structure. Markup of substantive text includes:
* linked text and images
.BR
- * paragraph actions, such as indent, bulleted, numbered\-lists, etc.
+ * paragraph actions, such as indent, bulleted, numbered-lists, etc.
.BR
Some interactive help on markup is available, by typing sisu and selecting
-markup or sisu \-\-help markup
+markup or sisu --help markup
.BR
To check the markup in a file:
.BR
- sisu \-\-identify [filename].sst
+ sisu --identify [filename].sst
.BR
For brief descriptive summary of markup history
.BR
- sisu \-\-query\-history
+ sisu --query-history
.BR
or if for a particular version:
.BR
- sisu \-\-query\-0.38
+ sisu --query-0.38
.SH
7.2 MARKUP EXAMPLES
@@ -1005,15 +1030,15 @@ With
.B SiSU
installed sample skins may be found in:
/usr/share/doc/sisu/sisu_markup_samples/dfsg (or equivalent directory) and if
-sisu\-markup\-samples is installed also under:
-/usr/share/doc/sisu/sisu_markup_samples/non\-free
+sisu-markup-samples is installed also under:
+/usr/share/doc/sisu/sisu_markup_samples/non-free
.SH
8. MARKUP OF HEADERS
.BR
.BR
-Headers contain either: semantic meta\-data about a document, which can be used
+Headers contain either: semantic meta-data about a document, which can be used
by any output module of the program, or; processing instructions.
.BR
@@ -1048,27 +1073,27 @@ to this one:
electronic document, electronic citation, data structure,
citation systems, search
% used_by: manual
- @date: :published: 2008\-05\-22
- :created: 2002\-08\-28
- :issued: 2002\-08\-28
- :available: 2002\-08\-28
- :modified: 2010\-03\-03
+ @date: :published: 2008-05-22
+ :created: 2002-08-28
+ :issued: 2002-08-28
+ :available: 2002-08-28
+ :modified: 2010-03-03
@make: :num_top: 1
:breaks: new=C; break=1
:skin: skin_sisu_manual
:bold: /Gnu|Debian|Ruby|SiSU/
- :manpage: name=sisu \- documents: markup, structuring, publishing
+ :manpage: name=sisu - documents: markup, structuring, publishing
in multiple standard formats, and search;
- synopsis=sisu \ [\-abcDdeFhIiMmNnopqRrSsTtUuVvwXxYyZz0\-9] \ [filename/wildcard \ ]
- . sisu \ [\-Ddcv] \ [instruction]
- . sisu \ [\-CcFLSVvW]
- . sisu \-\-v2 \ [operations]
- . sisu \-\-v1 \ [operations]
+ synopsis=sisu \ [-abcDdeFhIiMmNnopqRrSsTtUuVvwXxYyZz0-9] \ [filename/wildcard \ ]
+ . sisu \ [-Ddcv] \ [instruction]
+ . sisu \ [-CcFLSVvW]
+ . sisu --v2 \ [operations]
+ . sisu --v1 \ [operations]
@links: { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/
{ Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html
{ SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU
{ SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/
- { SiSU @ Ruby Application Archive }http://raa.ruby\-lang.org/project/sisu/
+ { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/
{ SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html
{ SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html
{ SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html
@@ -1082,8 +1107,9 @@ to this one:
.BR
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 Dublin Core meta tags are available
+document as a whole is to be processed. All header instructions take the form
+@headername: or on the next line and indented by once space :subheadername: All
+Dublin Core meta tags are available
.BR
.B @indentifier:
@@ -1103,7 +1129,7 @@ This is a sample header
.nf
- % SiSU 2.0 \ [declared \ file\-type \ identifier \ with \ markup \ version]
+ % SiSU 2.0 \ [declared \ file-type \ identifier \ with \ markup \ version]
.fi
.nf
@@ -1120,14 +1146,14 @@ This is a sample header
.fi
.nf
- @date: :published: \ [year \ or \ yyyy\-mm\-dd]
- :created: \ [year \ or \ yyyy\-mm\-dd]
- :issued: \ [year \ or \ yyyy\-mm\-dd]
- :available: \ [year \ or \ yyyy\-mm\-dd]
- :modified: \ [year \ or \ yyyy\-mm\-dd]
- :valid: \ [year \ or \ yyyy\-mm\-dd]
- :added_to_site: \ [year \ or \ yyyy\-mm\-dd]
- :translated: \ [year \ or \ yyyy\-mm\-dd]
+ @date: :published: \ [year \ or \ yyyy-mm-dd]
+ :created: \ [year \ or \ yyyy-mm-dd]
+ :issued: \ [year \ or \ yyyy-mm-dd]
+ :available: \ [year \ or \ yyyy-mm-dd]
+ :modified: \ [year \ or \ yyyy-mm-dd]
+ :valid: \ [year \ or \ yyyy-mm-dd]
+ :added_to_site: \ [year \ or \ yyyy-mm-dd]
+ :translated: \ [year \ or \ yyyy-mm-dd]
.fi
.nf
@@ -1153,7 +1179,7 @@ This is a sample header
.fi
.nf
- @links: { SiSU }http://www.jus.uio.no/sisu/
+ @links: { SiSU }http://www.sisudoc.org
{ FSF }http://www.fsf.org
.fi
@@ -1188,11 +1214,10 @@ This is a sample header
9.1 HEADING LEVELS
.BR
-Heading levels are :A~ ,:B~ ,:C~ ,1~ ,2~ ,3~ \... :A \- :C being part / section
-headings, followed by other heading levels, and 1 \-6 being headings followed
-by substantive text or sub\-headings. :A~ usually the title :A~? conditional
-level 1 heading (used where a stand\-alone document may be imported into
-another)
+Heading levels are :A~ ,:B~ ,:C~ ,1~ ,2~ ,3~ \... :A - :C being part / section
+headings, followed by other heading levels, and 1 -6 being headings followed by
+substantive text or sub-headings. :A~ usually the title :A~? conditional level
+1 heading (used where a stand-alone document may be imported into another)
.BR
.B :A~ [heading \ text]
@@ -1210,7 +1235,7 @@ Third level heading [this \ is \ a \ heading \ level \ divider]
.BR
.B 1~ [heading \ text]
-Top level heading preceding substantive text of document or sub\-heading 2,
+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),
@@ -1218,9 +1243,9 @@ otherwise takes the form 1~my_filename_for_this_segment
.BR
.B 2~ [heading \ text]
-Second level heading preceding substantive text of document or sub\-heading
-3, the heading level that would normally be marked 1.1 or 1.2 or 1.3 or 2.1
-etc. in a document.
+Second level heading preceding substantive text of document or sub-heading 3
+, the heading level that would normally be marked 1.1 or 1.2 or 1.3 or 2.1 etc.
+in a document.
.BR
.B 3~ [heading \ text]
@@ -1244,13 +1269,12 @@ normally be marked 1.1.1 or 1.1.2 or 1.2.1 or 2.1.1 etc. in a document
.nf
normal text, *{emphasis}*, !{bold text}!, /{italics}/, _{underscore}_, "{citation}",
- ^{superscript}^, ,{subscript},, +{inserted text}+, \-{strikethrough}\- #{monospace}#
-.BR
+ ^{superscript}^, ,{subscript},, +{inserted text}+, -{strikethrough}-, #{monospace}#
normal text
.BR
- !{emphasis}!
+ *{emphasis}* \ [note: \ can \ be \ configured \ to \ be \ represented \ by \ bold, \ italics \ or \ underscore]
.BR
- *{bold text}*
+ !{bold text}!
.BR
_{underscore}_
.BR
@@ -1273,12 +1297,16 @@ normally be marked 1.1.1 or 1.1.2 or 1.2.1 or 2.1.1 etc. in a document
.B resulting output:
.BR
-normal text
+normal text,
.B emphasis
+,
.B bold text
-.I underscore
+,
.I italics
-"citation" ^superscript^ [subscript] ++inserted text++ \-\-strikethrough\-\- monospace
+,
+.I underscore
+, "citation", ^superscript^, [subscript], ++inserted text++,
+--strikethrough--, monospace
.BR
normal text
@@ -1310,7 +1338,7 @@ normal text
++inserted text++
.BR
-\-\-strikethrough\-\-
+--strikethrough--
.BR
monospace
@@ -1388,9 +1416,9 @@ Numbered List (not to be confused with headings/titles, (document structure))
9.4 FOOTNOTES / ENDNOTES
.BR
-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
.BR
.B markup example:
@@ -1463,8 +1491,7 @@ normal text [^+2] continues
.nf
- % note the endnote marker \"~^\"
-.BR
+ % note the endnote marker "~^"
normal text~^ continues
.BR
^~ endnote text following the paragraph in which the marker occurs
@@ -1491,14 +1518,14 @@ decoration is omitted).
.nf
- normal text http://www.jus.uio.no/sisu continues
+ normal text http://www.sisudoc.org/ continues
.fi
.BR
.B resulting output:
.BR
-normal text <http://www.jus.uio.no/sisu> continues
+normal text <http://www.sisudoc.org/> continues
.BR
An escaped url without decoration
@@ -1508,18 +1535,18 @@ An escaped url without decoration
.nf
- normal text _http://www.jus.uio.no/sisu continues
- deb http://www.jus.uio.no/sisu/archive unstable main non\-free
+ normal text _http://www.sisudoc.org/ continues
+ deb http://www.jus.uio.no/sisu/archive unstable main non-free
.fi
.BR
.B resulting output:
.BR
-normal text <_http://www.jus.uio.no/sisu> continues
+normal text <_http://www.sisudoc.org/> continues
.BR
-deb <_http://www.jus.uio.no/sisu/archive> unstable main non\-free
+deb <_http://www.jus.uio.no/sisu/archive> unstable main non-free
.BR
where a code block is used there is neither decoration nor hyperlinking, code
@@ -1530,11 +1557,14 @@ blocks are discussed later in this document
.nf
- deb http://www.jus.uio.no/sisu/archive unstable main non\-free
+ deb http://www.jus.uio.no/sisu/archive unstable main non-free
.BR
- deb\-src http://www.jus.uio.no/sisu/archive unstable main non\-free
+ deb-src http://www.jus.uio.no/sisu/archive unstable main non-free
.fi
+.SH
+9.5.2 LINKING TEXT
+
.BR
To link text or an image to a url the markup is as follows
@@ -1546,14 +1576,11 @@ To link text or an image to a url the markup is as follows
about { SiSU }http://url.org markup
.fi
-.SH
-9.5.2 LINKING TEXT
-
.BR
.B resulting output:
.BR
-about SiSU <http://www.jus.uio.no/sisu/> markup
+aboutSiSU <http://www.sisudoc.org/> markup
.BR
A shortcut notation is available so the url link may also be provided
@@ -1571,7 +1598,7 @@ automatically as a footnote
.B resulting output:
.BR
-abou tSiSU <http://www.jus.uio.no/sisu/> [^14] markup
+about SiSU <http://www.sisudoc.org/> [^14] markup
.SH
9.5.3 LINKING IMAGES
@@ -1585,13 +1612,13 @@ abou tSiSU <http://www.jus.uio.no/sisu/> [^14] markup
.BR
% various url linked images
.BR
- {tux.png 64x80 \"a better way\" }http://www.jus.uio.no/sisu/
+ {tux.png 64x80 "a better way" }http://www.sisudoc.org/
.BR
.BR
- {GnuDebianLinuxRubyBetterWay.png 100x101 \"Way Better \- with Gnu/Linux, Debian and Ruby\" }http://www.jus.uio.no/sisu/
+ {GnuDebianLinuxRubyBetterWay.png 100x101 "Way Better - with Gnu/Linux, Debian and Ruby" }http://www.sisudoc.org/
.BR
.BR
- {~^ ruby_logo.png \"Ruby\" }http://www.ruby\-lang.org/en/
+ {~^ ruby_logo.png "Ruby" }http://www.ruby-lang.org/en/
.BR
.BR
.fi
@@ -1603,14 +1630,14 @@ abou tSiSU <http://www.jus.uio.no/sisu/> [^14] markup
[ tux.png ]
.BR
-tux.png 64x80 \"Gnu/Linux \- a better way\" <http://www.jus.uio.no/sisu/>
+tux.png 64x80 "Gnu/Linux - a better way" <http://www.sisudoc.org/>
.BR
[ \ ruby_logo \ (png \ missing) \ ] [^15]
.BR
-GnuDebianLinuxRubyBetterWay.png 100x101 \"Way Better \- with Gnu/Linux, Debian
-and Ruby\" <http://www.jus.uio.no/sisu/>
+GnuDebianLinuxRubyBetterWay.png 100x101 "Way Better - with Gnu/Linux, Debian
+and Ruby" <http://www.jus.uio.no/sisu/>
.BR
.B linked url footnote shortcut
@@ -1619,7 +1646,7 @@ and Ruby\" <http://www.jus.uio.no/sisu/>
.nf
{~^ \ [text \ to \ link] }http://url.org
% maps to: { \ [text \ to \ link] }http://url.org ~{ http://url.org }~
- % which produces hyper\-linked text within a document/paragraph,
+ % which produces hyper-linked text within a document/paragraph,
with an endnote providing the url for the text location used in the hyperlink
.fi
@@ -1631,7 +1658,7 @@ and Ruby\" <http://www.jus.uio.no/sisu/>
.BR
note at a heading level the same is automatically achieved by providing names
to headings 1, 2 and 3 i.e. 2~[name] and 3~[name] or in the case of
-auto\-heading numbering, without further intervention.
+auto-heading numbering, without further intervention.
.SH
9.6 GROUPED TEXT
@@ -1660,7 +1687,7 @@ Tables may be prepared in two either of two forms
.BR
.B resulting output:
- \ [table \ omitted, \ see \ other \ document \ formats]
+ [table omitted, see other document formats]
.BR
a second form may be easier to work with in cases where there is not much
@@ -1672,7 +1699,7 @@ information in each column
.nf
- !_ Table 3.1: Contributors to Wikipedia, January 2001 \- June 2005
+ !_ Table 3.1: Contributors to Wikipedia, January 2001 - June 2005
{table~h 24; 12; 12; 12; 12; 12; 12;}
|Jan. 2001|Jan. 2002|Jan. 2003|Jan. 2004|July 2004|June 2006
Contributors* | 10| 472| 2,188| 9,653| 25,011| 48,721
@@ -1687,9 +1714,9 @@ information in each column
.B resulting output:
.BR
-.B Table 3.1: Contributors to Wikipedia, January 2001 \- June 2005
+.B Table 3.1: Contributors to Wikipedia, January 2001 - June 2005
- \ [table \ omitted, \ see \ other \ document \ formats]
+ [table omitted, see other document formats]
.BR
* Contributed at least ten times; ** at least 5 times in last month; *** more
@@ -1706,7 +1733,7 @@ than 100 times in last month.
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.
.fi
.BR
@@ -1715,26 +1742,26 @@ than 100 times in last month.
.nf
poem{
- \`Fury said to a
+ `Fury said to a
mouse, That he
met in the
house,
- \"Let us
+ "Let us
both go to
law: I will
prosecute
- YOU. \-\-Come,
- I\'ll take no
+ YOU. --Come,
+ I'll take no
denial; We
must have a
trial: For
really this
- morning I\'ve
+ morning I've
nothing
- to do.\"
+ to do."
Said the
mouse to the
- cur, \"Such
+ cur, "Such
a trial,
dear Sir,
With
@@ -1743,14 +1770,14 @@ than 100 times in last month.
would be
wasting
our
- breath.\"
- \"I\'ll be
- judge, I\'ll
- be jury,\"
+ breath."
+ "I'll be
+ judge, I'll
+ be jury,"
Said
cunning
old Fury:
- \"I\'ll
+ "I'll
try the
whole
cause,
@@ -1758,14 +1785,14 @@ than 100 times in last month.
condemn
you
to
- death.\"\'
+ death."'
}poem
.fi
.BR
.B resulting output:
- \'Fury said to a
+ `Fury said to a
.BR
mouse, That he
.BR
@@ -1773,7 +1800,7 @@ than 100 times in last month.
.BR
house,
.BR
- \"Let us
+ "Let us
.BR
both go to
.BR
@@ -1781,9 +1808,9 @@ than 100 times in last month.
.BR
prosecute
.BR
- YOU. \-\-Come,
+ YOU. --Come,
.BR
- I\'ll take no
+ I'll take no
.BR
denial; We
.BR
@@ -1793,17 +1820,17 @@ than 100 times in last month.
.BR
really this
.BR
- morning I\'ve
+ morning I've
.BR
nothing
.BR
- to do.\"
+ to do."
.BR
Said the
.BR
mouse to the
.BR
- cur, \"Such
+ cur, "Such
.BR
a trial,
.BR
@@ -1821,13 +1848,13 @@ than 100 times in last month.
.BR
our
.BR
- breath.\"
+ breath."
.BR
- \"I\'ll be
+ "I'll be
.BR
- judge, I\'ll
+ judge, I'll
.BR
- be jury,\"
+ be jury,"
.BR
Said
.BR
@@ -1835,7 +1862,7 @@ than 100 times in last month.
.BR
old Fury:
.BR
- \"I\'ll
+ "I'll
.BR
try the
.BR
@@ -1851,7 +1878,7 @@ than 100 times in last month.
.BR
to
.BR
- death.\"\'
+ death."'
.BR
.SH
@@ -1878,26 +1905,26 @@ than 100 times in last month.
.nf
group{
.BR
- \'Fury said to a
+ 'Fury said to a
mouse, That he
met in the
house,
- \"Let us
+ "Let us
both go to
law: I will
prosecute
- YOU. \-\-Come,
- I\'ll take no
+ YOU. --Come,
+ I'll take no
denial; We
must have a
trial: For
really this
- morning I\'ve
+ morning I've
nothing
- to do.\"
+ to do."
Said the
mouse to the
- cur, \"Such
+ cur, "Such
a trial,
dear Sir,
With
@@ -1906,14 +1933,14 @@ than 100 times in last month.
would be
wasting
our
- breath.\"
- \"I\'ll be
- judge, I\'ll
- be jury,\"
+ breath."
+ "I'll be
+ judge, I'll
+ be jury,"
Said
cunning
old Fury:
- \"I\'ll
+ "I'll
try the
whole
cause,
@@ -1921,14 +1948,14 @@ than 100 times in last month.
condemn
you
to
- death.\"\'
+ death."'
}group
.fi
.BR
.B resulting output:
- \'Fury said to a
+ `Fury said to a
.BR
mouse, That he
.BR
@@ -1936,7 +1963,7 @@ than 100 times in last month.
.BR
house,
.BR
- \"Let us
+ "Let us
.BR
both go to
.BR
@@ -1944,9 +1971,9 @@ than 100 times in last month.
.BR
prosecute
.BR
- YOU. \-\-Come,
+ YOU. --Come,
.BR
- I\'ll take no
+ I'll take no
.BR
denial; We
.BR
@@ -1956,17 +1983,17 @@ than 100 times in last month.
.BR
really this
.BR
- morning I\'ve
+ morning I've
.BR
nothing
.BR
- to do.\"
+ to do."
.BR
Said the
.BR
mouse to the
.BR
- cur, \"Such
+ cur, "Such
.BR
a trial,
.BR
@@ -1984,13 +2011,13 @@ than 100 times in last month.
.BR
our
.BR
- breath.\"
+ breath."
.BR
- \"I\'ll be
+ "I'll be
.BR
- judge, I\'ll
+ judge, I'll
.BR
- be jury,\"
+ be jury,"
.BR
Said
.BR
@@ -1998,7 +2025,7 @@ than 100 times in last month.
.BR
old Fury:
.BR
- \"I\'ll
+ "I'll
.BR
try the
.BR
@@ -2014,21 +2041,22 @@ than 100 times in last month.
.BR
to
.BR
- death.\"\'
+ death."'
.BR
.SH
9.6.4 CODE
.BR
-Code tags are used to escape regular sisu markup, and have been used
-extensively within this document to provide examples of
+Code tags code{ \... }code (used as with other group tags described above) are
+used to escape regular sisu markup, and have been used extensively within this
+document to provide examples of
.B SiSU
markup. You cannot however use code tags to escape code tags. They are
however used in the same way as group or poem tags.
.BR
-A code\-block is treated as an object and given a single object number. [an \
+A code-block is treated as an object and given a single object number. [an \
option \ to \ number \ each \ line \ of \ code \ may \ be \ considered \ at \
some \ later \ time]
@@ -2037,26 +2065,26 @@ some \ later \ time]
.nf
- \'Fury said to a
+ `Fury said to a
mouse, That he
met in the
house,
- \"Let us
+ "Let us
both go to
law: I will
prosecute
- YOU. \-\-Come,
- I\'ll take no
+ YOU. --Come,
+ I'll take no
denial; We
must have a
trial: For
really this
- morning I\'ve
+ morning I've
nothing
- to do.\"
+ to do."
Said the
mouse to the
- cur, \"Such
+ cur, "Such
a trial,
dear Sir,
With
@@ -2065,14 +2093,14 @@ some \ later \ time]
would be
wasting
our
- breath.\"
- \"I\'ll be
- judge, I\'ll
- be jury,\"
+ breath."
+ "I'll be
+ judge, I'll
+ be jury,"
Said
cunning
old Fury:
- \"I\'ll
+ "I'll
try the
whole
cause,
@@ -2080,7 +2108,61 @@ some \ later \ time]
condemn
you
to
- death.\"\'
+ death."'
+.fi
+
+.BR
+From
+.B SiSU
+2.7.7 on you can number codeblocks by placing a hash after the opening code
+tag code{# as demonstrated here:
+
+
+.nf
+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."'
.fi
.SH
@@ -2091,13 +2173,13 @@ To make an index append to paragraph the book index term relates to it, using
an equal sign and curly braces.
.BR
-Currently two levels are provided, a main term and if needed a sub\-term.
-Sub\-terms are separated from the main term by a colon.
+Currently two levels are provided, a main term and if needed a sub-term.
+Sub-terms are separated from the main term by a colon.
.nf
- Paragraph containing main term and sub\-term.
- ={Main term:sub\-term}
+ Paragraph containing main term and sub-term.
+ ={Main term:sub-term}
.fi
.BR
@@ -2110,7 +2192,7 @@ The structure of the resulting index would be:
.nf
Main term, 1
- sub\-term, 1
+ sub-term, 1
.fi
.BR
@@ -2119,8 +2201,8 @@ the term refers to more than one paragraph, indicate the number of paragraphs.
.nf
- Paragraph containing main term, second term and sub\-term.
- ={first term; second term: sub\-term}
+ Paragraph containing main term, second term and sub-term.
+ ={first term; second term: sub-term}
.fi
.BR
@@ -2130,29 +2212,29 @@ The structure of the resulting index would be:
.nf
First term, 1,
Second term, 1,
- sub\-term, 1
+ sub-term, 1
.fi
.BR
-If multiple sub\-terms appear under one paragraph, they are separated under the
+If multiple sub-terms appear under one paragraph, they are separated under the
main term heading from each other by a pipe symbol.
.nf
- Paragraph containing main term, second term and sub\-term.
- ={Main term:sub\-term+1|second sub\-term
- A paragraph that continues discussion of the first sub\-term
+ Paragraph containing main term, second term and sub-term.
+ ={Main term:sub-term+1|second sub-term
+ A paragraph that continues discussion of the first sub-term
.fi
.BR
-The plus one in the example provided indicates the first sub\-term spans one
+The plus one in the example provided indicates the first sub-term spans one
additional paragraph. The logical structure of the resulting index would be:
.nf
Main term, 1,
- sub\-term, 1\-3,
- second sub\-term, 1,
+ sub-term, 1-3,
+ second sub-term, 1,
.fi
.SH
@@ -2209,9 +2291,11 @@ MARKUP SYNTAX HISTORY
11. NOTES RELATED TO FILES\-TYPES AND MARKUP SYNTAX
.BR
+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)
+
.BR
-0.38 is substantially current, depreciated 0.16 supported, though file names
-were changed at 0.37
+0.38 is substantially current for version 1.0
.BR
* sisu \-\-query=[sisu \ version \ [0.38] or \'history]
@@ -2251,9 +2335,9 @@ or, backward compatible using the comment marker:
0.38
.BR
-variations include \'
+variations include '
.B SiSU
-(text|master|insert) [version]\' and \'sisu\-[version]\'
+(text|master|insert) [version]' and 'sisu-[version]'
.BR
.B 0.51
@@ -2329,8 +2413,8 @@ The internal document markup of
.BR
.B SiSU
-has in effect two sets of levels to be considered, using 0.38 notation A\-C
-headings/levels, pre\-ordinary paragraphs /pre\-substantive text, and 1\-3
+has in effect two sets of levels to be considered, using 0.38 notation A-C
+headings/levels, pre-ordinary paragraphs /pre-substantive text, and 1-3
headings/levels, levels which are followed by ordinary text. This may be
conceptualised as levels A,B,C, 1,2,3, and using such letter number notation,
in effect: A must exist, optional B and C may follow in sequence (not strict) 1
@@ -2341,7 +2425,7 @@ alternative makes explicit an aspect of structuring documents in
.B SiSU
that is not otherwise obvious to the newcomer (though it appears more
complicated, is more in your face and likely to be understood fairly quickly);
-the substantive text follows levels 1,2,3 and it is \'nice\' to do most work in
+the substantive text follows levels 1,2,3 and it is 'nice' to do most work in
those levels
.BR
@@ -2355,13 +2439,13 @@ those levels
\.ssm and \.ssi to replace \.s1 \.s2 \.s3 \.r1 \.r2 \.r3 and \.si
.BR
-this is captured by the following file \'rename\' instruction:
+this is captured by the following file 'rename' instruction:
.nf
- rename \'s/\.s[123]$/\.sst/\' *.s{1,2,3}
- rename \'s/\.r[123]$/\.ssm/\' *.r{1,2,3}
- rename \'s/\.si$/\.ssi/\' *.si
+ rename 's/\.s[123]$/\.sst/' *.s{1,2,3}
+ rename 's/\.r[123]$/\.ssm/' *.r{1,2,3}
+ rename 's/\.si$/\.ssi/' *.si
.fi
.BR
@@ -2375,7 +2459,7 @@ The internal document markup remains unchanged, from
.BR
.B 0.23
-(2005w36/2) utf\-8 for markup file
+(2005w36/2) utf-8 for markup file
.BR
.B 0.22
@@ -2389,8 +2473,8 @@ relied upon
.BR
.B 0.16
(2005w25/2) substantial changes introduced to make markup cleaner, header
-0~title type, and headings [1\-6]~ introduced, also percentage sign (%) at
-start of a text line as comment marker
+0~title type, and headings [1-6]~ introduced, also percentage sign (%) at start
+of a text line as comment marker
.BR
.B SiSU
@@ -2420,7 +2504,7 @@ has plaintext and binary filetypes, and can process either type of document.
.BR
.B SiSU
-documents are prepared as plain\-text (utf\-8) files with
+documents are prepared as plain-text (utf-8) files with
.B SiSU
markup. They may make reference to and contain images (for example), which
are stored in the directory beneath them _sisu/image.
@@ -2441,10 +2525,10 @@ located locally or on a remote server for which a url is provided.
source markup can be shared with the command:
.BR
- sisu \-s [filename]
+ sisu -s [filename]
.SH
-12.1.1 SISU TEXT \- REGULAR FILES (.SST)
+12.1.1 SISU TEXT - REGULAR FILES (.SST)
.BR
The most common form of document in
@@ -2454,10 +2538,10 @@ The most common form of document in
markup.
.BR
-<http://www.jus.uio.no/sisu/sisu_markup>
+<http://www.sisudoc.org/sisu/sisu_markup>
.BR
-<http://www.jus.uio.no/sisu/sisu_manual>
+<http://www.sisudoc.org/sisu/sisu_manual>
.SH
12.1.2 SISU MASTER FILES (.SSM)
@@ -2489,10 +2573,10 @@ Note: a secondary file of the composite document is built prior to processing
with the same prefix and the suffix \._sst [^17]
.BR
-<http://www.jus.uio.no/sisu/sisu_markup>
+<http://www.sisudoc.org/sisu/sisu_markup>
.BR
-<http://www.jus.uio.no/sisu/sisu_manual>
+<http://www.sisudoc.org/sisu/sisu_manual>
.SH
12.1.3 SISU INSERT FILES (.SSI)
@@ -2515,13 +2599,13 @@ A sisupod is a zipped
text file or set of
.B SiSU
text files and any associated images that they contain (this will be extended
-to include sound and multimedia\-files)
+to include sound and multimedia-files)
.BR
.B SiSU
plaintext files rely on a recognised directory structure to find contents
such as images associated with documents, but all images for example for all
-documents contained in a directory are located in the sub\-directory
+documents contained in a directory are located in the sub-directory
_sisu/image. Without the ability to create a sisupod it can be inconvenient to
manually identify all other files associated with a document. A sisupod
automatically bundles all associated files with the document that is turned
@@ -2539,13 +2623,13 @@ documents.
The command to create a sisupod is:
.BR
- sisu \-S [filename]
+ sisu -S [filename]
.BR
Alternatively, make a pod of the contents of a whole directory:
.BR
- sisu \-S
+ sisu -S
.BR
.B SiSU
@@ -2553,10 +2637,10 @@ processing can be done directly against a sisupod; which may be located
locally or on a remote server for which a url is provided.
.BR
-<http://www.jus.uio.no/sisu/sisu_commands>
+<http://www.sisudoc.org/sisu/sisu_commands>
.BR
-<http://www.jus.uio.no/sisu/sisu_manual>
+<http://www.sisudoc.org/sisu/sisu_manual>
.SH
13. EXPERIMENTAL ALTERNATIVE INPUT REPRESENTATIONS
@@ -2575,25 +2659,25 @@ incomplete and should be handled with care.
.B convert from sst to simple xml representations (sax, dom and node):
.BR
- sisu \-\-to\-sax [filename/wildcard] or sisu \-\-to\-sxs [filename/wildcard]
+ sisu --to-sax [filename/wildcard] or sisu --to-sxs [filename/wildcard]
.BR
- sisu \-\-to\-dom [filename/wildcard] or sisu \-\-to\-sxd [filename/wildcard]
+ sisu --to-dom [filename/wildcard] or sisu --to-sxd [filename/wildcard]
.BR
- sisu \-\-to\-node [filename/wildcard] or sisu \-\-to\-sxn [filename/wildcard]
+ sisu --to-node [filename/wildcard] or sisu --to-sxn [filename/wildcard]
.BR
.B convert to sst from any sisu xml representation (sax, dom and node):
.BR
- sisu \-\-from\-xml2sst [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]]
+ sisu --from-xml2sst [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]]
.BR
or the same:
.BR
- sisu \-\-from\-sxml [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]]
+ sisu --from-sxml [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]]
.SH
13.1.1 XML SAX REPRESENTATION
@@ -2602,19 +2686,19 @@ or the same:
To convert from sst to simple xml (sax) representation:
.BR
- sisu \-\-to\-sax [filename/wildcard] or sisu \-\-to\-sxs [filename/wildcard]
+ sisu --to-sax [filename/wildcard] or sisu --to-sxs [filename/wildcard]
.BR
To convert from any sisu xml representation back to sst
.BR
- sisu \-\-from\-xml2sst [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]]
+ sisu --from-xml2sst [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]]
.BR
or the same:
.BR
- sisu \-\-from\-sxml [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]]
+ sisu --from-sxml [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]]
.SH
13.1.2 XML DOM REPRESENTATION
@@ -2623,19 +2707,19 @@ or the same:
To convert from sst to simple xml (dom) representation:
.BR
- sisu \-\-to\-dom [filename/wildcard] or sisu \-\-to\-sxd [filename/wildcard]
+ sisu --to-dom [filename/wildcard] or sisu --to-sxd [filename/wildcard]
.BR
To convert from any sisu xml representation back to sst
.BR
- sisu \-\-from\-xml2sst [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]]
+ sisu --from-xml2sst [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]]
.BR
or the same:
.BR
- sisu \-\-from\-sxml [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]]
+ sisu --from-sxml [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]]
.SH
13.1.3 XML NODE REPRESENTATION
@@ -2644,19 +2728,19 @@ or the same:
To convert from sst to simple xml (node) representation:
.BR
- sisu \-\-to\-node [filename/wildcard] or sisu \-\-to\-sxn [filename/wildcard]
+ sisu --to-node [filename/wildcard] or sisu --to-sxn [filename/wildcard]
.BR
To convert from any sisu xml representation back to sst
.BR
- sisu \-\-from\-xml2sst [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]]
+ sisu --from-xml2sst [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]]
.BR
or the same:
.BR
- sisu \-\-from\-sxml [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]]
+ sisu --from-sxml [filename/wildcard \ [.sxs.xml,.sxd.xml,sxn.xml]]
.SH
14. CONFIGURATION
@@ -2671,13 +2755,13 @@ Information on the current configuration of
should be available with the help command:
.BR
- sisu \-v
+ sisu -v
.BR
which is an alias for:
.BR
- sisu \-\-help env
+ sisu --help env
.BR
Either of these should be executed from within a directory that contains sisu
@@ -2747,7 +2831,7 @@ directory, or site wide basis. Skins are looked for in the following locations:
.BR
.B Within the skin directory
-are the following the default sub\-directories for document skins:
+are the following the default sub-directories for document skins:
.BR
./skin/doc
@@ -2807,24 +2891,24 @@ installed sample skins may be found in:
.BR
/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
.BR
-(or equivalent directory) and if sisu\-markup\-samples is installed also under:
+(or equivalent directory) and if sisu-markup-samples is installed also under:
.BR
- /usr/share/doc/sisu\-markup\-samples/v2/samples/_sisu/skin/doc
+ /usr/share/doc/sisu/markup-samples-non-free/samples/_sisu/skin/doc
.BR
Samples of list.yml and promo.yml (which are used to create the right column
list) may be found in:
.BR
- /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)
.SH
-16. CSS \- CASCADING STYLE SHEETS (FOR HTML, XHTML AND XML)
+16. CSS - CASCADING STYLE SHEETS (FOR HTML, XHTML AND XML)
.BR
.BR
@@ -2832,7 +2916,7 @@ CSS files to modify the appearance of
.B SiSU
html, XHTML or XML may be placed in the configuration directory: \./_sisu/css
; ~/.sisu/css or; /etc/sisu/css and these will be copied to the output
-directories with the command sisu \-CC.
+directories with the command sisu -CC.
.BR
The basic CSS file for html output is html.css, placing a file of that name in
@@ -2877,7 +2961,7 @@ subdirectory of the same name as the document with the filetype identifier
stripped (.sst \.ssm)
.BR
-The last part of a directory path, representing the sub\-directory in which a
+The last part of a directory path, representing the sub-directory in which a
document set resides, is the directory name that will be used for the output
directory. This has implications for the organisation of document collections
as it could make sense to place documents of a particular subject, or type
@@ -2900,14 +2984,14 @@ appearance.
.BR
.B SiSU
-is about the ability to auto\-generate documents. Home pages are regarded as
+is about the ability to auto-generate documents. Home pages are regarded as
custom built items, and are not created by
.B SiSU
. More accurately,
.B SiSU
has a default home page, which will not be appropriate for use with other
sites, and the means to provide your own home page instead in one of two ways
-as part of a site\'s configuration, these being:
+as part of a site's configuration, these being:
.BR
1. through placing your home page and other custom built documents in the
@@ -2923,7 +3007,7 @@ subject. Each directory can/should have its own homepage. See the section on
directory structure and organisation of content.
.SH
-18.1 HOME PAGE AND OTHER CUSTOM BUILT PAGES IN A SUB\-DIRECTORY
+18.1 HOME PAGE AND OTHER CUSTOM BUILT PAGES IN A SUB-DIRECTORY
.BR
Custom built pages, including the home page index.html may be placed within the
@@ -2932,7 +3016,7 @@ for the configuration directory, namely \./_sisu ; ~/_sisu ; /etc/sisu From
there they are copied to the root of the output directory with the command:
.BR
- sisu \-CC
+ sisu -CC
.SH
18.2 HOME PAGE WITHIN A SKIN
@@ -2979,16 +3063,12 @@ Current markup examples and document output samples are provided at
<http://www.jus.uio.no/sisu/SiSU/examples.html>
.BR
-Some markup with syntax highlighting may be found under
-<http://www.jus.uio.no/sisu/sample/syntax> but is not as up to date.
-
-.BR
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.
.SH
-20. SISU SEARCH \- INTRODUCTION
+20. SISU SEARCH - INTRODUCTION
.BR
.BR
@@ -3036,14 +3116,14 @@ four tables:
subject, (the Dublin Core...);
.BR
- * another the substantive texts by individual "paragraph" (or object) \-
- along with structural information, each paragraph being identifiable by its
+ * another the substantive texts by individual "paragraph" (or object) - 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
formatted and clean text versions for searching); and
.BR
- * a third containing endnotes cross\-referenced back to the paragraph from
+ * a third containing endnotes cross-referenced back to the paragraph from
which they are referenced (both in formatted and clean text versions for
searching).
@@ -3088,7 +3168,7 @@ that as well).
.BR
.B SiSU
-\- Structured information, Serialized Units \- a document publishing system,
+- Structured information, Serialized Units - a document publishing system,
postgresql dependency package
.SH
@@ -3101,16 +3181,16 @@ dependencies needed for
.B SiSU
to populate a postgresql database, this being part of
.B SiSU
-\- man sisu).
+- man sisu).
.SH
22.3 SYNOPSIS
.BR
- sisu \-D [instruction] [filename/wildcard \ if \ required]
+ sisu -D [instruction] [filename/wildcard \ if \ required]
.BR
- sisu \-D \-\-pg \-\-[instruction] [filename/wildcard \ if \ required]
+ sisu -D --pg --[instruction] [filename/wildcard \ if \ required]
.SH
22.4 COMMANDS
@@ -3118,54 +3198,54 @@ to populate a postgresql database, this being part of
.BR
Mappings to two databases are provided by default, postgresql and sqlite, the
same commands are used within sisu to construct and populate databases however
-\-d (lowercase) denotes sqlite and \-D (uppercase) denotes postgresql,
-alternatively \-\-sqlite or \-\-pgsql may be used
+-d (lowercase) denotes sqlite and -D (uppercase) denotes postgresql,
+alternatively --sqlite or --pgsql may be used
.BR
-.B \-D or \-\-pgsql
+.B -D or --pgsql
may be used interchangeably.
.SH
22.4.1 CREATE AND DESTROY DATABASE
.TP
-.B \-\-pgsql \-\-createall
+.B --pgsql --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)
.TP
-.B sisu \-D \-\-createdb
+.B sisu -D --createdb
creates database where no database existed before
.TP
-.B sisu \-D \-\-create
+.B sisu -D --create
creates database tables where no database tables existed before
.TP
-.B sisu \-D \-\-Dropall
+.B sisu -D --Dropall
destroys database (including all its content)! kills data and drops tables,
indexes and database associated with a given directory (and directories of the
same name).
.TP
-.B sisu \-D \-\-recreate
+.B sisu -D --recreate
destroys existing database and builds a new empty database structure
.SH
22.4.2 IMPORT AND REMOVE DOCUMENTS
.TP
-.B sisu \-D \-\-import \-v [filename/wildcard]
+.B sisu -D --import -v [filename/wildcard]
populates database with the contents of the file. Imports documents(s)
specified to a postgresql database (at an object level).
.TP
-.B sisu \-D \-\-update \-v [filename/wildcard]
+.B sisu -D --update -v [filename/wildcard]
updates file contents in database
.TP
-.B sisu \-D \-\-remove \-v [filename/wildcard]
+.B sisu -D --remove -v [filename/wildcard]
removes specified document from postgresql database.
.SH
@@ -3177,7 +3257,7 @@ removes specified document from postgresql database.
.BR
.B SiSU
-\- Structured information, Serialized Units \- a document publishing system.
+- Structured information, Serialized Units - a document publishing system.
.SH
23.2 DESCRIPTION
@@ -3188,17 +3268,16 @@ dependency package, which is a dummy package to install dependencies needed for
.B SiSU
to populate an sqlite database, this being part of
.B SiSU
-\- man sisu).
+- man sisu).
.SH
23.3 SYNOPSIS
.BR
- sisu \-d [instruction] [filename/wildcard \ if \ required]
+ sisu -d [instruction] [filename/wildcard \ if \ required]
.BR
- sisu \-d \-\-(sqlite|pg) \-\-[instruction] [filename/wildcard \ if \
- required]
+ sisu -d --(sqlite|pg) --[instruction] [filename/wildcard \ if \ required]
.SH
23.4 COMMANDS
@@ -3206,54 +3285,54 @@ to populate an sqlite database, this being part of
.BR
Mappings to two databases are provided by default, postgresql and sqlite, the
same commands are used within sisu to construct and populate databases however
-\-d (lowercase) denotes sqlite and \-D (uppercase) denotes postgresql,
-alternatively \-\-sqlite or \-\-pgsql may be used
+-d (lowercase) denotes sqlite and -D (uppercase) denotes postgresql,
+alternatively --sqlite or --pgsql may be used
.BR
-.B \-d or \-\-sqlite
+.B -d or --sqlite
may be used interchangeably.
.SH
23.4.1 CREATE AND DESTROY DATABASE
.TP
-.B \-\-sqlite \-\-createall
+.B --sqlite --createall
initial step, creates required relations (tables, indexes) in existing
(sqlite) database (a database should be created manually and given the same
name as working directory, as requested) (rb.dbi)
.TP
-.B sisu \-d \-\-createdb
+.B sisu -d --createdb
creates database where no database existed before
.TP
-.B sisu \-d \-\-create
+.B sisu -d --create
creates database tables where no database tables existed before
.TP
-.B sisu \-d \-\-dropall
+.B sisu -d --dropall
destroys database (including all its content)! kills data and drops tables,
indexes and database associated with a given directory (and directories of the
same name).
.TP
-.B sisu \-d \-\-recreate
+.B sisu -d --recreate
destroys existing database and builds a new empty database structure
.SH
23.4.2 IMPORT AND REMOVE DOCUMENTS
.TP
-.B sisu \-d \-\-import \-v [filename/wildcard]
+.B sisu -d --import -v [filename/wildcard]
populates database with the contents of the file. Imports documents(s)
specified to an sqlite database (at an object level).
.TP
-.B sisu \-d \-\-update \-v [filename/wildcard]
+.B sisu -d --update -v [filename/wildcard]
updates file contents in database
.TP
-.B sisu \-d \-\-remove \-v [filename/wildcard]
+.B sisu -d --remove -v [filename/wildcard]
removes specified document from sqlite database.
.SH
@@ -3261,12 +3340,12 @@ removes specified document from sqlite database.
.BR
.SH
-24.1 SEARCH \- DATABASE FRONTEND SAMPLE, UTILISING DATABASE AND SISU FEATURES,
+24.1 SEARCH - DATABASE FRONTEND SAMPLE, UTILISING DATABASE AND SISU FEATURES,
INCLUDING OBJECT CITATION NUMBERING (BACKEND CURRENTLY POSTGRESQL)
.BR
Sample search frontend <http://search.sisudoc.org> [^21] A small database and
-sample query front\-end (search from) that makes use of the citation system,
+sample query front-end (search from) that makes use of the citation system,
.I object citation numbering
to demonstrates functionality.[^22]
@@ -3286,7 +3365,7 @@ the names of the documents matched along with the objects (paragraphs) that
meet the search criteria.[^23]
.TP
-.B sisu \-F \-\-webserv\-webrick
+.B sisu -F --webserv-webrick
builds a cgi web search frontend for the database created
.BR
@@ -3294,7 +3373,7 @@ The following is feedback on the setup on a machine provided by the help
command:
.BR
- sisu \-\-help sql
+ sisu --help sql
.nf
@@ -3323,21 +3402,21 @@ necessary]
24.2 SEARCH FORM
.TP
-.B sisu \-F
-generates a sample search form, which must be copied to the web\-server cgi
+.B sisu -F
+generates a sample search form, which must be copied to the web-server cgi
directory
.TP
-.B sisu \-F \-\-webserv\-webrick
+.B sisu -F --webserv-webrick
generates a sample search form for use with the webrick server, which must be
-copied to the web\-server cgi directory
+copied to the web-server cgi directory
.TP
-.B sisu \-Fv
+.B sisu -Fv
as above, and provides some information on setting up hyperestraier
.TP
-.B sisu \-W
+.B sisu -W
starts the webrick server which should be available wherever sisu is properly
installed
@@ -3369,7 +3448,7 @@ directory /home/ralph/sisu_www
(A) to generate the index within the webserver directory to be indexed:
.BR
- estcmd gather \-sd [index \ name] [directory \ path \ to \ index]
+ estcmd gather -sd [index \ name] [directory \ path \ to \ index]
.BR
the following are examples that will need to be tailored according to your
@@ -3379,15 +3458,15 @@ needs:
cd /home/ralph/sisu_www
.BR
- estcmd gather \-sd casket /home/ralph/sisu_www
+ estcmd gather -sd casket /home/ralph/sisu_www
.BR
-you may use the \'find\' command together with \'egrep\' to limit indexing to
+you may use the 'find' command together with 'egrep' to limit indexing to
particular document collection directories within the web server directory:
.BR
- find /home/ralph/sisu_www \-type f | egrep
- \'/home/ralph/sisu_www/sisu/.+?.html$\' |estcmd gather \-sd casket \-
+ find /home/ralph/sisu_www -type f | egrep
+ '/home/ralph/sisu_www/sisu/.+?.html$' |estcmd gather -sd casket -
.BR
Check which directories in the webserver/output directory (~/sisu_www or
@@ -3396,25 +3475,24 @@ elsewhere depending on configuration) you wish to include in the search index.
.BR
As sisu duplicates output in multiple file formats, it it is probably
preferable to limit the estraier index to html output, and as it may also be
-desirable to exclude files \'plain.txt\', \'toc.html\' and
-\'concordance.html\', as these duplicate information held in other html output
-e.g.
+desirable to exclude files 'plain.txt', 'toc.html' and 'concordance.html', as
+these duplicate information held in other html output e.g.
.BR
- find /home/ralph/sisu_www \-type f | egrep
- \'/sisu_www/(sisu|bookmarks)/.+?.html$\' | egrep \-v
- \'(doc|concordance).html$\' |estcmd gather \-sd casket \-
+ find /home/ralph/sisu_www -type f | egrep
+ '/sisu_www/(sisu|bookmarks)/.+?.html$' | egrep -v '(doc|concordance).html$'
+ |estcmd gather -sd casket -
.BR
from your current document preparation/markup directory, you would construct a
rune along the following lines:
.BR
- find /home/ralph/sisu_www \-type f | egrep \'/home/ralph/sisu_www/([specify \
+ find /home/ralph/sisu_www -type f | egrep '/home/ralph/sisu_www/([specify \
first \ directory \ for \ inclusion]|[specify \ second \ directory \ for \
- inclusion]|[another \ directory \ for \ inclusion? \ \...])/.+?.html$\' |
- egrep \-v \'(doc|concordance).html$\' |estcmd gather \-sd
- /home/ralph/sisu_www/casket \-
+ inclusion]|[another \ directory \ for \ inclusion? \ \...])/.+?.html$' |
+ egrep -v '(doc|concordance).html$' |estcmd gather -sd
+ /home/ralph/sisu_www/casket -
.BR
(B) to set up the search form
@@ -3423,20 +3501,20 @@ rune along the following lines:
(i) copy estseek.cgi to your cgi directory and set file permissions to 755:
.BR
- sudo cp \-vi /usr/lib/estraier/estseek.cgi /usr/lib/cgi\-bin
+ sudo cp -vi /usr/lib/estraier/estseek.cgi /usr/lib/cgi-bin
.BR
- sudo chmod \-v 755 /usr/lib/cgi\-bin/estseek.cgi
+ sudo chmod -v 755 /usr/lib/cgi-bin/estseek.cgi
.BR
- sudo cp \-v /usr/share/hyperestraier/estseek.* /usr/lib/cgi\-bin
+ sudo cp -v /usr/share/hyperestraier/estseek.* /usr/lib/cgi-bin
.BR
[see \ estraier \ documentation \ for \ paths]
.BR
-(ii) edit estseek.conf, with attention to the lines starting \'indexname:\' and
-\'replace:\':
+(ii) edit estseek.conf, with attention to the lines starting 'indexname:' and
+'replace:':
.BR
indexname: /home/ralph/sisu_www/casket
@@ -3451,10 +3529,10 @@ rune along the following lines:
(C) to test using webrick, start webrick:
.BR
- sisu \-W
+ sisu -W
.BR
-and try open the url: <http://localhost:8081/cgi\-bin/estseek.cgi>
+and try open the url: <http://localhost:8081/cgi-bin/estseek.cgi>
.SH
26. SISU_WEBRICK
@@ -3465,7 +3543,7 @@ and try open the url: <http://localhost:8081/cgi\-bin/estseek.cgi>
.BR
.B SiSU
-\- Structured information, Serialized Units \- a document publishing system
+- Structured information, Serialized Units - a document publishing system
.SH
26.2 SYNOPSIS
@@ -3477,7 +3555,7 @@ sisu_webrick [port]
or
.BR
-sisu \-W [port]
+sisu -W [port]
.SH
26.3 DESCRIPTION
@@ -3487,7 +3565,7 @@ sisu_webrick is part of
.B SiSU
(man sisu) sisu_webrick starts
.B Ruby
-\'s Webrick web\-server and points it to the directories to which
+' s Webrick web-server and points it to the directories to which
.B SiSU
output is written, providing a list of these directories (assuming
.B SiSU
@@ -3502,8 +3580,8 @@ yaml file: ~/.sisu/sisurc.yml a sample of which is provided as
26.4 SUMMARY OF MAN PAGE
.BR
-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]
+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]
.BR
where no port is given and settings are unchanged the default port is 8081
@@ -3512,9 +3590,9 @@ where no port is given and settings are unchanged the default port is 8081
26.5 DOCUMENT PROCESSING COMMAND FLAGS
.BR
-sisu \-W [port] starts
+sisu -W [port] starts
.B Ruby
-Webrick web\-server, serving
+Webrick web-server, serving
.B 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
@@ -3525,7 +3603,7 @@ defaults have not been changed in ~/.sisu/sisurc.yaml then on port 8081
.BR
For more information on
.B SiSU
-see: <http://www.jus.uio.no/sisu>
+see: <http://www.sisudoc.org/> or <http://www.jus.uio.no/sisu>
.BR
or man sisu
@@ -3562,7 +3640,7 @@ documents can either be sisu marked up files in plaintext \.sst or \.ssm or;
zipped sisu files, sisupod.zip or filename.ssp
.BR
-.B \.sst / \.ssm \- sisu text files
+.B \.sst / \.ssm - sisu text files
.BR
.B SiSU
@@ -3572,13 +3650,13 @@ processing instruction and the url. The source file and any associated parts
.nf
- sisu \-3 http://[provide \ url \ to \ valid \ \.sst \ or \ \.ssm \ file]
+ sisu -3 http://[provide \ url \ to \ valid \ \.sst \ or \ \.ssm \ file]
.fi
.BR
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.
+see <http://www.jus.uio.no/sisu/SiSU/examples.html> and use the url to the
+ \.sst for the desired document.
.BR
NOTE: to set up a remote machine to serve
@@ -3587,7 +3665,7 @@ documents in this way, images should be in the directory relative to the
document source \../_sisu/image
.BR
-.B sisupod \- zipped sisu files
+.B sisupod - zipped sisu files
.BR
A sisupod is the zipped content of a sisu marked up text or texts and any other
@@ -3601,7 +3679,7 @@ documents it contains generated locally.
.nf
- sisu \-3 http://[provide \ url \ to \ valid \ sisupod.zip \ or \ \.ssp \ file]
+ sisu -3 http://[provide \ url \ to \ valid \ sisupod.zip \ or \ \.ssp \ file]
.fi
.BR
@@ -3626,37 +3704,37 @@ machine using either rsync, or scp.
.BR
In order to do this some ssh authentication agent and keychain or similar tool
will need to be configured. Once that is done the placement on a remote host
-can be done seamlessly with the \-r (for scp) or \-R (for rsync) flag, which
-may be used in conjunction with other processing flags, e.g.
+can be done seamlessly with the -r (for scp) or -R (for rsync) flag, which may
+be used in conjunction with other processing flags, e.g.
.nf
- sisu \-3R sisu_remote.sst
+ sisu -3R sisu_remote.sst
.fi
.SH
28.1 COMMANDS
.TP
-.B \-R [filename/wildcard]
+.B -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 \"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
+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
.TP
-.B \-r [filename/wildcard]
+.B -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 \"keys\" and ssh agent in place. Also see \-R
+that you have your "keys" and ssh agent in place. Also see -R
.SH
28.2 CONFIGURATION
.BR
-[expand \ on \ the \ setting \ up \ of \ an \ ssh\-agent \ / \ keychain]
+[expand \ on \ the \ setting \ up \ of \ an \ ssh-agent \ / \ keychain]
.SH
29. REMOTE SERVERS
@@ -3673,7 +3751,7 @@ 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.
.SH
-30. QUICKSTART \- GETTING STARTED HOWTO
+30. QUICKSTART - GETTING STARTED HOWTO
.BR
.SH
@@ -3698,8 +3776,7 @@ Sid and testing archives (and possibly Ubuntu), assuming your
.nf
aptitude update
-.BR
- aptitude install sisu\-complete
+ aptitude install sisu-complete
.fi
.BR
@@ -3710,11 +3787,11 @@ markup samples:
.nf
#/etc/apt/sources.list
.BR
- deb http://ftp.fi.debian.org/debian/ unstable main non\-free contrib
+ deb http://ftp.fi.debian.org/debian/ unstable main non-free contrib
.BR
- deb\-src http://ftp.fi.debian.org/debian/ unstable main non\-free contrib
+ deb-src http://ftp.fi.debian.org/debian/ unstable main non-free contrib
.BR
- d
+
.fi
.BR
@@ -3724,7 +3801,7 @@ The aptitude commands become:
.nf
aptitude update
.BR
- aptitude install sisu\-complete sisu\-markup\-samples
+ aptitude install sisu-complete sisu-markup-samples
.fi
.BR
@@ -3738,8 +3815,8 @@ archives, they will be available by adding the following to your
.nf
#/etc/apt/sources.list
- deb http://www.jus.uio.no/sisu/archive unstable main non\-free
- deb\-src http://www.jus.uio.no/sisu/archive unstable main non\-free
+ 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
.fi
.BR
@@ -3748,11 +3825,11 @@ repeat the aptitude commands
.nf
aptitude update
- aptitude install sisu\-complete sisu\-markup\-samples
+ aptitude install sisu-complete sisu-markup-samples
.fi
.BR
-Note however that it is not necessary to install sisu\-complete if not all
+Note however that it is not necessary to install sisu-complete if not all
components of sisu are to be used. Installing just the package sisu will
provide basic functionality.
@@ -3773,7 +3850,7 @@ They may be downloaded from:
as root type:
.BR
- rpm \-i [rpm \ package \ name]
+ rpm -i [rpm \ package \ name]
.SH
30.1.3 INSTALLATION FROM SOURCE
@@ -3837,11 +3914,11 @@ further information on setup.rb is available from:
<http://i.loveruby.net/en/projects/setup/doc/usage.html>
.BR
-.B \"install\"
+.B "install"
.BR
-The \"install\" file provided is an installer prepared using \"rant\". In the
-root directory of the unpacked
+The "install" file provided is an installer prepared using "rant". In the root
+directory of the unpacked
.B SiSU
as root type:
@@ -3864,10 +3941,10 @@ or
This makes use of Rant (by Stefan Lang) and the provided Rantfile. It has been
configured to do post installation setup setup configuration and generation of
first test file. Note however, that additional external package dependencies,
-such as tetex\-extra are not taken care of for you.
+such as tetex-extra are not taken care of for you.
.BR
-Further information on \"rant\" is available from:
+Further information on "rant" is available from:
.BR
<http://make.rubyforge.org/>
@@ -3882,7 +3959,7 @@ For a list of alternative actions you may type:
ruby install help
.BR
- ruby install \-T
+ ruby install -T
.SH
30.2 TESTING SISU, GENERATING OUTPUT
@@ -3891,7 +3968,7 @@ For a list of alternative actions you may type:
To check which version of sisu is installed:
.BR
-sisu \-v
+sisu -v
.BR
Depending on your mode of installation one or a number of markup sample files
@@ -3920,7 +3997,7 @@ Having moved to the directory that contains the markup samples (see
instructions above if necessary), choose a file and run sisu against it
.BR
-sisu \-NhwoabxXyv free_as_in_freedom.rms_and_free_software.sam_williams.sst
+sisu -NhwoabxXyv free_as_in_freedom.rms_and_free_software.sam_williams.sst
.BR
this will generate html including a concordance file, opendocument text format,
@@ -3931,7 +4008,7 @@ plaintext, XHTML and various forms of XML, and OpenDocument text
.BR
Assuming a LaTeX engine such as tetex or texlive is installed with the required
-modules (done automatically on selection of sisu\-pdf in
+modules (done automatically on selection of sisu-pdf in
.B Debian
)
@@ -3940,10 +4017,10 @@ Having moved to the directory that contains the markup samples (see
instructions above if necessary), choose a file and run sisu against it
.BR
-sisu \-pv free_as_in_freedom.rms_and_free_software.sam_williams.sst
+sisu -pv free_as_in_freedom.rms_and_free_software.sam_williams.sst
.BR
-sisu \-3 free_as_in_freedom.rms_and_free_software.sam_williams.sst
+sisu -3 free_as_in_freedom.rms_and_free_software.sam_williams.sst
.BR
should generate most available output formats: html including a concordance
@@ -3951,27 +4028,27 @@ file, opendocument text format, plaintext, XHTML and various forms of XML, and
OpenDocument text and pdf
.SH
-30.2.3 RELATIONAL DATABASE \- POSTGRESQL, SQLITE
+30.2.3 RELATIONAL DATABASE - POSTGRESQL, SQLITE
.BR
-Relational databases need some setting up \- you must have permission to create
+Relational databases need some setting up - you must have permission to create
the database and write to it when you run sisu.
.BR
Assuming you have the database installed and the requisite permissions
.BR
-sisu \-\-sqlite \-\-recreate
+sisu --sqlite --recreate
.BR
-sisu \-\-sqlite \-v \-\-import
+sisu --sqlite -v --import
free_as_in_freedom.rms_and_free_software.sam_williams.sst
.BR
-sisu \-\-pgsql \-\-recreate
+sisu --pgsql --recreate
.BR
-sisu \-\-pgsql \-v \-\-import
+sisu --pgsql -v --import
free_as_in_freedom.rms_and_free_software.sam_williams.sst
.SH
@@ -3991,10 +4068,10 @@ The man pages are also available online, though not always kept as up to date
as within the package itself:
.BR
-* sisu.1 <http://www.jus.uio.no/sisu/man/sisu.1> [^25]
+* sisu.1 <http://www.jus.uio.no/sisu/man/sisu.1.html> [^25]
.BR
-* sisu.8 <http://www.jus.uio.no/sisu/man/sisu.8> [^26]
+* sisu.8 <http://www.jus.uio.no/sisu/man/sisu.8.html> [^26]
.BR
* man directory <http://www.jus.uio.no/sisu/man> [^27]
@@ -4003,21 +4080,24 @@ as within the package itself:
30.3.2 BUILT IN HELP
.BR
-sisu \-\-help
+sisu --help
.BR
-sisu \-\-help \-\-env
+sisu --help --env
.BR
-sisu \-\-help \-\-commands
+sisu --help --commands
.BR
-sisu \-\-help \-\-markup
+sisu --help --markup
.SH
30.3.3 THE HOME PAGE
.BR
+<http://www.sisudoc.org/>
+
+.BR
<http://www.jus.uio.no/sisu>
.BR
@@ -4041,9 +4121,9 @@ Additional markup samples are packaged separately in the file:
.BR
On
.B 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.
+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.
.SH
31. EDITOR FILES, SYNTAX HIGHLIGHTING
@@ -4053,10 +4133,16 @@ home site.
The directory:
.BR
- \./data/sisu/v2/conf/editor\-syntax\-etc/
+ \./data/sisu/v2/conf/editor-syntax-etc/
.BR
- /usr/share/sisu/v2/conf/editor\-syntax\-etc
+ \./data/sisu/v3/conf/editor-syntax-etc/
+
+.BR
+ /usr/share/sisu/v2/conf/editor-syntax-etc
+
+.BR
+ /usr/share/sisu/v3/conf/editor-syntax-etc
.BR
contains rudimentary sisu syntax highlighting files for:
@@ -4065,7 +4151,7 @@ contains rudimentary sisu syntax highlighting files for:
* (g)vim <http://www.vim.org>
.BR
- package: sisu\-vim
+ package: sisu-vim
.BR
status: largely done
@@ -4086,13 +4172,13 @@ status: largely done
place in:
.BR
- /usr/share/gtksourceview\-1.0/language\-specs
+ /usr/share/gtksourceview-1.0/language-specs
.BR
or
.BR
- ~/.gnome2/gtksourceview\-1.0/language\-specs
+ ~/.gnome2/gtksourceview-1.0/language-specs
.BR
status: very basic syntax highlighting
@@ -4101,7 +4187,7 @@ or
comments: this editor features display line wrap and is used by Goby!
.BR
-* nano <http://www.nano\-editor.org>
+* nano <http://www.nano-editor.org>
.BR
file: nanorc
@@ -4116,7 +4202,7 @@ save as:
status: basic syntax highlighting
.BR
- comments: assumes dark background; no display line\-wrap; does line breaks
+ comments: assumes dark background; no display line-wrap; does line breaks
.BR
* diakonos (an editor written in ruby) <http://purepistos.net/diakonos>
@@ -4137,7 +4223,7 @@ includes:
status: basic syntax highlighting
.BR
-comments: assumes dark background; no display line\-wrap
+comments: assumes dark background; no display line-wrap
.BR
* kate & kwrite <http://kate.kde.org>
@@ -4170,7 +4256,7 @@ comments: assumes dark background; no display line\-wrap
file: sisu_nedit.pats
.BR
- nedit \-import sisu_nedit.pats
+ nedit -import sisu_nedit.pats
.BR
status: a very clumsy first attempt [not \ really \ done]
@@ -4182,16 +4268,17 @@ comments: assumes dark background; no display line\-wrap
* emacs <http://www.gnu.org/software/emacs/emacs.html>
.BR
- files: sisu\-mode.el
+ files: sisu-mode.el
.BR
to file ~/.emacs add the following 2 lines:
.BR
- (add\-to\-list \'load\-path \"/usr/share/sisu/v1/conf/editor\-syntax\-etc/emacs\")
+ (add-to-list 'load-path
+ "/usr/share/sisu/v2/conf/editor-syntax-etc/emacs")
.BR
- (require \'sisu\-mode.el)
+ (require 'sisu-mode.el)
.BR
[not \ done \ / \ not \ yet \ included]
@@ -4218,7 +4305,7 @@ NOTE:
.BR
[ \ .B \ SiSU \ parses \ files \ with \ long \ lines \ or \ line \ breaks, \
-but, \ display \ linewrap \ (without \ line\-breaks) \ is \ a \ convenient \
+but, \ display \ linewrap \ (without \ line-breaks) \ is \ a \ convenient \
editor \ feature \ to \ have \ for \ sisu \ markup]
.SH
@@ -4237,7 +4324,7 @@ must be able to discern the structure of a document, (text headings and their
levels in relation to each other), either from information provided in the
document header or from markup within the text (or from a combination of both).
Processing is done against an abstraction of the document comprising of
-information on the document\'s structure and its objects,[2] which the program
+information on the document's structure and its objects,[2] which the program
serializes (providing the object numbers) and which are assigned hash sum
values based on their content. This abstraction of information about document
structure, objects, (and hash sums), provides considerable flexibility in
@@ -4251,9 +4338,9 @@ ways of representing documents, (or indeed to create new ones).
.BR
.BR
-* 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 \"War and Peace\" require almost no markup, and most of the
+* 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 "War and Peace" require almost no markup, and most of the
headers are optional.
.BR
@@ -4263,8 +4350,8 @@ and more sparse than the most basic HTML), [this \ may \ also \ be \ converted
.BR
* 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
+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.
@@ -4282,7 +4369,7 @@ different strengths of various standard formats for representing documents,
amongst the output formats currently supported are:
.BR
- * html \- both as a single scrollable text and a segmented document
+ * html - both as a single scrollable text and a segmented document
.BR
* xhtml
@@ -4291,21 +4378,21 @@ amongst the output formats currently supported are:
* epub
.BR
- * XML \- both in sax and dom style xml structures for further development as
+ * XML - both in sax and dom style xml structures for further development as
required
.BR
- * ODF \- open document format, the iso standard for document storage
+ * ODF - open document format, the iso standard for document storage
.BR
- * LaTeX \- used to generate pdf
+ * LaTeX - used to generate pdf
.BR
* pdf (via LaTeX)
.BR
- * sql \- population of an sql database, (at the same object level that is
- used to cite text within a document)
+ * sql - population of an sql database, (at the same object level that is used
+ to cite text within a document)
.BR
Also produces: concordance files; document content certificates (md5 or sha256
@@ -4336,10 +4423,11 @@ 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].
-.BR * 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
+.BR
+* 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
@@ -4354,7 +4442,7 @@ to be done only once but may be repeated for various reasons as desired
presentations/representations)
.BR
-* document source (plaintext utf\-8) if shared on the net may be used as input
+* document source (plaintext utf-8) if shared on the net may be used as input
and processed locally to produce the different document outputs
.BR
@@ -4428,7 +4516,7 @@ try one of the following:
<http://www.jus.uio.no/sisu/man/sisu_help.1.html>
.BR
-.B sisu generated output \- links to html
+.B sisu generated output - links to html
.BR
<http://sisudoc.org/sisu/sisu_help/index.html>
@@ -4455,114 +4543,75 @@ Alternative sources for this help sources page listed here:
man sisu
.BR
- man 7 sisu_complete
-
-.BR
- man 7 sisu_pdf
-
-.BR
- man 7 sisu_postgresql
-
-.BR
- man 7 sisu_sqlite
-
-.BR
- man sisu_termsheet
-
-.BR
- man sisu_webrick
-
-.SH
-34.2 SISU GENERATED OUTPUT \- LINKS TO HTML
-
-.BR
-Note
-.B SiSU
-documentation is prepared in
-.B 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]
-
-.SH
-34.2.1 WWW.SISUDOC.ORG
-
-.BR
-<http://sisudoc.org/sisu/sisu_manual/index.html>
-
-.BR
- <http://sisudoc.org/sisu/sisu_manual/index.html>
-
-.BR
- <http://sisudoc.org/sisu/sisu_commands/index.html>
-
-.BR
- <http://sisudoc.org/sisu/sisu_complete/index.html>
-
-.BR
- <http://sisudoc.org/sisu/sisu_configuration/index.html>
+ man sisu-concordance
.BR
- <http://sisudoc.org/sisu/sisu_description/index.html>
+ man sisu-epub
.BR
- <http://sisudoc.org/sisu/sisu_examples/index.html>
+ man sisu-git
.BR
- <http://sisudoc.org/sisu/sisu_faq/index.html>
+ man sisu-harvest
.BR
- <http://sisudoc.org/sisu/sisu_filetypes/index.html>
+ man sisu-html
.BR
- <http://sisudoc.org/sisu/sisu_help/index.html>
+ man sisu-odf
.BR
- <http://sisudoc.org/sisu/sisu_help_sources/index.html>
+ man sisu-pdf
.BR
- <http://sisudoc.org/sisu/sisu_howto/index.html>
+ man sisu-pg
.BR
- <http://sisudoc.org/sisu/sisu_introduction/index.html>
+ man sisu-po
.BR
- <http://sisudoc.org/sisu/sisu_manual/index.html>
+ man sisu-sqlite
.BR
- <http://sisudoc.org/sisu/sisu_markup/index.html>
+ man sisu-txt
.BR
- <http://sisudoc.org/sisu/sisu_output_overview/index.html>
+ man 7 sisu_complete
.BR
- <http://sisudoc.org/sisu/sisu_pdf/index.html>
+ man 7 sisu_pdf
.BR
- <http://sisudoc.org/sisu/sisu_postgresql/index.html>
+ man 7 sisu_postgresql
.BR
- <http://sisudoc.org/sisu/sisu_quickstart/index.html>
+ man 7 sisu_sqlite
.BR
- <http://sisudoc.org/sisu/sisu_remote/index.html>
+ man sisu_termsheet
.BR
- <http://sisudoc.org/sisu/sisu_search/index.html>
+ man sisu_webrick
-.BR
- <http://sisudoc.org/sisu/sisu_skin/index.html>
+.SH
+34.2 SISU GENERATED OUTPUT - LINKS TO HTML
.BR
- <http://sisudoc.org/sisu/sisu_sqlite/index.html>
+Note
+.B SiSU
+documentation is prepared in
+.B 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[^29]
-.BR
- <http://sisudoc.org/sisu/sisu_syntax_highlighting/index.html>
+.SH
+34.2.1 WWW.SISUDOC.ORG
.BR
- <http://sisudoc.org/sisu/sisu_vim/index.html>
+<http://sisudoc.org/sisu/sisu_manual/index.html>
.BR
- <http://sisudoc.org/sisu/sisu_webrick/index.html>
+ <http://sisudoc.org/sisu/sisu_manual/index.html>
.SH
34.3 MAN2HTML
@@ -4571,28 +4620,22 @@ pdf, odf and epub which may be also be accessed via the html pages[^28]
34.3.1 LOCALLY INSTALLED
.BR
-<file:///usr/share/doc/sisu/v2/html/sisu.1.html>
-
-.BR
-<file:///usr/share/doc/sisu/v2/html/sisu_help.1.html>
+file:///usr/share/doc/sisu/html/sisu.1.html
.BR
-<file:///usr/share/doc/sisu/v2/html/sisu_help_sources.1.html>
+ file:///usr/share/doc/sisu/html/sisu.1.html
.BR
- /usr/share/doc/sisu/v2/html/sisu.1.html
-
-.BR
- /usr/share/doc/sisu/v2/html/sisu_pdf.7.html
+ file:///usr/share/doc/sisu/html/sisu_pdf.7.html
.BR
- /usr/share/doc/sisu/v2/html/sisu_postgresql.7.html
+ file:///usr/share/doc/sisu/html/sisu_postgresql.7.html
.BR
- /usr/share/doc/sisu/v2/html/sisu_sqlite.7.html
+ file:///usr/share/doc/sisu/html/sisu_sqlite.7.html
.BR
- /usr/share/doc/sisu/v2/html/sisu_webrick.1.html
+ file:///usr/share/doc/sisu/html/sisu_webrick.1.html
.SH
34.3.2 WWW.JUS.UIO.NO/SISU
@@ -4694,7 +4737,9 @@ editors notes, numbered asterisk footnote/endnote series
editors notes, numbered asterisk footnote/endnote series
.TP
.BI 14.
-<http://www.jus.uio.no/sisu/>
+<http://www.sisudoc.org/>
+
+.BR
.TP
.BI 15.
<http://www.ruby-lang.org/en/>
@@ -4706,7 +4751,7 @@ Table from the Wealth of Networks by Yochai Benkler
.BI 17.
\.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
+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.
.TP
@@ -4739,10 +4784,14 @@ matches are found.
There is nothing to stop MySQL support being added in future.
.TP
.BI 25.
-<http://www.jus.uio.no/sisu/man/sisu.1>
+<http://www.jus.uio.no/sisu/man/sisu.1.html>
+
+.BR
.TP
.BI 26.
-<http://www.jus.uio.no/sisu/man/sisu.8>
+<http://www.jus.uio.no/sisu/man/sisu.8.html>
+
+.BR
.TP
.BI 27.
<http://www.jus.uio.no/sisu/man>
@@ -4761,28 +4810,26 @@ named index.html or more extensively through sisu_manifest.html
.SH SEE ALSO
\fIsisu\fR(1),
.br
-\fIsisu\-epub\fR(1),
+\fIsisu-epub\fR(1),
.br
-\fIsisu\-harvest\fR(1),
+\fIsisu-harvest\fR(1),
.br
-\fIsisu\-html\fR(1),
+\fIsisu-html\fR(1),
.br
-\fIsisu\-odf\fR(1),
+\fIsisu-odf\fR(1),
.br
-\fIsisu\-pdf\fR(1),
+\fIsisu-pdf\fR(1),
.br
-\fIsisu\-pg\fR(1),
+\fIsisu-pg\fR(1),
.br
-\fIsisu\-sqlite\fR(1),
+\fIsisu-sqlite\fR(1),
.br
-\fIsisu\-txt\fR(1).
+\fIsisu-txt\fR(1).
.br
\fIsisu_vim\fR(7)
-.br
-\fIsisu\fR(8)
.SH HOMEPAGE
-More information about \fBSiSU\fR can be found at <\fIhttp://www.jus.uio.no/sisu/\fR>.
+More information about \fBSiSU\fR can be found at <\fIhttp://www.sisudoc.org/\fR>.
.SH AUTHOR
\fBSiSU\fR was written by Ralph Amissah <\fIralph@amissah.com\fR>.
diff --git a/man/man7/sisu_vim.7 b/man/man7/sisu_vim.7
index 6b6ccd1..9ea9184 100644
--- a/man/man7/sisu_vim.7
+++ b/man/man7/sisu_vim.7
@@ -23,16 +23,10 @@ has syntax highlighting for a number of editors including vim which are
documented under:
.BR
- man sisu_syntax_highlighting
+ /usr/share/doc/sisu/markup-samples/sisu_manual/sisu_syntax_highlighting.sst
.BR
- /usr/share/doc/sisu/sisu_manual/sisu_syntax_highlighting/index.html
-
-.BR
- <http://sisudoc.org/sisu_manual/sisu_syntax_highlighting/index.html>
-
-.BR
- <http://www.jus.uio.no/sisu/sisu_manual/sisu_syntax_highlighting/index.html>
+ <http://www.sisudoc.org/sisu/sisu_manual/sisu_syntax_highlighting/index.html>
.BR
.B SiSU
@@ -69,126 +63,15 @@ sisu\-vim actions are activated on files with the suffix \.sst \.ssm \.ssi
FURTHER INFORMATION
.BR
-For more information on
+For more information
.B SiSU
see:
.BR
-<http://www.jus.uio.no/sisu>
-
-.BR
-or man sisu
-
-.SH
-DOCUMENT INFORMATION (METADATA)
-.BR
-
-.SH
-METADATA
-.BR
-
-.BR
-Document Manifest @
-<http://sisudoc.org/sisu_manual/sisu_vim/sisu_manifest.html>
-
-.BR
-.B Dublin Core
-(DC)
-
-.BR
-.I DC tags included with this document are provided here.
-
-.BR
-DC Title:
-.I SiSU \- Vim
-
-.BR
-DC Creator:
-.I Ralph Amissah
-
-.BR
-DC Rights:
-.I Copyright (C) Ralph Amissah 2008, part of SiSU documentation, License GPL
-3
-
-.BR
-DC Type:
-.I information
+<http://sisudoc.org/>
.BR
-DC Date created:
-.I 2002\-11\-12
-
-.BR
-DC Date issued:
-.I 2002\-11\-12
-
-.BR
-DC Date available:
-.I 2002\-11\-12
-
-.BR
-DC Date modified:
-.I 2008\-02\-12
-
-.BR
-DC Date:
-.I 2008\-02\-12
-
-.BR
-.B Version Information
-
-.BR
-Sourcefile:
-.I sisu_vim.sst
-
-.BR
-Filetype:
-.I SiSU text insert 0.58
-
-.BR
-Sourcefile Digest, MD5(sisu_vim.sst)=
-.I b5028f957b128162f7653bbd940042ca
-
-.BR
-Skin_Digest: MD5(skin_sisu_manual.rb)=
-.I 072b2584bedea82ea8a416587b9fa244
-
-.BR
-.B Generated
-
-.BR
-Document (metaverse) last generated:
-.I Thu Feb 14 02:44:14 +0000 2008
-
-.BR
-Generated by:
-.I SiSU
-.I 0.64.4
-of 2008w06/4 (2008\-02\-14)
+<http://www.jus.uio.no/sisu>
.BR
-Ruby version:
-.I ruby 1.8.6 (2007\-09\-24 patchlevel 111) \ [i486\-linux]
-
-
-.TP
-Other versions of this document:
-.TP
-manifest: <http://www.jus.uio.no/sisu/sisu_vim/sisu_manifest.html>
-.TP
-html: <http://www.jus.uio.no/sisu/sisu_vim/toc.html>
-.TP
-pdf: <http://www.jus.uio.no/sisu/sisu_vim/portrait.pdf>
-.TP
-pdf: <http://www.jus.uio.no/sisu/sisu_vim/landscape.pdf>
-.TP
-at: <http://www.jus.uio.no/sisu>
-.TP
-* Generated by: SiSU 0.64.4 of 2008w06/4 (2008-02-14)
-.TP
-* Ruby version: ruby 1.8.6 (2007-09-24 patchlevel 111) [i486-linux]
-.TP
-* Last Generated on: Thu Feb 14 02:44:14 +0000 2008
-.TP
-* SiSU http://www.jus.uio.no/sisu
+or man sisu