From fe2f9c8588b1d24c31dc725dfd063150968faabd Mon Sep 17 00:00:00 2001 From: Payten Giles Date: Thu, 29 Apr 2021 09:28:31 +1000 Subject: [PATCH] Update readme and add license --- COPYING | 12 ++++++++++++ README.md | 18 +++++++++++------- 2 files changed, 23 insertions(+), 7 deletions(-) create mode 100644 COPYING diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..dc26d94 --- /dev/null +++ b/COPYING @@ -0,0 +1,12 @@ +Copyright 2021 Hudson Molonglo Pty Ltd +Licensed under the Educational Community License, Version 2.0 (the +"License"); you may not use this file except in compliance with the +License. You may obtain a copy of the License at + +http://opensource.org/licenses/ecl2.php + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an "AS IS" +BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express +or implied. See the License for the specific language governing +permissions and limitations under the License. \ No newline at end of file diff --git a/README.md b/README.md index bfc9fb8..7089770 100644 --- a/README.md +++ b/README.md @@ -9,10 +9,11 @@ Developed by Hudson Molonglo for The New School. This plugin adds the ability to download a spreadsheet for a set of archival objects from a particular resource. This spreadsheet can then be used to apply a series of changes to those archival objects and the fields presented. Once -prepared, the spreadsheet can be applied via a new background job. +prepared, the changes within the spreadsheet can be applied via a new background +job. To download the spreadsheet there is now a "Bulk Update Spreadsheet" menu item -available on the resource view or edit page menu (under the "More" menu). You +available on the resource view or edit page under the "More" menu. You will be required to select the archival objects to be included in the spreadsheet and can download the XLSX from this form. @@ -22,6 +23,9 @@ simply select your XLSX file in the presented form and click "Start Job". ### Fields and Subrecords +Currently the following Archival Object fields and subrecords are exposed in the +XLSX spreadsheet. + Archival Object fields: * title * level @@ -36,8 +40,8 @@ least 3 empty sets to allow creation of new subrecords on the archival object. The columns provide access to a subset of the subrecord fields, whereby any mandatory fields not provided are given default values upon import. -If a values are provided for a subrecord at an index do not map to an existing -subrecord, a new subrecord will be created. +If the values provided do not map to an existing subrecord, a new subrecord will +be created. Notes: * accessrestrict @@ -54,7 +58,7 @@ new note will be created. ## Prerequisites -This plugin relies on the digitization_work_order plugin being enabled, +This plugin relies on the `digitization_work_order` plugin being enabled, available here: https://github.com/hudmol/digitization_work_order. ## Installation @@ -92,8 +96,8 @@ See also: > AppConfig[:spreadsheet_bulk_updater_apply_deletes] : `boolean` If enabled, the importer will drop subrecords (dates, extents, instances or -notes) when all columns for that existing subrecord have no values. As not all -subrecord fields have a corresponding column in the spreadsheet, you may +notes) when all spreadsheet columns for that existing subrecord have no values. +As not all subrecord fields have a corresponding column in the spreadsheet, you may unwittingly drop a subrecord which has data in other fields. Default: `false`