(:groupheader:)(:Summary: Modifying the style of page contents:) (:div class='rfloat frame' style='clear:right; font-size:small;':) '''Contents''' *[[#Basics|Basics]] *[[#Scope|Scope]] *[[#blocks|In tables and directives]] *[[#Attributes|Attributes]] *[[#Styles|Enabling Styles]] *[[#Shortcuts|Custom style shortcuts]] *[[#predefined|Predefined Style Shortcuts]] *[[#Examples|Examples]] *[[#KnownIssues|Known Issues]] *[[#SeeAlso|See Also]] (:divend:) (:Audience: authors (basic, advanced) :) <:vspace> [[#Basics]] !! WikiStyle basics <:vspace> WikiStyles allow authors to modify the color and other styling attributes of the contents of a page. A WikiStyle is written using percent-signs, as in %red%[@%red%@]%% or %bgcolor=lightblue%[@%bgcolor=lightblue%@]%%. <:vspace> [[#Attributes]] !! WikiStyle attributes <:vspace> The style attributes recognized within a WikiStyle specification are: (:table:) (:cellnr colspan=2:)%center%------------ CSS -------------%% (:cell:)%center%--HTML--%% (:cellnr:) bgcolor background-color border'^[[#al|1]]^' color background-color border display float font-size font-family font-weight font-style (:cell:) height[[#fn|*]] list-style margin'^[[#al|1]]^' padding'^[[#al|1]]^' text-align text-decoration white-space width[[#fn|*]] (:cell:) accesskey align class hspace id target rel vspace value (:cellnr rowspan=3:) Special: define, apply (:tableend:) <:vspace> The attributes in the first two columns correspond to the ''[[cascading style sheet -> http://blooberry.com/indexdot/css/propindex/all.htm]]'' (CSS) properties of the same name. The attributes in the last column apply only to specific items: <:vspace> * '''[@class=@]''' and '''[@id=@]''' assign a CSS class or identifier to an HTML element * '''[@target=name@]''' opens links that follow in a browser window called "name" * '''[@rel=name@]''' in a link identifies the relationship of a target page * '''[@accesskey=x@]''' uses 'x' as a shortcut key for the link that follows * '''[@value=9@]''' sets the number of the current ordered list item <:vspace> ** [[#fn]] The width and height attributes have asterisks because they are handled specially for <img .../> tags. If used by themselves (i.e., without anything providing an "apply=" parameter to the WikiStyle), then they set the 'width=' and 'height=' attributes of any <img ... /> tags that follow. Otherwise, they set the 'width:' and 'height:' properties of the element being styled. ## [[#al]] margin, padding, and border can be suffixed by -left, -right, -top, and -bottom <:vspace> !! WikiStyles versus CSS styles WikiStyles, as written in the wiki page, are not exactly CSS styles or CSS classes. WikiStyles allow authors to use both pre-defined by the administrator CSS classes, and to define new combinations of styles, without any need to edit/update local CSS files on the server. <:vspace> Note that PmWiki allows advanced authors to use of @@ class= @@ and @@ style= @@ in tables and division blocks, but these are raw HTML attributes, and not WikiStyles, knowledge of CSS is required to use them. <:vspace> !! Text color and font The most basic use of WikiStyles is to change text attributes such as color, background color, and font. PmWiki defines several WikiStyles for changing the text color to [=%black%, %white%, %red%, %yellow%, %blue%, %gray%, %silver%, %maroon%, %green%, %navy%, and %purple%=]. <:vspace> (:markup class=horiz:) The basket contains %red% apples, %blue% blueberries, %purple% eggplant, %green% limes, %% and more. (:markupend:) <:vspace> For colors other than the predefined colors, use the [@%color=...%@] WikiStyle. (Note: RGB colors (#rrggbb) should always be specified with lowercase letters to avoid [[WikiWord]] conflicts.) <:vspace> (:markup class=horiz:) I'd like to have some %color=#ff7f00% tangerines%%, too! (:markupend:) <:vspace> To change the background color, use [@%bgcolor=...%@] as a WikiStyle: <:vspace> (:markup class=horiz:) This sentence contains %bgcolor=green yellow% yellow text on a green background. (:markupend:) <:vspace> See [[(PmWiki:)WikiStyle Colors]] for more color help. <:vspace> !! Text justification WikiStyles are used to control the text justification <:vspace> (:markup class=horiz:) %center% This text is centered. <:vspace> %right% Right justified. (:markupend:) <:vspace> and to create floating text: <:vspace> (:markup class=horiz:) %rfloat% This text floats to the right <:vspace> %rframe% floats to the right with a frame <:vspace> Lorem ipsum dolor sit amet, consectetuer sadipscing elitr (:markupend:) <:vspace> <:vspace> [[#Scope]] !! Scope <:vspace> WikiStyles can also specify a ''scope''; with no scope, the style is applied to any text that follows up to the next WikiStyle specification or the end of the paragraph, whichever comes first. The '''apply=''' attribute and its shortcuts allow to change the scope as follows: <:vspace> ||class='tabtable' cellpadding=3 cellspacing=0 style="border:1px dotted blue;" rules=rows ||!apply attribute ||!shortcut ||!style applies to... || ||[@%apply=img ...%@] ||- ||all images that ''follow'' until another style applied|| ||[@%apply=p ...%@] ||[@%p ...%@] ||the current paragraph|| ||[@%apply=pre ...%@] ||- ||the current preformatted text|| ||[@%apply=list ...%@] ||[@%list ...%@] ||the current list|| ||[@%apply=item ...%@] ||[@%item ...%@] ||the current list item|| ||[@%apply=div ...%@] ||- ||the current div|| ||[@%apply=block ...%@] ||[@%block ...%@] ||to the current block, whether it's a paragraph, list, list item, heading, or division.|| <:vspace> Thus, '''[@%p color=blue%@]''' is the same as '''[@%apply=p color=blue%@]''', and '''[@%list ROMAN%@]''' is the same as '''[@%apply=list list-style=upper-roman%@]'''. <:vspace> Some [[#predefined|predefined style shortcuts]] also make use of apply, thus '''[@%right%@]''' is a shortcut for '''[@%text-align=right apply=block%@]'''. <:vspace> Example: Apply a style to a paragraph: (:markup:) %p bgcolor=#ffeeee% The WikiStyle specification at the beginning of this line applies to the entire paragraph, even if there are %blue% other WikiStyle specifications %% in the middle of the paragraph. (:markupend:) <:vspace> <:vspace> '''Caveat''': An applied WikiStyle will only take effect if it's on the line that starts the thing it's supposed to modify. In other words, a WikiStyle in the third markup line of a paragraph can't change the attributes of the paragraph: <:vspace> (:markup class=horiz:) after the first line of the paragraph, we try to %apply=p color=blue% change color. This does't work because the style comes after the first line of the paragraph. (:markupend:) <:vspace> (:markup class=horiz:) However, this %apply=p color=red% paragraph ''will'' be in red because its block style does occur in the first line of its text. (:markupend:) <:vspace> (:markup class=horiz:) * Here's a list item * %list red% Oops, too late to affect the list! (:markupend:) <:vspace> <:vspace> <:vspace> [[#blocks]] !! Larger blocks <:vspace> The '''[@>>WikiStyle<<@]''' block can be used to apply a WikiStyle to a large block of items. The style is applied until the next [@>><<@] is encountered. <:vspace> (:markup class=horiz:) >>blue font-style:italic bgcolor=#ffffcc<< Everything after the above line is styled with blue italic text, <:vspace> This includes preformatted %red%text%% * lists -> indented items >><< (:markupend:) <:vspace> Note, the '''[@(:div style="..." class="...":)@]''' directive does not work the same way as [@>>WikiStyle<<@], it can only contain the regular HTML style and class attributes. <:vspace> <:vspace> [[#styleclass]] !! HTML "class" and "style" attributes for tables and divisions WikiStyles are only the commands between [@%...%@] percent signs. <:vspace> [[PmWiki/Tables]], [[PmWiki/table directives]] and [=(:div:)=] division blocks allow advanced authors to incorporate the HTML/CSS attributes @@ class= @@ and @@ style=@@. %red% Note that these attributes are not WikiStyles%%, knowledge of CSS is required to use them. <:vspace> (:markup class=horiz:) (:table style="font-style:italic; color:green; border:1px solid blue; background-color:#ffffcc":) (:cellnr:) Everything after the above line is styled with green italic text, <:vspace> This includes preformatted text * lists -> indented items (:tableend:) (:markupend:) <:vspace> Note, the '''[@(:div style="..." class="...":)@]''' directive does not work the same way as [@>>style<<@], as mentioned above, it can only contain the HTML style and class attributes. <:vspace> [[#Shortcuts]] !! Custom style shortcuts <:vspace> The '''[@define=@]''' attribute can be used to assign a shorthand name to any WikiStyle specification. This shorthand name can then be reused in later WikiStyle specifications. <:vspace> (:markup class=horiz:) %define=box block bgcolor=#ddddff border="2px dotted blue"% <:vspace> %box% [@some sort of text@] <:vspace> %box font-weight=bold color=green% [@some sort of text@] (:markupend:) <:vspace> -< '''Tip:''' It's often a good idea to put common style definitions into [[Group Header(s)]] pages so that they can be shared among multiple pages in a group. Or, the [[wiki administrator]] can predefine styles site-wide as a [[local customization(s)]] (see [[Custom WikiStyles]]). <:vspace> -< '''Tip:''' Use custom style definitions to associate meanings with text instead of just colors. For example, if warnings are to be displayed as green text, set [@%define=warn green%@] and then use [@%warn%@] instead of [@%green%@] in the document. Then, if you later decide that warnings should be styled differently, it's much easier to change the (one) definition than many occurrences of [@%green%@] in the text. <:vspace> -< '''Tip:''' Any undefined WikiStyle is automatically treated as a request for a class, thus [@%pre%@] is the same as saying [@%class=pre%@]. <:vspace> !![[#predefined]] Predefined style shortcuts <:vspace> PmWiki defines a number of style shortcuts. <:vspace> * Text colors: %black%black%%, %white bgcolor=black%white%%, %red%red%%, %yellow%yellow%%, %blue%blue%%, %gray%gray%%, %silver%silver%%, %maroon%maroon%%, %green%green%%, %navy%navy%%, %purple%purple%% (shortcut for [@%color=...%@]) * Justification: [@%center%@] and [@%right%@] * Images and boxes ** Floating left or right: [@%rfloat%@] and [@%lfloat%@] ** Framed items: [@%frame%@], [@%rframe%@], and [@%lframe%@] ** Thumbnail sizing: [@%thumb%@] * Open link in new window: [@%newwin%@] (shortcut for [@%target=_blank%@]) * Comments: [@%comment%@] (shortcut for [@%display=none%@]) * Ordered lists: [@%decimal%@], [@%roman%@], [@%ROMAN%@], [@%alpha%@], [@%ALPHA%@] (see also Cookbook:OutlineLists) <:vspace> <:vspace> [[#Styles]] !! Enabling Styles Styles not listed above can be enabled by a PmWiki Administrator by modifying the local/config.php file. For instance to enable the "line-height" style attribute add the line <:vspace> ->$WikiStyleCSS[] = 'line-height'; <:vspace> to the local/config.php file. <:vspace> <:vspace> [[#WikiStyleApply]] !! Defining scope for other HTML elements You can add additional HTML elements to [@$WikiStyleApply@] to apply WikiStyles to other HTML elements. For example to allow styling on table rows, or anchor tags. <:vspace> To apply styling to anchor tags, place in config.php: ->[@ $WikiStyleApply['link'] = 'a'; @] <:vspace> Then, you can apply a class or style to an anchor link: (:markup class=horiz:) %apply=link red%[[PmWiki.WikiStyles | test link]] (:markupend:) <:vspace> Or, to apply an ID attribute to a table row TR, place in config.php: ->[@ $WikiStyleApply['row'] = 'tr'; @] <:vspace> Then, in an advanced table, you can have: ->[@ (:cellnr:) %apply=row id=myid bgcolor=pink% cell content @] <:vspace> And also in a simple table: ->[@ || border=1 || %apply=row id=myrowid% 1 || 2 || 3 || 4 || @] <:vspace> Note, the [=%apply=row...%=] WikiStyle should be on the same line as [@(:cellnr:)@]. <:vspace> <:vspace> [[#Examples]] !! Examples <:vspace> [[WikiStyle Examples]] contains a number of examples of ways to use WikiStyles in pages. <:vspace> [[#KnownIssues]] !! Known Issues * Percents in style definitions (like: [@%block width=50% %@]) require the use of "pct" instead of "%". PmWiki will convert the "pct" into "%" so that it becomes valid CSS. * If you specify multiple values for an attribute, like @@border="2px solid blue"@@ make sure you place the values in quotes. * Be sure to use lowercase letters for red-green-blue hex colors, [@%color=#aa3333%@] will work, [@%color=#AA3333%@] may not. <:vspace> [[#SeeAlso]] !!See Also * [[PmWiki/Custom WikiStyles]] {PmWiki/CustomWikiStyles$:Summary} * [[PmWiki:List Styles]] {PmWiki/ListStyles$:Summary} * [[Cookbook:WikiStylesPlus | WikiStylesPlus]] {Cookbook.WikiStylesPlus$:Summary}(:groupfooter:) <:block>