From 0c04f0ed81576515cb31321edc8ca4c0fdac3ca4 Mon Sep 17 00:00:00 2001 From: allanaaa Date: Wed, 4 Sep 2024 07:26:36 -0400 Subject: [PATCH] Update README.md Re https://github.com/omeka/omeka-s-enduser/issues/207 --- README.md | 43 ++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 40 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 29c58d5..e9dff46 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,46 @@ # Copy Resources -An [Omeka S](https://omeka.org/s/) module for copying resources, including items, -item sets, sites, and site pages. +An [Omeka S](https://omeka.org/s/) module for copying resources, including items, item sets, sites, and site pages. -## For Module Developers +Copy Resources inserts a "copy" button into the interface of several pages in the admin side, including when viewing the resource, and on the table of sites, each site's table of pages, and the items and item sets tables. + +Items and item sets will get a new unique identifier, but have all their metadata fields duplicated, including data captured by modules, such as geolocation data in Mapping. Duplicate items will be added to the same item sets as the originals; duplicated resources will be added to the same sites as the originals. However, duplicated items will have no media copied with them. + +Sites and site pages will have the same name, but their URL slugs will be unique. Pages will have all their page blocks duplicated, including blocks added by modules, and those blocks' settings. + +Some content will not copy exactly - be sure you review duplicated resources thoroughly and look for anything missing before making the new resource public. + +## Permissions + +Global Administrators, Supervisors, and Editors can use this module to copy items, item sets, sites, and site pages. + +Users at Author and Reviewer levels can copy items and item sets. + +Site-specific permissions do not affect a user's ability to copy sites. Site copying is reserved for Global Administrators, Supervisors, and Editors. + +Users with site-specific permissions of Creator and Manager can copy pages. + +Users can copy resources that they do not own. When a resource is copied, the user who made the duplicate will become its owner; the resource will not retain the owner of the original. + +## Requirements + +Copy Resources requires Omeka S 4.1.0 or later. + +If you are using the following modules, we recommend you upgrade to versions that have been updated since Copy Resources' release, specifically: + +- Collecting version 1.12 or later +- Data Visualization version 1.3 +- Item Carousel Block version 1.3 +- Faceted Browse version 1.5.1 +- Mapping version 2.0 +- Scripto version 1.5 +- Sharing version 1.5. + +Other modules with data potentially copyable by Copy Resources, such as Metadata Browse, do not have dependencies. + +See the [Omeka S user manual](https://omeka.org/s/docs/user-manual/modules/copyresources/) for user documentation. + +## For developers ### Events