Skip to content

Latest commit

 

History

History
42 lines (24 loc) · 2.76 KB

README.md

File metadata and controls

42 lines (24 loc) · 2.76 KB
Raw

controlled-vocabulary-template

Template repository for controlled vocabularies. The example controlled vocabulary is published as https://knowledge.c-innovationhub.com/my-controlled-vocabulary.

Prefix IRI
my-prefix: https://knowledge.c-innovationhub.com/my-controlled-vocabulary#

How to

Create a repository starting from this template repository. Rename the folders and the repository accordingly to the identifier of the controlled vocabulary. The new controlled vocabulary name should be used to replace my-controlled-vocabulary in all the places.

  1. The RDF files describing the controlled vocabularies can be defined manually or by modifying the template Excel file my-controlled-vocabulary.xlsx. Documentation on how to create more advanced Excel files can be found here.

  2. Download the tools as discussed below and put the JARs in the tools folder to automatise their execution through the run.sh script. A Java installation is required.

xls2rdf: Excel to RDF

Download release JAR from here and rename it as xls2rdf.jar. You can alternatively use the user interface available at https://skos-play.sparna.fr/play/convert. Documentation for the CLI tool is available here. The run.sh script was tested with version 2.2.0.

widoco: RDF to HTML

Download release JAR from here and rename it as widoco.jar. Documentation for the CLI tool is available here. The run.sh script was tested with version 1.4.21.

  1. Execute the sh run.sh x.y.z script providing as argument the correct version number. The version number should be the same declared in the Excel file.

  2. Edit the documentation in the sections folder

  3. Git commit and push

  4. Enable GitHub Pages to host the controlled vocabulary

  5. Configure a webserver by using the provided .htaccess file

Additional notes

  • If the taxonomy has more than one level, the skos-play-cli tool (link) can be used to generate a hierarchical visualisation of the taxonomy through the following command:
java -jar ./tools/skos-play-cli.jar hierarchical -i ./my-controlled-vocabulary/my-controlled-vocabulary.ttl -o ./my-controlled-vocabulary/hierarchy.html -f html -l en

The generated file should be manually added to or referred from the Widoco documentation.