/hal-bibliography-integrator

Utilisation de l'API HAL pour générer une liste de publications sur une page web.

Primary LanguageJavaScriptGNU General Public License v3.0GPL-3.0

Intégrateur de bibliographie HAL

release docs tag license

Ce dépôt contient un module JavaScript qui facilite l'intégration de la bibliographie HAL d'un auteur ou d'une auteure dans un site web. Le code utilise l'API HAL pour récupérer les données et les présente dans un style similaire à celui du CV HAL. Le package propose également plusieurs plugins pour enrichir les informations affichées.

docs Static Badge

Tutoriel

Pour intégrer une bibliographie HAL dans un site munissez vous de l'idHal du chercheur ou de la chercheuse concerné(e).

  1. Téléchargez la dernière release et extrayer les fichiers hal.js et hal.css depuis le fichier "dist.zip".

  2. A l'endroit où vous souhaitez intégrer la bibliographie insérez le nœud HTML suivant

    <div id="hal-bibliography-integrator"></div>

  3. Dans le <head> de votre page, insérez le code suivant pour charger les ressources CSS :

    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.3.0/css/all.min.css" integrity="sha512-SzlrxWUlpfuzQ+pcUCosxcglQRNAq/DZjVsC0lE40xsADsfeQoEypE+enwcOiGjk/bSuGGKHEyjSoQ1zVisanQ==" crossorigin="anonymous" referrerpolicy="no-referrer" />
<link rel="stylesheet" href="./path/to/hal.css">

  4. (Optionnel) Si certain titres d'articles contiennent des expressions mathématiques, pour qu'il soient correctement formatés, ajoutez dans le <head> de votre page le code suivant

    <script>
    MathJax = {
        tex: {
            inlineMath: [['$', '$'], ['\\(', '\\)']],
            processEscapes: true,
            tags: "all"
        },
        svg: {
            fontCache: 'global'
        },
        loader: {
            load: ['[tex]/html']
        }
    };
</script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/3.2.2/es5/tex-svg.min.js" integrity="sha512-EtUjpk/hY3NXp8vfrPUJWhepp1ZbgSI10DKPzfd+3J/p2Wo89JRBvQIdk3Q83qAEhKOiFOsYfhqFnOEv23L+dA==" crossorigin="anonymous" referrerpolicy="no-referrer"></script>

  5. A la fin du <head> de votre page HTML, ajoutez le code suivant en configurant l'idHal cible et la liste des types de publications souhaitées (voir la liste des types pris en charge ci-dessous). La clé 'debug' permet d'afficher certaines informations du script dans la console du navigateur.

    <script type="text/javascript">
    const hal_integrator_config = {
       // idHal personnalisé
       "id": "timothee-schmoderer",
       // Liste des types de publications souhaités
       "typeList": ["THESE", "ART", "UNDEFINED", "COMM"],
       // (Optionnel: activation manuelle)
       "doit": false,
       // (Optionnel: mode de débogage)
       "debug": false,
     }
</script>

Remarque : Les différentes sections de publications apparaissent dans l'ordre défini par le tableau de la clé typeList.

  1. A la fin du <body> de votre page HTML, ajoutez la code suivant pour charger le script

     <script type="text/javascript" src="./path/to/hal.js"></script>

résultat

Liste des types de publications HAL pris en charge

Le tableau suivant donne les keywords a utiliser dans la clé typeList pour obtenir la liste complète des publications de ce type. La dernière colonne indique si le type est pris en charge par le module javascript:

Keyword Description Pris en charge Icon
ART Article de journal ✔️ fa-newspaper
COMM Communication dans un congrès ✔️ fa-microphone
COUV Chapitre de livre ✔️ fa-book
THESE Thèse ✔️ fa-graduation-cap
OUV Livre ✔️ fa-book
UNDEFINED Preprint, document de travail ✔️ fa-file-pen
REPORT ? ❌
OTHER ? ❌
MEM ? ❌
IMG Image ❌
POSTER Poster de conférence ✔️ fa-image
ISSUE ? ❌
PROCEEDINGS Proceedings ✔️ fa-file
HDR Habilitation à diriger des recherche ❌
NOTICE ? ❌
PATENT Brevet ✔️ fa-lightbulb
BLOG ? ❌
REPORT_LABO ? ❌
VIDEO Vidéo ❌
REPORT_MAST ? ❌
LECTURE Cours ✔️ fa-book-open
REPORT_LPRO ? ❌
REPORT_LICE ? ❌
TRAD ? ❌
SOFTWARE Logiciel ✔️ fa-microchip
CREPORT ? ❌
PRESCONF ? ❌
REPORT_DOCT ? ❌
REPORT_ETAB ? ❌
MAP ? ❌
SON ? ❌
REPORT_FORM ? ❌
REPORT_GMAST ? ❌
OTHERREPORT ? ❌
NOTE ? ❌
SYNTHESE ? ❌
REPORT_FPROJ ? ❌
REPORT_GLICE ? ❌
REPACT ? ❌
MEMLIC ? ❌
REPORT_RFOINT ? ❌
REPORT_COOR ? ❌
ETABTHESE ? ❌
REPORT_RETABINT ? ❌
MANUAL ? ❌
DOUV ? ❌

