Creates a .zip archive of all input documents. The use-short-names option will store documents under their short (canonical) filenames.
zip
.*
.zip
Setting | Description | Default |
---|---|---|
add-new-files | Boolean or list of extensions/patterns to match. | False |
added-in-version | Dexy version when this filter was first available. | |
additional-doc-filters | Filters to apply to additional documents created as side effects. | {} |
additional-doc-settings | Settings to apply to additional documents created as side effects. | {} |
data-type | Alias of custom data class to use to store filter output. | generic |
examples | Templates which should be used as examples for this filter. | [] |
exclude-add-new-files | List of patterns to skip even if they match add-new-files. | [] |
exclude-new-files-from-dir | List of directories to skip when adding new files. | [] |
ext | File extension to output. | None |
extension-map | Dictionary mapping input extensions to default output extensions. | None |
help | Helpstring for plugin. | Creates a .zip archive of all input documents. The use-short-names option will store documents under their short (canonical) filenames. |
input-extensions | List of extensions which this filter can accept as input. | ['.*'] |
keep-originals | Whether, if additional-doc-filters are specified, the original unmodified docs should also be added. | False |
mkdir | A directory which should be created in working dir. | None |
mkdirs | A list of directories which should be created in working dir. | [] |
nodoc | Whether filter should be excluded from documentation. | False |
output | Whether to output results of this filter by default by reporters such as 'output' or 'website'. | True |
output-extensions | List of extensions which this filter can produce as output. | ['.zip'] |
override-workspace-exclude-filters | If True, document will be populated to other workspaces ignoring workspace-exclude-filters. | False |
preserve-prior-data-class | Whether output data class should be set to match the input data class. | False |
require-output | Should dexy raise an exception if no output is produced by this filter? | True |
tags | Tags which describe the filter. | [] |
use-short-names | Whether to use short, potentially non-unique names within the archive. | False |
variables | A dictionary of variable names and values to make available to this filter. | {} |
vars | A dictionary of variable names and values to make available to this filter. | {} |
workspace-exclude-filters | Filters whose output should be excluded from workspace. | ['pyg'] |
workspace-includes | If set to a list of filenames or extensions, only these will be populated to working dir. | None |
Content © 2020 Dr. Ana Nelson | Site Design © Copyright 2011 Andre Gagnon | All Rights Reserved.