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
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
|
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<?xml-stylesheet type="text/css" href="../_sisu/css/sax.css"?>
<!-- Document processing information:
* Generated by: SiSU 0.59.0 of 2007w38/0 (2007-09-23)
* Ruby version: ruby 1.8.6 (2007-06-07 patchlevel 36) [i486-linux]
*
* Last Generated on: Mon Sep 24 15:34:25 +0100 2007
* SiSU http://www.jus.uio.no/sisu
-->
<document>
<head>
<meta>Title:</meta>
<title class="dc">
SiSU - Configuration
</title>
<br />
<meta>Creator:</meta>
<creator class="dc">
Ralph Amissah
</creator>
<br />
<meta>Rights:</meta>
<rights class="dc">
Ralph Amissah
</rights>
<br />
<meta>Type:</meta>
<type class="dc">
information
</type>
<br />
<meta>Subject:</meta>
<subject class="dc">
ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search
</subject>
<br />
<meta>Date created:</meta>
<date_created class="extra">
2002-08-28
</date_created>
<br />
<meta>Date issued:</meta>
<date_issued class="extra">
2002-08-28
</date_issued>
<br />
<meta>Date available:</meta>
<date_available class="extra">
2007-08-28
</date_available>
<br />
<meta>Date modified:</meta>
<date_modified class="extra">
2007-08-30
</date_modified>
<br />
<meta>Date:</meta>
<date class="dc">
2007-08-30
</date>
<br />
</head>
<body>
<object id="1">
<ocn>1</ocn>
<text class="h1">
SiSU - Configuration,<br /> Ralph Amissah
</text>
</object>
<object id="2">
<ocn>2</ocn>
<text class="h2">
Configuration of Environment
</text>
</object>
<object id="3">
<ocn>3</ocn>
<text class="h4">
1. Configuration
</text>
</object>
<object id="4">
<ocn>4</ocn>
<text class="h5">
1.1 Determining the Current Configuration
</text>
</object>
<object id="5">
<ocn>5</ocn>
<text class="norm">
Information on the current configuration of <b>SiSU</b> should be
available with the help command:
</text>
</object>
<object id="6">
<ocn>6</ocn>
<text class="indent1">
sisu -v
</text>
</object>
<object id="7">
<ocn>7</ocn>
<text class="norm">
which is an alias for:
</text>
</object>
<object id="8">
<ocn>8</ocn>
<text class="indent1">
sisu --help env
</text>
</object>
<object id="9">
<ocn>9</ocn>
<text class="norm">
Either of these should be executed from within a directory that
contains sisu markup source documents.
</text>
</object>
<object id="10">
<ocn>10</ocn>
<text class="h5">
1.2 Configuration files (config.yml)
</text>
</object>
<object id="11">
<ocn>11</ocn>
<text class="norm">
<b>SiSU</b> configration parameters are adjusted in the configuration
file, which can be used to override the defaults set. This includes
such things as which directory interim processing should be done in and
where the generated output should be placed.
</text>
</object>
<object id="12">
<ocn>12</ocn>
<text class="norm">
The <b>SiSU</b> configuration file is a yaml file, which means
indentation is significant.
</text>
</object>
<object id="13">
<ocn>13</ocn>
<text class="norm">
<b>SiSU</b> resource configuration is determined by looking at the
following files if they exist:
</text>
</object>
<object id="14">
<ocn>14</ocn>
<text class="indent1">
./_sisu/sisurc.yml
</text>
</object>
<object id="15">
<ocn>15</ocn>
<text class="indent1">
~/.sisu/sisurc.yml
</text>
</object>
<object id="16">
<ocn>16</ocn>
<text class="indent1">
/etc/sisu/sisurc.yml
</text>
</object>
<object id="17">
<ocn>17</ocn>
<text class="norm">
The search is in the order listed, and the first one found is used.
</text>
</object>
<object id="18">
<ocn>18</ocn>
<text class="norm">
In the absence of instructions in any of these it falls back to the
internal program defaults.
</text>
</object>
<object id="19">
<ocn>19</ocn>
<text class="norm">
Configuration determines the output and processing directories and the
database access details.
</text>
</object>
<object id="20">
<ocn>20</ocn>
<text class="norm">
If <b>SiSU</b> is installed a sample sisurc.yml may be found in
/etc/sisu/sisurc.yml
</text>
</object>
<object id="21">
<ocn>21</ocn>
<text class="h2">
Configuration of Documents
</text>
</object>
<object id="22">
<ocn>22</ocn>
<text class="h4">
2. Skins
</text>
</object>
<object id="23">
<ocn>23</ocn>
<text class="norm">
Skins modify the default appearance of document output on a document,
directory, or site wide basis. Skins are looked for in the following
locations:
</text>
</object>
<object id="24">
<ocn>24</ocn>
<text class="indent1">
./_sisu/skin
</text>
</object>
<object id="25">
<ocn>25</ocn>
<text class="indent1">
~/.sisu/skin
</text>
</object>
<object id="26">
<ocn>26</ocn>
<text class="indent1">
/etc/sisu/skin
</text>
</object>
<object id="27">
<ocn>27</ocn>
<text class="norm">
<b>Within the skin directory</b> are the following the default
sub-directories for document skins:
</text>
</object>
<object id="28">
<ocn>28</ocn>
<text class="indent1">
./skin/doc
</text>
</object>
<object id="29">
<ocn>29</ocn>
<text class="indent1">
./skin/dir
</text>
</object>
<object id="30">
<ocn>30</ocn>
<text class="indent1">
./skin/site
</text>
</object>
<object id="31">
<ocn>31</ocn>
<text class="norm">
A skin is placed in the appropriate directory and the file named
skin_[name].rb
</text>
</object>
<object id="32">
<ocn>32</ocn>
<text class="norm">
The skin itself is a ruby file which modifies the default appearances
set in the program.
</text>
</object>
<object id="33">
<ocn>33</ocn>
<text class="h5">
2.1 Document Skin
</text>
</object>
<object id="34">
<ocn>34</ocn>
<text class="norm">
Documents take on a document skin, if the header of the document
specifies a skin to be used.
</text>
</object>
<object id="35">
<ocn>35</ocn>
<text class="code">
   @skin: skin_united_nations    
