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