Title:
SiSU - 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:
Date issued:
Date available:
Date modified:
Date:
2007-09-16
1
SiSU - Skins, Ralph Amissah
2
Document Skins - configuration
3
1. Skins
4
Skins modify the default appearance of document output on a document,
directory, or site wide basis. Skins are looked for in the following
locations:
5
./_sisu/skin
6
~/.sisu/skin
7
/etc/sisu/skin
8
Within the skin directory are the following the default
sub-directories for document skins:
9
./skin/doc
10
./skin/dir
11
./skin/site
12
A skin is placed in the appropriate directory and the file named
skin_[name].rb
13
The skin itself is a ruby file which modifies the default appearances
set in the program.
14
1.1 Document Skin
15
Documents take on a document skin, if the header of the document
specifies a skin to be used.
16
@skin: skin_united_nations
17
1.2 Directory Skin
18
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).
19
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.
20
1.3 Site Skin
21
A site skin, modifies the program default skin.
22
1.4 Sample Skins
23
With SiSU installed sample skins may be found in:
24
/etc/sisu/skin/doc and
/usr/share/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/doc
25
(or equivalent directory) and if sisu-markup-samples is installed also
under:
26
/usr/share/doc/sisu/sisu_markup_samples/non-free/_sisu/skin/doc
27
Samples of list.yml and promo.yml (which are used to create the right
column list) may be found in:
28
/usr/share/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/yml (or
equivalent directory)