Mercurial > hg > digilib

comparison iiif-api.html @ 1640:1ae8b89d3a86

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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
comparison
equal deleted inserted replaced
-1:000000000000 1640:1ae8b89d3a86
1 <!DOCTYPE html>
2 <!--
3 | Generated by Apache Maven Doxia at 2017-08-22
4 | Rendered using Apache Maven Fluido Skin 1.3.0
5 -->
6 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7 <head>
8 <meta charset="UTF-8" />
9 <meta name="viewport" content="width=device-width, initial-scale=1.0" />
10 <meta name="Date-Revision-yyyymmdd" content="20170822" />
11 <meta http-equiv="Content-Language" content="en" />
12 <title>digilib - The Digital Image Library &#x2013; The digilib IIIF API</title>
13 <link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
14 <link rel="stylesheet" href="./css/site.css" />
15 <link rel="stylesheet" href="./css/print.css" media="print" />
16
17
18 <script type="text/javascript" src="./js/apache-maven-fluido-1.3.0.min.js"></script>
19
20
21 </head>
22 <body class="topBarDisabled">
23
24
25
26 <div class="container-fluid">
27 <div id="banner">
28 <div class="pull-left">
29 <a href="./" id="bannerLeft">
30 <h2>digilib - a versatile image viewing environment for the internet</h2>
31 </a>
32 </div>
33 <div class="pull-right"> <a href="./" id="bannerRight">
34 <img src="images/digilib-logo-small.png" />
35 </a>
36 </div>
37 <div class="clear"><hr/></div>
38 </div>
39
40 <div id="breadcrumbs">
41 <ul class="breadcrumb">
42
43
44 <li id="publishDate">Last Published: 2017-08-22</li>
45 <li class="divider">|</li> <li id="projectVersion">Version: 2.5-SNAPSHOT</li>
46
47
48
49
50 </ul>
51 </div>
52
53
54 <div class="row-fluid">
55 <div id="leftColumn" class="span3">
56 <div class="well sidebar-nav">
57
58
59 <ul class="nav nav-list">
60 <li class="nav-header">Overview</li>
61
62 <li>
63
64 <a href="index.html" title="About digilib">
65 <i class="none"></i>
66 About digilib</a>
67 </li>
68
69 <li>
70
71 <a href="features.html" title="digilib features">
72 <i class="none"></i>
73 digilib features</a>
74 </li>
75
76 <li>
77
78 <a href="digilib-short.html" title="How digilib works">
79 <i class="none"></i>
80 How digilib works</a>
81 </li>
82
83 <li>
84
85 <a href="history.html" title="Ancient history">
86 <i class="none"></i>
87 Ancient history</a>
88 </li>
89 <li class="nav-header">Installation</li>
90
91 <li>
92
93 <a href="install-digilib.html" title="Installing digilib">
94 <i class="none"></i>
95 Installing digilib</a>
96 </li>
97
98 <li>
99
100 <a href="build-maven.html" title="Building digilib">
101 <i class="none"></i>
102 Building digilib</a>
103 </li>
104 <li class="nav-header">Configuration</li>
105
106 <li>
107
108 <a href="digilib-config.html" title="Configuring digilib">
109 <i class="none"></i>
110 Configuring digilib</a>
111 </li>
112
113 <li>
114
115 <a href="image-directories.html" title="Directory layout">
116 <i class="none"></i>
117 Directory layout</a>
118 </li>
119
120 <li>
121
122 <a href="java-settings.html" title="Java settings and tuning">
123 <i class="none"></i>
124 Java settings and tuning</a>
125 </li>
126
127 <li>
128
129 <a href="auth.html" title="Access control">
130 <i class="none"></i>
131 Access control</a>
132 </li>
133 <li class="nav-header">Development</li>
134
135 <li>
136
137 <a href="scaler-api.html" title="The digilib Scaler API">
138 <i class="none"></i>
139 The digilib Scaler API</a>
140 </li>
141
142 <li class="active">
143
144 <a href="#"><i class="none"></i>The digilib IIIF API</a>
145 </li>
146
147 <li>
148
149 <a href="client-integration.html" title="Integrating digilib into your page">
150 <i class="none"></i>
151 Integrating digilib into your page</a>
152 </li>
153
154 <li>
155
156 <a href="plugins.html" title="Digilib plugins">
157 <i class="none"></i>
158 Digilib plugins</a>
159 </li>
160 <li class="nav-header">Project Documentation</li>
161
162 <li>
163
164 <a href="project-info.html" title="Project Information">
165 <i class="icon-chevron-right"></i>
166 Project Information</a>
167 </li>
168 </ul>
169
170
171
172 <hr class="divider" />
173
174 <div id="poweredBy">
175 <div class="clear"></div>
176 <div class="clear"></div>
177 <div class="clear"></div>
178 <a href="http://maven.apache.org/" title="Built by Maven" class="builtBy">
179 <img class="builtBy" alt="Built by Maven" src="http://maven.apache.org/images/logos/maven-feather.png" />
180 </a>
181 <a href="http://www.sourceforge.net/" title="Hosted by SourceForge" class="builtBy">
182 <img class="builtBy" alt="Hosted by SourceForge" src="http://upload.wikimedia.org/wikipedia/commons/0/0b/Sourceforge_logo.png" />
183 </a>
184 </div>
185 </div>
186 </div>
187
188
189 <div id="bodyColumn" class="span9" >
190
191 <h1>The digilib IIIF API</h1>
192 <div class="section">
193 <h2><a name="IIIF_Image_API"></a>IIIF Image API</h2>
194 <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>
195 <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>
196 <p>IIIF Image API URLs for an image request have the form:</p>
197
198 <div class="source">
199 <div class="source">
200 <pre>http[s]://{server}/{digilib-webapp}/Scaler/{iiif-prefix}/{identifier}/{region}/{size}/{rotation}/{quality}.{format}
201 </pre></div></div>
202 <p>where <tt>digilib-webapp</tt> is the name of the digilib web application in the servlet container. </p>
203 <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 &#x201c;IIIF&#x201d;.</p>
204 <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 &#x201c;!&#x201d;, so the fn-path &#x201c;books/book1/page0002&#x201d; becomes the identifier &#x201c;books!book1!page0002&#x201d;.</p>
205 <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>
206 <p>A IIIF Image API image request URL could look like:</p>
207
208 <div class="source">
209 <div class="source">
210 <pre>http://www.example.org/digilib/Scaler/IIIF/books!book1!page0002/full/!150,75/0/default.jpg
211 </pre></div></div>
212 <p>An info request URL for the same image looks like: </p>
213
214 <div class="source">
215 <div class="source">
216 <pre>http://www.example.org/digilib/Scaler/IIIF/books!book1!page0002/info.json
217 </pre></div></div></div>
218 <div class="section">
219 <h2><a name="IIIF_Presentation_API"></a>IIIF Presentation API</h2>
220 <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>
221 <p>To build digilib with the Manifester servlet you need to add the <tt>iiif-presentation</tt> profile to your Maven build:</p>
222
223 <div class="source">
224 <div class="source">
225 <pre>mvn -Piiif-presentation package
226 </pre></div></div>
227 <p>(or use the digilib-webapp-X.X.X-srv3p.war file from the website)</p>
228 <p>The Manifester servlet URLs have the form:</p>
229
230 <div class="source">
231 <div class="source">
232 <pre>http[s]://{server}/{digilib-webapp}/Manifester/{iiif-prefix}/{identifier}
233 </pre></div></div>
234 <p>So you can get a manifest for all images in the directory <tt>/books/book1</tt> with a URL like:</p>
235
236 <div class="source">
237 <div class="source">
238 <pre>http://www.example.org/digilib/Manifester/IIIF/books!book1
239 </pre></div></div>
240 <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 &#x201c;view a manifest&#x201d; 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>
241 </div>
242 </div>
243 </div>
244
245 <hr/>
246
247 <footer>
248 <div class="container-fluid">
249 <div class="row span12">Copyright &copy; 2001-2017
250 <a href="http://digilib.sourceforge.net">digilib Community</a>.
251 All Rights Reserved.
252
253 </div>
254
255
256
257 </div>
258 </footer>
259 </body>
260 </html>