Merge pull request #604 from albig/prepare-release-3.2.0

Prepare release 3.2.0

Documentation/Administrator/Index.rst

@@ -8,9 +8,9 @@
 
 .. _admin-manual:
 
-====================
+####################
 Administrator Manual
-====================
+####################
 
 .. contents::
    :local:
@@ -22,15 +22,40 @@ Administrator Manual
 Installation
 ************
 
-It is highly recommended to install this extension by using composer.
+Composer Mode
+=============
+
+It is highly recommended to install this extension by using composer. This is the only supported way.
+
+Please run the following commands in your webroot where the TYPO3 :file:`composer.json` is located:
+
+.. rst-class:: bignums-xxl
+
+#. Fetch Kitodo.Presentation with Composer
+
+   .. code-block:: shell
+
+      composer require kitodo/presentation:^3.2
+
+#. Install and Activate the Extension
+
+   .. code-block:: shell
+
+      ./vendor/typo3 extension:activate dlf
+
+
+Classic Mode
+============
 
 However, there are two options to install the required packages solarium/solarium and symfony/event-dispatcher in non-composer mode:
 
-a. Run the command "composer update" within the directory of the extension.
+a. Run the command :php:`composer update` within the directory of the extension.
    All required packages are downloaded automatically to the vendor subdirectory.
 
 b. Download the required packages manually to vendor/solarium/solarium and vendor/symfony/event-dispatcher.
-   Please check the require sections (composer.json) of the extension, solarium and event-dispatcher
-   to download and install matching versions.
+   Please check the require sections in :file:`composer.json` of the extension,
+   solarium and event-dispatcher to download and install matching versions.
 
-After the installation of the packages in non-composer mode you have to deactivate and (re-)activate the extension in the extension manager to trigger the TYPO3 autoloader to rebuild the classmap.
+After the installation of the packages in non-composer mode you have to deactivate
+and (re-)activate the extension in the extension manager to trigger the TYPO3
+autoloader to rebuild the classmap.

Documentation/Community/Index.rst

@@ -8,8 +8,9 @@
 
 .. _known-problems:
 
+#########
 Community
-=========
+#########
 
 GitHub Repository
 -----------------

Documentation/Configuration/Index.rst

@@ -8,9 +8,9 @@
 
 .. _system_setup:
 
-============
+############
 System Setup
-============
+############
 
 .. contents::
     :local:
@@ -22,71 +22,62 @@ System Setup
 TYPO3 Setup
 ***********
 
+Extension Configuration
+=======================
+
+This step is obligatory!
+
+* go to the Extension Configuration (:file:`ADMIN TOOLS -> Settings -> Extension Configuration`).
+* open dlf
+* check and save the configuration
+
+After this step, the require tx_dlf_formats records are created on the root page (uid=0).
+
+TYPO3 Configuration
+===================
+
 The navigation plugin provides a page selection dropdown input field. The
 resulting action url cannot contain a valid cHash value.
 
 The default behaviour of TYPO3 is to call the pageNotFound handler and/or to show an exception:
 
 .. figure:: ../Images/Configuration/typo3_pagenotfoundonchasherror.png
-   :width: 800px
+   :width: 820px
    :alt: TYPO3 Error-Message "Reason: Request parameters could not be validated (&cHash empty)"
 
    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
