buildrelease
[openafs-wiki.git] / 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 in topics"> TWiki Styles in topics</a></li>
10           </ul>
11         </li>
12         <li><a href="#Tips"> Tips</a></li>
13       </ul>
14     </li>
15   </ul>
16 </div>
17
18 # <a name="Appendix C: TWiki CSS"></a> Appendix C: TWiki CSS
19
20 _Listing of CSS class names emitted from TWiki core code and standard plugins, for the Dakar release._
21
22 ## <a name="Who should read this document?"></a> Who should read this document?
23
24 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.
25
26 ## <a name="Naming conventions"></a> Naming conventions
27
28 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`.
29 2. TWiki uses class names only (.twikiDiffTable) and no id names (#twikiDiffTable), to allow multiple class names. Class names are written using the dot prefix.
30 3. If you define your own CSS classes, it is preferable that you do not use the `twiki` prefix to prevent undesired overriding effects.
31
32 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!)
33
34 ### <a name="TWiki styles in core code"></a> TWiki styles in core code
35
36 <table border="1" cellpadding="0" cellspacing="0">
37   <tr>
38     <td> .twikiAlert </td>
39     <td> Client.pm, Form.pm, Statistics.pm </td>
40   </tr>
41   <tr>
42     <td> .twikiFirstCol </td>
43     <td> Render.pm </td>
44   </tr>
45   <tr>
46     <td> .twikiForm </td>
47     <td> Render.pm </td>
48   </tr>
49   <tr>
50     <td> .twikiNew </td>
51     <td> Changes.pm, Search.pm </td>
52   </tr>
53   <tr>
54     <td> .twikiHelp </td>
55     <td> Changes.pm </td>
56   </tr>
57   <tr>
58     <td> .twikiTopRow </td>
59     <td> Manage.pm </td>
60   </tr>
61   <tr>
62     <td> .twikiSummary </td>
63     <td> Manage.pm </td>
64   </tr>
65   <tr>
66     <td> .twikiGrayText </td>
67     <td> Manage.pm </td>
68   </tr>
69   <tr>
70     <td> .twikiCheckBox </td>
71     <td> Manage.pm </td>
72   </tr>
73   <tr>
74     <td> .twikiLink </td>
75     <td> Render.pm </td>
76   </tr>
77   <tr>
78     <td> .twikiNewLink </td>
79     <td> Render.pm </td>
80   </tr>
81   <tr>
82     <td> .twikiAnchorLink </td>
83     <td> Render.pm </td>
84   </tr>
85   <tr>
86     <td> .twikiEmulatedLink </td>
87     <td> Preview.pm </td>
88   </tr>
89   <tr>
90     <td> .twikiWebIndent </td>
91     <td> TWiki.pm </td>
92   </tr>
93 </table>
94
95 <table border="1" cellpadding="0" cellspacing="0">
96   <tr>
97     <td> .twikiEditFormTextField </td>
98     <td> Form.pm </td>
99   </tr>
100   <tr>
101     <td> .twikiEditFormLabelField </td>
102     <td> Form.pm </td>
103   </tr>
104   <tr>
105     <td> .twikiEditFormTextAreaField </td>
106     <td> Form.pm </td>
107   </tr>
108   <tr>
109     <td> .twikiEditFormCheckboxButton </td>
110     <td> Form.pm </td>
111   </tr>
112   <tr>
113     <td> .twikiEditFormCheckboxField </td>
114     <td> Form.pm </td>
115   </tr>
116   <tr>
117     <td> .twikiRadioButton </td>
118     <td> Form.pm </td>
119   </tr>
120   <tr>
121     <td> .twikiEditFormRadioField </td>
122     <td> Form.pm </td>
123   </tr>
124   <tr>
125     <td> .twikiEditFormError </td>
126     <td> Form.pm </td>
127   </tr>
128 </table>
129
130 <table border="1" cellpadding="0" cellspacing="0">
131   <tr>
132     <td> .twikiDiffTable </td>
133     <td> RDiff.pm </td>
134   </tr>
135   <tr>
136     <td> .twikiDiffDeletedHeader </td>
137     <td> RDiff.pm </td>
138   </tr>
139   <tr>
140     <td> .twikiDiffDeletedMarker </td>
141     <td> RDiff.pm </td>
142   </tr>
143   <tr>
144     <td> .twikiDiffDeletedText </td>
145     <td> RDiff.pm </td>
146   </tr>
147   <tr>
148     <td> .twikiDiffAddedHeader </td>
149     <td> RDiff.pm </td>
150   </tr>
151   <tr>
152     <td> .twikiDiffAddedMarker </td>
153     <td> RDiff.pm </td>
154   </tr>
155   <tr>
156     <td> .twikiDiffAddedText </td>
157     <td> RDiff.pm </td>
158   </tr>
159   <tr>
160     <td> .twikiDiffChangedHeader </td>
161     <td> RDiff.pm </td>
162   </tr>
163   <tr>
164     <td> .twikiDiffChangedText </td>
165     <td> RDiff.pm </td>
166   </tr>
167   <tr>
168     <td> .twikiDiffUnchangedText </td>
169     <td> RDiff.pm </td>
170   </tr>
171   <tr>
172     <td> .twikiDiffUnchangedTextContents </td>
173     <td> RDiff.pm </td>
174   </tr>
175   <tr>
176     <td> .twikiDiffLineNumberHeader </td>
177     <td> RDiff.pm </td>
178   </tr>
179 </table>
180
181 <table border="1" cellpadding="0" cellspacing="0">
182   <tr>
183     <td> .twikiToc </td>
184     <td> TWiki.pm </td>
185   </tr>
186   <tr>
187     <td> .twikiTocTitle </td>
188     <td> TWiki.pm </td>
189   </tr>
190 </table>
191
192 ### <a name="TWiki Styles in Plugins"></a> TWiki Styles in Plugins
193
194 <table border="1" cellpadding="0" cellspacing="0">
195   <tr>
196     <td> .twikiTable </td>
197     <td>[[Main/TablePlugin]]</td>
198   </tr>
199   <tr>
200     <td> .twikiSortedAscendingCol </td>
201     <td>[[Main/TablePlugin]]</td>
202   </tr>
203   <tr>
204     <td> .twikiSortedDescendingCol </td>
205     <td>[[Main/TablePlugin]]</td>
206   </tr>
207   <tr>
208     <td> .twikiFirstCol </td>
209     <td>[[Main/TablePlugin]]</td>
210   </tr>
211 </table>
212
213 ### <a name="TWiki Styles in Templates"></a> TWiki Styles in Templates
214
215 <table border="1" cellpadding="0" cellspacing="0">
216   <tr>
217     <td> .twikiFormTable </td>
218     <td> formtables.tmpl, form.tmpl </td>
219   </tr>
220   <tr>
221     <td> .twikiFormTableHRow </td>
222     <td> formtables.tmpl, form.tmpl </td>
223   </tr>
224   <tr>
225     <td> .twikiFormTableRow </td>
226     <td> formtables.tmpl </td>
227   </tr>
228   <tr>
229     <td> .twikiAttachments </td>
230     <td> attachtables.tmpl </td>
231   </tr>
232   <tr>
233     <td> .twikiEditForm </td>
234     <td> form.tmpl </td>
235   </tr>
236   <tr>
237     <td> .twikiSubmit </td>
238     <td>   </td>
239   </tr>
240   <tr>
241     <td> .twikiButton </td>
242     <td>   </td>
243   </tr>
244   <tr>
245     <td> .twikiLeft </td>
246     <td>   </td>
247   </tr>
248   <tr>
249     <td> .twikiRight </td>
250     <td>   </td>
251   </tr>
252   <tr>
253     <td> .twikiClear </td>
254     <td>   </td>
255   </tr>
256   <tr>
257     <td> .twikiHidden </td>
258     <td>   </td>
259   </tr>
260   <tr>
261     <td> .twikiSmall </td>
262     <td>   </td>
263   </tr>
264   <tr>
265     <td> .twikiBottomRow </td>
266     <td>   </td>
267   </tr>
268   <tr>
269     <td> .twikiSRAuthor </td>
270     <td>   </td>
271   </tr>
272   <tr>
273     <td> .twikiSRRev </td>
274     <td>   </td>
275   </tr>
276   <tr>
277     <td> .twikiPageForm </td>
278     <td>   </td>
279   </tr>
280   <tr>
281     <td> .twikiSeparator </td>
282     <td>   </td>
283   </tr>
284   <tr>
285     <td> .twikiAccessKey </td>
286     <td>   </td>
287   </tr>
288   <tr>
289     <td> .twikiLinkLabel </td>
290     <td>   </td>
291   </tr>
292   <tr>
293     <td> .twikiFormSteps </td>
294     <td> container around a form, such as the attach form: attach.tmpl </td>
295   </tr>
296   <tr>
297     <td> .twikiFormStep </td>
298     <td> form row </td>
299   </tr>
300 </table>
301
302 ### <a name="TWiki Styles in topics"></a> TWiki Styles in topics
303
304 <table border="1" cellpadding="0" cellspacing="0">
305   <tr>
306     <td> .twikiBroadcastMessage </td>
307     <td>[[TWiki/TWikiPreferences]]</td>
308   </tr>
309 </table>
310
311 ## <a name="Tips"></a> Tips
312
313 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.
314
315 Practical introduction to CSS: <http://www.w3.org/Style/LieBos2e/enter/>
316
317 **_Related Topics:_** [[TWikiSkins]], [[PatternSkin]], [[DeveloperDocumentationCategory]], [[AdminDocumentationCategory]]