Overview and History¶

Additional TODO¶

Placeholder for additional TODO items.

Introduction¶

This guide, designed for non-technical users, provides a background and history of National Library of New Zealand (NLNZ) Tools SIP Generation Fairfax.

Contents of this document¶

Following this introduction, this Overview and History Guide includes the following sections:

Overview - Covers what the NLNZ Tools SIP Generation Fairfax is and what it is not.
History - Covers the history of the tool from its inception to today.
Documentation corrections - Covers a process to submit corrections to the documentation.
License - Covers the license used.
Release history - Covers significant changes made in each release.

Overview¶

NLNZ Tools SIP Generation Fairfax is designed to prepare Fairfax-specific SIPs for ingestion into the Rosetta archiving system. Its purpose is to automate the generation of Fairfax SIPs from Fairfax files.

What it is NOT¶

It is NOT specific to any other ingestion besides Fairfax publications.

History¶

The National Library of New Zealand has a legal mandate, and a social responsibility, to preserve New Zealand’s social and cultural history, be it in the form of books, newspapers and photographs, or of websites, blogs and videos. Increasing amounts of New Zealand’s documentary heritage is only available online. Users find this content valuable and convenient, but its impermanence, lack of clear ownership, and dynamic nature pose significant challenges to any institution that attempts to acquire and preserve it.

NLNZ Tools SIP Generation Fairfax is a set of functionality for use in ingesting Fairfax-specific content. This fairfax ingestion, which is a feed from Fairfax of their digital print publications. This code does the custom processing involved with processing the Fairfax files.

Project objectives¶

Meets the needs of the National Library of New Zealand
Possibly provide helpful functionality or example processing to other users and institutions.

The tool is open-source software and is freely available for the benefit of the international archiving community.

Documentation corrections¶

This documentation is generated from .rst files in the docs folder of the codebase, found at https://github.com/NLNZDigitalPreservation/nlnz-tools-sip-generation-fairfax .

There are two approaches to making documentation corrections. Both approaches require a Github account.

Edit the files directly in the repository¶

Github describes the process of editing files directly in the repository here: https://help.github.com/en/articles/editing-files-in-your-repository . Follow this process to edit the problematic .rst files directly.

Annotate a PDF with changes and suggestions¶

Some readers might not be willing to edit those files directly and submit changes via Github. Another way to document desired changes in the documentation is to download the documentation as a pdf from its location on readthedocs, namely, https://nlnz-tools-sip-generation-fairfax.readthedocs.io , annotate that pdf with the desired changes, and then submit that annotated pdf in a github issue. Github describes the process of creating an issue here: https://help.github.com/en/articles/creating-an-issue .

License¶

All contributions to the NLNZ Tools SIP Generation Fairfax must be under the MIT (2019) License, which can be found at: https://mit-license.org/

The code is open-source software and is freely available for the benefit of the international archiving community.

See the Contributing section of the Developer Guide for more details.

Copyright¶

Contributors¶

See git commits to see who contributors are.

Release history¶

See Release Notes for release notes on specific versions.