Read a Document Succession Tutorial

Prerequisites

Installation is not required if you are satisfied with just seeing the Hidos output documented in this tutorial.

You only need to install the Hidos package if you want to generate the Hidos output documented below by running Hidos on your own computer.

Steps

1. Save a document snapshot from a document succession

Run from the shell command line:

hidos get 1wFGhvmv8XZfPx0O5Hya2e9AyXo --output latest_copy_here
ls latest_copy_here
head -n4 latest_copy_here/article.xml

Output:

<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE article PUBLIC "-//NLM//DTD JATS (Z39.96) Journal Archiving and Interchange DTD v1.2 20190208//EN"
                  "JATS-archivearticle1.dtd">
<article xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:xlink="http://www.w3.org/1999/xlink" dtd-version="1.2" article-type="other">

2. Get information about a document succession

Run from the shell command line:

hidos info 1wFGhvmv8XZfPx0O5Hya2e9AyXo

Output:

{
  "dsi": "1wFGhvmv8XZfPx0O5Hya2e9AyXo",
  "signed": true,
  "allowed_signers": [
    "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIIQdQut465od3lkVyVW6038PcD/wSGX/2ij3RcQZTAqt"
  ],
  "init": "swh:1:rev:d7014686f9aff1765f3f1d0ee47c9ad9ef40c97a",
  "editions": [
    "0.1",
    "0.2",
    "1.1",
    "1.2",
    "1.3",
    "1.4",
    "2.1",
    "2.2",
    "2.3"
  ],
  "origins": [
    {
      "id": "589a1f4d",
      "origin": "https://github.com/digital-successions/1wFGhvmv8XZfPx0O5Hya2e9AyXo",
      "branch": "main"
    },
    {
      "id": "d68c116b",
      "origin": "https://github.com/document-succession/1wFGhvmv8XZfPx0O5Hya2e9AyXo",
      "branch": "main"
    }
  ]
}

3. Get information about a specific edition

Run from the shell command line:

hidos info 1wFGhvmv8XZfPx0O5Hya2e9AyXo/2.3

Output:

{
  "number": "2.3",
  "snapshot": "swh:1:dir:a6578ff657292b72d48b0d261ea00525b5a13cfc",
  "author_date": "2024-07-15",
  "archive_date": "2024-07-16",
  "record": "swh:1:rev:aa99df948517724bdd0d783828505febc952b1e3"
}

4. Get information about and a snapshot of a previous edition

hidos info 1wFGhvmv8XZfPx0O5Hya2e9AyXo/1.4
hidos get 1wFGhvmv8XZfPx0O5Hya2e9AyXo/1.4 --output old_copy_here
ls old_copy_here

Output:

{
  "number": "1.4",
  "snapshot": "swh:1:dir:eb9dfc65c22cde7b558ca2070ed4b2950074ed2f",
  "author_date": "2023-10-08",
  "archive_date": "2024-02-18",
  "record": "swh:1:rev:b9a89f2396f069b79e9fe344deb3f99749e088d0"
}
article.xml

Conclusion

You have successfully accessed a document succession. To learn how to create and post a document succession, proceed to the Post a Temporary Document Succession tutorial.