 |
San Francisco, California | |||
| USA | ||||
|
|
San Francisco, California | |||
| USA | ||||
Custom Metadata - Lightroom Plugin
Provides custom-configurable metadata for library panel, library filter, and smart collections.
Includes functions to group, ungroup, and select a group of photos.
Featuring:
Quick Links (intra-page)
Background Information
Screenshots
How to Use
Custom Metadata FAQ (Frequently Asked Questions)
Revision History
Download
See the readme file after downloading for usage and other notes.
Plugin Manager
File Menu -> Plugin Extras
Lightroom supports pre-defined metadata based on IPTC spec and what have you, but there is no capability for user-specific metadata used to support personal organizational styles, and such stuff. Thus the custom-metadata plugin was born...
Initial version of this plugin was not much more than the example from the Lightroom SDK.
2nd versions moved it to elare plugin framedwork and added transfer, sync, and export features.
3rd version introduced handling of groups of related photos.
Version 3 was inspired by the idea of being able to bind related photos into groups, see related forum thread.
CustomMetadata adds the following custom metadata fields to your photos by default:
(you can delete, change, or add your own...)
- Groups: used by group menu functions.
- Properties: General purpose field for defining photo properties.
- Notes (Private): For notes not intended for the public eye.
- Notes (Public): Notes that may accompany an exported photo.
- To Do: Comments about what needs to be done with/to this photo.
- Edit Notes: Destructive edit history, or whatever you deem pertinent.
- Acquisition Notes: Describes details of image aquisition.
- Content Details: Notes about the content of the photo.
- State: "action/no-action-required" (dropdown selection) - I added this for a friend (I don't use it), I just check 'To Do' field to determine if action required.
Note: To delete / change / add / modify these fields, edit the Metadata.lua file in the lrplugin folder: instructions are inside.
These fields are stored in your catalog, and presented in the bottom of the right-hand Library panel, and are available as Library filters and for use in smart collections.
| Metadata | Any info kept with a photo that is not directly related to its appearance as an image, but is there for informational or organizational purposes. Develop settings are not considered metadata for the purpose of this document/plugin. |
| Custom Metadata | Metadata defined by a plugin. It can be read by any other plugin, but only written by the defining plugin. Defined in a file (Metadata.lua) specified in LrMetadataProvider (Info.lua). Synonym: "photo properties for plugin". |
- Install (see readme file in downloaded zip file)
- Configure in plugin manager
- Library panel
- Library Filter
- Smart Collections
- File Menu
See elare plugin framework for common settings.
Additional Settings and Controls
| Custom Metadata Management | |
The 'Backup/Restore - XML' buttons were intended to be like an xmp extension. Note: if you rename a photo file then the saved metadata file will become dissociated, in which case you will need to resave it (or "manually" change the custom-metadata xml filename to match). Note: if the metadata has not changed, the file will not be changed, so one can use the last-modified time to backup only changed files. The idea is to make custom metadata more secure, since its not saved in xmp. |
|
| Backup as XML | Saves all or selected metadata in xmp-like xml files in catalog sibling folder. From there you can make an additional back up copy for additional safe keeping, if desired. |
| Restore from XML | Restores all or selected metadata (previously saved). Useful in case a catalog needs to be rebuilt from xmp or other disaster recovery. It could also be imported from there into other 3rd party software like a database program for analysis or printing... |
| Transfer Metadata | Transfer all or selected metadata items from other Lightroom native fields or other plugin fields. Suggesiton: First select a test photo and click the 'Transfer Metadata' button in the plugin manager. Once it works for one test photo, do it again with more photos selected, or no photos selected (in which case it will do the entire catalog). Must be configured first by clicking 'Edit Advanced Settings' (hint: first enter a preset name in preset manager section of plugin manager) |
| Export CSV | Exports all or selected metadata items for selected photos as CSV sidecars (csv files in same directory as sources with same base filename), a single CSV file in a location of your choice, or separate files in a single directory. Useful for building web galleries or e-commerce sites that accept information in csv format. |
| Import CSV | Imports multiple CSV files or a single CSV file containing metadata previously exported by Custom Metadata plugin or any other source. |
CSV Format for a single big file containing metadata for all target photos: path, copy-name, item-1, item-2, ... - i.e. first two items must be photo path and virtual copy name if applicable, and the other items are the various custom metadata fields. for example: path, copyName, my_notes_private CSV Format for a multiple little files each containing metadata for only one photo: path-or-filename, copy-name, item-1, item-2, ... - i.e. first two items must be photo path and virtual copy name if applicable, and the other items are the various custom metadata fields. for example, if all files are sidecars in with source then: filename, copyName, my_notes_private or if all files are in a single directory, then: path, copyName, my_notes_private Hint: you can tell what format it reads by looking at the format it writes. |
|
Feel free to edit values in the library panel for all fields except 'Groups'. 'Groups' is reserved for use by File Menu's "Group" functions.
When defining a rule, you can select one of your custom metadata fields in the leftmost drop-down... Of particular note is the 'Groups' field. Some examples:
To isolate a single group, enter:
Groups contains name={my-group-name}
And if you want to see just the representative photo, then also enter:
Groups contains rep=me
Or, to isolate all HDR photos:
Groups contains type=HDR
(assuming you used HDR as type when defining HDR groups)
Press '\' key to display library filters (if not already displayed), then click on 'Metadata' to display colums of metadata for filtering, then edit a column or add a column and select one of your custom metadata fields. Select one or more items from list to filter thumbnails. Note: the 'Groups' metadata field is not so helpful in selecting specific groups, since its multi-line and sometimes long, but it can be very helpful in isolating those photos that are in some kind of group, and then using the menu function for selecting photos in a specified group, or Ctrl/Cmd clicking a collection to go with it...
Access via Lightroom's menu bar: File Menu -> Plugin Extras
| Sync Custom Metadata | Copies all or selected custom metadata from most selected photo to other selected photos. You will be presented with a checklist form first. |
| Define Group | Binds selected photos into a group with most selected photo being considered its "representative". - kinda like a stack, except its supported in collections, and members need not be in same folder or collection. One can select various group photos using ordinary Lightroom smart collections, or with the assistance of the 'Select Group' menu item below. You need to give the group a name, and can also give the group a type. Note: unselected photos will not be part of the group begin defined. |
| Add to Group | Selected photos will be added to specified group. |
| Remove from Group | Selected photos will be removed from specified group. |
| Select Group | Select members of a group. You will be able to select a group name, but only groups containining member photos in active sources will be presented, unless you select a collection that has no photos in at as your active source (or the all-photographs collection), in which case you will be prompted to consider all groups in catalog instead. |
| Delete Group | Removes metadata corresponding to specified group from all photos that have it, effectively deleting the group - no photos are deleted or removed from catalog. |
| Collect Group | Convenience function for replacing contents of Custom Metadata's quick-group collection with that of the specified group, and making said collection the exclusive source - convenient for isolating group photos for editing or whatever... |
*** Important note: If you've customized Metadata.lua, be careful not to overwrite your customized version of Metadata.lua - all other files can be updated. Feel free to check out the new field(s) added to the newer version of Metadata.lua, and copy and paste them to your customized Metadata.lua if you like.
*** Important notes regarding upgrading from version 1 to version 2:
Be sure to edit the toolkitId in Info.lua to match the previous one, or it will seem like all your previous metadata has disappeared.
Either transfer modified metadata items to the new Metadata.lua file OR just use the one you have instead of the newly downloaded one - the old metadata module will work with the rest of the plugin files just fine as long as you edit Info.lua since the metadata module name has changed (applies to all updates).
*** Important notes regarding updating any version 2 (from another version 2 )
Do not overwrite an edited Metadata.lua file with an incoming, since it will wipe out your edited version of Metadata.lua file. If you want new fields just copy them from the new Metadata.lua to your edited one.
If you have an 'Update Plugin' button in plugin manager (later versions do), then use it to update the plugin and you won't have any of the aforementioned issues to worry about...
Finally: *Nothing* (short of SQL hacking) can remove your custom metadata from the catalog. If it ever appears like its missing, its because the plugin became disabled, or the toolkit identifier in Info.lua has changed. Once the plugin is re-enabled, and/or the toolkit identifier restored, your custom metadata will reappear.
These FAQs come partly from users, and partly from my imagination. Please let me know if there are errors or omissions in this FAQ - thanks.
NOTE: The following Q&A's assume that the plugin is working as I expect... If, after your best effort, still "no go", please let me know.
Question: Why would I ever need or want such a thing as Custom Metadata?
Answer: From a strictly metadata point of view, custom metadata offers one advantage over native metadata - it leaves native metadata open to be used for the manner in which it was intended, instead of being bastardized for custom purposes. For example, one could use IPTC Scene code to keep to-do and/or edit notes, but then your to-do lists and/or edit notes would end up being published as IPTC Scene codes. And if you decided to use IPTC scene code for its true purpose in the future, you'd be in a quandry. But in addition to pure user enterable metadata, the CustomMetadata plugin offers transfer, sync, export, and group handling features.
Question: What should I use for group name when grouping photos?
Answer: Choose a unique name for this group - something you can remember when it comes time to choose it from a dropdown, or specify it in a smart collection text box. Beware of spaces - I use CamelHump notation, examples:
Some people prefer using underscores:
Or you can use spaces ***:
*** looks nicer, but it may be hard to find Saint Mary's Cathedral using a smart collection without getting Saint Ignacius, Mary's Home Pies, and Grace Cathedral too.
Question: What should I use for group type when grouping photos?
Answer: Type is optional, but here are some examples:
Question: Why is the Groups field user-editable yet you recommend not editing it?
Answer: All multi-line fields must be editable, else Lightroom makes it into a single long long line that brings Lightroom to its knees. So, it's editable, but shouldn't be edited.
Question: Is it ever OK to edit the Groups field?
Answer: In general its best to leave it alone, although I sometimes set rep=me, to define a representative when the representative has been "ungrouped" but some photos are still grouped. The same thing can be accomplished by regrouping, its just a shortcut...
Question: How can I transfer metadata to exports bound for catalog (e.g. re-mastering)?
Answer: First, click 'Edit Advanced Settings' in the plugin manager and make sure you approve of which items will be transferred, and which will not - and edit to match your metadata and your desires (its toward the bottom). Then, insert 'Transfer Custom Metadata' post-process action in export dialog box.
Question: What if you died today? - what happens to my custom metadata tomorrow?
Answer: Custom Metadata uses nothing that will be deprecated in Lr4, so it should keep on truckin' until at least Lr5, and maybe beyond, but dunno how far beyond..., but if its not being maintained any more, a smart person would probably consider exporting all the custom metadata using which ever version of Lightroom it still works with, and then find a way to import that data into some other metadata fields, either of another plugin that is being maintained, or Lightroom proper. You may be able to use built-in Lightroom functions to do it (in the future), or a plugin that supports metadata transferral, exiftool (e.g. to update IPTC fields and then re-read metadata in Lightroom), or an SQL update statement issued directly to the catalog file. Somebody in the community would probably be happy to help if this is more than you can do.
The basic functionality of Custom Metadata (defining user-editable fields for library panel / filter / smart-collections) is trivial and is contained in just a few lines of code so any plugin author including me if able could adapt the core functionality to the next Lightroom version in just a few minutes, even if all the fancy stuff (backup/export/transfer...) was to be dropped temporarily, or permanently. Note: I include all source code so anybody who knows how could readily do it...
PS - If you really wanted to discontinue using Custom Metadata and transfer the metadata to another (target) plugin that can't import custom metadata from other plugins, here is a trick:
Question: Any other hot tips I should know about?
Answer: Yes:
Question: What are the limitations of Custom Metadata and what are your plans for the future?
Answer:
(reverse chronological order)
Version 4.1.1, released 2011-03-21
- Suppresses Lr4.0 compatibility warning.
Version 4.1, released 2011-12-03
- Added additional options for exporting CSV, and added import CSV function.
Version 4.0.2, released 2011-11-16
- Fixed bug in export filter (post-process action) in case photos don't have any specified custom metadata.
Version 4.0.1, released 2011-11-15
- Added export filter (post-process action) to transfer custom metadata to exported photos when being added to catalog.
Version 3.2, released 2011-11-09
- Improved progress indicator when saving custom metadata.
Version 3.1, released 2011-10-17
- Enhanced group handling.
Version 3.0, released 2011-10-14
- Added group support.
Versions 2.0-2.6 releases:
@2.6 (10/12/2011) - Added item to file menu for manual sync of selected metadata.
@2.5 (10/12/2011) - Added ability to transfer custom metadata from another plugin (or same plugin when it had a different ID - hint: 'Edit Advanced Settings'). Also fixed bug that 'Check for Update' would fail if plugin-id was migrated when updating plugin.
@2.4 (10/11/2011) - Configuration for metadata to transfer, export as csv, and save/read has been moved to "advanced settings" - you no longer have to edit 'SpecialManager.lua', which not only makes it easier, but also you don't risk overwriting 'SpecialManager.lua' when updating the plugin (hint: use the 'Update Plugin' button in plugin manager, to update plugin, if possible).
@v2.3 (10/11/2011) - Added buttons to save/read custom metadata as xml. Also added an 'Update Plugin' button for next time - will assure your modified Metadata.lua file is not overwritten when updating, and your Info.lua file has the correct ID so no metadata temporarily appears lost.
@v2.2 (09/27/2011) - Added button to export custom metadata as csv.
@v2.1 - Added enumerated field for "action/no-action required" that defaults to "no action required".
@v2.0 - Lr3 only.
Version 1 releases are not documented, but they were Lr2-compatible.
acceptance of Download Terms & Conditions will be required
Custom Metadata 4.1.1 - Latest & greatest: this is the one to download.
Custom Metadata 4.0.2 - previous version in case latest has problems.
Custom Metadata 1.0 - for very rudimentary Lr2-compatible version.
| Static content updated 2011-10-12 | Copyright 2007 - robcole.com - all rights reserved. | Dynamic content updated 07:18:54 PM |