[spip-dev] Aide de SPIP - Normaliser un peu l'API

Hello,

L’aide de SPIP a été mis en plugin-dist sur la branche de dev (3.2).
Rien n’a été modifié au niveau du comportement pour l’instant.

Une première étape serait de normaliser un peu l’interface d’aide qui est restée dans le core, à savoir, la balise #AIDER et la fonction aide().

Les modifications seraient les suivantes :

  • Renommer la fonction aide() en aider() afin de coïncider avec la balise #AIDER. Il faut aussi renommer la fonction de calcul inc_aider_dist en inc_calculer_aide_dist dans le core et dans le plugin aussi.

  • Harmoniser les arguments de la balise et de la fonction. Aujourd’hui la balise n’a qu’un argument qui est l’identifiant d’aide à afficher alors que la fonction aide() possède un deuxième argument qui indique si l’aide doit être affiché à partir d’une url locale ou distante (directement sur le serveur d’aide). Donc l’idée est de rajouter cet argument aussi à la balise.

En corollaire, faut-il garder l’argument env dans la fonction de calcul de l’aide, argument non utilisé actuellement.

  • Paramétrer le mode d’affichage de l’aide local ou distant. Ce mode est toujours local par défaut. L’idée serait de paramétrer ce mode par une constante (dans le plugin aide).

Voilà pour un premier pas.

Votre avis ?