SPIP-Contrib

SPIP-Contrib

عربي | Deutsch | English | Español | français | italiano | Nederlands

279 Plugins, 195 contribs sur SPIP-Zone, 111 visiteurs en ce moment

Accueil > Rédaction > Texte et affichage > TextWheel > Présentation de TextWheel

Présentation de TextWheel

5 juillet 2011 – par Fil – 10 commentaires

15 votes

Textwheel — littéralement, « la roue du texte » — est un projet visant à simplifier l’écriture de règles de transformation d’un texte d’un format vers un autre.

Quand on s’intéresse aux systèmes de publication sur Internet, on a la forte impression que chacun réinvente la roue de son côté, refaisant pour chaque composant du logiciel sa propre implémentation.

Textwheel s’attaque à l’un de ces composants : la transformation d’un texte « brut » en texte présentable à l’écran.

Par exemple, sous SPIP, on transforme :
{Hello} {{World}}
en :
<i>Hello</i> <strong>World</strong>

Sous Textile, on transforme :
_Hello_ *World*
en :
<em>Hello</em> <strong>World</strong>

En BBCode, on aura :
[i]Hello[/i] [b]World[/b]

L’ennui jusqu’ici c’est que chaque logiciel (gestion de contenu, gestion de forums) est livré avec ses propres raccourcis, dans sa propre implémentation. Il n’y a donc ni standard, ni possibilité d’échanger, ni possibilité de modifier ses raccourcis. Textwheel est une proposition visant à répondre à ces soucis d’interopérabilité.

Le principe : avec Textwheel, plutôt que de coder une fonction qui effectue ces règles de transformation, on les décrit dans un fichier de configuration (ex : spip.yaml), au format très simple (YAML). Textwheel se chargera d’appliquer ces règles.

Ainsi, Textwheel sépare la création des « raccourcis d’édition » de leur implémentation technique.

Avec Textwheel, les raccourcis de SPIP se programment donc ainsi :

strong:
 match: [ "{{", "}}" ]
 replace: [ "<strong>", "</strong>" ]
italics:
 match: [ "{", "}" ]
 replace: [ "<i>", "</i>" ]

Ceux de Textile :

strong:
 match: "/\*(\w*)\*/U"
 replace: "<strong>\1</strong>"
italics:
 match: "/_(\w*)_/U"
 replace: "<em>\1</em>"

et le BBCode :

strong:
 match: [ "[b]", "[/b]" ]
 replace: [ "<strong>", "</strong>" ]
italics:
 match: [ "[i]", "[/i]" ]
 replace: [ "<i>", "</i>" ]

On voit qu’il est dès lors très facile d’ajouter les raccourcis BBCode ou Textile dans SPIP, ou l’inverse, en manipulant des fichiers de configuration. Bien entendu les cas plus complexes (callbacks, expressions rationnelles) sont prévus.

Avantages de Textwheel

L’interopérabilité entre logiciels n’est pas le seul avantage.

-  Extensibilité. Il est plus aisé pour un utilisateur de manipuler un fichier de configuration au format établi, que de se plonger dans des modifications de code qui peuvent sauter à chaque mise à jour.

-  Traitements. Dès lors que les raccourcis sont codés de manière descriptive, et non pas fonctionnelle, il est possible de leur faire subir des traitements qui ne se limitent pas à les appliquer à un texte. On peut par exemple les appliquer à la chaîne sur l’ensemble des textes d’une base de données, et voir lesquels sont utilisés, combien de fois, à quels textes... et à quelle vitesse.

-  Rapidité. Ce qui permet de détecter des règles mal programmées, inutiles, trop lentes ou pas efficaces. En appliquant cette méthodologie aux raccourcis de SPIP, nous avons pu en quelques jours diviser par deux le temps de calcul des textes (sur certaines bases de texte d’usage réel).

-  Compilation. Une autre sortie possible pour un fichier de raccourcis, c’est une compilation sous forme de code dans un langage arbitraire (par exemple : PHP, python, ruby, javascript, C...). Cette approche devrait permettre à terme de retrouver les mêmes raccourcis sous différents logiciels, quel que soit leur langage de programmation, et aussi bien côté serveur (PHP, python) que client (javascript).

-  Tests unitaires. Jusqu’ici les raccourcis avaient tendance à « casser » dès lors qu’on mettait les mains dans le code, et il était bien difficile, lorsqu’on constatait un bug, de voir à quel niveau des traitements le résultat devenait non conforme. Maintenant que notre moteur peut comparer, pour chaque règle, le résultat obtenu avec sa valeur attendue, un jeu de tests peut non seulement nous dire si quelque chose a changé, mais nous dire aussi précisément quoi.

