Merge pull request #464 from wpferguson/implement_script_metadata

Implement script metadata

Author: wpferguson

contrib/AutoGrouper.lua

@@ -52,9 +52,9 @@ local du = require "lib/dtutils"
 
 du.check_min_api_version("7.0.0", "LabelsToTags") 
 
-local gettext = dt.gettext.gettext
+local gettext = darktable.gettext.gettext
 
-gettext.bindtextdomain("LabelsToTags", dt.configuration.config_dir .."/lua/locale/")
+darktable.gettext.bindtextdomain("LabelsToTags", darktable.configuration.config_dir .."/lua/locale/")
 
 local function _(msgid)
   return gettext(msgid)
@@ -64,6 +64,13 @@ end
 
 local script_data = {}
 
+script_data.metadata = {
+  name = "LabelsToTags",
+  purpose = _("allows the mass-application of tags using color labels and ratings as a guide"),
+  author = "August Schwerdfeger (august@schwerdfeger.name)",
+  help = "https://docs.darktable.org/lua/stable/lua.scripts.manual/scripts/contrib/LabelsToTags"
+}
+
 script_data.destroy = nil -- function to destory the script
 script_data.destroy_method = nil -- set to hide for libs since we can't destroy them commpletely yet, otherwise leave as nil
 script_data.restart = nil -- how to restart the (lib) script after it's been hidden - i.e. make it visible again

contrib/CollectHelper.lua

@@ -65,10 +65,26 @@ local MODULE_NAME = "RL_out_sharp"
 -- check API version
 du.check_min_api_version("7.0.0", MODULE_NAME) 
 
+-- translation
+local gettext = dt.gettext.gettext
+
+dt.gettext.bindtextdomain("RL_out_sharp", dt.configuration.config_dir .."/lua/locale/")
+
+local function _(msgid)
+  return gettext(msgid)
+  end
+
 -- return data structure for script_manager
 
 local script_data = {}
 
+script_data.metadata = {
+  name = "RL_out_sharp",
+  purpose = _("Richardson-Lucy output sharpening using GMic"),
+  author = "Marco Carrarini <marco.carrarini@gmail.com>",
+  help = "https://docs.darktable.org/lua/stable/lua.scripts.manual/scripts/contrib/RL_out_sharp"
+}
+
 script_data.destroy = nil -- function to destory the script
 script_data.destroy_method = nil -- set to hide for libs since we can't destroy them commpletely yet, otherwise leave as nil
 script_data.restart = nil -- how to restart the (lib) script after it's been hidden - i.e. make it visible again
@@ -77,15 +93,6 @@ script_data.show = nil -- only required for libs since the destroy_method only h
 -- OS compatibility
 local PS = dt.configuration.running_os == "windows" and  "\\"  or  "/"
 
--- translation
-local gettext = dt.gettext.gettext
-
-gettext.bindtextdomain("RL_out_sharp", dt.configuration.config_dir .."/lua/locale/")
-
-local function _(msgid)
-  return gettext(msgid)
-  end
-
 -- initialize module preferences
 if not dt.preferences.read(MODULE_NAME, "initialized", "bool") then
   dt.preferences.write(MODULE_NAME, "sigma", "string", "0.7")

contrib/HDRMerge.lua

@@ -43,7 +43,7 @@ local filelib = require "lib/dtutils.file"
 du.check_min_api_version("7.0.0", "autostyle") 
 
 local gettext = darktable.gettext.gettext
-gettext.bindtextdomain("autostyle", dt.configuration.config_dir .."/lua/locale/")
+darktable.gettext.bindtextdomain("autostyle", darktable.configuration.config_dir .."/lua/locale/")
 
 local function _(msgid)
   return gettext(msgid)
@@ -53,6 +53,13 @@ end
 
 local script_data = {}
 
+script_data.metadata = {
+  name = "autostyle",
+  purpose = _("automatically apply a style based on image EXIF tag"),
+  author = "Marc Cousin <cousinmarc@gmail.com>",
+  help = "https://docs.darktable.org/lua/stable/lua.scripts.manual/scripts/contrib/autostyle/"
+}
+
 script_data.destroy = nil -- function to destory the script
 script_data.destroy_method = nil -- set to hide for libs since we can't destroy them commpletely yet, otherwise leave as nil
 script_data.restart = nil -- how to restart the (lib) script after it's been hidden - i.e. make it visible again

