{"id":39882740,"url":"https://github.com/materialdigital/ontology_publication_template","last_synced_at":"2026-01-18T14:32:46.980Z","repository":{"id":208460216,"uuid":"721687051","full_name":"materialdigital/ontology_publication_template","owner":"materialdigital","description":null,"archived":false,"fork":false,"pushed_at":"2024-03-14T07:49:30.000Z","size":199,"stargazers_count":0,"open_issues_count":3,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-03-21T15:04:58.509Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc-by-4.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/materialdigital.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2023-11-21T15:11:47.000Z","updated_at":"2023-12-07T17:31:51.000Z","dependencies_parsed_at":"2023-11-21T16:42:23.655Z","dependency_job_id":"981a80a0-a0fe-44ec-b002-5e94620c83e3","html_url":"https://github.com/materialdigital/ontology_publication_template","commit_stats":null,"previous_names":["matttjung/ontology_publish","matttjung/ontology_publication_template"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/materialdigital/ontology_publication_template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/materialdigital%2Fontology_publication_template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/materialdigital%2Fontology_publication_template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/materialdigital%2Fontology_publication_template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/materialdigital%2Fontology_publication_template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/materialdigital","download_url":"https://codeload.github.com/materialdigital/ontology_publication_template/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/materialdigital%2Fontology_publication_template/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28537651,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-18T13:04:05.990Z","status":"ssl_error","status_checked_at":"2026-01-18T13:01:44.092Z","response_time":98,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-01-18T14:32:46.850Z","updated_at":"2026-01-18T14:32:46.940Z","avatar_url":"https://github.com/materialdigital.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# ontology_publication_template\n[![Check and deploy](https://github.com/materialdigital/ontology_publication_template/actions/workflows/workflow.yaml/badge.svg)](https://github.com/materialdigital/ontology_publication_template/actions/workflows/workflow.yaml)\n\n## Purpose\nThis repo contains a minimal example of how ontologies could be published using github-pages while maintaining availability of definition files and documentation for older versions.\n\n## Requirements as defined by HAP 4\nThe requirements are specified in [Technical requirements for ontologies](README.md#technical-requirements-for-ontologies) and [Additional requirements for publishing ontologies](README.md#additional-requirements-for-publishing-ontologies).\nThe file [ontology.ttl](ontology.ttl) is a turtle serialization of an example ontology that conforms to the requirements given in the table.\n\n## Key components\n### [ontology.ttl](ontology.ttl)\nThe definition file for an ontology, which is actively developed and thus changes its version number more or less frequently.\n\n### [.github/workflows/workflow.yaml](.github/workflows/workflow.yaml)\nA workflow definition that does the following steps on push to main and develop:\n\n1) Build the html documentation and the ontologies alternate serializations for the current version\n2) add the current versions documentation and serializations to gh-pages, maintaining other versions and replacing the same (current) version\n\n### [.htaccess_example](.htaccess_example)\nA example .htaccess file that takes care of finding the correct version and the latest version. Currently this file has to be edited for each new version (unfortunately gh-pages does not allow symlinks). It's meant to be used at some perma-id provider e.g. at [w3id.org](https://w3id.org).\n\n## Future work\n\n- The github release tool is not yet part of the deploy action. This might be desirable in the future.\n- A way for automatedly delivering the latest version without changing the .htaccess-file would be nice. One could simply store the versions folder in gh-pages twice (also using the name \"latest\").\n\n## Technical requirements for ontologies\n\n### Ontology metadata\n| Requirement | Description | Prefered property | Example |\n| ----------- | ----------- | ----------------- | ------- |\n| Title | Title of the ontology | `dcterms:title` | |\n| Author, Creator, Maintainer | Identification of the creator(s) or maintainer(s) of the ontology. Wherever possible use an ORCID | `dcterms:creator` | `\u003chttps://orcid.org/0000-0000-0000-0000\u003e` |\n| Creation Date | Date of creation of the ontology | `dcterms:created` | |\n| Version | Details about the version of the ontology, including updates and revisions. | `owl:versionInfo` **and** `owl:versionIRI` | |\n| Ontology Description and Scope | Clear and concise decription of the onotlogy and its scope. | `rdfs:comment` | |\n| Project | Identification of the projects creator(s) or maintainer(s) of the ontology. Include this in the rdfs:comment for \"Ontology description and scope\" | | |\n| License | Information about the licensing and usage rights of the ontology. If you have not thought about this before, we recommend to consider CC-BY-4.0 | `dcterms:license` | `\u003chttp://creativecommons.org/licenses/by/4.0/\u003e` |\n| How to cite | Provide a citation example for the ontology, e.g. a scientific paper you published about your ontology. | `dcterms:bibliographicCitation` | |\n\n### IRIs\n| Requirement | Description | Prefered property | Example |\n| ----------- | ----------- | ----------------- | ------- |\n| Namespace | A **unique** namespace for the ontology to avoid conflicts and ensure clear identification. | | https://w3id.org/pmd/new_ontology/ |\n| Dereferenceable IRIs | Internationalized Resource Identifiers (IRIs) should be dereferenciable for easy access and reference, if you have the capabilities to do so. | | |\n\n### IRIs\n| Requirement | Description | Prefered property | Example |\n| ----------- | ----------- | ----------------- | ------- |\n| Labels | Label of the classes and properties | `rdfs:label` or `skos:prefLabel` | |\n| Definitions | Clear and concise definitions for all terms, concepts, and relationships within the ontology. | `rdfs:comment` or `skos:description` | |\n\n## Additional requirements for publishing ontologies\n### General\n| Requirement | Description | Example |\n| ----------- | ----------- | ------- |\n| Documentation | Comprehensive documentation covering the ontology's purpose, scope, and structure. | |\n| Accessibility | Accessable through www, publicly available | https://github.com/materialdigital/ontology_publication_template |\n| Findability | Already published via scientific journal or terminology service or ontology repo or similar | |\n\n### Interoperability\n| Requirement | Description | Example |\n| ----------- | ----------- | ------- |\n| Top-Level grounding | To which top-level or mid-level is the ontology based on? | BFO, EMMO, PMDco, etc |\n| Concept reuse | From which other ontologies are concepts reused? | QUDT, CHEBI, etc. |\n| Format Standards | Serialize the ontology in RDF turtle. | ttl |\n| OWL Complexity | Is the ontology OWL-DL conform or does it use other OWL variants | |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaterialdigital%2Fontology_publication_template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmaterialdigital%2Fontology_publication_template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaterialdigital%2Fontology_publication_template/lists"}