</text>
</object>
<object id="36">
<ocn>36</ocn>
<text class="h5">
2.2 Directory Skin
</text>
</object>
<object id="37">
<ocn>37</ocn>
<text class="norm">
A directory may be mapped on to a particular skin, so all documents
within that directory take on a particular appearance. If a skin exists
in the skin/dir with the same name as the document directory, it will
automatically be used for each of the documents in that directory,
(except where a document specifies the use of another skin, in the
skin/doc directory).
</text>
</object>
<object id="38">
<ocn>38</ocn>
<text class="norm">
A personal habit is to place all skins within the doc directory, and
symbolic links as needed from the site, or dir directories as required.
</text>
</object>
<object id="39">
<ocn>39</ocn>
<text class="h5">
2.3 Site Skin
</text>
</object>
<object id="40">
<ocn>40</ocn>
<text class="norm">
A site skin, modifies the program default skin.
</text>
</object>
<object id="41">
<ocn>41</ocn>
<text class="h5">
2.4 Sample Skins
</text>
</object>
<object id="42">
<ocn>42</ocn>
<text class="norm">
With <b>SiSU</b> installed sample skins may be found in:
</text>
</object>
<object id="43">
<ocn>43</ocn>
<text class="indent1">
/etc/sisu/skin/doc and
/usr/share/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/doc
</text>
</object>
<object id="44">
<ocn>44</ocn>
<text class="norm">
(or equivalent directory) and if sisu-markup-samples is installed also
under:
</text>
</object>
<object id="45">
<ocn>45</ocn>
<text class="indent1">
/usr/share/doc/sisu/sisu_markup_samples/non-free/_sisu/skin/doc
</text>
</object>
<object id="46">
<ocn>46</ocn>
<text class="norm">
Samples of list.yml and promo.yml (which are used to create the right
column list) may be found in:
</text>
</object>
<object id="47">
<ocn>47</ocn>
<text class="indent1">
/usr/share/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/yml (or
equivalent directory)
</text>
</object>
<object id="48">
<ocn>48</ocn>
<text class="h4">
3. Homepages
</text>
</object>
<object id="49">
<ocn>49</ocn>
<text class="norm">
<b>SiSU</b> is about the ability to auto-generate documents. Home pages
are regarded as custom built items, and are not created by <b>SiSU</b>.
More accurately, <b>SiSU</b> 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:
</text>
</object>
<object id="50">
<ocn>50</ocn>
<text class="norm">
1. through placing your home page and other custom built documents in
the subdirectory _sisu/home/ (this probably being the easier and more
convenient option)
</text>
</object>
<object id="51">
<ocn>51</ocn>
<text class="norm">
2. through providing what you want as the home page in a skin,
</text>
</object>
<object id="52">
<ocn>52</ocn>
<text class="norm">
Document sets are contained in directories, usually organised by site
or subject. Each directory can/should have its own homepage. See the
section on directory structure and organisation of content.
</text>
</object>
<object id="53">
<ocn>53</ocn>
<text class="h5">
3.1 Home page and other custom built pages in a sub-directory
</text>
</object>
<object id="54">
<ocn>54</ocn>
<text class="norm">
Custom built pages, including the home page index.html may be placed
within the configuration directory _sisu/home/ in any of the locations
that is searched for the configuration directory, namely ./_sisu;
~/_sisu; /etc/sisu From there they are copied to the root of the
output directory with the command:
</text>
</object>
<object id="55">
<ocn>55</ocn>
<text class="indent1">
sisu -CC
</text>
</object>
<object id="56">
<ocn>56</ocn>
<text class="h5">
3.2 Home page within a skin
</text>
</object>
<object id="57">
<ocn>57</ocn>
<text class="norm">
Skins are described in a separate section, but basically are a file
written in the programming language <b>Ruby</b> that may be provided to
change the defaults that are provided with sisu with respect to
individual documents, a directories contents or for a site.
</text>
</object>
<object id="58">
<ocn>58</ocn>
<text class="norm">
If you wish to provide a homepage within a skin the skin should be in
the directory _sisu/skin/dir and have the name of the directory for
which it is to become the home page. Documents in the directory
commercial_law would have the homepage modified in skin_commercial
law.rb; or the directory poems in skin_poems.rb
</text>
</object>
<object id="59">
<ocn>59</ocn>
<text class="code">
   class Home<br />   def homepage<br />   # place the html content of your homepage here, this will become index.html<br />   <<HOME <html><br />   <head></head><br />   <doc><br />   <p>this is my new homepage.</p><br />   </doc><br />   </html><br />   HOME<br />   end<br />   end    
</text>
</object>
</body>
</document>
|
