digirati-co-uk / iiif-manifest-editor

Create new IIIF Manifests. Modify existing manifests. Tell stories with IIIF.
https://manifest-editor.digirati.services/
MIT License
33 stars 2 forks source link

Embeddable on separate tools like IIIF Workbench #21

Open glenrobson opened 2 years ago

glenrobson commented 2 years ago

As part of the IIIF training we have developed a tool for attendees to upload IIIF resources to GitHub. The tool is available at:

https://workbench.gdmrdigital.com

and an example repository:

https://github.com/iiif-test/Space/

We would like to embed the Manifest editor into this tool so users can create their manifest and then save it into the 'workbench'. This would require:

tomcrane commented 2 years ago

See https://github.com/digirati-co-uk/iiif-manifest-editor/discussions/10 and #26 and https://github.com/digirati-co-uk/iiif-manifest-editor/issues/1#issuecomment-980058865

We need to resolve the issue of:

glenrobson commented 2 years ago

I think its bullet 2 we are after. Being able to configure an endpoint to post JSON to.

There has been some discussion on a shared github layout for apps which write manifests and images to GitHub which might be an alternative option i.e. Manifest editor writes to a certain github location and workbench can show them but it would be easier for us if we can configure or host a manifest editors to post to Workbench which can put it in the correct (for us) location.

tomcrane commented 2 years ago

There's now quite a bit in the Wiki about persistence of IIIF resources, e.g.,

https://github.com/digirati-co-uk/iiif-manifest-editor/wiki/Saving-IIIF https://github.com/digirati-co-uk/iiif-manifest-editor/wiki/Preview

We won't get all the options done for first release, but we will have this one - https://github.com/digirati-co-uk/iiif-manifest-editor/blob/main/docs/rfcs/001-iiif-sandbox.md

and we will have the extensibility for others to add more integrations.

tomcrane commented 2 years ago

Also a "spec" for how the Manifest Editor can integrate with IIIF-based persistence (e.g., POST to collection) https://github.com/digirati-co-uk/iiif-manifest-editor/wiki/REST-Protocol

Would that spec be a good integration point for you @glenrobson ?

glenrobson commented 2 years ago

After reading through the docs linked above I think I like the look of the iiif-sandbox service as an integration point. I could implement store/preview and store/permalink which would be available in a configured instance of the Manifest Editor embedded in our training workbench.

I could also use the REST-Protocol but currently most of the Collection and Manifest URLs I have to hand in workbench are for the GitHub pages versions of the manifests. But I could create a dummy / proxy collection URL which would support the REST functions.

Just looking through both options, the iiif-sandbox seems the easiest option to implement if both are available.

stephenwf commented 1 year ago

There is a set of packages exported that does allow this functionality. However it lacks documentation. Example with preview packages can be found here: https://codesandbox.io/p/sandbox/lucid-sara-cf8040?file=%2Fsrc%2FApp.tsx%3A13%2C1