diff --git a/README.md b/README.md index b846a2d..c82bba5 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ To use these curation tasks in a DSpace project add the following dependency to io.github.ilri.cgspace cgspace-java-helpers - 6.0 + 6.1-SNAPSHOT ``` @@ -31,7 +31,7 @@ $ mvn package Copy the resulting jar to the DSpace `lib` directory: ``` -$ cp target/cgspace-java-helpers-6.0.jar ~/dspace/lib/ +$ cp target/cgspace-java-helpers-6.1-SNAPSHOT.jar ~/dspace/lib/ ``` ## Configuration @@ -40,38 +40,6 @@ Please refer to the appropriate README.md file: - Curation Tasks: [src/main/java/io/github/ilri/cgspace/ctasks/README.md](https://github.com/ilri/cgspace-java-helpers/blob/dspace6/src/main/java/io/github/ilri/cgspace/ctasks/README.md) - Scripts: [src/main/java/io/github/ilri/cgspace/scripts/README.md](https://github.com/ilri/cgspace-java-helpers/blob/dspace6/src/main/java/io/github/ilri/cgspace/scripts/README.md) - -Add the curation task to DSpace's `config/modules/curate.cfg`: - -``` -plugin.named.org.dspace.curate.CurationTask = io.github.ilri.cgspace.ctasks.CountryCodeTagger = countrycodetagger -plugin.named.org.dspace.curate.CurationTask = io.github.ilri.cgspace.ctasks.CountryCodeTagger = countrycodetagger.force -``` - -And then add the following variables to your `local.cfg` or some other [configuration file that is included](https://wiki.lyrasis.org/display/DSDOC6x/Configuration+Reference#ConfigurationReference-IncludingotherPropertyFiles): - -``` -# name of the field containing ISO 3166-1 country names -countrycodetagger.iso3166.field = cg.coverage.country - -# name of the field containing ISO 3166-1 Alpha2 country codes -countrycodetagger.iso3166-alpha2.field = cg.coverage.iso3166-alpha2 - -# only add country codes if an item doesn't have any (default false) -#countrycodetagger.forceupdate = false -``` - -*Note*: DSpace's curation system supports "profiles" where you can use the same task with different options, for example above I have a normal country code tagger task and a "force" variant. The "force" variant is the same task, but it looks for configuration variables using the `countrycodetagger.force` instead. To use the "force" variant you simply need to add these new variables with the `forceupdate` parameter overridden to the same configuration file where you put the other variables. The "force" profile clears all existing country codes and updates everything. - -## Invocation -Once the jar is installed and you have added appropriate configuration in `~/dspace/config/modules`: - -``` -$ ~/dspace/bin/dspace curate -t countrycodetagger -i 10568/3 -r - -l 500 -s object -``` - -*Note*: it is very important to set the cache limit (`-l`) and the database transaction scope to something sensible (`object`) if you're curating a community or collection with more than a few hundred items. - ## Notes This project was initially created according to the [Maven Getting Started Guide](https://maven.apache.org/guides/getting-started/): @@ -79,12 +47,6 @@ This project was initially created according to the [Maven Getting Started Guide $ mvn -B archetype:generate -DgroupId=io.github.ilri.cgspace -DartifactId=cgspace-java-helpers -DarchetypeArtifactId=maven-archetype-quickstart -DarchetypeVersion=1.4 ``` -## TODO - -- Make sure this doesn't work on items in the workflow -- Check for existence of metadata field before trying to add metadata -- Add tests - ## License This work is licensed under the [GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html). diff --git a/src/main/java/io/github/ilri/cgspace/ctasks/README.md b/src/main/java/io/github/ilri/cgspace/ctasks/README.md index 05c1379..571fe9c 100644 --- a/src/main/java/io/github/ilri/cgspace/ctasks/README.md +++ b/src/main/java/io/github/ilri/cgspace/ctasks/README.md @@ -14,7 +14,7 @@ To use these curation tasks in a DSpace project add the following dependency to io.github.ilri.cgspace cgspace-java-helpers - 6.0 + 6.1-SNAPSHOT ``` @@ -30,7 +30,7 @@ $ mvn package Copy the resulting jar to the DSpace `lib` directory: ``` -$ cp target/cgspace-java-helpers-6.0.jar ~/dspace/lib/ +$ cp target/cgspace-java-helpers-6.1-SNAPSHOT.jar ~/dspace/lib/ ``` ## Configuration diff --git a/src/main/java/io/github/ilri/cgspace/scripts/README.md b/src/main/java/io/github/ilri/cgspace/scripts/README.md index 81b3999..99a2a13 100644 --- a/src/main/java/io/github/ilri/cgspace/scripts/README.md +++ b/src/main/java/io/github/ilri/cgspace/scripts/README.md @@ -14,7 +14,7 @@ To use these curation tasks in a DSpace project add the following dependency to io.github.ilri.cgspace cgspace-java-helpers - 6.0 + 6.1-SNAPSHOT ``` @@ -30,7 +30,7 @@ $ mvn package Copy the resulting jar to the DSpace `lib` directory: ``` -$ cp target/cgspace-java-helpers-6.0.jar ~/dspace/lib/ +$ cp target/cgspace-java-helpers-6.1-SNAPSHOT.jar ~/dspace/lib/ ``` ## Invocation