From b1732fec4e8556c19228dd513c2b93a817d314b4 Mon Sep 17 00:00:00 2001 From: Castedo Ellerman Date: Fri, 26 Apr 2024 11:25:21 +0000 Subject: [PATCH] split successions from snapshots on home page --- docs/index.md | 91 +++++++++++++++++++++++++++++---------------------- 1 file changed, 51 insertions(+), 40 deletions(-) diff --git a/docs/index.md b/docs/index.md index eea736a..6e7cb20 100644 --- a/docs/index.md +++ b/docs/index.md @@ -3,76 +3,87 @@ 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)](bdf/index.md): -: This format encodes a Baseprint document snapshot. - -[Document Succession Git Layout (DSGL)](https://perm.pub/VGajCjaNP1Ugz58Khn1JWOEdMZ8): -: Baseprint document snapshots are stored inside a document succession in DSGL format. - -[Document Succession Identifiers (DSI)](https://perm.pub/1wFGhvmv8XZfPx0O5Hya2e9AyXo): -: A DSI is a textual identifier for document successions and snapshots. +The goal is to assist users and developers +in assessing the interoperability between applications that read or write in a Baseprint format. + 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 discussions, decisions, proposals, definitions, etc. -that focus on a specific feature of a Baseprint format. +is available to facilitate discussions, decisions, proposals, definitions, etc... +that focus on specific features of a Baseprint format. -Applications ------------- +Baseprint Document Snapshots +---------------------------- -DSI, DSGL, and BDF together make *Baseprint document successions*, which are introduced -on [try.perm.pub](https://try.perm.pub). +[Baseprint Document Format (BDF)](bdf/index.md) is the +digital encoding format for Baseprint document snapshots, +which can be redistributed and archived through various mechanisms. -### Websites +### Snapshot Reading Software -- [perm.pub](https://perm.pub) -- [popgen.es](https://popgen.es) - -### Software Reading/Writing in DSGL - -[Hidos](https://hidos.readthedocs.io): -: Software library and tool that reads/writes document successions in DSGL. - -[Document Succession Highly Manual Toolkit](https://manual.perm.pub): -: Manual for software toolkit that reads/writes document successions in DSGL. +[epijats](https://gitlab.com/perm.pub/epijats): +: An open-source library used by BaseprintPress, [perm.pub](https://perm.pub), + [popgen.es](https://popgen.es), and Baseprinter (for previews). -### Software Writing in a Baseprint Format +### Snapshot Writing Software [Baseprinter](https://try.perm.pub/baseprinter): -: A BDF authoring tool that can be used via GitHub Actions, container, or locally - installed. +: A BDF authoring tool available through GitHub Actions, container, or local + installation. [Pandoc](https://try.perm.pub/pandoc): : This tool can output JATS XML, which can be BDF compatible. -### Software Reading in a Baseprint Format + + + +Baseprint Redistribution and Archiving +-------------------------------------- + +Baseprint document snapshots can be redistributed and archived through various +mechanisms. +Some preprint servers could archive Baseprint document snapshots in a centralized +approach. +Alternatively, Baseprint document snapshots can be redistributed and archived +in a distributed approach as *Baseprint document successions*. + +### Baseprint Document Successions + +*Baseprint document successions* are introduced at [try.perm.pub](https://try.perm.pub). + +Baseprint document snapshots can be stored within a document succession in +[Document Succession Git Layout (DSGL)](https://perm.pub/VGajCjaNP1Ugz58Khn1JWOEdMZ8) +format. +A [Document Succession Identifier (DSI)](https://perm.pub/1wFGhvmv8XZfPx0O5Hya2e9AyXo) +is a textual identifier for document successions and snapshots. +DSI, DSGL, and BDF together encode Baseprint document successions. + +#### Software Reading/Writing Baseprint Document Successions + +[Hidos](https://hidos.readthedocs.io): +: Software library and tool that reads/writes document successions in DSGL. + +[Document Succession Highly Manual Toolkit](https://manual.perm.pub): +: Manual for a software toolkit that reads/writes document successions in DSGL. [BaseprintPress](https://gitlab.com/perm.pub/baseprintpress): -: Software generating web pages from Baseprint document successions. +: Software that 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/). -[epijats](https://gitlab.com/perm.pub/epijats): -: An open-source library used by BaseprintPress, perm.pub, popgen.es, and Baseprinter (for previews). Related Technologies -------------------- -- [JATS4R](https://jats4r.org/) -- [PMC Open Access Subset packages](https://www.ncbi.nlm.nih.gov/pmc/tools/openftlist/) +- [JATS XML](jats.md) - [Software Heritage Archive](https://www.softwareheritage.org/) - [SoftWare Hash Identifier (SWHID)](https://www.swhid.org/) + History -------