Skip to content

[MAINTENANCE] Add missing documentation for upgrading Collection plugin #1848

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sebastian-meyer merged 2 commits into from
Feb 23, 2026
Merged

[MAINTENANCE] Add missing documentation for upgrading Collection plugin #1848

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
33584da
Add missing documentation for upgrading Collection plugin
beatrycze-volk Feb 20, 2026
bf1e425
Merge branch 'main' into doc
sebastian-meyer Feb 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 16 additions & 6 deletions Documentation/Administrator/Index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,11 +226,21 @@ d. Reindex all documents. This can be done by the kitodo:reindex CLI command wit
Furthermore version 5.1 supports the use of Solr Managed Schemas to update the schemas automatically during the update of the extension.
To use this feature you have to change the schemaFactory within solrconfig.xml from "ClassicIndexSchemaFactory" to "ManagedIndexSchemaFactory".

Version 5.x -> 6.0
==================

Plugin Collection
-----------------

The Collection plugin can now be used to display a list of collections or overview of a single collection. The list of collections will be
displayed if more than one collection is inserted to the :code:`collections` setting in the FlexForm. There exists possibility to still
display the list of collections even if only one collection is inserted, by checking the FlexForm setting :code:`dont_show_single`.

Version 5.1 & Version 6.0 -> 7.0
==================

Version 7.0 introduces a new Solr field :code:`structure_path`, that provides context in the ListView about where search results appear in the structure tree. Indexing requires
the field to be present in your running Solr instance, thus making the update of the schema.xml mandatory.
Version 7.0 introduces a new Solr field :code:`structure_path`, that provides context in the ListView about where search results appear in
the structure tree. Indexing requires the field to be present in your running Solr instance, thus making the update of the schema.xml mandatory.

Steps to Update your Solr schema.xml
---------------
Expand All @@ -247,10 +257,10 @@ This setting is available for all plugins in the page tree.
Plugin ListView
---------------

The ListView plugin has now a new setting 'Show breadcrumb/path to result location within the structure map', which is deactivated by default. When activated the
search results will display a string similar to a breadcrumb, that shows the label or type of the parents structures up to but excluding the toplevel structure. The
structure path will always be generated during indexing, the plugin settings toggles wether it will be displayed or not. Documents that not have been reindexed yet
will not display a structure path.
The ListView plugin has now a new setting 'Show breadcrumb/path to result location within the structure map', which is deactivated by default.
When activated the search results will display a string similar to a breadcrumb, that shows the label or type of the parents structures up to
but excluding the toplevel structure. The structure path will always be generated during indexing, the plugin settings toggle whether it will
be displayed or not. Documents that not have been reindexed yet will not display a structure path.

*******
Logging
Expand Down
Loading