none

[openafs-wiki.git] / TWiki / TWikiSkins.mdwn

<div>
  <ul>
    <li><a href="#TWiki Skins"> TWiki Skins</a><ul>
        <li><a href="#Overview"> Overview</a></li>
        <li><a href="#Changing the default TWiki skin"> Changing the default TWiki skin</a></li>
        <li><a href="#Defining Skins"> Defining Skins</a><ul>
            <li><a href="#Partial customisation, or adding"> Partial customisation, or adding in new features to an existing skin</a></li>
          </ul>
        </li>
        <li><a href="#Variables in Skins"> Variables in Skins</a></li>
        <li><a href="#The "Go" Box and Navigation Box"> The "Go" Box and Navigation Box</a></li>
        <li><a href="#Using Cascading Style Sheets"> Using Cascading Style Sheets</a></li>
        <li><a href="#Attachment Tables"> Attachment Tables</a></li>
        <li><a href="#Packaging and Publishing Skins"> Packaging and Publishing Skins</a></li>
        <li><a href="#Browsing Installed Skins"> Browsing Installed Skins</a></li>
        <li><a href="#Activating Skins"> Activating Skins</a></li>
        <li><a href="#Hard-Coded Skins"> Hard-Coded Skins</a></li>
      </ul>
    </li>
  </ul>
</div>

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

_Skins overlay regular templates to give different looks and feels to TWiki screens._

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

TWiki uses [[TWikiTemplates]] files as the basis of all the screens it uses to interact with users. Each screen has an associated template file that contains the basic layout of the screen. This is then filled in by the code to generate what you see in the browser.

TWiki ships with a default set of template files that give a basic look-and-feel. TWiki also includes support for _skins_ that can be selected to give different, more sophisticated, look and feels. A default TWiki installation will usually start up with the [[PatternSkin]] already selected. Skins may also be defined by third parties and loaded into a TWiki installation to give more options. To see how TWiki looks when **no** skin is selected, [[view this topic with a non-existant skin|%WEB%/%TOPIC%?skin=not_a_skin]].

Topic text is not affected by the choice of skin, though a skin can be defined to use a CSS (Cascading Style Sheet), which can sometimes give a radically different appearance to the text.

**_Relevant links on TWiki.org:_**

- TWiki:TWiki.TWikiSkinsSupplement - **_%T% tip:_** supplemental documentation on TWiki skins
- TWiki:Plugins.SkinPackage - list of all contributed skin packages
- TWiki:Plugins.SkinDevelopment - discussion and feedback on contributed skins
- TWiki:Plugins.SkinBrainstorming - open forum for new skin ideas
- TWiki:Plugins.SkinPackageHowTo - template to create a new skin package

**_See other types of extensions:_** [[TWikiAddOns]], [[TWikiContribs]], [[TWikiPlugins]]

## <a name="Changing the default TWiki skin"></a> Changing the default TWiki skin

TWiki default ships with the skin [[PatternSkin]] activated. If you want to modify the layout, colors or even the templates to suit your own needs, have a look first at the topics [[PatternSkinCustomization]] and [[PatternSkinCssCookbook]].

## <a name="Defining Skins"></a> Defining Skins

You may want to define your own skin, for example to comply with corporate web guidelines, or because you have a aesthetic vision that you want to share.

The [[TWikiTemplates]] files used for skins are located in the `twiki/templates` directory and are named according to the skin: <code>**&lt;scriptname&gt;.&lt;skin&gt;.tmpl**</code>. Skin files may also be defined in TWiki topics - see [[TWikiTemplates]] for details.