+This is not the desired behaviour. You should configure in
+:file:`ADMIN TOOLS -> Settings -> Configure Installation-Wide Options`
+:file:`$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.
 
-.. figure:: ../Images/Configuration/typo3_install_pagenotfoundonchasherror.png
-   :width: 800px
+.. figure:: ../Images/Configuration/New\ TYPO3\ site\ \[TYPO3\ CMS\ 9.5.26\ .png
+   :width: 820px
    :alt: TYPO3 Configuration of pageNotFoundOnCHashError in Install Tool
 
-   TYPO3 Configuration of pageNotFoundOnCHashError in Install Tool
+   TYPO3 Configuration of pageNotFoundOnCHashError in Settings Module
 
-The install tool writes this configuration to typo3conf/LocalConfiguration.php::
+This configuration is written to typo3conf/LocalConfiguration.php::
 
     'FE' => [
             'pageNotFoundOnCHashError' => '0',
             'pageNotFound_handling' => '',
         ],
 
 
-.. _configuration-solr:
-
-*****************
-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.x up and running.
-    Download Solr from http://lucene.apache.org/solr/.
-    Other versions since 5.0 should be possible but are not tested.
-
-2. Copy the lib/ApacheSolr/configsets/dlf to $SOLR_HOME/configsets/dlf.
-
-3. Using basic authentication is optional but recommended.
-    The documentation is available here:
-    https://lucene.apache.org/solr/guide/7_4/basic-authentication-plugin.html
-
-
-.. _configuration-typoscript:
-
-******************************
 TypoScript Basic Configuration
-******************************
+------------------------------
 
 Please include the Template "Basic Configuration (dlf)". This template adds
 jQuery to your page by setting the following typoscript:
 
 :typoscript:`page.includeJSlibs.jQuery`
 
 
-******************
 Slug Configuration
-******************
+------------------
 
 With TYPO3 9.5 it is possible to make speaking urls with the builtin advanced
 routing feature ("Slug"). This may be used for extensions too.
@@ -118,3 +109,26 @@ The following code is an example of an routeEnhancer for the workview page on ui
          id: '(\d+)|(http.*xml)'
          page: \d+
          double: '[0-1]'
+
+
+.. _configuration-solr:
+
+*****************
+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.7 or 8.8 and running.
+    Download Solr from https://solr.apache.org/downloads.html.
+    Other versions may work but are not tested.
+
+2. Copy the lib/ApacheSolr/configsets/dlf to $SOLR_HOME/configsets/dlf.
+
+3. Using basic authentication is optional but recommended.
+    The documentation is available here:
+    https://lucene.apache.org/solr/guide/7_4/basic-authentication-plugin.html
+
+
+.. _configuration-typoscript:

Documentation/Index.rst

@@ -7,9 +7,9 @@
 
 .. _start:
 
-=============================================================
+###################
 Kitodo.Presentation
-=============================================================
+###################
 
 .. only:: html
 
@@ -48,7 +48,9 @@ Kitodo.Presentation
     The content of this document is related to TYPO3,
     a GNU/GPL CMS/Framework available from `www.typo3.org <http://www.typo3.org/>`_.
 
-    **Table of Contents**
+*****************
+Table of Contents
+*****************
 
 .. toctree::
     :maxdepth: 5

Documentation/Introduction/Index.rst

@@ -8,14 +8,16 @@
 
 .. _introduction:
 
+############
 Introduction
-============
+############
 
 
 .. _what-it-does:
 
+*************************
 About Kitodo.Presentation
--------------------------
+*************************
 
 Kitodo.Presentation is a powerful framework for building a METS-based digital
 library. It is highly customizable through an user-friendly backend and flexible
@@ -29,20 +31,25 @@ Kitodo.Presentation provides a comprehensive toolset covering all basic
 requirements for presenting digitized media: books, archivalia, digital
 depositary copies, manuscripts and letters, prints, newspapers and magazines.
 
-Download of current version is `avaiable on GitHub <https://github.com/kitodo/kitodo-presentation>`_.
+Download of current version is `available on GitHub <https://github.com/kitodo/kitodo-presentation>`_.
 
+***********************************
 Libraries using Kitodo.Presentation
------------------------------------
-
-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/>`_
-* `SUB Hamburg <http://digitalisate.sub.uni-hamburg.de/>`_
-* `Gottfried Wilhelm Leibniz Library Hannover <http://digitale-sammlungen.gwlb.de/>`_
+***********************************
+
+Amongst others Kitodo.Presentation is known to be used on the following digital presentations:
+
+* `Akademie der Künste <https://digital.adk.de/>`_
+* `Börsenblatt digital <https://www.boersenblatt-digital.de/>`_
+* `Gottfried Wilhelm Leibniz Library Hannover <https://digitale-sammlungen.gwlb.de/>`_
+* `Orff-Zentrum München <https://www.ozm.bayern.de/>`_
+* `Sachsen.Digital <https://sachsen.digital/>`_
+* `SLUB Dresden <https://digital.slub-dresden.de/>`_
+* `SUB Hamburg <https://digitalisate.sub.uni-hamburg.de/>`_
+* `UB "Georgius Agricola" at the TU Bergakademie Freiberg <https://digital.ub.tu-freiberg.de/>`_
 * `UB Mannheim <https://digi.bib.uni-mannheim.de/>`_
