aboutsummaryrefslogtreecommitdiffhomepage
path: root/data/doc/manuals_generated/sisu_manual/sisu_skin/sisu_skin.sst
blob: 587400fb137b4fe20e02cd1306be56ca2f0440fb (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
% SiSU insert 0.58

@title: SiSU

@subtitle: Skins

@creator: Ralph Amissah

@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3

@type: information

@subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search

@date.created: 2002-11-12

@date.issued: 2002-11-12

@date.available: 2002-11-12

@date.modified: 2007-09-16

@date: 2007-09-16

@level: new=C; break=1; num_top=1

@skin: skin_sisu_manual

@bold: /Gnu|Debian|Ruby|SiSU/

@links: { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/
{ Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/2.html
{ SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU
{ SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/
{ SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/
{ SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html
{ SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html
{ SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html
{ SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/
{ SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/

% @rcs$

:A~? @title @creator

:B~? Document Skins - configuration

1~skins Skins

% .SH "SKINS \- document, directory and site skins"

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

_1 ./_sisu/skin

_1 ~/.sisu/skin

_1 /etc/sisu/skin

!_ Within the skin directory
are the following the default sub-directories for document skins:

_1 ./skin/doc

_1 ./skin/dir

_1 ./skin/site

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

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

2~ Document Skin

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

code{

@skin: skin_united_nations

}code

2~ Directory Skin

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

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.

2~ Site Skin

A site skin, modifies the program default skin.

2~ Sample Skins

With SiSU installed sample skins may be found in:

_1 /etc/sisu/skin/doc and /usr/share/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/doc

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

_1 /usr/share/doc/sisu/sisu_markup_samples/non-free/_sisu/skin/doc

Samples of list.yml and promo.yml (which are used to create the right column list) may be found in:

_1 /usr/share/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/yml (or equivalent directory)