Convert services.txt to metadata YAML (WIP).

[mlt] / src / modules / core / filter_data_show.yml

diff --git a/src/modules/core/filter_data_show.yml b/src/modules/core/filter_data_show.yml
index b15678d39a5be0d47b369367b7d853a3961d1b6a..e289b3d84b6485998ffb42f9092b440125ef25d6 100644 (file)
--- a/src/modules/core/filter_data_show.yml
+++ b/src/modules/core/filter_data_show.yml
@@ -9,3 +9,50 @@ license: LGPLv2.1
 language: en
 tags:
   - Video
+description: Show data based on properties of the producer.
+notes: |
+  The data show filter uses data provided by the data feed filter.
+  The producer properties must supply: >
+    * The keyword text to be inserted in the form of: 
+    meta.attr.[keyword].markup=[text to insert]
+  
+    * The name of the properties to be used from the feed file in the form of: 
+    meta.attr.[name]=1
+  
+    * The text to be displayed in the form of: 
+    meta.attr.[name].markup=[some text #keyword#] 
+    (Keyword text is enclosed between #s.)
+  
+  e.g.
+  melt file.dv meta.attr.sometext.markup="this is some text" meta.attr.titles=1 meta.attr.titles.markup=#sometext# -filter data_show dynamic=1
+  >
+  Two special keywords exist
+  * #timecode# shows the frame position as a timecode.
+  * #frame# shows the frame position as an integer.
+  e.g.
+  melt file.dv meta.attr.timecode=1 meta.attr.timecode.markup=#timecode# -attach data_feed:attr_check -attach data_show:custom_file.properties dynamic=1
+  (where the file "custom_file" contains a filter definition by the name of "timecode")
+parameters:
+  - identifier: argument
+    title: Feed Properties File
+    type: string
+    required: no
+    readonly: no
+    default: data_fx.properties
+    widget: fileopen
+
+  - identifier: resource
+    title: Feed Properties File
+    type: string
+    required: no
+    readonly: yes
+    default: data_fx.properties
+    widget: fileopen
+
+  - identifier: dynamic
+    title: Dynamic
+    type: integer
+    default: 0
+    minimum: 0
+    maximum: 1
+    widget: checkbox