kitodo-presentation/README.md

5.8 KiB
Raw Permalink Blame History

Kitodo.Presentation

Kitodo.Presentation is a feature-rich framework for building a METS- or IIIF-based digital library. It is part of the Kitodo Digital Library Suite.

Kitodo.Presentation is highly customizable through a user-friendly backend and flexible design templates. Since it is based on the great free and open source Content Management System TYPO3, it integrates perfectly with your website and can easily be managed by editors. Kitodo.Presentation provides a comprehensive toolset covering all requirements for presenting digitized media. It implements international standards such as IIIF Image API, IIIF Presentation API, OAI Protocol for Metadata Harvesting, METS, MODS, TEI, ALTO, and can be configured to support any other descriptive XML format using simple XPath expressions. With Kitodo.Presentation you can publish digitized books, manuscripts, periodicals, newspapers, archival materials, audio and video.

For a complete overview of all features, visit the Kitodo homepage.

Codacy Grade

Kitodo was formerly known as Goobi. Older releases can be found on Launchpad.

Requirements

Kitodo.Presentation requires TYPO3 with PHP. It uses MySQL or MariaDB as database and Apache Solr via Solarium as search engine backend.

Currently TYPO3 10.4 ELTS and TYPO3 11.5 LTS is supported with the following system requirements:

Component Constraints for 10 LTS Constraints for 11 LTS
TYPO3 10.4.43+ 11.5.35+
PHP 7.4.33 7.4.33
MySQL 5.7.x - 8.0.x 5.7.9 - 8.0.x
MariaDB 10.2.7 - 10.11.x 10.2.7 - 10.11.x
Apache Solr 8.x 8.x
OCR Highlighting Plugin 0.8.x-solr78 0.8.x-solr78

Application level dependencies are handled by Composer (see composer.json).

Kitodo. Digital Library Modules

Kitodo is an open source software suite intended to support the digitisation of cultural assets for libraries, archives, museums, and documentation centres of all sizes. A range of modules with open interfaces support the production, presentation, and archiving of digital assets. The software can be flexibly used for a multitude of digitisation strategies and scalable business models for in-house projects, purely corporate services, or hybrid endeavours. Kitodo is backed and continually updated by a dynamic user and developer community and the non-profit association Kitodo e. V.

Information | Communication | Support

For general information and news, please visit our website.

As a system that has to meet the diverse requirements of a wide variety of institutions and the materials they want to digitise, Kitodo is a rather complex software solution, the installation and configuration of which can be challenging, especially for users with limited IT capacities and know-how.

To ensure it can best advise and assist users on technical and organisational issues, the Kitodo community has established support structures for the following typical scenarios.

  1. Users who have clearly defined questions relating to the use and development of Kitodo or Kitodo modules are well-served by the Kitodo mailing list. They will typically receive helpful answers from the community or the Kitodo release managers within a short period of time. If this should be unsuccessful for any reason, the Kitodo association office will address your matter to an experienced member institution. You do not need to be a member of the association to use the mailing list. The list archive provides an impression of the topics and conversations.
  2. For users who occasionally need more extensive advice and possibly also on-site practical assistance for Kitodo installation, workflow modelling, etc., the Kitodo office maintains a list of voluntary mentors. Requests can be directed to these proven experts from various libraries by the association office. More information is available from the association office.
  3. For institutions that would like an initial and extensive introduction to Kitodo in the form of a product presentation or ongoing support, in particular on-site, we are happy to provide a list of companies that to the best of our knowledge have already worked in these fields. To obtain the company list, please also use the association office address. Please bear in mind that the association cannot provide further assistance in selecting service providers.

Getting started