-  Évolutivité. Cette approche devrait permettre de redynamiser le travail sur les raccourcis (introduction de nouveaux raccourcis, suppression de raccourcis obsolètes, amélioration de raccourcis mal foutus...). Car on peut imaginer construire un outil qui permettra de signaler le cas échéant au webmestre qui met à jour son site qu’il aura, par exemple, deux articles à vérifier (et lesquels) suite à une amélioration du code. Outil qui sera basé sur de simples fichiers YAML.

Télécharger

Le projet est développé, en ce moment, via git et sur github.com ; on avance en parallèle sur le moteur (http://github.com/Cerdic/textwheel/...) et sur le plugin SPIP (http://github.com/Cerdic/textwheel/).

Pour télécharger ce dernier par svn, utiliser la commande suivante :

svn checkout http://svn.github.com/Cerdic/textwheel.git/ plugins/textwheel/

Le plugin pour SPIP donne une page ?exec=tw dans l’espace privé qui permet de voir ce qui change entre textwheel et la fonction propre() classique de SPIP : les quelques textes où le rendu n’est pas exactement identique sont signalés, ainsi que le temps passé dans chaque rule, et le temps total des calculs.

Participer

Si cette rapide présentation vous a alléché, sachez que toutes les participations sont les bienvenues.

Le projet est, pour démarrer, codé en anglais et en PHP. Il offre d’ores et déjà des spécifications en version 0.1, une implémentation en PHP, et un plugin pour SPIP qui remplace le moteur historique de SPIP par cette nouvelle approche.

Nous n’en sommes qu’au début. Il y a beaucoup à faire sur ce projet, qu’il s’agisse d’améliorer les specs, de contribuer de la documentation, d’établir des cas tests, de coder des implémentations dans d’autres langages (ruby, javascript), etc.

Une communauté de développeurs se met en place sur la mailing-list textwheel@rezo.net ; URL : http://listes.rezo.net/mailman/listinfo/textwheel

A bientôt !

Retour en haut de la page

Tout afficher

Vos commentaires

Répondre à cet article

Qui êtes-vous ?
  • [Se connecter]

Pour afficher votre trombine avec votre message, enregistrez-la d’abord sur gravatar.com (gratuit et indolore) et n’oubliez pas d’indiquer votre adresse e-mail ici.

Ajoutez votre commentaire ici Les choses à faire avant de poser une question (Prolégomènes aux rapports de bugs. )
Ajouter un document

Retour en haut de la page

Ça discute par ici

  • spiPDF v0.2.1 : : générer des contenus sur mesure en PDF

    16 février 2011 – 171 commentaires

    Le plugin spiPDF génère des fichiers au format PDF d’article ou de tout autre élément SPIP, simplement à partir d’un squelette construit au format HTML 4 et facile à modifier. Présentation Le plugin génère des fichiers PDF à partir d’un squelette écrit (...)

  • Plugin Vidéo(s)

    23 novembre 2010 – 524 commentaires

    Interface de gestion et modèle d’insertion des vidéos : Dailymotion Vimeo Youtube Modèle de la balise HTML5 video avec alternative flash html5media : Lecture HTML5/Flash pour tout navigateur des fichiers MP4/H264/Ogg/WebM/Mkv Support (...)

  • Plugin JAZ

    9 mai 2012 – 23 commentaires

    Une fois installé, le plugin « JAZ » (Joindre Automatiquement à une Zone) permet de définir une zone ou une liste de zones d’accès restreint, auxquels tout auteur demandant son inscription sera automatiquement associé. Utilité Dans le cadre d’une (...)

  • Champs Extras 3

    16 janvier 2012 – 344 commentaires

    Ce plugin permet de créer et/ou de gérer des champs supplémentaires dans les objets éditoriaux de SPIP. Il permet donc de prendre en compte et d’afficher de nouveaux éléments dans n’importe quel objet éditorial de SPIP. Screencast Vous n’aimez pas (...)

  • Liste des pays avec codes ISO 3166-1

    3 juillet 2010 – 21 commentaires

    Les listes de codes de l’ISO 3166-1 Propose une boucle "pays" qui s’utilise comme suit (exemple) : #PAGINATION #ID_PAYS #CODE #NOM Le plugin installe une nouvelle table "pays" qui reprend la liste des pays (...)