topicexplorer metadata

Assists with metadata management.

The topicexplorer metadata command provides several metadata management tools. It works with tab-separated files (TSV).

Example Workflow

A typical workflow, assuming a Topic Explorer environment defined by example.ini:

  1. Extract metadata with topicexplorer metadata -e metadata.tsv example.ini

  2. Open file in a text editor to change values.

  3. Save file.

  4. Update metadata with topicexplorer metadata -a metadata.tsv example.ini

For label updating, see documentation for list labels (-l).

Command Line Arguments

Extract Metadata (-e)

Extracts all metadata to a TSV file.

List labels (-l)

Extracts labels to a TSV file.

Usage should be combined with --rename:

  1. topicexplorer metadata -l labels.tsv example.ini

  2. Edit the labels you wish to change.

  3. topicexplorer metadata --rename -a labels.tsv example.ini

Force insertion (-f)

Forces blank metadata to be inserted for non-specified fields.

Rename labels (--rename)

Changing document labels can cause many issues for reconstructing the document, any renames must be explicitly enabled with the --rename flag. Documents will be updated assuming the original order of the extracted TSV file.

HathiTrust Integration (--htrc)

The topicexplorer metadata --htrc command will add volume titles and links to the HathiTrust Page Turner fulltext view to the InPhO Topic Explorer document view.

The argument is only a flag, and does not require a TSV file to be specified.

See also

HathiTrust Integrations

Expanded documentation of the HathiTrust integrations.