scripts manual - added documentation for examples/x-touch.lua

API versions

content/lua.api.manual/types/dt_lua_image_t.md

@@ -442,14 +442,14 @@ darktable will regenerate the thumbnail by itself when it is needed.
 ```
 self.function(
   check_dirs : boolean 
-  min_size : integer
+  start_size : integer
-  max_size : integer
+  end_size : integer
 )
 ```
 * **self** - _[types.dt_lua_image_t](../types/dt_lua_image_t)_ - The image whose cache is to be generated.
 * **check_dirs** - _boolean_ - check if the mipmap cache directories exist.  Create them if necessary.
-* **min_size** - _integer_ - minimum mipmap size to generate
+* **start_size** - _integer_ - mipmap size to generate first
-* **max_size** - _integer_ - maximum mipmap size to generate
+* **end_size** - _integer_ - mipmap size to generate last
 
 **NOTES:**
 * mipmap cache image sizes
@@ -464,5 +464,6 @@ self.function(
   - 8 - full resolution
 
 * To generate a single size mipmap image set start_size and end_size to the same value
-* When different min_size and max_size sizes are specified, every size mipmap from min_size to max_size is generated.
+* When generating multiple sizes put the largest size as the start size and the smallest as the end.
+* When different start and end sizes are specified, every size mipmap from start to end is generated.
 * When looping over a set of images and generating just one size, check for directories on the first image only.

content/lua.api.manual/version.md

@@ -8,5 +8,17 @@ author: "people"
 
 # Current API
 
-The Lua API version used in darktable 3.8.0 is 8.0.0.
+The Lua API version used in darktable 4.4.0 is 9.1.0.
+
+Previous API versions were
+
+- darktable 4.2.x  -  Lua API 9.0.0
+- darktable 3.8.x  -  Lua API 8.0.0
+- darktable 3.6.x  -  Lua API 7.0.0
+- darktable 3.2.x  -  Lua API 6.0.0
+- darktable 2.4.x  -  Lua API 5.0.0
+- darktable 2.2.x  -  Lua API 4.0.0
+- darktable 2.0.x  -  Lua API 3.0.0
+- darktable 1.6.1  -  Lua API 2.0.2
+- darktable 1.6.0  -  Lua API 2.0.1
 

content/lua.scripts.manual/installation.md

@@ -60,9 +60,9 @@ The recommended way to enable and disable specific scripts is using the script m
 
     echo 'require "tools/script_manager"' > ~/.config/darktable/luarc
 
-### Windows ( via command prompt )
+### Windows
 
-    echo require 'tools/script_manager' > %LOCALAPPDATA%\darktable\luarc
+    echo "require 'tools/script_manager'" > %LOCALAPPDATA%\darktable\luarc
 
 ### Snap
 

content/lua.scripts.manual/scripts/contrib/rename_images.md

@@ -1,37 +0,0 @@
----
-title: rename_images
-id: rename_images
-weight: 275
-draft: false
-author: "people"
----
-
-## Name
-
-rename_images.lua - rename one or more image files
-
-## Description
-
-Rename an image or images according to a pattern built by
-the user.  It is possible to specify a different directory
-in the rename pattern, which will result in a move as well as
-a rename.  The database will be updated to reflect the new
-name/location of the image.
-
-## Usage
-
-* require this script from your luarc file or start it from script_manager
-* select an image or images
-* enter a renaming pattern
-* click the button to rename the files
-
-## Additional Software Required
-
-
-## Limitations
-
-
-## Author
-
-  Bill Ferguson - wpferguson@gmail.com
-

content/lua.scripts.manual/scripts/examples/x-touch.md

@@ -0,0 +1,59 @@
+---
+title: x-touch
+id: x-touch
+weight: 120
+draft: false
+author: "people"
+---
+
+## Name
+
+x-touch.lua - use an X-Touch Mini controller with darktable
+
+## Description
+
+This script will create virtual sliders that are mapped dynamically to
+the most relevant sliders for the currently focused processing module.
+Tailored modules are color zones, tone equalizer, color calibration and
+mask manager properties. The script can easily be amended for other
+devices or personal preferences. Virtual "toggle" buttons can be created
+as well, that dynamically change meaning depending on current status.
+
+## Usage
+
+* require this script from your luarc file or start it from script_manager
+* restart darktable if using the luarc file
+* create shortcuts for each of the encoders on the x-touch mini
+  to a virtual slider under lua/x-touch
+  or import the following shortcutsrc file in the shortcuts dialog/preferences tab:
+
+```
+None;midi:CC1=lua/x-touch/knob 1
+None;midi:CC2=lua/x-touch/knob 2
+None;midi:CC3=lua/x-touch/knob 3
+None;midi:CC4=lua/x-touch/knob 4
+None;midi:CC5=lua/x-touch/knob 5
+None;midi:CC6=lua/x-touch/knob 6
+None;midi:CC7=lua/x-touch/knob 7
+None;midi:CC8=lua/x-touch/knob 8
+midi:E0=global/modifiers
+midi:F0=global/modifiers;ctrl
+midi:F#0=global/modifiers;alt
+midi:G#-1=iop/blend/tools/show and edit mask elements
+midi:A-1=iop/colorzones;focus
+midi:A#-1=iop/toneequal;focus
+midi:B-1=iop/colorbalancergb;focus
+midi:C0=iop/channelmixerrgb;focus
+```
+
+## Additional Software Required
+
+
+## Limitations
+
+
+## Author
+
+Diederik ter Rahe
+
+## Change Log

content/lua.scripts.manual/scripts/tools/script_manager.md

@@ -51,7 +51,7 @@ and _tools_ containing tools for managing the lua scripts.
 
 ## Additional Software Required
 
-git - [git-scm.com](https://git-scm.com/) - git is used to install and update the scripts.  script_manager will still run if git is not installed or accessible, but installing and updating scripts will not be possible.
+git - wwww.git.org - git is used to install and update the scripts.  script_manager will still run if git is not installed or accessible, but installing and updating scripts will not be possible.
 
 
 ## Limitations

content/lua.scripts.manual/troubleshooting.md

@@ -22,4 +22,4 @@ Open a terminal and start darktable with the command `/Applications/darktable.ap
 
 ### Windows
 
-Open a command prompt. Start darktable with the command `"C:\Program Files\darktable\bin\darktable" -d lua > log.txt 2>&1`. This provides debugging information to give you insight into what is happening.
+Open a command prompt. Start darktable with the command "C:\Program Files\darktable\bin\darktable" -d lua > log.txt. This provides debugging information to give you insight into what is happening.