Bricoland Drive - Yet Another Dotclear DIY Primer

Plugin Related : première béta pour la version 1.0

2008-06-01T15:45:00+02:00

Oui. Vous avez bien lu : il est temps pour moi d'assumer une version 1.0 pour ce bon vieux Related Pages.
Il faut dire que le risque est mésuré : ce plugin a déjà eu l'occasion de faire ses preuves, au fil des version antérieures.

C'est d'ailleurs pour cette raison que je vais faire court.

Quels sont les changements ?

En apparence, il n'y en a quasiment aucun. :-)

Tout au plus un ou deux éléments qui changent de style. L'utilisation reste donc parfaitement identique, malgré un ré-aménagement de certaines portions du code.

La grande nouveauté est l'apparition de la prise en charge des marqueurs de templates Dotclear2, au sein des fichiers XHTML que l'on peut inclure dans les pages. En effet, désormais si vous choisissez d'inclure un fichier .html, les éventuelles balises {{tpl:xxx}} ou <tpl:xxx> seront transmises au moteur de templates de Dotclear2 et transformées en conséquence.

J'ai néanmoins glissé une petite restriction là au milieu : au moment du passage par le moteur de templates, seul le chemin du dépôt des pages du plugin sera scanné pour la recherche d'un fichier template. Cela signifie qu'en cas d'appel à {{tpl:include}}, le fichier désiré devra également être situé dans le dépôt.^[1]

Et ça se récupère où ?

Pour l'instant, essentiellement par là : archive ZIP (24 Ko).

Je ne mettrai pas le lien en page d'accueil, ni le plugin en téléchargement sur dotaddict.org, avant une première tournée de tests, et sans doute la version beta suivante.

Comme l'ensemble des nouveaux plugins ou nouvelles versions de plugins existants que je diffuse, seule la compatibilité avec Dotclear 2.0 RC1 ou plus est garantie.

Notes

[1] Il va de soi que si, à l'usage, cette restriction s'avère trop gênante, j'en reverrai le principe.

Nouveau plugin : YASH

2008-05-30T13:32:00+02:00

Qu'est ce donc ?

Une fois que vous saurez que ce nom un peu idiot signifie Yet Another Syntax Highlighter, vous vous douterez de ce que propose ce plugin. Il s'agit donc encore d'un plugin de colorisation syntaxique de fragments de code qui pourraient être glissés dans un billet.

Contrairement à certains de ses compères pour Dotclear2, YASH n'utilise pas GeSHi, ni n'opère la colorisation côté serveur. YASH est principalement un plugin permettant d'intégrer et d'utiliser facilement la librairie Javascript Syntax Highlighter, opérant la colorisation côté client.

Comment ça s'installe ?

L'installation et la configuration de YASH sont quasiment identiques à ce qui est nécessaire pour le plugin commentsWikibar : il suffit d'installer le plugin et d'aller l'activer via son interface d'administration. Il est également possible de contrôler un peu le rendu en fournissant une feuille de style personnalisée.

Quelles sont les possibilités ?

La version de la librairie Javascript Syntax Highlighter embarquée est une version 1.6, en provenance du SVN au 29/05/2008. L'ensemble des scripts core et brushes constitue le fichier yash.js, sous forme minifiée.

Il est donc possible d'avoir la colorisation pour les langages suivants :

XML, XSLT, XHTML et HTML,
CSS,
Javascript,
PHP,
SQL,
Python,
Ruby,
Java,
C++,
C#,
Delphi,
et Visual Basic^[1]

Comment l'utilise-t-on ?

Au moment de la rédaction, deux solutions s'offrent à vous. Si vous êtes un adepte du clavier, vous pouvez avoir recours directement à la macro wiki yash.

Vous l'utiliserez de la sorte :

///yash php
<?php
echo 'Hello Wordl !';
?>
///

Vous indiquez donc le langage en guise de paramètre lors de l'appel de la macro. Pour la saisie en XHTML, vous devrez insérer des blocs sous la forme :

<pre class="brush: html">
...
</pre>

Mais si vous êtes plutôt un adepte du clic, le plugin ajoute également un bouton^[2] dans la barre de mise en forme de l'éditeur Dotclear.

Et à part ça ?

Rien. J'ai fini. Ou presque.

