diff --git a/docsrc/source/tutorial.md b/docsrc/source/tutorial.md index e4ca1b69..a293767b 100644 --- a/docsrc/source/tutorial.md +++ b/docsrc/source/tutorial.md @@ -55,7 +55,7 @@ By default, osxphotos will use the original filename of the photo when exporting `osxphotos export /path/to/export --filename "{title}"` -The above command will export photos using the title. Note that you don't need to specify the extension as part of the `--filename` template as osxphotos will automatically add the correct fie extension. Some photos might not have a title so in this case, you could use the default value feature to specify a different name for these photos. For example, to use the title as the filename, but if no title is specified, use the original filename instead: +The above command will export photos using the title. Note that you don't need to specify the extension as part of the `--filename` template as osxphotos will automatically add the correct file extension. Some photos might not have a title so in this case, you could use the default value feature to specify a different name for these photos. For example, to use the title as the filename, but if no title is specified, use the original filename instead: ```txt osxphotos export /path/to/export --filename "{title,{original_name}}" @@ -315,6 +315,26 @@ Then the next to you run osxphotos, you can simply do this: The configuration file is a plain text file in [TOML](https://toml.io/en/) format so the `.toml` extension is standard but you can name the file anything you like. +### An example from an actual osxphotos user + +Here's a comprehensive use case from an actual osxphotos user that integrates many of the concepts discussed in this tutorial (thank-you Philippe for contributing this!): + + I usually import my iPhone’s photo roll on a more or less regular basis, and it includes photos and videos. As a result, the size ot my Photos library may rise very quickly. Nevertheless, I will tag and geolocate everything as Photos has a quite good keyword management system. + + After a while, I want to take most of the videos out of the library and move them to a separate "videos" folder on a different folder / volume. As I might want to use them in Final Cut Pro, and since Final Cut is able to import Finder tags into its internal library tagging system, I will use osxphotos to do just this. + + Picking the videos can be left to Photos, using a smart folder for instance. Then just add a keyword to all videos to be processed. Here I chose "Quik" as I wanted to spot all videos created on my iPhone using the Quik application (now part of GoPro). + + I want to retrieve my keywords only and make sure they populate the Finder tags, as well as export all the persons identified in the videos by Photos. I also want to merge any keywords or persons already in the video metadata with the exported metadata. + + Keeping Photo’s edited titles and descriptions and putting both in the Finder comments field in a readable manner is also enabled. + + And I want to keep the file’s creation date (using `--touch-file`). + + Finally, use `--strip` to remove any leading or trailing whitespace from processed template fields. + +`osxphotos export ~/Desktop/folder for exported videos/ --keyword Quik --only-movies --db /path to my.photoslibrary --touch-file --finder-tag-keywords --person-keyword --xattr-template findercomment "{title}{title?{descr?{newline},},}{descr}" --exiftool-merge-keywords --exiftool-merge-persons --exiftool --strip` + ### Conclusion osxphotos is very flexible. If you merely want to backup your Photos library, then spending a few minutes to understand the `--directory` option is likely all you need and you can be up and running in minutes. However, if you have a more complex workflow, osxphotos likely provides options to implement your workflow. This tutorial does not attempt to cover every option offered by osxphotos but hopefully it provides a good understanding of what kinds of things are possible and where to explore if you want to learn more. \ No newline at end of file