CHF Gloss

Extension key

chf_gloss

Package name

digicademy/chf_gloss

Version

main

Language

en

Author

Jonatan Jalle Steller, CHF Gloss contributors

License

This document is published under the CC BY 4.0 license.

Rendered

Mon, 21 Jul 2025 09:52:03 +0000

The extension provides a data model for glossary data, as part of the Cultural Heritage Framework (CHF). It can be included in various data resources across the CHF. A glossary consists mainly of a central resource and its entries. The latter may annotate a set of words or abbreviations. Their definitions may only contain minimal formatting. Authorship can be attributed to the entire resource instead of individual entries.

Table of contents:

Introduction

The extension allows you to build a glossary in your TYPO3 project. It can be used to embed abbreviation tags (for abbreviations) and info buttons (for term definitions) in other data models of the Cultural Heritage Framework (CHF). Definitions are supposed to be very brief and do not include images or other files. The extension is part of the CHF, which provides additional functionality such as dictionary or encyclopedia entries, labels to structure data, and various additional data models.

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 GlossaryResource. Further data, such as entries, needs to be located in the same data folder.

Display the glossary

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

Editing content

Editors need access to the data folder in order to make changes. They may add and edit entries and agents here.

TBD

Templates

TBD

Data model

All records of a glossary are held together by a single GlossaryResource which holds the main classes GlossaryEntry and Agent. The class GlossaryEntry has a set of fields for terms to define and definitions. They may be of the type "term" or "abbreviation", which mainly defines how they are displayed when a glossary is embedded into another data model.

Agents may be used to mark the authors of the entire glossary. Individual entries do not have an authorship relation since they are intended to be very brief. In addition, the model knows a flexible SameAs class, which can be used to connect a glossary to authority files.

Graphical overview

API reference

TBD

Maintenance

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

Sitemap