Contents
Wiki Styles allow authors to modify the color and other styling attributes of the contents of a page.
A Wiki Style? is written using percent-signs, as in %red% or %bgcolor=lightblue%.
Wiki Styles, as written in the wiki page, are not exactly CSS styles or CSS classes. Wiki Styles 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.
Note that Pm Wiki allows advanced authors to use of class= and style= in tables and division blocks, but these are raw HTML attributes, and not Wiki Styles, knowledge of CSS is required to use them.
The most basic use of Wiki Styles is to change text attributes such as color, background color, and font. Pm Wiki defines several Wiki Styles for changing the text color to %black%, %white%, %red%, %yellow%, %blue%, %gray%, %silver%, %maroon%, %green%, %navy%, and %purple%.
The basket contains %red% apples, %blue% blueberries, %purple% eggplant, %green% limes, %% and more. | The basket contains apples, blueberries, eggplant, limes, and more. |
For colors other than the predefined colors, use the %color=...% Wiki Style?. (Note: RGB colors (#rrggbb) should always be specified with lowercase letters to avoid WikiWord conflicts.)
I'd like to have some %color=#ff7f00% tangerines%%, too! | I'd like to have some tangerines, too! |
To change the background color, use %bgcolor=...% as a Wiki Style?:
This sentence contains %bgcolor=green yellow% yellow text on a green background. | This sentence contains yellow text on a green background. |
See WikiStyle Colors for more color help.
Wiki Styles are used to control the text justification
%center% This text is centered. %right% Right justified. | This text is centered. Right justified. |
and to create floating text:
%rfloat% This text floats to the right %rframe% floats to the right with a frame Lorem ipsum dolor sit amet, consectetuer sadipscing elitr | This text floats to the right floats to the right with a frame Lorem ipsum dolor sit amet, consectetuer sadipscing elitr |
Wiki Styles can also specify a scope; with no scope, the style is applied to any text that follows up to the next Wiki Style? specification or the end of the paragraph, whichever comes first. The apply= attribute and its shortcuts allow to change the scope as follows:
| apply attribute | shortcut | style applies to... |
|---|---|---|
%apply=img ...% | - | any image that follows |
%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. |
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%.
Some predefined style shortcuts also make use of apply, thus %right% is a shortcut for %text-align=right apply=block%.
Example: Apply a style to a paragraph:
%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. |
The Wiki Style? specification at the beginning of this line applies to the entire paragraph, even if there are other Wiki Style? specifications in the middle of the paragraph. |
Caveat: An applied Wiki Style? will only take effect if it's on the line that starts the thing it's supposed to modify. In other words, a Wiki Style? in the third markup line of a paragraph can't change the attributes of the paragraph:
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. | after the first line of the paragraph, we try to change color. This does't work because the style comes after the first line of the paragraph. |
However, this %apply=p color=red% paragraph ''will'' be in red because its block style does occur in the first line of its text. | However, this paragraph will be in red because its block style does occur in the first line of its text. |
* Here's a list item * %list red% Oops, too late to affect the list! |
|
The >>WikiStyle<< block can be used to apply a Wiki Style? to a large block of items.
The style is applied until the next >><< is encountered.
>>blue font-style:italic
bgcolor=#ffffcc<<
Everything after the above line is
styled with blue italic text,
This includes
preformatted %red%text%%
* lists
-> indented items
>><<
| Everything after the above line is styled with blue italic text, This includes preformatted text
indented items
|
Note, the (:div style="..." class="...":) directive does not work the same way as >>WikiStyke<<, it can only contain the regular HTML style and class attributes.
Wiki Styles are only the commands between %...% percent signs.
Tables, table directives and (:div:) division blocks allow advanced authors to incorporate the HTML/CSS attributes class= and style=. Note that these attributes are not Wiki Styles, knowledge of CSS is required to use them.
(: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,
This includes
preformatted text
* lists
-> indented items
(:tableend:)
|
|
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.
The define= attribute can be used to assign a shorthand name to any Wiki Style? specification.
This shorthand name can then be reused in later Wiki Style? specifications.
%define=box block bgcolor=#ddddff border="2px dotted blue"% %box% [@some sort of text@] %box font-weight=bold color=green% [@some sort of text@] | |
%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.
%pre% is the same as saying %class=pre%.
Pm Wiki defines a number of style shortcuts.
%color=...%)
%center% and %right%
%rfloat% and %lfloat%
%frame%, %rframe%, and %lframe%
%thumb%
%newwin% (shortcut for %target=_blank%)
%comment% (shortcut for %display=none%)
%decimal%, %roman%, %ROMAN%, %alpha%, %ALPHA% (see also Cookbook:OutlineLists)
The style attributes recognized within a Wiki Style? specification are:
------------ CSS ------------- --HTML--
color bgcolor class
background-color margin id
text-align padding hspace
text-decoration border vspace
font-size float target
font-family list-style rel
font-weight width* accesskey
font-style height* value
display
Special: define, apply
The attributes in the first two columns correspond to the cascading style sheet (CSS) properties of the same name. The attributes in the last column apply only to specific items:
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
Styles not listed above can be enabled by a Pm Wiki Administrator by modifying the local/config.php file. For instance to enable the "line-height" style attribute add the line
to the local/config.php file.
You can add additional HTML elements to $WikiStyleApply to apply Wiki Styles to other HTML elements. For example to allow styling on table rows, or anchor tags.
To apply styling to anchor tags, place in config.php:
$WikiStyleApply['link'] = 'a';
Then, you can apply a class or style to an anchor link:
%apply=link red%[[PmWiki.WikiStyles | test link]] |
Or, to apply an ID attribute to a table row TR, place in config.php:
$WikiStyleApply['row'] = 'tr';
Then, in an advanced table, you can have:
(:cellnr:) %apply=row id=myid bgcolor=pink% cell content
And also in a simple table:
|| border=1 || %apply=row id=myrowid% 1 || 2 || 3 || 4 ||
Note, the %apply=row...% Wiki Style? should be on the same line as (:cellnr:).
WikiStyle Examples contains a number of examples of ways to use Wiki Styles in pages.
%block width=50% %) require the use of "pct" instead of "%".
border="2px solid blue" make sure you place the values in quotes.
%color=#aa3333% will work, %color=#AA3333% may not.