tify-iiif-viewer / tify

TIFY is a slim and mobile-friendly IIIF document viewer.
GNU Affero General Public License v3.0
108 stars 27 forks source link

Add documentation for fulltext usage #121

Closed datazuul closed 2 years ago

datazuul commented 2 years ago

It is stated here https://www.sub.uni-goettingen.de/en/digital-library/digital-tools/dokumentbetrachter-tify/ and here https://github.com/tify-iiif-viewer/tify/blob/main/src/components/ViewFulltext.vue that fulltext is supported.

I can not find an example / demo of this functionality. Source code uses canvas otherContent annotation list to get fulltext. When I use a manifest with fulltext (hOCR), e.g. https://api.digitale-sammlungen.de/iiif/presentation/v2/bsb11475472/manifest I can not see any GUI element for fulltext toggling or showing?

Please add documentation and demo for fulltext view.

datazuul commented 2 years ago

I found a demo on the homepage "The Natural Method of Healing/Wellcome Collection". A "Fulltext" button is shown.

Please add documentation for this and how fulltext has to be embedded into manifests that it can be shown.

t11r commented 2 years ago

We may add more documentation regarding the IIIF manifest in the future. For now, please see the documentation for the IIIF Presentation API, the property used for fulltext is otherContent on any canvas. This is evaluated by TIFY at https://github.com/tify-iiif-viewer/tify/blob/main/src/components/ViewFulltext.vue#L34.

ipf commented 2 years ago

An example is here and this is the manifest where we used it