cocoda

Ferramenta de mapeamento Cocoda

Uma ferramenta baseada na Web para criar mapeamentos entre os sistemas de organização do conhecimento.

Experimente a versão mais recente de lançamento, a versão atual de desenvolvimento e consulte a documentação de uso!

Índice

• Instalar
  • Libere versões
  • Versões de desenvolvimento
  • Servir os arquivos
  • Docker
• Uso
• Configuração
• Mantenedores
• Contribuir
• Licença

Instalar

Libere versões

Os lançamentos podem ser baixados na forma de arquivos estáticos. Extraia um diretório de servidor da Web e ajuste o arquivo de configuração cocoda.json . Você pode automatizar o download e a extração do último lançamento com JQ como este:

 # 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

O diretório cocoda está pronto para ser servido com qualquer servidor da web.

Versões de desenvolvimento

Como alternativa, é possível clonar o repositório Cocoda:

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

Em seguida, instale os módulos de nós necessários com o NPM e execute a compilação (requer Node.js v18 ou acima, recomendado pelo V20):

npm ci
npm run build

Os arquivos são criados no diretório dist , incluindo o arquivo de configuração.

Servir os arquivos

Qualquer servidor da Web pode ser usado para servir arquivos Cocoda. Nenhuma configuração especial é necessária. Por exemplo, usando o pacote http-server NPM para servir Cocoda em 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 também está disponível via Docker. Consulte nossa documentação do Docker para obter mais informações e instruções.

Uso

Há um manual de usuário final de detecção disponível em alemão e em inglês. A versão alemã provavelmente estará mais atualizada. As fontes de documentação estão localizadas nos docs de diretório.

Configuração

Para a versão pré-criada, as opções de configuração podem ser substituídas usando cocoda.json na raiz do diretório. As opções padrão são fornecidas no arquivo config/cocoda.default.json (consulte este arquivo para obter exemplos sobre como usar as opções de configuração). Ao usar uma compilação manual, crie o arquivo config/cocoda.json e Rebuild ( npm run build ) após a edição (você também pode executar npm run build -- --config-only se você já tiver uma compilação na pasta dist/ e precisará atualizar apenas o arquivo config). Os seguintes campos são reconhecidos até agora:

• Título : O título principal da instância como string simples

• LOGOS : Uma lista de logotipos para exibir deixado para o título, cada um com subcampos:

  • file : URL da imagem em relação ao diretório static
  • alt : texto alternativo para a imagem, se a imagem não puder ser exibida, como string lisa
  • url : URL para vincular o logotipo

• MENU : Uma lista de links para mostrar no menu, cada um com subcampos:

  • url : o URL do link
  • prefLabel : Mapeamento de códigos de linguagem para vincular títulos

• SearchLinks : Uma lista de links de pesquisa para vincular -se rapidamente a recursos externos de conceitos. Cada Searchlink tem subcampos:

  • url Um modelo de URL com possíveis parâmetros {prefLabel} e/ou {notation}
  • prefLabel : Mapeamento de códigos de linguagem para vincular títulos

• FavoritosChemes : Lista de Uris de vocabulário a ser favorecido por padrão.

• Idiomas : Matriz com linguagens de interface suportadas

• registros : lista os registros onde obter dados de

• Overideregistries : false (padrão) ou true controla se deve substituir os registros listados em config/cocoda.default.json

• Auth : URL para uma instância de login-server a ser usada para autenticação

• Listas de conceitos : uma lista de listas de conceitos. Cada lista pode ser um objeto ou um URL que retorne um objeto JSON. Os objetos são basicamente os registros JSKOS, com as propriedades necessárias prefLabel e concepts . Se concepts forem uma corda, ela será considerada um URL que retornará uma variedade de conceitos JSON. Propriedades opcionais são notation e scopeNote .

• AutoreFresh : um objeto com valores de atualização automática em milissegundos. autoRefresh.mappings determina com que frequência os mapeamentos no MappingBrowser serão recarregados (padrão: 10000 = a cada 10 segundos), autoRefresh.update determina a frequência com que o cocoda procurará uma atualização (padrão: 120000 = a cada 2 minutos).

Usando a versão pré-criada, o aplicativo deve ser recarregado após a edição do arquivo de configuração.

Mantenedores

• @stefandesu
• @nichtich

Contribuir

Suas contribuições para melhorar o Cocoda são muito bem -vindas: Abra um problema do GitHub para sugestões de recursos e relatórios de bugs! Consulte o arquivo contribuindo.md para obter mais informações sobre como e onde melhor contribuir e para obter detalhes de desenvolvimento.

Consulte https://gbv.github.io/cocoda/ para documentação da API construir automaticamente a partir de fontes de nó.

Licença

MIT © 2019 verbundzentrale des gbv (vzg)