summaryrefslogtreecommitdiff
path: root/doc/themes.rst
blob: 895f1a07bf51b8c053af1223c89b26d2867784f9 (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
======================
SemanticScuttle Themes
======================
SemanticScuttle may be changed visually by supplying custom "themes" (skins)
that modify the visual appearance.


Changing the current theme
==========================
In ``data/config.php``, set your theme like this: ::

    $theme = 'darkmood';

The available themes are the folders in ``www/themes/``.
By default, SemanticScuttle ships only one usable theme ("default") and one
to demonstrate how to create your own theme ("testdummy").


Creating your own theme
=======================
Have a look at the "testdummy" theme in ``www/themes/testdummy/``.

CSS and image files
-------------------
Since both file types need to be accessible via the web server directly,
they are located in the ``www/`` folder: ::

    www/themes/$themename/

The main CSS file that automatically gets included is ::

    www/themes/$themename/scuttle.css

Several template files in SemanticScuttle include image files. If they do not
exist in your theme, the default ones are used automatically.
Note that this is not true for images that are specified in the CSS files.


Template files
--------------
The templates of the default file are located in ::

    data/templates/default/

You may put your theme template files into ::

    data/templates/$themename/


Existing themes
===============

* `Flat`__ by Roman Lehnhof. See the `introduction blog post`__
* `sscuttlizr`__

__ https://github.com/rlehnhof/flat
__ http://lehnhof.net/2013/08/semantic-scuttle-new-flat-interface-theme-template/
__ https://github.com/jonrandoem/sscuttlizr