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

API versions

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/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