Custom Wiki Styles

DocumentationToDo Update with most recent changes and make clearer for administrators.

This page describes the predefined WikiStyles and how a WikiAdministrator can define additional WikiStyles as a local customisation for all pages (in local/config.php) or specific groups (in local/$Group.php).

All predefined WikiStyles are setup in the global array $WikiStyle. To define your own WikiStyles, add the setting of the correspondent WikiStyle within the array.

Predefined WikiStyles

The following array-values are set by scripts/wikistyles.php using the SDV()-function (so you can overwrite them by setting them prior in config.php or farmconfig.php):

markup: definition:

text colors:
(equiv. to %color=xxxx define=xxxx%
%black% $WikiStyle['black']['color'] = 'black'
%white% $WikiStyle['white']['color'] = 'white'
%red% $WikiStyle['red']['color'] = 'red'
%yellow% $WikiStyle['yellow']['color'] = 'yellow'
%blue% $WikiStyle['blue']['color'] = 'blue'
%gray% $WikiStyle['gray']['color'] = 'gray'
%silver% $WikiStyle['silver']['color'] = 'silver'
%maroon% $WikiStyle['maroon']['color'] = 'maroon'
%green% $WikiStyle['green']['color'] = 'green'
%navy% $WikiStyle['navy']['color'] = 'navy'
%purple% $WikiStyle['purple']['color'] = 'purple'

list-styles:
%decimal% $WikiStyle['decimal']['apply'] = 'list'
$WikiStyle['decimal']['list-style'] = 'decimal'
%roman% $WikiStyle['roman']['apply'] = 'list'
$WikiStyle['roman']['list-style'] = 'lower-roman'
%ROMAN% $WikiStyle['ROMAN']['apply'] = 'list'
$WikiStyle['ROMAN']['list-style'] = 'upper-roman'
%alpha% $WikiStyle['alpha']['apply'] = 'list'
$WikiStyle['alpha']['list-style'] = 'lower-alpha'
%ALPHA% $WikiStyle['ALPHA']['apply'] = 'list'
$WikiStyle['ALPHA']['list-style'] = 'upper-alpha'

special:
open links in a new browser-window:
%newwin% $WikiStyle['newwin']['target'] = '_blank'
turns markup into a comment via display:none css
%comment% $WikiStyle['comment']['display'] = 'none'

Defining your own WikiStyles

  1. The first index of the array defines the style-name (e.g. mynewstyle, projectentry etc)
  2. the second index defines the css-attribute-name (e.g. color, bgcolor etc)
    (??? please verify !!! -KAL)
  3. the value set defines the css-attribute-value (e.g. red, bold etc)

TODO: description of second index = "apply" or "class" - seems to be special ? -KAL

Sample: If you're wanting to define a (sitewide) style the same as the page style 

 %define=projectentry color:red%,

use 

  $WikiStyle['projectentry']['color'] = 'red';

If you're wanting to define a new style to be the same as %projectentry color=red%, use 

 
  $WikiStyle['mynewstyle']['class'] = 'projectentry';
  $WikiStyle['mynewstyle']['color'] = 'red';

To be done:

  • description of $WikiStyleApply and $WikiSTyleCSS arrays

We might need to introduce a or markup for this to style just the divs and not the enclosing <dl>'s. You can actually add this in a local customization by doing: 

 $WikiStyleApply['div'] = 'div';

or 

 $WikiStyleApply['indent'] = 'div';

  • v1 upgrade note: if you used to have 
 
  $WikiStyle['mynewstyle']['bgcolor'] = 'colorname';
you'll need to change it to 
 
  $WikiStyle['mynewstyle']['background-color'] = 'colorname';

<< Custom Markup | PmWiki.DocumentationIndex | WikiFarms >>