diff --git a/src/doc/converters/standard_converters.rst b/src/doc/converters/standard_converters.rst index 586b84b48be78f1307298a11ad61a2448c3c3cd7..b988172dc5a4e0efd77631013085d776cc2527f6 100644 --- a/src/doc/converters/standard_converters.rst +++ b/src/doc/converters/standard_converters.rst @@ -331,3 +331,30 @@ XMLTextNodeConverter In the future, this converter can be used to match XMLTextNodes that are generated by the XMLTagConverter. + + +ZipFileConverter +---------------- + +This converter opens zip files, unzips them into a temporary directory and +exposes its contents as File structure elements. + +Usage Example: +============== + +.. code-block:: yaml + + ExampleZipFile: + type: ZipFile + match: example\.zip$ + subtree: + DirInsideZip: + type: Directory + match: experiments$ + FileInsideZip: + type: File + match: description.odt$ + +This converter will match and open files called `example.zip`. +If the file contains a directory called `experiments` it will be processed further by the respective +converter in the subtree. The same is true for a file called `description.odt`.