Skip to content
Snippets Groups Projects
Commit e72336a7 authored by Alexander Schlemmer's avatar Alexander Schlemmer
Browse files

DOC(converters): doc for zipfile converter

parent b9371064
No related branches found
No related tags found
2 merge requests!217TST: Make NamedTemporaryFiles Windows-compatible,!200Zipfile converter
......@@ -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`.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment