Merge pull request #522 from sebastian-meyer/prepare-release

Prepare release of 3.1.0

Documentation/Community/Index.rst

@@ -13,13 +13,13 @@ Community
 
 GitHub Repository
 -----------------
-All sources of Kitodo.Presentation and other Kitodo software is hosted at
+All sources of Kitodo.Presentation and other Kitodo software are hosted at
 `GitHub <https://github.com/kitodo/kitodo-presentation>`_.
 
 If you find a bug, please report it to the Kitodo.Presentation
 `issue tracker on GitHub <https://github.com/kitodo/kitodo-presentation/issues>`_.
 
-Pull-requests are greatly appreciated ;-)
+Pull-requests are greatly appreciated! ;-)
 
 Mailing Lists
 -------------
@@ -28,10 +28,10 @@ If you have questions about this extensions or about other
 `Kitodo <https://www.kitodo.org/en/>`_ components you may check the mailing
 lists of Kitodo:
 
-* Community mailing list helps on any question about installation and usage of
-  the software. Email-address is [email protected]. The list archive
+* Community mailing list helps on any questions about installation and usage of
+  the software. Its address is [email protected]. The list archive
   can be found at https://maillist.slub-dresden.de/pipermail/kitodo-community/
-* Developer mailing list discusses implementation details. Email-address is
+* Developer mailing list discusses implementation details. Its address is
   [email protected]. The list archive can be found at
   https://maillist.slub-dresden.de/pipermail/kitodo-developer/
 

Documentation/Configuration/Index.rst

@@ -33,10 +33,8 @@ The default behaviour of TYPO3 is to call the pageNotFound handler and/or to sho
 
    TYPO3 Error-Message "Reason: Request parameters could not be validated (&cHash empty)"
 
-
-
 This is not the desired behaviour. You should configure in the TYPO3 install tool
-$TYPO3_CONF_VARS['FE'][pageNotFoundOnCHashError]=0 to show the requested page
+$TYPO3_CONF_VARS['FE']['pageNotFoundOnCHashError']=0 to show the requested page
 instead. The caching will be disabled in this case. This was the default
 behaviour before TYPO3 6.x.
 
@@ -63,7 +61,7 @@ Solr Installation
 This extension doesn't include Solr, but just a prepared configuration set.
 To setup Apache Solr, perform the following steps:
 
-1. Make sure you have Apache Solr 7.4 up and running.
+1. Make sure you have Apache Solr 7.x up and running.
     Download Solr from http://lucene.apache.org/solr/.
     Other versions since 5.0 should be possible but are not tested.
 
@@ -81,6 +79,6 @@ TypoScript Basic Configuration
 ******************************
 
 Please include the Template "Basic Configuration (dlf)". This template adds
-jQuery 2.2.1 to your page by setting the following typoscript:
+jQuery to your page by setting the following typoscript:
 
 :typoscript:`page.includeJSlibs.jQuery`

Documentation/Index.rst

@@ -27,13 +27,13 @@ Kitodo.Presentation
         It is highly customizable through a user-friendly backend and flexible design templates.
 
     :Keywords:
-        kitodo,digital framework,digitization,viewer,library,METS,OAI-PMH
+        kitodo,presentation,digitization,viewer,library,METS,OAI-PMH
 
     :Copyright:
-        ###YEAR###
+        since 2017
 
     :Author:
-        Kitodo. Key to digital objects e.V.
+        Kitodo Release Management Team
 
     :Email:
         [email protected]

Documentation/Introduction/Index.rst

@@ -34,7 +34,7 @@ Download of current version is `avaiable on GitHub <https://github.com/kitodo/ki
 Libraries using Kitodo.Presentation
 -----------------------------------
 
-The following libraries use Kitodo.Presentation for their digital collections:
+Amongst others the following libraries are using Kitodo.Presentation for their digital collections:
 
 * `SLUB Dresden <http://digital.slub-dresden.de/>`_
 * `UB "Georgius Agricola" at the TU Bergakademie Freiberg <http://digital.ub.tu-freiberg.de/>`_
@@ -52,9 +52,9 @@ handling, language localization, caching, etc., is possible within the
 Kitodo.Presentation functional modules. The entire system is multi-client
 capable, i.e. any number of instances of Kitodo.Presentation can be run within
 a single TYPO3 installation, each with its own configuration, search index,
-database, access permissions, visual design, etc.
+backend pages, access permissions, visual design, etc.
 
-Kitodo.Presentation offers a standard OAI-PMH 2-compliant interface for
+Kitodo.Presentation offers a standard OAI-PMH2-compliant interface for
 international search capability and digital metadata legibility. We recommend
 registering your Kitodo installation with the appropriate public OAI registry.
 
@@ -69,19 +69,19 @@ is a group of classes that build upon the TYPO3 API, adding
 Kitodo-specific functions, such as handling METS structures and library metadata
 in various formats, or linking external resources, such as OAI-PMH interfaces or
 Solr search engines. The API extensions are available to all TYPO3 extensions,
