TWiki/TWikiSkins.mdwn


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

%TOC% %STARTINCLUDE%

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

_Overlay regular templates with alternate header/footer layouts_

## <a name="Overview"> Overview </a>

Skins are customized [[TWikiDocumentation]] files. You can use skins to change the look of a %WIKITOOLNAME% topic, for example, the layout of the header and footer. Rendered text between header and footer does **_not_** change. You can also use skins to define an alternate view, like a view optimized for printing.

--++ Defining Skins

Skin files are located in the `twiki/templates` directory and are named with the syntax: <code>**&lt;scriptname&gt;.&lt;skin&gt;.tmpl**</code>. For example, the **Printable** skin for the `view` template is `view.print.tmpl`.

## <a name="Activating_Skins"> Activating Skins </a>

A skin can be activated in two ways:

* Define the `SKIN` Preference variable in [[TWiki/TWikiPreferences]], one of the [[WebPreferences]], or in a user - %WIKIUSERNAME% - topic.
  * `Set SKIN = print`

* Add `?skin=name` to the URL, for this example:
  * %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]] - 14 Jul 2001 <br />