Convert services.txt to metadata YAML (WIP).

[mlt] / src / modules / xml / producer_xml.yml

diff --git a/src/modules/xml/producer_xml.yml b/src/modules/xml/producer_xml.yml
index ab824d00fb06475be6e1e7700dd8da29d885383b..1aaebdfb4d8e7b740a2687b17a67137febb3d8b6 100644 (file)
--- a/src/modules/xml/producer_xml.yml
+++ b/src/modules/xml/producer_xml.yml
@@ -10,3 +10,30 @@ language: en
 tags:
   - Audio
   - Video
+description: |
+  Construct a service network from an XML description. See docs/mlt-xml.txt.
+parameters:
+  - identifier: argument
+    title: URL
+    type: string
+    description: |
+      An XML text file containing MLT XML
+      Since MLT XML files can be parameterised, the URL syntax is:
+      {file-name}[?{param-name}{'='|':'}{param-value}[&{param-name}{'='|':'}{param-value}...]]
+      A colon is allowed instead of an equal sign to pacify melt, who tokenises 
+      anything with an equal sign as a property setting. Also, when running 
+      melt from the shell, beware of the '?' and shell filename expansion. You 
+      can surround the URL with single quotations to prevent expansion. 
+      Finally, the loader will fail to match the filename when you use 
+      parameters, so preface the url with 'xml:' to force the loader to load 
+      with the xml service.
+    readonly: no
+    required: yes
+    mutable: no
+    widget: fileopen
+    
+  - identifier: resource
+    title: Resource
+    type: string
+    description: File location. See "argument" above.
+    readonly: yes