From 218fa0f979f588364d9ad3dd197603dad4cf6de6 Mon Sep 17 00:00:00 2001 From: William Welling <8352733+wwelling@users.noreply.github.com> Date: Mon, 26 Sep 2022 13:59:53 -0500 Subject: [PATCH] Add examples and links to test mocks in README (#125) --- README.md | 217 +++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 214 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 947b21b..1233e1f 100644 --- a/README.md +++ b/README.md @@ -120,8 +120,219 @@ This service provides **IIIF** manifest generation from **DSpace RDF** and/or ** - [Installation][fedora-install] -
(back to top)
+
+Fedora PCDM RDF Example + +The following series of Fedora requests for PCDM RDF + +https://api-pre.library.tamu.edu/fcrepo/rest/bb/97/f2/3e/bb97f23e-803a-4bd6-8406-06802623554c/20/d5/bc/11/20d5bc11-1f51-487c-8ef6-00a5ece451aa/berger_cloonan_batch_5_objects/457 +``` + . + . + . + "Fancy Paper Company"^^ . + "fedoraAdmin"^^ . + . + "reformatted digital"^^ . + "In copyright; For more information see: http://rightsstatements.org/vocab/InC/1.0/"^^ . + "Surface application; Sprinkled; M5.D2.F5; Machine made; Section(s) from the Decorated and Decorative Paper Terms Thesaurus: VIII.I.1; Not signed; Not stamped; Not stickered; Not embossed; Paper darkened; somewhat brittle and fragile; slightly torn"^^ . + "Berger-Cloonan #466"^^ . + "1 sheet of red, gray, black and light brown sprinkled paper; 21.00 x 22.50 in."^^ . + "Decorative papers"^^ . + "sprinkling"^^ . + "fedoraAdmin"^^ . + "2022-01-27T18:18:54.551Z"^^ . + "2022-01-27T18:18:54.551Z"^^ . + "Paper"^^ . + "466"^^ . + "M5.D2.F5.A"^^ . + "StillImage"^^ . + "art reproduction"^^ . + "decorated papers"^^ . + "Multi-colored sprinkled papers"^^ . + . + . + . + "false"^^ . + . + . + . + . +``` + +https://api-pre.library.tamu.edu/fcrepo/rest/bb/97/f2/3e/bb97f23e-803a-4bd6-8406-06802623554c/20/d5/bc/11/20d5bc11-1f51-487c-8ef6-00a5ece451aa/berger_cloonan_batch_5_objects/457/orderProxies/page_0_proxy/fcr:metadata +``` + . + . + . + "fedoraAdmin"^^ . + "fedoraAdmin"^^ . + "2022-01-27T18:18:54.551Z"^^ . + "2022-01-27T18:18:54.551Z"^^ . + . + . + . + . + "false"^^ . + . + . +``` + +https://api-pre.library.tamu.edu/fcrepo/rest/bb/97/f2/3e/bb97f23e-803a-4bd6-8406-06802623554c/20/d5/bc/11/20d5bc11-1f51-487c-8ef6-00a5ece451aa/berger_cloonan_batch_5_objects/457/pages/page_0/fcr:metadata +``` + . + . + . + "fedoraAdmin"^^ . + "fedoraAdmin"^^ . + "2022-01-27T18:18:54.551Z"^^ . + "2022-01-27T18:18:54.551Z"^^ . + . + . + "false"^^ . + . + . + . +``` + +https://api-pre.library.tamu.edu/fcrepo/rest/bb/97/f2/3e/bb97f23e-803a-4bd6-8406-06802623554c/20/d5/bc/11/20d5bc11-1f51-487c-8ef6-00a5ece451aa/berger_cloonan_batch_5_objects/457/pages/page_0/files/fcr:metadata +``` + . + . + . + . + "fedoraAdmin"^^ . + "fedoraAdmin"^^ . + "2022-01-27T18:18:54.551Z"^^ . + "2022-01-27T18:18:54.551Z"^^ . + . + . + . + . + "false"^^ . + . + . +``` + +https://api-pre.library.tamu.edu/fcrepo/rest/bb/97/f2/3e/bb97f23e-803a-4bd6-8406-06802623554c/20/d5/bc/11/20d5bc11-1f51-487c-8ef6-00a5ece451aa/berger_cloonan_batch_5_objects/457/pages/page_0/files/00466.jpg/fcr:metadata +``` + . + . + . + "00466.jpg"^^ . + "fedoraAdmin"^^ . + "22601344"^^ . + "image/jpeg"^^ . + "fedoraAdmin"^^ . + "2022-01-27T18:18:54.551Z"^^ . + . + "2022-01-27T18:18:54.551Z"^^ . + "00466.jpg"^^ . + . + "false"^^ . + . + . + . +``` + +Will result in IIIF v2 presentation manifest + +``` +{ + "@context" : "http://iiif.io/api/presentation/2/context.json", + "@id" : "https://api-pre.library.tamu.edu/iiif-service/fedora/presentation/bb/97/f2/3e/bb97f23e-803a-4bd6-8406-06802623554c/20/d5/bc/11/20d5bc11-1f51-487c-8ef6-00a5ece451aa/berger_cloonan_batch_5_objects/457", + "@type" : "sc:Manifest", + "attribution" : [ "Fancy Paper Company", "In copyright; For more information see: http://rightsstatements.org/vocab/InC/1.0/" ], + "label" : [ "Berger-Cloonan #466", "466" ], + "logo" : "https://library.tamu.edu/assets/images/tamu-logos/TAM-PrimaryMarkB.png", + "metadata" : [ { + "label" : "identifier", + "value" : "466" + }, { + "label" : "contributor", + "value" : "Fancy Paper Company" + }, { + "label" : "subject", + "value" : [ "Decorative papers", "sprinkling" ] + }, { + "label" : "rights", + "value" : "In copyright; For more information see: http://rightsstatements.org/vocab/InC/1.0/" + }, { + "label" : "format", + "value" : "reformatted digital" + }, { + "label" : "type", + "value" : [ "Multi-colored sprinkled papers", "art reproduction", "decorated papers" ] + }, { + "label" : "title", + "value" : "Berger-Cloonan #466" + }, { + "label" : "relation", + "value" : "M5.D2.F5.A" + }, { + "label" : "extent", + "value" : "1 sheet of red, gray, black and light brown sprinkled paper; 21.00 x 22.50 in." + }, { + "label" : "medium", + "value" : "Paper" + }, { + "label" : "type", + "value" : "StillImage" + }, { + "label" : "context", + "value" : "bb/97/f2/3e/bb97f23e-803a-4bd6-8406-06802623554c/20/d5/bc/11/20d5bc11-1f51-487c-8ef6-00a5ece451aa/berger_cloonan_batch_5_objects/457" + } ], + "sequences" : [ { + "@id" : "https://api-pre.library.tamu.edu/iiif-service/fedora/sequence/bb/97/f2/3e/bb97f23e-803a-4bd6-8406-06802623554c/20/d5/bc/11/20d5bc11-1f51-487c-8ef6-00a5ece451aa/berger_cloonan_batch_5_objects/457", + "@type" : "sc:Sequence", + "canvases" : [ { + "@id" : "https://api-pre.library.tamu.edu/iiif-service/fedora/canvas/bb/97/f2/3e/bb97f23e-803a-4bd6-8406-06802623554c/20/d5/bc/11/20d5bc11-1f51-487c-8ef6-00a5ece451aa/berger_cloonan_batch_5_objects/457/pages/page_0", + "@type" : "sc:Canvas", + "height" : 9430, + "images" : [ { + "@id" : "https://api-pre.library.tamu.edu/iiif/2/8cabeecc-d4b6-3365-a075-bacc30d082e3/info.json", + "@type" : "oa:Annotation", + "motivation" : "sc:painting", + "on" : "https://api-pre.library.tamu.edu/iiif-service/fedora/canvas/bb/97/f2/3e/bb97f23e-803a-4bd6-8406-06802623554c/20/d5/bc/11/20d5bc11-1f51-487c-8ef6-00a5ece451aa/berger_cloonan_batch_5_objects/457/pages/page_0", + "resource" : { + "@id" : "https://api-pre.library.tamu.edu/iiif/2/8cabeecc-d4b6-3365-a075-bacc30d082e3/full/full/0/default.jpg", + "@type" : "dctypes:Image", + "format" : "image/jpeg", + "height" : 9430, + "service" : { + "label" : "Fedora IIIF Image Resource Service", + "profile" : "http://iiif.io/api/image/2/level0.json", + "@context" : "http://iiif.io/api/image/2/context.json", + "@id" : "https://api-pre.library.tamu.edu/iiif/2/8cabeecc-d4b6-3365-a075-bacc30d082e3" + }, + "width" : 8590 + } + } ], + "label" : "fedora:bb/97/f2/3e/bb97f23e-803a-4bd6-8406-06802623554c/20/d5/bc/11/20d5bc11-1f51-487c-8ef6-00a5ece451aa/berger_cloonan_batch_5_objects/457/pages/page_0", + "metadata" : [ { + "label" : "context", + "value" : "bb/97/f2/3e/bb97f23e-803a-4bd6-8406-06802623554c/20/d5/bc/11/20d5bc11-1f51-487c-8ef6-00a5ece451aa/berger_cloonan_batch_5_objects/457/pages/page_0" + } ], + "width" : 8590 + } ], + "label" : [ "Berger-Cloonan #466", "466" ] + } ], + "thumbnail" : { + "@id" : "https://api-pre.library.tamu.edu/iiif/2/8cabeecc-d4b6-3365-a075-bacc30d082e3/full/!100,100/0/default.jpg", + "service" : { + "label" : "Fedora IIIF Image Resource Service", + "profile" : "http://iiif.io/api/image/2/level0.json", + "@context" : "http://iiif.io/api/image/2/context.json", + "@id" : "https://api-pre.library.tamu.edu/iiif/2/8cabeecc-d4b6-3365-a075-bacc30d082e3" + } + } +} +``` +
+> Please see [Mock Fedora PCDM RDF](https://github.com/TAMULib/IRIIIFService/tree/main/src/test/resources/mock/fedora/rdf) and [IIIF JSON](https://github.com/TAMULib/IRIIIFService/tree/main/src/test/resources/mock/fedora/json) for additional examples. + +
(back to top)
## Developer Documentation @@ -163,8 +374,8 @@ Copyright © 2022 Texas A&M University Libraries under the [MIT License][license [pcdm]: https://pcdm.org/ [iiif]: http://iiif.io/ -[iiif-presentation-api-v2]: http://iiif.io/api/presentation/2.1/) -[iiif-image-api-v2]: http://iiif.io/api/image/2.1/) +[iiif-presentation-api-v2]: http://iiif.io/api/presentation/2.1/ +[iiif-image-api-v2]: http://iiif.io/api/image/2.1/ [dspace]: http://www.dspace.org/ [dspace-install]: https://wiki.duraspace.org/display/DSDOC6x/Installing+DSpace#space-menu-link-content