cmu-openathens-doc/README.md

74 lines
2.8 KiB
Markdown
Raw Permalink Blame History

This file contains invisible Unicode characters!

This file contains invisible Unicode characters that may be processed differently from what appears below. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to reveal hidden characters.

---
title: OpenAthens par le CMU
subtitle: Comment utiliser OpenAthens aux HUG et à l'UNIGE
date: 2025-05-07T10:59:48+0200
id: 20250507105948
tags: ["cmu", "unige", "hug", "cmu", "openathens", "documentation"]
template_version: v0.2.0
---
# [OpenAthens par le CMU][1]
Ce projet rassemble la documentation produite par la Bibliothèque de l'UNIGE,
site CMU sur l'usage du protocole OpenAthens pour accéder à l'information
scientifique qui est derrière un *paywall* et est couverte par les licences et
les abonnements de la Bibliothèque.
Il faut noter que depuis janvier 2023, OpenAthens est *la* méthode pour cet
accès, car la reconnaissance par IP n'est plus possible.
## Contenu de la documentation
Cette documentation propose:
1. Des procédures détaillant les cas particuliers. Ce sont les fichiers `.md`
du dossier `source/`. Un cas particulier est ajouté à chaque fois qu'un ou
une lectrice signale un problème pour accéder à une ressource précise chez
un fournisseur (base de donnée, éditeur, revue).
1. Une méthode pour [ajouter un *bookmarklet* au navigateur web][3] pour
faciliter son usage.
## Édition et conversion
Pour éditer la source de la procédure du *bookmaklet*, il faut éditer le
fichier markdown correspondant: [`./source/bookmarklet.md`][3]. C'est la même
méthode pour les cas particuliers.
Pour la conversion du document, il faut installer les dépendances (voir la
section [*Requis*][4]) et utiliser les facilités du `Makefile`:
- `make html` ou `make <filename>.html` pour générer le ou les fichiers HTML
contenant les éléments d'interface de `pagedjs` pour la consultation dans un
navigateur web.
- `make watch TARGET=<filename>.html` permet de reconstruire automatiquement le
fichier chaque fois que des modifications du markdown, du template ou du CSS
sont enregistrées.
- `make serve` lance un serveur web local (avec python) pour charger le fichier
HTML produit par la commande précédente.
- `make` ou `make pdf` ou `make <filename>.pdf` converti au format PDF le ou
les fichiers markdown en utilisant `pagedjs`. Seuls les sources modifiées
sont reconstruites.
- `make clean` supprime les fichiers HTML lorsqu'ils ne sont plus utiles.
## Requis
Pour convertir les sources dans différents formats, et pour faciliter
l'édition, certains logiciels sont utiles, voire nécessaires:
- `pandoc` pour les conversion (obligatoire).
- `pagedjs-cli` pour la conversion au format PDF (obligatoire).
- `watchexec` pour observer les modifications sur des fichiers afin de relancer
une commande. C'est utile pour la commande `make watch TARGET=<filename>.md`
par exemple.
## Licence
Ce projet est sous [licence CC-BY-SA 4.0][2].
<!-- références -->
[1]: ./
[2]: ./LICENSE
[3]: ./source/bookmarklet.md
[4]: #requis