SPIP-Contrib

SPIP-Contrib

عربي | Deutsch | English | Español | français | italiano | Nederlands

286 Plugins, 197 contribs sur SPIP-Zone, 284 visiteurs en ce moment

Accueil > Rédaction > Définitions en FAQ > Définitions et FAQ, version 3

Définitions et FAQ, version 3

1er mai 2015 – par _Eric_ – 11 commentaires

11 votes

É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.

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 tâche 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.

PNG - 87.5 ko

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.

PNG - 83 ko

Exemple

PNG - 77.6 ko

Voir en ligne : http://plugins.spip.net/faq

Dernière modification de cette page le 14 juin 2015

Retour en haut de la page

Vos commentaires

  • Le 4 juin 2015 à 15:58, par vfavrat En réponse à : Définitions et FAQ, version 3

    Bonjour,

    Tout d’abord merci pour ce plugin.

    Deux petits soucis :
    * j’ai activé l’option « Insérer un lien vers le début de la FAQ en fin de chaque réponse » : le lien est bien inséré, mais ne fonctionne pas.
    * je n’arrive pas à utiliser les catégories : suffit-il d’écrire #categorie ? Dans ma page cela affiche #categorie mais pas d’icône de tag. Que faut-il faire de plus ?

    Merci d’avance pour votre aide.

    Virginie

    • Le 6 juin 2015 à 10:40, par _Eric_ En réponse à : Définitions et FAQ, version 3

      Bonjour,

      J’ai testé sur plusieurs sites cela fonctionne très bien. Il faudrait que je puisse accéder à ton site pour voir le comportement et surtout la façon dont tu as écrit la FAQ.

      Pour le problème de la catégorie es-tu sure d’avoir écrit ton #categorie à la suite du titre sans revenir à la ligne ?

    • Le 8 juin 2015 à 08:58, par vfavrat En réponse à : Définitions et FAQ, version 3

      Bonjour et merci !

      Pour les catégories, je mettais un retour à la ligne effectivement. Cela fonctionne maintenant, mais avec une simple puce (point) et non le petit symbole annoncé.
      Dans l’aide je n’avais pas lu qu’il fallait tout mettre sur la même ligne.

      Pour le retour au début de la FAQ, cela fonctionne, mais quand il y a des titres, cela remonte au début de la partie et non de la page.

      Merci beaucoup.

    • Le 8 juin 2015 à 09:08, par _Eric_ En réponse à : Définitions et FAQ, version 3

      Il faut vérifier si tu n’as pas un style CSS qui écrase celui qui permet d’insérer le symbole pour le tag. Je ne vois pas pourquoi ça ne fonctionnerait pas chez toi.

      Pour le retour au début de la FAQ c’est bien le fonctionnement voulu. Un titre implique une FAQ, donc toutes les questions de cette FAQ renvoie vers le titre donc le début de la FAQ. Ca permet justement de remonter à la FAQ en cours si on en a plusieurs dans la page.

    • Le 24 mars à 16:01, par Jean Christophe Villeneuve En réponse à : Définitions et FAQ, version 3

      Bonjour

      Je reprends le dossier pour le même site.

      Pour le retour en début de FAQ, c’est OK si on lui donne un titre mais si un titre implique une FAQ, une FAQ n’implique pas forcément un titre, notamment quand il n’y a qu’une FAQ dans la page. Et dans ce cas, le lien « Retour au début de la FAQ » est inopérant.
      Ce qui serait bien, c’est que ça remonte tout au début même en absence de titre.

      Autre demande : y a-t-il moyen que le lien vers une ancre de la FAQ, du genre adresse#faq_1_0_15 amène vers cette ancre avec automatiquement ouverture de la question et affichage de la réponse ?

    Répondre à ce message

  • Le 18 mars à 09:36, par erational En réponse à : Définitions et FAQ, version 3

    Sur un SPIP 3.1.1, la mise à jour du plugin FAQ a planté le site. (levée d’une erreur fatale require_once dans textwheel ligne 174, sans doute à cause du changement de chemin de répertoire du plugin)

    Pour résoudre le problème :

    • désactiver le plugin (par exemple en renommant son répertoire via le FTP)
    • vider vos répertoires local/ et tmp/cache
    • ré-activer le plugin

    Répondre à ce message

  • Le 2 septembre 2015 à 19:13, par Phil En réponse à : Définitions et FAQ, version 3

    Bonjour,
    je suis en mutualisé avec PHP 5.2.17, SPIP 3.0.17 et le plugin FAQ 3.0.9.
    Lorsque je crée un FAQ simple comme

    1. <faq>
    2. ? Q1
    3. R1
    4. </faq>

    Télécharger

    Il s’affiche comme

    1. <dl class="faq">
    2. Q1
    3. R1

    Télécharger

    Avec donc les tags en clair et sans le formatage attendu. Comment corriger ?
    Merci d’avance pour votre aide.

    • Le 2 septembre 2015 à 21:32, par _Eric_ En réponse à : Définitions et FAQ, version 3

      Salut,

      Je ne reproduis le comportement que tu décris. J’ai une FAQ bien construite. Peux-tu soit me donner plus d’informations sur les plugins installés sur ton site ou me donner le texte source exact qui ne fonctionne pas ?

    • Le 4 septembre 2015 à 16:10, par Phil En réponse à : Définitions et FAQ, version 3

      Merci de la réponse ;-)
      Mon texte source exact est le suivant

      1. <faq>
      2. :Nouveau titre
      3. ? Question
      4. Réponse
      5. </faq>

      Télécharger

      j’ai monté une autre instance de spip en parallèle et sur cette autre instance le plugin FAQ marche ... Les plugins =
      Accès Restreint 3.8.13
      Activité éditoriale 2.0.4
      API de vérification 1.0.8
      Article PDF 0.4.6
      Autorité 0.10.9
      Champs Extras 3.7.1
      CSVImport 0.2.3
      Enluminures typographiques 3.5.4
      Facteur 3.1.2
      FAQ 3.0.9 - test
      Formidable 2.9.2
      Le Couteau Suisse 1.9.8 -
      Lecteur Multimédia 2.7.7
      Mes fichiers
      Nuage 4.0.5
      Saisies pour formulaires 2.5.11
      Sarka-SPIP 3.4.5 - test
      Simples Logs 1.1.1 - stable
      SPIP Bonux 3.2.1
      SPIP-Listes 3.0.11 - test
      Splickrbox 0.4.6 - stable
      YAML 1.5.2 - stable
      Z-core 2.4.5 - stable
      Zen-Garden 2.6.2

    • Le 7 septembre 2015 à 14:48, par Phil En réponse à : Définitions et FAQ, version 3

      Sur l’instance où le plugin ne fonctionne pas, je vois que SPIP génère le code HTML suivant (on remarque que le signe inférieur précédant « class = » a été htmlisé à plusieurs endroits).

      1. class='ajaxbloc' aria-live='polite' aria-atomic='true' data-ajax-<cadre class='xml'>
      2. env='PkTj5eV7IGMKkM3wEpygmZjamnd2W4nFc0IJyySIOxAf5S/h3dqlxow3HBRZkCT8M8Kas+9ujGeqEbGwOv+b32OpsACCI1QqEtCII5U312iQaNcmTOH2csVQ0rfFXJTMGsX55VIOkOgfsgt/lBAVNxNxDjQ8uv6nLEg11/5ZupN+3Iq95G1aaM/67kTnEFBxrbncZlSUEGgQxbePdD9v1xTBKZCA2qIDLrw4P0Wefdv4dn/jKZxV7zMkyK/Sppw39GsyN4AA6dhtsPVpxyQ=' data-origin="Utilisation-489.html"><h3 class="spip">
      3. &lt;a
      4. class="ancre" href="#faq_1_1" name="faq_1_1" id="faq_1_1"></a>
      5. Nouveau titre</h3><p>&lt;dl
      6. class="faq js">
      7. &lt;a
      8. class="ancre" href="#faq_1_1_0" name="faq_1_1_0" id="faq_1_1_0"></a></p><dt>
      9. Question</dt><dd>
      10. Réponse</dd></dl></div><p></p></div>

      Télécharger

      Sur l’instance où ça marche, j’ai

      1. class='ajaxbloc' aria-live='polite' aria-atomic='true' data-ajax-env='vmWfBYCfxAKl/5UYzby+z6VTflNd6pGvF/WKeDhpcn0dhM3e83qcP2wlcfbMGtRDG97wxSKrHBmg5v7RB84SreNvII43IZY21fdAaco2FEGZ3FI26aIZQ3stzYUueh3fxMFX+48dR1MzDHNIIxSH5PLEIaMqMBwYj9Hm+Js4egSa0wiwLDa4ycQeRF7duVfw0XtPc6eCnUJt5Je5oqDI7OqYKrrdJ+u042r984dfN83WcYyMkM8WtNoxfaJG1NoIr53N/ZmN0ablQTasYBDixq7vlY+0T5kN6gnOf8nx' data-origin="Test-FAQ.html"><dl class="faq js">
      2.  
      3. <p> <a class="ancre" href="#faq_1_0_0" name="faq_1_0_0" id="faq_1_0_0"></a></p>
      4. <dt>
      5. Question 1
      6. </dt>

      Télécharger

      Merci de ton aide.

    Répondre à ce message

  • Le 1er juillet 2015 à 22:56, par livier En réponse à : Définitions et FAQ, version 3

    Bonjour,

    J’ai eu un problème à l’intallation du plugin : réponse en rouge : • Le plugin FAQ dépend de TW [0.3.1 ;[

    Résolu par la mise à jour de tous les plugins installés puis SPIP 3.0.20 [22255]

    Bon, pendant que je suis là :

    La dégradation n’est pas optimale lorsque le texte de la liste apparait dans le cadre d’une balise #INTRODUCTION. J’utilise SPIPr qui fait usage de cette balise dans les listes d’articles présentés, et voici ce que donne le html :

    1. <p>
    2. mot1
    3. <br class="autobr"></br>
    4. définition1 mot2
    5. <br class="autobr">
    6. </br>
    7. définition2
    8. </p>

    Télécharger

    Enfin, une demande, ce n’est peut être pas trivial à faire,, mais j’ai trouvé ce plugin pour faire un lexique ... et l’idée de l’utiliser aussi sur le même site pour faire une FAQ ne me parait pas folle du tout. Mais la config du plugin ne peut être adaptée à chaque utilisation puisqu’on est dans le même site. Celà est il envisageable de dépasser cette restriction ?

    C’est pas pour critiquer, c’est pour aider hen ;-)

    Répondre à ce message

Répondre à cet article

Qui êtes-vous ?

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 Les choses à faire avant de poser une question (Prolégomènes aux rapports de bugs. )
Ajouter un document

Retour en haut de la page

Ça discute par ici

  • Adaptive Images

    15 novembre 2013 – 66 commentaires

    Un plugin pour permettre aux sites responsive d’adapter automatiquement les images de la page à l’écran de consultation. Adaptive Images, que l’on pourrait traduire par Images adaptatives, désigne la pratique qui vise à adapter les taille, (...)

  • Métas

    8 août 2009 – 50 commentaires

    Ce petit plugin permet l’ajout, depuis l’espace privé, de metatags aux articles et rubriques de SPIP, ainsi que la mise en exergue de mots importants.

  • Brownie

    6 juillet 2012 – 43 commentaires

    Brownie est une adaptation pour Zpip du thème du même nom initialement développé par Egrappler.com. Présentation Brownie est un thème Responsive à deux colonnes. La démonstration ci-dessous utilise la version 2.0.0 de Brownie, la dist de SPIP3 (...)

  • Métas +

    3 décembre – 13 commentaires

    Améliorez l’indexation de vos articles dans les moteurs et leur affichage sur les réseaux sociaux grâce aux métadonnées Dublin Core, Open Graph et Twitter Card. Installation Activer le plugin dans le menu dédié. Dans le panel de configuration, (...)

  • Acces Restreint 3.0

    11 décembre 2008 – 785 commentaires

    Le plugin accès restreint permet de définir et de gérer des zones de l’espace public en accès restreint. Cette version du plugin a été redévelopée et optimisée tout spécialement pour SPIP 2.0. Il en découle une amélioration des performances sur les gros (...)

Ça spipe par là