Code-Web.org - plugin

La dernière ligne droite pour Dotclear 2?

Thierry Geindre — Sat, 05 Jul 2008 17:23:00 +0200

Dotclear 2 vient de sortir en version RC2.1 et offre quelques améliorations qui sont détaillées dans le billet annonçant sa sortie. On y apprend également qu'il s'agit très probablement de la dernière release avant la sortie de la version finale maintenue pour cet été.

Pour ma part j'ai vérifié la compatibilité des plugins que je maintiens avec cette nouvelle version. J'annonce donc que BashFr Quote, WikiText, SyntaxeHl et DotPoll fonctionnent très bien sur le blog de test de Code-web.org.

En revanche, l'interface de Langomatic disparaît lorsque l'on essais de créer une traduction d'un plugin. Je me suis proposé pour assurer la mise en conformité de ce plugin avec le futures versions de Dotclear et je vais donc étudier le problème... A suivre.

Comme toujours, vous pouvez retrouver tous ces plugins sur le dépôt de Code-web.org ou sur Dotaddict. Si vous rencontrez des problèmes avec l'un de ces plugins, n'hésitez pas à me les remonter dans les billets appropriés ou même ici.

LangOmatic compatible Dotclear 2 RC1

Thierry Geindre — Tue, 20 May 2008 22:56:00 +0200

Voilà déjà un moment que certains d'entre nous, développeurs de plugin sous Dotclear, utilisent le plugin langOmatic pour la traduction de leur développements. Malheureusement, ce plugin n'était plus maintenu par son auteur original et la compatibilité avec les nouvelles versions de Dotclear 2 devenait de plus en plus mauvaise...

C'est un problème de licence qui m'empêchait jusqu'alors de le mettre en conformité avec le nouveau Dotclear. En effet, et comme il me l'avait justement été signalé par Moe, l'absence de licence ne signifie pas libre selon le droit français. En principe donc, impossible de mettre à jour ce plugin légalement.

J'ai donc pris la liberté de contacter son auteur, qui a accepté que je poursuive le développement de ce plugin et le publie sous licence GNU GPL. Son seul souhait est : ...j'aimerais que tu gardes le nom Pas de soucis, c'est bien noté!

Voici donc le plugin langOmatic enfin compatible avec Dotclear 2 RC 1. En cas de problème, n'hésitez pas à profiter des commentaires de ce billet pour me les signaler. Je précise en passant que je ne reprend que les mises à jour visant à rendre le plugin compatible avec les futures version de Dotclear. Pour de nouvelles fonctionnalités, il faudra voir avec quelqu'un d'autre.

Dotpoll : Plugin de sondage pour Dotclear 2

Thierry Geindre — Fri, 09 May 2008 15:21:00 +0200

Après quelques heures de travail voici enfin la première version de Dotpoll, un plugin permettant de créer des sondages sur votre blog. Pour l'heure, ces sondages ne peuvent être affichés que dans des widget, autant que vous le souhaitez.

Il reste quelques petites choses à faire en priorité :

Ajouter des messages de confirmation lors de suppressions
Permettre de choisir l'ordre d'affichage des différents choix d'un sondage
Vérifier que toutes les éventuelles erreurs sont bien catchées
Vérifier les traductions anglaises

Pour la suite :

Des barres de progression pour les résultats des sondages
Pouvoir afficher les sondages n'importe où (billet, page dédiée, etc.)
Si vous avez d'autres idées, n'hésitez pas...

Installer Dotpoll

Évidemment, ce plugin s'installe comme n'importe quel autre plugin pour Dotclear 2. Choisissez simplement le paquet qui vous convient.

Il a été testé avec les version RC 1 et Beta 7 de Dotclear sans aucun problème.

Utiliser Dotpoll

Créer / modifier un sondage

Il vous suffit de vous rendre sur l'onglet Nouveau sondage de DotPoll. Vous pourrez alors choisir le titre (ou la question) de votre sondage. Validez. Vous arriverez ensuite dans l'interface de modification de votre sondage. Pour y ajouter des choix, rendez-vous sur l'onglet Nouveau choix, entrez le texte de votre nouveau choix puis validez. Vous pourrez ainsi ajouter autant de choix que vous le souhaitez.

