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="#Supported browsers"> Supported browsers</a></li>
  13         <li><a href="#Installation"> Installation</a><ul>
  14             <li><a href="#Troubleshooting"> Troubleshooting</a></li>
  15           </ul>
  16         </li>
  17         <li><a href="#Creating your own look"> Creating your own look</a></li>
  18         <li><a href="#Customization"> Customization</a></li>
  19         <li><a href="#Further reading"> Further reading</a></li>
  20         <li><a href="#Skin Info"> Skin Info</a></li>
  21         <li><a href="#Related topics"> Related topics</a></li>
  22         <li><a href="#Feedback"> Feedback</a></li>
  23       </ul>
  24     </li>
  25   </ul>
  26 </div>
  27
  28 ## <a name="Screen Shot"></a> Screen Shot
  29
  30 [<img src="http://www.dementia.org/twiki//view/patternskin_screenshot.gif" width="600" height="130" alt="Click for full screen image" style="border: 1px solid #eee" />](http://www.dementia.org/twiki//view/patternskin_screenshot_full.gif)
  31
  32 ## <a name="Supported browsers"></a> Supported browsers
  33
  34 PatternSkin has been tested succesfully on the following browsers:
  35
  36 - Windows
  37   - Internet Explorer 6.0, 5.5 (note: Explorer 5.0 is **not** supported: will function but shows visual quirks)
  38   - Mozilla/Firefox
  39 - Mac OS X
  40   - Safari 1.2
  41   - Mozilla/Firefox
  42
  43 Not tested, but will probably work (let me know):
  44
  45 - \*nix
  46   - Mozilla/Firefox
  47
  48 ## <a name="Installation"></a> Installation
  49
  50 **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.
  51
  52 **Note 2:** PatternSkin is included with TWiki by default. Use the following instructions only if you are upgrading PatternSkin.
  53
  54 - Download the ZIP file from the Skin Home page (see below)
  55 - Unzip <code>**%TOPIC%.zip**</code> in your twiki installation directory
  56 - Test if installed: <http://www.dementia.org/twiki//view/%WEB%/%TOPIC%?skin=pattern>
  57 - For skin activation see [[TWikiSkins]]
  58
  59 ### <a name="Troubleshooting"></a> Troubleshooting
  60
  61 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.
  62
  63 Check these variables here:
  64
  65 - TWIKILAYOUTURL = %TWIKILAYOUTURL%
  66 - TWIKISTYLEURL = %TWIKISTYLEURL%
  67 - SKIN = %SKIN%
  68
  69 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:
  70
  71         * %TWIKIWEB%.PatternSkin settings:
  72                 * Set TWIKILAYOUTURL = %PUBURL%/%TWIKIWEB%/PatternSkin/layout.css
  73                 * Set TWIKISTYLEURL = %PUBURL%/%TWIKIWEB%/PatternSkin/style.css
  74
  75 If this still does not work, contact the administrator who installs skins.
  76
  77 For further troubleshooting and feedback, go to TWiki:Plugins/PatternSkinDev.
  78
  79 ## <a name="Creating your own look"></a> Creating your own look
  80
  81 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.
  82
  83 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.
  84
  85 You can eiter:
  86
  87 - Change the `layout.css` and `style.css` attachment files for this topic (upload updated versions)
  88 - In [[TWikiPreferences]], point the variables `TWIKILAYOUTURL` and `TWIKISTYLEURL` to other attachments, perhaps in another topic (your new skin topic?)
  89
  90 If you want to change colors and white space of screen elements, modify `style.css`. %BR% If you want to change the positioning of screen elements, modify `layout.css`.
  91
  92 See for practical details: [[PatternSkinCustomization]] %BR% The CSS classes that PatternSkin uses are documented in [[PatternSkinCss]].
  93
  94 ## <a name="Customization"></a> Customization
  95
  96 See: [[PatternSkinCustomization]]
  97
  98 ## <a name="Further reading"></a> Further reading
  99
 100 - [[PatternSkinCustomization]] - Practical information on how to change the looks of PatternSkin
 101 - [[PatternSkinCss]] - A reference to used CSS classes
 102 - TWiki:Plugins/PatternSkinDev - Development page, bug reports, solutions from users
 103
 104 ## <a name="Skin Info"></a> Skin Info
 105
 106 <table border="1" cellpadding="0" cellspacing="0">
 107   <tr>
 108     <td align="right"> Description: </td>
 109     <td> Provides a CSS based default look and feel for TWiki - flexible and [[Main/W3C]]-compliant </td>
 110   </tr>
 111   <tr>
 112     <td align="right"> Screenshot: </td>
 113     <td><a href="http://www.dementia.org/twiki//view/patternskin_screenshot_full.gif"><img alt="Click for full screen image" height="130" src="http://www.dementia.org/twiki//view/patternskin_screenshot.gif" style="border: 1px solid #eee" width="600" /></a></td>
 114   </tr>
 115   <tr>
 116     <td align="right"> Base Name: </td>
 117     <td> pattern </td>
 118   </tr>
 119   <tr>
 120     <td align="right"> Skin Author: </td>
 121     <td> TWiki:Main/ArthurClemens </td>
 122   </tr>
 123   <tr>
 124     <td align="right"> Skin Version: </td>
 125     <td> 24 Aug 2004 (v1.0.8) </td>
 126   </tr>
 127   <tr>
 128     <td align="right"> History: </td>
 129     <td>  </td>
 130   </tr>
 131   <tr>
 132     <td align="right"> 24 Aug 2004: </td>
 133     <td> v.1.0.8 - Fix for disabled TablePlugin; added plain.pattern.tmpl </td>
 134   </tr>
 135   <tr>
 136     <td align="right"> 23 Aug 2004: </td>
 137     <td> v.1.0.7 - Change to checkboxes in edit and preview screen; removed REVINFO at bottom; style changes </td>
 138   </tr>
 139   <tr>
 140     <td align="right"> 22 Aug 2004: </td>
 141     <td> v.1.0.6b - Removed files from zip that are now part of the TWiki distribution; removed .DS_Store files </td>
 142   </tr>
 143   <tr>
 144     <td align="right"> 17 Aug 2004: </td>
 145     <td> v.1.0.6 - Support for twikiMoved css class </td>
 146   </tr>
 147   <tr>
 148     <td align="right"> 17 Aug 2004: </td>
 149     <td> v.1.0.5 - Fix for not showing SEARCHSTRING </td>
 150   </tr>
 151   <tr>
 152     <td align="right"> 16 Aug 2004: </td>
 153     <td> v.1.0.4 - Fixes search results layout with noheader="on" </td>
 154   </tr>
 155   <tr>
 156     <td align="right"> 14 Aug 2004: </td>
 157     <td> v.1.0.3 - Update to attach template, css fix to edit template </td>
 158   </tr>
 159   <tr>
 160     <td align="right"> 14 Aug 2004: </td>
 161     <td> v.1.0.2 - Fixes print template, table paddings in topics, minor changes to style.css </td>
 162   </tr>
 163   <tr>
 164     <td align="right"> 13 Aug 2004: </td>
 165     <td> v.1.0.1 - Updated /data/TWiki/WebLeftBarPersonalTemplate and style.css </td>
 166   </tr>
 167   <tr>
 168     <td align="right"> 08 Aug 2004: </td>
 169     <td> Initial version (v1.0.0) </td>
 170   </tr>
 171   <tr>
 172     <td align="right"> Dependencies: </td>
 173     <td>   </td>
 174   </tr>
 175   <tr>
 176     <td align="right"> Skin Home: </td>
 177     <td><a href="http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%" target="_top">http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%</a></td>
 178   </tr>
 179   <tr>
 180     <td align="right"> Feedback: </td>
 181     <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>
 182   </tr>
 183   <tr>
 184     <td align="right"> Download: </td>
 185     <td><a href="http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%" target="_top">http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%</a></td>
 186   </tr>
 187 </table>
 188
 189 ## <a name="Related topics"></a> Related topics
 190
 191 - [[TWikiCss]]
 192 - [[WebBottomBar]]
 193 - [[WebLeftBar]]
 194 - [[WebLeftBarExample]]
 195 - [[WebLeftBarPersonalTemplate]]
 196 - [[WebLeftBarCookbook]]
 197 - [[WebTopBar]]
 198
 199 See also [[Further reading|Main/TOPIC#Further_reading]] on this page.
 200
 201 Other skins:
 202
 203 - [[TWikiSkins]]
 204 - [[TWikiSkinBrowser]]
 205
 206 ## <a name="Feedback"></a> Feedback
 207
 208 Leave remarks, suggestions and other feedback in TWiki:Plugins.PatternSkinDev.
 209
 210 -- TWiki:Main/ArthurClemens - 24 Aug 2004