Project

General

Profile

[NAME] plug-in

Introduction

The [NAME] plug-in forms part of the YYYYYYYYYYYY plug-in group and is used to [make ZZZZZZZZZZ changes to a photograph]. It is generally used as part of the [Import/Lighttable/Darkroom/Export - delete as appropriate] process of darktable's workflow.

Screenshot of the plug-in - insert screenshot here [use a close-up, showing all parameters of the relevant plug-in, but no items from other plug-ins - to avoid confusion]

This page is correct for the following stable versions of darktable

  • 1.0 [?????]
  • darktable:version:0.93 [?????]

Reasons for use

The [NAME] plug-in is used to ... [manipulate/adjust/enhance/reduce/maximise/minimise/remove - delete as appropriate] the XXXXXXXXX aspect of your photos. [Expand further here to either give more detail on generic reasons for use, or to explain other reasons for use.]

What this plug-in actually does

This plug-in affects the [contrast/highlights/underexposed/overexposed] aspects of a photograph and .... [insert a '''''slightly technical''''' explanation of what the plug-in does - since this allows people to learn the underlying theory behind any manipulations and improve their knowledge over time. Please note - this is not the place for a full technical thesis, but more a very simple explanation of how the plug-in achieves its effect]

Parameters that can be changed

The following [parameters/settings] can be changed within this plug-in:

  • AAAAAAAA
  • BBBBBBBB
  • CCCCCCCC
  • DDDDDDDD

AAAAAAAA

This parameter is represented by a [slider/graphics box/whatever....] and can be found in the [right/left]-hand panel of the [import/Lighttable/Darkroom/export - delete as appropriate] view.
Settings range from [0 to 100] where 0 shows/changes .... and where 100 shows/changes...

BBBBBBBB

This parameter is represented by a [slider/graphics box/whatever....] and can be found in the [right/left]-hand panel of the [import/Lighttable/Darkroom/export - delete as appropriate] view.
Settings range from [0 to 100] where 0 shows/changes .... and where 100 shows/changes...

CCCCCCCC

This parameter is represented by a [slider/graphics box/whatever....] and can be found in the [right/left]-hand panel of the [import/Lighttable/Darkroom/export - delete as appropriate] view.
Settings range from [0 to 100] where 0 shows/changes .... and where 100 shows/changes...

DDDDDDDD

This parameter is represented by a [slider/graphics box/whatever....] and can be found in the [right/left]-hand panel of the [import/Lighttable/Darkroom/export - delete as appropriate] view.
Settings range from [0 to 100] where 0 shows/changes .... and where 100 shows/changes...

Generally recommended settings

Whilst users may choose any settings they wish to create the look that they desire, the following settings are generally recommended for this plug-in.

Parameter AAAAAAAA

Useful settings generally range from [25 to 75]. Lower values can lead to... and higher values will lead to....

Parameter BBBBBBBB

Useful settings generally range from [25 to 75]. Lower values can lead to... and higher values will lead to....

Parameter CCCCCCCC

Useful settings generally range from [25 to 75]. Lower values can lead to... and higher values will lead to....

Parameter DDDDDDDD

Useful settings generally range from [25 to 75]. Lower values can lead to... and higher values will lead to....

[Other general comments about the parameters and their use (either alone, or in combination with one another)]

Example usage

Example 1

The [NAME] plug-in allows you to [manipulate/adjust/enhance/reduce/maximise/minimise/remove - delete as appropriate] VVVVVVVVVV to ....

In this example, you can see how the [NAME] plug-in [manipulates/adjusts/enhances/reduces/maximises/minimises/removes] ZZZZZZZZ and allows ....

Before photo screenshot - insert screenshot here
[Explanation of the original photo and what is hoped to improve/change]

Parameters used/suggested screenshot - insert screenshot here
[Explanation of the parameters used, and why - focusing on the reasons for using the values that you did.]

After photo screenshot to show changes - insert screenshot here
[Explanation of the photo following plug-in improvements and what has improved/changed]

NB.[Important to ensure that the before and after screenshots show only the effect of this plug-in, not a combination of other unspecified plug-ins or a stack of other adjustments. This example should focus on just the changes and improvements that can be achieved through the use of this plug-in. DELETE THIS TEXT ONCE THE EXAMPLE IS CREATED]

Example 2

The [NAME] plug-in allows you to [manipulate/adjust/enhance/reduce/maximise/minimise/remove - delete as appropriate] VVVVVVVVVV to ....

In this example, you can see how the [NAME] plug-in [manipulates/adjusts/enhances/reduces/maximises/minimises/removes] ZZZZZZZZ and allows ....

Before photo screenshot - insert screenshot here
[Explanation of the original photo and what is hoped to improve/change]

Parameters used/suggested screenshot - insert screenshot here
[Explanation of the parameters used, and why - focusing on the reasons for using the values that you did.]

After photo screenshot to show changes - insert screenshot here
[Explanation of the photo following plug-in improvements and what has improved/changed]

NB.[Important to ensure that the before and after screenshots show only the effect of this plug-in, not a combination of other unspecified plug-ins or a stack of other adjustments. This example should focus on just the changes and improvements that can be achieved through the use of this plug-in. DELETE THIS TEXT ONCE THE EXAMPLE IS CREATED]

[Insert other examples as required]

Caveats

[Input any warnings about using this plug-in in conjunction with others that may negatively affect it, or where you should choose to use either this plug-in or another, but not both - or delete this line.]

[Input any details about how extreme settings may affect the photos - or delete this line.]

[None]

See also

The darktable book [link to static generic 'current version' page]

darktable's online manual [link to front page] - [PLUG-IN NAME - link to exact relevant page]

Relevant Blog entries concerning this plugin * [None currently available/Insert links here]

Online tutorials showing how to use this plug-in * [None currently available/Insert links here]

Online videos showing this plug-in in action * None currently available/Insert links here]

Source code

darktable:source:src/iop/clipping.c

Also available in: PDF HTML TXT