CHF Map 

Extension key

chf_map

Package name

digicademy/chf_map

Version

main

Language

en

Author

Jonatan Jalle Steller, CHF Map contributors

License

This document is published under the CC BY 4.0 license.

Rendered

Mon, 29 Sep 2025 13:36:26 +0000


This TYPO3 extension implements a data model for map tiles and features as well as simple coordinates and geographical token distributions, as part of the Cultural Heritage Framework (CHF). Geographical features are stored (and serialised) as GeoJSON. The extension also acts as a wrapper for MapLibre GL JS and provides a plugin to show individual features or groups of features as content elements in the frontend. Integrators may further specify the map tiles they want to display as a base map.


Table of contents:

Introduction 

The extension allows you to build comprehensive support for maps into your TYPO3 project. Map resources may include a few simple features on a single map all the way to a multitude of feature collections available in the same map with multiple available tiles users can choose from. The extension uses the World Geodetic System (WGS 84/EPSG 4326). The extension uses MapLibre to display maps on the web, which automatically translates geographic coordinates to a Pseudo-Mercator (EPSG 3857) or a globe projection. Map features are stored as GeoJSON. The extension is part of the Cultural Heritage Framework (CHF), which provides additional functionality such as glossary entries, bibliographic references, and various additional data models.

Screenshots 

TBD

Install and config 

  1. Install the extension

    Add the package name to your composer.json or install the package manually.

  2. Set up a data folder

    In a blank folder in your page tree, add a MapResource. Further data, such as features, needs to be located in the same data folder. Depending on the size of your resources, you may want to reserve a data folder per resource to keep their records separate.

Display the resource 

To show the map resource on a specific page of your website, simply add the Map plugin and set it up to use the resource in question.

If you want to be able to only show select features from your resource, use the label function built into the extension. You can add a Tag of type Label to your data folder and then select it in the features you want it to apply to. You can then select the label in the plugin to display only those features.

Editing content 

Editors need access to the data folder in order to make changes. They may add and edit resources, features, and tags here.

TBD

Templates 

TBD

Data model 

All records of a resource are held together by a single MapResource which holds the main classes Feature, Tag, and Tile. The core class Feature can hold GeoJSON information to describe various geometries such as points, line strings, polygons, multi points, multi line strings, multi polygons, or geometry collections.

Each MapResource may specify a number of Tile objects it wants to map its data onto. The data model itself does not check whether the tiles are available and whether you are allowed to use them. Some providers limit the number of requests per day or month, for example. In addition, please note that the tiles added here may require you to add a notice to your website's privacy policy about requests being made to external servers.

Coordinates and Distribution classes are available for other data models to easily describe exact locations and geographic token distributions, respectively.

In addition, the model knows flexible LabelTag and SameAs classes, which can be used to group features via labels and to connect entities to authority files.

Graphical overview 

Data model of the extension

Overview of the extension's data model. Check the API reference for further details.

API reference 

TBD

Sitemap 

Maintenance 

Maintenance of the extension may include adapting it to new TYPO3 versions or updating dependencies and includes.