Skip to content

[DOCUMENTATION] Update and fix the outdated documentation manual - #2174

Merged
sebastian-meyer merged 4 commits into
kitodo:mainfrom
stweil:docs-upstream
Sep 28, 2026
Merged

sebastian-meyer merged 4 commits into
kitodo:mainfrom
stweil:docs-upstream

Conversation

@stweil

@stweil stweil commented Sep 27, 2026

Copy link
Copy Markdown
Member

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_ 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)

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>
@stweil

stweil commented Sep 27, 2026

Copy link
Copy Markdown
Member Author

@sebastian-meyer, https://extensions.typo3.org/extension/dlf looks rather old and would need an update, too.

@stweil

stweil commented Sep 28, 2026

Copy link
Copy Markdown
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.

@sebastian-meyer sebastian-meyer added the 🗎 documentation An update on documentation. label Sep 28, 2026
@codecov

codecov Bot commented Sep 28, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 0.00%. Comparing base (875b458) to head (3051fc8).
⚠️ Report is 3 commits behind head on main.

Additional details and impacted files
@@     Coverage Diff      @@
##   main   #2174   +/-   ##
============================
============================

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@sebastian-meyer sebastian-meyer changed the title [TASK] Update and fix the outdated documentation manual [DOCUMENTATION] Update and fix the outdated documentation manual Sep 28, 2026
Comment thread Documentation/Configuration/Index.rst Outdated
@sebastian-meyer
sebastian-meyer merged commit 0355eac into kitodo:main Sep 28, 2026
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

🗎 documentation An update on documentation.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants