plugin refbase

Présentation de refbase

refbase est une application libre et gratuite, écrite en PHP / MySQL, permettant de gérer une base de références bibliographiques en ligne.

refbase peut importer et exporter des références bibliographiques dans différents format (incluant BibTeX, EndNote, RIS, PubMed, ISI Web of Science, CSA Illumina, RefWorks, MODS XML, OpenOffice, and MS Word).

Il peut mettre en forme une liste de citations en HTML, RTF, PDF, or LaTeX, et il offre des outils puissants de recherche ainsi que la possibilité de transformer sa recherche en flux RSS.

Par ailleurs, il génère nativement des COinS ce qui permet, entre autres, d’importer très facilement des références avec l’excellent Zotero ou encore de récupérer facilement la version complète d’une référence à partir des technologies OpenURL [1].

Il est également possible de tester refbase en ligne : http://demo.refbase.net/.

Pré-requis et installation

Attention : ce plugin ne contient pas le logiciel refbase. Il permet simplement d’interroger une base de données refbase externe et d’afficher les résultats dans SPIP. Pour pouvoir utiliser ce plugin, vous devez donc disposer d’une installation externe de refbase. Si vous souhaitez simplement et facilement ajouter des références bibliographiques à vos articles, le plugin Cite : des modèles pour les références bibliographiques sera peut-être plus adapté.

La base refbase n’a pas besoin d’être installée sur le même serveur que SPIP.

Le comportement par défaut du plugin peut être configuré à l’aide du plugin cfg. Si le plugin cfg n’est pas indispensable au fonctionnement du plugin, son utilisation est fortement conseillée.

MÀJ : à partir de la version 2 (SPIP 3 minimum), le plugin CFG n’est plus nécessaire pour la configuration du plugin refbase. Le formulaire de configuration est directement accessible dans le menu Squelettes.

L’installation du plugin refbase est classique (voir la documentation officielle).

Le plugin refbase est développé sur SPIP-Zone et peut donc être récupéré par SVN.

Vous pouvez aussi récupérer le fichier ZIP (voir ci-contre) produit à partir de SPIP-Zone ou bien utiliser la fonction auto de SPIP 2.0.

Vos squelettes doivent intégrer la balise #INSERT_HEAD afin que soient appelés dans vos pages les styles css nécessaires au modèle et la fonction javascript utilisée pour déplier les blocs de la vue Citations.

Pourquoi ce plugin ?

