Skip to content

Generate Pages from a Published Document Succession

This tutorial will guide you through the process of downloading a document succession based on a Document Succession Identifier (DSI) and then generating web pages from it.

Warning

This tutorial uses an early preliminary version of baseprintpress. The steps involved are rather advanced. If you would like to be notified when a more user-friendly tutorial is available, contact Castedo.

Prerequisites

Make sure you have the following installed:

Steps

1. Install BaseprintPress

pip install --user git+https://gitlab.com/perm.pub/baseprintpress.git

2. Create a config file

Create a baseprintpress.yaml file that includes a list of Digitial Succession Identifiers (DSIs). Add the DSI of the published digital succession to the file.

mkdir myproj
cd myproj
echo 'successions: {"HKSI5NPzMFmgRlb4Vboi71OTKYo": {}}' > baseprintpress.yaml

The baseprintpress.yaml file will be read by baseprintpress.

3. Download the digital succession data

Find and download the underlying data for the published digital succession into a local cache. By default, the cache location is the subdirectory git_cache.

baseprintpress fetch

You can pass the git_cache directory to the --git-dir parameter of hidos to explore the downloaded digital successions.

4. Generate web pages

baseprintpress build

The generated pages can be found in the newly created subdirectory site. You can use a web browser to view the pages. The file site/index.html will list and link to the pages generated for the digital successions listed in baseprintpress.yaml.

Conclusion

You have successfully "browsed" a digital succession based on only its DSI.

Questions/Feedback

If you have any questions or feedback, feel free to contact Castedo.