[aide ↪ dev-aide-en-fichiers] Simplification de l'aide en ligne en utilisant des (.. .)

Matthieu Marcillaud <[email protected]> Sat, 1 May 2021 02:11:01 +0200
Newsgroups gmane.comp.web.spip.cvs
Message-ID <jQysk79G6eIJsVTmWg3RhFQ7qPj00s0xozgApaEqAhA@localhost.localdomain>
spip/aide
-
Par Matthieu Marcillaud, le 1er mai 2021 à 02h09min : 

Simplification de l'aide en ligne en utilisant des fichiers, plutôt que d'aller la chercher sur spip.net.

`#AIDER{raccourcis}` affiche l'aide du groupe "raccourcis". (et uniquement celle là). Ce groupe contient différentes entrées, et éventuellement une intro.

La déclaration est volontairement *très* simple et traverse un pipeline "aide_index".
`$index['raccourcis'] = ['simple', 'lien', 'note', 'citation', 'tableau', 'liste', 'glossaire', 'ancre'];`

Pour garder cette simplicité on s'appuie sur la structure suivante :

Le fichier de langue "aide" tel que lang/aide_fr.php contient les titres, soit "{groupe}" ou "{groupe}_{entree}".
Comme les fichiers de langue sont extensibles (ie on peut declarer un lang/aide_fr.php dans un autre plugin), ça devrait suffire.

- 'raccourcis' => Titre...
- 'raccourcis_simple' => Titre... etc.

Le contenu lui est cherché dans un fichier "aide/{lang}/{groupe}/{entree}.spip" tel que "aide/fr/raccourcis/lien.spip".
S'il existe un "aide/{lang}/{groupe}/_intro.spip" il sera utilisé en introduction du groupe.

Si une langue n'existe pas, on tente de suivre le même chemin de recherche que pour les traductions.

Note: il reste quelques bugs d'ancres à corriger dans la popin.


*Ajouté*
    aide/fr/raccourcis/_intro.spip
    aide/fr/raccourcis/ancre.spip
    aide/fr/raccourcis/citation.spip
    aide/fr/raccourcis/code.spip
    aide/fr/raccourcis/glossaire.spip
    aide/fr/raccourcis/lien.spip
    aide/fr/raccourcis/liste.spip
    aide/fr/raccourcis/note.spip
    aide/fr/raccourcis/simple.spip
    aide/fr/raccourcis/tableau.spip
    lang/aide_fr.php
*Supprimé*
    aide_options.php
*Modifié*
    inc/aide.php
    paquet.xml
    prive/squelettes/contenu/aide.html
    prive/squelettes/contenu/aide_fonctions.php

Détails : https://git.spip.net/spip/aide/commit/a340a7227035c834a5af0bc8397b794442b473da