contrib/LabelsToTags.lua

@@ -40,23 +40,30 @@ local gettext = dt.gettext.gettext
 
 local MODULE = "change_group_leader"
 
-gettext.bindtextdomain(MODULE, dt.configuration.config_dir .."/lua/locale/")
+dt.gettext.bindtextdomain(MODULE, dt.configuration.config_dir .."/lua/locale/")
 
 du.check_min_api_version("3.0.0", MODULE)
 
+local function _(msgid)
+    return gettext(msgid)
+end
+
 -- return data structure for script_manager
 
 local script_data = {}
 
+script_data.metadata = {
+  name = "change_group_leader",
+  purpose = _("automatically change the leader of raw+jpg paired image groups"),
+  author = "Bill Ferguson <wpferguson@gmail.com>",
+  help = "https://docs.darktable.org/lua/stable/lua.scripts.manual/scripts/contrib/change_group_leader"
+}
+
 script_data.destroy = nil -- function to destory the script
 script_data.destroy_method = nil -- set to hide for libs since we can't destroy them commpletely yet, otherwise leave as nil
 script_data.restart = nil -- how to restart the (lib) script after it's been hidden - i.e. make it visible again
 script_data.show = nil -- only required for libs since the destroy_method only hides them
 
-local function _(msgid)
-    return gettext(msgid)
-end
-
 -- create a namespace to contain persistent data and widgets
 chg_grp_ldr = {}
 

contrib/OpenInExplorer.lua

@@ -39,28 +39,34 @@
 local dt = require "darktable"
 local du = require "lib/dtutils"
 
+local gettext = dt.gettext.gettext 
+dt.gettext.bindtextdomain("clear_GPS", dt.configuration.config_dir .."/lua/locale/")
+
+local function _(msgid)
+    return gettext(msgid)
+end
+
 -- return data structure for script_manager
 
 local script_data = {}
 
+script_data.metadata = {
+  name = "clear_GPS",
+  purpose = _("remove GPS data from selected image(s)"),
+  author = "Bill Ferguson <wpferguson@gmail.com>",
+  help = "https://docs.darktable.org/lua/stable/lua.scripts.manual/scripts/contrib/clear_gps/"
+}
+
 script_data.destroy = nil -- function to destory the script
 script_data.destroy_method = nil -- set to hide for libs since we can't destroy them commpletely yet
 script_data.restart = nil -- how to restart the (lib) script after it's been hidden - i.e. make it visible again
 script_data.show = nil -- only required for libs since the destroy_method only hides them
 
-local gettext = dt.gettext.gettext 
-gettext.bindtextdomain("clear_GPS", dt.configuration.config_dir .."/lua/locale/")
-
 -- not a number
 local NaN = 0/0
 
 du.check_min_api_version("7.0.0", "clear_GPS") 
 
-
-local function _(msgid)
-    return gettext(msgid)
-end
-
 local function clear_GPS(images)
   for _, image in ipairs(images) do
     -- set the location information to Not a Number (NaN) so it displays correctly

contrib/RL_out_sharp.lua

@@ -54,7 +54,7 @@ du.check_min_api_version("7.0.0", "color_profile_manager")
 
 local gettext = dt.gettext.gettext
 
-gettext.bindtextdomain("color_profile_manager", dt.configuration.config_dir .."/lua/locale/")
+dt.gettext.bindtextdomain("color_profile_manager", dt.configuration.config_dir .."/lua/locale/")
 
 local function _(msgid)
     return gettext(msgid)
@@ -363,6 +363,13 @@ end
 
 local script_data = {}
 
+script_data.metadata = {
+  name = "color_profile_manager",
+  purpose = _("manage external darktable color profiles"),
+  author = "Bill Ferguson <wpferguson@gmail.com>",
+  help = "https://docs.darktable.org/lua/stable/lua.scripts.manual/scripts/contrib/color_profile_manager"
+}
+
 script_data.destroy = destroy
 script_data.restart = restart
 script_data.destroy_method = "hide"