letex:unzip (in library ltx-lib.xpl)
Will extract a complete zip file or a single contained file to a specified destination folder.
Visualisation
The pre-creation of this SVG image needs the Graphviz software installed. Please inform your project maintainer.
Input Ports
none
Output Ports
| Name | Documentation | Connections |
|---|---|---|
resultⓅ | A c:files document with the extracted files, as c:file elements (no hierarchy). There is an
@xml:base attribute on /c:files that contains the $dest-dir location URL. A c:file element will contain a @name
attribute with the corresponding file’s relative location. | A c:files document with the extracted files, as c:file elements (no hierarchy). There is an @xml:base attribute on /c:files that contains the $dest-dir location URL. A c:file element will contain a @name attribute with the corresponding file’s relative location. |
Options
| Name | Documentation | Default |
|---|---|---|
zipⓇ | The operating system’s file path (not a URL) to the zip file. On Windows, backward slashes should work, but it’s safer to use forward slashes for path separators. Not sure whether spaces are ok though. There also may be encoding issues related to OS specific encodings of file names that are not UTF-8 compliant. | |
dest-dirⓇ | An OS file system path, not a URL. Will be created if it does not exist (subject to the $overwrite option). | |
overwrite | Whether existing directories and files will be overwritten. The step will fail if set to 'no' and there is an existing file/dir with the target name. | 'no' |
file | Optionally, a specific relative path to a file within the zip file. Will be restored to its relative path below $dest-dir. |
Subpipeline
none