This commit is contained in:
wpferguson 2020-12-22 05:33:45 +00:00
parent d306945103
commit 128be69078
9 changed files with 16 additions and 16 deletions

File diff suppressed because one or more lines are too long

View file

@ -271,7 +271,7 @@ script_name - string - the name of the script
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>https://darktable-org.github.io/luadocs/lua.api.manual/darktable/darktable.print/</guid> <guid>https://darktable-org.github.io/luadocs/lua.api.manual/darktable/darktable.print/</guid>
<description>function\( message : string \) Will print a string to the darktable control log (the long overlaid window that appears over the main panel). <description>function( message : string ) Will print a string to the darktable control log (the long overlaid window that appears over the main panel).
message - string - The string to display which should be a single line. </description> message - string - The string to display which should be a single line. </description>
</item> </item>
@ -748,7 +748,7 @@ This event registers a new keyboard shortcut. The shortcut isn&amp;rsquo;t bound
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>https://darktable-org.github.io/luadocs/lua.api.manual/darktable/darktable.register_storage/</guid> <guid>https://darktable-org.github.io/luadocs/lua.api.manual/darktable/darktable.register_storage/</guid>
<description>function( plugin_name : string, name : string, [store : function], [finalize : function], [supported : function], [initialize : function], [widget : types.lua_widget] ) This function will add a new storage implemented in Lua. A storage is a module that is responsible for handling images once they have been generated during export. Examples of core storages include filesystem, e-mail, facebook&amp;hellip; <description>function( plugin_name : string, name : string, [store : function], [finalize : function], [supported : function], [initialize : function], [widget : types.lua_widget] ) This function will add a new storage implemented in Lua. A storage is a module that is responsible for handling images once they have been generated during export. Examples of core storages include filesystem, e-mail, pwigo&amp;hellip;
plugin_name - string - A unique name for the plugin. name - string - A human readable name for the plugin.</description> plugin_name - string - A unique name for the plugin. name - string - A human readable name for the plugin.</description>
</item> </item>

View file

@ -2427,16 +2427,16 @@
<p>The name of the Operating system darktable is currently running on</p> <p>The name of the Operating system darktable is currently running on</p>
<h1 id="darktableconfigurationcheck_version"><a href="#darktableconfigurationcheck_version">🔗</a>darktable.configuration.check_version</h1> <h1 id="darktableconfigurationcheck_version"><a href="#darktableconfigurationcheck_version">🔗</a>darktable.configuration.check_version</h1>
<pre><code>function( <pre><code>function(
module_name : string, module_name : string,
... : table... ... : table...
) )
</code></pre><p>Check that a module is compatible with the running version of darktable </code></pre><p>Check that a module is compatible with the running version of darktable
Add the following line at the top of your module : Add the following line at the top of your module :
darktable.configuration.check(&hellip;,{M,m,p},{M2,m2,p2}) <code>darktable.configuration.check(...,{M,m,p},{M2,m2,p2})</code>
To document that your module has been tested with API version M.m.p and M2.m2.p2. To document that your module has been tested with API version M.m.p and M2.m2.p2.
This will raise an error if the user is running a released version of DT and a warning if he This will raise an error if the user is running a released version of DT and a warning if he
is running a development version is running a development version
(the &hellip; here will automatically expand to your module name if used at the top of your script</p> (the &hellip; here will automatically expand to your module name if used at the top of your script).</p>
<ul> <ul>
<li><strong>module_name</strong> - <em>string</em> - The name of the module to report on error</li> <li><strong>module_name</strong> - <em>string</em> - The name of the module to report on error</li>
<li><strong>&hellip;</strong> - <em>table</em> - Tables of API versions that are known to work with the script</li> <li><strong>&hellip;</strong> - <em>table</em> - Tables of API versions that are known to work with the script</li>

View file

@ -2400,7 +2400,7 @@ Use this variable to detect when you should finish long running jobs</p>
) )
</code></pre><p>Runs a function in the background. This function will be run at a later point, after luarc has </code></pre><p>Runs a function in the background. This function will be run at a later point, after luarc has
finished running. If you do a loop in such a function, please check darktable.control.ending finished running. If you do a loop in such a function, please check darktable.control.ending
in your loop to finish the function when DT exits</p> in your loop to finish the function when darktable exits</p>
<ul> <ul>
<li><strong>function</strong> - <em>function</em> - The call to dispatch</li> <li><strong>function</strong> - <em>function</em> - The call to dispatch</li>
<li><strong>&hellip;</strong> - <em>anything</em> - extra parameters to pass to the function</li> <li><strong>&hellip;</strong> - <em>anything</em> - extra parameters to pass to the function</li>

View file

