data/TWiki/TWikiCss.txt
author Colas Nahaboo <colas@nahaboo.net>
Sat, 26 Jan 2008 15:50:53 +0100
changeset 0 414e01d06fd5
permissions -rw-r--r--
RELEASE 4.2.0 freetown
     1 %META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="7"}%
     2 %STARTINCLUDE%
     3 ---+ Appendix C: TWiki CSS
     4 
     5 _Listing of CSS class names emitted from TWiki core code and standard plugins, for the Dakar release._
     6 
     7 %TOC%
     8 
     9 ---++ Who should read this document?
    10 
    11 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.
    12 
    13 ---++ Naming conventions
    14 
    15    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=.
    16    1 If you define your own CSS classes, it is preferable that you do not use the =twiki= prefix to prevent undesired overriding effects.
    17 
    18 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!)
    19 
    20 ---+++ TWiki styles in core code
    21 
    22 |.twikiAlert  |Client.pm, Form.pm, Statistics.pm  |
    23 |.twikiFirstCol  |Render.pm  |
    24 |.twikiForm  |Render.pm  |
    25 |.twikiNew  |Changes.pm, Search.pm  |
    26 |.twikiHelp  |Changes.pm  |
    27 |.twikiTopRow  |Manage.pm  |
    28 |.twikiSummary  |Manage.pm  |
    29 |.twikiGrayText  |Manage.pm  |
    30 |.twikiCheckBox  |Manage.pm  |
    31 |.twikiLink  |Render.pm  |
    32 |.twikiNewLink  |Render.pm  |
    33 |.twikiAnchorLink  |Render.pm  |
    34 |.twikiCurrentWebHomeLink  |Render.pm  |
    35 |.twikiCurrentTopicLink  |Render.pm  |
    36 |.twikiEmulatedLink  |Preview.pm  |
    37 |.twikiWebIndent  |TWiki.pm  |
    38 
    39 |.twikiEditFormDateField  | Form.pm  |
    40 |.twikiEditFormTextField  |Form.pm  |
    41 |.twikiEditFormLabelField  |Form.pm  |
    42 |.twikiEditFormTextAreaField  |Form.pm  |
    43 |.twikiEditFormCheckboxButton  |Form.pm  |
    44 |.twikiEditFormCheckboxField  |Form.pm  |
    45 |.twikiRadioButton  |Form.pm  |
    46 |.twikiEditFormRadioField  |Form.pm  |
    47 |.twikiEditFormError  |Form.pm  |
    48 
    49 |.twikiDiffTable  |RDiff.pm  |
    50 |.twikiDiffDeletedHeader  |RDiff.pm  |
    51 |.twikiDiffDeletedMarker  |RDiff.pm  |
    52 |.twikiDiffDeletedText  |RDiff.pm  |
    53 |.twikiDiffAddedHeader  |RDiff.pm  |
    54 |.twikiDiffAddedMarker  |RDiff.pm  |
    55 |.twikiDiffAddedText  |RDiff.pm  |
    56 |.twikiDiffChangedHeader  |RDiff.pm  |
    57 |.twikiDiffChangedText  |RDiff.pm  |
    58 |.twikiDiffUnchangedText  |RDiff.pm  |
    59 |.twikiDiffUnchangedTextContents  |RDiff.pm  |
    60 |.twikiDiffLineNumberHeader  |RDiff.pm  |
    61 |.twikiDiffDebug  |RDiff.pm  |
    62 |.twikiDiffDebugRight  |RDiff.pm  |
    63 |.twikiDiffDebugLeft  |RDiff.pm  |
    64 
    65 |.twikiToc  |TWiki.pm  |
    66 |.twikiTocTitle  |TWiki.pm  |
    67 
    68 
    69 ---+++ TWiki Styles in Plugins
    70 ---++++ TablePlugin
    71 |=.twikiTable=  |The table  |
    72 |=.twikiSortedCol=  |A sorted column  |
    73 |=.twikiSortedAscendingCol=  |Sorted column, ascending  |
    74 |=.twikiSortedDescendingCol=  |Sorted column, descending  |
    75 |=.tableSortIcon=  |The sort icon holder (span)  |
    76 |=.twikiFirstCol=  |The first column  |
    77 |=.twikiTableEven= |Even numbered rows  |
    78 |=.twikiTableOdd= |Odd numbered rows  |
    79 |=.twikiTableCol= + column number  | Unique column identifier, for instance: =twikiTableCol0= |
    80 |=.twikiTableRow= + type + row number | Unique row identifier, for instance: =twikiTableRowdataBg0= |
    81 
    82 
    83 ---+++ TWiki Styles in Templates
    84 
    85 |.twikiPage  |twiki.tmpl  |
    86 |.twikiMiddleContainer  |twiki.tmpl  |
    87 |.twikiMain  |twiki.tmpl  |
    88 |.twikiFormTable  |formtables.tmpl, form.tmpl  |
    89 |.twikiFormTableHRow  |formtables.tmpl, form.tmpl  |
    90 |.twikiFormTableRow  |formtables.tmpl  |
    91 |.twikiFormTableFooter  |formtables.tmpl  |
    92 |.twikiAttachments  |attachtables.tmpl |
    93 |.twikiEditForm |form.tmpl |
    94 |.twikiSubmit  | |
    95 |.twikiSubmitDisabled  | |
    96 |.twikiInputField  | |
    97 |.twikiInputFieldDisabled  | |
    98 |.twikiInputFieldReadOnly  | |
    99 |.twikiInputFieldFocus | For Internet Explorer that does not recognize the =:focus= pseudo class selector |
   100 |.twikiInputFieldBeforeFocus  |for use with Javascript: the color of the input text when not clicked in the field |
   101 |.twikiTextarea | |
   102 |.twikiTextareaRawView | |
   103 |.twikiButton  | |
   104 |.twikiFocus  |Behaviour marker so a field can be given input focus |
   105 |.twikiLeft  | |
   106 |.twikiRight  | |
   107 |.twikiClear  | |
   108 |.twikiHidden  | |
   109 |.twikiSmall  | |
   110 |.twikiBottomRow  | |
   111 |.twikiSRAuthor  | |
   112 |.twikiSRRev  | |
   113 |.twikiPageForm  | |
   114 |.twikiSeparator  | |
   115 |.twikiAccessKey  | |
   116 |.twikiLinkLabel  | |
   117 |.twikiFormSteps  |container around a form, such as the attach form: attach.tmpl |
   118 |.twikiFormStep  |form row |
   119 |.twikiNoBreak   | no break on whitespace |
   120 |.twikiMakeVisible  |For elements that should only be visible with javascript on: default set to hidden, is made visible by javascript. Defaults to inline. |
   121 |.twikiMakeVisibleInline  |For =span= elements that should only be visible with javascript on: default set to hidden, is made visible by javascript. |
   122 |.twikiMakeVisibleBlock  |For =div= elements that should only be visible with javascript on: default set to hidden, is made visible by javascript. |
   123 |.twikiMakeHidden  |For elements that should be *hidden* with javascript on: no default style, is made hidden by javascript. |
   124 |.twikiFooterNote  | |
   125 |.twikiPopUp | Behaviour marker so a popup-window can be invoked |
   126 
   127 ---+++ TWiki Styles used in =configure=
   128 |#twikiLogin  |CSS.pm  |
   129 |.twikiFormSteps  |CSS.pm |
   130 |.twikiFormStep  |CSS.pm |
   131 
   132 ---+++ TWiki Styles in topics
   133 
   134 |.twikiBroadcastMessage  |%SYSTEMWEB%.TWikiPreferences  |
   135 |#twikiSearchTable  |%SYSTEMWEB%.WebSearch, %SYSTEMWEB%.WebSearchAdvanced  |
   136 
   137 ---+++ TWiki Styles in Skins
   138 |#twikiLogin  | login.pattern.tmpl  | |
   139 
   140 ---+++ Reserved Styles
   141 |.twikiImage  | defined in PatternSkin  |div creates border around enclosed image |
   142 |.twikiNotification  | defined in PatternSkin |temporary alert, lighter than broadcast message |
   143 |.twikiUnvisited  | defined in PatternSkin  |link style that ignores the visited link state; useful for form links |
   144 
   145 ---++ Tips
   146 !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.
   147 
   148 Practical introduction to CSS: http://www.w3.org/Style/LieBos2e/enter/
   149 
   150 __Related Topics:__ TWikiSkins, PatternSkin, DeveloperDocumentationCategory, AdminDocumentationCategory
   151 
   152 %STOPINCLUDE%