chf_base

Common classes as well as a UI library and other base services for the CHF

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

Repository

Common classes as well as a UI library and other base services for 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 Base
========

The Cultural Heritage Framework (CHF) is a research software suite that helps
you build web apps to **produce and publish data in the humanities**. It is
designed for the needs of scholarly editing, lexicography, archives, GLAM
institutions, and, more generally, projects interested in making cultural
heritage, books, media, or annotated bibliographies available in their own
web-based research platform. A key strength of the CHF is the ability to
produce portals and **multimodal editions** that include various data types
with historical points of reference in a single system, including editing
interfaces, frontends, and serialisations. Specific data models are organised
as additional components around the TYPO3 extension CHF Base, which
provides central data types like ``Agent``, ``Location``, and ``Period``,
but also multiple types of ``Tag`` and ``Relation`` to structure and connect
data as well as services like import and export routines. The various
components are developed and maintained by the Digital Academy, a Digital
Humanities department at the Academy of Sciences and Literature Mainz.

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

Roadmap
=======

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

- Unify mdlr and mrvl in this component
- Move social links here
- Frontend plugin and templates?
- Embedded metadata
- Infrastructure for imports
- Infrastructure for serialisations
- Infrastructure for search configs
- Add API documentation

**Beyond 2.0.0**

- Add testing
- Generic import
- Additional serialisations
- Automation to include Leaflet files upon new releases

**Nice to have**

- Allow ``Period`` to use calendars other than the Gregorian one

Owner

Citation (CITATION.cff)

cff-version: 1.2.0
title: CHF Base
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 Base contributors"
repository-code: >-
  https://github.com/digicademy-chf/chf_base
abstract: >-
  The Cultural Heritage Framework (CHF) is a research
  software suite that helps you build web apps to produce
  and publish data in the humanities. It is designed for
  the needs of scholarly editing, lexicography, archives,
  GLAM institutions, and, more generally, projects
  interested in making cultural heritage, books, media, or
  annotated bibliographies available in their own web-based
  research platform. A key strength of the CHF is the
  ability to produce portals and multimodal editions that
  include various data types with historical points of
  reference in a single system, including editing
  interfaces, frontends, and serialisations. Specific data
  models are organised as additional components around the
  TYPO3 extension CHF Base, which provides central data
  types like Agent, Location, and Period, but also multiple
  types of Tag and Relation to structure and connect data
  as well as services like import and export routines. The
  various components are developed and maintained by the
  Digital Academy, a Digital Humanities department at the
  Academy of Sciences and Literature Mainz.
keywords:
  - TYPO3
  - Cultural heritage
  - Heritage
  - Digital humanities
  - Humanities
  - Data
  - User interface
  - UI
  - Serialisations
  - Social
license: GPL 3
version: 2.0.0
date-released: '2025-08-27'

GitHub Events

Issues and Pull Requests

Last synced: 6 months ago