Skip to content
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

[MAINTENANCE] Improve documentation #1474

Merged
merged 4 commits into from
Feb 6, 2025
Merged

[MAINTENANCE] Improve documentation #1474

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2c9526d
Run GitHub action for documentation only if there are relevant changes
stweil Feb 6, 2025
60c0155
Allow manual deploying of documentation in GitHub action
stweil Feb 6, 2025
8dd9ace
Fixes grammar in source comment
stweil Feb 5, 2025
8964d52
Spelling and other fixes and improvements for documentation
stweil Feb 6, 2025
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
11 changes: 9 additions & 2 deletions .github/workflows/documentation.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion Classes/Controller/OaiPmhController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down
13 changes: 8 additions & 5 deletions Documentation/Administrator/Index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.


Expand Down Expand Up @@ -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
Expand All @@ -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
-----------------------
Expand Down
4 changes: 3 additions & 1 deletion Documentation/Developers/Embedded3DViewer.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@
Embedded 3D Viewer
========

The `model-viewer <https://modelviewer.dev>`_ 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 <https://github.com/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 <https://modelviewer.dev>`_ 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 <https://github.com/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:
Expand Down