slub/slub-web-kartenforum

Installs: 45

Dependents: 0

Suggesters: 0

Security: 0

Stars: 2

Watchers: 12

Forks: 2

Open Issues: 4

Language:JavaScript

Type:typo3-cms-extension

v3.0.0 2024-10-25 10:59 UTC

README

Logo of the Virtual Map Forum

The Virtual Map Forum allows the searching and viewing of historic and georeferenced maps and offers further capabilities for the georeferencing of historic maps (dependencies to vk2-georeference. The application is developed as an extension for the CMS TYPO3. and the extension was tested with TYPO3 version 10.4.

Configuration

TYPO3 Extension configuration

For a valid default configuration have a look at ddev-kartenforum. Furthermore the extension can be configured via the Extension Configuration in the TYPO3 back office. The following settings are supported:

TYPO3 Content configuration

In order for the welcome flyout to be more than a green rectangle some contents have to be added from the TYPO3 backoffice. Any text elements are feasible for this purpose.

Documentation/images/welcome_content_configuration.png

In addition, a button must be included to hide the flyout and disable it for subsequent visits. The following figure explains how to add such a button. Mainly important is the Appearance -> Layout Setting, which has to be Map: Welcome Button.

Documentation/images/welcome_button_configuration.png

TYPO3 Template configuration

In order for the user dropdown to work correctly, the page ids of the specific setup have to be supplied to the extension via the template configuration. All available configuration parameters can be found here: Configuration/TypoScript/constants.typoscript The following figure shows how to modify the settings:

Image of the template modification tools, with the constants section highlighted.

Available query parameters

The permalink implementation provides several query parameters that allow the application to be initialized with a predetermined state. These query parameters are explained in the following table.

ℹ Arrays are represented as comma seprated values in the same query parameter.

Development

Besides some templating and configuration logic, the largest part of the application code is build with JavaScript. The source code is placed in the directory Build.

Main dependencies are:

For each plugin of the extension, a JavaScript / CSS bundle is build, which is placed in the directory Resources/Public/Build/

For building bundles or developing have a look at the script commands within package.json.

Basically all production code can be build via the following commands:

cd Build/
npm install
npm run build