To start creating a new skin, copy the default [[TWikiTemplates]] (like `view.tmpl`), or copy an existing skin to use as a base for your own skin. You should only need to copy the files you intend to customise, as TWiki can be configured to fall back to another skin if a template is not defined in your skin. Name the files as described above (for example `view.myskin.tmpl`.

For your own TWiki skin you are encouraged to show a small 80x31 pixel [<img src="http://www.dementia.org/twiki//view/TWiki/TWikiLogos/T-logo-80x15.gif" width="80" height="15" alt="This site is powered by the TWiki collaboration platform" title="This site is powered by the TWiki collaboration platform" />](http://twiki.org/) logo at the bottom of your skin:

`<a href="http://twiki.org/"><img src="%PUBURL%/%TWIKIWEB%/TWikiLogos/T-logo-80x15.gif" alt="This site is powered by the TWiki collaboration platform" width="80" height="15" title="This site is powered by the TWiki collaboration platform" border="0" /></a>`

The standard TWiki skins show the logo in the `%WEBCOPYRIGHT%` variable.

**_%X% Note:_** Two skin names have _reserved_ meanings; `text` skin, and skin names starting with `rss` have [[hard-coded meanings|Main/WebHome#HardCodedSkins]].

The following template files are used for TWiki screens, and are referenced in the TWiki core code. If a skin doesn't define its own version of a template file, then TWiki will fall back to the next skin in the skin path, or finally, to the default version of the template file.

(Certain template files are expected to provide certain TMPL:DEFs - these are listed in sub-bullets)

- `addform` - used to select a new form for a topic
- `attachagain` - used when refreshing an existing attachment
- `attachnew` - used when attaching a new file to a topic
- `attachtables` - defines the format of attachments at the bottom of the standard topic view
  - `ATTACH:files:footer`, `ATTACH:files:header`, `ATTACH:files:row`, `ATTACH:versions:footer`, `ATTACH:versions:header`, `ATTACH:versions:row`
- `changeform` - used to change the form in a topic
- `changes` - used by the `changes` script
- `edit` - used for the edit screen
- `form`
- `formtables` - used to defined the format of forms
  - `FORM:display:footer`, `FORM:display:header`, `FORM:display:row`
- `login` - used for loggin in when using the TemplateLoginManager
  - `LOG_IN`, `LOG_IN_BANNER`, `LOG_OUT`, `LOGGED_IN_BANNER`, `NEW_USER_NOTE`, `UNRECOGNISED_USER`
- `moveattachment` - used when moving an attachment
- `oopsaccessdenied` - used to format Access Denied messages
  - `no_such_topic`, `no_such_web`, `only_group`, `topic_access`
- `oopsattention` - used to format Attention messages
  - `already_exists`, `bad_email`, `bad_ver_code`, `bad_wikiname`, `base_web_missing`, `confirm`, `created_web`, `delete_err`, `invalid_web_color`, `invalid_web_name`, `in_a_group`, `mandatory_field`, `merge_notice`, `missing_action`, `missing_fields`, `move_err`, `missing_action`, `no_form_def`, `no_users_to_reset`, `notwikiuser`, `oversized_upload`, `password_changed`, `password_mismatch`, `problem_adding`, `remove_user_done`, `rename_err`, `rename_not_wikiword`, `rename_topic_exists`, `rename_web_err`, `rename_web_exists`, `rename_web_prerequisites`, `reset_bad`, `reset_ok`, `save_error`, `send_mail_error`, `thanks`, `topic_exists`, `unrecognized_action`, `upload_name_changed`, `web_creation_error`, `web_exists`, `web_missing`, `wrong_password`, `zero_size_upload`
- `oopschangelanguage` - used to prompt for a new language when internationalisation is enabled
- `oopsgeneric` - a basic dialog for user information; provides "ok" button only
- `oopslanguagechanged` - used to confirm a new language when internationalisation is enabled
- `oopsleaseconflict` - used to format lease Conflict messages
  - `lease_active`, `lease_old`
- `preview` - used for previewing edited topics before saving
- `rdiff` - used for viewing topic differences
- `registernotify` - used by the user registration system
- `registernotifyadmin` - used by the user registration system
- `rename` - used when renaming a topic
- `renameconfirm` - used when renaming a topic
- `renamedelete` - used when renaming a topic
- `renameweb` - used when renaming a web
- `renamewebconfirm` - used when renaming a web
- `renamewebdelete` - used when renaming a web
- `searchbookview` - used to format inline search results in book view
- `searchformat` - used to format inline search results
- `search` - used by the `search` CGI script
- `settings`
- `view` - used by the `view` CGI script
- `viewprint` - used to create the printable view

`twiki.tmpl` is a master template conventionally used by other templates, but not used directly by code.

**_%X% Note:_** It is best to create these templates for your skin. If you `TMPL:INCLUDE` the default templates, or templates from other skins, when you are defining your own skin, you run the risk that the included file might change and break your skin.

### <a name="Partial customisation, or adding"></a> Partial customisation, or adding in new features to an existing skin

You can use recusion in the TMPL:INCLUDE chain (eg twiki.classic.tmpl contains `%TMPL:INCLUDE{"twiki"}%`, the templating system will include the next twiki.SKIN in the skin path. For example, to create a customisation of pattern skin, where you _only_ want to remove the edit &amp; WYSIWYG buttons from view page, you create only a `view.yourlocal.tmpl`:

    %TMPL:INCLUDE{"view"}%
    %TMPL:DEF{"edit_topic_link"}%%TMPL:END%
    %TMPL:DEF{"edit_wysiwyg_link"}%%TMPL:END%

and then set `SKIN=yourlocal,pattern`.

Because [[ClassicSkin]] and the default templates use the same Template definition names, you can over-ride the edit links in them (or any skin derived from them) using the same `view.yourlocal.tmpl` (just set SKIN=yourlocal,classic either in [[TWikiPreferences]] for globally, or a Web's Webname.WebPreferences for a particular web)

## <a name="Variables in Skins"></a> Variables in Skins

You can use [[template variables|Main/TWikiTemplates#TemplateVariables]], [[TWikiVariables]], and other predefined variables to compose your skins. Some commonly used variables in skins:

<table border="1" cellpadding="0" cellspacing="0">
  <tr>
    <th bgcolor="#99CCCC"><strong> Variable: </strong></th>
    <th bgcolor="#99CCCC"><strong> Expanded to: </strong></th>
  </tr>
  <tr>
    <td><code>%WEBLOGONAME%</code></td>
    <td> Filename of web logo </td>
  </tr>
  <tr>
    <td><code>%WEBLOGOIMG%</code></td>
    <td> Image URL of web logo </td>
  </tr>
  <tr>
    <td><code>%WEBLOGOURL%</code></td>
    <td> Link of web logo </td>
  </tr>
  <tr>
    <td><code>%WEBLOGOALT%</code></td>
    <td> Alt text of web logo </td>
  </tr>
  <tr>
    <td><code>%WIKILOGOURL%</code></td>
    <td> Link of page logo </td>
  </tr>
  <tr>
    <td><code>%WIKILOGOIMG%</code></td>
    <td> Image URL of page logo </td>
  </tr>
  <tr>
    <td><code>%WIKILOGOALT%</code></td>
    <td> Alt text of page logo </td>
  </tr>
  <tr>
    <td><code>%WEBBGCOLOR%</code></td>
    <td> Web-specific background color, defined in the [[Main/WebPreferences]]</td>
  </tr>
  <tr>
    <td><code>%WIKITOOLNAME%</code></td>
    <td> The name of your TWiki site </td>
  </tr>
  <tr>
    <td><code>%SCRIPTURL%</code></td>
    <td> The script URL of TWiki </td>
  </tr>
  <tr>
    <td><code>%SCRIPTURLPATH%</code></td>
    <td> The script URL path </td>
  </tr>
  <tr>
    <td><code>%SCRIPTSUFFIX%</code></td>
    <td> The script suffix, ex: <code>.pl</code>, <code>.cgi</code></td>
  </tr>
  <tr>
    <td><code>%WEB%</code></td>
    <td> The name of the current web. </td>
  </tr>
  <tr>
    <td><code>%TOPIC%</code></td>
    <td> The name of the current topic. </td>
  </tr>
  <tr>
    <td><code>%WEBTOPICLIST%</code></td>
    <td> Common links of current web, defined in the [[Main/WebPreferences]]. It includes a [[Main/WebHome#GoBox]]</td>
  </tr>
  <tr>
    <td><code>%TEXT%</code></td>
    <td> The topic text, e.g. the content that can be edited </td>
  </tr>
  <tr>
    <td><code>%META{"form"}%</code></td>
    <td>[[Main/TWikiForms]], if any </td>
  </tr>
  <tr>
    <td><code>%META{"attachments"}%</code></td>
    <td>[[Main/FileAttachment]] table </td>
  </tr>
  <tr>
    <td><code>%META{"parent"}%</code></td>
    <td> The topic parent </td>
  </tr>
  <tr>
    <td><code>%EDITTOPIC%</code></td>
    <td> Edit link </td>
  </tr>
  <tr>
    <td><code>%REVTITLE%</code></td>
    <td> The revision title, if any, ex: <code>(r1.6)</code></td>
  </tr>
  <tr>
    <td><code>%REVINFO%</code></td>
    <td> Revision info, ex: <code>r1.6 - 24 Dec 2002 - 08:12 GMT - Main.admin</code></td>
  </tr>
  <tr>
    <td><code>%WEBCOPYRIGHT%</code></td>
    <td> Copyright notice, defined in the [[Main/WebPreferences]]</td>
  </tr>
  <tr>
    <td><code>%BROADCASTMESSAGE%</code></td>
    <td> Broadcast message at the beginning of your view template, can be used to alert users of scheduled downtimes; can be set in [[Main/TWikiPreferences]]</td>
  </tr>
</table>

<a name="GoBox"></a>

## <a name="The &quot;Go&quot; Box and Navigation Box"></a> The "Go" Box and Navigation Box

The default skins include a [["Go" box|Main/GoBox]], also called "Jump" box, to jump to a topic.

The box also understands 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 `onchange` 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:

<form action="http://www.dementia.org/twiki/view/%WEB%/%TOPIC%" name="sample">
  <table bgcolor="#DDDDDD" border="0" cellpadding="5">
    <tr>
      <td colspan="2"> Bare bones header, for demo only </td>
    </tr>
    <tr>
      <td> Navigate: </td>
      <td><select name="sel" onchange="this.form.topic.value=this.options[this.selectedIndex].value; this.form.submit()"><option selected value="">...</option>
          <option value="http://twiki.org/">Intranet home</option>
          <option value="Main.TWikiUsers">Employee index</option>
          <option value="Main.WebHome">Main web</option>
          <option value="TWiki.WebHome">TWiki web</option>
          <option value="http://www.google.com/">Google</option>
          <option value="http://www.yahoo.com/">Yahoo!</option></select></td>
    </tr>
    <tr>
      <td> Jump: </td>
      <td><input name="topic" size="16" type="text" /></td>
    </tr>
  </table>
</form>

**_Note:_** Redirect to a URL only works if it is enabled in `configure` (Miscellaneous, `{AllowRedirectUrl}`).

## <a name="Using Cascading Style Sheets"></a> Using Cascading Style Sheets

CSS files are gererally attachments to the skin topic that are included in the the skin templates - in the case of [[PatternSkin]] in the template `styles.pattern.tmpl`.

- To see how CSS is used in the default TWiki skin, see: [[PatternSkin]]
- If you write a complete new skin, this is the syntax to use in a template file:

    <style type='text/css' media='all'>@import url('%PUBURLPATH%/%TWIKIWEB%/MySkin/mystyle.css');</style>

## <a name="Attachment Tables"></a> Attachment Tables

Controlling the look and feel of attachment tables is a little bit more complex than for the rest of a skin. By default, the attachment table is a standard TWiki table, and the look is controlled in the same way as other tables. In a very few cases you may want to change the _content_ of the table as well.

The format of standard attachment tables is defined through the use of special _TWiki template macros_ which by default, are defined in the `attachtables.tmpl` template using the `%TMPL:DEF` macro syntax described in [[TWikiTemplates]]. These macros are:

<table border="1" cellpadding="0" cellspacing="0">
  <tr>
    <th bgcolor="#99CCCC"><strong> Macro </strong></th>
    <th bgcolor="#99CCCC"><strong> Description </strong></th>
  </tr>
  <tr>
    <td><code>ATTACH:files:header</code></td>
    <td> Standard title bar </td>
  </tr>
  <tr>
    <td><code>ATTACH:files:row</code></td>
    <td> Standard row </td>
  </tr>
  <tr>
    <td><code>ATTACH:files:footer</code></td>
    <td> Footer for all screens </td>
  </tr>
  <tr>
    <td><code>ATTACH:files:header:A</code></td>
    <td> Title bar for upload screens, with attributes column </td>
  </tr>
  <tr>
    <td><code>ATTACH:files:row:A</code></td>
    <td> Row for upload screen </td>
  </tr>
  <tr>
    <td><code>ATTACH:files:footer:A</code></td>
    <td> Footer for all screens </td>
  </tr>
</table>

The format of tables of file versions in the Upload screen can also be changed, using the macros:

<table border="1" cellpadding="0" cellspacing="0">
  <tr>
    <th bgcolor="#99CCCC"><strong> Macro </strong></th>
    <th bgcolor="#99CCCC"><strong> Description </strong></th>
  </tr>
  <tr>
    <td><code>ATTACH:versions:header</code></td>
    <td> Header for versions table on upload screen </td>
  </tr>
  <tr>
    <td><code>ATTACH:versions:row</code></td>
    <td> Row format for versions table on upload screen </td>
  </tr>
  <tr>
    <td><code>ATTACH:versions:footer</code></td>
    <td> Footer for versions table on upload screen </td>
  </tr>
</table>

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

<table border="1" cellpadding="0" cellspacing="0">
  <tr>
    <th bgcolor="#99CCCC"><strong> Tag </strong></th>
    <th bgcolor="#99CCCC"><strong> Description </strong></th>
  </tr>
  <tr>
    <td><code>%A_URL%</code></td>
    <td> URL that will recover the file </td>
  </tr>
  <tr>
    <td><code>%A_REV%</code></td>
    <td> Revision of this file </td>
  </tr>
  <tr>
    <td><code>%A_ICON%</code></td>
    <td> A file icon suitable for representing the attachment content </td>
  </tr>
  <tr>
    <td><code>%A_FILE%</code></td>
    <td> The name of the file </td>
  </tr>
  <tr>
    <td><code>%A_SIZE%</code></td>
    <td> The size of the file </td>
  </tr>
  <tr>
    <td><code>%A_DATE%</code></td>
    <td> The date the file was uploaded </td>
  </tr>
  <tr>
    <td><code>%A_USER%</code></td>
    <td> The user who uploaded it </td>
  </tr>
  <tr>
    <td><code>%A_COMMENT%</code></td>
    <td> The comment they put in when uploading it </td>
  </tr>
  <tr>
    <td><code>%A_ATTRS%</code></td>
    <td> The attributes of the file as seen on the upload screen e.g "h" for a hidden file </td>
  </tr>
</table>

## <a name="Packaging and Publishing Skins"></a> Packaging and Publishing Skins

See TWiki:Plugins/SkinPackagingHowTo and TWiki:Plugins/SkinDeveloperFAQ

## <a name="Browsing Installed Skins"></a> Browsing Installed Skins

You can try out all installed skins in the [[TWikiSkinBrowser]].

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

TWiki uses a _skin search path_, which lets you combine skins additively. The skin path is defined using a combination of [[TWikiVariables]] and URL parameters.

TWiki works by asking for a template for a particular function - for example, 'view'. The detail of how templates are searched for is described in [[TWikiTemplates]], but in summary, the templates directory is searched for a file called `view.`_skin_`.tmpl`, where _skin_ is the name of the skin e.g. `pattern`. If no template is found, then the fallback is to use `view.tmpl`. Each skin on the path is searched for in turn. For example, if you have set the skin path to `local,pattern` then `view.local.tmpl` will be searched for first, then `view.pattern.tmpl` and finally `view.tmpl`.

The basic skin is defined by a `SKIN` setting:

- `Set SKIN = catskin, bearskin`

You can also add a parameter to the URL, such as `?skin=catskin,bearskin`:

- [[http://www.dementia.org/twiki/view/%WEB%/%TOPIC%?skin=catskin,bearskin|%WEB%/%TOPIC%?skin=catskin,bearskin]]

Setting `SKIN` (or the `?skin` parameter in the URL) replaces the existing skin path setting, for the current page only. You can also _extend_ the existing skin path as well, using _covers_.

- `Set COVER = ruskin`

This pushes a different skin to the front of the skin search path (so for our example above, that final skin path will be `ruskin, catskin, bearskin`). There is also an equivalent `cover` URL parameter. The difference between setting `SKIN` vs. `COVER` is that if the chosen template is not found (e.g., for included templates), `SKIN` will fall back onto the next skin in line, or the default skin, if only one skin was present, while `COVER` will always fall back onto the current skin.

An example would be invoking the printable mode, which is achieved by applying `?cover=print`. The `view.print.tmpl` simply invokes the `viewprint` template for the current skin which then can appropriately include all other used templates for the current skin. Where the printable mode be applied by using `SKIN`, all skins would have the same printable appearance.

The full skin path is built up as follows: `SKIN` setting (or `?skin` if it is set), then `COVER` setting is added, then `?cover`.

<a name="HardCodedSkins"></a>

## <a name="Hard-Coded Skins"></a> Hard-Coded Skins

The `text` skin is reserved for TWiki internal use.

Skin names starting with `rss` also have a special meaning; if one or more of the skins in the skin path starts with 'rss' then 8-bit characters will be encoded as XML entities in the output, and the `content-type` header will be forced to `text/xml`.

**_Related Topics:_** [[TWikiSkinBrowser]], [[AdminDocumentationCategory]], [[DeveloperDocumentationCategory]], TWiki:TWiki.TWikiSkinsSupplement

-- **_Contributors:_** TWiki:Main.PeterThoeny, TWiki:Main.MikeMannix, TWiki:Main.CrawfordCurrie