CINXE.COM
Documentation — inveniosoftware.org
<!doctype html> <title>Documentation — inveniosoftware.org</title> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=Edge"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="keywords" content="invenio, library, framework, ils, research, data, multimedia, ir, institutional, repository, cern, foss, open, software, model, search, workflows, marc, marc21, python, api, doi, json, memento, oai-pmh, orcid, openaire, rest, zenodo, cds, flask, angular"> <meta name="generator" content="Lektor 3.3.11"> <script src="https://code.jquery.com/jquery-3.2.1.min.js"></script> <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js"></script> <script src="https://unpkg.com/isotope-layout@3/dist/isotope.pkgd.min.js"></script> <script async defer src="https://buttons.github.io/buttons.js"></script> <script src="https://cdnjs.cloudflare.com/ajax/libs/ekko-lightbox/4.0.1/ekko-lightbox.min.js"></script> <link rel="icon" href="/static/img/favicon.ico?h=4df2b1b9"> <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css"> <link rel="stylesheet" href="/static/css/style.css?h=29287faf"> <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css"> <link href="https://fonts.googleapis.com/css?family=Open+Sans:300,300i,400,400i,600|Oswald|Source+Code+Pro:400&display=swap" rel="stylesheet"> <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/ekko-lightbox/4.0.1/ekko-lightbox.css" /> <link rel="alternate" type="application/atom+xml" title="Invenio Blog" href="https://inveniosoftware.org/feed.xml"> <body> <section class="header-section " > <div class="cover-image"> <header class="header-nav"> <nav class="navbar navbar-fixed-top invenio-navbar"> <div class="container"> <!-- Brand and toggle get grouped for better mobile display --> <div class="navbar-header"> <button class="navbar-toggle collapsed" type="button" data-toggle="collapse" data-target="#inv-navbar-collapse" aria-controls="inv-navbar-collapse" aria-expanded="false" aria-label="Toggle navigation"> <span class="sr-only">Toggle navigation</span> <span class="icon-bar"></span> <span class="icon-bar"></span> <span class="icon-bar"></span> </button> <a href="/" class="navbar-brand"> <img src="/static/img/logo-invenio-white.svg?h=84611f18" alt=""> </a> </div> <!-- Collect the nav links, forms, and other content for toggling --> <div class="collapse navbar-collapse" id="inv-navbar-collapse"> <ul class="nav navbar-nav navbar-right"> <li><a href="/">Home</a></li> <li class="dropdown-submenu"> <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false"> <span class="nav-label">Products</span><span class="caret"></span></a> <ul class="dropdown-menu"> <li><a href="/products/rdm/">InvenioRDM</a></li> <li><a href="/products/ils/">InvenioILS</a></li> <li><a href="/products/framework/">Invenio Framework</a></li> </ul> </li> <li><a href="/showcase/">Examples</a></li> <li class="dropdown-submenu"> <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false"> <span class="nav-label">Community</span><span class="caret"></span></a> <ul class="dropdown-menu"> <li><a href="/products/rdm/roadmap/">Roadmap</a></li> <li><a href="/getinvolved/">Get involved</a></li> <li><a href="/events/">Events & Training</a></li> <li><a href="/support/">Hosting & Support</a></li> <li><a href="/governance/">Governance</a></li> <li><a href="/people/">People</a></li> </ul> </li> <li><a class="active-menu" href="/documentation/">Docs</a></li> <li><a href="/blog/">Blog</a></li> <li><a href="https://invenio-talk.web.cern.ch">Talk</a></li> <li><a href="/about/">About</a></li> </ul> </div> </div> </nav> </header> <div class="container"> <div class="row"> <div class="col"> <div class="header-section-title"> <h1>Documentation</h1> <p class="sub-title">Invenio products documentation</p> </div> </div> </div> </div> </div> </section> <section class="documentation-section section-content-light-bg"> <div class="container"> <div class="row"> <div class="col-lg-10 col-lg-offset-1"> <div class="row"> <div class="col-sm-4"> <h3 class="text-center"> <a href="https://invenio.readthedocs.io/en/latest/"> <img class="documentation-logo" src="/static/img/logo-invenio-framework.svg?h=de9a0f7c" title="Invenio Framework" alt="Invenio Framework"/> </a> </h3> <div class="panel panel-default"> <div class="panel-heading">Invenio Framework</div> <div class="list-group"> <a class="list-group-item" href="https://invenio.readthedocs.io/en/latest/getting-started/index.html"> <i class="fa fa-fw fa-play-circle"></i> Getting started </a> <a class="list-group-item" href="https://invenio.readthedocs.io/en/latest/tutorials/bootcamp.html"> <i class="fa fa-fw fa-graduation-cap"></i> Tutorials </a> <a class="list-group-item" href="https://invenio.readthedocs.io/en/latest/"> <i class="fa fa-fw fa-book"></i> Documentation </a> </div> </div> <div class="list-group"> <a class="list-group-item" href="https://invenio.readthedocs.io/en/latest/documentation/bundles/index.html"> <i class="fa fa-fw fa-cogs"></i> API reference </a> <a class="list-group-item" href="https://invenio.readthedocs.io/en/latest/releases/index.html"> <i class="fa fa-fw fa-tags"></i> Releases </a> <a class="list-group-item" href="https://invenio.readthedocs.io/en/latest/releases/upgrading/index.html"> <i class="fa fa-fw fa-angle-double-up"></i> Upgrading </a> </div> </div> <div class="col-sm-4"> <h3 class="text-center"> <a href="https://inveniordm.docs.cern.ch/"> <img class="documentation-logo" src="/static/img/logo-invenio-rdm.svg?h=db2629d2" title="InvenioRDM" alt="InvenioRDM"/> </a> </h3> <div class="panel panel-default"> <div class="panel-heading">InvenioRDM</div> <div class="list-group"> <a class="list-group-item" href="https://inveniordm.docs.cern.ch/develop/"> <i class="fa fa-fw fa-play-circle"></i> Getting started </a> <a class="list-group-item" href="https://inveniordm.docs.cern.ch/"> <i class="fa fa-fw fa-book"></i> Documentation </a> </div> </div> <div class="list-group"> <a class="list-group-item" href="https://inveniordm.docs.cern.ch/develop/topics/extensions/"> <i class="fa fa-fw fa-cubes"></i> Extend </a> </div> </div> <div class="col-sm-4"> <h3 class="text-center"> <a href="https://invenioils.docs.cern.ch/"> <img class="documentation-logo" src="/static/img/logo-invenio-ils.svg?h=da7ca04b" title="InvenioILS" alt="InvenioILS"/> </a> </h3> <div class="panel panel-default"> <div class="panel-heading">InvenioILS</div> <div class="list-group"> <a class="list-group-item" href="https://invenioils.docs.cern.ch/preview/"> <i class="fa fa-fw fa-play-circle"></i> Preview </a> <a class="list-group-item" href="https://invenioils.docs.cern.ch/"> <i class="fa fa-fw fa-book"></i> Documentation </a> </div> </div> </div> </div> </div> <div class="col-lg-8 col-lg-offset-2 documentation-search-block"> <p class="text-center"> Search for anything about Invenio </p> <div class="input-group"> <input type="search" required class="form-control" placeholder="Search for code, documentation, issues, ..." id="search-query"> <div class="input-group-btn"> <button type="button" class="btn btn-default btn-search" data-provider="github"> <i class="fa fa-fw fa-flip-horizontal fa-search documentation-icon-dark"></i> GitHub </button> <button type="button" class="btn btn-default dropdown-toggle" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false"> <span class="caret"></span> </button> <ul class="dropdown-menu dropdown-menu-normal"> <li class="dropdown-header">Other</li> <li> <a href="#" class="btn-search" data-provider="google"> <i class="fa fa-fw fa-flip-horizontal fa-search documentation-icon-dark"></i> Google </a> </li> </ul> </div> </div> </div> </div> </div> </section> <section class="documentation-section section-content-white-bg"> <div class="container"> <div class="row"> <div class="col-lg-6"> <div class="row centered"> <span class="section-title">Getting help</span> <div class="col-lg-12"> <div class="row"> <div class="col-sm-6"> <h2><i class="fa fa-keyboard-o"></i> <a href="https://discord.gg/8qatqBC">Chat</a> </h2> <p> Chat with Invenio developers </p> </div> <div class="col-sm-6"> <h2><i class="fa fa-comment"></i> <a href="https://invenio-talk.web.cern.ch/">Forum</a></h2> <p> Ask questions on the forum </p> </div> </div> <div class="row"> <div class="col-sm-6"> <h2><i class="fa fa-users"></i> <a href="/people/">People</a></h2> <p> Review the list of contributors </p> </div> </div> </div> </div> </div> <div class="col-lg-6"> <div class="row centered"> <span class="section-title">Contributing</span> <div class="col-lg-12"> <div class="row"> <div class="col-sm-6"> <h2> <i class="fa fa-compass"></i> <a href="https://invenio.readthedocs.io/en/latest/community/contributing/contribution-guide.html"> Contribution guide </a> </h2> <p> Learn how to contribute to the project </p> </div> <div class="col-sm-6"> <h2> <i class="fa fa-users"></i> <a href="/governance/">Governance</a> </h2> <p> Roles and decision making </p> </div> </div> </div> <div class="col-lg-12"> <div class="row"> <div class="col-sm-6"> <h2> <i class="fa fa-language"></i> <a href="https://invenio.readthedocs.io/en/latest/community/contributing/translation-guide.html"> Translator guide </a> </h2> <p> Learn how to contribute as a translator </p> </div> <div class="col-sm-6"> <h2> <i class="fa fa-bookmark"></i> <a href="https://invenio.readthedocs.io/en/latest/community/code-of-conduct.html"> Code of conduct </a> </h2> <p> Collaboration on the Invenio project </p> </div> </div> </div> <div class="col-lg-12"> <div class="row"> <div class="col-sm-6"> <h2> <i class="fa fa-check-square-o"></i> <a href="https://github.com/inveniosoftware/rfcs">Design RFC</a> </h2> <p> Propose changes on Invenio with RFC (Request for Comments) </p> </div> <div class="col-sm-6"> <h2> <i class="fa fa-shield"></i> <a href="https://invenio.readthedocs.io/en/latest/community/security-policy.html"> Security policy </a> </h2> <p> Reporting and disclosure of security issues </p> </div> </div> </div> </div> </div> </div> </div> </section> <script type="text/javascript"> $(document).ready(function () { var ENTER_KEY = 13; var searchInput = $('#search-query'); function search(provider) { var query = searchInput.val().trim(); if (!query) { return; } var url, params; if (provider === 'github') { // NOTE: // ideally, it would be better to have type: 'Code', but GitHub requires // the user to be logged in to search in Code params = {q: 'org:inveniosoftware' + ' ' + query, type: 'Commits'}; url = 'https://github.com/search'; } else if (provider === 'google') { params = {q: 'invenio' + ' ' + query}; url = 'https://www.google.com/search'; } if (url && params) { window.location.href = url + '?' + $.param(params); } } searchInput.on('keydown', function (e) { if (e.keyCode === ENTER_KEY) { search('github'); } }); $('.btn-search').on('click', function (e) { e.preventDefault(); search($(this).data('provider')); }) }) </script> <footer> <div class="contact-section section-content-dark-bg"> <div class="container"> <div class="row"> <div class="col-md-6 footer-logo-centered"> <a href="/"><img class="icon-contact" src="/static/img/logo-invenio-white.svg?h=84611f18" /></a> </div> <div class="col-md-2"> <h3 class="contact-title">Products</h3> <table class="contact-list"> <tbody> <tr> <td><a href="/products/rdm/">InvenioRDM</a></td> </tr> <tr> <td> <a href="/products/ils/">InvenioILS</a> </td> </tr> <tr> <td> <a href="/products/framework/">Invenio Framework</a> </td> </tr> <tr> <td> <a href="/#products">Get Started</a> </td> </tr> <tr> <td> <a href="/showcase/">Examples</a> </td> </tr> <tr> <td><a href="/about/">About</a></td> </tr> <tr> <td><a href="/about#logos">Logos</a></td> </tr> </tbody> </table> </div> <div class="col-md-2"> <h3 class="contact-title">Community</h3> <table class="contact-list"> <tbody> <tr> <td><a href="/products/rdm/roadmap/">Roadmap</a></td> </tr> <tr> <td> <a href="/getinvolved/">Get Involved</a> </td> </tr> <tr> <td> <a href="/events/">Events & Training</a> </td> </tr> <tr> <td> <a href="/support/">Hosting & Support</a> </td> </tr> <tr> <td> <a href="/governance/">Governance</a> </td> </tr> <tr> <td> <a href="/people/">People</a> </td> </tr> </tbody> </table> </div> <div class="col-md-2"> <h3 class="contact-title">Keep in touch</h3> <table class="contact-list"> <tbody> <tr> <td> <a href="https://github.com/inveniosoftware">GitHub</a> </td> </tr> <tr> <td> <a href="https://discord.gg/8qatqBC">Chatroom</a> </td> </tr> <tr> <td> <a href="https://invenio-talk.web.cern.ch">Talk</a> </td> </tr> <tr> <td> <a href="https://twitter.com/inveniosoftware">Twitter</a> </td> </tr> <tr> <td><a href="/blog/">Blog</a></td> </tr> </tbody> </table> </div> </div> </div> </div> <div class="footer-bottom"> <div class="container"> <div class="row"> <div class="col-md-12 centered"> <span>Copyright © 2016-<span id="currentYear"></span> CERN & contributors. Icons by <a href="http://fontawesome.io/">Font Awesome</a> and <a href="https://icons8.com/">Icons8</a>. Text is licensed under Creative Commons Attribution 4.0 International.<br> <span class="text-muted"><small></small></span> </div> </div> </div> </div> </footer> <script> var currentDate = new Date(); var currentYear = currentDate.getFullYear(); document.getElementById("currentYear").innerText = currentYear; </script> <!-- Matomo --> <script> var _paq = window._paq = window._paq || []; /* tracker methods like "setCustomDimension" should be called before "trackPageView" */ _paq.push(['trackPageView']); _paq.push(['enableLinkTracking']); (function() { var u="https://webanalytics.web.cern.ch/"; _paq.push(['setTrackerUrl', u+'matomo.php']); _paq.push(['setSiteId', '233']); var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0]; g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s); })(); </script> <!-- End Matomo Code --> <script> //Main navigation scroll spy for shadow $(window).scroll(function() { var y = $(window).scrollTop(); if (y > 0) { $(".invenio-navbar").addClass('invenio-navbar-not-top'); } else { $(".invenio-navbar").removeClass('invenio-navbar-not-top'); } }); </script> </body>