TWiki/TWikiCss.mdwn

   1 <div>
   2   <ul>
   3     <li><a href="#Appendix C: TWiki CSS"> Appendix C: 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><ul>
   6             <li><a href="#TWiki styles in core code"> TWiki styles in core code</a></li>
   7             <li><a href="#TWiki Styles in Plugins"> TWiki Styles in Plugins</a></li>
   8             <li><a href="#TWiki Styles in Templates"> TWiki Styles in Templates</a></li>
   9             <li><a href="#TWiki Styles used in =configure="> TWiki Styles used in configure</a></li>
  10             <li><a href="#TWiki Styles in topics"> TWiki Styles in topics</a></li>
  11             <li><a href="#TWiki Styles in Skins"> TWiki Styles in Skins</a></li>
  12           </ul>
  13         </li>
  14         <li><a href="#Tips"> Tips</a></li>
  15       </ul>
  16     </li>
  17   </ul>
  18 </div>
  19
  20 # <a name="Appendix C: TWiki CSS"></a> Appendix C: TWiki CSS
  21
  22 _Listing of CSS class names emitted from TWiki core code and standard plugins, for the Dakar release._
  23
  24 ## <a name="Who should read this document?"></a> Who should read this document?
  25
  26 Most 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.
  27
  28 ## <a name="Naming conventions"></a> Naming conventions
  29
  30 1. All TWiki class names have the prefix `twiki`. So: twikiAlert, twikiToc, etcetera. Remember that CSS class names are case sensitive - TWiki CSS uses lowercase `tw`.
  31 2. If you define your own CSS classes, it is preferable that you do not use the `twiki` prefix to prevent undesired overriding effects.
  32
  33 A wide range of standard styles are used in the TWiki core code and topics, and more are used in plugins. The following is an exhaustive list of all styles defined by the Pattern skin. For the most part, the names are the only documentation of the purpose of the style. For more information on how these styles are used, read the code (sorry!)
  34
  35 ### <a name="TWiki styles in core code"></a> TWiki styles in core code
  36
  37 <table border="1" cellpadding="0" cellspacing="0">
  38   <tr>
  39     <td> .twikiAlert </td>
  40     <td> Client.pm, Form.pm, Statistics.pm </td>
  41   </tr>
  42   <tr>
  43     <td> .twikiFirstCol </td>
  44     <td> Render.pm </td>
  45   </tr>
  46   <tr>
  47     <td> .twikiForm </td>
  48     <td> Render.pm </td>
  49   </tr>
  50   <tr>
  51     <td> .twikiNew </td>
  52     <td> Changes.pm, Search.pm </td>
  53   </tr>
  54   <tr>
  55     <td> .twikiHelp </td>
  56     <td> Changes.pm </td>
  57   </tr>
  58   <tr>
  59     <td> .twikiTopRow </td>
  60     <td> Manage.pm </td>
  61   </tr>
  62   <tr>
  63     <td> .twikiSummary </td>
  64     <td> Manage.pm </td>
  65   </tr>
  66   <tr>
  67     <td> .twikiGrayText </td>
  68     <td> Manage.pm </td>
  69   </tr>
  70   <tr>
  71     <td> .twikiCheckBox </td>
  72     <td> Manage.pm </td>
  73   </tr>
  74   <tr>
  75     <td> .twikiLink </td>
  76     <td> Render.pm </td>
  77   </tr>
  78   <tr>
  79     <td> .twikiNewLink </td>
  80     <td> Render.pm </td>
  81   </tr>
  82   <tr>
  83     <td> .twikiAnchorLink </td>
  84     <td> Render.pm </td>
  85   </tr>
  86   <tr>
  87     <td> .twikiCurrentWebHomeLink </td>
  88     <td> Render.pm </td>
  89   </tr>
  90   <tr>
  91     <td> .twikiCurrentTopicLink </td>
  92     <td> Render.pm </td>
  93   </tr>
  94   <tr>
  95     <td> .twikiEmulatedLink </td>
  96     <td> Preview.pm </td>
  97   </tr>
  98   <tr>
  99     <td> .twikiWebIndent </td>
 100     <td> TWiki.pm </td>
 101   </tr>
 102 </table>
 103
 104 <table border="1" cellpadding="0" cellspacing="0">
 105   <tr>
 106     <td> .twikiEditFormDateField </td>
 107     <td> Form.pm </td>
 108   </tr>
 109   <tr>
 110     <td> .twikiEditFormTextField </td>
 111     <td> Form.pm </td>
 112   </tr>
 113   <tr>
 114     <td> .twikiEditFormLabelField </td>
 115     <td> Form.pm </td>
 116   </tr>
 117   <tr>
 118     <td> .twikiEditFormTextAreaField </td>
 119     <td> Form.pm </td>
 120   </tr>
 121   <tr>
 122     <td> .twikiEditFormCheckboxButton </td>
 123     <td> Form.pm </td>
 124   </tr>
 125   <tr>
 126     <td> .twikiEditFormCheckboxField </td>
 127     <td> Form.pm </td>
 128   </tr>
 129   <tr>
 130     <td> .twikiRadioButton </td>
 131     <td> Form.pm </td>
 132   </tr>
 133   <tr>
 134     <td> .twikiEditFormRadioField </td>
 135     <td> Form.pm </td>
 136   </tr>
 137   <tr>
 138     <td> .twikiEditFormError </td>
 139     <td> Form.pm </td>
 140   </tr>
 141 </table>
 142
 143 <table border="1" cellpadding="0" cellspacing="0">
 144   <tr>
 145     <td> .twikiDiffTable </td>
 146     <td> RDiff.pm </td>
 147   </tr>
 148   <tr>
 149     <td> .twikiDiffDeletedHeader </td>
 150     <td> RDiff.pm </td>
 151   </tr>
 152   <tr>
 153     <td> .twikiDiffDeletedMarker </td>
 154     <td> RDiff.pm </td>
 155   </tr>
 156   <tr>
 157     <td> .twikiDiffDeletedText </td>
 158     <td> RDiff.pm </td>
 159   </tr>
 160   <tr>
 161     <td> .twikiDiffAddedHeader </td>
 162     <td> RDiff.pm </td>
 163   </tr>
 164   <tr>
 165     <td> .twikiDiffAddedMarker </td>
 166     <td> RDiff.pm </td>
 167   </tr>
 168   <tr>
 169     <td> .twikiDiffAddedText </td>
 170     <td> RDiff.pm </td>
 171   </tr>
 172   <tr>
 173     <td> .twikiDiffChangedHeader </td>
 174     <td> RDiff.pm </td>
 175   </tr>
 176   <tr>
 177     <td> .twikiDiffChangedText </td>
 178     <td> RDiff.pm </td>
 179   </tr>
 180   <tr>
 181     <td> .twikiDiffUnchangedText </td>
 182     <td> RDiff.pm </td>
 183   </tr>
 184   <tr>
 185     <td> .twikiDiffUnchangedTextContents </td>
 186     <td> RDiff.pm </td>
 187   </tr>
 188   <tr>
 189     <td> .twikiDiffLineNumberHeader </td>
 190     <td> RDiff.pm </td>
 191   </tr>
 192 </table>
 193
 194 <table border="1" cellpadding="0" cellspacing="0">
 195   <tr>
 196     <td> .twikiToc </td>
 197     <td> TWiki.pm </td>
 198   </tr>
 199   <tr>
 200     <td> .twikiTocTitle </td>
 201     <td> TWiki.pm </td>
 202   </tr>
 203 </table>
 204
 205 ### <a name="TWiki Styles in Plugins"></a> TWiki Styles in Plugins
 206
 207 <table border="1" cellpadding="0" cellspacing="0">
 208   <tr>
 209     <td> .twikiTable </td>
 210     <td>[[Main/TablePlugin]]</td>
 211   </tr>
 212   <tr>
 213     <td> .twikiSortedAscendingCol </td>
 214     <td>[[Main/TablePlugin]]</td>
 215   </tr>
 216   <tr>
 217     <td> .twikiSortedDescendingCol </td>
 218     <td>[[Main/TablePlugin]]</td>
 219   </tr>
 220   <tr>
 221     <td> .twikiFirstCol </td>
 222     <td>[[Main/TablePlugin]]</td>
 223   </tr>
 224   <tr>
 225     <td> .twikiTableEven </td>
 226     <td>[[Main/TablePlugin]]</td>
 227   </tr>
 228   <tr>
 229     <td> .twikiTableOdd </td>
 230     <td>[[Main/TablePlugin]]</td>
 231   </tr>
 232 </table>
 233
 234 ### <a name="TWiki Styles in Templates"></a> TWiki Styles in Templates
 235
 236 <table border="1" cellpadding="0" cellspacing="0">
 237   <tr>
 238     <td> .twikiFormTable </td>
 239     <td> formtables.tmpl, form.tmpl </td>
 240   </tr>
 241   <tr>
 242     <td> .twikiFormTableHRow </td>
 243     <td> formtables.tmpl, form.tmpl </td>
 244   </tr>
 245   <tr>
 246     <td> .twikiFormTableRow </td>
 247     <td> formtables.tmpl </td>
 248   </tr>
 249   <tr>
 250     <td> .twikiFormTableFooter </td>
 251     <td> formtables.tmpl </td>
 252   </tr>
 253   <tr>
 254     <td> .twikiAttachments </td>
 255     <td> attachtables.tmpl </td>
 256   </tr>
 257   <tr>
 258     <td> .twikiEditForm </td>
 259     <td> form.tmpl </td>
 260   </tr>
 261   <tr>
 262     <td> .twikiSubmit </td>
 263     <td>   </td>
 264   </tr>
 265   <tr>
 266     <td> .twikiSubmitDisabled </td>
 267     <td>   </td>
 268   </tr>
 269   <tr>
 270     <td> .twikiInputField </td>
 271     <td>   </td>
 272   </tr>
 273   <tr>
 274     <td> .twikiInputFieldDisabled </td>
 275     <td>   </td>
 276   </tr>
 277   <tr>
 278     <td> .twikiButton </td>
 279     <td>   </td>
 280   </tr>
 281   <tr>
 282     <td> .twikiLeft </td>
 283     <td>   </td>
 284   </tr>
 285   <tr>
 286     <td> .twikiRight </td>
 287     <td>   </td>
 288   </tr>
 289   <tr>
 290     <td> .twikiClear </td>
 291     <td>   </td>
 292   </tr>
 293   <tr>
 294     <td> .twikiHidden </td>
 295     <td>   </td>
 296   </tr>
 297   <tr>
 298     <td> .twikiSmall </td>
 299     <td>   </td>
 300   </tr>
 301   <tr>
 302     <td> .twikiBottomRow </td>
 303     <td>   </td>
 304   </tr>
 305   <tr>
 306     <td> .twikiSRAuthor </td>
 307     <td>   </td>
 308   </tr>
 309   <tr>
 310     <td> .twikiSRRev </td>
 311     <td>   </td>
 312   </tr>
 313   <tr>
 314     <td> .twikiPageForm </td>
 315     <td>   </td>
 316   </tr>
 317   <tr>
 318     <td> .twikiSeparator </td>
 319     <td>   </td>
 320   </tr>
 321   <tr>
 322     <td> .twikiAccessKey </td>
 323     <td>   </td>
 324   </tr>
 325   <tr>
 326     <td> .twikiLinkLabel </td>
 327     <td>   </td>
 328   </tr>
 329   <tr>
 330     <td> .twikiFormSteps </td>
 331     <td> container around a form, such as the attach form: attach.tmpl </td>
 332   </tr>
 333   <tr>
 334     <td> .twikiFormStep </td>
 335     <td> form row </td>
 336   </tr>
 337 </table>
 338
 339 ### <a name="TWiki Styles used in &lt;code&gt;configure="></a> TWiki Styles used in =configure
 340
 341 <table border="1" cellpadding="0" cellspacing="0">
 342   <tr>
 343     <td> #twikiLogin </td>
 344     <td> CSS.pm </td>
 345   </tr>
 346   <tr>
 347     <td> .twikiFormSteps </td>
 348     <td> CSS.pm </td>
 349   </tr>
 350   <tr>
 351     <td> .twikiFormStep </td>
 352     <td> CSS.pm </td>
 353   </tr>
 354 </table>
 355
 356 ### <a name="TWiki Styles in topics"></a> TWiki Styles in topics
 357
 358 <table border="1" cellpadding="0" cellspacing="0">
 359   <tr>
 360     <td> .twikiBroadcastMessage </td>
 361     <td>[[TWiki/TWikiPreferences]]</td>
 362   </tr>
 363   <tr>
 364     <td> #twikiSearchTable </td>
 365     <td>[[TWiki/WebSearch]], [[TWiki/WebSearchAdvanced]]</td>
 366   </tr>
 367 </table>
 368
 369 ### <a name="TWiki Styles in Skins"></a> TWiki Styles in Skins
 370
 371 <table border="1" cellpadding="0" cellspacing="0">
 372   <tr>
 373     <td> #twikiLogin </td>
 374     <td> login.pattern.tmpl </td>
 375     <td>   </td>
 376   </tr>
 377 </table>
 378
 379 ## <a name="Tips"></a> Tips
 380
 381 PatternSkin makes extensive use of CSS in its templates. Read the [[PatternSkin]] topic and [[PatternSkinCss]] to learn more about creating your own CSS-based skin.
 382
 383 Practical introduction to CSS: <http://www.w3.org/Style/LieBos2e/enter/>
 384
 385 **_Related Topics:_** [[TWikiSkins]], [[PatternSkin]], [[DeveloperDocumentationCategory]], [[AdminDocumentationCategory]]