DokuWiki permet d'écrire des greffons et thèmes très flexibles en les rendant hautement configurables.

Pour rendre un greffon configurable, vous devez fournir un fichier lib/plugins/<plugin>/conf/default.php qui contiendra les paramètres par défaut et un fichier lib/plugins/<plugin>/conf/metadata.php qui contient la description Méta-données_de_configuration qui est utilisée par le Gestionnaire de configuration pour gérer/afficher les options¹⁾.

$conf[<setting>] = <value>;

Pour chaque paramètre dans lib/plugins/<votre plugin>/conf/default.php, il devrait y avoir une valeur $meta[<setting>] définie dans lib/plugins/<votre plugin>/conf/metadata.php²⁾ :

$meta[<setting>] = array(<setting class>, <param name> => <param value>);

Si aucun paramètre n'est requis pour une classe de réglage (voir ci-dessous), c'est tout simplement :

$meta[<setting>] = array(<setting class>);

Exemples:

$meta['_basic']     = array('fieldset');
$meta['title']      = array('string');
$meta['lang']       = array('dirchoice','_dir' => DOKU_INC.'inc/lang/');
$meta['dmode']      = array('numeric','_pattern' => '/0[0-7]{3,4}/'); // n'accepte qu'une représentation octale
$meta['allowdebug'] = array('onoff');
$meta['passcrypt']  = array('multichoice','_choices' => array('smd5','md5','sha1','ssha','crypt','mysql','my411'));

Let's say initially a plugin uses the syntax:

$meta['multi'] = array('multicheckbox', '_choices' => array('a','b','c','d'));

this means the multicheckbox will show four choices plus a string input.

Let's suppose also that the user inserts one or more extra values not in _choices.

In the next release of the plugin the author's plugin decides to use the multicheckbox without the extra string, but, in order to be backwardly compatible, adopts:

$meta['multi'] = array('multicheckbox', '_other' => 'exists', '_choices' => array('a','b','c','d'));

which means:

• if the user has inserted comma separated values, they will be printed in the extra string;
• otherwise the extra string won't show.

Note also that if the user inserts comma separated values which already exist (or some of them) in _choices but:

• they are already ticked, then the extra string will be removed and nothing else;
• they are not already ticked, then the extra string will be removed and the relative value will be ticked.

Inside inc/init.php the configurations settings are read into a global array $conf[]. When no settings were set, these are read from the default settings file. You can access the core settings anywhere by using the $conf[] array.

$startpage = $conf['start'];

You can access settings in plugins by using the $this->getConf('<setting>') method. In your plugin class you use:

$keyvalue = $this->getConf('key');

In templates you can use tpl_getConf('<setting>').

$nicetoknow = tpl_getConf('special');

For every setting in lib/plugins/<your plugin>/conf/default.php there can be a $lang[<setting>] value defined in lib/plugins/<your plugin>/lang/en/settings.php. This value will be displayed as the label of the setting in the configuration manager. If the label file is left out or doesn't contain a value for the setting, the configuration manager will display “plugin <plugin name> <setting>” as the label instead.

You can also create a settings.php file for other languages.

Again, this also applies to templates (see localization for further details).