Les derniers détails scabreux :

Il s'agit d'une version beta, mais je pense (j'espère) qu'elle ne devrait pas poser de problèmes particuliers.
Le plugin nécessite Dotclear2 RC1, évidemment, mais également un thème tirant pleinement partie des behaviors de présentation.
L'archive ZIP (23 Ko) est disponible ici-même et le sera bientôt via plugins.dotaddict.org.

Notes

[1] Ouaip ... Je l'ai laissé. :-p

[2] Une baguette magique, si, si !

Plugin Related sauvé des eaux : suite à prévoir

2008-05-12T20:41:00+02:00

Contrairement à ce que j'envisageais dans un premier temps, le plugin Related Pages (aka Related tout court) ne partira pas vraiment en retraite.

Voici donc le programme actuellement envisagé :

Dans un tout premier temps, Related Pages va s'assurer d'être parfaitement compatible avec Dotclear 2 RC1 et plus particulièrement le plugin officiel Pages. Il s'agit principalement de supprimer un effet de bord au niveau des URLs présent lors de l'utilisation conjointe de ces deux plugins, et de passer le template par défaut au goût du jour. C'est aujourd'hui chose faite : une version 0.3.12 est disponible au moment même où j'écris ces lignes. Le ZIP est en téléchargement directement ici, ou par l'intermédiaire de plugins.dotaddict.org.
Dans les jours qui viennent, Related Pages passera dans une phase 0.4.x qui apportera comme principale nouveauté la possibilité d'avoir des balises templates au sein des fichiers HTML inclus. Elle se caractérisera également par une adoption plus complète des nouveaux mécanismes de Dotclear 2 RC1 concernant la gestion du post_type. Après un premier gros tour de chauffe, en fonction des retours utilisateurs, cette branche 0.4.x donnera probablement naissance à la première version 1.x de ce plugin.
A compter de la disponibilité de Related Pages 0.4, un nouveau plugin includedPages commencera à montrer son nez, reprenant seulement la partie pages incluses de Related Pages. Lors de son installation, includedPages convertira les anciennes pages internes d'une installation de Related Pages vers les nouvelles pages Dotclear 2 RC1.

Pour faire (un peu) plus simple :

Si vous utilisiez déjà Related Pages pour des pages internes et des pages incluses, ne changez rien.^[1]
Si vous n'utilisez que des pages internes, le plus sage sera sans doute de migrer vers Pages.
Si vous avez commencé directement avec Pages et que le besoin d'inclure des pages HTML ou scripts PHP se présente plus tard, vous pourrez alors opter pour l'utilisation conjointe de Pages et du futur includedPages.

Comme vous le voyez, le choix vous reviendra. Et afin de vous guider, je m'efforcerai de publier une matrice de comparaison entre Related Pages, Pages et includedPages au moment de la prochaine annonce.

Notes

[1] Sauf si vous désirez permettre les commentaires sur les pages internes : dans ce cas, Pages vous intéressera plus que Related Pages.

A vot' bon coeur, m'sieurs, dames ...

2008-05-09T17:56:00+02:00

C'est nouveau, ça vient de sortir : il y a désormais un bouton PayPal pour faire un don au Bricoland Drive en page d'accueil.
Si, si !

Ne vous méprenez pas sur mes intentions, tout de même. Je ne me lance pas dans une opération de monétisation du blog. Tout comme il n'y aura jamais d'accès payant aux ressources du Bricoland Drive, ni bandeaux de publicité. Par contre, je ne voyais aucune raison de ne pas inviter aux dons.

Je ne m'attends évidemment pas à des sommes mirobolantes, mais si de temps à autre, il y a suffisamment pour quelques paquets de café et de filtres, ou l'achat d'un bon livre afin d'acquérir quelques compétences/connaissances supplémentaires, je serai déjà un homme heureux. J'ai d'ailleurs choisi de laisser le montant du don au bon vouloir des éventuels donateurs.

Et si vous pensez malgré tout que je suis en train de vendre mon âme au Grand Capitalisme, vous pouvez toujours m'insulter dans les commentaires de ce billet. :-)

Template personnalisé par catégorie

2008-04-29T16:46:00+02:00

Si vous avez un peu pris le temps de décortiquer les sources et les quelques documentations disponibles au sujet de Dotclear2, vous vous êtes sans doute aperçu que vous avez entre les mains un beau jeu de Lego. Si celui-ci peut sembler, de prime abord, complexe, avec un peu de pratique vous vous rendrez rapidement compte qu'il offre une grande souplesse à faible coût.

Pour illustrer ce propos, aujourd'hui, nous allons jouer un peu avec le rendu des pages de catégories.

Posons rapidement le problème : pour certaines catégories, nous souhaitons avoir des éléments en plus (ou en moins), et, pourquoi pas, un balisage HTML radicalement différent.

Par réflexe, nous serons tentés de chercher où glisser un bout de PHP au beau milieu de nos fichiers templates^[1], histoire de faire un test sur la (ou les) catégorie(s) devant bénéficier d'un traitement particulier. Nous nous rendrons vite compte que le PHP au sein des templates Dotclear2, bien que possible, n'est pas la panacée. Nous nous dirigerons donc vers un balisage template conditionnel à grand renfort de <tpl:*If*>.^[2] Voilà qui peut être très simple et amplement suffisant pour un nombre restreint de cas particuliers.

Figurez-vous que je vais vous proposer de lui rentrer dans le lard, à ce mécréant de Dotclear2. Nous allons le forcer à changer la façon dont il distribue le template (unique) de catégorie, histoire d'avoir les coudées franches une bonne fois pour toutes.

Pas la peine de vous inquiéter, c'est moins violent et intrusif que ça ne le paraît. Il nous suffira de redéfinir le gestionnaire d'URL en charge des catégories, par le nôtre, propre à notre nouveau thème.

L'intervention se limite alors à l'édition du fichier _public.php de notre thème, comme suit :

<?php
$core->url->register('category','category','^category/(.+)$',array('myURLHandlers','category'));
class myURLHandlers extends dcUrlHandlers
{
	public static function category($args)
	{
		$_ctx =& $GLOBALS['_ctx'];
		$core =& $GLOBALS['core'];
		
		$n = self::getPageNumber($args);
		
		if ($args == '' && !$n) {
			self::p404();
		}
		
		$params['cat_url'] = $args;
		$params['post_type'] = 'post';
		
		$_ctx->categories = $core->blog->getCategories($params);
		
		if ($_ctx->categories->isEmpty()) {
			self::p404();
		} else {
			if ($n) {
				$GLOBALS['_page_number'] = $n;
			}
			$tpl = 'category-'.$_ctx->categories->cat_id.'.html';
			if (!$core->tpl->getFilePath($tpl)) {
				$tpl = 'category.html';
			}
			self::serveDocument($tpl);
			exit;
		}
	}
}
?>

En y regardant de plus près, il apparaît clairement qu'il ne s'agit que d'une copie du gestionnaire par défaut, mais agrémentée du simple ajout de code suivant :

$tpl = 'category-'.$_ctx->categories->cat_id.'.html';
if (!$core->tpl->getFilePath($tpl)) {
	$tpl = 'category.html';
}

Ces quelques lignes suffisent à faire toute la différence :

Nous considèrons que le template à servir en priorité se nomme category-##.html, où ## représente l'identifiant numérique de la catégorie.
Nous nous assurons qu'un template de ce nom est bel et bien disponible auprès du moteur de template
Si ce n'est pas le cas, nous nous rabattons sur ce cher vieux nom de template par défaut, category.html
Nous demandons à Dotclear2 de servir le template retenu.

Le tour est joué.

Il est désormais possible de se livrer à toutes les extravagances imaginables pour une catégorie donnée. Il suffira pour cela de lui adjoindre un template HTML correctement nommé.

Notes

[1] Réflexe naturel de tout nouvel utilisateur arrivant de Dotclear 1.x. Osez me dire le contraire ! ;-)

