egaia figs

Given a list of UUIDs, append figures for referenced archive items to a template document.

Usage

egaia figs --help
egaia figs UUID...

Options

--help

Display this help text and exit.

UUID

Locate an image and description for the item corresponding to a UUID present in this string, and append those to a template document, which will be saved as figures.docx in the root of the bag data/ directory.

Notes on tool behaviour

This tool is intended to simplify the process of “writing within the archive”, by allowing you to batch-import images and descriptive captions for items from the archive collections.

The items to be appended will be identified from UUIDs provided on the command line, and will be matched against items contained in the archive pub directory. If a match is found, this command will append an inline medium-scale image for that item to the end of the template document, followed by a caption paragraph containing the title, description, and URL for that item as given in the archive catalogue. The figure and caption may then be edited and copied into another document. This command uses “Figure” and “Caption” docx styles, which are recognized by the derive command such that it will convert the document into HTML and PDF distribution formats with these figures embedded.