Mercurial > hg > digilib
diff iiif-api.html @ 1640:1ae8b89d3a86
Creating site for 2.5-SNAPSHOT
| author | Robert Casties <casties@mpiwg-berlin.mpg.de> |
|---|---|
| date | Tue, 22 Aug 2017 16:38:19 +0000 |
| parents | |
| children | 16be3440305b |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/iiif-api.html Tue Aug 22 16:38:19 2017 +0000 @@ -0,0 +1,260 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2017-08-22 + | Rendered using Apache Maven Fluido Skin 1.3.0 +--> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> + <head> + <meta charset="UTF-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <meta name="Date-Revision-yyyymmdd" content="20170822" /> + <meta http-equiv="Content-Language" content="en" /> + <title>digilib - The Digital Image Library – The digilib IIIF API</title> + <link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" /> + <link rel="stylesheet" href="./css/site.css" /> + <link rel="stylesheet" href="./css/print.css" media="print" /> + + + <script type="text/javascript" src="./js/apache-maven-fluido-1.3.0.min.js"></script> + + + </head> + <body class="topBarDisabled"> + + + + <div class="container-fluid"> + <div id="banner"> + <div class="pull-left"> + <a href="./" id="bannerLeft"> + <h2>digilib - a versatile image viewing environment for the internet</h2> + </a> + </div> + <div class="pull-right"> <a href="./" id="bannerRight"> + <img src="images/digilib-logo-small.png" /> + </a> + </div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + + + <li id="publishDate">Last Published: 2017-08-22</li> + <li class="divider">|</li> <li id="projectVersion">Version: 2.5-SNAPSHOT</li> + + + + + </ul> + </div> + + + <div class="row-fluid"> + <div id="leftColumn" class="span3"> + <div class="well sidebar-nav"> + + + <ul class="nav nav-list"> + <li class="nav-header">Overview</li> + + <li> + + <a href="index.html" title="About digilib"> + <i class="none"></i> + About digilib</a> + </li> + + <li> + + <a href="features.html" title="digilib features"> + <i class="none"></i> + digilib features</a> + </li> + + <li> + + <a href="digilib-short.html" title="How digilib works"> + <i class="none"></i> + How digilib works</a> + </li> + + <li> + + <a href="history.html" title="Ancient history"> + <i class="none"></i> + Ancient history</a> + </li> + <li class="nav-header">Installation</li> + + <li> + + <a href="install-digilib.html" title="Installing digilib"> + <i class="none"></i> + Installing digilib</a> + </li> + + <li> + + <a href="build-maven.html" title="Building digilib"> + <i class="none"></i> + Building digilib</a> + </li> + <li class="nav-header">Configuration</li> + + <li> + + <a href="digilib-config.html" title="Configuring digilib"> + <i class="none"></i> + Configuring digilib</a> + </li> + + <li> + + <a href="image-directories.html" title="Directory layout"> + <i class="none"></i> + Directory layout</a> + </li> + + <li> + + <a href="java-settings.html" title="Java settings and tuning"> + <i class="none"></i> + Java settings and tuning</a> + </li> + + <li> + + <a href="auth.html" title="Access control"> + <i class="none"></i> + Access control</a> + </li> + <li class="nav-header">Development</li> + + <li> + + <a href="scaler-api.html" title="The digilib Scaler API"> + <i class="none"></i> + The digilib Scaler API</a> + </li> + + <li class="active"> + + <a href="#"><i class="none"></i>The digilib IIIF API</a> + </li> + + <li> + + <a href="client-integration.html" title="Integrating digilib into your page"> + <i class="none"></i> + Integrating digilib into your page</a> + </li> + + <li> + + <a href="plugins.html" title="Digilib plugins"> + <i class="none"></i> + Digilib plugins</a> + </li> + <li class="nav-header">Project Documentation</li> + + <li> + + <a href="project-info.html" title="Project Information"> + <i class="icon-chevron-right"></i> + Project Information</a> + </li> + </ul> + + + + <hr class="divider" /> + + <div id="poweredBy"> + <div class="clear"></div> + <div class="clear"></div> + <div class="clear"></div> + <a href="http://maven.apache.org/" title="Built by Maven" class="builtBy"> + <img class="builtBy" alt="Built by Maven" src="http://maven.apache.org/images/logos/maven-feather.png" /> + </a> + <a href="http://www.sourceforge.net/" title="Hosted by SourceForge" class="builtBy"> + <img class="builtBy" alt="Hosted by SourceForge" src="http://upload.wikimedia.org/wikipedia/commons/0/0b/Sourceforge_logo.png" /> + </a> + </div> + </div> + </div> + + + <div id="bodyColumn" class="span9" > + + <h1>The digilib IIIF API</h1> +<div class="section"> +<h2><a name="IIIF_Image_API"></a>IIIF Image API</h2> +<p>The Scaler servlet provides not only its native <a href="scaler-api.html">Scaler API</a> but also an API compliant to the standards of the International Image Interoperability Framework <a class="externalLink" href="http://iiif.io">http://iiif.io</a>.</p> +<p>As of version 2.3.7 digilib supports the <a class="externalLink" href="http://iiif.io/api/image/2.1/">IIIF Image API version 2</a> at <a class="externalLink" href="http://iiif.io/api/image/2.0/compliance.html">compliance level 2</a>. You can switch between API version 1.1 and 2.0 support with the <tt>iiif-api-version</tt> parameter in <a href="digilib-config.html">digilib-config</a>, </p> +<p>IIIF Image API URLs for an image request have the form:</p> + +<div class="source"> +<div class="source"> +<pre>http[s]://{server}/{digilib-webapp}/Scaler/{iiif-prefix}/{identifier}/{region}/{size}/{rotation}/{quality}.{format} +</pre></div></div> +<p>where <tt>digilib-webapp</tt> is the name of the digilib web application in the servlet container. </p> +<p>The value of <tt>iiif-prefix</tt> is defined by the <tt>iiif-prefix</tt> parameter in <a href="digilib-config.html">digilib-config</a>. The default value is “IIIF”.</p> +<p>The <tt>identifier</tt> part of the URL must not contain slashes. Since the identifier is mapped to the digilib fn-parameter, which is a filesystem path that likely contains slashes separating subdirectories, all occurrences of a slash have to be replaced by the value of the <tt>iiif-slash-replacement</tt> parameter in <a href="digilib-config.html">digilib-config</a>. The default value of the replacement string is “!”, so the fn-path “books/book1/page0002” becomes the identifier “books!book1!page0002”.</p> +<p>For a definition of the other parameters <tt>region</tt>, <tt>size</tt>, <tt>rotation</tt>, <tt>quality</tt>, and <tt>format</tt> please see the <a class="externalLink" href="http://iiif.io/api/image/2.0/">IIIF Image API docs</a>.</p> +<p>A IIIF Image API image request URL could look like:</p> + +<div class="source"> +<div class="source"> +<pre>http://www.example.org/digilib/Scaler/IIIF/books!book1!page0002/full/!150,75/0/default.jpg +</pre></div></div> +<p>An info request URL for the same image looks like: </p> + +<div class="source"> +<div class="source"> +<pre>http://www.example.org/digilib/Scaler/IIIF/books!book1!page0002/info.json +</pre></div></div></div> +<div class="section"> +<h2><a name="IIIF_Presentation_API"></a>IIIF Presentation API</h2> +<p>As of version 2.5.3 digilib provides the optional Manifester servlet that generates simple <a class="externalLink" href="http://iiif.io/api/presentation/2.1">IIIF Presentation API version 2</a> manifests that can be used with any <a class="externalLink" href="http://iiif.io/apps-demos/#image-viewing-clients">IIIF viewer</a> to navigate a directory full of images with the functions of a book-reader or light-table.</p> +<p>To build digilib with the Manifester servlet you need to add the <tt>iiif-presentation</tt> profile to your Maven build:</p> + +<div class="source"> +<div class="source"> +<pre>mvn -Piiif-presentation package +</pre></div></div> +<p>(or use the digilib-webapp-X.X.X-srv3p.war file from the website)</p> +<p>The Manifester servlet URLs have the form:</p> + +<div class="source"> +<div class="source"> +<pre>http[s]://{server}/{digilib-webapp}/Manifester/{iiif-prefix}/{identifier} +</pre></div></div> +<p>So you can get a manifest for all images in the directory <tt>/books/book1</tt> with a URL like:</p> + +<div class="source"> +<div class="source"> +<pre>http://www.example.org/digilib/Manifester/IIIF/books!book1 +</pre></div></div> +<p>To try out a viewer on your manifest you can go to the website of the Universal Viewer <a class="externalLink" href="http://universalviewer.io/">http://universalviewer.io/</a> and enter the URL of your manifest in the “view a manifest” box on the page. This will work even with a local digilib installation since the Javascript in your Browser reads and interprets the manifest.</p></div> + </div> + </div> + </div> + + <hr/> + + <footer> + <div class="container-fluid"> + <div class="row span12">Copyright © 2001-2017 + <a href="http://digilib.sourceforge.net">digilib Community</a>. + All Rights Reserved. + + </div> + + + + </div> + </footer> + </body> +</html>