• Tutoriels
• Manuel 1.8
• 1.7
• 1.6
• 1.5
• 1.4
• 1.3
• 1.2
• 1.1
• 1.0
• 1.9-dev
• Référence API

Guide du développeur

• ^ Références
• ^ Les classes utilitaires
  • jApp : chemins de l'application
  • jDateTime : manipulation de dates et heures
  • jFile : lire ou créer des fichiers
  • jFilter : vérification et filtrage de données
  • jImageModifier: Modifier une image
  • jMailer : envoi de mails
  • jMessage : informations entre actions
  • jSession : stockage de sessions
  • jWiki : transformation de texte wiki

Jelix 1.8.1

Section: jWiki : transformation de texte wiki

« jSession : stockage de sessions

^ Les classes utilitaires

Changer de langue : EN

jWiki est une classe permettant de transformer un texte wiki dans un autre format, XHTML par exemple. Cette classe repose sur la classe Wikirenderer version 3.1.

Pour que Wikirenderer puisse réaliser la transformation, il lui faut donner un ensemble d'objets précis, qui ensemble vont régir les rêgles de transformation.

Un certain nombre d'ensemble de règles sont fournies (voir lib/wikirenderer/rules/), permettant par exemple de transformer du code wiki "wr3" en XHTML. Il est possible d'imaginer des règles pour transformer du code dokuwiki en XHTML, ou encore du code mediawiki en docbook. Toutes les combinaisons sont possibles. Il suffit de fournir ou développer ces règles.

Pour utiliser jWiki, il faut l'instancier en indiquant le nom d'un ensemble de rêgles. Par exemple pour transformer du code wiki "wr3" en XHTML, il y a les règles wr3_to_xhtml, on fera donc :

   $wr = new jWiki('wr3_to_xhtml');
   $xhtml = $wr->render($texte_wiki);

Les règles par défaut sont dans lib/wikirenderer/rules, mais vous pouvez ajouter les vôtres dans votre application, par exemple dans votre_appli/plugins/wr_rules/. Bien sûr, il faut déclarer le dépôt de plugins votre_appli/plugins dans la configuration de Jelix.

À la différence des rules livrées avec wikirenderer, celles que vous mettez dans votre_appli/plugins/wr_rules/ doivent être chacune dans son propre répertoire, comme pour tout plugin Jelix. Si par exemple votre règle se nomme "superwiki_to_xhtml", alors son code source doit se trouver dans votre_appli/plugins/wr_rules/superwiki_to_xhtml/superwiki_to_xhtml.rule.php, avec dedans une classe nommé superwiki_to_xhtml qui hérite de WikiRendererConfig ou de la classe d'une règle existante.

Pour plus d'informations sur l'utilisation de jWiki, voir la documentation de Wikirenderer.