porting clean up
This commit is contained in:
parent
f376660f22
commit
9b3dc9e465
9 changed files with 23 additions and 23 deletions
|
@ -7,7 +7,7 @@ author: "people"
|
||||||
---
|
---
|
||||||
|
|
||||||
Allows to access the currently worked on images, i.e the ones selected by the collection
|
Allows to access the currently worked on images, i.e the ones selected by the collection
|
||||||
lib. Filtering (rating etc) does not change that collection.
|
lib. Filtering \(rating etc\) does not change that collection.
|
||||||
|
|
||||||
# darktable.collection.#
|
# darktable.collection.#
|
||||||
|
|
||||||
|
|
|
@ -20,7 +20,7 @@ The version number of darktable.
|
||||||
|
|
||||||
`boolean`
|
`boolean`
|
||||||
|
|
||||||
True if darktable has a GUI (launched through the main darktable command, not darktable-cli).
|
True if darktable has a GUI \(launched through the main darktable command, not darktable-cli\).
|
||||||
|
|
||||||
# darktable.configuration.verbose
|
# darktable.configuration.verbose
|
||||||
|
|
||||||
|
@ -38,7 +38,7 @@ The name of the directory where darktable will store temporary files.
|
||||||
|
|
||||||
`string`
|
`string`
|
||||||
|
|
||||||
The name of the directory where darktable will find its global configuration objects (modules).
|
The name of the directory where darktable will find its global configuration objects \(modules\).
|
||||||
|
|
||||||
# darktable.configuration.cache_dir
|
# darktable.configuration.cache_dir
|
||||||
|
|
||||||
|
@ -87,18 +87,18 @@ The name of the Operating system darktable is currently running on
|
||||||
|
|
||||||
```
|
```
|
||||||
function(
|
function(
|
||||||
module_name : string,
|
module_name : string,
|
||||||
... : table...
|
... : table...
|
||||||
)
|
)
|
||||||
```
|
```
|
||||||
|
|
||||||
Check that a module is compatible with the running version of darktable
|
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(...,{M,m,p},{M2,m2,p2})
|
`darktable.configuration.check(...,{M,m,p},{M2,m2,p2})`
|
||||||
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 ... here will automatically expand to your module name if used at the top of your script
|
\(the ... here will automatically expand to your module name if used at the top of your script\).
|
||||||
|
|
||||||
* **module_name** - _string_ - The name of the module to report on error
|
* **module_name** - _string_ - The name of the module to report on error
|
||||||
* **...** - _table_ - Tables of API versions that are known to work with the script
|
* **...** - _table_ - Tables of API versions that are known to work with the script
|
||||||
|
|
|
@ -27,7 +27,7 @@ function(
|
||||||
|
|
||||||
Runs a function in the background. This function will be run at a later point, after luarc has
|
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
|
in your loop to finish the function when darktable exits
|
||||||
|
|
||||||
* **function** - _function_ - The call to dispatch
|
* **function** - _function_ - The call to dispatch
|
||||||
* **...** - _anything_ - extra parameters to pass to the function
|
* **...** - _anything_ - extra parameters to pass to the function
|
||||||
|
|
|
@ -6,8 +6,8 @@ draft: false
|
||||||
author: "people"
|
author: "people"
|
||||||
---
|
---
|
||||||
|
|
||||||
Allows access to the database of images. Note that duplicate images (images with the
|
Allows access to the database of images. Note that duplicate images \(images with the
|
||||||
same RAW but different XMP) will appear multiple times with different duplicate indexes.
|
same RAW but different XMP\) will appear multiple times with different duplicate indexes.
|
||||||
Also note that all images are here. This table is not influenced by any GUI filtering \(collections, stars etc...\).
|
Also note that all images are here. This table is not influenced by any GUI filtering \(collections, stars etc...\).
|
||||||
|
|
||||||
# darktable.database.#
|
# darktable.database.#
|
||||||
|
@ -42,7 +42,7 @@ Imports new images into the database.
|
||||||
|
|
||||||
* **location** - _string_ - The filename or directory to import images from. NOTE: If the images are set to be
|
* **location** - _string_ - 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.
|
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 [post-import-film](..//../events/post-imort-film) filtering on that film to react when images are actually imported.
|
||||||
* **return** - _[types.dt_lua_image_t](../../types/dt_lua_image_t)_ - The created image if an image is imported or the toplevel film object if a film was
|
* **return** - _[types.dt_lua_image_t](../../types/dt_lua_image_t)_ - The created image if an image is imported or the toplevel film object if a film was
|
||||||
imported.
|
imported.
|
||||||
|
|
||||||
|
@ -56,7 +56,7 @@ function(
|
||||||
)
|
)
|
||||||
```
|
```
|
||||||
|
|
||||||
Physically moves an image (and all its duplicates) to another film, and/or renames the image file.
|
Physically moves an image \(and all its duplicates\) to another film, and/or renames the image file.
|
||||||
This will move the image file, the related XMP and all XMP for the duplicates to the directory of the new film and rename them as specified.
|
This will move the image file, the related XMP and all XMP for the duplicates to the directory of the new film and rename them as specified.
|
||||||
Note that the order of the two required parameters is not relevant.
|
Note that the order of the two required parameters is not relevant.
|
||||||
|
|
||||||
|
|
|
@ -56,7 +56,7 @@ function(
|
||||||
) : string
|
) : string
|
||||||
```
|
```
|
||||||
|
|
||||||
Similar to the system function type() but it will return the real type instead of _userdata_
|
Similar to the system function type\(\) but it will return the real type instead of _userdata_
|
||||||
for darktable specific objects.
|
for darktable specific objects.
|
||||||
|
|
||||||
* **object** - _anything_ - The object whose type must be reported.
|
* **object** - _anything_ - The object whose type must be reported.
|
||||||
|
|
|
@ -8,8 +8,8 @@ author: "people"
|
||||||
|
|
||||||
This subtable contains function and data to manipulate the darktable user interface with
|
This subtable contains function and data to manipulate the darktable user interface with
|
||||||
Lua.
|
Lua.
|
||||||
Most of these function won't do anything if the GUI is not enabled (i.e you are using the
|
Most of these function won't do anything if the GUI is not enabled \(i.e you are using the
|
||||||
command line version darktable-cli instead of darktable).
|
command line version darktable-cli instead of darktable\).
|
||||||
|
|
||||||
# darktable.gui.action_images
|
# darktable.gui.action_images
|
||||||
|
|
||||||
|
@ -223,8 +223,8 @@ Display an image in darkroom view.
|
||||||
The lighttable view
|
The lighttable view
|
||||||
|
|
||||||
Attributes:
|
Attributes:
|
||||||
* [has_tostring](../Attributes#has_tostring)
|
* [has_tostring](../../Attributes#has_tostring)
|
||||||
* [parent](../Attributes#parent) : [types.dt_lua_view_t](../../types/dt_lua_view_t)
|
* [parent](../../Attributes#parent) : [types.dt_lua_view_t](../../types/dt_lua_view_t)
|
||||||
|
|
||||||
### darktable.gui.views.lighttable.is_image_visible
|
### darktable.gui.views.lighttable.is_image_visible
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@ author: "people"
|
||||||
Lua allows you to manipulate preferences. Lua has its own namespace for preferences and
|
Lua allows you to manipulate preferences. Lua has its own namespace for preferences and
|
||||||
you can't access nor write normal darktable preferences.
|
you can't access nor write normal darktable preferences.
|
||||||
Preference handling functions take a _script_ parameter. This is a string used to avoid
|
Preference handling functions take a _script_ parameter. This is a string used to avoid
|
||||||
name collision in preferences (i.e namespace). Set it to something unique, usually the
|
name collision in preferences \(i.e namespace\). Set it to something unique, usually the
|
||||||
name of the script handling the preference.
|
name of the script handling the preference.
|
||||||
Preference handling functions can't guess the type of a parameter. You must pass the type
|
Preference handling functions can't guess the type of a parameter. You must pass the type
|
||||||
of the preference you are handling.
|
of the preference you are handling.
|
||||||
|
@ -38,8 +38,8 @@ function(
|
||||||
```
|
```
|
||||||
|
|
||||||
Creates a new preference entry in the Lua tab of the preference screen. If this function
|
Creates a new preference entry in the Lua tab of the preference screen. If this function
|
||||||
is not called the preference can't be set by the user (you can still read and write invisible
|
is not called the preference can't be set by the user \(you can still read and write invisible
|
||||||
preferences).
|
preferences\).
|
||||||
|
|
||||||
* **script** - _string_ - Invisible prefix to guarantee unicity of preferences.
|
* **script** - _string_ - Invisible prefix to guarantee unicity of preferences.
|
||||||
* **name** - _string_ - A unique name used with the script part to identify the preference.
|
* **name** - _string_ - A unique name used with the script part to identify the preference.
|
||||||
|
|
|
@ -7,9 +7,9 @@ author: "people"
|
||||||
---
|
---
|
||||||
|
|
||||||
```
|
```
|
||||||
function\(
|
function(
|
||||||
message : string
|
message : string
|
||||||
\)
|
)
|
||||||
```
|
```
|
||||||
|
|
||||||
Will print a string to the darktable control log (the long overlaid window that appears over
|
Will print a string to the darktable control log (the long overlaid window that appears over
|
||||||
|
|
|
@ -19,7 +19,7 @@ function(
|
||||||
```
|
```
|
||||||
|
|
||||||
This function will add a new storage implemented in Lua.
|
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...
|
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...
|
||||||
|
|
||||||
* **plugin_name** - _string_ - A unique name for the plugin.
|
* **plugin_name** - _string_ - A unique name for the plugin.
|
||||||
* **name** - _string_ - A human readable name for the plugin.
|
* **name** - _string_ - A human readable name for the plugin.
|
||||||
|
|
Loading…
Reference in a new issue