-* `Orff-Zentrum München <http://www.orff-zentrum.de/>`_
-* `Württembergische Landesbibliothek Stuttgart <http://digital.wlb-stuttgart.de/digitale-sammlungen/>`_
+* `Universitätsbibliothek der LMU München <https://digi.ub.uni-muenchen.de/>`_
+* `Württembergische Landesbibliothek Stuttgart <http://digital.wlb-stuttgart.de/>`_
 
 In Kitodo.Presentation, the METS/MODS formats are flexible. Digital collections
 can be configured for any METS-based format, e.g. METS/TEI for manuscripts.
@@ -58,13 +65,14 @@ 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.
 
+*******************
 Software Components
--------------------
+*******************
 
 The software primarily consists of three modules:
 
 Commons
-^^^^^^^
+=======
 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
@@ -75,7 +83,7 @@ are only necessary in single installations, don't need to be part of the officia
 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 as well as
@@ -86,7 +94,7 @@ interface is provided, which allows automation of procedures, such as importing
 digital resources.
 
 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
@@ -95,38 +103,38 @@ templates and are thus fully customizable.
 .. _screenshots:
 
 Screenshots
------------
+===========
 
-Some examples of Kitodo.Presentation in action on the `digital collection of SLUB Dresden <http://digital.slub-dresden.de/>`_:
+Some examples of Kitodo.Presentation in action on the `Digital Collection of SLUB Dresden <https://digital.slub-dresden.de/>`_:
 
-.. figure:: ../Images/Introduction/KitodoPresentaion-SLUB1.PNG
-   :width: 500px
+http://digital.slub-dresden.de/id457052678
+
+.. figure:: ../Images/Introduction/Digitale\ Sammlungen\ \ Colloquia\ Lutheri\ conscripta\ a\ quibusdam\ et\ alia\ quaedam\ addita\ sunt.\ Thesaurus\ theologiae\ -\ Mscr.Dresd.A.180.d.png
+   :width: 820px
    :alt: Mscr.Dresd.A.180.d
 
    Mscr.Dresd.A.180.d
 
-   Find this document in `SLUB digital collections. <http://digital.slub-dresden.de/werkansicht/dlf/162147/7/>`__
-
-.. figure:: ../Images/Introduction/KitodoPresentation-SLUB-DresdenDaily.PNG
-   :width: 500px
-   :alt: Newspaper an other periodicals
+http://digital.slub-dresden.de/id416971482-19060601
 
-   Newspaper an Other Periodicals
+.. figure:: ../Images/Introduction/Digitale\ Sammlungen\ \ The\ Daily\ record\ and\ the\ Dresden\ daily\ \ \ 01.06.1906.png
+   :width: 820px
+   :alt: Newspaper issue with full-text switched on
 
-   Find this document in `SLUB digital collections. <http://digital.slub-dresden.de/werkansicht/dlf/120620/1/>`__
+   Newspaper Issue with Full-text Switched on
 
-.. figure:: ../Images/Introduction/KitodoPresentation-SLUB-Kalenderansicht.PNG
-   :width: 500px
-   :alt: Calendar for Digitised Newspapers
+http://digital.slub-dresden.de/id501434038
 
-   Calendar for Digitised Newspapers
+.. figure:: ../Images/Introduction/Digitale\ Sammlungen\ \ Dresdner\ Nachrichten.png
+   :width: 820px
+   :alt: All Years Overview of a Newspaper Title
 
-   Find this document in `SLUB digital collections. <http://digital.slub-dresden.de/werkansicht/dlf/120676/1/>`__
+   All Years Overview of a Newspaper Title
 
-.. figure:: ../Images/Introduction/KitodoPresentation-SLUB-Volltexte.PNG
-   :width: 500px
-   :alt: Full Text and OCR Presentation
+http://digital.slub-dresden.de/id501434038-1942
 
-   Full Text and OCR Presentation
+.. figure:: ../Images/Introduction/Digitale\ Sammlungen\ \ Dresdner\ Nachrichten\ \ \ 1942.png
+   :width: 820px
+   :alt: Calendar View of a Newspaper Year
 
-   Find this document in `SLUB digital collections. <http://digital.slub-dresden.de/werkansicht/dlf/120676/1/>`_
+   Calendar View of a Newspaper Year

Documentation/Plugins/Index.rst

@@ -8,9 +8,9 @@
 
 .. _configuration:
 
-================
+################
 Plugin Reference
-================
+################
 
 .. contents::
     :local:
@@ -229,7 +229,7 @@ now.
  - :Property:
        initialDocument
    :Data Type:
-       :ref:`t3tsref:data-type-db`
+       :ref:`t3tsref:data-type-integer`
    :Default:
 
  - :Property: