voc4cat-tool Documentation

A toolbox for collaboratively maintaining SKOS vocabularies on GitHub using Excel (xlsx-files) as a user-friendly interface.

What is voc4cat-tool?

voc4cat-tool is a command-line tool that enables:

• Bidirectional conversion between Excel (xlsx) and SKOS/RDF (turtle) formats

• Validation with SHACL profiles and additional consistency checks

• Vocabulary metadata management via configuration files

• ID range allocation for contributors for opaque URIs

• Extract provenance information from git history

• HTML documentation generation from SKOS/RDF vocabularies

It is part of the voc4cat ecosystem:

• voc4cat-tool (this package) - The command-line conversion and validation tool

• voc4cat-template - GitHub repository template with workflows for collaborative vocabulary projects

• voc4cat - A SKOS vocabulary for catalysis based on the template.

Getting Started

• Installation & Quickstart
  • Installation
  • Quickstart: Your first vocabulary
  • Next steps
• Core Principles
  • What is SKOS?
  • Key SKOS elements
  • The voc4cat approach
  • Learn more

User Guide

• Setting up a Vocabulary Project
  • Creating your repository
  • What’s included
  • Initial configuration
  • Generate your first vocabulary
  • Configure GitHub settings
  • Customize your project
  • Keeping in sync with the template
  • IRI design
  • Next steps
• Contributing to a Vocabulary
  • Overview
  • Get the current vocabulary
  • Make your changes
  • Request an ID range
  • Submit your contribution
  • Understand CI/CD feedback
  • Fix issues in your PR
  • What happens after merge
  • Typical edit cycle
  • See also
• Maintaining a Vocabulary
  • Reviewing pull requests
  • Creating releases
  • Managing gh-pages / documentation
  • Local testing
  • Keeping in sync with voc4cat-template
  • See also
• Running Workflows Locally
  • Prerequisites
  • Available commands
  • Typical local workflow
  • Troubleshooting
  • See also

Reference

• CLI Reference
• Schemas
• Migrating from 043 to v1.0
• Changelog