aboutsummaryrefslogtreecommitdiffhomepage
path: root/man/man8/sisu.8
blob: c55847d45ccf342903c29da721231c322510fb79 (plain)
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
274
275
276
.\"  Name: SiSU information Structuring Universe   
.\"  Author: Ralph Amissah
.\"  Description: sisu manpage
.\"  License: GPL 2 or later
.\"  Notes: Process this file with
.\"    groff -man -Tascii sisu.1
.\"    nroff -man sisu.1 | most 
.\" /[^\\][-'] 
.\" :%s/\([^\\]\)\([-']\)/\1\\\2/c
.TH sisu 8  "October 26, 2006" "version 0.48" "CONFIGURATION and SETUP"
.SH NAME
.B SiSU
\- Structured information, Serialized Units \- a document publishing system
.SH SYNOPSIS
.B sisu
.B [\-mhwpxXv...] [
.I filename/wildcard
.B ]
.\"%% Description
.SH DESCRIPTION
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 identification of documents using the Dublin Core;
document management; built to be associated with a revision control system;
text object numbering for the identification of a texts location in any of the
output formats, easy skinning on a site wide, or per document basis, ... for
more see 
.I man 1 sisu
or 
.I <http://www.jus.uio.no/sisu>
.PP
.B SiSU is an alternative way of publishing and managing documents.
.\"%% Installation
.SH INSTALLATION
.PP
Up to date information on SiSU downloads, and their installation should be
available from:
.I <http://www.jus.uio.no/sisu/SiSU/download.html>
or at:
.I <http://www.jus.uio.no/sisu/sisu_download/download.html>
.PP
There you should find links to the latest source tarball, and instructions on
how to install SiSU.
.PP
Sample marked up documents are are available at
.I /usr/share/doc/sisu/sisu_markup_samples/dfsg
or equivalent directory, or online at
.I <http://www.jus.uio.no/sisu/sample/markup.html>
or for viewing in html with syntax highlighting from
.I <http://www.jus.uio.no/sisu/sample/syntax>
.PP
A syntax table is provided at 
.I /usr/share/doc/sisu/on_markup.txt
or equivalent, and online at
.I <http://www.jus.uio.no/sisu/sample/on_markup.txt>
.PP
.I man 1 sisu
has a syntax table along with processing commands.
.PP
SiSU also provides some help via the command: 
.I sisu \-\-help
and selecting an appropriate subject, e.g.
.PP
.I sisu \-\-help commands
.PP
.I sisu \-\-help markup
.PP
.I sisu \-\-help headers
.PP
.I sisu \-\-help env
.PP
The rest of this note is on post installation setup
.\"%% Post Installation Setup
.SH Post Installation Setup \- Quick start
.PP
After installation of sisu-complete, move to the document samples directory
.PP
  cd /usr/share/doc/sisu/sisu_markup_samples/dfsg
.PP
and run
.PP
  sisu \-1 free_as_in_freedom.rms_and_free_software.sam_williams.sst
.PP
or the same:
.PP
  sisu  \-NhwpoabxXyv free_as_in_freedom.rms_and_free_software.sam_williams.sst
