This repository is for the development of cross-application editor configurations, known as "Modes", that implement RO-Crate Profiles.
RO-Crate (Research-Object Crate) is linked-data based specification, based on JSON-LD syntax with an extensible Schema.org based vocabulary schema and @context
, for packaging data with metadata. RO-Crates are useful in a variety of contexts, including for describing research datasets for re-use and archiving, and for describing contextual information such as the relationships between people, organisations and events.
RO-Crate Profiles specify how to specialise the RO-Crate approach for a particular purpose or domain. They consist of (at least) a human-readable document, and optionally, validation services. An RO-Crate Mode File supplements an RO-Crate Profile with specific machine-readable instructions.
The configuration files contained in this repository, which we are calling "RO-Crate Modes", are intended to form the basis of an approach for describing RO-Crate editor behaviour and as a basis for validation.
Initial versions of this work were based on the Describo Profiles (which vary between versions of Describo) used to configure the Describo family of RO-Crate editing tools, currently maintained by Marco La Rosa.
Schema.org uses a very simple approach to defining its own schema, which is explained in this page about Schema.org style Schemas and RO-Crate Editor Profiles.
We will be discussing:
- How to improve the editing experience, such as
schema:CreateAction
, which links to multiple other entities, making them more complicated than simply linking to aschema:creator
. - Generating schemas, SHACL shapes or other schema languages such as OWL, in addition to the existing tooling for generating profiles from example documents and Schema.org style ontologies.
- Linking to RO-Crate Profile validation.
- Other: Let us know about your suggestions by raising an issue.
This repository is maintained by the Language Data Commons of Australia (LDaCA). If there is interest we will set up a series of ad hoc standardisation consultation meetings to help steer the development of RO-Crate Modes, along the lines of the RO-Crate community process which takes place outside of any formal organisational framework.
Prerequisites:
- Ensure that Python is downloaded and added to your device's path.
For anyone who wishes to edit PlantUML diagrams, such as in .md
files, follow these steps:
- Install plantuml
- Copy the pre-commit file from the githooks folder into
.git/hooks
- Navigate to the root of this repository:
cd (your directory path)/ro-crate-modes/
- (Linux/Mac):
cp githooks/pre-commit .git/hooks
- (Windows):
copy githooks/pre-commit .git/hooks
- Navigate to the root of this repository:
- To update images, run
plantuml docs/images/*.puml -tsvg
. Depending on your IDE, there may be a PlantUML extension/plugin available that allows for real-time previewing of PlantUML diagrams, which is helpful whilst editing.puml
files.