1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
|
<!-- manual page source format generated by PolyglotMan v3.2, -->
<!-- available at http://polyglotman.sourceforge.net/ -->
<html>
<head>
<title>sisu(8) manual page</title>
</head>
<body bgcolor='white'>
<a href='#toc'>Table of Contents</a><p>
<h2><a name='sect0' href='#toc0'>Name</a></h2>
<b>SiSU</b> - Structured information, Serialized Units - a document
publishing system
<h2><a name='sect1' href='#toc1'>Synopsis</a></h2>
<b>sisu</b> <b>[-mhwpxXv...] [</b> <i>filename/wildcard</i> <b>]</b>
<h2><a name='sect2' href='#toc2'>Description</a></h2>
A
document publishing system, that from a simple single marked-up document,
produces a multitude of output formats including: html, latex, pdf, info,
and sql output, which can be cross referenced as having the same document
structure and text object numbering, "object citation numbering". Features
include its’ simple syntax; the semantic tagging of documents; document
management; built to be associated with a revision control system; text
object numbering for the identification of a texts location in any of the
output formats, easy skinning on a site wide, or per document basis; granular
search; a degree of future proofing ... for more see <i>man</i> 1 sisu or <i><<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a>
></i>
<p>
<b>SiSU is a way of preparing, publishing, managing and searching documents.</b>
<h2><a name='sect3' href='#toc3'>Installation</a></h2>
<p>
Up to date information on SiSU downloads, and their installation
should be available from: <i><<a href='http://www.jus.uio.no/sisu/SiSU/download.html'>http://www.jus.uio.no/sisu/SiSU/download.html</a>
></i> or
at: <i><<a href='http://www.jus.uio.no/sisu/sisu_download/download.html'>http://www.jus.uio.no/sisu/sisu_download/download.html</a>
></i> <p>
There you should
find links to the latest source tarball, and instructions on how to install
SiSU. <p>
Sample marked up documents are are available at <i>/usr/share/doc/sisu/sisu_markup_samples/dfsg</i>
or equivalent directory, or online, see <i><<a href='http://www.jus.uio.no/sisu/SiSU/2.html'>http://www.jus.uio.no/sisu/SiSU/2.html</a>
></i>
<p>
<i>man</i> 1 sisu has a syntax table along with processing commands. <p>
SiSU also
provides some help via the command: <i>sisu</i> --help and selecting an appropriate
subject, e.g. <p>
<i>sisu</i> --help commands <p>
<i>sisu</i> --help markup <p>
<i>sisu</i> --help headers <p>
<i>sisu</i>
--help env <p>
The rest of this note is on post installation setup
<h2><a name='sect4' href='#toc4'>Post Installation
Setup - Quick start</a></h2>
<p>
<p> After installation of sisu-complete, move to the document
samples directory, <p>
cd /usr/share/doc/sisu/sisu_markup_samples/dfsg<br>
<p>
[this is not where you would normally work but provides sample documents
for testing, you may prefer instead to copy the contents of that directory
to a local directory before proceeding] <p>
and in that directory, initialise
the output directory with the command <p>
<i>sisu</i> -CC <p>
then run: <p>
<i>sisu</i> -1 free_as_in_freedom.rms_and_free_software.sam_williams.sst
<p>
or the same: <p>
<i>sisu</i> -NhwpoabxXyv free_as_in_freedom.rms_and_free_software.sam_williams.sst
<p>
look at output results, see the "sisu_manifest" page created for the document
<p>
for an overview of your current sisu setup, type: <p>
<i>sisu</i> --help env <p>
or <p>
<i>sisu</i>
-V <p>
To generate a document from a remote url accessible location move to
a writable directory, (create a work directory and cd into it) as the file
will be downloaded there and e.g. <p>
<i>sisu</i> -1 <a href='http://www.jus.uio.no/sisu/gpl3.fsf/gpl3.fsf.sst'>http://www.jus.uio.no/sisu/gpl3.fsf/gpl3.fsf.sst</a>
<p>
<i>sisu</i> -3 <a href='http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/free_culture.lawrence_lessig.sst'>http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/free_culture.lawrence_lessig.sst</a>
<p>
examine source document, vim has syntax highlighting support <p>
gvim free_as_in_freedom.rms_and_free_software.sam_williams.sst
<p>
additional markup samples in <i><<a href='http://www.jus.uio.no/sisu/SiSU/2.html'>http://www.jus.uio.no/sisu/SiSU/2.html</a>
></i> <p>
it should
also be possible to run sisu against sisupods (prepared zip files, created
by running the command sisu -S [filename]), whether stored locally or remotely.
<p>
<i>sisu</i> -3 <a href='http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/sisupod.zip'>http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/sisupod.zip</a>
<p>
there
is a security issue associated with the running of document skins that
are not your own, so these are turned of by default, and the use of the
following command, which switches on the associated skin is not recommended:
<p>
<i>sisu</i> -3 --trust <a href='http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/sisupod.zip'>http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/sisupod.zip</a>
<p>
For help <i>man</i> sisu <p>
<i>sisu</i> --help <p>
<i>sisu</i> --help env for the way sisu "sees/maps"
your system <p>
<i>sisu</i> --help commands for list of commands and so on <p>
<b>Document
markup directory</b> <p>
Perhaps the easiest way to begin is to create a directory
for sisu marked up documents within your home directory, and copy the file
structure (and document samples) provided in the document sample directory:
<i>mkdir</i> ~/sisu_test <p>
<i>cd</i> ~/sisu_test <p>
<i>cp</i> -a /usr/share/doc/sisu/sisu_markup_samples/dfsg/*
~/sisu_test/. <p>
<b>----------</b> <p>
<b>Tip:</b> the markup syntax examples may be of interest <i><<a href='http://www.jus.uio.no/sisu/sample/'>http://www.jus.uio.no/sisu/sample/</a>
></i>
<p>
<b>Tip:</b> <i>sisu</i> -U [sisu markup filename] should printout the different possible
outputs and where sisu would place them. <p>
<b>Tip:</b> if you want to toggle ansi
color add <i>c</i> to your flags. <p>
<b>----------</b> <p>
<b>SiSU configuration file search path is:</b> <p>
<i>./_sisu/sisurc.yaml</i>
<p>
<i>~/.sisu/sisurc.yaml</i> <p>
<i>/etc/sisu/sisurc.yaml</i> <p>
<h2><a name='sect5' href='#toc5'>Debian INSTALLATION Note</a></h2>
<p>
It is best
you see <i><<a href='http://www.jus.uio.no/sisu/SiSU/download.html#debian'>http://www.jus.uio.no/sisu/SiSU/download.html#debian</a>
></i> for up the most
up to date information. <p>
notes taken from the Debian control file (end edited),
gives an idea of additional packages that SiSU can make use of if available,
(the use/requirement of some of which are interdependent for specific actions
by SiSU): <p>
Package: sisu <p>
Depends: ruby (>= 1.8.2), libwebrick-ruby, unzip, zip
<p>
Conflicts: vim-sisu, sisu-vim, sisu-remote <p>
Replaces: vim-sisu, sisu-vim <p>
Recommends:
sisu-pdf, sisu-sqlite, sisu-postgresql, librmagick-ruby, trang, tidy, librexml-ruby,
openssl, rsync, openssh-client lsh-client, keychain, hyperestraier, kdissert
Suggests: rcs cvs, lv, texinfo, pinfo <p>
Package: sisu-complete <p>
Depends: ruby
(>= 1.8.2), sisu, sisu-pdf, sisu-postgresql, sisu-sqlite <p>
Recommends: hyperestraier
<p>
Package: sisu-pdf <p>
Depends: sisu, texlive-latex-base, texlive-fonts-recommended,
texlive-latex-recommended, texlive-latex-extra <p>
Suggests: evince, xpdf <p>
Package:
sisu-postgresql <p>
Depends: sisu, libdbd-pg-ruby, libdbi-ruby, libdbm-ruby, postgresql
<p>
Recommends: libfcgi-ruby <p>
Package: sisu-sqlite <p>
Depends: sisu, sqlite, libdbd-sqlite-ruby,
libdbi-ruby, libdbm-ruby <p>
Recommends: libfcgi-ruby <p>
Package: sisu-markup-samples
<p>
Depends: sisu <p>
<h2><a name='sect6' href='#toc6'>Package Description</a></h2>
<b>sisu</b> <p>
Description: documents - structuring,
publishing in multiple formats and search <p>
SiSU is a lightweight markup
based, command line oriented, document structuring, publishing and search
framework for document collections. <p>
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 locating content), including plain text, HTML,
XHTML, XML, OpenDocument text (ODF:ODT), LaTeX, PDF files, and populate
an SQL database with objects (roughly paragraph-sized chunks) so searches
may be performed and matches returned with that degree of granularity:
your search criteria is met by these documents and at these locations within
each document. Object numbering 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.
Document outputs also share semantic meta-data provided. <p>
SiSU also provides
concordance files, document content certificates and manifests of generated
output. <p>
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. <p>
man pages,
and interactive help are provided. <p>
Dependencies for various features are
taken care of in sisu related packages. The package sisu-complete installs
the whole of SiSU. <p>
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. <p>
Homepage: <<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a>
>
</pre>
<h2><a name='sect7' href='#toc7'>Document Resource Configuration</a></h2>
<b>sisu</b> resource configuration information
is obtained from sources (where they exist): <br>
<pre>~/.sisu/sisurc.yaml/etc/sisu/[sisu version]/sisurc.yamlsisu program defaults</pre><p>
<b>Skins</b> <p>
default document appearance may be modified using skins contained
in sub-directories located at the following paths: <br>
<pre>./_sisu/skin~/.sisu/skin/etc/sisu/skin</pre><p>
more specifically, the following locations
(or their /etc/sisu equivalent) should be used: <p>
<i>~/.sisu/skin/doc</i> skins for
individual documents; <p>
<i>~/.sisu/skin/dir</i> skins for directories of matching
names; <p>
<i>~/.sisu/skin/site</i> site-wide skin modifying the site-wide appearance
of documents. <p>
Usually all skin files are placed in the document skin directory:
<i>~/.sisu/skin/doc</i> with softlinks being made to the skins contained there
from other skin directories as required.
<h2><a name='sect8' href='#toc8'>Further Information</a></h2>
<p>
For more information
on <i>SiSU</i> see: <i><<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a>
></i> <p>
or <i>man</i> sisu
<h2><a name='sect9' href='#toc9'>Author</a></h2>
Ralph Amissah <i><ralph@amissah.com></i>
or <i><ralph.amissah@gmail.com></i>
<h2><a name='sect10' href='#toc10'>See Also</a></h2>
<a href='http:~/bin/man2html?sisu:1'><b>sisu(1)</a>
,</b> <a href='http:~/bin/man2html?sisu_examples:1'><b>sisu_examples(1)</a>
,</b> <a href='http:~/bin/man2html?sisu_webrick:1'><b>sisu_webrick(1)</a>
,</b>
<a href='http:~/bin/man2html?sisu_pdf:1'><b>sisu_pdf(1)</b></a>
<a href='http:~/bin/man2html?sisu_sqlite:1'><b>sisu_sqlite(1)</b></a>
<a href='http:~/bin/man2html?sisu_postgresql:1'><b>sisu_postgresql(1)</b></a>
<a href='http:~/bin/man2html?sisu_termsheet:1'><b>sisu_termsheet(1)</a>
,</b> <p>
<hr><p>
<a name='toc'><b>Table of Contents</b></a><p>
<ul>
<li><a name='toc0' href='#sect0'>Name</a></li>
<li><a name='toc1' href='#sect1'>Synopsis</a></li>
<li><a name='toc2' href='#sect2'>Description</a></li>
<li><a name='toc3' href='#sect3'>Installation</a></li>
<li><a name='toc4' href='#sect4'>Post Installation Setup - Quick start</a></li>
<li><a name='toc5' href='#sect5'>Debian INSTALLATION Note</a></li>
<li><a name='toc6' href='#sect6'>Package Description</a></li>
<li><a name='toc7' href='#sect7'>Document Resource Configuration</a></li>
<li><a name='toc8' href='#sect8'>Further Information</a></li>
<li><a name='toc9' href='#sect9'>Author</a></li>
<li><a name='toc10' href='#sect10'>See Also</a></li>
</ul>
</body>
</html>
|
