Skip to content

Commit

Permalink
BDF -> BpDF
Browse files Browse the repository at this point in the history
  • Loading branch information
castedo committed Aug 30, 2024
1 parent a9903e0 commit a2bad63
Show file tree
Hide file tree
Showing 5 changed files with 23 additions and 23 deletions.
4 changes: 2 additions & 2 deletions docs/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Future Plans

### Milestones

Image support for [BDF](bdf/index.md)
Image support for [BpDF](bdf/index.md)
: As of 2023, Baseprint software does not support images.

[BaseprintPress](https://gitlab.com/perm.pub/baseprintpress) available as a GitHub Action
Expand All @@ -36,7 +36,7 @@ E-publication of the [Maggi paper](https://github.com/castedo/ten-years-challeng
: A web API that resolves a DSI to all the SWHIDs for each of the snapshots by querying the
Software Heritage Archive and GitHub. It needs to use OpenSSH to verify SSH signatures.

In-browser client-side BDF-to-HTML rendering
In-browser client-side BpDF-to-HTML rendering
: Calls the resolver service. Websites can use it without having to generate content
server-side or statically.

Expand Down
36 changes: 18 additions & 18 deletions docs/bdf/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Baseprint Document Format (BDF)
===============================
Baseprint Document Format (BpDF)
================================

BDF is a format for encoding a *Baseprint document snapshot*.
BpDF is a format for encoding a *Baseprint document snapshot*.
These snapshots can be identified with a
[SoftWare Hash IDentifier (SWHID)](https://swhid.org).
Baseprint document snapshots exemplify the concept of "baseprint" discussed in the
Expand All @@ -12,38 +12,38 @@ document
Objectives
----------

BDF aims to minimize format rot.
Unlike formats like LaTeX and Markdown, which are used for authoring, BDF is designed
BpDF aims to minimize format rot.
Unlike formats like LaTeX and Markdown, which are used for authoring, BpDF is designed
for redistribution and archiving.


BDF'23
------
BpDF'23
-------

*BDF'23* is the version of BDF as supported by software circa 2023 that can read and
write BDF.
*BpDF'23* is the version of BpDF as supported by software circa 2023 that can read and
write BpDF.

Technically, BDF'23 is not a file format
Technically, BpDF'23 is not a file format
but a format for a directory-like data structure.
This structure is addressable as
a [Git](https://en.wikipedia.org/wiki/Git) tree and [SWHID](https://swhid.org)
directory.

When working with BDF data,
When working with BpDF data,
it is often temporarily stored in a file system directory.
However, for public long-term storage, BDF data is stored in a SWHID addressable Git tree or
However, for public long-term storage, BpDF data is stored in a SWHID addressable Git tree or
an equivalent "directory" object in the Software Heritage Archive.

Inside BDF'23, there is a file named `article.xml` encoded in a subset of the
Inside BpDF'23, there is a file named `article.xml` encoded in a subset of the
[JATS XML format](../jats.md).
This file format can informally be referred to as *Baseprint JATS XML*.
As of October 2023,
all applications that read Baseprint document snapshots encoded in BDF'23
all applications that read Baseprint document snapshots encoded in BpDF'23
use the [epijats](https://gitlab.com/perm.pub/epijats) Python library.


BDF Reading Software
--------------------
BpDF Reading Software
---------------------

[epijats](https://gitlab.com/perm.pub/epijats):
: An open-source library used by
Expand All @@ -55,9 +55,9 @@ BDF Reading Software
### Snapshot Writing Software

[Baseprinter](https://try.perm.pub/baseprinter):
: A BDF authoring tool available through GitHub Actions, container, or local
: A BpDF authoring tool available through GitHub Actions, container, or local
installation.

[Pandoc](https://try.perm.pub/pandoc):
: This tool can output [JATS XML](../jats.md), which can be BDF compatible.
: This tool can output [JATS XML](../jats.md), which can be BpDF compatible.

2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ that focus on specific features of a Baseprint format.
Snapshots vs. Successions
-------------------------

[Baseprint Document Format (BDF)](bdf/index.md) is the
[Baseprint Document Format (BpDF)](bdf/index.md) is the
digital encoding format for *Baseprint document snapshots*,
which can be redistributed and archived through various mechanisms.
Some preprint servers could archive Baseprint document snapshots in a centralized
Expand Down
2 changes: 1 addition & 1 deletion docs/jats.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ JATS XML Open Dialects

This page documents Free Open-Source Software (FOSS) and Open Access (OA) repositories that
establish various *open dialects* of JATS XML.
[Baseprint Document Format (BDF)](bdf/index.md) establishes another JATS open dialect:
[Baseprint Document Format (BpDF)](bdf/index.md) establishes another JATS open dialect:
*Baseprint JATS*, developed for self-publishing workflows using author-authored JATS XML.
Author-authored JATS demands FOSS that supports WYPIEWYP:
What-You-Preview-Is-Essentially-What-You-Publish.
Expand Down
2 changes: 1 addition & 1 deletion docs/successions.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ A document succession encoded in the format
records a succession of Baseprint document *snapshots*.
A [Document Succession Identifier (DSI)](https://perm.pub/1wFGhvmv8XZfPx0O5Hya2e9AyXo)
is a textual persistent identifier of a document succession.
DSI, DSGL, and [BDF](bdf/index.md) together encode Baseprint document successions.
DSI, DSGL, and [BpDF](bdf/index.md) together encode Baseprint document successions.

## Software Reading/Writing Baseprint Document Successions

Expand Down

0 comments on commit a2bad63

Please sign in to comment.