This is an old revision of the document!
Name of logic (i.e. Append)
THIS position should be used for a brief introduction (max 2 sentences!) of the logic, stating WHAT and WHY it is doing something.
Usage
Here, a general/generic description of HOW the logic is USED should be given. Try to be as general as possible, but also mention prerequisites, restrictions, advantages, requirements which are specific of this logic. Basically everything the user needs to know to successfully use this logic.
Example
Here, a very specific example should be given/described. In the future, this can be supported by screenshots etc.. For the moment, give an example easy enough for the user to understand, but specific enough to elaborate why a given parameter is a good set for this very situation.
Modes (only if n > 1 modes)
ModeBBBB
Here, a short introduction for the given mode should be placed. Again, state WHAT and WHY this mode us useful in not more than 2 sentences.
#Parameters
* make a list of parameters * or make a table
#Inputs
* make a list of existing inputs for this mode * or make a table
#Outputs
* make a list of existing outputs for this mode * or make a table
#New/Changed Header Values
* which header values have changed * which header values are new
ModeBBBB
Here, a short introduction for the given mode should be placed. Again, state WHAT and WHY this mode us useful in not more than 2 sentences.
#Parameters
* make a list of parameters * or make a table
#Inputs
* make a list of existing inputs for this mode * or make a table
#Outputs
* make a list of existing outputs for this mode * or make a table
#New/Changed Header Values
* which header values have changed * which header values are new
Concept
In this paragraph, the “HOW a logic works under the hood” and WHY someone should use it can be elaborated with higher detail
Describes a scenario in an image processing workflow where this logic can be used to solve the resulting problem. Also, wikipages, publications or anything else describing the theory behind an algorithm should be linked here, if applicable.