Next-generation file format (NGFF) specifications for storing bioimaging data in the cloud.
Specifications are written in markdown, or technically bikeshed -- a markdown document, with special extensions understood by the bikeshed tool. The bikeshed tool is run on-commit via the spec-prod github action, generating the familiar "spec looking" ReSpec format. ReSpec is just html with a javascript ReSpec library.
Specification files end with the .bs file extension. The github action runs on commit to automatically convert to respec/html, via 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 to
latest/index.bs - Update changelog at the bottom of
latest/index.bs - Find references to previous version and in most cases, bump to the current version.
- copy
latest/index.bsto$VERSION/index.bs - copy
latest/copyright.includeto$VERSION/copyright.include - update the head matter in the
$VERSIONed file- Use:
Status: w3c/CG-FINAL - Update
URL: - Use the following
Status 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."
- Use:
- update the footer matter in the
$VERSIONed file- Version in the citation block including release date
- Update https://github.com/ome/spec-prod for the new version
Please see https://ngff.openmicroscopy.org/latest#citing for the latest citation.