From fc34d142b324a37cf219086be4c16d2bd55be591 Mon Sep 17 00:00:00 2001 From: Stefan Weil Date: Thu, 6 Feb 2025 09:48:07 +0100 Subject: [PATCH] [MAINTENANCE] Improve documentation (#1474) Signed-off-by: Stefan Weil --- .github/workflows/documentation.yml | 11 +++++++++-- Classes/Controller/OaiPmhController.php | 2 +- Documentation/Administrator/Index.rst | 13 ++++++++----- Documentation/Developers/Embedded3DViewer.rst | 4 +++- 4 files changed, 21 insertions(+), 9 deletions(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 41e5bc7fe..c33794d1c 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -2,7 +2,14 @@ name: Documentation # Build and test documentation on pull_request and push event # If the git reference is the main branch, additionally build the documentation artifact and deploy it to GitHub Pages -on: [ push, pull_request ] +on: + push: + paths: + - 'Documentation/**' + pull_request: + paths: + - 'Documentation/**' + workflow_dispatch: jobs: build: @@ -33,7 +40,7 @@ jobs: # Add a dependency to the build job needs: build - if: github.repository_owner == 'kitodo' && github.ref == 'refs/heads/main' + if: github.repository_owner == 'kitodo' && github.ref == 'refs/heads/main' || github.event_name == 'workflow_dispatch' # Grant GITHUB_TOKEN the permissions required to make a Pages deployment permissions: diff --git a/Classes/Controller/OaiPmhController.php b/Classes/Controller/OaiPmhController.php index 75aaf8fab..9bb77be88 100644 --- a/Classes/Controller/OaiPmhController.php +++ b/Classes/Controller/OaiPmhController.php @@ -593,7 +593,7 @@ protected function verbListRecords() */ protected function verbListSets() { - // It is required to set a oai_name inside the collection record to be shown in oai-pmh plugin. + // It is required to set oai_name inside the collection record to be shown in oai-pmh plugin. $this->settings['hideEmptyOaiNames'] = true; $oaiSets = $this->collectionRepository->findCollectionsBySettings($this->settings); diff --git a/Documentation/Administrator/Index.rst b/Documentation/Administrator/Index.rst index 449e00bee..a981a250a 100644 --- a/Documentation/Administrator/Index.rst +++ b/Documentation/Administrator/Index.rst @@ -23,9 +23,12 @@ Installation Make sure you have TYPO3 and Apache Solr already running. -a. Get the latest release ("jar"-file) from https://github.com/dbmdz/solr-ocrhighlighting/releases. Version 0.9.1 is the minimum version number. Make sure to pick the right file for Solr 8 or 9 respectively. -b. Copy the jar-file (e.g. "solr-ocrhighlighting-0.9.1.jar") to the modules/ocrsearch/lib/ directory of your Apache Solr. -c. Copy the schema.xml and solrconfig.xml from Configuration/ApacheSolr/configsets/dlf/conf/ to $SOLR_HOME/configsets/dlf/ +a. Get the latest release ("jar" file) from https://github.com/dbmdz/solr-ocrhighlighting/releases. Version 0.9.1 is the minimum version number. Make sure to pick the right file for Solr 8 or 9 respectively. + +b. Copy the jar file (e.g. `solr-ocrhighlighting-0.9.1.jar`) to the `modules/ocrsearch/lib/` directory of your Apache Solr. + +c. Copy the `schema.xml` and `solrconfig.xml` from `Configuration/ApacheSolr/configsets/dlf/conf/` to `$SOLR_HOME/configsets/dlf/`. + d. Restart Solr. @@ -60,7 +63,7 @@ This section contains version specific instructions on upgrading an existing Kit Version 3.3 -> 4.0 ================== -Upgrade-Wizards +Upgrade Wizards --------------- There are two upgrade wizards available. If you upgrade an existing installation, you should use them. Without, you have to @@ -76,7 +79,7 @@ Set the Storage Pid ------------------- 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. +This setting is available for all plugins in the page tree. The plugin specific constant `pages` has been removed. Migrate Plugin Settings ----------------------- diff --git a/Documentation/Developers/Embedded3DViewer.rst b/Documentation/Developers/Embedded3DViewer.rst index 86dc83c77..fbcfe643b 100644 --- a/Documentation/Developers/Embedded3DViewer.rst +++ b/Documentation/Developers/Embedded3DViewer.rst @@ -2,7 +2,9 @@ Embedded 3D Viewer ======== -The `model-viewer `_ is installed as the build-in standard viewer and supports ‘glTF/GLB 3D models’ as the model file format. Alternatively you can use one or multiple custom viewer implementations or our reference implementations from the GitHub repository `slub/dlf-3d-viewers `_. On this page, you will find all the information needed to configure and embed any 3D Viewer implementation for Kitodo.Presentation. +The `model-viewer `_ is installed as the built-in standard viewer and supports ‘glTF/GLB 3D models’ as the model file format. +Alternatively you can use one or multiple custom viewer implementations or our reference implementations from the GitHub repository `slub/dlf-3d-viewers `_. +On this page, you will find all the information needed to configure and embed any 3D Viewer implementation for Kitodo.Presentation. .. contents:: :local: