TWiki/TWikiCss.mdwn

   1 <div>
   2   <ul>
   3     <li><a href="#Appendix B: TWiki CSS"> Appendix B: TWiki CSS</a><ul>
   4         <li><a href="#Who should read this document?"> Who should read this document?</a></li>
   5         <li><a href="#Naming conventions"> Naming conventions</a></li>
   6         <li><a href="#CSS classes"> CSS classes</a><ul>
   7             <li><a href="#Classes from core code"> Classes from core code</a></li>
   8             <li><a href="#Classes from Plugins"> Classes from Plugins</a></li>
   9           </ul>
  10         </li>
  11         <li><a href="#Going further"> Going further</a></li>
  12       </ul>
  13     </li>
  14   </ul>
  15 </div>
  16
  17 # <a name="Appendix B: TWiki CSS"></a> Appendix B: TWiki CSS
  18
  19 _Listing of CSS class names emitted from TWiki core code and standard plugins, for the 01-Aug-2004 TWiki production release._
  20
  21 ## <a name="Who should read this document?"></a> Who should read this document?
  22
  23 More or less all html elements generated by TWiki core code now have Cascading Style Sheet (CSS) tags. **_Skin builders_** and others who want to change the appearance of the default TWiki installation or any of the skins can use this document to see what styles can be created for these html elements.
  24
  25 ## <a name="Naming conventions"></a> Naming conventions
  26
  27 1. All TWiki class names have the prefix `twiki`. So: twikiEditPage, twikiTopicAction, etcetera. Remember that CSS class names are case sensitive - TWiki CSS uses lowercase `tw`.
  28 2. TWiki uses class names only (.twikiViewPage) and no id names (#twikiViewPage), to allow multiple class names. Class names are written using the dot prefix.
  29 3. If you define your own CSS classes, it is preferable that you do not use the `twiki` prefix to prevent undesired overriding effects.
  30
  31 ## <a name="CSS classes"></a> CSS classes
  32
  33 ### <a name="Classes from core code"></a> Classes from core code
  34
  35 <table border="1" cellpadding="0" cellspacing="0">
  36   <tr>
  37     <td> .twikiNew </td>
  38     <td> Changes.pm </td>
  39   </tr>
  40   <tr>
  41     <td> .twikiChangeFormButtonHolder </td>
  42     <td> Edit.pm </td>
  43   </tr>
  44   <tr>
  45     <td> .twikiChangeFormButton </td>
  46     <td> Form.pm </td>
  47   </tr>
  48   <tr>
  49     <td> .twikiForm </td>
  50     <td> Form.pm </td>
  51   </tr>
  52   <tr>
  53     <td> .twikiEditFormTextField </td>
  54     <td> Form.pm </td>
  55   </tr>
  56   <tr>
  57     <td> .twikiEditFormLabelField </td>
  58     <td> Form.pm </td>
  59   </tr>
  60   <tr>
  61     <td> .twikiEditFormTextAreaField </td>
  62     <td> Form.pm </td>
  63   </tr>
  64   <tr>
  65     <td> .twikiEditFormCheckboxButton </td>
  66     <td> Form.pm </td>
  67   </tr>
  68   <tr>
  69     <td> .twikiEditFormCheckboxButton </td>
  70     <td> Form.pm </td>
  71   </tr>
  72   <tr>
  73     <td> .twikiEditFormCheckboxField </td>
  74     <td> Form.pm </td>
  75   </tr>
  76   <tr>
  77     <td> .twikiEditFormRadioField </td>
  78     <td> Form.pm </td>
  79   </tr>
  80   <tr>
  81     <td> .twikiEditFormError </td>
  82     <td> Form.pm </td>
  83   </tr>
  84   <tr>
  85     <td> .twikiRadioButton </td>
  86     <td> Form.pm </td>
  87   </tr>
  88   <tr>
  89     <td> .twikiCheckbox </td>
  90     <td> Form.pm </td>
  91   </tr>
  92   <tr>
  93     <td> .twikiEditFormError </td>
  94     <td> Form.pm </td>
  95   </tr>
  96   <tr>
  97     <td> .twikiDiffTable </td>
  98     <td> RDiff.pm </td>
  99   </tr>
 100   <tr>
 101     <td> .twikiDiffDeletedHeader </td>
 102     <td> RDiff.pm </td>
 103   </tr>
 104   <tr>
 105     <td> .twikiDiffDeletedMarker </td>
 106     <td> RDiff.pm </td>
 107   </tr>
 108   <tr>
 109     <td> .twikiDiffDeletedText </td>
 110     <td> RDiff.pm </td>
 111   </tr>
 112   <tr>
 113     <td> .twikiDiffAddedHeader </td>
 114     <td> RDiff.pm </td>
 115   </tr>
 116   <tr>
 117     <td> .twikiDiffAddedMarker </td>
 118     <td> RDiff.pm </td>
 119   </tr>
 120   <tr>
 121     <td> .twikiDiffAddedText </td>
 122     <td> RDiff.pm </td>
 123   </tr>
 124   <tr>
 125     <td> .twikiDiffChangedHeader </td>
 126     <td> RDiff.pm </td>
 127   </tr>
 128   <tr>
 129     <td> .twikiDiffChangedText </td>
 130     <td> RDiff.pm </td>
 131   </tr>
 132   <tr>
 133     <td> .twikiDiffUnchangedText </td>
 134     <td> RDiff.pm </td>
 135   </tr>
 136   <tr>
 137     <td> .twikiDiffLineNumberHeader </td>
 138     <td> RDiff.pm </td>
 139   </tr>
 140   <tr>
 141     <td> .twikiForm </td>
 142     <td> Render.pm </td>
 143   </tr>
 144   <tr>
 145     <td> .twikiAnchorLink </td>
 146     <td> Render.pm </td>
 147   </tr>
 148   <tr>
 149     <td> .twikiLink </td>
 150     <td> Render.pm </td>
 151   </tr>
 152   <tr>
 153     <td> .twikiNewLink </td>
 154     <td> Render.pm </td>
 155   </tr>
 156   <tr>
 157     <td> .twikiNew </td>
 158     <td> Search.pm </td>
 159   </tr>
 160   <tr>
 161     <td> .twikiAlert </td>
 162     <td> Search.pm </td>
 163   </tr>
 164   <tr>
 165     <td> .twikiAlert </td>
 166     <td> Statistics.pm </td>
 167   </tr>
 168   <tr>
 169     <td> .twikiAlert </td>
 170     <td> TWiki.pm </td>
 171   </tr>
 172   <tr>
 173     <td> .twikiToc </td>
 174     <td> TWiki.pm </td>
 175   </tr>
 176   <tr>
 177     <td> .twikiTocTitle </td>
 178     <td> TWiki.pm </td>
 179   </tr>
 180 </table>
 181
 182 ### <a name="Classes from Plugins"></a> Classes from Plugins
 183
 184 **[[TablePlugin]]**
 185
 186 <table border="1" cellpadding="0" cellspacing="0">
 187   <tr>
 188     <td> .twikiSortedAscendingCol </td>
 189     <td> !TablePlugin.pm </td>
 190   </tr>
 191   <tr>
 192     <td> .twikiSortedDescendingCol </td>
 193     <td> !TablePlugin.pm </td>
 194   </tr>
 195   <tr>
 196     <td> .twikiFirstCol </td>
 197     <td> !TablePlugin.pm </td>
 198   </tr>
 199 </table>
 200
 201 ## <a name="Going further"></a> Going further
 202
 203 PatternSkin makes fully use of CSS in its templates. Read the [[PatternSkin]] topic and [[PatternSkinCss]] to learn more about adjusting PatternSkin, or creating your own CSS-based skin.
 204
 205 See also: [[DragonSkin]].
 206
 207 Practical introduction to CSS: <http://www.w3.org/Style/LieBos2e/enter/>
 208
 209 -- TWiki:Main.ArthurClemens - 08 Aug 2004