Définitions et FAQ

Mise en valeur des définitions

Ce plugin valorise les éléments HTML dédiés aux définitions, méconnus et trop peu utilisés. Employez ces balises dans la rédaction de vos articles, pour améliorer leur sémantique (et donc leur indexation, leur référencement, leur accessibilité [1], etc).

Terme défini : dfn

Lorsqu’on définit un terme au fil d’un texte, celui-ci est à placer dans l’élément HTML dfn. Exemple :
« Le polatouche est un écureuil volant » s’écrit :
Le <dfn>polatouche</dfn> est un écureuil volant.

Liste de définitions : dl, dt, dd

Très pratiques pour des définitions qui se succèdent, comme dans un glossaire ou une FAQ, les listes de définitions comportent deux parties, un terme et une description. Exemple :

<dl>
    <dt>Grenouille</dt>
    <dd>Truc vert humide</dd>
    <dt>Lapin</dt>
    <dd>Truc chaud et doux</dd>
</dl>

Ce plugin habille ces éléments d’un style minimal par défaut, de façon à les rendre un peu plus visibles, pour vous inviter à les employer. Pour en savoir plus, consultez les documentations HTML de référence, dont cet article traduit sur Pompage.net : « Les listes de définitions : mal utilisées ou mal comprises ? ».

Création de FAQ

Ce plugin permet de réaliser facilement une FAQ, c’est-à-dire une liste de questions fréquentes accompagnées de leurs réponses. Cette FAQ est constituée d’une liste de définitions cliquable open-close : la réponse se déplie lorsque l’internaute clique sur la question, puis se replie s’il la clique à nouveau.

Voici les deux façons de créer une FAQ sur votre site :

* Création d’un article-FAQ (par le rédacteur)

1. Rédiger les questions et réponses dans un article dédié,
2. Baliser correctement : les questions entre <dt>, les réponses entre <dd> et l’ensemble entre <dl class="faq"> et </dl>.

* Création d’une rubrique-FAQ (par le webmestre)

1. Stocker les questions-réponses, à raison d’un couple par article, où la question constitue le titre,
2. Ranger ces articles dans une rubrique dédiée [2],
3. Inclure la noisette fournie par le plugin, dans le squelette de rubrique correspondant, de cette façon : <INCLURE{fond=inc-rubrique-faq}{id_rubrique}>.

Ces deux types de FAQ peuvent co-exister au sein d’un même site, où il est possible de créer autant de FAQ que souhaité.

Voici un exemple de FAQ créé avec ce plugin, assortie à la charte graphique du site de l’UPSTI :