cocoda

Outil de cartographie cocoda

Un outil Web pour créer des mappages entre les systèmes d'organisation des connaissances.

Essayez la dernière version de version, la version de développement actuelle et consultez la documentation d'utilisation!

Table des matières

• Installer
  • Versions de libération
  • Versions de développement
  • Servir les fichiers
  • Docker
• Usage
• Configuration
• Maintient
• Contribuer
• Licence

Installer

Versions de libération

Les versions peuvent être téléchargées sous forme de fichiers statiques. Extraire dans un répertoire de serveur Web et ajuster le fichier de configuration cocoda.json . Vous pouvez automatiser le téléchargement et l'extraction de la dernière version avec JQ comme ceci:

 # You can also manually download the latest release here: https://github.com/gbv/cocoda/releases/latest
wget -N $( curl -s https://api.github.com/repos/gbv/cocoda/releases/latest | jq -r ' .assets[].browser_download_url ' )
unzip cocoda- * .zip
rm cocoda- * .zip

Le répertoire cocoda est alors prêt à être servi avec n'importe quel serveur Web.

Versions de développement

Alternativement, il est possible de cloner le référentiel de cocoda:

git clone https://github.com/gbv/cocoda.git
cd cododa

Ensuite, installez les modules de nœud requis avec NPM et exécutez la construction (nécessite Node.js v18 ou supérieur, v20 recommandé):

npm ci
npm run build

Les fichiers sont créés dans le Distory dist , y compris le fichier de configuration.

Servir les fichiers

Tout serveur Web peut être utilisé pour desservir les fichiers COCODA. Aucune configuration spéciale n'est nécessaire. Par exemple, l'utilisation du package NPM http-server pour servir COCODA à http: // localhost: 8000:

 # serve the pre-built release
npx http-server -p 8000 cocoda/
# or serve the build version
npx http-server -p 8000 dist/

Docker

Cocoda est également disponible via Docker. Veuillez vous référer à notre documentation Docker pour plus d'informations et d'instructions.

Usage

Il existe un manuel de l'utilisateur final détourné disponible en allemand et en anglais. La version allemande sera probablement plus à jour. Les sources de documentation sont situées dans docs d'annuaire.

Configuration

Pour la version prédéfinie, les options de configuration peuvent être remplacées en utilisant cocoda.json à la racine du répertoire. Les options par défaut sont données dans le fichier config/cocoda.default.json (veuillez consulter ce fichier pour des exemples sur la façon d'utiliser les options de configuration). Lorsque vous utilisez une version manuelle, créez un fichier config/cocoda.json et reconstruire ( npm run build ) après l'édition (vous pouvez également exécuter npm run build -- --config-only si vous avez déjà une build dans le dossier dist/ et seulement pour mettre à jour le fichier de configuration). Les champs suivants sont reconnus jusqu'à présent:

• Titre : Le titre principal de l'instance comme une chaîne simple

• Logos : une liste de logos à afficher à gauche au titre, chacun avec des sous-champs:

  • file : URL de l'image par rapport au répertoire static
  • alt : texte alternatif pour l'image, si l'image ne peut pas être affichée, comme une chaîne simple
  • url : URL pour lier le logo

• Menu : une liste de liens à afficher dans le menu, chacun avec des sous-champs:

  • url : l'URL de liaison
  • prefLabel : cartographie des codes linguistiques pour lier les titres

• SearchLinks : une liste de liens de recherche pour lier rapidement les ressources externes à partir de concepts. Chaque recherche de recherche a des sous-champs:

  • url un modèle d'URL avec des paramètres possibles {prefLabel} et / ou {notation}
  • prefLabel : cartographie des codes linguistiques pour lier les titres

• FavorisChemes : Liste des URI de vocabulaire à être favorisée par défaut.

• Langues : tableau avec interface prise en charge langues

• Registries : répertorie les registres où obtenir des données

• OverRideRegistries : false (par défaut) ou true contrôles de dépôt de dépassements répertoriés dans config/cocoda.default.json

• Auth : URL vers une instance de connexion à utiliser pour l'authentification

• Conceptlists : une liste de listes de concepts. Chaque liste peut être un objet ou une URL qui renvoie un objet JSON. Les objets sont essentiellement les registres JSKOS avec les propriétés requises prefLabel et concepts . Si concepts sont une chaîne, il sera considéré comme une URL qui renvoie un tableau JSON de concepts. Les propriétés facultatives sont notation et scopeNote .

• Autorefresh : un objet avec des valeurs de rafraîchissement automatique en millisecondes. autoRefresh.mappings détermine à quelle fréquence les mappages dans MappingBrowser seront rechargés (par défaut: 10000 = toutes les 10 secondes), autoRefresh.update détermine la fréquence à laquelle Cocoda recherchera une mise à jour (par défaut: 120000 = toutes les 2 minutes).

À l'aide de la version prédéfinie, l'application doit être rechargée après la modification du fichier de configuration.

Maintient

• @stefandesu
• @nichtich

Contribuer

Vos contributions pour améliorer la cocoda sont les bienvenues: veuillez ouvrir un problème GitHub pour les suggestions de fonctionnalités et les rapports de bogues! Consultez le fichier contributing.md pour plus d'informations sur la façon et le meilleur contribution de contribuer et pour les détails du développement.

Voir https://gbv.github.io/cocoda/ Pour la documentation de l'API construire automatiquement à partir des sources de nœuds.

Licence

MIT © 2019 Verbundzentral des GBV (VZG)