[2] Réflexe naturel de tout thèmeur allergique au PHP. Là aussi, osez me dire le contraire ... :-p

Nouveau filtre antispam : Defensio

2008-04-26T06:07:00+02:00

~~Attention : Il s'agit d'un plugin au tout premier stade de développement. C'est de l' alpha de chez alpha . Ne le testez pas sur un blog en production.~~

Qu'est ce que Defensio ?

Defensio se veut comme une alternative au déjà célèbre service Akismet. Ce qui signifie qu'il s'agit d'un service antispam centralisé, interrogeable par HTTP au travers d'une API.

Pour en savoir plus, je vous recommande donc la lecture de la page adéquate sur le site officiel, ainsi qu'un détour par la FAQ.

Que fait le filtre Defensio pour Dotclear2 et comment l'utiliser ?

Le filtre Defensio se comporte exactement comme son homologue Akismet. Il y a donc la même restriction que pour Akismet : il n'est pas possible de signaler de faux négatifs au service concerné.^[1] Il va de soi que le signalement des faux positifs fonctionne.

Pour en bénéficier, il suffit :

D'installer le plugin depuis l'archive ZIP fournie (9 Ko).
De créer un compte gratuit sur Defensio, et de demander une clé API pour un blog donné.^[2]
D'aller dans le panneau de gestion Antispam de Dotclear2, pour accéder à la configuration du filtre Defensio et ainsi y reporter la clé API destinée à votre blog.
Une fois la clé vérifiée, un retour à la centrale Antispam sera nécessaire pour vous permettre d'activer le filtre.

