luadocs/content/lua.scripts.manual/scripts/contrib/CollectHelper.md
Bill Ferguson b69d752221 [lua scripts] created manual from script comments
[lua scripts api] created manual from embedded library documentation

[lua api] created stub to contain lua api manual
2020-12-12 15:14:19 -05:00

1.6 KiB

title id weight draft author
CollectHelper CollectHelper 40 false people

Name

CollectHelper.lua - add buttons to help with collections

Description

This plugin adds the button(s) to the "Selected Images" module:

  1. Return to Previous Collection
  2. Collect on image's Folder
  3. Collect on image's Color Label(s)
  4. Collect on All (AND)

It also adds 3 preferences to the lua options dialog box which allow the user to activate/deactivate the 3 "Collect on" buttons.

Button Behavior:

  1. Return to Previous Collection - Will reset the collect parameters to the previously active settings
  2. Collect on image's Folder - Will change the collect parameters to be "Folder" with a value of the selected image's folder location
  3. Collect on image's Color Label(s) - Will change the collect parameter to be "Color" with a value of the selected images color labels, will apply multiple parameters with AND logic if multiple exist
  4. Collect on All (AND) - Will collect on all parameters activated by the preferences dialog, as such this button is redundant if you only have one of the two other options enabled

Usage

Install: (see here for more detail: https://github.com/darktable-org/lua-scripts )

  1. Copy this file in to your "lua/contrib" folder where all other scripts reside.
  2. Require this file in your luarc file, as with any other dt plug-in

Select the photo you wish to change you collection based on. In the "Selected Images" module click on "Collect on this Image"

Additional Software Required

Limitations

Author

Kevin Ertel

Change Log