cocoda

Инструмент картирования Cocoda

Веб-инструмент для создания сопоставлений между системами организации знаний.

Попробуйте последнюю версию релиза, текущую версию разработки и проконсультируйтесь с документацией об использовании!

Оглавление

• Установить
  • Выпустить версии
  • Версии разработки
  • Обслуживание файлов
  • Докер
• Использование
• Конфигурация
• Содействия
• Способствовать
• Лицензия

Установить

Выпустить версии

Выпуски могут быть загружены в форме статических файлов. Извлеките в каталог веб -сервера и настройте файл конфигурации cocoda.json . Вы можете автоматизировать загрузку и извлечение последнего релиза с JQ, например:

 # 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

cocoda каталога готова к обслуживанию с любым веб -сервером.

Версии разработки

В качестве альтернативы, можно клонировать репозиторий Cocoda:

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

Затем установите необходимые модули узлов с NPM и запустите сборку (требуется node.js v18 или выше, v20 рекомендуется):

npm ci
npm run build

Файлы создаются в dist , включая файл конфигурации.

Обслуживание файлов

Любой веб -сервер может использоваться для обслуживания файлов cocoda. Специальная конфигурация не требуется. Например, используя пакет NPM http-server для обслуживания 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. Пожалуйста, обратитесь к нашей документации Docker для получения дополнительной информации и инструкций.

Использование

На немецком и английском языке доступно руководство для конечного пользователя. Немецкая версия, скорее всего, будет более обновленной. Источники документации расположены в docs .

Конфигурация

Для предварительно построенной версии параметры конфигурации могут быть переопределены с помощью cocoda.json в корне каталога. Параметры по умолчанию приведены в файле config/cocoda.default.json (пожалуйста, обратитесь в этот файл для примеров о том, как использовать параметры конфигурации). При использовании ручной сборки создайте файл config/cocoda.json и восстановление ( npm run build ) после редактирования (вы также можете запустить npm run build -- --config-only если у вас уже есть сборка в папке dist/ и вам нужно обновить файл конфигурации). Следующие поля признаны до сих пор:

• Название : Основное название экземпляра как простая строка

• Логотипы : список логотипов для отображения, оставленного на заголовке, каждый с подполя:

  • file : URL -адрес изображения относительно static каталога
  • alt : альтернативный текст для изображения, если изображение не может быть отображен, как простая строка
  • url : URL для ссылки из логотипа

• Меню : список ссылок, чтобы показать в меню, каждая из которых с подполя:

  • url : URL ссылки
  • prefLabel : отображение языковых кодов в заголовки ссылок

• SearchLinks : список поисковых ссылок, чтобы быстро ссылаться на внешние ресурсы из концепций. У каждого SearchLink есть подполя:

  • url шаблон URL с возможными параметрами {prefLabel} и/или {notation}
  • prefLabel : отображение языковых кодов в заголовки ссылок

• фавориты : список словарного запаса URI, который будет любимым по умолчанию.

• Языки : массив с поддерживаемыми языками интерфейса

• Реестры : перечисляет реестры, откуда получить данные

• Переопределение лигин : false (default) или true элементы управления переопределениями реестров, перечисленных в config/cocoda.default.json

• AUTH : URL в экземпляр логин-сервера, который будет использоваться для аутентификации

• Концептуальные списки : список списков концепций. Каждый список может быть либо объектом, либо URL, который возвращает объект JSON. Объекты - это в основном реестры JSKOS с необходимыми свойствами prefLabel и concepts . Если concepts - это строка, она будет считаться URL, который возвращает массив концепций JSON. Дополнительные свойства - это notation и scopeNote .

• AutoreFresh : объект со значениями автоматического обновления в миллисекундах. autoRefresh.mappings определяет, как часто будут отображаться сопоставления в MappingBrowser (по умолчанию: 10000 = каждые 10 секунд), autoRefresh.update определяет, как часто Cocoda будет искать обновление (по умолчанию: 120000 = каждые 2 минуты).

Используя предварительно построенную версию, приложение должно быть перезагружено только после редактирования файла конфигурации.

Содействия

• @stefandesu
• @nichtich

Способствовать

Ваш вклад в улучшение Cocoda очень приветствуется: пожалуйста, откройте проблему GitHub для предложений и отчетов об ошибках! См. Файл appling.md для получения дополнительной информации о том, как и где лучше всего вносить свой вклад и для деталей разработки.

См. Https://gbv.github.io/cocoda/ для документации API автоматически построить из источников узлов.

Лицензия

MIT © 2019 VERBUNDZENTRALE DES GBV (VZG)