Typage des relations entre articles avec A2A

Principe du typage entre relations

Deux articles peuvent être reliés ensembles par plusieurs types de relations, par exemple :

• un article peut être la suite d’un autre.
• un article peut parler d’un sujet connexe à un autre article.
• un article peut être une correction d’un autre article.
• etc.

Le(s) webmestre(s) du site va donc pouvoir définir des types de relation entre articles.
Chaque type de relation se définit par :
-  une clef unique qui sert pour le webmestre dans les boucles. Cette clef ne doit pas contenir d’espaces ni de caractères spéciaux ou accentués.
-  un titre, qui sert pour les rédacteurs, afin de choisir le type de relation. Le titre peut le cas échéant être traduit dans la langue du rédacteur.

Par exemple nous pourrions avoir comme clef « suite » et comme titre « article suivant ».

Définition des types

Un webmestre peut se rendre dans la page de configuration des types via le Menu « Configuration » -> « Relations entre articles ». Il accède alors au formulaire suivant :

Le premier champ doit contenir l’ensemble des types de liaisons. Chaque type se situe sur une ligne, sous la forme : clef,titre.

Par exemple :

suite,Article suivant
connexe,Article connexe
correction,Correctif

Le titre peut être une chaîne de langue : module:chaine (voir la documentation sur les chaînes de langues).

Si vous essayez de supprimer un type de liaison utilisé, le plugin vous en avertit et vous donne la liste des articles qui utilisent ce type de liaison : il ne vous reste plus qu’à changer les liaisons ayant ce type.

Il est possible de rendre obligatoire le typage de liaison. Si vous cochez la case alors qu’il existe des articles avec des liaisons non typées, le plugin vous en averti : il ne vous reste plus qu’à typer les liaisons (ou les supprimer).

Il est également possible de permettre de relier plusieurs fois deux articles en ayant un typage différent. Par exemple relier les articles 1 et 2 selon le type « article suivant » « sujet connexe ». Si vous tentez de désactiver cette option alors qu’il existe plusieurs relations entre 2 mêmes articles, le plugin vous en empêche et vous fournit la liste des relations problématiques. Il ne vous reste plus qu’à choisir un type de relations.

Par ailleurs, il est possible de définir des types non modifiables. Pour cela, il suffit de définir la variable globale $a2a_types_liaisons dans le fichiers mes_options.php. Cette variable est un tableau PHP clef/valeur :

$GLOBALS['a2a_types_liaisons'] = array(
'suite'=>'Article suivant',
'connexe'=>'Article connexe',
'correction'=>'Correctif'
);  

Pour le rédacteur

Le formulaire d’ajout d’une relation permet désormais d’en préciser le type. Par ailleurs, la liste des relations d’un article permet de modifier le typage d’une relation, en cliquant sur « modifier » à côté du type.

Cependant, il faut faire attention aux relations entre article dans les deux sens. Si vous modifiez le type de relation entre l’article 1 et l’article 2, le type de relation entre l’article 2 et l’article 1 n’est pas modifié.

Dans les squelettes

La boucle (ARTICLES_LIES) peut prendre le critère {type_liaison=clef} pour préciser le type de liaison souhaité. Par exemple pour lister les articles liés avec le type « connexe » [1].

<B_connexes>
<ol>
<BOUCLE_connexes(ARTICLES_LIES){id_article}{type_liaison=connexe}{par rang}>
<li><a href="#URL_ARTICLE{#ID_ARTICLE_LIE}">#INFO_TITRE{article,#ID_ARTICLE_LIE}</a></li>
</BOUCLE_connexes>
</ol>
</B_connexes>

Par ailleurs on dispose au sein de la boucle (ARTICLES_LIES)de la balise #TYPE_LIAISON, sur lequel on peut appliquer le filtre |a2a_traduire_type_liaisons pour obtenir le titre du type de liaison (par exemple « Article connexe » pour le type « connexe »).

On peut également utiliser #TYPES_LIAISONS en combinaison avec la boucle (DATA) de SPIP 3 pour lister les types de liaisons. Ainsi, pour afficher tout les articles liés en séparant les types de liaisons :

<BOUCLE_types_liaisons(DATA){source tableau, #TYPES_LIAISONS}>
<B_articles_lies>
[<h2>(#CLE|a2a_traduire_type_liaisons)</h2>]
<ol>
<BOUCLE_articles_lies(ARTICLES_LIES){id_article}{par rang}{type_liaison=#CLE}>
<li><a href="#URL_ARTICLE{#ID_ARTICLE_LIE}">#INFO_TITRE{article,#ID_ARTICLE_LIE}</a></li>
</BOUCLE_articles_lies>
</ol>
</B_articles_lies>
</BOUCLE_types_liaisons>

Enfin, la balise #ARTICLES_LIES peut prendre un deuxième argument précisant le type de liaison : #ARTICLES_LIES{'',connexe} ;
depuis la version 3.1.0, il en est de même pour la balise #ARTICLES_LIANT : #ARTICLES_LIANT{'',connexe}.