chf_lex

Create and manage lexicographic data in TYPO3 as part of the CHF

https://github.com/digicademy-chf/chf_lex

Repository

Create and manage lexicographic data in TYPO3 as part of the CHF

README.rst

..  image:: https://img.shields.io/badge/PHP-8.2/8.4-blue.svg
    :alt: PHP 8.2/8.4
    :target: https://www.php.net/downloads

..  image:: https://img.shields.io/badge/TYPO3-13-orange.svg
    :alt: TYPO3 13
    :target: https://get.typo3.org/version/13

..  image:: https://img.shields.io/badge/License-GPLv3-blue.svg
    :alt: License: GPL v3
    :target: https://www.gnu.org/licenses/gpl-3.0

=======
CHF Lex
=======

This TYPO3 extension for lexicographic resources implements the
`DMLex data model `__, version
1.0 CSD01, as part of the Cultural Heritage Framework (CHF). It includes the
two official modules Controlled Vocabulary and Linking, as well as a custom
Editorial module and in-line annotations. Other additions are intended to make
it work better for dictionaries with a historical component. In addition to the
data model itself, the extension also provides
`TEI Lex-0 `__
and `OntoLex Lemon `__ serialisations
designed so they can be provided through REST endpoints. In addition to
dictionary entries, the extension also allows for encyclopedic entries and
works well with CHF Gloss to further integrate glossary entries.

:Repository:  https://github.com/digicademy-chf/chf_lex
:Read online: https://digicademy-chf.github.io/chf_lex
:TER:         https://extensions.typo3.org/extension/chf_lex

Roadmap
=======

This is a pre-release version. The following steps are required for the software to move out of beta:

- Frontend plugin and templates
- Import of *Namenforschung* data
- Embedded metadata
- First set of serialisations
- Search configuration
- Add API documentation

**Beyond 2.0.0**

- Add testing
- Generic import
- Additional serialisations

**Known issues**

- Data model conformity: in ``Pronunciation``, either ``soundFile`` or ``transcription`` are required
- Data model conformity: the ``min`` and ``max`` values of ``MemberRoleTag`` should limit the number of members
- Needs checking: the config for custom TEI annotations may not work properly and still needs `toolbar buttons `__
- To do: to use TEI annotations in the frontend, RTE transformations are needed

Owner

Citation (CITATION.cff)

cff-version: 1.2.0
title: CHF Lex
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Jonatan Jalle
    family-names: Steller
    email: jonatan.steller@adwmainz.de
    affiliation: Academy of Sciences and Literature Mainz
    orcid: 'https://orcid.org/0000-0002-5101-5275'
  - name: "CHF Lex contributors"
repository-code: >-
  https://github.com/digicademy-chf/chf_lex
abstract: >-
  This TYPO3 extension for lexicographic resources
  implements the DMLex data model, version 1.0 CSD01, as
  part of the Cultural Heritage Framework (CHF). It
  includes the two official modules Controlled Vocabulary
  and Linking, as well as a custom Editorial module and
  in-line annotations. Other additions are intended to make
  it work better for dictionaries with a historical
  component. In addition to the data model itself, the
  extension also provides TEI Lex-0 and OntoLex Lemon
  serialisations designed so they can be provided through
  REST endpoints. In addition to dictionary entries, the
  extension also allows for encyclopedic entries and works
  well with CHF Gloss to further integrate glossary
  entries.
keywords:
  - TYPO3
  - Lexicographic data
  - Encyclopedia
  - Dictionary
  - Data
  - Research
  - DMLex
  - TEI Lex-0
  - OntoLex Lemon
license: GPL 3
version: 2.0.0
date-released: '2025-08-27'

GitHub Events