TP
Teddy Payet
CTO Freelance
  • Accueil
  • Blog
  • SPIP - Documentation technique : mise en conformité

SPIP - Documentation technique : mise en conformité

Vous avez pu lire mes 2 précédents articles (ici et ici) sur la Documentation technique d’un plugin en se servant des chaînes de langue offerte par SPIP.
Si vous avez été attentif, vous avez pu lire que j’utilisais les label sous la forme label_champ et label_champ_explication...
Oui mais...

Avec cette solution, quand on utilise la Fabrique pour réaliser notre plugin, on devait intervenir quasi systématiquement dans les formulaires d’édition des objets pour changer explication_champ en label_champ_explication...

Long et parfois fastidieux. Cela peut ocassionner des erreurs, des oublis.

Mise en conformité selon les règles de SPIP

Le but de cette nomenclature est d’être le plus générique possible et de pouvoir se greffer à tout plugin aisément.
Alors, je vais rectifier un peu le tir pour que nous n’ayons plus à changer les chaînes de langue pour les explications.

Un plugin est déjà sur la zone avec le proof of concept de mes 2 précédents articles.
J’ai pu le tester, le mettre à l’épreuve...

De là, en découle mon virage sur les chaînes de langue.

La mise en application

Si on désire avoir cette documentation technique dans un moindre effort, on va respecter les chaînes de langue générées par la Fabrique.
De ce fait, lorsqu’on crée une chaîne, on la construira sur cette mécanique :

label_champ
documentation_champ
explication_champ
correspondance_champ
export_champ

Les 2 dernières chaînes de langue sont ici pour vous illustrer l’utilisation sur d’autres besoins documentaires.

Prochaine étape
Je vais modifier dans peu de temps le plugin sur la zone pour prendre en compte le raisonnement que j’ai eu jusqu’à maintenant et respecter la nomenclature de SPIP (et de la Fabrique).
Je reviens vers vous très rapidement avec les modifications dudit plugin.

 
par Teddy Payet
Frameworks
SPIP