Il ne vous restera plus ensuite qu'à laisser faire.^[3]

Et pourquoi encore un filtre ?

C'est une question que vous êtes en droit de vous poser, l'artillerie Antispam de Dotclear2 étant déjà bien remplie. De fait, il s'agit essentiellement d'offrir le choix le plus large aux utilisateurs, et de privilégier la diversité.

Ce filtre va-t-il évoluer ?

Ceux d'entre vous qui feront le tour en détail de Defensio.com remarqueront qu'il existe quelques subtilités supplémentaires par rapport au service Akismet : principalement la possibilité d'obtenir quelques statistiques et un principe d'annonce de publication des billets.

J'ai fait en sorte d'intégrer sommairement la première fonctionnalité dans l'interface de configuration du filtre. Par contre, j'ai préféré faire l'impasse sur la seconde pour le moment.

Il y aurait pas mal d'améliorations à apporter au plugin pour tirer pleinement parti du service éponyme. Néanmoins, avant de me lancer dans le développement d'une version plus enrobée, je préfère attendre d'avoir un peu de recul, tant sur l'adoption envisageable, les retours des testeurs courageux, que sur la tenue et l'évolution du service lui-même.

EDIT 28/04 : Passage en version 0.2, avec fichier de localisation FR. Le lien de téléchargement est à jour.

EDIT 02/05 : Après une semaine d'utilisation sur ce blog et le blog voisin, le plugin ne présente aucun souci majeur en terme de fonctionnement. Il me semble adapté pour des tests à plus grande échelle.

Notes

[1] Mais cela pourrait très bien changer d'ici une version stable.

[2] Vous aurez bien entendu pris le temps de lire les conditions d'usage auparavant. N'est-ce pas ?

[3] En priant pour que cette très jeune version du filtre ne contienne pas trop de bugs ! ;-)

Mise à jour du plugin sitemaps

2008-04-25T05:13:00+02:00

Et si on poursuivait la séance de remise à neuf des plugins, en vue de l'arrivée de Dotclear2 RC ?

Aujourd'hui, c'est au tour de sitemaps, qui pour l'occasion passe en version ~~1.0-beta1~~1.0-RC1^[1] :

Le support du pseudo-format URL list passe à la trappe, Yahoo prenant également en charge le protocole Sitemap.
Une option pour la prise en compte des nouvelles entrées de type page fait son apparition. C'est logique.
Pour l'occasion, les entrailles du plugin reçoivent de quoi permettre à un plugin d'ajouter aisément des entrées avec un post_type spécifique.^[2]
Le XML en sortie est désormais produit via le moteur de template. Ça ne change pas grand chose au final, mais permet de mieux gérer l'aspect cache^[3] et ainsi de limiter la charge si un petit malin venait à multiplier les requêtes sur le sitemap ...

Une fois de plus, il n'y a donc pas de révolution. Simplement une évolution naturelle et logique d'une mécanique simple et déjà rodée.

Téléchargement : Archive ZIP (12 Ko)
Version Dotclear2 requise : 2.0-RC1 ou plus.

