aboutsummaryrefslogtreecommitdiffhomepage
path: root/man/man1/sisu_skin.1
blob: ce5537a9fbbd1b7cf575fec246b8d8e4db078f7d (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
.TH "sisu_skin" "1" "2007-09-16" "0.59.0" "SiSU"
.SH
SISU \- SKINS,
RALPH AMISSAH
.BR

.SH
DOCUMENT SKINS \- CONFIGURATION
.BR

.SH
1. SKINS
.BR

.BR
Skins modify the default appearance of document output on a document,
directory, or site wide basis. Skins are looked for in the following locations:

.BR
  \./_sisu/skin

.BR
  ~/.sisu/skin

.BR
  /etc/sisu/skin

.BR
.B Within the skin directory
are the following the default sub\-directories for document skins:

.BR
  \./skin/doc

.BR
  \./skin/dir

.BR
  \./skin/site

.BR
A skin is placed in the appropriate directory and the file named skin_[name].rb

.BR
The skin itself is a ruby file which modifies the default appearances set in
the program.

.SH
1.1 DOCUMENT SKIN

.BR
Documents take on a document skin, if the header of the document specifies a
skin to be used.


.nf
  @skin: skin_united_nations
.fi

.SH
1.2 DIRECTORY SKIN

.BR
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).

.BR
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.

.SH
1.3 SITE SKIN

.BR
A site skin, modifies the program default skin.

.SH
1.4 SAMPLE SKINS

.BR
With
.B SiSU
installed sample skins may be found in:

.BR
  /etc/sisu/skin/doc and
  /usr/share/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/doc

.BR
(or equivalent directory) and if sisu\-markup\-samples is installed also under:

.BR
  /usr/share/doc/sisu/sisu_markup_samples/non\-free/_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)

.SH
DOCUMENT INFORMATION (METADATA)
.BR

.SH
METADATA
.BR

.BR
Document Manifest @
<http://www.jus.uio.no/sisu/sisu_manual/sisu_skin/sisu_manifest.html>

.BR
.B Dublin Core
(DC)

.BR
.I DC tags included with this document are provided here.

.BR
DC Title:
.I SiSU \- Skins

.BR
DC Creator:
.I Ralph Amissah

.BR
DC Rights:
.I Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL
3

.BR
DC Type:
.I information

.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 2007\-09\-16

.BR
DC Date:
.I 2007\-09\-16

.BR
.B Version Information

.BR
Sourcefile:
.I sisu_skin.sst

.BR
Filetype:
.I SiSU text insert 0.58

.BR
Sourcefile Digest, MD5(sisu_skin.sst)=
.I 8aebfb5312045c3a705ad6c314246f67

.BR
Skin_Digest:
MD5(/home/ralph/grotto/theatre/dbld/sisu\-dev/sisu/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/skin/doc/skin_sisu_manual.rb)=
.I 20fc43cf3eb6590bc3399a1aef65c5a9

.BR
.B Generated

.BR
Document (metaverse) last generated:
.I Mon Sep 24 15:36:15 +0100 2007

.BR
Generated by:
.I SiSU
.I 0.59.0
of 2007w38/0 (2007\-09\-23)

.BR
Ruby version:
.I ruby 1.8.6 (2007\-06\-07 patchlevel 36) \ [i486\-linux]


.TP
Other versions of this document:
.TP
manifest: <http://www.jus.uio.no/sisu/sisu_skin/sisu_manifest.html>
.TP
html: <http://www.jus.uio.no/sisu/sisu_skin/toc.html>
.TP
pdf: <http://www.jus.uio.no/sisu/sisu_skin/portrait.pdf>
.TP
pdf: <http://www.jus.uio.no/sisu/sisu_skin/landscape.pdf>
." .TP
." manpage: http://www.jus.uio.no/sisu/sisu_skin/sisu_skin.1
.TP
at: <http://www.jus.uio.no/sisu>
.TP
.TP
* 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: Mon Sep 24 15:36:31 +0100 2007
.TP
* SiSU http://www.jus.uio.no/sisu