Préserver la typo SPIP avec CKeditor

Depuis la version 0.14 du plugin CKeditor pour SPIP, il est possible d’utiliser CKeditor en préservant la typo SPIP : aucun code HTML n’est introduit dans vos articles, tout est reconverti en typographie SPIP.

Les éditeurs visuels ont l’avantage de la simplicité pour l’usager : pas de langage de typo à apprendre, il suffit de cliquer sur des boutons. Le prix à payer pour cette simplicité, c’était jusqu’ici l’introduction de code HTML dans les articles SPIP, là où il ne devrait y avoir que du code typo. Ce code HTML introduit des disparités dans le rendu visuel du site, et il interdit un certain nombre de manipulations basées sur la typo SPIP. De plus, la présence de ce code HTML rendait la cohabitation impossible entre les usagers de CKeditor et les usagers préférant manipuler la typo dans l’éditeur SPIP.

Cette limitation appartient au passé, puisque depuis la version 0.14 du plugin CKeditor pour SPIP, on peut utiliser une librairie — judicieusement nommée HTML2SPIP — pour retransformer en typo SPIP tout le code HTML produit par CKeditor. On a ainsi un éditeur visuel, mais les articles restent rédigés en typo SPIP.

Pour rentrer dans les détails, au moment où on lance CKeditor, SPIP converti sa typo en HTML. CKeditor manipule le code HTML, et quand on enregistre, la librairie HTML2SPIP converti l’HTML en typo SPIP. Tout ne peut pas être converti, et certains enrichissements de CKeditor seront ignorés au moment de la reconversion en typo. Par exemple, CKeditor permet de choisir la couleur d’une section, opération qui n’a pas de sens en typo SPIP (et plus généralement qui est à proscrire si on tente d’imposer une charte graphique cohérente). HTML2SPIP ignorera les colorations introduites par CKeditor, qui seront perdues.

Configuration de CKeditor pour préserver la typo

Tout d’abord, il faut télécharger la librairie HTML2SPIP. Prenez la dernière version, et décompactez la dans le dossier lib de
votre installation de SPIP.

Rendez vous ensuite dans les formulaires de configuration de CKeditor dans l’espace privé. Choisissez le formulaire Configuration avancée, qui ressemble à ceci :

Si à la place des réglages de la section Options HTML2SPIP, vous avez un message indiquant La librairie html2spip n’est pas installée(...), vous pouvez avoir un des problèmes suivants

  • HTML2SPIP n’est pas installée dans le dossier lib.
  • Les permissions dans le système de fichier ne permettent pas au serveur d’y accéder.
  • La version de HTML2SPIP n’est pas celle attendue par le plugin CKeditor. Le plugin attend une version spécifique de la librairie. Le message d’erreur vous donne un lien vers la bonne version.

Activez l’option Reconvertir l’HTML en typo SPIP. Si vous souhaitez que le plugin désactive de lui même les fonctionnalités de CKeditor incompatibles avec la typo SPIP, cochez aussi l’option N’utiliser que les options de CKEditor compatibles avec les raccourcis typographiques SPIP.

Conserver certaines balises HTML

HTML2SPIP élimine les balises HTML qui n’ont pas d’équivalent en typo SPIP, vous pouvez néanmoins vouloir conserver certaines balises, telles que <object> ou <embed>. C’est possible, avec le champ Balises HTML que HTML2SPIP doit laisser intouchées. Placez-y la liste des balises à préserver, séparées par des point-virgules.

Gestion des modèles propres au site

Si vous utilisez des modèles propre au site, il est important de les renseigner dans le champ Balises SPIP à autoriser dans CKEditor, afin que CKeditor et HTML2SPIP n’y touchent pas.

Interception des traitements de conversion

Vous pouvez placer dans votre fichier mes_fonctions.php des fonctions qui seront invoqués avant et après les opérations de conversions HTML vers typo SPIP et typo SPIP vers HTML. Les noms sont assez explicites :

  • ckeditor_spip2html_pre($texte)
  • ckeditor_spip2html_post($texte)
  • ckeditor_html2spip_pre($texte)
  • ckeditor_html2spip_post($texte)

Ce type d’interception peut être utile si vous pratiquez des opérations sur la typo SPIP. Par exemple si vous interceptez typographie_fr() pour transformer les adresses de courriel en images, un traitement dans ckeditor_html2spip_pre() permettra de réaliser l’opération inverse, et ainsi retrouver votre adresses en texte dans votre article.

Chaque fonction prends un unique argument, contenant le texte à traiter, et doit renvoyer le texte traité.

Discussion

Aucune discussion

Ajouter un commentaire

Avant de faire part d’un problème sur un plugin X, merci de lire ce qui suit :

  • Désactiver tous les plugins que vous ne voulez pas tester afin de vous assurer que le bug vient bien du plugin X. Cela vous évitera d’écrire sur le forum d’une contribution qui n’est finalement pas en cause.
  • Cherchez et notez les numéros de version de tout ce qui est en place au moment du test :
    • version de SPIP, en bas de la partie privée
    • version du plugin testé et des éventuels plugins nécessités
    • version de PHP (exec=info en partie privée)
    • version de MySQL / SQLite
  • Si votre problème concerne la partie publique de votre site, donnez une URL où le bug est visible, pour que les gens puissent voir par eux-mêmes.
  • En cas de page blanche, merci d’activer l’affichage des erreurs, et d’indiquer ensuite l’erreur qui apparaît.

Merci d’avance pour les personnes qui vous aideront !

Par ailleurs, n’oubliez pas que les contributeurs et contributrices ont une vie en dehors de SPIP.

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

Ce champ accepte les raccourcis SPIP {{gras}} {italique} -*liste [texte->url] <quote> <code> et le code HTML <q> <del> <ins>. Pour créer des paragraphes, laissez simplement des lignes vides.

Ajouter un document

Suivre les commentaires : RSS 2.0 | Atom