===== ImagePlugin =====
//This plugin processes [[images]], adding basic metadata//

  * Processes files with extensions: ''.jpeg'', ''.jpg'', ''.gif'', ''.png'', ''.bmp'', ''.xbm'', ''.tif'', ''.tif'', ''.jpf'', ''.jpx'', ''.jp2'', ''.jpc'', ''.j2k'', ''.pnm'', ''.pgx'' \\ Perl regular expression: //''<nowiki>(?i)\.(jpe?g|gif|png|bmp|xbm|tif?f|jpf|jpx|jp2|jpc|j2k|pnm|pgx)$</nowiki>''//


ImagePlugin uses the Imagemagick utilities to create 
derivatives(thumbnail images) and extract image metadata (width height format). ImagePlugin can 
easily be extended to extract more extensive image metadata if required.


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

^Option^Description^Value^
^//ImagePlugin 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)\.(jpe?g|gif|png|bmp|xbm|tif?f|jpf|jpx|jp2|jpc|j2k|pnm|pgx)$// |
^//Options Inherited from [[ImageConverter]]//^^^
| **create_thumbnail** |If set to true, create a thumbnail version of each image, and add Thumb, ThumbType, thumbicon, ThumbWidth, ThumbHeight metadata. |//Default: true//\\ [[ImageConverter#create_thumbnail option values|List]] |
| **thumbnailsize** |Make thumbnails of size nxn. |//Default: 100// //Range: 1,// |
| **thumbnailtype** |Make thumbnails in format 's'. |//Default: gif// |
| **noscaleup** |Don't scale up small images when making thumbnails. | |
| **create_screenview** |If set to true, create a screen sized image, and set Screen, ScreenType, screenicon, ScreenWidth, ScreenHeight metadata. |//Default: true//\\ [[ImageConverter#create_screenview option values|List]] |
| **screenviewsize** |Make screenview images of size nxn. |//Default: 500// //Range: 1,// |
| **screenviewtype** |Make screenview images in format 's'. |//Default: jpg// |
| **converttotype** |Convert main image to format 's'. | |
| **minimumsize** |Ignore images smaller than n bytes. |//Default: 100// //Range: 1,// |
| **apply_aspectpad** |{ImageConverter.apply_aspectpad} |//Default: false//\\ [[ImageConverter#apply_aspectpad option values|List]] |
| **aspectpad_ratio** |{ImageConverter.aspectpad_ratio} |//Default: 2// //Range: 1,// |
| **aspectpad_mode** |{ImageConverter.aspectpad_mode} |//Default: al//\\ [[ImageConverter#aspectpad_mode option values|List]] |
| **aspectpad_colour** |{ImageConverter.aspectpad_colour} |//Default: transparent// |
| **aspectpad_tolerance** |{ImageConverter.aspectpad_tolerance} |//Default: 0.0// //Range: 0,// |
^//Options Inherited from [[BaseMediaConverter]]//^^^
| **enable_cache** |Cache automatically generated files (such as thumbnails and screen-size images) so they don't need to be repeatedly generated. | |
^//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]] |