Votre sondage est maintenant créé. Pour pouvoir l'afficher sur votre blog, vous devrez vous assurer qu'il est publié. Par défaut, les nouveaux sondages ne sont pas publiés. Pour publier un sondage, rendez vous dans la liste des sondages (onglet Mes sondages sur l'interface de DotPoll) puis cochez la case correspondant au sondage que vous venez de créer. En bas de la liste, sélectionnez Publier puis cliquez sur Ok.

Votre sondage est désormais opérationnel.

Afficher un sondage dans un widget

Rendez-vous sur l'interface de gestion de vos widget. Un nouveau widget est désormais disponible : DotPoll. Ajoutez ce widget à la liste de votre choix. Les options disponibles sont assez explicites pour ne pas mériter d'explications. Sachez simplement que la liste des sondages proposée ne contient que les sondages publiés.

A propos de la configuration

La seule chose qu'il est possible de configurer dans DotPoll est la manière dont les votant seront identifiés. Soit par Cookie, soit par leur adresse IP. Les deux méthodes présentant toutes deux leurs avantages et leurs inconvénients, ce choix est laissé à l'utilisateur.

Un aperçu ?

Vous pouvez voir DotPoll en action sur cette page, et même sur l'ensemble du blog, dans la partie droite. Profitez-en pour répondre au sondage!

Licence

DotPoll est désormais sous licence GNU GPL.

Dotclear 2 RC disponible

Thierry Geindre — Sat, 03 May 2008 15:32:00 +0200

C'est maintenant chose faite, la version RC de Dotclear 2 est disponible en téléchargement sur le site officiel.

Pour ma part, cela signifie quelques test des plugin que je maintiens pour vérifier leur compatibilité avec cette nouvelle version. N'hésitez pas à me remonter d'éventuels problèmes.

Résultat des courses

Les widgets BashFr Quote et WikiText semblent fonctionner à merveille. Rien à signaler de ce côté là.

En revanche, l'archive zip de SyntaxeHl semble ne pas fonctionner pour l'installation automatisée comme il me l'avait déjà été signalé dans un commentaire. Je vais essayer de trouver la source du problème. En attendant, pour installer ce plugin, vous pouvez décompresser l'archive zip du plugin et l'uploader via votre client FTP dans le répertoire plugin de votre dotclear.

Maj

Le problème de l'archive de SyntaxeHl est désormais réglé. Apparemment c'est un fichier vide contenu dans la liste des langages proposé par GeShi qui posait problème. J'avoue ne pas vraiment comprendre. Bref, j'ai mis à jour la dernière archive zip disponible pour SyntaxeHl donc tous les liens d'installation donnés jusque là sont bons.

SyntaxeHl 1.1

Thierry Geindre — Mon, 14 Apr 2008 10:08:00 +0200

Nouvelle version du plugin SyntaxeHl pour Dotclear 2. Il est désormais possible de le configurer via l'interface de configuration de votre blog. Par ailleurs, cette nouvelle version corrige une petite erreur de programmation qui pouvait lancer des warning sous certaines installations.

Mise à jour & installation

SyntaxeHl s'installe comme n'importe quel autre plugin, voyez la documentation officielle. Pour la mise à jour, et bien qu'en principe l'installation d'une nouvelle version écrase l'ancienne, je préconise tout de même de désinstaller l'ancienne version avant d'installer la nouvelle.

Téléchargement

Vous trouverez sur le dépôt de plugins de code-web.org la dernière version de SyntaxeHl en package zip, tar.gz et pkg.gz.

Configuration du plugin

Rendez-vous sur le tableau de bord, puis dans les paramètres de votre blog. Vous trouverez, sur cette page, une partie dédiées à la configuration de SyntaxeHl. Les options disponibles sont les suivantes :

Class CSS commune : définit une class CSS qui sera appliquée à tous les bloc <pre> en plus de la class spécifique au langage.
Activer les liens sur les mots clés : active les liens sur les mots clés du langage mis en forme. Pour du PHP par exemple, les liens vers la documentation officielle seront placés sur les fonctions.
Activer la numérotation des lignes : active la numérotation des lignes de codes qui seront mises en formes.

Comme je l'ai déjà indiqué, ce plugin n'est pas rétro actif. Par conséquent, les modifications de configuration du plugin n'interviendront que sur les billets modifiés ou créés par la suite.

Pour toute remarques, suggestions ou problèmes, n'hésitez pas à poser votre question dans les commentaires.

Licence

SyntaxeHl est désormais sous licence GNU GPL.

Plugin de coloration syntaxique

Thierry Geindre — Mon, 31 Mar 2008 14:14:00 +0000

La coloration syntaxique manquait sur Dotclear 2, je me suis donc lancé dans la réalisation d'un plugin remplissant cette fonction. A travers cette article, je vous propose de découvrir la création de plugin pour Dotclear 2.

Pour réaliser la coloration, nous utiliserons tout simplement GeShi, une classe qui remplit admirablement bien cette fonction. Il s'agit donc d'intégrer le travaille de cette classe à Dotclear sous la forme d'un plugin.

J'ai choisi de reprendre le nom de l'ancien plugin qui fournissait la coloration syntaxique ,SyntaxeHl pour syntaxe highlight je présume.

Un répertoire avec GeShi pour le plugin

La première étape, très simple, consiste à créer un répertoire pour accueillir les fichiers de votre plugin. Pour cela, il suffit de créer un sous répertoire dans le répertoire plugins de votre Dotclear. Nommons le par exemple syntaxehl. Il vous faudra ensuite télécharger la dernière version de GeShi. Décompressez l'archive que vous venez de récupérer dans le répertoire que vous venez de créer. Ainsi vous devez obtenir un nouveau répertoire /plugins/syntaxehl/geshi/. Dans ce répertoire, vous pouvez supprimer les répertoires contrib et doc qui ne nous serons pas utile.

Informations relatives au plugin

Nous allons maintenant définir les différentes informations relatives à notre plugin. Pour cela, vous devez créer un fichier _define.php dans le répertoire /plugins/syntaxehl/. Le contenu de ce fichier sera le suivant :

<?php
$this->registerModule(
  /* Name */          "SyntaxeHl",
  /* Description*/    "Plugin de coloration syntaxique",
  /* Author */        "Votre Nom",
  /* Version */       '1',
  /* Permissions */   'usage,contentadmin'
);
?>

Les commentaires accompagnant chacun des paramètres sont suffisamment clair pour comprendre de quoi il s'agit. Nous ne nous arrêterons que sur le champ concernant les permissions. Il s'agit ici de définir quel type d'utilisateur peut activer le plugin. Dans cet exemple, nous avons choisit d'autoriser tous les utilisateurs mais on aurait également pu se limiter aux administrateurs en indiquant seulement admin.

Enregistrez les modifications puis rendez vous sur la page listant les plugin installés sur votre blog. Vous constaterez avec joie que le plugin que vous venez de créer apparaît bien dans la liste. Pour l'instant, ce plugin est totalement inutile puisqu'il ne fait absolument rien. Nous allons donc lui ajouter ses fonctionnalités.

Intercepter le code à mettre en forme

Pour mettre en forme le code inséré dans un billet, j'ai choisi d'exploiter la classe wiki2xhtml qui est employée, comme son nom l'indique, pour transformer la syntaxe Wiki d'un billet en (X)HTML.Ce choix peut être discutable puisqu'il ne permet pas de mettre en forme du code inséré dans un billet écrit directement en HTML.Cela-dit, je part du principe qu'un billet écrit en HTML directement ne devrait pas faire l'objet de modifications par un plugin puisqu'en principe il est déjà écrit dans sa version finale.

Pour mettre en forme les codes sources, nous allons exploiter une des fonctionnalités offertes par wiki2xhtml : les macros. Pour cela, nous utiliserons la fonction registerFunction de wiki2xhtml qui attend deux paramètres : le type de fonction que l'on souhaite enregistrer et la fonction en question. Pour le type, on indiquera simplement macro:nom_de_la_macro. Le fait d'enregistrer une fonction en tant que macro va déclencher l'appel à notre fonction lorsque la classe rencontrera dans le contenu du billet le texte suivant :

///nom_de_la_macro
du texte
///

Ici, notre fonction recevra du texte en paramètre, il nous suffira alors d'effectuer toutes les modifications souhaitées puis de retourner la version modifié du texte pour qu'elle remplace l'originale.

Enregistrer notre macro pour wiki2xhtml

Nous n'avons pour le moment qu'un bout de la solution finale. En effet, même si on sait comment procéder pour obtenir le code à mettre en forme, on ne sait pas vraiment comment procéder pour enregistrer notre fonction auprès de la classe wiki2xhtml aux bons moments.

Le système des behavior

Depuis la version 2, Dotclear intègre un tout nouveau système : les behavior. Terme qui peut être traduit littéralement par comportement. C'est un système très simple à utiliser qui propose une gestion événementielle. En fait, un plugin peut enregistrer une fonction pour tel ou tel événement. Lorsque cet événement se produit, Dotclear appel la ou les fonctions qui ont été enregistrées pour cet événement. En plus, ces fonctions recevront un certain nombre de paramètres différents en fonction du behavior concerné.

Parmi la liste des behavior diponibles, on trouve coreWikiPostInit qui est appelé lors de l'initialisation de la classe wiki2xhtml. La fonction qui sera enregistrée pour cette événement recevra une référence vers l'instance de wiki2xhtml en paramètre. Il sera donc très facile d'y enregistrer notre macro.

Quelques fichiers

Nous avons toutes les solutions en main pour la création de notre plugin. Nous allons maintenant pouvoir entamer le codage. Il faudra bien sur placer notre code dans certains fichiers. Comme vous pouvez l'imaginer, le fait de créer un fichier nommé n'importe comment ne sera pas forcément pris en compte par Dotclear. Le nommage est important pour le bon fonctionnement de notre plugin.

Ce qui va déterminer le nom du fichier que nous allons utiliser, c'est la partie de Dotclear dans laquelle on souhaite agir, la partie publique ou la partie administration. Pour agir sur la partie publique, on créera un fichier nommé _public.php ou alors un fichier _admin.php pour agir dans la partie administration.

Pour notre pugin, c'est dans la partie admin que nous voulons agir. En effet, les billets rédigés en syntaxe Wiki sont transformés en (X)HTML dans la partie administration. Nous allons donc créer un fichier _admin.php dans le répertoire /plugins/syntaxehl/.

Codage du plugin

Il ne nous reste maintenant plus qu'à coder notre plugin. Placez le code suivant dans le fichier _admin.php que nous venons de créer.

<?php
// Protège contre les accès directes au fichier
if (!defined('DC_CONTEXT_ADMIN')) exit;
 
// Require façon Dotclear
require(dirname(__FILE__).'/geshi/geshi.php');
 
// On enregistre notre behavior
$core->addBehavior('coreInitWikiPost',array('syntaxeHl','registerFunc'));
 
 
class syntaxeHl
{
        // Fonction correspondant à notre behavior
        public static function registerFunc(&$wiki2xhtml)
        {
                // On lit de répertoire de GeShi pour connaître
                // la liste des langages diponibles
                $dir = dirname(__FILE__).'/geshi/geshi/';
                $od = opendir($dir);
                while($f = readdir($od))
                {
                        // Si c'est bien un fichier portant l'extension .php
                        if(is_file($dir.$f) && substr($f,-4,4)=='.php')
                        {
                                // On enregistre une nouvelle macro pour ce langage
                                $lang = str_replace('.php','',$f);
                                $wiki2xhtml->registerFunction('macro:['.$lang.']',array('syntaxeHl','parse'));
                        }
                }
        }
 
        // Fonction appelée par Wiki2Xhtml
        public static function parse($text,$args)
        {
                // On supprime les caractères blancs en
                // en début et fin de chaîne (optionnel)
                $text = trim($text);
 
                // Création d'une instance de GeShi
                $geshi =& new GeSHi($text,$args);
 
                // On désactive les liens sur les mots clés (optionnel)
                $geshi->enable_keyword_links(false);
 
                // On retourne le code mis en forme, coloré
                return $geshi->parse_code();
        }
}
?>

Ayant déjà bien expliqué les solutions employées ci-dessus, je ne m'attarderais pas sur ce code. Vous pouvez consulter la documentation de Dotclear pour en savoir plus sur les méthodes utilisées.

Notez simplement que l'on utilise pas directement le nom du langage pour nommer nos macro, mais qu'on le place entre crochets ([ et ]). Il y a deux raisons à cela, d'une part le plugin qui assurait la coloration syntaxique pour Dotclear 1 utilisait lui aussi les crochets (rétro compatibilité) et d'autre part cela permet de ne pas interférer avec d'autres macros comme html par exemple qui permet d'insérer du code html dans un billet lorsqu'on est en syntaxe Wiki.

Un test ?

Si vous avez correctement suivit cet article, votre plugin est maintenant fonctionnel. Vous pouvez le tester en créant un nouveau billet et en insérant le code suivant (en syntaxe Wiki):

///[php]
<?php
  echo 'Hello world!';
?>
///

et vous obtiendrez normalement le résultat suivant :

<?php
  echo 'Hello world!';
?>

Vous remarquerez peut-être que ce plugin n'est pas rétro actif, c'est à dire que les anciens billets contenant du code sources ne seront pas colorés. Pour chacun d'entre eux, il vous faudra les éditer et enregistrer les modifications.

Packager votre plugin

Maintenant que votre plugin fonctionne, il pourrait être intéressant de le distribuer. Le meilleur moyen pour cela est de créer un package. Le moyen le plus simple est d'utiliser le plugin Packager dont c'est la seule et unique fonction.

Version finale

Pour ceux qui souhaitent simplement installer ce plugin sur leur blog, vous pouvez consulter le dépôt de plugin de Code-Web.org où vous trouverez les paquets directement installables sur Dotclear. Si vous avez des questions qui concernent ce plugin, rendez-vous sur le billet traitant de la dernière version disponible.