Skip to content

Baseprints Interoperability Forum

This website and associated GitHub repository are for sharing information about Baseprint open formats. The goal is to help users and developers assess the interoperability between applications that read or write in a Baseprint format.

Baseprint Open Formats

Baseprint Document Format (BDF):
This format encodes a Baseprint document snapshot.
Document Succession Git Layout (DSGL):
Baseprint document snapshots are stored inside a document succession in DSGL format.
Document Succession Identifiers (DSI):
A DSI is a textual identifier for document successions and snapshots.

Baseprint Feature D's

The GitHub Discussions category Baseprint Feature D's is available to facilitate discussions, decisions, proposals, definitions, etc. that focus on a specific feature of a Baseprint format.

Applications

DSI, DSGL, and BDF together make Baseprint document successions, which are introduced on try.perm.pub.

Websites

Software Reading/Writing in DSGL

Hidos:
Software library and tool that reads/writes document successions in DSGL.
Document Succession Highly Manual Toolkit:
Manual for software toolkit that reads/writes document successions in DSGL.

Software Writing in a Baseprint Format

Baseprinter:
A BDF authoring tool that can be used via GitHub Actions, container, or locally installed.
Pandoc:
This tool can output JATS XML, which can be BDF compatible.

Software Reading in a Baseprint Format

BaseprintPress:
Software generating web pages from Baseprint document successions. For a tutorial, see "Generate Pages for a Published Digital Succession".
epijats:
An open-source library used by BaseprintPress, perm.pub, popgen.es, and Baseprinter (for previews).

History

"Baseprint" was the clear winner in this word choice survey.