.PP
look at output results, see the "sisu_manifest" page created for the document
.PP
To generate an online document move to a writable directory, (create a work
directory and cd into it) as the file will be downloaded there and e.g.
.PP
.I sisu \-1 http://www.jus.uio.no/sisu/gpl2.fsf/gpl2.fsf.sst
.PP
.I sisu \-3 http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/free_culture.lawrence_lessig.sst
.PP
examine source document, vim has syntax highlighting support
.PP
gvim free_as_in_freedom.rms_and_free_software.sam_williams.sst
.PP
additional markup samples in
.I <http://www.jus.uio.no/sisu/SiSU/2.html>
.PP
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.
.PP
.I sisu \-3 http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/sisupod.zip
.PP
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:
.PP
.I sisu \-3 \-\-trust http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/sisupod.zip
.PP
For help
.I man sisu
.PP
.I sisu \-\-help
.PP
.I sisu \-\-help env
for the way sisu "sees/maps" your system
.PP
.I sisu \-\-help commands
for list of commands and so on
.PP
.\"%% B. Generate a (local) document from a markup/work directory.
.B Document markup directory
.PP
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 ~/sisu_test
.PP
.I cd ~/sisu_test
.PP
.I cp \-a /usr/share/doc/sisu/sisu_markup_samples/dfsg/* ~/sisu_test/.
.PP
.B \-\-\-\-\-\-\-\-\-\-
.PP
.B Tip: 
the markup syntax examples may be of interest 
.I <http://www.jus.uio.no/sisu/sample/>
.PP
.B Tip:
.I sisu \-U [sisu markup filename]
should printout the different possible outputs and where sisu would place them.
.PP
.B Tip: 
if you want to toggle ansi color add 
.I c
to your flags.
.PP
.B \-\-\-\-\-\-\-\-\-\-
.PP
.\"%% configuration files
.B SiSU configuration file search path is:
.PP
.I ./_sisu/sisurc.yaml
.PP
.I ~/.sisu/sisurc.yaml
.PP
.I /etc/sisu/sisurc.yaml
.PP
.\"%% Debian Installation Note
.SH Debian INSTALLATION Note
.PP
It is best you see
.I <http://www.jus.uio.no/sisu/SiSU/download.html#debian>
for up the most up to date information.
.PP
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):
.PP
Package: sisu
.PP
Depends: ruby (>= 1.8.4), libwebrick-ruby
.PP
Recommends: sisu-pdf, sisu-sqlite, sisu-postgresql, librmagick-ruby, trang,
  tidy, librexml-ruby, zip, unzip, openssl, rsync, openssh-client \| lsh-client,
  keychain, hyperestraier, kdissert
.PP
Suggests: libfcgi-ruby1.8, rcs \| cvs, lv, texinfo, pinfo, rename
.PP
Package: sisu-complete
.PP
Depends: ruby (>= 1.8.4), sisu, sisu-pdf, sisu-postgresql, sisu-sqlite
.PP
Recommends: hyperestraier
.PP
Package: sisu-pdf
.PP
Depends: sisu, tetex-bin \| texlive-base-bin, tetex-extra \| texlive-latex-extra,
  texlive-latex-extra, latex-ucs
.PP
Suggests: evince, xpdf
.PP
Package: sisu-postgresql
.PP
Depends: sisu, postgresql-8.1, libdbi-ruby, libdbm-ruby, libdbd-pg-ruby
.PP
Suggests: pgaccess, libdbd-pgsql, postgresql-contrib-8.1
.PP
Package: sisu-sqlite
.PP
Depends: sisu, sqlite, libdbi-ruby, libdbm-ruby, libdbd-sqlite-ruby
.PP
Suggests: libdbd-sqlite
.PP
Package: sisu-markup-samples
.PP
Depends: sisu
.PP
.fi
.\"%% Configuration Files
.SH DOCUMENT RESOURCE CONFIGURATION
.B sisu
resource configuration information is obtained from sources (where they exist):
.\" preformatted text follows
.nf
.I ~/.sisu/sisurc.yaml
.I /etc/sisu/[sisu version]/sisurc.yaml
.I sisu program defaults
.fi
.PP
.\"%% Skins
.B Skins
.PP
default document appearance may be modified using skins contained in
sub\-directories located at the following paths:
.\" preformatted text follows
.nf
.I ./_sisu/skin
.I ~/.sisu/skin
.I /etc/sisu/skin
.fi
.PP
more specifically, the following locations (or their /etc/sisu equivalent) should be used:
.PP
.I ~/.sisu/skin/doc
skins for individual documents;
.PP
.I ~/.sisu/skin/dir
skins for directories of matching names;
.PP
.I ~/.sisu/skin/site
site\-wide skin
modifying the site\-wide appearance of documents.
.PP
Usually all skin files are placed in the document skin directory:
.I ~/.sisu/skin/doc
with softlinks being made to the skins contained there from other skin directories as required.
.\"%% Further Information
.SH FURTHER INFORMATION
.PP
For more information on 
.I SiSU
see:
.I <http://www.jus.uio.no/sisu>
.PP
or
.I man sisu
.\"%% Author
.SH AUTHOR
Ralph Amissah
.I <ralph@amissah.com>
or
.I <ralph.amissah@gmail.com>
.SH SEE ALSO
.BR sisu(1),
.BR sisu_examples(1),
.BR sisu_webrick(1),
.BR sisu_pdf(1)
.BR sisu_sqlite(1)
.BR sisu_postgresql(1)
.BR sisu_termsheet(1),