Clarify name of ro-crate-js, related products and their repositories

[stain]

https://www.npmjs.com/package/ro-crate called ro-crate in NPM is the release of this library, in github called ro-crate-js https://github.com/UTS-eResearch/ro-crate-js

The installed bin/ script for generating HTML is called makehtml without reference to ro-crate.

The generated HTML from makehtml has a footer that claims a different name from either:

This file was created at 1618413083147 by Calcyte which implements the Draft RO-Crate format, version

Never mind the "Draft" comment, the footer link for Calcyte goes to https://code.research.uts.edu.au/eresearch/calcytejs calcytejs which has the tool calcyfy - using earlier DataCrate rather than RO-Crate? It says it is a port from the Python based https://codeine.research.uts.edu.au/eresearch/calcyte Calcyte

There is also https://github.com/UTS-eResearch/CalcyteJS repo which presumably is a mirror of the above.

ro-crate-html-js https://github.com/UTS-eResearch/ro-crate-html-js seems to be a tool that depends on this ro-crate library from NPM, but adds new commands rochtml rocstatic and rocschema - however their -h claims "Extracts data from a spreadsheet to make an RO crate" which is what I thought was Calcyte.

I think ro-crate-html-js is what is released as https://www.npmjs.com/package/ro-crate-html-js although that page calls it ro-crate and links back to this https://github.com/UTS-eResearch/ro-crate-js instead of https://github.com/UTS-eResearch/ro-crate-html-js

The outputs from ro-crate-html-js' ro-crate-html-js looks exactly like output of ro-crate-js' makehtml except it links to crate.js in a different way, and it no longer includes the static HTML fallback. As in #15 it is unclear what is license of the linked JS.

There is also https://www.npmjs.com/package/ro-crate-excel aka https://github.com/UTS-eResearch/ro-crate-excel aka ro-crate-excel which on NPM claims to be "Not published on npm yet" which provides the command xlro - this is I think an updated replacement of the older Calcyte?

So the product names so far are:

• ro-crate
• ro-crate-js
• makehtml
• Calcyte (footer)
• CalcyteJS
• calcyfy
• Calcyte (Python)
• crate.js
• ro-crate-html-js
• roc? (rochtml rocstatic rocschema)
• ro-crate-excel
• xlro

It is also unclear which of these products superseedes which, which are separate (like xlro), and which is responsible for the crucial crate.js.

I don't mind "-js" difference - obviously npm install ro-crate-js would be redundant!

But for anyone finding this it is very hard not knowing the history. Even for me it is hard to know which of these I should list on https://www.researchobject.org/ro-crate/tools/ under which name!

The installed binary script names should also somehow match the repo or pkg name, e.g. something less generic than makehtml.

So could we clarify the product names - updating READMEs and have right forward/back links would go a long way.

Tagging @ptsefton @spikelynch

[ptsefton]

Good point!

I will clean this all up.

First of all - the HTML generation in the core ro-crate-js library should be removed. Is it OK if I just delete it or should there be a period where it is deprecated in favour of using the tools in ro-crate-html?

Notes on all the names:

ro-crate -- Core RO-Crate library for loading/processing crates. This is reasonable name for an npm repository but does not match the git name (should we change this?)
ro-crate-js -- The git repo for the above
makehtml -- DEPRECATED
Calcyte (footer) -- DEPRECATED I will make sure references are removed
CalcyteJS -- DEPRECATED - will make sure there are no references from generated HTML and the repo is labelled
Calcyte (Python) -- DEPRECATED
crate.js -- This is the generated HTML file for rendering crates
ro-crate-html-js -- The name of the library that does HTML conversion for RO-Crate - depends on ro-crate
It actually has four scripts which I will attempt to document much better:

"rochtml": "roc-html.js", // Replaces makeHTML
"metacrate": "meta-crate.js", // Generates a crate that links to a set of crates in a directory
"rocstatic": "roc-static-html.js", // Creates a complete website for large crates - with plugin templates
"rocschema": "roc-schema.js", // Extracts schemas from crates - where they have Property and Class defs

ro-crate-excel -- Current - replacement for Calcyte - can round trip RO-Crate in and out of spreadsheets (could be used for much more than commandline operations)
xlro -- commandline interface to ro-crate-excel -- Should i change the name???

[ptsefton]

So @stain in the short term could you try using rochtml?