Repository files navigation

Next-generation file format (NGFF) specifications for storing bioimaging data in the cloud.

Specifications are written in markdown, or technicallybikeshed -- a markdown document, withspecial extensions understood by the bikeshed tool. The bikeshed tool is runon-commit via thespec-prod github action,generating the familiar "spec looking" ReSpec format. ReSpec is just html witha javascript ReSpec library.

Specification files end with the .bs file extension. The github action runs oncommit to automatically convert to respec/html, via bikeshed.

Learn more about bikeshed

Commits on GitHub can be viewed using web services from the W3C:

• Rendered page:http://api.csswg.org/bikeshed/?url=https://raw.githubusercontent.com/ome/ngff/master/0.2/index.bs
• Diff:https://services.w3.org/htmldiff?doc1=https%3A%2F%2Fngff.openmicroscopy.org%2F0.2%2F&doc2=http%3A%2F%2Fapi.csswg.org%2Fbikeshed%2F%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fome%2Fngff%2Fmaster%2Flatest%2Findex.bs

• Make new changes tolatest/index.bs
• Update changelog at the bottom oflatest/index.bs
• Find references to previous version andin most cases, bump to the current version.

For each top-level metadata key of the OME-NGFF specification, JSON schemas are maintainedfor each version of the specification and stored under$VERSION/schemas/ orlatest/schemas/.Tests validating these schemas must be implemented to follow principles of theJSON schema test suiteand stored under$VERSION/tests/ orlatest/tests/ to allow their execution on each CI build.

All official example snippets must also be extracted and managed as separate JSON files under$VERSION/examples/ orlatest/examples/, validated by the appropriate schema by adding a.config.json file specifying the JSON schema to use and included in thespecification document using theinclude-code directive.

The official OME-NGFF JSON schemas are published underhttps://ngff.openmicroscopy.org//schemas/<schema_name>.schema using theSpec prod GitHub action. When a new JSON schema is introduced,this action needs to be reviewed to update the deployment script and allow the publicationof the schema.

• copylatest/index.bs to$VERSION/index.bs
• copylatest/copyright.include to$VERSION/copyright.include
• update the head matter in the$VERSIONed file
  • Use:Status: w3c/CG-FINAL
  • UpdateURL:
  • Use the followingStatus Text:: "This is the $VERSION release of this specification.Migration scripts will be provided between numbered versions. Data written with the latest version(an "editor's draft") will not necessarily be supported."
• update the footer matter in the$VERSIONed file
  • Version in the citation block including release date
• Updatehttps://github.com/ome/spec-prod for the new version

Please seehttps://ngff.openmicroscopy.org/latest#citing for the latestcitation.