CINXE.COM
GBIF Integrated Publishing Toolkit (IPT) User Manual :: GBIF IPT User Manual
<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width,initial-scale=1"> <title>GBIF Integrated Publishing Toolkit (IPT) User Manual :: GBIF IPT User Manual</title> <link rel="next" href="introduction"> <meta name="generator" content="Antora 3.1.2"> <link rel="stylesheet" href="../../_/css/site.css"> <script>var uiRootPath = '../../_'</script> </head> <body class="article"> <header class="header"> <nav class="navbar"> <div class="navbar-brand"> <a class="navbar-item" href="/manual/en"> <svg class="logo" viewBox="90 239.1 539.7 523.9" xmlns="http://www.w3.org/2000/svg"> <path class="gbif-logo-svg" d="M325.5,495.4c0-89.7,43.8-167.4,174.2-167.4C499.6,417.9,440.5,495.4,325.5,495.4"></path> <path class="gbif-logo-svg" d="M534.3,731c24.4,0,43.2-3.5,62.4-10.5c0-71-42.4-121.8-117.2-158.4c-57.2-28.7-127.7-43.6-192.1-43.6c28.2-84.6,7.6-189.7-19.7-247.4c-30.3,60.4-49.2,164-20.1,248.3c-57.1,4.2-102.4,29.1-121.6,61.9c-1.4,2.5-4.4,7.8-2.6,8.8c1.4,0.7,3.6-1.5,4.9-2.7c20.6-19.1,47.9-28.4,74.2-28.4c60.7,0,103.4,50.3,133.7,80.5C401.3,704.3,464.8,731.2,534.3,731"></path> </svg> <div class="nav-brand__name-area"> <span>GBIF IPT User Manual</span> </div> </a> <button class="navbar-burger" data-target="topbar-nav"> <span></span> <span></span> <span></span> </button> </div> <div id="topbar-nav" class="navbar-menu"> <div class="navbar-end"> <!--div class="navbar-end"> <div class="navbar-item has-dropdown is-hoverable"> <a class="navbar-link" href="">Documentation</a> <div class="navbar-dropdown"> <a class="navbar-item" href="/manual/en/">Menu</a> </div> </div> </div--> </div> <div class="navbar-end"> <div class="navbar-item search hide-for-print"> <div id="search-field" class="field"> <input id="search-input" type="text" placeholder="Search docs"> </div> </div> <div class="navbar-item has-dropdown is-hoverable"> <!-- Current: en --> <a class="navbar-link" href="en"> <svg class="navbar-languages" fill="#fcfcfc" height="24" viewBox="0 0 24 24" width="24" xmlns="http://www.w3.org/2000/svg"> <path d="M0 0h24v24H0z" fill="none"/> <path d="M12.87 15.07l-2.54-2.51.03-.03c1.74-1.94 2.98-4.17 3.71-6.53H17V4h-7V2H8v2H1v1.99h11.17C11.5 7.92 10.44 9.75 9 11.35 8.07 10.32 7.3 9.19 6.69 8h-2c.73 1.63 1.73 3.17 2.98 4.56l-5.09 5.02L4 19l5-5 3.11 3.11.76-2.04zM18.5 10h-2L12 22h2l1.12-3h4.75L21 22h2l-4.5-12zm-2.62 7l1.62-4.33L19.12 17h-3.24z"/> </svg> </a> <div class="navbar-dropdown"> <a class="navbar-item" href="../../../en/ipt/latest/">English</a> <a class="navbar-item" href="../../../es/ipt/latest/">español</a> <a class="navbar-item" href="../../../ja/ipt/latest/">日本語</a> <a class="navbar-item" href="../../../zh/ipt/latest/">繁體中文</a> </div> </div> <div class="navbar-item has-dropdown is-hoverable"> <a class="navbar-link"> <svg class="navbar-feedback" fill="#fcfcfc" height="24" viewBox="0 0 100 100" width="24" xmlns="http://www.w3.org/2000/svg" > <path d="M15.5,15.498h69v51.754H67.253v17.25L50,67.252H15.5V15.498z"/> </svg> </a> <div class="navbar-dropdown"> <a class="navbar-item" href="https://github.com/gbif/ipt/issues/new?labels=Feedback&body=Feedback+on+[GBIF Integrated Publishing Toolkit (IPT) User Manual](https://ipt.gbif.org/manual/en/ipt/latest/) ([Github source for this page](../blob/master/docs/en/modules/ROOT/pages/index.adoc))%0A%0AWrite+your+feedback+here.">Leave feedback on GitHub</a> <a class="navbar-item" href="mailto:helpdesk@gbif.org?subject=Feedback on IPT documentation 'GBIF Integrated Publishing Toolkit (IPT) User Manual'&body=Feedback on https://ipt.gbif.org/manual/en/ipt/latest/">Send feedback by email</a> <a class="navbar-item" href="https://github.com/gbif/ipt/edit/master/docs/en/modules/ROOT/pages/index.adoc">Edit this page on GitHub</a> </div> </div> </div> </div> </nav> </header> <div class="body"> <div class="nav-container" data-component="ipt" data-version="3.0"> <aside class="nav"> <div class="panels"> <div class="nav-panel-menu is-active" data-panel="menu"> <nav class="nav-menu"> <h3 class="title"><a href="./">Integrated Publishing Toolkit</a></h3> <ul class="nav-list"> <li class="nav-item" data-depth="0"> <ul class="nav-list"> <li class="nav-item" data-depth="1"> <a class="nav-link" href="introduction">How to Use this Manual</a> </li> <li class="nav-item" data-depth="1"> <button class="nav-item-toggle"></button> <a class="nav-link" href="getting-started">Getting Started – Installation and Initial Setup</a> <ul class="nav-list"> <li class="nav-item" data-depth="2"> <a class="nav-link" href="requirements">Requirements</a> </li> <li class="nav-item" data-depth="2"> <button class="nav-item-toggle"></button> <a class="nav-link" href="installation">Installation</a> <ul class="nav-list"> <li class="nav-item" data-depth="3"> <a class="nav-link" href="tomcat-installation-linux">Install Tomcat on Linux</a> </li> </ul> </li> <li class="nav-item" data-depth="2"> <a class="nav-link" href="initial-setup">Initial Setup</a> </li> </ul> </li> <li class="nav-item" data-depth="1"> <a class="nav-link" href="overview">Overview</a> </li> <li class="nav-item" data-depth="1"> <a class="nav-link" href="home">Home Menu</a> </li> <li class="nav-item" data-depth="1"> <a class="nav-link" href="manage-resources">Manage Resources Menu</a> </li> <li class="nav-item" data-depth="1"> <a class="nav-link" href="administration">Administration Menu</a> </li> <li class="nav-item" data-depth="1"> <a class="nav-link" href="about">About Menu</a> </li> <li class="nav-item" data-depth="1"> <a class="nav-link" href="releases">Releases</a> </li> <li class="nav-item" data-depth="1"> <a class="nav-link" href="release-notes">Release Notes</a> </li> <li class="nav-item" data-depth="1"> <button class="nav-item-toggle"></button> <a class="nav-link" href="how-to-publish">How to publish biodiversity data through GBIF.org</a> <ul class="nav-list"> <li class="nav-item" data-depth="2"> <a class="nav-link" href="resource-metadata">Resource Metadata</a> </li> <li class="nav-item" data-depth="2"> <a class="nav-link" href="checklist-data">Checklist Data</a> </li> <li class="nav-item" data-depth="2"> <a class="nav-link" href="occurrence-data">Occurrence Data</a> </li> <li class="nav-item" data-depth="2"> <a class="nav-link" href="sampling-event-data">Sampling Event Data</a> </li> </ul> </li> <li class="nav-item" data-depth="1"> <button class="nav-item-toggle"></button> <span class="nav-text">Best Practice Guides</span> <ul class="nav-list"> <li class="nav-item" data-depth="2"> <a class="nav-link" href="gbif-metadata-profile">Resource metadata</a> </li> <li class="nav-item" data-depth="2"> <a class="nav-link" href="best-practices-checklists">Checklist Data</a> </li> <li class="nav-item" data-depth="2"> <span class="nav-text">Occurrence Data (pending)</span> </li> <li class="nav-item" data-depth="2"> <a class="nav-link" href="best-practices-sampling-event-data">Sampling Event Data</a> </li> </ul> </li> <li class="nav-item" data-depth="1"> <a class="nav-link" href="faq">FAQ</a> </li> <li class="nav-item" data-depth="1"> <button class="nav-item-toggle"></button> <span class="nav-text">Contributing</span> <ul class="nav-list"> <li class="nav-item" data-depth="2"> <a class="nav-link" href="translations">Translations</a> </li> <li class="nav-item" data-depth="2"> <a class="nav-link" href="developer-guide">Development</a> </li> </ul> </li> <li class="nav-item" data-depth="1"> <button class="nav-item-toggle"></button> <span class="nav-text">Customization</span> <ul class="nav-list"> <li class="nav-item" data-depth="2"> <a class="nav-link" href="customization">How to Style Your IPT</a> </li> <li class="nav-item" data-depth="2"> <a class="nav-link" href="database-connection">Supported Databases</a> </li> <li class="nav-item" data-depth="2"> <a class="nav-link" href="core">Adding a new core</a> </li> <li class="nav-item" data-depth="2"> <a class="nav-link" href="license">Adding a new License</a> </li> <li class="nav-item" data-depth="2"> <a class="nav-link" href="user-id">Adding a New User ID Directory</a> </li> </ul> </li> <li class="nav-item" data-depth="1"> <a class="nav-link" href="versioning">Dataset Versioning Policy</a> </li> <li class="nav-item" data-depth="1"> <button class="nav-item-toggle"></button> <a class="nav-link" href="citation">Dataset Citation Format</a> <ul class="nav-list"> <li class="nav-item" data-depth="2"> <a class="nav-link" href="datacite-mappings">DataCite to EML mappings</a> </li> </ul> </li> <li class="nav-item" data-depth="1"> <a class="nav-link" href="doi-workflow">DOI Workflows</a> </li> <li class="nav-item" data-depth="1"> <a class="nav-link" href="applying-license">Applying a License to a Dataset</a> </li> <li class="nav-item" data-depth="1"> <a class="nav-link" href="darwin-core">Darwin Core</a> </li> <li class="nav-item" data-depth="1"> <a class="nav-link" href="dwca-guide">Darwin Core Archives – How-to Guide</a> </li> <li class="nav-item" data-depth="1"> <a class="nav-link" href="data-preparation">Data Preparation</a> </li> <li class="nav-item" data-depth="1"> <a class="nav-link" href="data-quality-checklist">Data Quality Checklist</a> </li> <li class="nav-item" data-depth="1"> <a class="nav-link" href="colophon">Colophon</a> </li> <li class="nav-item" data-depth="1"> <a class="nav-link" href="resources">Resources</a> </li> <li class="nav-item" data-depth="1"> <a class="nav-link" href="glossary">Glossary</a> </li> </ul> </li> </ul> </nav> </div> </div> </aside> </div> <main class="article"> <div class="toolbar" role="navigation"> <button class="nav-toggle"></button> <a href="./" class="home-link is-current"></a> <nav class="breadcrumbs" aria-label="breadcrumbs"> <ul> <li><a href="./">Integrated Publishing Toolkit</a></li> <li><a href="./">GBIF Integrated Publishing Toolkit (IPT) User Manual</a></li> </ul> </nav> </div> <div class="content"> <aside class="toc sidebar" data-title="Contents" data-levels="2"> <div class="toc-menu"></div> </aside> <article class="doc"> <h1 class="page">GBIF Integrated Publishing Toolkit (IPT) User Manual</h1> <div id="preamble"> <div class="sectionbody"> <div class="paragraph"> <p><em>For information on the latest release, including downloads, see the <a href="releases" class="xref page">Releases</a> page.</em></p> </div> <div class="paragraph"> <p>The GBIF Integrated Publishing Toolkit (IPT) is a freely available open source web application that makes it easy to share four types of biodiversity-related information:</p> </div> <div class="olist arabic"> <ol class="arabic"> <li> <p>primary taxon occurrence data</p> </li> <li> <p>taxon checklists</p> </li> <li> <p>sampling event data</p> </li> <li> <p>general metadata about data sources.</p> </li> </ol> </div> <div class="paragraph"> <p>An IPT instance as well as the data and metadata registered through the IPT are connected to the GBIF Registry, are indexed for consultation via the GBIF network and portal, and are made accessible for public use. The IPT can also be configured with a DataCite account in order to assign DOIs to datasets transforming it into a data repository.</p> </div> <div class="paragraph"> <p>Founded and funded by governments in 2001, The Global Biodiversity Information Facility (GBIF) is the world’s largest multi-lateral initiative for enabling free access to biodiversity data via the Internet. <a href="https://www.gbif.org/participation/participant-list">GBIF’s diverse Participants</a> include primarily countries and international organizations. GBIF also has formal partnerships with relevant international treaty bodies. GBIF’s mission is to promote and enable free and open access to biodiversity data worldwide via the Internet to underpin science, conservation and sustainable development. More information about GBIF can be found at <a href="https://www.gbif.org/">GBIF.org</a>.</p> </div> <div class="paragraph"> <p>Several factors have provided motivation for GBIF to lead the development of the IPT:</p> </div> <div class="ulist"> <ul> <li> <p>limitations of previous publishing tools (DiGIR, TAPIR, BioCASe) to easily publish and transfer large datasets;</p> </li> <li> <p>the need to reduce the load on both the publisher’s server, and GBIF’s server during indexing. The reason being that indexing from DiGIR, TAPIR, or BioCASe caused heavy loads due to repeated HTTP request-response interactions.</p> </li> <li> <p>the need to speed up the process of indexing biodiversity occurrence datasets;</p> </li> <li> <p>the need to offer additional benefits and services to the data publishers to encourage data publication;</p> </li> <li> <p>the lack of appropriate tools to publish certain types of biodiversity data, such as names checklists and data set metadata.</p> </li> </ul> </div> <div class="paragraph"> <p>To understand how the IPT works, try watching this concise 25 minute live demo showing how a dataset gets properly published and registered through GBIF.org.</p> </div> <div class="videoblock responsive-video"> <div class="title">How to publish biodiversity data through GBIF.org using the IPT</div> <div class="content"> <iframe width="100%" src="https://www.youtube.com/embed/eDH9IoTrMVE?rel=0" frameborder="0" allowfullscreen></iframe> </div> </div> </div> </div> <div class="sect1"> <h2 id="users"><a class="anchor" href="#users"></a>Users</h2> <div class="sectionbody"> <div class="paragraph"> <p>If you’re only interested in trying out the IPT please request an account on the <a href="https://ipt.gbif.org/">Demo IPT</a> by sending an email to <a href="mailto:helpdesk@gbif.org">helpdesk@gbif.org</a>.</p> </div> <div class="paragraph"> <p>The simplest way to begin using the IPT is to request a free account on a <a href="https://www.gbif.org/data-hosting-centres" target="_blank" rel="noopener">trusted data hosting centre</a> allowing you to manage your own datasets and publish them through GBIF.org without the hassle of setting up and maintaining the IPT on your own server.</p> </div> <div class="paragraph"> <p>Otherwise if want to setup your own instance of the IPT the <a href="getting-started" class="xref page">Getting Started Guide</a> is your entry point.</p> </div> <div class="admonitionblock note"> <table> <tr> <td class="icon"> <i class="fa icon-note" title="Note"></i> </td> <td class="content"> Be sure to sign up to the <a href="https://lists.gbif.org/mailman/listinfo/ipt/">IPT Mailing List</a>, which serves as a support group for IPT users. It is essential that the IPT is kept up to date to be as secure and robust as possible, so if you are responsible for administering an IPT, then you should be signed up to be notified of new releases so that you can update immediately. </td> </tr> </table> </div> </div> </div> <div class="sect1"> <h2 id="developers"><a class="anchor" href="#developers"></a>Developers</h2> <div class="sectionbody"> <div class="paragraph"> <p>The core development of the IPT is directed by GBIF, but the coding is a community effort and everyone is welcome to join. Start by browsing the <a href="https://github.com/gbif/ipt/issues">Open Issues</a> to find something that you’d like to start working on. Kindly note that contributions are welcome in the form of a <a href="https://help.github.com/articles/creating-a-pull-request/">pull request</a> using a branch or fork of the repository. Full instructions aimed at developers can be found <a href="developer-guide" class="xref page">here</a>.</p> </div> </div> </div> <div class="sect1"> <h2 id="translators"><a class="anchor" href="#translators"></a>Translators</h2> <div class="sectionbody"> <div class="paragraph"> <p>The IPT user interface and manual both need internationalization, but it’s a community effort and everyone is welcome to join. Full instructions aimed at translators can be found <a href="translations" class="xref page">here</a>.</p> </div> <div class="paragraph"> <p>Thanks to an enormous community effort, and by leveraging the power of the <a href="https://crowdin.com/project/gbif-ipt">Crowdin</a> localization tool, the user interface has already been translated into seven different languages: English, French, Spanish, Traditional Chinese, Brazilian Portuguese, Japanese, and Russian.</p> </div> </div> </div> <div class="sect1"> <h2 id="acknowledgements"><a class="anchor" href="#acknowledgements"></a>Acknowledgements</h2> <div class="sectionbody"> <div class="paragraph"> <p>A large number of dedicated volunteers contribute to the success of this software. With your help, the IPT has become a successful tool in use all around the world.</p> </div> <div class="paragraph"> <p><a href="https://crowdin.com/">Crowdin</a> is kindly supporting this open source project by giving GBIF a free access to its localization management platform. Crowdin makes it possible to manage a large number of concurrent translations.</p> </div> </div> </div> <nav class="pagination"> <span class="next"><a href="introduction">How to Use this Manual</a></span> </nav> </article> </div> </main> </div> <footer class="footer"> <div class="horizontal-stripe light-background"> <div class="footer-container"> <nav class="site-footer__menu"> <div> <a href="https://www.gbif.org/">GBIF.org</a> <a href="https://www.gbif.org/terms">Terms and agreements</a> <a href="https://www.gbif.org/contact-us">Contact</a> </div> <div> <strong>GBIF Secretariat</strong> • Universitetsparken 15 • DK-2100 Copenhagen Ø • Denmark </div> </nav> </div> </div> <div class="horizontal-stripe"> <div class="footer-container"> <a href="https://www.gbif.org/"><img src="https://www.gbif.org/img/full_logo_white.svg" alt="GBIF"></a> </div> </div> </footer> <script id="site-script" src="../../_/js/site.js" data-ui-root-path="../../_"></script> <script async src="../../_/js/vendor/highlight.js"></script> <script src="../../_/js/vendor/lunr.js"></script> <script src="../../_/js/search-ui.js" id="search-ui-script" data-site-root-path="../.." data-snippet-length="100" data-stylesheet="../../_/css/search.css"></script> <script async src="../../search-index.js"></script> <script defer data-domain="ipt.gbif.org" src="https://plausible.io/js/script.file-downloads.js"></script> </body> </html>