-which means that they can not only be used by Kitodo.Presentation, but by other
+which means that they can be used not only by Kitodo.Presentation, but by other
 extensions as well. Thus, commercial or other very specific functions, which
-are only necessary in single installations, aren’t part of the official
-Kitodo.Presentation release, but are created as separate extensions.
+are only necessary in single installations, don't need to be part of the official
+Kitodo.Presentation release, but can be created as separate extensions.
 
 Modules
 ^^^^^^^
 is a group of components that are integrated into the TYPO3 backend and
 manage the configuration of extensions as well as of digital resources, clients
-and collections. Currently, there is a module for client management and one for
-manually importing new resources or newly-indexed existing digital resources.
+and collections. Currently, there is a module for client management as well as
+integrations with the basic TYPO3 list module to manage the digital resources.
 In addition, they enable a highly granular configuration of structure and
-metadata handling as well as database management. Further, a command line
+metadata handling as well as database management. Furthermore, a command line
 interface is provided, which allows automation of procedures, such as importing
 digital resources.
 
@@ -90,8 +90,7 @@ Plugins
 are components that build the frontend output and provide various functions.
 All plugins can be precisely configured via GUI and freely dropped into
 TYPO3-managed web pages. All frontend outputs are based on design
-templates and are thus fully customizable. Currently, Kitodo.Presentation
-contains 12 plugins.
+templates and are thus fully customizable.
 
 .. _screenshots:
 

Documentation/Settings.cfg

@@ -1,22 +1,14 @@
-# This is the project specific Settings.yml file.
-# Place Sphinx specific build information here.
-# Settings given here will replace the settings of 'conf.py'.
-
-# Below is an example of intersphinx mapping declaration
-# Add more mappings depending on what manual you want to link to
-# Remove entirely if you don't need cross-linking
-
 [general]
-copyright = 2017-2019
 project = Kitodo.Presentation
-release = 3.0.0
+release = 3.1.0
+copyright = since 2017 by Kitodo Release Management Team
 
 [html_theme_options]
 github_branch = master
 github_repository = kitodo/kitodo-presentation
 
 project_contact = mailto:[email protected]
-project_home = https://github.com/kitodo/kitodo-presentation
+project_home = https://kitodo.org
 project_issues = https://github.com/kitodo/kitodo-presentation/issues
 project_repository = https://github.com/kitodo/kitodo-presentation
 

README.md

@@ -24,12 +24,24 @@ Kitodo.Presentation is highly customizable through a user-friendly backend and f
 Requirements
 ------------
 
-Kitodo.Presentation requires [TYPO3 8 LTS](https://get.typo3.org/8) with at least [PHP 7.0+](https://secure.php.net). It uses [MySQL 5.7+](https://www.mysql.com) or [MariaDB 10.2+](https://mariadb.com) as database and [Apache Solr 7.0+](https://lucene.apache.org/solr) via [Solarium 4.2+](http://www.solarium-project.org/) as search engine backend.
+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.
+
+Currently **TYPO3 8 ELTS** and **TYPO3 9 LTS** are supported with the following system requirements:
+
+| Component   | Constraints for 8 ELTS | Constraints for 9 LTS |
+| ----------- | ---------------------- | --------------------- |
+| TYPO3       | 8.7.x                  | 9.5.x                 |
+| PHP         | 7.2.x - 7.4.x          | 7.2.x - 7.4.x         |
+| MySQL       | 5.7.x                  | 5.7.x                 |
+| MariaDB     | 10.2.x - 10.2.26       | 10.2.x - 10.3.x       |
+| Apache Solr | 7.x                    | 7.x                   |
+
+Application level dependencies are handled by [Composer](https://getcomposer.org) (see [composer.json](./composer.json)).
 
 Kitodo. Key to digital objects
 ------------------------------
 
-[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 maintained by the [Library of Congress](https://loc.gov/standards). 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 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.
 
 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).
 

composer.json

@@ -22,10 +22,10 @@
   "support": {
     "issues": "https://github.com/kitodo/kitodo-presentation/issues",
     "source": "https://github.com/kitodo/kitodo-presentation",
-    "docs": "https://docs.typo3.org/typo3cms/extensions/dlf/"
+    "docs": "https://docs.typo3.org/p/kitodo/presentation/master/en-us/"
   },
   "require": {
-    "php": "^7.3",
+    "php": "^7.3|^7.4",
     "ext-curl": "*",
     "ext-dom": "*",
     "ext-json": "*",

ext_emconf.php

@@ -17,15 +17,14 @@
     'category' => 'misc',
     'constraints' => [
         'depends' => [
-            'php' => '7.0.0-',
+            'php' => '7.3.0-7.4.99',
             'typo3' => '8.7.0-9.5.99'
         ],
         'conflicts' => [],
         'suggests' => []
     ],
     'state' => 'stable',
     'uploadfolder' => false,
-    'createDirs' => '',
     'clearCacheOnLoad' => false,
     'author' => 'Sebastian Meyer (Maintainer)',
     'author_email' => '[email protected]',