Skip to content

Commit

Permalink
revamp content to focus on formats
Browse files Browse the repository at this point in the history
  • Loading branch information
castedo committed Nov 2, 2023
1 parent 7503e58 commit 9c668f4
Show file tree
Hide file tree
Showing 4 changed files with 89 additions and 76 deletions.
18 changes: 18 additions & 0 deletions docs/bdf.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
Baseprint Document Format (BDF)
===============================

BDF is a specific format for encoding the concept discussed in the document
"[What is a baseprint?](https://perm.pub/HKSI5NPzMFmgRlb4Vboi71OTKYo)".

For temporary storage, this format is a directory with a JATS XML file in it named `article.xml`.
For public long-term storage, BDF data is stored in a Git tree
(or equivalent "directory" object in the Software Heritage Archive).

"Snapshot" is a good alternative and more intuitive name for BDF as a Git tree.
So "Baseprint snapshot" and "BDF snapshot" refers to BDF stored as a Git tree rather
than file system directory.

Only a tiny subset of JATS XML (and JATS4R) is valid in BDF.
Currently, [epijats](https://gitlab.com/perm.pub/epijats) is the only software
reading BDF and it only understands a tiny fraction of JATS XML.

84 changes: 66 additions & 18 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,77 @@
# Baseprints
Baseprints Interoperability Forum
=================================

Read the document "[What is a baseprint?](https://perm.pub/HKSI5NPzMFmgRlb4Vboi71OTKYo)"
for a definition of _baseprint_. That document itself also serves as an example of a baseprint.
Baseprints are used as digital objects (or editions) inside a digital succession.
Visit [try.perm.pub](https://try.perm.pub/) to learn about digital successions of baseprints.
For technical details and an illustration of a baseprint, see the [Technical Details page](tech.md).
This website and associated GitHub repository are for sharing information about
Baseprint open formats.
A goal for this sharing is to help applications reading or writing data in a
baseprint format to better serve users with better interoperability.


## Software
Baseprint Open Formats
----------------------

[Basecast](https://try.perm.pub/basecast/) is an example of software that **writes** a baseprint.
This is demonstrated in the tutorial
["Author a Baseprint Locally"](https://try.perm.pub/tutorial/basecast_locally/).
Currently only one format uses the name "Baseprint".
However, [try.perm.pub](https://try.perm.pub) uses the phrase
"Baseprint document succession" for data records in Document Succession Git Layout (DSGL).

[BaseprintPress](https://gitlab.com/perm.pub/baseprintpress)
is an example of software that **reads** a baseprint.
It generates web pages from a baseprint by using the open-source library
[epijats](https://gitlab.com/perm.pub/epijats).
This is demonstrated in the tutorial
["Generate Pages for a Published Digital Succession"](https://try.perm.pub/tutorial/gen_pages/).
[Baseprint Document Format (BDF)](bdf.md):
: "Document snapshot" is an intuitive phrase for what this format encodes.

## Related technologies
Document Succession Git Layout (DSGL) & Document Succession Identifier (DSI):
: Two formats which are a split and rename to be made from the specification for
[Digital Succession Identifiers (DSI)](https://perm.pub/1wFGhvmv8XZfPx0O5Hya2e9AyXo).
This format is a succession of document snapshots in BDF.

Existing Applications
---------------------

### Websites

* [perm.pub](https://perm.pub)
* [popgen.es](https://popgen.es)


### Software Writing in a Baseprint Format

[Baseprinter](https://perm.pub/baseprinter):
: A BDF authoring tool that can be used via GitHub Actions, container or locally
installed.

[Pandoc](https://perm.pub/baseprinter):
: But only with JATS XML output that is BDF compatible.

[Hidos](https://hidos.readthedocs.io):
: Software library and tool that writes document successions in DSGL
(a.k.a., "Baseprint document successions").

### Software Reading in a Baseprint Format

[epijats](https://gitlab.com/perm.pub/epijats):
: open-source library used by BaseprintPress, perm.pub and popgen.es and Baseprinter (for previews).

[BaseprintPress](https://gitlab.com/perm.pub/baseprintpress):
: Generates web pages from Baseprint document successions.
For a tutorial, see ["Generate Pages for a Published Digital Succession"](https://try.perm.pub/tutorial/gen_pages/).

Related Technologies
--------------------

* [JATS4R](https://jats4r.org/)
* [PMC Open Access Subset packages](https://www.ncbi.nlm.nih.gov/pmc/tools/openftlist/)
* [Software Heritage Archive](https://www.softwareheritage.org/)
* [SWHIDs : SoftWare Hash Identifiers](https://www.swhid.org/)
* [Digital Succession Identifiers](https://perm.pub/1wFGhvmv8XZfPx0O5Hya2e9AyXo)

Baseprint Feature D's
---------------------

The GitHub Discussions category
[Baseprint Feature D's](https://github.com/singlesourcepub/baseprints/discussions/categories/baseprint-feature-d-s)
is available to facilitate focused discussions, decisions, proposals, definitions etc...
about a specific feature of a Baseprint format.

History
-------

"Baseprint" was the clear winner in
[this word choice survey](https://github.com/singlesourcepub/community/discussions/51).

53 changes: 0 additions & 53 deletions docs/tech.md

This file was deleted.

10 changes: 5 additions & 5 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,18 @@ theme:
custom_dir: theme
features:
- content.code.copy
- toc.integrate
# - toc.integrate
- navigation.footer
- navigation.indexes
# - navigation.indexes
- navigation.top
- navigation.tracking
markdown_extensions:
- attr_list
- admonition
- def_list
nav:
- Baseprints:
- index.md
- tech.md
- Interoperability Forum: index.md
- Baseprint Document Format: bdf.md
watch:
- docs
- theme

0 comments on commit 9c668f4

Please sign in to comment.