Attachment Tables

The format of standard attachment tables is defined through the use of special TWiki template macros which by default are defined in the templates/twiki.tmpl template using the %TMPL:DEF macro syntax described in TWikiTemplates. These macros are:

The ATTACH:row macros are expanded for each file in the attachment table, using the following special tags:

Note: it is easy to change the look and feel for an entire site by editing the twiki.tmpl template file. However, to simplify upgrading, you should avoid doing this. Instead, write a skin-specific template file e.g. attach.myskin.tmpl and use %TMPL:INCLUDE{attach.myskin.tmpl}% to include it in each of your skin files. As long as it it included after twiki.tmpl, your macro definitions will override the defaults defined there.

Browsing Installed Skins

You can try all installed skins in TWikiSkinBrowser.

Using Cascading Style Sheets

The regular templates files currently do not use style sheets. Many skin developers choose to use them, it helps in separating style from content.

Example: To use a style sheet for the broadcast message, add this to view.myskin.tmpl:

<style type="text/css">
.broadcastmessage {
    background: yellow; display:block;
    border-style:solid;border-width: 2px;border-color:red;
}
.broadcastmessage strong {color: red}
</style>

Then add a div tag to the %BROADCASTMESSAGE% variable located after the #PageTop anchor or after the opening form tag:

<div class="broadcastmessage"> %BROADCASTMESSAGE% </div>

Variables in Skins

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

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:

Packaging and Publishing Skins

See TWiki:Plugins/SkinPackagingHowTo

Defining Skins

Overview

Skins are customized TWiki Templates files. You can use skins to change the look of a TWiki 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: <scriptname>.<skin>.tmpl. For example, the Printable skin for the view template is view.print.tmpl.

Activating Skins

• Define the SKIN Preference variable in TWikiPreferences, one of the WebPreferences, or in a user - TWikiGuest - topic.

TWiki Skins

• Define the SKIN preference variable in TWikiPreferences, one of the WebPreferences, or a user preference. Ex:
  • Set SKIN = print
• Add ?skin=name to the URL, for this example:

• • Set SKIN = wikiwiki

TWiki Skins

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

A skin can be activated in two ways:

• Define the SKIN preference variable in TWikiPreferences, one of the WebPreferences, or a user preference. I.e.
  • Set SKIN = wikiwiki
    Note: Who has time to create the classic wikiwiki skin?
• Add ?skin=name to the URL, i.e. for this topic:
  • http://pyqplayer.sourceforge.net/cgi-bin/bin/view/TWiki/TWikiSkins?skin=print (for the print view skin)
  • http://pyqplayer.sourceforge.net/cgi-bin/bin/view/TWiki/TWikiSkins?skin=plain (for the plain view skin that has no header and footer)

The ?skin=name URL parameter overrides the SKIN preference value.

-- PeterThoeny - 20 Jan 2001