Définitions et FAQ, version 3

Écrire rapidement des listes de question-réponse sous forme de FAQ, sans se prendre la tête.

Ce plugin est une extension de Textwheel ; il ajoute de nouveaux raccourcis typographiques permettant de générer rapidement une FAQ proprement présentée, et basée sur les listes de définitions (dl, dt, dd) .

Installation et compatibilité ascendante

Cette nouvelle branche v3 fonctionne directement en SPIP 3 (Textwheel étant distribué par défaut).

Cette branche apporte de nouvelles fonctions au plugin mais assure une compatibilité ascendante parfaite avec la fonction d’article-FAQ de la branche v2 précédente documentée dans l’article Définitions et FAQ. De même, la fonction de rubrique-FAQ est toujours supportée.

Utilisation de base

Le contenu d’une FAQ est inséré entre des marqueurs <faq></faq> qui se dégradent lorsque le plugin n’est plus actif : les balises deviennent juste invisibles et il ne reste que la liste à l’intérieur.

Une question commence par une nouvelle ligne, le premier caractère de la ligne devant être un point d’interrogation « ? ». Tout le texte inscrit depuis la ligne suivante jusqu’à la prochaine question ou la fin de la FAQ est considéré comme la réponse.

<faq>
? Libellé de la première question ?
Texte de la réponse. Ce texte peut contenir tout type de raccourcis et de structures (tableau, listes, paragraphes...). Le texte se termine à ligne précédent la question suivante.

? Libellé de la dernière question ?
Le texte de la réponse se termine cette fois à la ligne précédent la balise de fin de FAQ.
</faq>

Utilisation avancée

Cette nouvelle branche v3 apporte aussi des fonctionnalités avancées :

  • catégorisation des questions ;
  • insertion d’un titre regroupant une séquence de questions ;

Toute ces informations complémentaires s’écrivent à la suite du titre de la question séparées par un espace.

Catégories

Toute information écrite #tag est considérée comme une catégorie à partir du moment où « tag » est une chaine alphanumérique.

Pour chaque question la liste des étiquettes est collectée et affichée précédée d’un petit caractère habituel pour les tags. Si un tag correspond au titre d’un mot-clé SPIP, alors il est affiché comme un lien vers la page mot-clé associée.

Titres

Un titre est détecté par le caractère « :» en début de ligne. Tout le reste de la ligne constitue le libellé. Il est possible d’insérer plusieurs titres dans une même FAQ et donner ainsi l’impression d’une série de FAQ thématiques.

Intégration au Porte-plume

Cette nouvelle branche v3 permet aussi d’utiliser la barre d’édition du Porte-plume pour ajouter une FAQ, une question ou un titre. Un bloc spécial d’édition est dédié aux FAQ et propose un bouton par fonction.

Configuration

Le plugin possède aussi un formulaire de configuration qui permet d’ajuster le comportement des FAQ comme le fait d’attacher des ancres aux questions, d’utiliser ou pas les CSS fournis par le plugin ou la fonction de pliage-dépliage des questions.

Exemple

Discussion

Une 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