Fossil SCM

fossil-scm / skins / README.md
1
Built-in Skins
2
==============
3
4
Each subdirectory under this folder describes a built-in "skin".
5
There are five key files in each subdirectory:
6
7
* `css.txt` → The CSS for the skin
8
* `details.txt` → Skin-specific settings
9
* `footer.txt` → Text of the Content Footer for each page
10
* `header.txt` → Text of the Content Header for each page
11
* `js.txt` → Javascript included in the Content Footer
12
13
To improve an existing built-in skin, simply edit the appropriate
14
files and recompile.
15
16
To add a new skin:
17
18
1. Create a new subdirectory under skins/. (The new directory is
19
called "skins/newskin" below but you should use a new original
20
name, of course.)
21
22
2. Add files skins/newskin/css.txt, skins/newskin/details.txt,
23
skins/newskin/footer.txt, skins/newskin/header.txt, and
24
skins/newskin/js.txt. Be sure to "fossil add" these files.
25
26
3. Go to the tools/ directory and rerun "tclsh makemake.tcl". This
27
step rebuilds the various makefiles so that they have dependencies
28
on the skin files you just installed.
29
30
4. Edit the BuiltinSkin[] array near the top of the src/skins.c source
31
file so that it describes and references the "newskin" skin.
32
33
5. Type "make" to rebuild.
34
35
See the [custom skin documentation](/doc/$CURRENT/www/customskin.md) for
36
more information.
37
38
Development Hints
39
-----------------
40
41
One way to develop a new skin is to copy the baseline files (css.txt,
42
details.txt, footer.txt, header.txt, and js.txt) into a working
43
directory $WORKDIR then launch Fossil with a command-line option
44
"--skin $WORKDIR". Example:
45
46
cp -r skins/default newskin
47
fossil ui --skin ./newskin
48
49
When the argument to --skin contains one or more '/' characters, the
50
appropriate skin files are read from disk from the directory specified.
51
So after launching fossil as shown above, you can edit the newskin/*.txt
52
files using your favorite text editor, then press Reload on your browser
53
to see immediate results.
54

Keyboard Shortcuts

Open search /
Next entry (timeline) j
Previous entry (timeline) k
Open focused entry Enter
Show this help ?
Toggle theme Top nav button