The Cookbook of IIIF Recipes — IIIF | International Image Interoperability Framework

<!DOCTYPE html> <html lang='en'><head> <meta charset="utf-8"> <title> The Cookbook of IIIF Recipes — IIIF | International Image Interoperability Framework </title> <meta name="description" content="IIIF is a set of open standards for delivering high-quality, attributed digital objects online at scale. It’s also an international community developing and implementing the IIIF APIs. IIIF is backed by a consortium of leading cultural institutions."> <link rel="shortcut icon" href="/assets/favicon.ico"> <link rel="apple-touch-icon" sizes="180x180" href="/assets/apple-touch-icon.png"> <link rel="icon" type="image/png" sizes="32x32" href="/assets/favicon-32x32.png"> <link rel="icon" type="image/png" sizes="16x16" href="/assets/favicon-16x16.png"> <link rel="manifest" href="/assets/site.webmanifest"> <link rel="mask-icon" href="/assets/safari-pinned-tab.svg" color="#E82334"> <meta name="msapplication-TileColor" content="#da532c"> <meta name="theme-color" content="#ffffff"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="/assets/css/style.css"> <link rel="canonical" href="/get-started/cookbook/" />  <script async src="https://www.googletagmanager.com/gtag/js?id=G-ZW5W9QRPH6"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'G-ZW5W9QRPH6'); </script> <link rel="preload" as="image" href="/assets/images/heroes/smithsonian_cookbook.webp">  <meta name="generator" content="Jekyll v4.1.1" /> <meta property="og:title" content="The Cookbook of IIIF Recipes" /> <meta property="og:locale" content="en_US" /> <link rel="canonical" href="/get-started/cookbook/" /> <meta property="og:url" content="/get-started/cookbook/" /> <meta property="og:type" content="website" /> <meta name="twitter:card" content="summary" /> <meta property="twitter:title" content="The Cookbook of IIIF Recipes" /> <meta name="twitter:site" content="@iiif_io" /> <script type="application/ld+json"> {"@context":"https://schema.org","@type":"WebPage","headline":"The Cookbook of IIIF Recipes","publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"/assets/favicon.ico"}},"url":"/get-started/cookbook/"}</script>   <link rel="me" href="https://glammr.us/@iiif"> </head> <body> <section class="hero is-primary" style="background-image: linear-gradient(to bottom, rgba(0, 25, 39, 0.68), rgba(0, 25, 39, 0.68)), url('/assets/images/heroes/smithsonian_cookbook.webp'); background-size: cover; background-position: bottom center; background-attachment: fixed; "> <div class="hero-head"> <nav id="navbar" class="navbar is-transparent is-spaced"> <div class="container"> <div class="navbar-brand"> <a class="navbar-item" href="/"> <img src="/assets/images/logos/logo-sm.png" alt="IIIF logo" height="28"> <span class="brand-title">International Image Interoperability Framework</span> </a> <div class="navbar-burger" data-target="navbar" onclick="document.querySelector('.navbar-menu').classList.toggle('is-active');"> <span></span> <span></span> <span></span> </div> </div> <div class="navbar-menu"> <div class="navbar-end"> <a class="navbar-item" href="/">Home</a> <a class="navbar-item" href="/demos">Demos</a> <a class="navbar-item" href="/news-and-events">News & Events</a> <div class="navbar-item has-dropdown is-hoverable"> <a class="navbar-link" href="/get-involved"> Get Involved </a> <div class="navbar-dropdown is-boxed is-active"> <a class="navbar-item" href="/community/">Community</a> <a class="navbar-item" href="/community/consortium">Consortium</a> <a class="navbar-item" href="/newsletter">Join Newsletter</a> <a class="navbar-item" href="/get-involved/outreach-materials">Outreach Materials</a> </div> </div> <div class="navbar-item has-dropdown is-hoverable"> <a class="navbar-link" href="/get-started"> Get Started </a> <div class="navbar-dropdown is-boxed is-active"> <a class="navbar-item" href="/get-started/how-iiif-works">How IIIF Works</a> <a class="navbar-item" href="/community/ambassadors/">IIIF Ambassadors</a> <a class="navbar-item" href="https://iiif.io/guides">Guides</a> <a class="navbar-item" href="https://iiif.io/api">APIs & Documentation</a> <a class="navbar-item" href="/get-started/cookbook">Cookbooks</a> <a class="navbar-item" href="/get-started/training">Training</a> </div> </div> </div> </div> </div> </nav> </div> <div class="hero-body container"> <nav class="breadcrumb is-centered" aria-label="breadcrumbs"> <ul> <li><a href="/get-started/">Get Started</a></li> </ul> </nav> <div class="container has-text-centered"> <h1 class="title is-size-2 is-size-3-mobile is-size-desktop is-size-1-widescreen">The Cookbook of IIIF Recipes</h1> <p class="subtitle is-size-5"></p> </div> </div> </section> <section id="main"> <div class='container-block is-max-widescreen'><div class='container' markdown='1'> <div class="content"> <div class="container-block is-max-widescreen"><div class="container"> <h2 id="the-cookbook">The Cookbook</h2> <p>IIIF “recipes” are different reusable code snippets to help create IIIF manifests for common use cases. They’ll help you understand how to build up your IIIF Manifest using patterns that have emerged from within the IIIF community over time.</p> <p>Using recipes is a bit like using a code library. If the recipe does what you need, you can copy and paste from the library to get up and running more quickly. Recipes will also help you familiarise yourself with patterns and techniques that IIIF developers use a lot.</p> <p>There’s a <strong>#cookbook</strong> channel on the IIIF Slack team too, if you’d like to know more or join a Cookbook community call.</p> </div></div> <div class="container-block is-max-widescreen"><div class="container has-text-centered"> <h2 id="see-all-the-recipes">See all the recipes</h2> <p>Go directly to the IIIF Cookbook and browse to see if your use case is covered. <br /></p> <div class="columns is-centered"> <a class="button is-primary is-normal" href="https://iiif.io/api/cookbook/">View recipes</a> </div> </div></div> <h2 id="recipes">Recipes</h2> <p>Here are a few examples, and more are being added each month for a wide variety of common use cases.</p> <ul> <li> <p><a href="https://iiif.io/api/cookbook/recipe/0001-mvm-image/">Simplest Manifest - Image</a> <br /> <em>You’ll need: a text editor and an image</em> <br /> If all you have for an object is one image on the web and a label, this pattern turns it into a IIIF Presentation resource.</p> </li> <li> <p><a href="https://iiif.io/api/cookbook/recipe/0005-image-service/">Support Deep Viewing with Basic Use of a IIIF Image Service</a> <br /> Paint a Canvas using an image with an associated IIIF Image API service.</p> </li> <li> <p><a href="https://iiif.io/api/cookbook/recipe/0003-mvm-video/">Simplest Manifest - Video</a> The simplest viable manifest for video content. This pattern presents a single video file in a IIIF Presentation resource.</p> </li> <li> <p><a href="https://iiif.io/api/cookbook/recipe/0139-geolocate-canvas-fragment/">Geographic coordinates</a> Use Web Annotation to provide geocoordinates for a fragment of an IIIF Presentation API 3.0 Canvas.</p> </li> </ul> <h2 id="creating-recipes">Creating recipes</h2> <h3 id="do-you-have-an-idea-for-a-recipe">Do you have an idea for a recipe?</h3> <p>Feel free to reuse any recipe that suits you, and if you’d like to <strong>submit a recipe</strong>, the first step is to <a href="https://github.com/IIIF/cookbook-recipes/issues/new/choose">open a new issue</a> in the IIIF Cookbook repo for discussion. If you’re not familiar with how to use Github, feel free to contact us and we can help you through the process. Thanks for helping in this effort, and also please be sure to check that there isn’t already a recipe that does what you want.</p> <h4 id="requirements-for-new-recipes">Requirements for new recipes</h4> <p>To make sure your submission is not abandoned, please make sure to include the following detail:</p> <ul> <li>A short, clear name</li> <li>A use case</li> <li>References and links to help people understand how you expect the recipe to work</li> <li>Notes on how you would implement it (and make that repeatable)</li> <li>A full example, including a written description and a code sample (JSON-LD)</li> <li>Any restrictions you predict on the use of the recipe</li> <li>Any existing recipes you think are connected</li> </ul> <h3 id="writing-a-recipe">Writing a recipe</h3> <p>If you’re interested in helping author a recipe, please see the <a href="https://iiif.io/api/cookbook/recipe/">Cookbook Process document</a> for full details on that front.</p> <p>There’s <a href="https://github.com/IIIF/cookbook-recipes/issues">a big list of ideas in the IIIF Cookbook Github repo</a>, and you’re very welcome to grab one of them and build it! We’re grateful for all the help we can get to build this important community resource.</p> </div> </div></div> </section> <footer id="footer" class="footer"> <div class="container"> <div class="columns"> <div class="navbar-brand column is-half"> <a class="navbar-item" href="/"> <img src="/assets/images/logos/logo-sm.png" alt="IIIF logo" height="28"> <span class="brand-title blue-text">International Image Interoperability Framework</span> </a> <p>IIIF is a set of open standards for delivering high-quality, attributed digital objects online at scale. It’s also an international community developing and implementing the IIIF APIs. IIIF is backed by a consortium of leading cultural institutions.</p> </div> <div class="column"></div> <div class="column menu-column"> <h4>About</h4> <ul> <li> <a href="/get-started/how-iiif-works">How IIIF Works</a> </li> <li> <a href="https://iiif.io/api">APIs & Documentation</a> </li> <li> <a href="/demos">Demos</a> </li> <li> <a href="https://iiif.io/guides">Tutorials & Guides</a> </li> <li> <a href="/privacy">Privacy policy</a> </li> </ul> </div> <div class="column menu-column"> <h4>Stay Connected</h4> <ul> <li> <a href="/news-and-events">News & Events</a> </li> <li> <a href="/newsletter">Join Newsletter</a> </li> <li> <a href="/community/groups">Community Groups</a> </li> <li> <a href="/community/consortium">Consortium</a> </li> <li> <a href="/contact">Contact Us</a> </li> </ul> </div> </div> </div> </footer><script src="https://code.jquery.com/jquery-3.6.0.min.js" integrity="sha256-/xUj+3OJU5yExlq6GSYGSHk7tPXikynS7ogEvDej/m4=" crossorigin="anonymous"></script> <script type="text/javascript" src="//cdn.jsdelivr.net/npm/slick-carousel@1.8.1/slick/slick.min.js"></script> <script type="text/javascript" src="/assets/js/carouselInit.js"></script>  <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.11.2/css/all.css" /> <script src="https://formspree.io/js/formbutton-v1.min.js" defer></script> <script> /* paste this line in verbatim */ window.formbutton=window.formbutton||function(){(formbutton.q=formbutton.q||[]).push(arguments)}; /* customize formbutton below*/ formbutton("create", { action: "https://formspree.io/f/xbjwjlbn", title: "Feedback", fields: [ { type: "radio", name: "feedback_type", value: "Comment", label: "Comment", style: { display: "inline-block", "padding-right": "10px" } }, { type: "radio", name: "feedback_type", value: "Correction", label: "Correction", style: { display: "inline-block", "padding-right": "10px" } }, { type: "radio", name: "feedback_type", value: "Bug", label: "Bug", style: { display: "inline-block", "padding-right": "10px" } }, { type: "email", label: "Email:", name: "Email", required: true, placeholder: "your@email.com" }, { type: "textarea", label: "Message:", name: "Message", placeholder: "We want to hear from you! Enter your feedback here.", }, { type: "submit", value: "Submit" }, { type: "hidden", name: "Page", value: window.location.pathname.replaceAll('/','|'), style: { display: "none" } } ], buttonImg: "<i class='fas fa-comment' style='font-size:24px'/>", styles: { title: { backgroundColor: "#0d232d" }, button: { backgroundColor: "#0d232d" } } }); </script> </body> </html>

CINXE.COM

The Cookbook of IIIF Recipes — IIIF | International Image Interoperability Framework