From 2d6c18a99667d9a6567df88751516566000b9391 Mon Sep 17 00:00:00 2001 From: Andreas Romeyke <art1@andreas-romeyke.de> Date: Sat, 23 Oct 2021 17:42:00 +0200 Subject: [PATCH] - added comment --- lib/SLUB/LZA/SIPBuilderBagIt.pm | 40 +++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) diff --git a/lib/SLUB/LZA/SIPBuilderBagIt.pm b/lib/SLUB/LZA/SIPBuilderBagIt.pm index aa6f5ea..389ae1c 100644 --- a/lib/SLUB/LZA/SIPBuilderBagIt.pm +++ b/lib/SLUB/LZA/SIPBuilderBagIt.pm @@ -1,4 +1,44 @@ package SLUB::LZA::SIPBuilderBagIt; +#=============================================================================== +# FILE: slubsipbuilderbagit.pl +# +# USAGE: perl bin/slubsipbuilderbagit.pl --help +# EXAMPLES: perl bin/slubsipbuilderbagit.pl --man +# +# DESCRIPTION: A CLI tool to create a valid SIP for ingest into SLUBArchiv.digital +# +# REQUIREMENTS: perl install version 5.28 or higher, as all necessary modules required +# module Archive::BagIt required version 0.070 or higher +# For Debian users: If cpan installations fails, please install libperl-dev and libperl5.28 +# For Windows users: Check if UTF-8 flag set at +# Systemsteuerung > Zeit und Region > Region > Verwaltung/Gebietsschema ändern +# +# NOTES: related to official document "SIP Spezifikation für automatischen Ingest SLUBArchiv" +# https://slubarchiv.slub-dresden.de/technische-standards-fuer-die-ablieferung-von-digitalen-dokumenten/ +# option --save_option=copy is RECOMMENDED (If processing fails, manual restoration is needed!) +# option --add_meta_file="key: values" must be in quotes to be able to write whitespaces for values +# +# Copyright (c) 2021 +# ORGANIZATION: Saxon State and University Library Dresden (SLUB) +# AUTHORS: Serhiy Bolkun (Serhiy.Bolkun@slub-dresden.de) +# Andreas Romeyke (Andreas.Romeyke@slub-dresden.de) +# Jens Steidl (Jens.Steidl@slub-dresden.de) +# +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see <https://www.gnu.org/licenses/> +#=============================================================================== + use strict; use warnings; use utf8; -- GitLab