https://github.com/ksclarke/jiiify-docs
Documentation for the Jiiify project.
https://github.com/ksclarke/jiiify-docs
documentation jiiify
Last synced: 6 months ago
JSON representation
Documentation for the Jiiify project.
- Host: GitHub
- URL: https://github.com/ksclarke/jiiify-docs
- Owner: ksclarke
- Created: 2021-05-22T01:11:53.000Z (about 5 years ago)
- Default Branch: gitbook
- Last Pushed: 2021-05-25T02:46:11.000Z (about 5 years ago)
- Last Synced: 2025-01-31T03:31:57.688Z (over 1 year ago)
- Topics: documentation, jiiify
- Homepage:
- Size: 27.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Introduction
Jiiify Presentation is a Java library for working with IIIF Presentation manifests and collections. There are different releases for IIIF Presentation [version 2](https://github.com/ksclarke/jiiify-presentation/tree/v2) and [version 3](https://github.com/ksclarke/jiiify-presentation/tree/v3). Though both versions are being used in production, version 3 is much more complete than version 2. Version 3 is also more actively developed at the moment.
The Jiiify Presentation library just contains an object model. It does not contain a server or IIIF client. It's intended to be used in servers, clients, or one-off scripts that need to work with presentation manifests and collections. Because Jiiify Presentation is written in Java and runs on the JVM, it can also be used in Ruby scripts \(with the help of JRuby\) and Python scripts \(with the help of Jython\).
This guide attempts to show how one might use Jiiify Presentation by working through the [example recipes](https://iiif.io/api/cookbook/) that the IIIF Cookbook Committee is developing. These cookbook recipes illustrate how to use IIIF Presentation and this guide uses them to illustrate how to use Jiiify Presentation. The goal is to include examples in Java, Ruby, and Python.
Suggestions on how to improve this documentation are welcome. If you have a question or suggestion, feel free [create an issue](https://github.com/ksclarke/jiiify-presentation/issues) or [start a discussion](https://github.com/ksclarke/jiiify-presentation/discussions) on the GitHub project page.
This documentation is released under the [Creative Commons Attribution-ShareAlike 4.0 International Public License](https://creativecommons.org/licenses/by-sa/4.0/legalcode). The documentation's code examples are licensed under the [BSD 3-Clause License](https://opensource.org/licenses/BSD-3-Clause). The JSON documents in the documentation \(borrowed from the IIIF Cookbook\) are gifted to the public domain using the [CC0 Public Domain Dedication](https://creativecommons.org/publicdomain/zero/1.0/).