Fix indent

[kdenlive] / effects / README

diff --git a/effects/README b/effects/README
index b36ba564787bc8586c5464c91608048a375e059d..7cc34eb76d72f009dc6c06afec232c32b64ee00b 100644 (file)
--- a/effects/README
+++ b/effects/README
@@ -5,7 +5,7 @@
 ==========
 Kdenlive uses MLT for all video/audio effects/filters.
 For filters that provide metadata the GUI can be generated automatically.
-If the generated GUI is not sufficient a cusom one can be build using a XML
+If the generated GUI is not sufficient a custom one can be build using a XML
 file describing the effect and its parameters.
 ==========
 
@@ -29,7 +29,7 @@ The basic structure of a XML filter description:
 --------------------------------------------------------------------------------------
 
 Line 1:
-    - required to make strings in the effect translatable
+    - required to make strings used in the effect translatable
 Line 2:
     - tag: MLT ("mlt_service") name of the effect
     - id: internal kdenlive id, can be anything, but must be unique for each effect
@@ -41,14 +41,15 @@ Line 3:
 Line 4:
     - Short description of the effect to be shown in the effect list
     - Additionally a <full> part can be added inside. It's content will be available in the effect stack (see frei0r_lightgraffiti.xml for an example):
-        - supports HTML formatting (requires the of CDATA)
+        - supports HTML formatting (requires the use of CDATA)
 Line 5:
     - name of the author(s) of the filter (not of the XML file ;))
 The rest:
     - list of effect parameters:
         - tag "name": visible name of the parameter (depending on the GUI this parameter uses)
-        - tag "comment": (optional) description of the parameter (support HTML formatting) (not yet support by all widgets)
+        - tag "comment": (optional) description of the parameter (support HTML formatting) (not yet supported by all widgets)
         - attribute "name": MLT filter parameter name
+        - attribute "paramprefix": a string to be prepended to the parameter value before passing it to MLT
         - attribute "default": initial value, format depends on parameter type
         - attribute "type": widget (GUI) to use
             - "fixed":
@@ -57,7 +58,8 @@ The rest:
                 - number
                 - represented by a slider
                 - additional parameter attributes:
-                    - "factor": (optional) values coming from MLT will be multiplied with factor, values from the GUI divided by factor
+                    - "factor": (optional) values coming from MLT will be multiplied with factor
+                    - "offset": (optional) will be added to values coming from MLT after "factor" is applied
                     - "min": smallest value possible (after multiplying with "factor")
                     - "max": largest value possible (after multiplying with "factor")
                     - "suffix": (optional) displayed unit of the values
@@ -70,21 +72,23 @@ The rest:
                 - multiple choice
                 - represented by a drop-down menu
                 - additional parameter attribute:
-                    - "paramlist": list of possible values separated by comma (no whitespaces!)
+                    - "paramlist": list of possible values separated by semicolon (no whitespaces!)
                 - addtional tag:
-                    - "paramlistdisplay": (optional) list of names to use for the values
+                    - "paramlistdisplay": (optional) list of names to use for the values separated by comma
             - "position":
                 - time stored as frame number
                 - represented by a slider
             - "color":
-                - color value in similar to HTML ("#rrggbb" or "0xrrggbb")
+                - color value, similar to representation HTML ("#rrggbb"/"#aarrggbb" or "0xrrggbbaa")
                 - represented by a button opening the KDE color dialog + a color picker button
+                - additional attributes:
+                    - "alpha": (default = "0") use to enable alpha support
             - "keyframe":
                 - keyframable number
                 - keyframes are opt-in (only one keyframe by default -> should be prefered over "constant" whenever possible)
                 - works with MLT filters that utilize start/end values
                 - same attributes as "constant"
-                - additional attribute:
+                - additional attributes:
                     - "intimeline": (default = "0") parameter to preselect for editing in the timeline (only one parameter can have "1")
                     - "widget": (optional) GUI based on the standard keyframe GUI (possible values: "corners")
             - "simplekeyframe":
@@ -111,6 +115,13 @@ The rest:
                 - cubic Bézier spline editor for the frei0r color curves filter (new version, might be reused for other filters)
             - "roto-spline":
                 - GUI for the rotoscoping filter (spline on the monitor)
+            - "keywords":
+                - Text entry with a selection of possible keywords to be inserted in the text.
+                - additional tags:
+                    - "keywords": list of possible keyword values separated by semicolon
+                    - "keywordsdisplay": list of names to use for the values separated by semicolon
+            - "fontfamily":
+                - Font typeface entry
 ==========
 
 ==========
@@ -118,7 +129,11 @@ Effects can be blacklisted in kdenlive/data/blacklisted_effects.txt
 All effects with a custom XML GUI need to be blacklisted.
 ==========
 
+==========
+Effects can be assigned to an effect category in kdenlive/data/kdenliveeffectscategory.rc.
+==========
+
 ==========
 Kdenlive parses the effect folder at each startup, so that if you have an XML file describing a new effect,
-just copy it in your ~/.kde/share/apps/kdenlive/effects/ folder and restart Kdenlive to enable the new effect.
+just copy it to your ~/.kde/share/apps/kdenlive/effects/ folder and restart Kdenlive to enable the new effect.
 ==========