Several updates.

mjordan · Jan 1, 2025 · 974860c · 974860c
1 parent d6dcc70
commit 974860c
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 2 deletions.
diff --git a/docs/changelog.md b/docs/changelog.md
@@ -1,5 +1,8 @@
 ### main branch (no tag/release)
 
+* January 1, 2025: Resolved (commit f8dce4c) [issue 799](https://github.com/mjordan/islandora_workbench/issues/799).
+* December 31, 2024: Resolved (commit b512b7d) [issue 868](https://github.com/mjordan/islandora_workbench/issues/848).
+* December 28, 2024: Resolved (commit d02e140) [issue 848](https://github.com/mjordan/islandora_workbench/issues/868).
 * December 11, 2024: Resolved (commit c00af94) [issue 864](https://github.com/mjordan/islandora_workbench/issues/864).
 * December 4, 2024: Resolved (commit 9357ea6) [issue 859](https://github.com/mjordan/islandora_workbench/issues/859).
 * December 3, 2024: Resolved (commit eb5a849) [issue 856](https://github.com/mjordan/islandora_workbench/issues/856); resolved (commit 22e5d1e) [issue 857](https://github.com/mjordan/islandora_workbench/issues/857) and [issue 858](https://github.com/mjordan/islandora_workbench/issues/858).
@@ -153,6 +156,7 @@
 
 ### Documentation
 
+* January 1, 2025: Updated docs on "[Rolling back nodes and media](/islandora_workbench_docs/rolling_back/)" to include new settings added in [issue 868](https://github.com/mjordan/islandora_workbench/issues/868).
 * December 28, 2024: Update docs on "[Reducing Workbench's impact on Drupal](/islandora_workbench_docs/reducing_load/)"; updated docs on "[Creating paged, compound, and collection content](/islandora_workbench_docs/paged_and_compound/)."
 * December 3, 2024: Update docs on "[Applying CSV value templates to rows in your input CSV](/islandora_workbench_docs/csv_value_templates/#applying-csv-value-templates-to-paged-content)"; updated docs on "[](/islandora_workbench_docs/paged_and_compound/)."
 * December 1, 2024: Updated docs on "[Rolling back nodes and media](/islandora_workbench_docs/rolling_back/)" to include new settings added in [issue 855](https://github.com/mjordan/islandora_workbench/issues/855). Updated docs on "[Field data applied to pages/children](/islandora_workbench_docs/paged_and_compound/#field-data-applied-to-pageschildren)" to include link to "[Applying CSV value templates to paged content](/islandora_workbench_docs/csv_value_templates/#applying-csv-value-templates-to-paged-content)."

diff --git a/docs/check.md b/docs/check.md
@@ -7,7 +7,7 @@ You should *always* check your configuration and input prior to creating, updati
 !!! note
     If you're on Windows, you will likely need to run Workbench by explicitly invoking Python, e.g. `python workbench --config config.yml --check` instead of using `./workbench` as illustrated above. Similarly, if you are on a Mac that has the Homebrew version of Python, you may need to run Workbench by providing the full path to the Homebrew Python interpreter, e.g., `/opt/homebrew/bin/python3 workbench --config config.yml --check`.
 
-If you do this, Workbench will check the following conditions and report any errors that require your attention before proceeding:
+If you do this, Workbench will check the following conditions and report any warnings or errors that require your attention before proceeding:
 
 * Configuration file
     * Whether your configuration file is valid YAML (i.e., no YAML syntax errors).
@@ -35,6 +35,7 @@ If you do this, Workbench will check the following conditions and report any err
     * Whether files in the `file` CSV column have extensions that are registered with the media's file field in Drupal. Note that validation of file extensions does not yet apply to files named using the `additional_files` configuration or for remote files (see [this issue](https://github.com/mjordan/islandora_workbench/issues/126) for more info).
     * Whether the media types configured for specific file extensions are configured on the target Drupal. Islandora Workbench will default to the 'file' media type if it can't find another more specific media type for a file, so the most likely cause for this check to fail is that the assigned media type does not exist on the target Drupal.
     * If creating [media track files](/islandora_workbench_docs/media_track_files/), `--check` will tell you if your media_use_tid value (either in the media_use_tid configuration setting or in row-level values in your CSV) does not include the "Service File" taxonomy term.
+    * If ingesting media track files or page-level OCR or hOCR files, `--check` will validate whether the files are encoded as UTF-8.
 * Field values
     * Base fields
         * If the `langcode` field is present in your CSV, whether values in it are valid Drupal language codes.

diff --git a/docs/configuration.md b/docs/configuration.md
@@ -245,10 +245,10 @@ See "[Rolling back](/islandora_workbench_docs/rolling_back/)" for more informati
 | timestamp_rollback |  | false | Set to `true` to add a timestamp to the "rollback.yml" and corresponding "rollback.csv" generated in "create" and "create_from_files" tasks. |
 | rollback_config_filename_template |  | | Defines a template that will be used to create the rollback configuration file. The two placeholders availalble in this template are `$config_filename` and `$input_csv_filename`. |
 | rollback_csv_filename_template |  | | Defines a template that will be used to create the rollback CSV file. The two placeholders availalble in this template are `$config_filename` and `$input_csv_filename`. |
+| rollback_file_include_node_info |  | `false` | Set to `true` to include `title`, `field_member_of` and `file` columns in your rollback CSV file. |
 | rollback_file_comments |  | | Defines a list of lines to be added to both the rollback config and CSV file as comments. |
 | include_password_in_rollback_config_file |  | `false` | Set to `true` to include the value of the `password` configuration setting in your rollback config YAML file. |
 
-
 ### Miscellaneous settings
 
 | Setting | Required | Default value | Description |

diff --git a/docs/fields.md b/docs/fields.md
@@ -660,6 +660,8 @@ The `field_member_of` column can take a node ID, a full URL to a node, or a URL
 
 If you use any of these types of values other than the bare node ID, Workbench will look up the node ID based on the URL or alias.
 
+"field_member_of" is multivalued; you can include any combination of the above types of values in the same CSV cell.
+
 ## Values in the "field_domain_access" column
 
 The Domain Access module, part of the [Domain](https://www.drupal.org/project/domain) suite of modules, creates a required, multivalued field with the machine name `field_domain_access` that controls, at the node level, which domains the node shows up in. When populating this field in your Workbench CSV, replace the periods in domain names with `_`. For example, if the domains you want to allow a node to show up in are `test1.testing.edu` and `test2.testing.edu`, the values in your `field_domain_access` field look like this:

diff --git a/docs/rolling_back.md b/docs/rolling_back.md
@@ -85,3 +85,8 @@ This will result in the following comments in your rollback configuration and CS
 # Have a nice day!
 ```
 
+## Including additional node-level data in the rollback CSV file
+
+By default, rollback CSV files have only a single column, `node_id`. However, if you include `rollback_file_include_node_info: true` in your configuration, Workbench will add `title`, `field_member_of`, and `file` columns containing relevant info for each created node.
+
+You do not need to remove these columns from the rollback CSV file before using it.