WikiRenderer

english

Utilisation de Wikirenderer 3.1

Dernière mise à jour le 20/06/2009

Utilisation simple

 include('WikiRenderer.lib.php');
 $wkr = new WikiRenderer();
 $monTexteXHTML = $wkr->render($monTexteWiki);

Par défaut, cela utilise la règle wr3_to_xhtml. Si vous voulez utilisez d'autres règles :

 include('WikiRenderer.lib.php');
  include('rules/dokuwiki_to_xhtml.php');

  $wkr = new WikiRenderer('dokuwiki_to_xhtml');
  $monTexteXHTML = $wkr->render($monTexteWiki);

Ou si vous voulez changer des choses dans la configuration de la règle utilisée :

 include('WikiRenderer.lib.php');
  include('rules/classicwr_to_xhtml.php');
  $config = new classicwr_to_xhtml();

  $config->simpletags = array('%%%'=>'
',
        ':-)'=>'<img src="laugh.png" alt=":-)" />',
        ':-('=>'<img src="sad.png" alt=":-(" />'
        );

  $wkr = new WikiRenderer($config);
  $monTexteXHTML = $wkr->render($monTexteWiki);

Connaître les erreurs

Il est possible de savoir si lors de la transformation, WikiRenderer a rencontré des erreurs (balises wikis malformée, imbriquée...). Il suffit, aprés la transformation, de regarder le contenu de la propriété errors. Exemple :

include('WikiRenderer.lib.php');
$wkr = new WikiRenderer();
$monTexteXHTML = $wkr->render($monTexteWiki);

if($wkr->errors){
   echo '<p style="color:red;">Il y a des erreurs wiki aux lignes : ';
   echo implode(',',array_keys($wkr->errors)),'</p>' ;
}

La propriété errors est un tableau d'élements dont la clé est un numéro de ligne, et la valeur le contenu de la ligne en question. On peut donc si on le désire, afficher aussi les lignes en erreur.

WikiRenderer ne s'arrete pas à la première erreur rencontrée. Les tags wiki qui posent problèmes ne sont pas interpretés, ni enlevés dans le texte résultat.

Les paramètres de configuration

Ils sont situés dans un objet, héritant de la classe WikiRendererConfig, et qui doit avoir les propriétés suivantes :

inlinetags
liste des noms des classes qui prennent en charge les tags wiki que l'on peut utiliser à l'intérieur les phrases (tags "inlines"). Voir la partie configuration avançée.
bloctags
Liste des noms de classes des tags de type blocs. Voir la partie configuration avançée.
simpletags
tags simples pour lesquels il y a juste un remplacement à faire. C'est donc un tableau PHP d'élements 'chaine à remplacer'=>'chaine remplacante'.
checkWikiWordFunction
Indique le nom de la fonction qui sera appelée lorsque WikiRenderer détectera des mots wiki en "CamelCase". (laissez à null si vous ne voulez pas ce genre de détéction). Cette fonction devra récupérer en paramètre une liste de mots wiki, et devra renvoyé une liste des chaines qui remplaceront les mots wiki indiqués. Cette fonction est à implémenter par vous-même selon votre application. Voir la partie configuration avançée.

Autre documentations