TWiki/TWikiSkins.mdwn


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

## <a name="TWiki_Skins"> TWiki Skins </a>

Skins are customized template files. You can use skins to change the look of a %WIKITOOLNAME% topic, for example the layout of the header and footer. Note that the renderd text between header and footer does **_not_** change. You can use skins also to define an alternate view, i.e. a view optimized for printing.

A skin file is located in the <code>**twiki/template**</code> directory and has a name like <code>**&lt;scriptname&gt;.&lt;skin&gt;.tmpl**</code> or <code>**&lt;scriptname&gt;.&lt;topicname&gt;.&lt;skin&gt;.tmpl**</code>. For example, the <code>**print**</code> skin for the <code>**view**</code> template is <code>**view<font>.print</font>.tmpl**</code> (red color added for clarification).

A skin can be activated in two ways:

* Define the SKIN preference variable in [[TWiki/TWikiPreferences]], one of the [[WebPreferences]], or a user preference. I.e.
  * Set SKIN = wikiwiki <br />**Note:** Who has time to create the classic `wikiwiki` skin?
* Add `?skin=name` to the URL, i.e. for this topic:
  * %SCRIPTURL%/view%SCRIPTSUFFIX%/%WEB%/%TOPIC%?skin=print (for the print view skin)
  * %SCRIPTURL%/view%SCRIPTSUFFIX%/%WEB%/%TOPIC%?skin=plain (for the plain view skin that has no header and footer)

The <code>**?skin=name**</code> URL parameter overrides the SKIN preference value.

-- [[PeterThoeny]] - 16 Mar 2001 <br />