Skip to content

Latest commit

 

History

History
113 lines (73 loc) · 3.62 KB

README.md

File metadata and controls

113 lines (73 loc) · 3.62 KB
Raw

Dictionnaire des sigles

Version 1.4.0

=> https://dicosigles.fr

Utilisation

Pour combiner la base de sigles et les contributions dans data/sigles.csv

  1. remplir scripts/config.sh
  2. exécuter scripts/merge.sh
  3. si tout est bon, exéculter scripts/publish.sh

Pour ajouter des sigles au dictionnaire à partir d'un fichier CSV

Le fichier CSV importé doit avoir les champs attendus.

Pour comparer un fichier CSV de termes (en-têtes : id,term,definition,explanation, explanation peut être vide) avec data/sigles.csv :

./scripts/compareKeysWithDic.sh [fichier de termes] [nom de la source de ce fichier] [URL de la source]

Le script produit un fichier .new.csv à côté du fichier de termes contenant les termes qui ne sont pas encore présents dans data/sigles.csv (et dicosigles.fr).

Pour détecter les explications dans un fichier CSV de termes pouvant compléter des termes existants dans data/sigles.csv :

scripts/saveNewExplanations.sh [fichier de termes] [nom de la source de ce fichier] [URL de la source]

Format de fichier

Format d'import

Le fichier importé doit avoir les caractéritiques suivantes :

Séparateur : ";" ou ","

Colonnes obligatoires (dans n'importe quel ordre) :

  • term (obligatoire) : le sigle. Par exemple : CADES
  • definition (obligatoire) : la forme longue du sigle. Par exemple : Caisse d’amortissement de la dette sociale
  • url_source (obligatoire) : l'URL de la page page Web officielle où ce sigle est défini. Par exemple : https://www.cnle.gouv.fr/Sigles-de-l-Administration.html
  • source (obligatoire) : nom de la source. Par exemple : CNLE
  • explanation (optionnel) : définition du concept. Par exemple : La mission de la CADES est est de financer et d'éteindre la dette cumulée de la Sécurité Sociale.
  • url_source_explanation (obligatoire pour chaque explication) : https://www.cades.fr/fr/a-propos/mission-et-fonctionnement
  • source_explanation (obligatoire pour chaque explication) : nom de la source de l'explication. Par exemple : CADES.

Notes de version

1.4.0 (25/09/2024)

  • une bonne partie du merge est faite en python/pandas plutôt que bash/xsv
  • changement de l'URL d'API utilisée (csvapi => tabular-api)
  • suppression de l'iframe Matomo
  • correction de bugs dans le script getContributions.sh

1.3.2 (01/09/2020)

  • bug dans le script de fusion des sigles

1.3.1 (31/07/2020)

  • la largeur de la documentation s'adapte aux petits écrans
  • ajout d'une marge entre les <li> des sources
  • désactivation de l'import de markdown brut pour la documentation (les éléments HTML n'étaient pas interprétés)

1.3.0 (31/07/2020)

  • ajout d'un bouton pour copier un lien court vers la recherche dans le presse-papier

1.2.0 (28/07/2020)

  • script pour ajouter des sigles en masse avec dédoublonnage par clé (#20)
  • ajout de 688 sigles liés à la gendarmerie et à la police nationale (Merci Denis Merigoux !)
  • nombre total de termes injecté dans package.json pour affichage

1.1.1 (25/07/2020)

  • l'app ne gérait pas bien les colonnes supplémentaires (explanation, etc.)

1.1.0 (25/07/2020)

  • scripts d'aggrégation et de publication

1.0.0 (12/07/2020)

  • Première version, sans scripts d'aggrégation

Project setup

npm install

Compiles and hot-reloads for development

npm run serve

Compiles and minifies for production

npm run build

Lints and fixes files

npm run lint

Customize configuration

See Configuration Reference.