TWikiSkins 15 - 25 Jul 2004 - Main.PeterThoeny
|
|
TWiki Skins | | 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. | > > | Although work is underway at TWiki:Codev.CssClassNames, the regular templates files currently do not use style sheets. Many skin developers, however, 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 : | |
| |
> > | 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 ay 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 templates/twiki.tmpl template using the %TMPL:DEF macro syntax described in TWikiTemplates. These macros are:
Macro | Description |
ATTACH:files:header | Standard title bar |
ATTACH:files:row | Standard row |
ATTACH:files:footer | Footer for all screens |
ATTACH:files:header:A | Title bar for upload screens, with attributes column |
ATTACH:files:row:A | Row for upload screen |
ATTACH:files:footer:A | Footer for all screens |
The format of tables of file versions in the Upload screen are also formattable, using the macros:
Macro | Description<-- --> |
ATTACH:versions:footer | Footer for versions table on upload screen |
ATTACH:versions:header | Header for versions table on upload screen |
ATTACH:versions:row | Row format for versions table on upload screen |
The ATTACH:row macros are expanded for each file in the attachment table, using the following special tags:
Tag | Description |
%A_URL% | URL that will recover the file |
%A_REV% | Revision of this file e.g. "1.1" |
%A_ICON% | A file icon suitable for representing the attachment content |
%A_FILE% | The name of the file |
%A_SIZE% | The size of the file |
%A_DATE% | The date the file was uploaded |
%A_USER% | The user who uploaded it |
%A_COMMENT% | The comment they put in when uploading it |
%A_ATTRS% | The attributes of the file as seen on the upload screen e.g "h" for a hidden file |
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. | | Packaging and Publishing Skins
See TWiki:Plugins/SkinPackagingHowTo and TWiki:Plugins/SkinDeveloperFAQ | |
> > | Browsing Installed Skins
You can try all installed skins in TWikiSkinBrowser. | | Activating Skins
A skin can be activated in two ways: | | The ?skin=name URL parameter overrides the SKIN Preference value. | |
< < | -- PeterThoeny - 05 Jan 2003 | > > | -- TWiki:Main.PeterThoeny - 25 Jul 2004
-- TWiki:Main.CrawfordCurrie - 30 Jun 2004
|
|
TWikiSkins 14 - 12 Oct 2003 - Main.PeterThoeny
|
|
TWiki Skins | |
%REVTITLE% | The revision title, if any, ex: (r1.6) |
%REVINFO% | Revision info, ex: r1.6 - 24 Dec 2002 - 08:12 GMT - TWikiGuest |
%WEBCOPYRIGHT% | Copyright notice, defined in the WebPreferences |
| |
< < |
%BROADCASTMESSAGE% | Broadcast message at the beginning of your view template, can be used to alert users of scheduled downtimes; is defined in TWikiPreferences |
| > > |
%BROADCASTMESSAGE% | Broadcast message at the beginning of your view template, can be used to alert users of scheduled downtimes; is set in TWikiPreferences |
| |
The "Go" Box and Navigation Box | |
| |
> > | 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>
| | Packaging and Publishing Skins
See TWiki:Plugins/SkinPackagingHowTo and TWiki:Plugins/SkinDeveloperFAQ |
|
TWikiSkins 11 - 08 Jan 2003 - Main.PeterThoeny
|
|
TWiki Skins | |
%WIKITOOLNAME% | The name of your TWiki site |
%SCRIPTURL% | The script URL of TWiki |
%SCRIPTSUFFIX% | The script suffix, ex: .pl , .cgi |
| |
< < |
%WEB% | The name of the current web. Note: It is recommended to URL-encode the variable in form actions with %URLENCODE{"%WEB%"}% for proper handling in an internationalized environment |
%TOPIC% | The name of the current topic. Note: It is recommended to URL-encode the variable in form actions with %URLENCODE{"%TOPIC%"}% for proper handling in an internationalized environment |
| > > |
%WEB% | The name of the current web. Note: It is recommended to URL-encode the variable in form actions with %INTURLENCODE{"%WEB%"}% for proper handling in an internationalized environment |
%TOPIC% | The name of the current topic. Note: It is recommended to URL-encode the variable in form actions with %INTURLENCODE{"%TOPIC%"}% for proper handling in an internationalized environment |
| |
%WEBTOPICLIST% | Common links of current web, defined in the WebPreferences. It includes a #GoBox |
%TEXT% | The topic text, e.g. the content that can be edited |
%META{"form"}% | TWikiForm, if any |
| | 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: | |
< < | | > > | | | |
|
TWikiSkins 10 - 05 Jan 2003 - Main.PeterThoeny
|
|
TWiki Skins | |
%WIKITOOLNAME% | The name of your TWiki site |
%SCRIPTURL% | The script URL of TWiki |
%SCRIPTSUFFIX% | The script suffix, ex: .pl , .cgi |
| |
< < |
%WEB% | The name of the current web |
%WEBURLENCODED% | The name of the current web, URL encoded (for form action) |
%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. Note: It is recommended to URL-encode the variable in form actions with %URLENCODE{"%WEB%"}% for proper handling in an internationalized environment |
%TOPIC% | The name of the current topic. Note: It is recommended to URL-encode the variable in form actions with %URLENCODE{"%TOPIC%"}% for proper handling in an internationalized environment |
| |
%WEBTOPICLIST% | Common links of current web, defined in the WebPreferences. It includes a #GoBox |
%TEXT% | The topic text, e.g. the content that can be edited |
%META{"form"}% | TWikiForm, if any |
| | 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: | |
< < | | > > | | | | | The ?skin=name URL parameter overrides the SKIN Preference value. | |
< < | -- PeterThoeny - 03 Jan 2003 | > > | -- PeterThoeny - 05 Jan 2003 |
|
TWikiSkins 9 - 04 Jan 2003 - Main.PeterThoeny
|
|
TWiki 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 . | |
> > | 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: | Expanded to: |
%WIKILOGOURL% | Link of page logo |
%WIKILOGOIMG% | Image URL of page logo |
%WIKILOGOALT% | Alt text of page logo |
%WEBBGCOLOR% | Web specific background color, defined in the WebPreferences |
%WIKITOOLNAME% | The name of your TWiki site |
%SCRIPTURL% | The script URL of TWiki |
%SCRIPTSUFFIX% | The script suffix, ex: .pl , .cgi |
%WEB% | The name of the current web |
%WEBURLENCODED% | The name of the current web, URL encoded (for form action) |
%TOPIC% | The name of the current topic |
%TOPICURLENCODED% | The name of the current topic, URL encoded (for form action) |
%WEBTOPICLIST% | Common links of current web, defined in the WebPreferences. It includes a #GoBox |
%TEXT% | The topic text, e.g. the content that can be edited |
%META{"form"}% | TWikiForm, if any |
%META{"attachments"}% | FileAttachment table |
%META{"parent"}% | The topic parent |
%EDITTOPIC% | Edit link |
%REVTITLE% | The revision title, if any, ex: (r1.6) |
%REVINFO% | Revision info, ex: r1.6 - 24 Dec 2002 - 08:12 GMT - TWikiGuest |
%WEBCOPYRIGHT% | Copyright notice, defined in the WebPreferences |
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 | | Activating Skins
A skin can be activated in two ways: | | The ?skin=name URL parameter overrides the SKIN Preference value. | |
< < | -- PeterThoeny - 14 Jul 2001
| > > | -- PeterThoeny - 03 Jan 2003 |
|
TWikiSkins 8 - 16 Sep 2001 - Main.MikeMannix
|
|
TWiki Skins | |
< < | Overlay regular templates with alternate header/footer layouts | > > | Skins overlay regular templates with alternate header/footer layouts; topic text is not affected | | Overview |
|
TWikiSkins 7 - 14 Sep 2001 - Main.PeterThoeny
|
|
TWiki 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. | > > | Skins are customized TWikiTemplates 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 | > > | 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 . |
|
TWikiSkins 6 - 10 Sep 2001 - Main.MikeMannix
|
|
> > | | | TWiki Skins | |
< < | Skins are customized TWikiTemplate files. You can use skins to change the look of a TWiki 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 | | | |
< < | 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). | > > | 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 | | A skin can be activated in two ways: | |
< < | | > > | | | | |
> > | | |
- Add
?skin=name to the URL, for this example:
| | | |
< < | The ?skin=name URL parameter overrides the SKIN preference value. | > > | The ?skin=name URL parameter overrides the SKIN Preference value. | | -- PeterThoeny - 14 Jul 2001
|
|
TWikiSkins 5 - 07 Sep 2001 - Main.MikeMannix
|
|
< < | TWiki Skins | > > | TWiki Skins | | Skins are customized TWikiTemplate files. You can use skins to change the look of a TWiki 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. |
|
TWikiSkins 4 - 30 Aug 2001 - Main.MikeMannix
|
| TWiki Skins | |
< < | Skins are customized TWikiTemplate files. You can use skins to change the look of a TWiki topic, for example the layout of the header and footer. Note that the renderd text between header and footer does not change. You can use skins also to define an alternate view, i.e. a view optimized for printing. | > > | Skins are customized TWikiTemplate files. You can use skins to change the look of a TWiki 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. | | | |
< < | A skin file is located in the twiki/template directory and has a name like <scriptname>.<skin>.tmpl . For example, the print skin for the view template is view.print.tmpl (red color added for clarification). | > > | 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). | | 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.
- Add
?skin=name to the URL, i.e. for this topic:
| > > |
- Define the SKIN preference variable in TWikiPreferences, one of the WebPreferences, or a user preference. Ex:
- Add
?skin=name to the URL, for this example:
| | |
|
TWikiSkins 3 - 15 Jul 2001 - Main.PeterThoeny
|
| TWiki Skins | |
< < | Skins are customized template files. You can use skins to change the look of a TWiki topic, for example the layout of the header and footer. Note that the renderd text between header and footer does not change. You can use skins also to define an alternate view, i.e. a view optimized for printing. | > > | Skins are customized TWikiTemplate files. You can use skins to change the look of a TWiki topic, for example the layout of the header and footer. Note that the renderd text between header and footer does not change. You can use skins also to define an alternate view, i.e. a view optimized for printing. | | | |
< < | 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 file is located in the twiki/template directory and has a name like <scriptname>.<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: | |
< < |
-
- Set SKIN = wikiwiki
Note: Who has time to create the classic wikiwiki skin?
| > > | | |
- Add
?skin=name to the URL, i.e. for this topic:
The ?skin=name URL parameter overrides the SKIN preference value. | |
< < | -- PeterThoeny - 16 Mar 2001
| > > | -- PeterThoeny - 14 Jul 2001
|
|
TWikiSkins 2 - 16 Mar 2001 - Main.PeterThoeny
|
|
> > | TWiki Skins | | Skins are customized template files. You can use skins to change the look of a TWiki topic, for example the layout of the header and footer. Note that the renderd text between header and footer does not change. You can use skins also to define an alternate view, i.e. a view optimized for printing. | |
< < | 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 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: | | | |
< < | The ?skin=name URL parameter overrides the SKIN preference value. | > > | The ?skin=name URL parameter overrides the SKIN preference value. | | | |
< < | -- PeterThoeny? - 20 Jan 2001
| > > | -- PeterThoeny - 16 Mar 2001
|
|
TWikiSkins 1 - 20 Jan 2001 - Main.PeterThoeny
|
|
> > | Skins are customized template files. You can use skins to change the look of a TWiki topic, for example the layout of the header and footer. Note that the renderd text between header and footer does not change. You can use skins also to define an alternate view, i.e. a view optimized for printing.
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:
The ?skin=name URL parameter overrides the SKIN preference value.
-- PeterThoeny? - 20 Jan 2001
|
|
Revision 15 | r15 - 25 Jul 2004 - 23:29:00 - PeterThoeny? |
Revision 14 | r14 - 12 Oct 2003 - 18:11:36 - PeterThoeny? |
Revision 13 | r13 - 12 Oct 2003 - 06:15:00 - PeterThoeny? |
Revision 12 | r12 - 26 Jul 2003 - 20:58:00 - PeterThoeny? |
Revision 11 | r11 - 08 Jan 2003 - 07:14:49 - PeterThoeny? |
Revision 10 | r10 - 05 Jan 2003 - 04:59:21 - PeterThoeny? |
Revision 9 | r9 - 04 Jan 2003 - 08:38:00 - PeterThoeny? |
Revision 8 | r8 - 16 Sep 2001 - 05:51:07 - MikeMannix? |
Revision 7 | r7 - 14 Sep 2001 - 08:43:22 - PeterThoeny? |
Revision 6 | r6 - 10 Sep 2001 - 00:07:45 - MikeMannix? |
Revision 5 | r5 - 07 Sep 2001 - 10:07:38 - MikeMannix? |
Revision 4 | r4 - 30 Aug 2001 - 22:08:21 - MikeMannix? |
Revision 3 | r3 - 15 Jul 2001 - 06:51:19 - PeterThoeny? |
Revision 2 | r2 - 16 Mar 2001 - 08:59:35 - PeterThoeny? |
Revision 1 | r1 - 20 Jan 2001 - 23:28:47 - PeterThoeny? |
|
|
This site is powered by the TWiki collaboration platform. All material on this collaboration platform is the property of the contributing authors. All material marked as authored by Eben Moglen is available under the license terms CC-BY-SA version 4.
|
|