Skip to content

Latest commit

 

History

History
49 lines (30 loc) · 3.38 KB

README.md

File metadata and controls

49 lines (30 loc) · 3.38 KB
Raw

Crate-O RO-Crate Editor Mode File

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, organizations 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 Editor 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 a 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.

About Schema.org Style Schemas

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

Future Roadmap

We will be discussing:

  • How to improve the editing experience such as schema:CreateAction which link to multiple other entities, making them more complicated than simply linking to a schema: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.

Governance

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 Editor profiles, along the lines of the RO-Crate community process which takes place outside of any formal orgnizational framework.

Setup

PlantUML

Prerequisites:

  • Ensure that python is downloaded and added to your device's path

For anyone that wishes to edit PlantUML diagrams, such as in .md files, follow these steps:

  1. Install plantuml
  2. 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-editor-profiles/
    • (linux/mac) cp githooks/pre-commit .git/hooks, (windows) copy githooks/pre-commit .git/hooks
  3. Depending on your IDE, there may be a PlantUML extension available/plugin that allows for real time previewing of PlantUML diagrams, this is helpful whilst editing .puml files