Basic vocabulary
To clarify how various parts fit together, let us summarize some key concepts, which will be used in the rest of this documentation:
- TEI Publisher
-
denotes the software framework as a whole, i.e. the entire toolbox, comprising all profiles and libraries
- Jinks
-
the central application manager, which generates applications and manages updates
- TEI Publisher Documentation and Demo
-
refers to the application containing this documentation and a selection of demos. It mimics the old monolithic TEI Publisher application, but is now generated from a blueprint.
- Profile
-
a modular building block for a TEI Publisher application. Profiles can extend other profiles and may be combined to create applications. We distinguish several kinds of profiles:
- Base
-
a special profile, used by all TEI Publisher applications, providing the core server-side API and basic page layout without styling
- Feature
-
a functional profile to be combined with base and potentially other profiles. It provides all necessary resources to fully implement a specific functional scope, e.g. docker configuration, register sidebar, or a timeline.
- Theme
-
provides a particular look and feel. It supplies all necessary CSS styles, fonts and graphic assets to achieve that.
- Blueprint
-
a complete template for an application targeted at a specific use case, e.g. a monograph, correspondence edition, dictionary etc.
- TEI Processing Model
-
the very core of TEI Publisher. Part of the TEI Guidelines and the TEI ODD specification format, it defines how documents are transformed from the source XML into output formats (e.g. HTML, ePub, print).
- Webcomponents
-
library of interactive custom HTML elements. These main user interface building blocks of TEI Publisher can be freely combined to create robust HTML pages with TEI Publisher. Part of the HTML5 standard and natively supported by browsers.
- Jinks Templates
-
a templating language used by Jinks during application generation as well as within profiles to fill placeholders with content.