From e72336a7476ee4a7cec858f04d675e1d57734aa4 Mon Sep 17 00:00:00 2001
From: Alexander Schlemmer <a.schlemmer@indiscale.com>
Date: Fri, 15 Nov 2024 11:51:59 +0100
Subject: [PATCH] DOC(converters): doc for zipfile converter

---
 src/doc/converters/standard_converters.rst | 27 ++++++++++++++++++++++
 1 file changed, 27 insertions(+)

diff --git a/src/doc/converters/standard_converters.rst b/src/doc/converters/standard_converters.rst
index 586b84b4..b988172d 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`.
-- 
GitLab