Aide_dev, développer facilement l’aide de son plugin

Publié le : 30 mai 2023 – par Thrax

1
2
3
4
5
1 vote

Aide_dev est un petit outil pour construire l’aide de plugins gérant des objets éditoriaux.

Installation et dépendance

Plugin nécessaire : aide, bien sûr.
Pré-requis : ne pas installer ce plugin en production ; il est un outil d’assistance au développement.

Configuration

Aucune.

Utilisations

L’accès à l’interface de conception d’une aide se fait au travers du menu Développement, à l’article Assistance création d’aide

N’oubliez pas de solliciter l’affichage de ce menu, au travers de vos préférences en tant qu’autrice ou auteur.

Fonctionnement

Le plugin sur lequel la développeuse ou le développeur souhaite travailler se choisit par un menu déroulant à gauche. Dès celui-ci sélectionné, il sera afficher des propositions de morceaux de code à ajouter dans le paquet et la déclaration d’utilisation des pipelines. De même, une rédaction du fichier de variable de langue pour l’aide sera rédigé. Enfin, l’arborescence nécessaire sera décrite avec des boutons pour la créer si nécessaire.

Références et liens

Pour en savoir plus :
Créer une aide en ligne pour un plugin

Pour faire autrement :
Aide_par_objet propose un autre type d’aide, par boite d’information latérale.

Explication de développement et todo

Vous êtes les bienvenues pour modifier ce plugin et l’améliorer, via la forge.

Discussion

5 ans 1 an 3 mois Sans limite
par date
Filtrer

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