diff --git a/affiliations-tools/README.md b/affiliations-tools/README.md new file mode 100644 index 0000000..e224777 --- /dev/null +++ b/affiliations-tools/README.md @@ -0,0 +1,161 @@ +# affiliations-tools + +L'instance `affiliations-tools` utilise l'application ezmaster +[`lodex-workers`](https://github.com/Inist-CNRS/lodex-workers). + +Elle offre plusieurs services autour des affiliations dans les notices bibliographiques: + +- `netscity`: donne des informations sur les villes envoyées (position + géographique, pays, province, ...) +- `rnsr`: déduit de l'adresse d'une affiliation d'auteur et d'une date de + publication (l'année suffit) zéro, un ou plusieurs identifiants RNSR + (correspondant à une ou plusieurs structures de recherche française(s)). + +Cet appariement suit des [règles +certaines](https://github.com/Inist-CNRS/ezs/blob/master/packages/conditor/README.md#r%C3%A8gles-certaines). + +## Configuration + +Il faut préciser dans le fichier de configuration de l'instance qu'elle utilise des paquets nodes: + +- `@ezs/analytics` +- `@ezs/basics` +- `@ezs/conditor` +- `@ezs/storage` + +Bien sûr, les dernières versions sont préférables. + +Exemple: + +```json +{ + "packages": [ + "@ezs/analytics@1.13.0", + "@ezs/basics@1.11.0", + "@ezs/conditor@2.4.1", + "@ezs/storage@1.5.3" + ] +} +``` + +## Utilisation + +- [v1/rnsr/csv](#v1%2frnsr%2fcsv) +- [v1/rnsr/json](#v1%2frnsr%2fjson) +- [v1/rnsr/conditor](#v1%2frnsr%2fconditor) + +### v1/rnsr/csv + +Prend un fichier CSV, avec des colonnes nommées `Adresse` et `Année`, et renvoie +un CSV avec la colonne supplémentaire `RNSR`. + +Les colonnes doivent être séparées par des tabulations, des points-virgules ou +des virgules. + +### Exemple CSV + +```bash +cat < *Remarque : Quand aucun identifiant n'est trouvé, un tableau vide est +> renvoyé.* + +### Paramètres de v1/rnsr/json + +| nom | description | +| ------ | -------------------------------------------------- | +| indent | `true` ou `false`, indente le JSON résultat ou non | + +### Exemple JSON + +```bash +cat <