@ -2411,7 +2411,7 @@ ipairs.</p>
<ul> <ul>
<li><strong>location</strong> - <em>string</em> - The filename or directory to import images from. NOTE: If the images are set to be <li><strong>location</strong> - <em>string</em> - The filename or directory to import images from. NOTE: If the images are set to be
imported recursively in preferences only the toplevel film is returned (the one whose imported recursively in preferences only the toplevel film is returned (the one whose
path was given as a parameter). NOTE2: If the parameter is a directory the call is nonblocking; the film object will not have the newly imported images yet. Use a postimport-film filtering on that film to react when images are actually imported.</li> path was given as a parameter). NOTE 2: If the parameter is a directory the call is nonblocking; the film object will not have the newly imported images yet. Use a <a href="..//../events/post-imort-film">post-import-film</a> filtering on that film to react when images are actually imported.</li>
<li><strong>return</strong> - <em><a href="../../types/dt_lua_image_t">types.dt_lua_image_t</a></em> - The created image if an image is imported or the toplevel film object if a film was <li><strong>return</strong> - <em><a href="../../types/dt_lua_image_t">types.dt_lua_image_t</a></em> - The created image if an image is imported or the toplevel film object if a film was
imported.</li> imported.</li>
</ul> </ul>

View file

@ -2554,8 +2554,8 @@ panels.</p>
<p>The lighttable view</p> <p>The lighttable view</p>
<p>Attributes:</p> <p>Attributes:</p>
<ul> <ul>
<li><a href="/luadocs/lua.api.manual/attributes/#has_tostring">has_tostring</a></li> <li><a href="../../Attributes#has_tostring">has_tostring</a></li>
<li><a href="/luadocs/lua.api.manual/attributes/#parent">parent</a> : <a href="../../types/dt_lua_view_t">types.dt_lua_view_t</a></li> <li><a href="../../Attributes#parent">parent</a> : <a href="../../types/dt_lua_view_t">types.dt_lua_view_t</a></li>
</ul> </ul>
<h3 id="darktableguiviewslighttableis_image_visible"><a href="#darktableguiviewslighttableis_image_visible">🔗</a>darktable.gui.views.lighttable.is_image_visible</h3> <h3 id="darktableguiviewslighttableis_image_visible"><a href="#darktableguiviewslighttableis_image_visible">🔗</a>darktable.gui.views.lighttable.is_image_visible</h3>
<pre><code>function( <pre><code>function(

View file

@ -2387,9 +2387,9 @@
darktable.print darktable.print
</h1> </h1>
<pre><code>function\( <pre><code>function(
message : string message : string
\) )
</code></pre><p>Will print a string to the darktable control log (the long overlaid window that appears over </code></pre><p>Will print a string to the darktable control log (the long overlaid window that appears over
the main panel).</p> the main panel).</p>
<ul> <ul>

View file

@ -2397,7 +2397,7 @@
[widget : types.lua_widget] [widget : types.lua_widget]
) )
</code></pre><p>This function will add a new storage implemented in Lua. </code></pre><p>This function will add a new storage implemented in Lua.
A storage is a module that is responsible for handling images once they have been generated during export. Examples of core storages include filesystem, e-mail, facebook&hellip;</p> A storage is a module that is responsible for handling images once they have been generated during export. Examples of core storages include filesystem, e-mail, pwigo&hellip;</p>
<ul> <ul>
<li><strong>plugin_name</strong> - <em>string</em> - A unique name for the plugin.</li> <li><strong>plugin_name</strong> - <em>string</em> - A unique name for the plugin.</li>
<li><strong>name</strong> - <em>string</em> - A human readable name for the plugin.</li> <li><strong>name</strong> - <em>string</em> - A human readable name for the plugin.</li>

View file

@ -23,7 +23,7 @@ All functions and data are accessed through the darktable module.</description>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>https://darktable-org.github.io/luadocs/lua.api.manual/darktable/darktable.print/</guid> <guid>https://darktable-org.github.io/luadocs/lua.api.manual/darktable/darktable.print/</guid>
<description>function\( message : string \) Will print a string to the darktable control log (the long overlaid window that appears over the main panel). <description>function( message : string ) Will print a string to the darktable control log (the long overlaid window that appears over the main panel).
message - string - The string to display which should be a single line. </description> message - string - The string to display which should be a single line. </description>
</item> </item>
@ -63,7 +63,7 @@ All functions and data are accessed through the darktable module.</description>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>https://darktable-org.github.io/luadocs/lua.api.manual/darktable/darktable.register_storage/</guid> <guid>https://darktable-org.github.io/luadocs/lua.api.manual/darktable/darktable.register_storage/</guid>
<description>function( plugin_name : string, name : string, [store : function], [finalize : function], [supported : function], [initialize : function], [widget : types.lua_widget] ) This function will add a new storage implemented in Lua. A storage is a module that is responsible for handling images once they have been generated during export. Examples of core storages include filesystem, e-mail, facebook&amp;hellip; <description>function( plugin_name : string, name : string, [store : function], [finalize : function], [supported : function], [initialize : function], [widget : types.lua_widget] ) This function will add a new storage implemented in Lua. A storage is a module that is responsible for handling images once they have been generated during export. Examples of core storages include filesystem, e-mail, pwigo&amp;hellip;
plugin_name - string - A unique name for the plugin. name - string - A human readable name for the plugin.</description> plugin_name - string - A unique name for the plugin. name - string - A human readable name for the plugin.</description>
</item> </item>