Add xml_retain property support to xml module.

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

diff --git a/src/modules/xml/producer_xml.yml b/src/modules/xml/producer_xml.yml
index 1aaebdfb4d8e7b740a2687b17a67137febb3d8b6..0df379acb19904263923eb47b9ab1a73065c1589 100644 (file)
--- a/src/modules/xml/producer_xml.yml
+++ b/src/modules/xml/producer_xml.yml
@@ -12,28 +12,22 @@ tags:
   - Video
 description: |
   Construct a service network from an XML description. See docs/mlt-xml.txt.
+
+notes: >
+  If there is a service with a property "xml_retain=1" that is not the
+  producer, and if it also has an "id" property; then the extra service
+  is put into a properties list keyed on the id property. Then, that
+  properties list is placed as a property on the returned service with
+  the name "xml_retain". This lets an application retrieve additional
+  deserialized services that are not the lastmost producer or anywhere in
+  its graph.
+
 parameters:
   - identifier: argument
-    title: URL
+    title: File
     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.
+    description: An XML text file containing MLT XML.
     readonly: no
     required: yes
     mutable: no
     widget: fileopen
-    
-  - identifier: resource
-    title: Resource
-    type: string
-    description: File location. See "argument" above.
-    readonly: yes