Difference: TWikiSkins (8 vs. 9)

Revision 92003-01-04 - PeterThoeny

Line: 1 to 1
 

TWiki Skins

Line: 13 to 13
  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.
Added:
>
>
Use the existing TWikiTemplates (like view.tmpl) or skin files as a base for your own skin, name it for example view.myskin.tmpl.

Variables in Skins

You can use template variables, TWikiVariables, and other predefined variables to compose your skins. Some commonly used variables in skins:

Variable:
<-- -->
Sorted ascending
Expanded to:
%EDITTOPIC% Edit link
%META{"attachments"}% FileAttachment table
%META{"form"}% TWikiForm, if any
%META{"parent"}% The topic parent
%REVINFO% Revision info, ex: r1.6 - 24 Dec 2002 - 08:12 GMT - TWikiGuest
%REVTITLE% The revision title, if any, ex: (r1.6)
%SCRIPTSUFFIX% The script suffix, ex: .pl, .cgi
%SCRIPTURL% The script URL of TWiki
%TEXT% The topic text, e.g. the content that can be edited
%TOPIC% The name of the current topic
%TOPICURLENCODED% The name of the current topic, URL encoded (for form action)
%WEB% The name of the current web
%WEBBGCOLOR% Web specific background color, defined in the WebPreferences
%WEBCOPYRIGHT% Copyright notice, defined in the WebPreferences
%WEBTOPICLIST% Common links of current web, defined in the WebPreferences. It includes a #GoBox
%WEBURLENCODED% The name of the current web, URL encoded (for form action)
%WIKILOGOALT% Alt text of page logo
%WIKILOGOIMG% Image URL of page logo
%WIKILOGOURL% Link of page logo
%WIKITOOLNAME% The name of your TWiki site

The "Go" Box and Navigation Box

The %WEBTOPICLIST% includes a "Go" box to jump to a topic. The box also understand URLs, e.g. you can type http://www.google.com/ to jump to an external web site. The feature is handy if you build a skin that has a select box of frequently used links, like Intranet home, employee database, sales database and such. A little JavaScript gets into action on the onSelect method of the select tag to fill the selected URL into the "Go" box field, then submits the form.

Here is an example form that has a select box and the "Go" box for illustration purposes. You need to have JavaScript enabled for this to work:

Bare bones header for demo only
Welcome  |  Register  |  Changes  |  Topics  |  Index  |  Search  |  Go

Packaging and Publishing Skins

See TWiki:Plugins/SkinPackagingHowTo

 

Activating Skins

A skin can be activated in two ways:

Line: 26 to 82
  The ?skin=name URL parameter overrides the SKIN Preference value.
Changed:
<
<
-- PeterThoeny - 14 Jul 2001
>
>
-- PeterThoeny - 03 Jan 2003
 
This site is powered by the TWiki collaboration platform Powered by PerlCopyright © 1999-2024 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.TWikiSkins.