-
Notifications
You must be signed in to change notification settings - Fork 45
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[MAINTENANCE] Update requirements documentation
- Loading branch information
1 parent
bd8cb78
commit f4f53a8
Showing
2 changed files
with
29 additions
and
63 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,27 +1,16 @@ | ||
| # 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 a feature-rich framework for building a METS- or IIIF-based digital library. It is part of the [Kitodo Digital Library Suite](https://www.kitodo.org). | ||
|
|
||
| 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](https://typo3.org), 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](https://iiif.io/api/image), [IIIF Presentation API](https://iiif.io/api/presentation), [OAI Protocol for Metadata Harvesting](https://www.openarchives.org/OAI/openarchivesprotocol.html), [METS](https://www.loc.gov/standards/mets), [MODS](https://www.loc.gov/standards/mods), [TEI](https://www.tei-c.org), [ALTO](https://www.loc.gov/standards/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, 3D objects, audio and video. | ||
| Kitodo.Presentation is highly customizable via a user-friendly backend and flexible design templates. Since it is based on the great free and open source Content Management System [TYPO3](https://typo3.org), 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](https://iiif.io/api/image), [IIIF Presentation API](https://iiif.io/api/presentation), [OAI Protocol for Metadata Harvesting](https://www.openarchives.org/OAI/openarchivesprotocol.html), [METS](https://www.loc.gov/standards/mets), [MODS](https://www.loc.gov/standards/mods), [TEI](https://www.tei-c.org), [ALTO](https://www.loc.gov/standards/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, 3D objects, audio and video. | ||
|
|
||
| For a complete overview of all features, visit the [Kitodo homepage](https://www.kitodo.org/software/kitodopresentation/features). | ||
|
|
||
| *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://www.php.net). It uses [MySQL](https://www.mysql.com) or [MariaDB](https://mariadb.com) as database and [Apache Solr](https://solr.apache.org) via [Solarium](https://www.solarium-project.org) as search engine backend. | ||
|
|
||
| Currently **TYPO3 11.5 ELTS** and **TYPO3 12.4 LTS** is supported with the following system requirements: | ||
|
|
||
| | Component | Constraints for 11 LTS | Constraints for 12 LTS | | ||
| | ----------------------- | ---------------------- | ---------------------- | | ||
| | TYPO3 | 11.5.37+ | 12.4.16+ | | ||
| | PHP | 7.4.x - 8.3.x | 8.1.x - 8.3.x | | ||
| | MySQL | 5.7.9 - 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 | | ||
| Kitodo.Presentation requires [**TYPO3 v11**](https://get.typo3.org/version/11) or [**TYPO3 v12**](https://get.typo3.org/version/12). Additionally, [**Apache Solr v8.11 - v9.7**](https://solr.apache.org) with [**solr-ocrhighlighting v0.9.1+**](https://github.com/dbmdz/solr-ocrhighlighting/releases) are required as search engine backend. | ||
|
|
||
| Application level dependencies are handled by [Composer](https://getcomposer.org) (see [composer.json](./composer.json)). | ||
|
|
||
|
|
@@ -33,29 +22,16 @@ Application level dependencies are handled by [Composer](https://getcomposer.org | |
|
|
||
| For general information and news, please visit our [website](https://www.kitodo.org). | ||
|
|
||
| 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/mailman3/postorius/lists/kitodo-community.kitodo.org/). 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/mailman3/hyperkitty/list/[email protected]/) | ||
| 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](mailto:[email protected]). | ||
| 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](mailto:[email protected]). Please bear in mind that the | ||
| association cannot provide further assistance in selecting service providers. | ||
| 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/mailman3/postorius/lists/kitodo-community.kitodo.org/). 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. | ||
| 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](mailto:[email protected]). | ||
| 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](mailto:[email protected]). Please bear in mind that the association cannot provide further assistance in selecting service providers. | ||
|
|
||
| ## Getting started | ||
|
|
||
| * [Extension Documentation](https://docs.typo3.org/p/kitodo/presentation/master/en-us/) | ||
| * [Extension Documentation](https://kitodo.github.io/kitodo-presentation) | ||
| * [DDEV Development Environment](https://github.com/kitodo/ddev-kitodo-presentation) | ||
| * [Demo Server](https://presentation-demo.kitodo.org/) | ||