refbase propose différents moyens pour intégrer des références dans son site web (voir http://www.refbase.net/index.php/In...), via une <iframe> (voir exemple ou en AJAX (voir exemple).

Cependant, une iframe ne s’intègre pas toujours de manière judicieuse dans une page web, notamment car on ne peut prédire sa taille à l’avance. Dans le cas du recours aux technologies AJAX, les COinS ne sont pas forcément détectés par le navigateur et, en particulier, par des outils tels que Zotero.

Ce plugin est né de l’objectif de fournir un modèle permettant d’insérer simplement dans un article une liste de références extraites de refbase en les intégrant directement dans le code HTML générés par SPIP. De fait, la liste apparaît comme faisant partie intégrante de la page. les COinS sont correctement détectés et la liste est indexée par les moteurs de recherche.

Configuration du comportement par défaut

À l’aide du plugin cfg, il est possible de configurer une liste de paramètres utilisés par défaut lors d’un appel au modèle <refbase>. Chacun de ses paramètres peut également être passé directement lors de l’appel du modèle. Une valeur passée directement au modèle a priorité sur la valeur par défaut.

On peut par exemple décider que par défaut les doublons ne sont pas affichés. Néanmoins, il est possible, dans un article donné par exemple, de forcer l’affichage des doublons en passant directement ce paramètre au modèle : <refbase|doublons=oui>.

url_refbase

Il s’agit de l’URL de la base refbase d’où sont extraites les références. Elle doit être fournie avec avec un http:// initial et un / final. Par exemple : http://demo.refbase.net/.

ATTENTION : si aucune URL par défaut n’a été définie avec CFG, il sera nécessaire de préciser ce paramètre à chaque appel du modèle.

vue

Quatre vues différentes sont possibles lors de l’affichage d’une liste de références. Ce paramètre accepte donc quatre valeurs possibles : citations (par défaut), liste, details et recap.

La vue recap étant particulière et nécessitant d’être accompagnée du paramètre par, elle n’est pas proposée dans la configuration par défaut avec cfg.

<refbase|vue=citations> produira :

Note : certains remarqueront un lien Check OpenResolver à côté des références. Ce lien est rajouté par l’extension OpenURL Referrer installée sur mon navigateur internet. Cela traduit la présence d’un COinS. En l’absence de cette extension, le lien sera simplement absent.

Dans la vue Citations, il y a sous chaque référence un bloc dépliable avec l’abstract de la référence, ses mots-clés et différentes options d’export. Voir un exemple ci-dessous :

<refbase|vue=liste> produira :

<refbase|vue=details> produira :

La vue recap permet de présenter un comptage des différentes références bibliographiques selon un champs donné qui doit être passé au modèle à l’aide du paramètre par. Le nom de ce champs doit correspondre à l’un des champs SQL de la base refbase (par exemple : author, publication, type, issue, series_title, created_date, edition, serial...).

<refbase|vue=recap|par=author> produira :

liens

À droite des citations sont affichés différents liens externes renvoyant vers différents outils en ligne (résolveur OpenURL, résolveur de DOI, version PDF en ligne...). Il est possible de ne pas afficher ces liens avec le paramètre liens=non.

<refbase|vue=citations|liens=non> produira :

max

Permet de spécifier le nombre maximum de références affichées. Prend un nombre entier comme valeur. Par exemple : <refbase|max=20>

doublons

Permet de spécifier les références entrées en double doivent être affichées ou non. Deux valeurs possibles : oui ou non.

tri

Spécifie l’ordre d’affichage des références. Cinq valeurs possibles :

• annee : tri par année décroissante.
• auteur : tri alphabétique par auteur.
• type : tri par type de références (articles, livres, chapitres, thèses...)
• type-annee : tri par type de références puis par année décroissante.
• date-creation : tri par date de création dans la base décroissante.

Exemple : <refbase|tri=annee> produira :

style

Ce paramètre n’a d’effet que sur la vue citations. Il précise le style de référence à utiliser. Les styles installés par défaut avec refbase sont :

• APA
• AMA
• MLA
• Chicago
• Harvard 1
• Harvard 2
• Harvard 3
• Vancouver
• Deep Sea res
• J Glaciol
• Mar Biol

Exemple : <refbase|style=MLA> produira :

liens_exports

Ce paramètre n’a d’effet que sur la vue citations. Il permet d’afficher ou de masquer le bloc dépliant avec l’abstract et les options d’exports. Deux valeurs possibles : oui ou non.

Exemple : <refbase|liens_exports=non> produira :

css

Les résultats importés depuis refbase sont englobés dans un <div> avec la classe refbasecss. Suivant vos squelettes, il est possible que le modèle soit affiché avec des caractères trop petits ou trop grands. Il est possible, avec le paramètre css, de passer des informations de style au <div> englobant.

Par exemple, pour afficher le texte du modèle dans une police plus grande, on pourra faire : <refbase|css=font-size:1.25em;>.

Les paramètres de sélection

Bien entendu, le plus souvent on ne souhaite pas afficher toutes les références de la base dans une sélection de celles-ci. Plusieurs paramètres de sélection sont disponibles.

voir

Le paramètre voir=tout permet de sélectionner toutes les références de la base.

auteur

Permet de sélectionner les références d’un auteur en particulier. <refbase|auteur=Einstein> sélectionnera toutes les références écrites par une personne s’appelant Einstein. En cas d’homonymie, on pourra préciser le prénom ainsi : <refbase|auteur=Einstein, Albert>.

institution

Permet d’afficher une bibliographie institutionnelle en passant au paramètre le sigle de l’institution. Par exemple : <refbase|institution=IPO>. Pour plus d’informations sur cette fonctionnalité, voir la documentation de refbase.

type

Permet de sélectionner un type de références. Le nom du type doit être entré en anglais tel qu’il apparaît dans refbase. Pour voir les différents types disponibles dans une base, aller dans la recherche avancée sur le site de la base en question. Les types les plus courants sont Journal Article, Book Whole, Book Chapter, Thesis...

Pour n’afficher que des articles de revue scientifique, on écrira <refbase|type=Journal Article>.

titre

Permet d’effectuer une recherche sur un ou plusieurs mots du titre. <refbase|titre=nucleotide> pour les références dont le titre contient nucleotide. On peut également transmettre une expression régulière. Ainsi, <refbase|titre=^nucleotide> ne renverra que les références dont le titre commence par nucleotide.

motcle

Sélectionne les références partageant le mot-clé entré.

journal

Sélectionne les articles parus dans une revue particulière. Par exemple, pour sélectionner les articles parus dans The Lancet : <refbase|journal=Lancet>.

identifiants

Chaque référence dispose d’un identifiant unique dans refbase. Cet identifiant est visible dans la vue details. Il s’agit du dernier champs, en bas à droite, intitulé Serial. L’identifiant d’une référence est également visible dans le lien permanent vers cette référence. En effet, ce lien permanent est de la forme show.php?record=1234 où 1234 est l’identifiant de la référence.

Le paramètre identifiants permet de sélectionner une ou plusieurs références à partir de leur identifiant. <refbase|identifiants=12> pour sélectionner la référence 12. <refbase|identifiants=12,18,54,35> pour sélectionner les références 12, 18, 35 et 54.

doi

Permet de sélectionner une référence à partir de son DOI. Par exemple : <refbase|doi=10.1002/Fps.1582>. On peut également passer uniquement une partie d’un DOI. <refbase|doi=10.1002> sélectionnera toutes les références dont le DOI contient 10.1002.

annee

Sélectionne les publications d’une année donnée. <refbase|annee=2005> sélectionnera toutes les publications parues en 2005.

depuis

Ce paramètre peut prendre deux formes :

• <refbase|depuis=2007> sélectionnera les références publiées à partir de 2007.
• <refbase|depuis=3ans> sélectionnera les références publiées cette année et les deux années précédentes.

where

Ce paramètre est le plus puissant. Il permet de réaliser des sélections avancées. Par exemple, pour sélectionner des chapitres d’ouvrage parus avant 2005 et dont le nom de l’auteur commence par un A on fera : <refbase|where=author RLIKE "^A" AND year < 2005 AND type RLIKE "Book Chapter">.

Le plus simple pour connaître la syntaxe à utiliser consiste à effectuer la recherche en question sur le site de la base refbase en question. Sur la page présentant les résultats de votre recherche, refbase vous proposera un lien vers un flux RSS correspondant à cette recherche. Ce lien sera de la forme http://mabaserefbase.net/rss.php?where=author RLIKE "^A" AND year < 2005 AND type RLIKE "Book Chapter"&showRows=5. Il suffit dès lors de recopier la valeur du paramètre where de l’URL.

Note : il est possible, pour ce paramètre, de lui passer directement une version « URL encodée ». Ainsi, l’exemple précédent devient : <refbase|where=author%20RLIKE%20%22%5EA%22%20AND%20year%20%3C%202005%20AND%20type%20RLIKE%20%22Book%20Chapter%22>.

Tableau récapitulatif des paramètres du modèle

Citer une seule référence

Il est également possible d’appeler le modèle de manière plus classique en lui passant un identifiant de référence, par exemple <refbase14225>. Dès lors, le modèle renvoie simplement la référence mise en forme et accompagnée d’un COinS. Le résultat est inséré dans le flux de texte. On obtient avec notre exemple :
Aalkjaer, C., & Cragoe, E. J. J. (1988). Intracellular pH regulation in resting and contracting segments of rat mesenteric resistance vessels. Journal of Physiology-London, 402, 391–410.

On peut également utiliser cette référence dans une note de bas de page. ATTENTION : l’écriture [[<refbase14225>]] ne fonctionnera pas mais produira : [2]. Il faut mettre du texte en début de note pour éviter que SPIP interprète le modèle comme le nom de l’appel de note. Un simple espace suffit.
Ainsi [[ <refbase14225>]] produira [3].
On peut également faire un appel de note personnalisé : [[<Aalkjaer 1998><refbase14225>]] produira [4].

Personnalisation

Il est possible de personnaliser la mise en forme du modèle en surchargeant le fichier refbase.css.

Syntaxe anglaise alternative

Afin que le modèle soit d’un usage simple pour les utilisateurs anglophones, les différents paramètres existent également dans leur forme anglaise. Dans cette version, nous avons privilégié l’API native de refbase (voir la documentation de refbase).

Si un même paramètre est passé au modèle à la fois sous sa forme française et sa forme anglaise, alors la forme anglaise est privilégiée.

Le tableau ci-dessous fournit la correspondance entre la syntaxe française et la syntaxe anglaise.

Aide à la saisie avec Insérer Modèles

Si le plugin Insérer Modèles est installé sur votre site, alors vous disposerez d’un formulaire vous permettant de générer l’appel au modèle dans vos articles.

Pour plus d’informations, voir la documentation du plugin Insérer Modèles.