Skip to content

Latest commit

 

History

History
52 lines (33 loc) · 2.46 KB

File metadata and controls

52 lines (33 loc) · 2.46 KB

Artsdata Data Model

This is the Artsdata.ca Data Model project repository. It contains all the schemas, examples and software used to publish the Artsdata.ca Data Model Documentation. For the site itself, please see artsdata.ca instead.

Issues and proposals are managed with GitHub issues.

Most of the documentation is generated using the vocabulary from the original ontology (rdfs:label, rdfs:comment).

Examples are manually edited in the doc folder of this repository using Markdown.

To do: Add SHACL shapes for each class.

To do: Add ShEx shapes for mapping to Wikidata.

To generate documentation:

% cd _generators
% ruby generate.rb

Test on local machine

  1. bundle install
  2. source .github-token
  3. bundle exec jekyll serve or manually set the token JEKYLL_GITHUB_TOKEN=123 jekyll serve

more info: http://jekyll.github.io/github-metadata/authentication/

Formatting Controlled Vocabulary Turtle Files

The controlled vocabularies and ontologies are writting using turtle syntax. The turtle is often created in a Google Sheet and then copy/pasted into a file with extenion .ttl. For example skos-event-types.ttl.

All turtle files should be automatically formatted using bjdmeest.ttlformatter plugin in Visual Studio Code before being committed. This helps see changes between versions and keeps a standardized layout.

Public documentation pages

The Artsdata data model contains several public documentation pages intended for broad dissemination. They are created as markdown file (.md) and published as html documents. There are severa different sets of public pages, each one with a specific focus:

Collection Location Includes
Landing page, named index Root
Architecture _architecture Documents describing how data flows in and out of Artsdata
Classes _classes All top-level classes included in the data model
Controlled vocabularies Root event-types
Properties Root - location
- performer
- sameas
Identifiers guidelines Root - identifier-recommendations
- id
- sameas
- retrieve-uri
Structured data templates _gabarits-jsonld - README (Event)
- Organization
- Person

Translations

The naming convention for language versions of the same documentation page is :

  • English: No language subtag in the URL slug. Example: index.md.
  • Français: .fr language subtag inserted before the file extension. Example: index.fr.md.