Writing Digital Successions

To use hidos you will need to have hidos installed and git setup. You also need a local git repository. To accomplish these prerequisites, see Getting Started.

Creating a digital succession (and DSI)

If your current directory is a git repository, you can create new digital succession as such:

hidos create my_succession

A new Digital Succession Identifier (DSI) will be displayed and the git branch name my_succession can be used for further operations. The branch name is not intrinsic to the succession and is for convenient identification of successions stored in a git repository.

Optionally, you may want to use the --unsigned and/or --git-dir options (between hidos and create).

Regenerate a new DSI

You might not like a DSI that you create. Maybe you don't want 0 or O characters, or maybe you don't want l or I characters, because some fonts do not visually distinguish them. Or maybe you don't want - or _ characters. Whatever the reason, every second you can easily regenerate a new DSI doing the following steps.

git branch -D my_succession
hidos create my_succession

Amending a new edition

In the following example, the my_succession branch stores a digital succession and at src_path in the file system is a directory or file which is the digital object to become a new edition. The following will make a signed commit so that the digital object is edition 1.1 of the succession.

hidos commit src_path my_succession 1.1

Publish/share a digital succession

Publishing a digital succession is a combination of archiving the digital succession and then making it citable.

Archiving a digital succession

Git push your digital succession branch to any git repository supported by Software Heritage, and make a save request.

Making it citable

A DSI such as dsi:ji2STto1mZ3i2BmnGxbkebejKH4 could be used in bibliographic references. But a safer bet is to use a URL such as https://perm.pub/ji2STto1mZ3i2BmnGxbkebejKH4.

To add a DSI to https://perm.pub/ contact Castedo Ellerman.