Comme toujours, si quelque chose ne va pas, je compte sur vous pour me le signaler. :-)

EDIT 07/05 : Passage en RC1 avec correction du problème de <changefreq> vide et ajout d'un complément pour la localisation.

Notes

[1] Si, si. Soyons fous, osons !

[2] Evidemment, cette partie sera à documenter.

[3] Plus particulièrement intéressant avec une utilisation conjointe des plugins staticCache ou memCache.

Mise à jour du plugin commentsWikibar

2008-04-23T20:40:00+02:00

On ne joue pas là dans la catégorie des plugins incontournables, mais la barre de formatage wiki pour les commentaires (aka commentsWikibar) n'en est pas moins utile. Aucune raison de ne pas la dépoussiérer un peu en vue de l'arrivée de Dotclear2 Release Candidate.

Au programme de cette nouvelle mouture (~~1.0-beta2~~1.0-RC3) :

Correction d'un bug au niveau des URLs générées - dans un environnement multiblog - pour l'inclusion des fichiers .js et .css associés
Suppression de la balise de template spécifique : il n'est plus nécessaire de modifier les fichiers des thèmes pour l'intégration; le nécessaire au fonctionnement de la barre est inséré via le nouveau behavior publicHeadContent (apparu dans la révision SVN 1639)
La mécanique d'insertion se base sur le type d'URL : par défaut, les fichiers .js et .css ne sont ajoutés qu'en visualisation d'un post, d'une page ou des pages du plugin Gallery permettant les commentaires. D'autres modes peuvent être supportés, il suffit aux plugins les mettant en oeuvre de définir un callback pour un behavior initCommentsWikibar.
Arrivée d'un panneau de configuration du plugin : la barre peut désormais être activée indépendamment sur chaque blog d'une installation Dotclear2. Petite cerise sur le gâteau, l'activation de la barre entraîne automatiquement l'activation de la syntaxe wiki pour les commentaires du blog concerné.

Téléchargement : Archive ZIP (19 Ko)
Version Dotclear2 requise : 2.0-RC1 ou plus.

Je crois que je n'oublie rien. Tout cela demande évidemment à être correctement testé, et ... documenté. :-)

Il va également sans dire que vos retours seront les bienvenus.

EDIT 28/04 : Passage en RC, avec fichier de localisation complet et corrigé.

EDIT 03/05 : Passage en RC2 pour corriger les URLs vers les images dans la feuille de styles par défaut. Cf. les commentaires.

EDIT 07/05 : Passage en RC3 pour modifier le comportement du bouton de saut de ligne.

Plugin Related en fin de vie

2008-04-22T03:26:00+02:00

Suite à l'annonce officielle du plugin Pages, qui sera désormais livré en standard avec Dotclear2, le plugin Related actuel est appelé à disparaître.

Ainsi, dans les semaines à venir, Related prendra tranquillement sa retraite et cédera la place à un nouveau plugin, dérivé de l'actuel, sans doute nommé externalPages ou includedPages. Seule la fonctionnalité permettant d'inclure un fichier externe en guise de page dans le blog sera reprise. Pour l'occasion, j'envisagerai de permettre la prise en charge des balises de template de Dotclear2 au sein des fichiers (X)HTML susceptibles d'être liés à une page.

Aucune date de sortie n'est fixée pour l'instant, mais une première version béta du plugin devrait suivre d'assez près la sortie de la version Release Candidate de Dotclear2.

Refonte en cours ...

2008-04-21T16:47:00+02:00

A compter d'aujourd'hui, le Bricoland Drive va connaître un petit ravalement de façade.

Il est en effet temps de donner à cet endroit l'apparence et les outils qui lui permettront de tenir le rôle qui lui était destiné : regrouper notes et travaux personnels concernant le développement d'extensions pour Dotclear, toutes branches confondues; ainsi que servir de lieu pour le support des plugins que je propose.

Tout cela ne se fera pas d'un seul et unique coup, les travaux s'échelonneront sur plusieurs semaines. Ce chantier avancera par étapes. Il faudra donc vous attendre à essuyer quelques plâtres (sous forme d'indisponibilité temporaire ou de liens brisés), mais je veillerai à ne pas trop faire de casse.

Merci de votre compréhension ... et de votre patience ! ;-)