Merge branch 'ocr-highlighting-plugin' of github.com:kitodo/kitodo-presentation into ocr-highlighting-plugin

This commit is contained in:
Alexander Bigga 2021-10-02 14:45:03 +02:00
commit 1c377b9271
1 changed files with 42 additions and 10 deletions

View File

@ -1,5 +1,4 @@
Kitodo.Presentation
===================
# 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.
@ -17,8 +16,9 @@ For a complete overview of all features, visit the [Kitodo homepage](https://www
[![LGTM Alerts](https://img.shields.io/lgtm/alerts/g/kitodo/kitodo-presentation.svg?logo=lgtm)](https://lgtm.com/projects/g/kitodo/kitodo-presentation/alerts/)
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/kitodo/kitodo-presentation/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/kitodo/kitodo-presentation/?branch=master)
Requirements
------------
Kitodo was formerly known as Goobi. Older releases can be found on [Launchpad](https://launchpad.net/goobi-presentation).
## Requirements
Kitodo.Presentation requires [TYPO3](https://get.typo3.org) with [PHP](https://secure.php.net). It uses [MySQL](https://www.mysql.com) or [MariaDB](https://mariadb.com) as database and [Apache Solr](https://lucene.apache.org/solr) via [Solarium](http://www.solarium-project.org/) as search engine backend.
@ -35,13 +35,45 @@ Currently **TYPO3 9.5 LTS** is supported with the following system requirements:
Application level dependencies are handled by [Composer](https://getcomposer.org) (see [composer.json](./composer.json)).
Kitodo. Key to digital objects
------------------------------
## Kitodo. Digital Library Modules
[Kitodo](https://github.com/kitodo) is an open source software suite intended to support mass digitization projects for cultural heritage institutions. Kitodo is widely-used and cooperatively maintained by major German libraries and digitization service providers. The software implements international standards such as IIIF, METS, MODS, ALTO, TEI, and other formats. Kitodo consists of several independent modules serving different purposes such as controlling the digitization workflow, enriching descriptive and structural metadata, and presenting the results to the public in a modern and convenient way.
[Kitodo](https://github.com/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.
To get more information, visit the [Kitodo homepage](https://www.kitodo.org). You can also follow Kitodo News on [Twitter](https://twitter.com/kitodo_org).
## Information | Communication | Support
---
For general information and news, please visit our [website](https://www.kitodo.org) and follow us on [Twitter](https://twitter.com/kitodo_org).
Kitodo was formerly known as Goobi. Older releases can be found on [Launchpad](https://launchpad.net/goobi-presentation).
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](https://maillist.slub-dresden.de/cgi-bin/mailman/listinfo/kitodo-community). 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](https://maillist.slub-dresden.de/pipermail/kitodo-community/)
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](contact@kitodo.org).
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](contact@kitodo.org). Please bear in mind that the
association cannot provide further assistance in selecting service providers.
## Getting started
### Kitodo.Production
* [Installation Guides](https://github.com/kitodo/kitodo-production/wiki/Installationsanleitung)
* [User documentation](https://github.com/kitodo/kitodo-production/wiki/)
* [Developer documentation](https://kitodo-production.readthedocs.io/en/latest/)
### Kitodo.Presentation
* [Extension Documentation](https://docs.typo3.org/p/kitodo/presentation/master/en-us/)
* [DDEV Development Environment](https://github.com/kitodo/ddev-kitodo-presentation)
* [Demo server](https://presentation-demo.kitodo.org/)