CHF Bib 

Extension key

chf_bib

Package name

digicademy/chf_bib

Version

main

Language

en

Author

Jonatan Jalle Steller, CHF Bib contributors

License

This document is published under the CC BY 4.0 license.

Rendered

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

The extension provides a data model for bibliographic data, as part of the Cultural Heritage Framework (CHF). It is largely modelled after the biblStruct element in TEI XML as produced by Zotero. In addition, entries may carry descriptions, summaries, (cover) images, and other files to put together annotated bibliographies. The data can be listed as a full bibliography, but entries and contributors may also be grouped via labels, and other data models can reference and elaborate on individual entries using a Reference class. A SameAs class may be used to identify, for example, authors via their ORCIDs in linked-data scenarios. A frontend plugin provides options to display selections of the bibliography, and a few common serialisations of bibliographic data are included out of the box. A TYPO3 task can be activated to periodically and automatically import data from a Zotero library.

Table of contents:

Introduction 

The extension allows you to build a comprehensive bibliography in your TYPO3 project. It can either be automatically imported from Zotero or edited in the TYPO3 backend. In case you are building an annotated bibliography, entries may also contain summary and description texts, (cover) images, and files. The extension was originally designed for academic projects in the Digital Humanities, but should work just as well for any other academic and non-academic domain. The extension is part of the Cultural Heritage Framework (CHF), which provides additional functionality such as glossary entries, geodata, 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 BibliographicResource. Further data, such as entries, needs to be located in the same data folder.

3. Optionally add a Zotero task

   You need to add a Zotero URI to your bibliography and set up an import task if your data is supposed to be imported from Zotero periodically. This may only be allowed for admins in your TYPO3 system.

   Go to your data folder, open the bibliography you want to import via Zotero, and add the Zotero sync URI. Then go to the Task module in the backend, add a new task, and select Import bibliography from Zotero. Enter the values required to perform the task and either start the task manually or set an interval to run the task automatically.

Display the bibliography 

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

If you want to be able to only show select entries from your bibliography, 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 entries or contributors you want it to apply to. You can then select the label in the plugin to display only those entries or contributors.

Editing content 

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

TBD

Templates 

TBD

Data model 

All records of a bibliography are held together by a single BibliographicResource which holds the main classes BibliographicEntry, Agent, and Tag. The class BibliographicEntry has a set of fields that contain inforomation of non-independent items (e.g. papers in a journal) as well as independent publications (e.g. the journal itself). Entries may be connected to other data models, which may specify elaborations such as the specific page number of a citation, by using the class SourceRelation.

Extent may be used several times in a bibliographic entry to provide, for example, volume and number of the journal an article is published in. The same class is used to enable providing multiple identifiers. Agent is its own class because agents may occur multiple times per publication, and their role (e.g., author or editor) can be specified by being added via an AuthorshipRelation.

In addition, the model knows flexible LabelTag and SameAs classes, which can be used to group entries and agents via labels and to connect entities 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