Repository navigation
[DOCUMENTATION] Update and fix the outdated documentation manual - #2174
Merged
Merged
Conversation
Update the RST manual against the current code. The changes below only touch the official documentation; no code is modified. User/Index: - correct CLI options: --quiet (not --quite), --solr (not ---solr) - kitodo:harvest uses --owner/-o (not --lib/-l) - document --softCommit for index/reindex/harvest/delete - document --use-cache/-uc for kitodo:reindex - kitodo:optimize has no --dry-run and the standard Symfony options - kitodo:delete no longer has --verbose Administrator/Index: - note the requirements and add a Requirements table - use the composer-based TYPO3 CLI (./vendor/bin/typo3) to activate dlf Configuration/Index: - page.includeJSFooterlibs.jQuery (not page.includeJSlibs.jQuery) - Solr 8.11 or 9.x, the modules (not contrib) directory and the 0.9.1 solr-ocrhighlighting build Plugins/Index: - fix tool names (rotationTool, searchInDocumentTool, zoomTool) and the new tools (annotationTool, viewerSelectionTool) - all tools are rendered by the single dlf_toolbox plugin, so the example configurations use plugin.tx_dlf_toolbox instead of the non-existing plugin.tx_dlf_<tool> objects - add Annotation and Multi View chapters - Page View: basket.crop / basket.magnifier (nested), multiViewType and the OpenLayers features values - Page Grid: drop the placeholder default (Navigation.tmpl does not exist) - Navigation: add the documentBack / documentForward features - OAI-PMH: document the solrcore and solrLimit settings - Search: drop the non-existing limit FlexForm field, add solrcore, facetCollections and showLogicalPageField, resetFacets defaults to 0 - Table Of Contents: the property is titleReplacements Introduction/Index, Index: METS- or IIIF-based and 3D / media support Developers/Database.rst, DEVELOPMENT.md: the kitodo:databaseDocsGenerate command name Assisted-by: OpenCode / Qwen3.8-27b-thinking (Alibaba Cloud) Signed-off-by: Stefan Weil <sw@weilnetz.de>
Regenerated from a current TYPO3 install with the updated kitodo:databaseDocsGenerate command (see the corresponding bugfix). Adds TCA labels that were added since the page was last generated (*Language*, *Transl.Orig*, *Metadata Subentries*, the pid description of tx_dlf_solrcores) and corrects the section title of tx_dlf_metadatasubentries. Assisted-by: OpenCode / Qwen3.8-27b-thinking (Alibaba Cloud) Signed-off-by: Stefan Weil <sw@weilnetz.de>
Member
Author
|
@sebastian-meyer, https://extensions.typo3.org/extension/dlf looks rather old and would need an update, too. |
Member
Author
|
@beatrycze-volk, this PR only changes documentation, so it cannot have a negative effect on production code and could therefore be merged for the next release. The AI generated updates look reasonable for me. But I would appreciate if someone with more experience could review it, too. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2174 +/- ##
============================
============================
☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
sebastian-meyer
requested changes
Sep 28, 2026
sebastian-meyer
approved these changes
Sep 28, 2026
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Update the RST manual against the current code. The changes below only
touch the official documentation; no code is modified.
User/Index:
Administrator/Index:
Configuration/Index:
0.9.1 solr-ocrhighlighting build
Plugins/Index:
new tools (annotationTool, viewerSelectionTool)
configurations use plugin.tx_dlf_toolbox instead of the non-existing
plugin.tx_dlf_ objects
the OpenLayers features values
facetCollections and showLogicalPageField, resetFacets defaults to 0
Introduction/Index, Index: METS- or IIIF-based and 3D / media support
Developers/Database.rst, DEVELOPMENT.md: the kitodo:databaseDocsGenerate
command name
Assisted-by: OpenCode / Qwen3.8-27b-thinking (Alibaba Cloud)