diff --git a/Documentation/Administrator/Index.rst b/Documentation/Administrator/Index.rst index b44375947..52ae2cc5b 100644 --- a/Documentation/Administrator/Index.rst +++ b/Documentation/Administrator/Index.rst @@ -76,12 +76,48 @@ Upgrade-Wizards There are two upgrade wizards available. If you upgrade an existing installation, you should use them. Without, you have to configure all plugins from scratch and the collection record images won't be visible. +Database Upgrade +---------------- + +Run the database upgrade (``Maintenance > Analyze Database Structure``) and *delete* the columns ``metadata`` and ``metadata_sorting``. +(These columns are not used anymore by Kitodo.Presentation 4. If they are not removed, indexing new documents may fail.) + Set the Storage Pid ------------------- -The Kitodo.Presentation configuration folder must be set by TypoScript constnat `plugin.tx_dlf.persistence.storagePid` now. +The Kitodo.Presentation configuration folder must be set by TypoScript constant `plugin.tx_dlf.persistence.storagePid` now. This setting is available for all plugins in the page tree. The plugin specific `pages` has been removed. +Migrate Plugin Settings +----------------------- + +When plugins are configured in TypoScript, the values must now be wrapped in a ``settings`` key. + +.. code-block:: typoscript + + // Before + plugin.tx_dlf_pageview { + features = OverviewMap + } + + // After + plugin.tx_dlf_pageview { + settings { + features = OverviewMap + } + } + +Fluid Rendering +--------------- + +All plugins now use the Fluid Template Engine instead of marker templates for outputting HTML. + +* If you override a ``.tmpl`` file, it needs to be migrated to an HTML/Fluid template. + +* The TypoScript setting ``templateFile`` has been removed. + +See the :ref:`Plugin Reference ` for more information. + Plugin Feeds ------------ @@ -110,15 +146,35 @@ Collection plugin. Both plugins have their own "listview" which basically uses t With the ListView plugin, you still achieve the following situation: -``` -page 1: Search Plugin (main column) - | - v - +--> page 2: ListView Plugin (main column) | Search Plugin (sidebar) e.g with forceAbsoluteUrlHttps - ^ - | -page 3: Collection Plugin (main column) -``` +:: + + page 1: Search Plugin (main column) + | + v + +--> page 2: ListView Plugin (main column) | Search Plugin (sidebar) e.g with forceAbsoluteUrlHttps + ^ + | + page 3: Collection Plugin (main column) + +The setting ``targetPid`` has been renamed to ``targetPidPageView``. + +Toolbox Plugins +--------------- + +Previously, the toolbox plugins (located in namespace ``Kitodo\Dlf\Plugin\Tools``) could be used directly. +This is not possible anymore, but instead they must be included via the overarching ``Toolbox`` plugin. + +.. code-block:: typoscript + + // Before + lib.imagemanipulation < tt_content.list.20.dlf_imagemanipulationtool + + // After + lib.imagemanipulation < tt_content.list.20.dlf_toolbox { + settings { + tools = imagemanipulationtool + } + } Update CSP ---------- @@ -126,6 +182,11 @@ Update CSP In Kitodo.Presentation 4.0, the way how static images are loaded has changed. Plase make sure that ``blob:`` URLs are not forbidden by your Content Security Policy. +Other Changes +------------- + +* jQuery and OpenLayers have been updated. If you manually include them, update the paths. + Version 3.2 -> 3.3 ================== diff --git a/Documentation/Features/PageView.rst b/Documentation/Features/PageView.rst index af16b4801..a598b467c 100644 --- a/Documentation/Features/PageView.rst +++ b/Documentation/Features/PageView.rst @@ -86,9 +86,9 @@ Additional OpenLayers controls may be configured in TypoScript: .. code-block:: typoscript plugin.tx_dlf_pageview { - settings { - features = OverviewMap,ZoomPanel - } + settings { + features = OverviewMap,ZoomPanel + } } These are created in ``dlfViewer::createControls_()``. @@ -106,16 +106,16 @@ To insert links for activating these tools into the default PageView template, t .. code-block:: typoscript plugin.tx_dlf_pageview { - settings { - basket { - magnifier = 1 - crop = 1 - } - - // The basket must be configured for these settings to take effect - basketButton = 1 - targetBasket = 123 + settings { + basket { + magnifier = 1 + crop = 1 } + + // The basket must be configured for these settings to take effect + basketButton = 1 + targetBasket = 123 + } } Magnifier diff --git a/Documentation/Plugins/Index.rst b/Documentation/Plugins/Index.rst index ca419f3e3..9439e62f8 100644 --- a/Documentation/Plugins/Index.rst +++ b/Documentation/Plugins/Index.rst @@ -22,6 +22,8 @@ Kitodo Plugin Reference Common Settings --------------- +.. _fluidplugins: + Fluid Template Configuration ----------------------------