Thank you to the IIIF Community for their help with this pocket project. IIIF Maps and IIIF Maps TSG members provided valuable code review, functionality review, resource testing and feedback. IIIF Training with Glen Robson provided resources and user expectations. These factors are what make this useful.
The Navplace Viewer is built to support IIIF Presentation API Defined Types (Collection, Manifest, Range, Canvas) with the navPlace property. To supply a resource, provide the URL in the address bar by adding the IIIF Content State parameter ?iiif-content= or by using the prompts in the interface. The navPlace property contains GeoJSON-LD and is Linked Data 1.1 compliant.
Now in beta: the Annotation Viewer also supports W3C Web Annotation 'Annotation' and 'AnnotationPage' types! To supply a resource, head to annotation-viewer.html. You can provide the URL in the address bar by using the ?iiif-content= or ?data= URL parameters, or by using the prompts in the interface. It is expected that Annotations used will contain GeoJSON-LD bodies and be Linked Data 1.1 compliant.
To contribute (you will want to run this on localhost), read the Navplace Viewer Contributors Guide. If you are looking to fork and run your own Navplace Viewer, continue reading.
If you are tailoring the viewer for your specific needs and do not want to contribute to this original or you want to deploy your modifications immediately without waiting for a review then you should fork this repository into your GitHub space. It will run immediately if you deploy the fork using GitHub Pages (you will get a default URL right away), and you can assign your own DNS from there. If you want to contribute that modification to the original, pull request your changes to the main branch in this repository from your repository. Please attribute the original and offer free access to your fork as described by the README.
The viewer has a brute force standpoint when it comes to rendering these resources' geographic data on the web map. It will render ALL the navPlace properties it finds on the object supplied and its children (items or structures) and their children recursively. For example, if you supply a Manifest which has a navPlace property which contains 2 Canvas items that also contain the navPlace property, ALL 3 geographies will be rendered. If the Manifest contains the same geographic information as the Canvases, the data will be duplicated. See the Options section below to control this behavior.
The viewer will resolve all referenced values, or embedded object values missing key details like items. Going back to our previous example of the Manifest with two Canvases that all have a navPlace property. If the navPlace properties were referenced Feature Collections, they would be resolved and appear in the viewer. If the Canvas items were referenced, they would be resolved and checked for navPlace which would also be resolved if it were referenced. This logic applies recursively from the top level item (such as a Collection) through all children items. See the /tests/referenced/ directory for examples of referenced resources. They can be supplied to the viewer to see the functionality. See the Options section below to control this behavior.
You can toggle how the viewer functions by supplying URL parameters or marking the check boxes available in the UI below the web map.
- Limit navPlace Detection : Only use the navPlace properties on my top level object and its direct children. Don't search recursively through the Linked Data relationship hierarchy for all the navPlace properties. Its URL parameter is
digand isdig=trueby default. - Limit Resolved Resources: When you come across a referenced value string or object, don't resolve the URI. Don't resolve everything while going through the Linked Data relationship hierarchy. Its URL parameter is
resolveand isresolve=trueby default.
Click the icon on the top right of the web map for different basemaps to toggle between.
The following entries of a Feature's properties will be shown in the metadata pop ups.
- Language map
labelandsummary. If a string is detected, it will be converted to a language mapnoneentry. - URI
canvasormanifestwhich is theidof the resource containing thenavPlaceproperty. - JSON Array
thumbnailwhose objects contain the URI (idor@id) of the thumbnail image to appear in the pop up.
Here is an example Feature with these metadata properties
{
"id":"https://example.org/geojson/feature/2",
"type":"Feature",
"properties":{
"label":{
"en": ["An English label"],
"none": ["A language agnostic label. Que interesante."]
},
"summary":{
"en": ["An English summary"],
"it": ["Un riassunto Italiano"]
},
"manifest": "https://example.org/iiif/manifest/1",
"canvas": "https://example.org/iiif/canvas/1",
"thumbnail" : [{"id": "https://example.org/image/thumb.jpg"}]
},
"geometry":{
"type":"Point",
"coordinates":[-90.28, 38.62]
}
}Note that you can have more entries in a Feature's properties, but they will not be detected by this viewer and will not appear in the pop ups. However, this viewer is open source and yours to modify for your needs! See the function VIEWER.formatPopup in app.js or make an issue in the GitHub repository for consideration by open source software developers.
For all Presentation API 3 Defined Types if the Feature(s) from the navPlace property do not have a label and summary, they will be automatically set to the label and summary of the resource itself. ALL labels and summaries for ALL languages are shown.
For Manifests, if the Feature(s) from the navPlace property do not have a thumbnail, their thumbnail image will be the image from the first Canvas if one exists. If the Features do have the thumbnail property, the first one listed in the array will be used.
For Canvases, if the Feature(s) from the navPlace property do not have a thumbnail property, their thumbnail will be the image from the Canvas if one exists. If the Features do have the thumbnail property, the first one listed in the array will be used.
This thumbnail support does not apply to Ranges or Collections, as their structures are too complex to determine a single image to default to.
There is no automated metadata support for objects in the Annotation Viewer.
Primary Developer: Bryan Haberberger -- https://github.com/thehabes
© 2023 Research Computing Group at Saint Louis University
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, and/or sublicense, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
The Research Computing Group at Saint Louis University shall be credited for the original source code in all software distributions and publications.
The original source code remains freely and openly available. The repackaging and sale of the original source code is not allowed. This source code may be a part of other larger Software that is for sale, so long as that other Software contains the required attribution mentioned above.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.