cocoda

Herramienta de mapeo de cocoda

Una herramienta basada en la web para crear asignaciones entre los sistemas de organización de conocimiento.

¡Pruebe la última versión de lanzamiento, la versión de desarrollo actual y consulte la documentación de uso!

Tabla de contenido

• Instalar
  • Lanzar versiones
  • Versiones de desarrollo
  • Sirviendo los archivos
  • Estibador
• Uso
• Configuración
• Mantenedores
• Contribuir
• Licencia

Instalar

Lanzar versiones

Los lanzamientos se pueden descargar en forma de archivos estáticos. Extraiga a un directorio de servidor web y ajuste el archivo de configuración cocoda.json . Puede automatizar la descarga y la extracción de la última versión con JQ así:

 # 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

El directorio cocoda está listo para ser servido con cualquier servidor web.

Versiones de desarrollo

Alternativamente, es posible clonar el repositorio de cocoda:

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

Luego instale los módulos de nodo requeridos con NPM y Ejecutar compilación (requiere Node.js V18 o arriba, V20 recomendado):

npm ci
npm run build

Los archivos se crean en Directory dist , incluido el archivo de configuración.

Sirviendo los archivos

Cualquier servidor web se puede usar para servir archivos de cocoda. No es necesaria una configuración especial. Por ejemplo, usando el paquete NPM http-server para servir cocoda en 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/

Estibador

Cocoda también está disponible a través de Docker. Consulte nuestra documentación de Docker para obtener más información e instrucciones.

Uso

Hay un manual de usuario final detallado disponible en alemán y en inglés. La versión alemana probablemente estará más actualizada. Las fuentes de documentación se encuentran en docs de directorio.

Configuración

Para la versión preconstruida, las opciones de configuración se pueden anular utilizando cocoda.json en la raíz del directorio. Las opciones predeterminadas se dan en el archivo config/cocoda.default.json (consulte este archivo para ver ejemplos sobre cómo usar las opciones de configuración). Cuando use una compilación manual, cree Archivo config/cocoda.json y reconstruya ( npm run build ) después de editar (también puede ejecutar npm run build -- --config-only si ya tiene una carpeta de compilación dist/ y solo necesita actualizar el archivo de configuración). Los siguientes campos se reconocen hasta ahora:

• Título : El título principal de la instancia como cadena simple

• Logotipos : una lista de logotipos para mostrar el título, cada uno con subcampos:

  • file : URL de imagen en relación con el directorio static
  • alt : texto alternativo para la imagen, si la imagen no se puede mostrar, como una cadena simple
  • url : URL para vincular desde el logotipo

• Menú : una lista de enlaces para mostrar en el menú, cada uno con subcampos:

  • url : la URL de enlace
  • prefLabel : mapeo de códigos de lenguaje para enlaces títulos

• SearchLinks : una lista de enlaces de búsqueda para vincular rápidamente los recursos externos de los conceptos. Cada SearchLink tiene subcampos:

  • url una plantilla de URL con posibles parámetros {prefLabel} y/o {notation}
  • prefLabel : mapeo de códigos de lenguaje para enlaces títulos

• FavoritosChemes : Lista de URI de vocabulario que se favorecerán por defecto.

• Idiomas : matriz con idiomas de interfaz compatibles

• Registros : enumera los registros de dónde obtener datos de

• OverderReGistries : false (predeterminado) o true controla si anular los registros enumerados en config/cocoda.default.json

• Auth : URL a una instancia de servidor de inicio de sesión para ser utilizada para la autenticación

• Listas de conceptos : una lista de listas de conceptos. Cada lista puede ser un objeto o una URL que devuelve un objeto JSON. Los objetos son básicamente registros JSKOS con propiedades requeridas prefLabel y concepts . Si concepts son una cadena, se considerará una URL que devuelve una serie de conceptos JSON. Las propiedades opcionales son notation y scopeNote .

• Autorefresh : un objeto con valores de actualización automática en milisegundos. autoRefresh.mappings determina con qué frecuencia se volverán a recargar los mapeos en MappingBrowser (predeterminado: 10000 = cada 10 segundos), autoRefresh.update determina con qué frecuencia COCODA buscará una actualización (predeterminada: 120000 = cada 2 minutos).

Utilizando la versión preconstruida, la aplicación solo debe ser recargada después de editar el archivo de configuración.

Mantenedores

• @stefandesu
• @Nichtich

Contribuir

Sus contribuciones para mejorar la cocoda son muy bienvenidas: ¡abra un problema de GitHub para sugerencias de características e informes de errores! Consulte el archivo que contribuye.md para obtener más información sobre cómo y dónde contribuir mejor y para obtener detalles de desarrollo.

Consulte https://gbv.github.io/cocoda/ para la documentación de API construir automáticamente a partir de fuentes de nodo.

Licencia

MIT © 2019 Verbundzentrale des GBV (VZG)