Skip to content

Commit

Permalink
Merge pull request #243 from UAlbanyArchives/develop
Browse files Browse the repository at this point in the history
updated docs and build
  • Loading branch information
gwiedeman authored Jan 26, 2024
2 parents c526ac9 + d90d09b commit 70bf95a
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 2 deletions.
5 changes: 4 additions & 1 deletion docs/using_mailbagit/mailbagit.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,10 +78,13 @@ e.g. `-d eml pdf warc`
> Compresses the mailbag as a ZIP, TAR, or TAR.GZ
> e.g. `-c zip` or `-c tar.gz`
* **-f, --companion_files**
* **-f, --companion-files**
> Allows for companion metadata files to be packaged alongside email export files.
> When this option is used, `mailbagit` will recursively include all the files in the directory provided into a mailbag.
* **-l, --external-links**
> Will crawl and add external `<a href="">` links to WARC derivatives as response records
### Bagit-python arguments

Mailbagit also accepts most [bagit-python](https://github.com/LibraryOfCongress/bagit-python) arguments. Thus, you can provide arguments like `--processes 2` or arguments to add metadata such as `--source-organization University at Albany, SUNY`
Expand Down
2 changes: 1 addition & 1 deletion docs/using_mailbagit/warcs.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ nav_order: 9

# WARC Derivatives

`mailbagit` can create WARC derivatives for email messages. This is a bit of an experimental feature in that using web archives for email isn't common and there is no concensus yet on how these WARC should be strutured. Still, since WARCs do a good job of both preserving how messages are displayed as well as maintaining email messages as data, they can be really useful for email preservation. Thus, we're including this feature as an example for users to try out and experiment with. If you have thoughts or feedback on this, please [submit an issue](https://github.com/UAlbanyArchives/mailbagit/issues/new/choose)!
`mailbagit` can create WARC derivatives for email messages. This is a bit of an experimental feature in that using web archives for email isn't common and there is no concensus yet on how these WARC should be structured. Still, since WARCs do a good job of both preserving how messages are displayed as well as maintaining email messages as data, they can be really useful for email preservation. Thus, we're including this feature as an example for users to try out and experiment with. If you have thoughts or feedback on this, please [submit an issue](https://github.com/UAlbanyArchives/mailbagit/issues/new/choose)!

WARCs can be more challenging to use that typical files, as you need software to "replay" them. [ReplayWeb.Page](https://replayweb.page/) is an easy method, and you can checkout the [Web Archiving Awesome List](https://github.com/iipc/awesome-web-archiving#replay) for more. The WARC files created by `mailbagit` can also be small enough to view in a text editor. The files are compressed with gzip, so you just have to extract them to plain text.

Expand Down

0 comments on commit 70bf95a

Please sign in to comment.