buildrelease
[openafs-wiki.git] / TWiki / PatternSkin.mdwn
1 # <a name="Pattern skin"></a><a name=" Pattern skin"></a> Pattern skin
2
3 **PatternSkin is developed to provide a CSS based default look and feel for TWiki - flexible and [[W3C]]-compliant.** Its layout and color scheme are designed to provide a nice, clean and productive _editing environment_. For use in corporate or perhaps in personal websites it should be fairly easy to tune the looks or even create a PatternSkin-based new skin.
4
5 <div><span>Page contents</span><ul>
6     <li>
7       <ul>
8         <li><a href="#Screen Shot"> Screen Shot</a></li>
9       </ul>
10     </li>
11     <li><a href="#TWiki Installation Error">TWiki Installation Error</a><ul>
12         <li><a href="#Creating your own look"> Creating your own look</a></li>
13         <li><a href="#Supported browsers"> Supported browsers</a></li>
14         <li><a href="#Installation"> Installation</a><ul>
15             <li><a href="#Troubleshooting"> Troubleshooting</a></li>
16           </ul>
17         </li>
18         <li><a href="#Skin Info"> Skin Info</a></li>
19         <li><a href="#Related topics"> Related topics</a></li>
20         <li><a href="#Feedback"> Feedback</a></li>
21       </ul>
22     </li>
23   </ul>
24 </div>
25
26 ## <a name="Screen Shot"></a> Screen Shot
27
28 [<img src="http://www.dementia.org/twiki//view/patternskin_screenshot.jpg" width="600" height="130" alt="Click for full screen image" style="border: 1px solid #eee" />](http://www.dementia.org/twiki//view/patternskin_screenshot_full.png)
29
30 ## <a name="Creating your own look"></a> Creating your own look
31
32 It is easy to tune the look and feel of PatternSkin by changing the color and space (margin, padding) settings in the Style Sheet files.
33
34 You may also choose to radically change the look and create a PatternSkin-based new skin. This is easier than to create a skin by writing new template files; you can concentrate on how things should look instead of what elements should get displayed.
35
36 - [[PatternSkinCustomization]] - how to configure page elements
37 - [[PatternSkinCssCookbook]] - how to customize the default look of TWiki
38 - [[PatternSkinCss]] - documentation of PatternSkin CSS classes
39
40 ## <a name="Supported browsers"></a> Supported browsers
41
42 PatternSkin has been tested successfully on the following browsers:
43
44 - Windows
45   - Internet Explorer 6.0, 5.5 (note: Explorer 5.0 is **not** supported: will function but shows visual quirks)
46   - Mozilla/Firefox
47 - Mac OS X
48   - Safari 2.0.3
49   - Mozilla/Firefox 1.5 (note: Firefox 1.0 will show visual quirks)
50 - \*nix
51   - Mozilla/Firefox 1.5 (note: Firefox 1.0 will show visual quirks)
52
53 ## <a name="Installation"></a> Installation
54
55 **Note:** You do not need to install anything on the browser to use this skin. The following instructions are for the administrator who installs the skin on the server where TWiki is running.
56
57 **Note 2:** PatternSkin is included with TWiki by default. Use the following instructions only if you are upgrading PatternSkin.
58
59 - Download the ZIP file from the Skin Home page (see below)
60 - Unzip <code>**%TOPIC%.zip**</code> in your twiki installation directory
61 - Test if installed: [[http://www.dementia.org/twiki/view/%WEB%/%TOPIC%?skin=pattern|%WEB%/%TOPIC%?skin=pattern]]
62 - For skin activation see [[TWikiSkins]]
63
64 ### <a name="Troubleshooting"></a> Troubleshooting
65
66 If you have set the SKIN variable setting to `pattern` and you still don't see the layout as on the [screenshot](http://www.dementia.org/twiki//view/patternskin_screenshot_full.png), a few settings in may have been disabled.
67
68 Check these variables here:
69
70 - TWIKILAYOUTURL = %TWIKILAYOUTURL%
71 - TWIKISTYLEURL = %TWIKISTYLEURL%
72 - TWIKICOLORSURL = %TWIKICOLORSURL%
73 - SKIN = %SKIN%
74
75 If TWIKILAYOUTURL or TWIKISTYLEURL don't give a value or point to non-existing files, check in [[TWikiPreferences]] that the following variables do exist and that they are set to on:
76
77        * %TWIKIWEB%.PatternSkin settings:
78           * Set TWIKILAYOUTURL = %PUBURLPATH%/%TWIKIWEB%/PatternSkin/layout.css
79           * Set TWIKISTYLEURL = %PUBURLPATH%/%TWIKIWEB%/PatternSkin/style.css
80           * Set TWIKICOLORSURL = %PUBURLPATH%/%TWIKIWEB%/PatternSkin/colors.css
81
82 If this still does not work, contact the administrator who installs skins.
83
84 For further troubleshooting and feedback, go to TWiki:Plugins/PatternSkinDev. Report bugs in the [[Support web|TWiki:Support/WebHome]].
85
86 ## <a name="Skin Info"></a> Skin Info
87
88 <table border="1" cellpadding="0" cellspacing="0">
89   <tr>
90     <td align="right"> Description: </td>
91     <td> TWiki's default skin; CSS based, flexible and [[Main/W3C]]-compliant </td>
92   </tr>
93   <tr>
94     <td align="right"> Screenshot: </td>
95     <td><a href="http://www.dementia.org/twiki//view/patternskin_screenshot_full.png"><img alt="Click for full screen image" height="130" src="http://www.dementia.org/twiki//view/patternskin_screenshot.jpg" style="border: 1px solid #eee" width="600" /></a></td>
96   </tr>
97   <tr>
98     <td align="right"> Preview: </td>
99     <td>[[%WEB%/%TOPIC%?skin=pattern]]</td>
100   </tr>
101   <tr>
102     <td align="right"> Base Name: </td>
103     <td> pattern </td>
104   </tr>
105   <tr>
106     <td align="right"> Skin Author: </td>
107     <td> TWiki:Main/ArthurClemens </td>
108   </tr>
109   <tr>
110     <td align="right"> Skin Version: </td>
111     <td> 31 Jan 2006 (v2.0.0) </td>
112   </tr>
113   <tr>
114     <td align="right"> History: </td>
115     <td>  </td>
116   </tr>
117   <tr>
118     <td align="right"> 31 Jan 2006: </td>
119     <td> v.2.0.0 - DAKAR RELEASE VERSION </td>
120   </tr>
121   <tr>
122     <td align="right"> 28 Aug 2004: </td>
123     <td> v.1.0.9 - CAIRO RELEASE VERSION </td>
124   </tr>
125   <tr>
126     <td align="right"> 08 Aug 2004: </td>
127     <td> Initial version (v1.0.0) </td>
128   </tr>
129   <tr>
130     <td align="right"> Dependencies: </td>
131     <td> TWiki:Plugins/TwistyContrib (automatically supported by Dakar) </td>
132   </tr>
133   <tr>
134     <td align="right"> Skin Home: </td>
135     <td><a href="http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%" target="_top">http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%</a></td>
136   </tr>
137   <tr>
138     <td align="right"> Feedback: </td>
139     <td><a href="http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev" target="_top">http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev</a></td>
140   </tr>
141   <tr>
142     <td align="right"> Download: </td>
143     <td><a href="http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%" target="_top">http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%</a></td>
144   </tr>
145 </table>
146
147 ## <a name="Related topics"></a> Related topics
148
149 - [[TWikiCss]]
150 - [[PatternSkinCss]]
151 - [[PatternSkinCssCookbook]]
152 - [[PatternSkinCssCookbookCenterPage]]
153 - [[PatternSkinCssCookbookEditTableStyle]]
154 - [[PatternSkinCssCookbookFonts]]
155 - [[PatternSkinCssCookbookNoLeftBar]]
156 - [[PatternSkinCssCookbookNoTopBar]]
157 - [[PatternSkinCustomization]]
158 - [[PatternSkinJavascripts]]
159 - [[WebBottomBar]]
160 - [[WebLeftBar]]
161 - [[WebLeftBarCookbook]]
162 - [[WebLeftBarExample]]
163 - [[WebLeftBarLogin]]
164 - [[WebLeftBarPersonalTemplate]]
165 - [[WebLeftBarSearch]]
166 - [[WebLeftBarWebsList]]
167 - [[WebTopBar]]
168 - [[AdminDocumentationCategory]]
169
170 Other skins:
171
172 - [[TWikiSkins]]
173 - [[TWikiSkinBrowser]]
174
175 ## <a name="Feedback"></a> Feedback
176
177 Leave remarks, suggestions and other feedback in TWiki:Plugins.PatternSkinDev.