doc

CHANGELOG.md

@@ -8,6 +8,12 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ## [Unreleased]
 
 
+## [0.8.1] - 2023-08-23
+### Changed
+- Add an configuration option to robustly handle errors generated by the
+ operating system on file system access (perhaps from a corrupted database.
+
+
 ## [0.8.0] - 2023-08-16
 Downstream moderate risk update release.
 
@@ -176,7 +182,8 @@ Downstream moderate risk update release.
 - Initial version
 
 
-[Unreleased]: https://github.com/plandes/zotsite/compare/v0.8.0...HEAD
+[Unreleased]: https://github.com/plandes/zotsite/compare/v0.8.1...HEAD
+[0.8.1]: https://github.com/plandes/zotsite/compare/v0.8.0...v0.8.1
 [0.8.0]: https://github.com/plandes/zotsite/compare/v0.7.0...v0.8.0
 [0.7.0]: https://github.com/plandes/zotsite/compare/v0.6.3...v0.7.0
 [0.6.3]: https://github.com/plandes/zotsite/compare/v0.6.2...v0.6.3

doc/usage.md

@@ -123,6 +123,26 @@ The generated website takes the following URL encoded parameters:
 * **isView**: if `1`, go directly to the PDF rather than the information page.
 
 
+## Robust File System Access
+
+If one file copy from the Zotero storage fails, the program dump a stack trace
+and terminate. However, there might be cases where the database might have
+out-of-sync entries from what is on the file system but you still want to
+export those entries that are available.
+
+To change this behavior and robustly deal with missing entries, add the
+following to the [configuration file]:
+
+```ini
+[site_creator]
+robust_fs = True
+```
+
+This tells the program to continue to try to export even when encountering file
+system copy issues. However, you'll get a lot of verbose error output if there
+is some larger issue.
+
+
 <!-- links -->
 [configuration file]: #configuration-file
 [Zotero]: https://www.zotero.org

test-resources/zotsite.conf

@@ -23,3 +23,8 @@ collection_like = %%
 prune_pattern = None
 # the default output directory to store the collection
 out_dir = None
+
+## if the below is uncommented, it will continue to try to export the even when
+## encountering file system copy issues.
+# [site_creator]
+# robust_fs = True