aboutsummaryrefslogtreecommitdiffhomepage
path: root/man/man8/sisu_howto.8
diff options
context:
space:
mode:
authorRalph Amissah <ralph@amissah.com>2007-09-24 15:43:13 +0100
committerRalph Amissah <ralph@amissah.com>2007-09-24 15:43:46 +0100
commita6d72d829e5fda70528759c6de8dc3e141278fb4 (patch)
treeea12a53041d4cb69be0aad3dc0af7bf827efbcd6 /man/man8/sisu_howto.8
parentchangelog update (diff)
documentation regenerated, large diff
Diffstat (limited to 'man/man8/sisu_howto.8')
-rw-r--r--man/man8/sisu_howto.8100
1 files changed, 49 insertions, 51 deletions
diff --git a/man/man8/sisu_howto.8 b/man/man8/sisu_howto.8
index 42bd1caf..3aebd30b 100644
--- a/man/man8/sisu_howto.8
+++ b/man/man8/sisu_howto.8
@@ -1,7 +1,6 @@
-.TH "sisu_howto" "1" "2007-09-16" "0.58.3" "SiSU - SiSU information Structuring Universe / Structured information, Serialized Units"
+.TH "sisu_howto" "1" "2007-09-16" "0.59.0" "SiSU"
.SH
-SISU \- SISU INFORMATION STRUCTURING UNIVERSE / STRUCTURED INFORMATION,
-SERIALIZED UNITS \- TECHNICAL, HOWTO,
+SISU \- TECHNICAL, HOWTO,
RALPH AMISSAH
.BR
@@ -385,13 +384,13 @@ and on installation under:
The following paths are searched:
.BR
- ./_sisu/sisurc.yaml
+ \./_sisu/sisurc.yaml
.BR
~/.sisu/sisurc.yaml
.BR
- ./etc/sisu/sisurc.yaml
+ \./etc/sisu/sisurc.yaml
.SH
4. MARKUP
@@ -463,7 +462,7 @@ words to be made bold within the document
.BR
Defaults are set. You may change the face to: bold, italics, underscore,
-strikethrough, ...
+strikethrough, \...
.SH
4.2.1 BOLD
@@ -820,7 +819,7 @@ and on installation under:
The following paths are searched:
.BR
- ./_sisu/skin
+ \./_sisu/skin
.BR
~/.sisu/skin
@@ -945,9 +944,9 @@ remaining simple.
.B SiSU
implements across document formats a \"useful common feature set\" \ [coming
\ from \ a \ humanities, \ law, \ and \ possibly \ social \ sciences \
-perspective, \ rather \ than \ technical \ or \ scientific \ writing] ... focus
-is primarily on content and data integrity rather than appearance, (though
-outputs in the various formats are respectable).
+perspective, \ rather \ than \ technical \ or \ scientific \ writing] \...
+focus is primarily on content and data integrity rather than appearance,
+(though outputs in the various formats are respectable).
.BR
A vim syntax highlighting file and an ftplugin with folds for sisu markup is
@@ -1120,7 +1119,7 @@ They may be downloaded from:
<http://www.jus.uio.no/sisu/SiSU/download.html#rpm>
.SH
-6.2.3 SOURCE PACKAGE .TGZ
+6.2.3 SOURCE PACKAGE \.TGZ
.BR
Otherwise to install
@@ -1234,13 +1233,13 @@ in the root directory of the unpacked
as root type:
.BR
- ruby ./sisu\-install
+ ruby \./sisu\-install
.BR
or
.BR
- ruby ./sisu\-install base
+ ruby \./sisu\-install base
.BR
This makes use of Rant (by Stefan Lang) and the provided Rantfile. It has been
@@ -1261,10 +1260,10 @@ further information:
For a list of alternative actions you may type:
.BR
- ruby ./sisu\-install help
+ ruby \./sisu\-install help
.BR
- ruby ./sisu\-install \-T
+ ruby \./sisu\-install \-T
.SH
6.3 DEPENDENCIES
@@ -1275,7 +1274,7 @@ that sisu makes use of, and that you may need or wish to install. (this will
depend on such factors as whether you want to generate pdf, whether you will be
using
.B SiSU
-with or without a database, ...) \'man sisu_markup\-samples\' may also be of
+with or without a database, \...) \'man sisu_markup\-samples\' may also be of
interest if the sisu\-markup\-samples package has also been installed.
.BR
@@ -1342,7 +1341,7 @@ other things provides the dependencies of sisu within
Description: documents \- structuring, publishing in multiple formats and search
SiSU is a lightweight markup based, command line oriented, document
structuring, publishing and search framework for document collections.
- .
+ \.
With minimal preparation of a plain\-text, (UTF\-8) file, using its native
markup syntax in your text editor of choice, SiSU can generate various
document formats (most of which share a common object numbering system for
@@ -1355,24 +1354,24 @@ other things provides the dependencies of sisu within
works that are frequently changed or updated) for which it provides a fixed
means of reference of content. Document outputs also share semantic meta\-data
provided.
- .
+ \.
SiSU also provides concordance files, document content certificates and
manifests of generated output.
- .
+ \.
A vim syntax highlighting file and an ftplugin with folds for sisu markup is
provided, as are syntax highlighting files for kate, kwrite, gedit and
diakonos. Vim 7 includes syntax highlighting for SiSU.
- .
+ \.
man pages, and interactive help are provided.
- .
+ \.
Dependencies for various features are taken care of in sisu related packages.
The package sisu\-complete installs the whole of SiSU.
- .
+ \.
Additional document markup samples are provided in the package
sisu\-markup\-samples which is found in the non\-free archive the licenses for
the substantive content of the marked up documents provided is that provided
by the author or original publisher.
- .
+ \.
Homepage: <http://www.jus.uio.no/sisu>
.fi
@@ -1385,11 +1384,11 @@ other things provides the dependencies of sisu within
Description: installs all SiSU related packages
This package installs SiSU and related packages that enable sisu to produce
pdf and to populate postgresql and sqlite databases.
- .
+ \.
SiSU is a lightweight markup based document publishing framework.
- .
+ \.
See sisu for a description of the package.
- .
+ \.
Homepage: <http://www.jus.uio.no/sisu>
.fi
@@ -1401,9 +1400,9 @@ other things provides the dependencies of sisu within
#Suggests: evince, xpdf
Description: dependencies to convert SiSU LaTeX output to pdf
This package enables the conversion of SiSU LaTeX output to pdf.
- .
+ \.
SiSU is a lightweight markup based document publishing framework.
- .
+ \.
Homepage: <http://www.jus.uio.no/sisu>
.fi
@@ -1417,15 +1416,15 @@ other things provides the dependencies of sisu within
Description: SiSU dependencies for use with postgresql database
This package enables SiSU to populate a postgresql database. This is done at
an object/paragraph level, making granular searches of documents possible.
- .
+ \.
This relational database feature of SiSU is not required but provides
interesting possibilities, including that of granular searches of documents
for matching units of text, primarily paragraphs that can be displayed or
identified by object citation number, from which an index of documents
matched and each matched paragraph within them can be displayed.
- .
+ \.
SiSU is a lightweight markup based document publishing framework.
- .
+ \.
Homepage: <http://www.jus.uio.no/sisu>
.fi
@@ -1438,15 +1437,15 @@ other things provides the dependencies of sisu within
Description: SiSU dependencies for use with sqlite database
This package enables SiSU to populate an sqlite database. This is done at an
object/paragraph level, making granular searches of documents possible.
- .
+ \.
This relational database feature of SiSU is not required but provides
interesting possibilities, including that of granular searches of documents
for matching units of text, primarily paragraphs that can be displayed or
identified by object citation number, from which an index of documents
matched and each matched paragraph within them can be displayed.
- .
+ \.
SiSU is a lightweight markup based document publishing framework.
- .
+ \.
Homepage: <http://www.jus.uio.no/sisu>
.fi
@@ -1565,7 +1564,7 @@ documents within ~/.sisu/skin
.BR
* additional software \- eg. Tex and LaTeX (tetex, tetex\-base, tetex\-extra on
.B Debian
-), Postgresql, \ [sqlite], trang, tidy, makeinfo, ... none of which are
+), Postgresql, \ [sqlite], trang, tidy, makeinfo, \... none of which are
required for basic html or XML processing.
.BR
@@ -1591,7 +1590,7 @@ using the defaults).
Documents are marked up in
.B SiSU
syntax and kept in an ordinary text editable file, named with the suffix
-.sst, or .ssm
+\.sst, or \.ssm
.BR
Marked up
@@ -1684,7 +1683,7 @@ or
.BR
The defaults can be changed via
.B SiSU
-\'s configure file sisurc.yml which the program expects to find in ./_sisu
+\'s configure file sisurc.yml which the program expects to find in \./_sisu
~/.sisu or /etc/sisu (searched in that order, stopping on the first one found)
.SH
@@ -1718,7 +1717,7 @@ Sample marked up document are provided with the download tarball in the
directory:
.BR
- ./data/doc/sisu/sisu_markup_samples/dfsg
+ \./data/doc/sisu/sisu_markup_samples/dfsg
.BR
These are installed on the system usually at:
@@ -1746,7 +1745,7 @@ There is syntax support for some editors provided (together with a README file)
in
.BR
- ./data/sisu/conf/syntax
+ \./data/sisu/conf/syntax
.BR
usually installed to:
@@ -1761,7 +1760,7 @@ usually installed to:
License: GPL 3 or later see the copyright file in
.BR
- ./data/doc/sisu
+ \./data/doc/sisu
.BR
usually installed to:
@@ -1801,7 +1800,7 @@ object citation numbering and system
CHANGELOG
.BR
- ./CHANGELOG
+ \./CHANGELOG
.BR
and see
@@ -1976,7 +1975,7 @@ to your flags.
configuration file search path is:
.BR
- ./_sisu/sisurc.yaml
+ \./_sisu/sisurc.yaml
.BR
~/.sisu/sisurc.yaml
@@ -2090,7 +2089,7 @@ default document appearance may be modified using skins contained in
sub\-directories located at the following paths:
.BR
- ./_sisu/skin
+ \./_sisu/skin
.BR
~/.sisu/skin
@@ -2151,8 +2150,7 @@ Document Manifest @
.BR
DC Title:
-.I SiSU \- SiSU information Structuring Universe / Structured information,
-Serialized Units \- Technical, Howto
+.I SiSU \- Technical, Howto
.BR
DC Creator:
@@ -2200,7 +2198,7 @@ Filetype:
.BR
Sourcefile Digest, MD5(sisu_howto.sst)=
-.I 82c606e66689bcb5d190edf8fc7227a0
+.I bb17770a0fa5b4ef035ebf0bcfca3faa
.BR
Skin_Digest:
@@ -2212,13 +2210,13 @@ MD5(/home/ralph/grotto/theatre/dbld/sisu\-dev/sisu/data/doc/sisu/sisu_markup_sam
.BR
Document (metaverse) last generated:
-.I Sun Sep 23 01:14:01 +0100 2007
+.I Mon Sep 24 15:36:16 +0100 2007
.BR
Generated by:
.I SiSU
-.I 0.58.3
-of 2007w36/4 (2007\-09\-06)
+.I 0.59.0
+of 2007w38/0 (2007\-09\-23)
.BR
Ruby version:
@@ -2274,10 +2272,10 @@ pdf: <http://www.jus.uio.no/sisu/sisu_howto/landscape.pdf>
at: <http://www.jus.uio.no/sisu>
.TP
.TP
-* Generated by: SiSU 0.58.3 of 2007w36/4 (2007-09-06)
+* Generated by: SiSU 0.59.0 of 2007w38/0 (2007-09-23)
.TP
* Ruby version: ruby 1.8.6 (2007-06-07 patchlevel 36) [i486-linux]
.TP
-* Last Generated on: Sun Sep 23 01:14:06 +0100 2007
+* Last Generated on: Mon Sep 24 15:36:31 +0100 2007
.TP
* SiSU http://www.jus.uio.no/sisu