From 3fb1eaf0382ddd3a0a97c5e54996609bc555b321 Mon Sep 17 00:00:00 2001 From: MikeMannix Date: Mon, 10 Sep 2001 00:07:45 +0000 Subject: none --- TWiki/TWikiSkins.mdwn | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) (limited to 'TWiki') diff --git a/TWiki/TWikiSkins.mdwn b/TWiki/TWikiSkins.mdwn index bcbae5ca..6e6dc667 100644 --- a/TWiki/TWikiSkins.mdwn +++ b/TWiki/TWikiSkins.mdwn @@ -1,17 +1,28 @@ +%TOC% %STARTINCLUDE% + # TWiki Skins -Skins are customized [[TWikiTemplates]] 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 also use skins to define an alternate view, ex: a view optimized for printing. +_Overlay regular templates with alternate header/footer layouts_ + +## Overview + +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. -Skin files are located in the **twiki/template** directory and are name with this syntax: **<scriptname>.<skin>.tmpl**. For example, the **print** skin for the **view** template is **view.print.tmpl** (red color added for clarification). +--++ Defining Skins + +Skin files are located in the `twiki/templates` directory and are named with the syntax: **<scriptname>.<skin>.tmpl**. For example, the **Printable** skin for the `view` template is `view.print.tmpl`. + +## Activating Skins A skin can be activated in two ways: -* Define the SKIN preference variable in [[TWiki/TWikiPreferences]], one of the [[WebPreferences]], or a user preference. Ex: +* 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 **?skin=name** URL parameter overrides the SKIN preference value. +The **?skin=name** URL parameter overrides the SKIN Preference value. -- [[PeterThoeny]] - 14 Jul 2001
-- cgit v1.2.3