Ajouter le support de nouveaux types

Pour ajouter le support d'un nouveau type de publication, suivez les étapes ci-dessous :

  1. Clonez ce dépôt git.
  2. Ouvrez le fichier hal-utils.js dans le dossier local du dépôt.
  3. Dans la variable hal_helpers, ajoutez une nouvelle entrée pour le nouveau type de publication :
{
   "TYPE": {
       "icon": "classe de l'icône",
       "title_en": "titre de la section pour ce type de publication"
   }
}

Assurez-vous de remplacer "TYPE" par le mot-clé correspondant au nouveau type de publications. Spécifiez la classe de l'icône associée au type en utilisant une icône mise à disposition par Font Awesome. Fournissez également le titre de la section en anglais pour ce type de publications.

  1. Modifiez le fichier README.md en ajoutant dans le tableau ci-dessus le nouveau type pris en charge.
  2. Une fois que vous avez effectué les modifications, vous pouvez partager votre contribution en créant une pull request sur ce dépôt ou en envoyant la nouvelle version par e-mail à T. Schmoderer.

Limitations

  • Une seule section de publications, par page où le script hal.js est chargé, est permise.

Plugins

Ce package propose l'ajout de plugins pour étendre les fonctionnalités du module. L'exécution des plugins est automatique a partir du moment ou les scripts hal.js et hal-[plugin-name].js sont présents. Les plugins sont configurables a travers le dictionaire contenu dans la clé "plugins" de la variable hal_integrator_config :

<script type="text/javascript">
    const hal_integrator_config = {
        ...
       "plugins": {
         "plugin-name": {},
       }
     }
</script>

Voir la documentation pour le détail des options de configuration de chaque plugin.

Nuage de mots clés

Le plugin wordcloud permet d'intégrer un nuage de mots-clés associés à un auteur. Les mots-clés sont extraits des publications affichées par le module principal. Ainsi, pour utiliser ce plugin, il est nécessaire de suivre la procédure décrite dans le tutoriel ci-dessus pour intégrer le module principal. Néanmoins, si vous souhaitez afficher uniquement le nuage de mots sans les publications, vous pouvez simplement ajouter le style suivant :

<style>
  #hal-bibliography-integrator {display: none;}
<style>

wordcloud-light

Pour intégrer le nuage de mots-clés de l'auteur dans votre page, suivez les étapes suivantes :

  1. À l'endroit où vous souhaitez afficher le nuage de mots-clés, insérez le nœud HTML suivant :
<div id="hal-wordcloud-integrator"></div>
  1. Dans la section <head> de votre page, ajoutez le lien vers la feuille de styles spécifique au nuage de mots-clés. Assurez-vous de spécifier le chemin d'accès correct vers le fichier hal-wordcloud.css :
<link rel="stylesheet" href="./path/to/hal-wordcloud.css">
  1. À la fin de la section <body> de votre page, ajoutez le script suivant pour charger le fichier hal-wordcloud.js. Assurez-vous également de spécifier le chemin d'accès correct vers le fichier :
<script type="text/javascript" src="./path/to/hal-wordcloud.js"></script>

Métriques liées aux articles

Le plugin artscore (article score) ajoute des métriques aux publications de type ART (articles de journaux). Le plugin récupère des métriques du journal (SJR, quartile, h-index, CiteScore) ainsi que le nombre de citations d'après semantic scholar.

artscore-light

Pour activer le plugin, veuillez suivre les étapes suivantes :

  1. Assurez-vous d'avoir ajouté le module principal hal.js à votre site web en suivant les instructions du tutoriel.
  2. Dans la section <head> de votre page, ajoutez le lien vers la feuille de styles :
    <link rel="stylesheet" href="./path/to/hal-artscore.css">
  1. Pour récupérer les infos de scopus (pour obtenir la métrique CiteScore du journal) procurez-vous une clé d'API à ce lien puis configurez le plugin via la variable :
<script type="text/javascript">
const hal_integrator_config = {
           ...
          "plugins": {
             "artscore": {
                "scopus": {
                    "apiKey": "your-api-key",
                }
              }
          }
        }
</script>
  1. A la fin de la section <body>, ajoutez le lien vers le script du plugin :
    <script type="text/javascript" src="./path/to/hal-artscore.js"></script>

Warnings:

  • Seulement les éléments de type "ART" (article de journaux) sont traités.
  • Un certain nombre de problèmes liés à des données non trouvées peuvent être résolus en configurant manuellement le plugin, voir la documentation.