===== ZIPPlugin =====
//Plugin which handles [[compressed|compressed and/or archived input formats]] currently handled formats 
and file extensions are: gzip (.gz, .z, .tgz, .taz), bzip (.bz), bzip2 (.bz2), zip (.zip .jar), and
tar (.tar).

This plugin relies on the following utilities being present 
(if trying to process the corresponding formats): gunzip (for gzip),  bunzip (for bzip), 
bunzip2, unzip (for zip), and tar (for tar).//

  * Processes files with extensions: ''.gz'', ''.tgz''. ''.z'', ''.taz'', ''.bz'', ''.bz2'', ''.zip'', ''.jar'', ''.tar'' \\  (Perl regular expression: //''<nowiki>(?i)\.(gz|tgz|z|taz|bz|bz2|zip|jar|tar)$</nowiki>''// )


The following table lists all of the configuration options available for ZIPPlugin.

^Option^Description^Value^
^//ZIPPlugin Options//^^^
| **process_exp** |A perl regular expression to match against filenames. Matching filenames will be processed by this plugin. For example, using '(?i).html?\$' matches all documents ending in .htm or .html (case-insensitive). |//Default: (?i)\.(gz|tgz|z|taz|bz|bz2|zip|jar|tar)$// |
^//Options Inherited from [[BasePlugin]]//^^^
| **process_exp** |A perl regular expression to match against filenames. Matching filenames will be processed by this plugin. For example, using '(?i).html?\$' matches all documents ending in .htm or .html (case-insensitive). | |
| **no_blocking** |Don't do any file blocking. Any associated files (e.g. images in a web page) will be added to the collection as documents in their own right. | |
| **block_exp** |Files matching this regular expression will be blocked from being passed to any later plugins in the list. | |
| **store_original_file** |Save the original source document as an associated file. Note this is already done for files like PDF, Word etc. This option is only useful for plugins that don't already store a copy of the original file. | |
| **associate_ext** |Causes files with the same root filename as the document being processed by the plugin AND a filename extension from the comma separated list provided by this argument to be associated with the document being processed rather than handled as a separate list. | |
| **associate_tail_re** |A regular expression to match filenames against to find associated files. Used as a more powerful alternative to associate_ext. | |
| **OIDtype** |The method to use when generating unique identifiers for each document. |//Default: auto//\\ [[BasePlugin#OIDtype option values|List]] |
| **OIDmetadata** |Specifies the metadata element that hold's the document's unique identifier, for use with -OIDtype=assigned. |//Default: dc.Identifier// |
| **no_cover_image** |Do not look for a prefix.jpg file (where prefix is the same prefix as the file being processed) to associate as a cover image. | |
| **filename_encoding** |The encoding of the source file filenames. |//Default: auto//\\ [[BasePlugin#filename_encoding option values|List]] |
| **file_rename_method** |The method to be used in renaming the copy of the imported file and associated files. |//Default: url//\\ [[BasePlugin#file_rename_method option values|List]] |