Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Stop pointing to playground & other readme fixes #38

Merged
merged 1 commit into from
Jan 25, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 12 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.8313341.svg)](https://doi.org/10.5281/zenodo.8313341)
[![](https://github.com/nfdi4cat/voc4cat/workflows/Publish/badge.svg)](https://github.com/nfdi4cat/voc4cat/actions)
[![](https://github.com/nfdi4cat/voc4cat/workflows/Build/badge.svg)](https://github.com/nfdi4cat/voc4cat/actions)
[<img src="https://www.w3.org/Icons/SW/Buttons/sw-skos-blue-v.svg" height="20" />](https://www.w3.org/TR/skos-primer/)
[<img src="https://www.w3.org/Icons/SW/Buttons/sw-skos-blue-v.svg" height="20" alt="SKOS logo" />](https://www.w3.org/TR/skos-primer/)

# A SKOS vocabulary for the catalysis disciplines

> **The first collection of terms was published in June 2023.**
> **Our goal is to grow the vocabulary to cover all subdisciplines of catalysis.**
>**Please join if you like to help. Everyone is welcome!**
> **Please join if you like to help.**

The vocabulary has been created and maintained as part of the [NFDI4Cat](http://www.nfdi4cat.org) initiative and follows our [Voc4Cat Guidelines](https://doi.org/10.5281/zenodo.7669183).

This repository was created from the template [voc4cat-template](https://github.com/nfdi4cat/voc4cat-template).
It uses the [voc4cat-tool](https://github.com/nfdi4cat/voc4cat-tool) and GitHub features like pull requests, gh-actions, gh-pages etc. to reduce the maintenance workload for contributors and editors.
It uses the [voc4cat-tool](https://github.com/nfdi4cat/voc4cat-tool) and GitHub features like pull requests, actions, pages etc. to reduce the maintenance workload for contributors and editors.

## Basic principles

Expand All @@ -22,21 +22,21 @@ We tried hard to make contributing easy. The process is essentially *(see furthe
- Edit the vocabulary file in Excel,
- Submit a pull request with the updated file placed in the folder `inbox-excel-vocabs`.<BR>It is important to keep the original file name `voc4cat.xlsx`.

After approval your pull request is ready to be merged by the editors. The merge will integrate your contribution into the SKOS-vocabulary files in the `vocabularies`-folder. Upon merge the corresponding documentation and a joined turtle file will be automatically built and published to gh-pages.
After approval your pull request is ready to be merged by the editors. The merge will integrate your contribution into the SKOS-vocabulary files in the `vocabularies`-folder. Upon merge the corresponding documentation and a joined turtle file will be automatically built and published to GitHub pages.

Besides this "in-development" version of the vocabulary, the latest released version and older releases are also available.

Links to specific versions:

- latest released version
- https://w3id.org/nfdi4cat/voc4cat
- "in-development" vesion (built from most recent commit to main)
- "in-development" version (built from most recent commit to main)
- `voc4cat` vocabulary documentation https://w3id.org/nfdi4cat/voc4cat/dev
- current and earlier releases identified by release date (the "v" before the data is optional)
- General scheme `https://w3id.org/nfdi4cat/voc4cat/{release-tag}`<BR>for example https://w3id.org/nfdi4cat/voc4cat/v2023-08-17

We have configured [content negotiation](https://en.wikipedia.org/wiki/Content_negotiation) for these urls.
So you can get the human readable HTML documentation but also the machine-readable turtle file of the vocabulary from the same url.
We have configured [content negotiation](https://en.wikipedia.org/wiki/Content_negotiation) for these URLs.
So you can get the human readable HTML documentation but also the machine-readable turtle file of the vocabulary from the same URL.
The IRI-design is described in detail in [iri-design.md](https://github.com/nfdi4cat/voc4cat/blob/main/iri-design.md).

To get the turtle file you may use tools like [curl](https://curl.se/) or [httpie](https://httpie.io/docs/cli) that allow to specify the content type. For example, to download the turtle file of the latest released version:
Expand All @@ -54,7 +54,7 @@ We also provide links to turtle files of individual concepts and collections:
- for releases by date-tag `https://w3id.org/nfdi4cat/voc4cat/{release-tag}/voc4cat_{NUMERIC-ID}.ttl`<BR>for example https://w3id.org/nfdi4cat/voc4cat/v2023-08-17/voc4cat_0000123

In addition to the specific versions, an [index page](https://nfdi4cat.github.io/voc4cat/) is generated that links to all tagged releases.
It is placed at the root of gh-pages.
It is placed at the root of the gh-pages branch.

To see how voc4cat rates in the [qSKOS](https://github.com/cmader/qSKOS) quality checks,
you can use this link to the [SKOS testing tool](http://skos-play.sparna.fr/skos-testing-tool/test?url=https://nfdi4cat.github.io/voc4cat/dev/voc4cat.ttl&rules=anr,chr,dcc,dlv,el,hr,husv,ilc,ipl,ml,mri,ncl,oc,oilt,ol,otc,rc,rrc,strc,tchbc,uc,ucil,urc&format=html).
Expand All @@ -65,12 +65,10 @@ To discuss about the **voc4cat**-vocabulary maintained here, create an [issue](h

To contribute new concepts or collections or change existing ones, you may either submit your contributions as Excel/xlsx-file or (as an expert) as new/changed turtle file.

> *To try out the workflow with some example data, you may use [voc4cat-playground](https://github.com/nfdi4cat/voc4cat-playground) which is almost identical to this repository but is not meant to last.*

Here are the steps for submitting updates in Excel.

- Get the Excel/xlsx-vocabulary file
- The most recent version of the vocabulary is always available via github-pages https://nfdi4cat.github.io/voc4cat/dev/voc4cat.xlsx
- The most recent version of the vocabulary is always available via GitHub-pages https://nfdi4cat.github.io/voc4cat/dev/voc4cat.xlsx
- Make changes to the Excel file. If you want to add something new you need to [request a range of IDs](https://github.com/nfdi4cat/voc4cat/issues/new/choose) for you.
- Add the xlsx file to your clone of the repository into the folder `inbox-excel-vocabs`
- The name of the file must match the vocabulary that you want to update. So do not change the filename, but keep `voc4cat.xlsx`.
Expand All @@ -93,16 +91,15 @@ See [inbox-excel-vocabs/README.md](inbox-excel-vocabs/README.md) for a minimal e

To discuss about the workflow for maintaining SKOS vocabularies based on this template, create an [voc4cat-template issue](https://github.com/nfdi4cat/voc4cat-template/issues).

To discuss about the tool that converts Excel to SKOS in gh-actions of this template, create an [voc4cat-tool issue](https://github.com/nfdi4cat/voc4cat-tool/issues).
To discuss about the tool that converts Excel to SKOS in GitHub-actions of this template, create an [voc4cat-tool issue](https://github.com/nfdi4cat/voc4cat-tool/issues).

## Contributors

For details see the Zenodo record.

**A big thanks to our GitHub contributors:**

<a href="https://github.com/nfdi4cat/voc4cat/graphs/contributors">
<img src="https://contrib.rocks/image?repo=nfdi4cat/voc4cat" />
<img src="https://contrib.rocks/image?repo=nfdi4cat/voc4cat" alt="Voc4Cat contributors"/>
</a>

*Figure made with [contrib.rocks](https://contrib.rocks).*
Expand All @@ -121,4 +118,4 @@ The template itself is CC0-1.0 licensed, see [LICENSE](LICENSE). Although there

This work was funded by the German Research Foundation (DFG) through the project "[NFDI4Cat](https://www.nfdi4cat.org) - NFDI for Catalysis-Related Sciences" (DFG project no. [441926934](https://gepris.dfg.de/gepris/projekt/441926934)), within the National Research Data Infrastructure ([NFDI](https://www.nfdi.de)) programme of the Joint Science Conference (GWK).

We thank the [W3ID Consortium](https://w3id.org) for making its permanent url service available to the community.
We thank the [W3ID Consortium](https://w3id.org) for making its permanent URL service available to the community.
Loading