Versions Compared

Old Version 1

changes.mady.by.user Tim Donohue

Saved on

compared with

New Version 2

changes.mady.by.user Mark H. Wood

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Removed WordFilter; PoiWordFilter is enabled by default.

...

Below is a listing of all currently available Media Filters, and what they actually do:

Name

Java Class

Function

Default input formats

Enabled by Default?

PDF Text Extractor

org.dspace.app.mediafilter.PDFFilter

extracts the full text of Adobe PDF documents (only if text-based or OCRed) for full text indexing. (Uses the Apache PDFBox tool)

Adobe PDF

yes

HTML Text Extractor

org.dspace.app.mediafilter.HTMLFilter

extracts the full text of HTML documents for full text indexing. (Uses Swing's HTML Parser)

HTML, Text

yes

Word Text Extractor

org.dspace.app.mediafilter.

WordFilterextracts the full text of Microsoft Word or Plain Text documents for full text indexing. (Uses the "Microsoft Word Text Mining" tools.)  See also

PoiWordFilter

, below.

Microsoft Word

yes

Word Text Extractor

org.dspace.app.mediafilter.PoiWordFilter

extracts the full text of Microsoft Word and Microsoft Word XML documents for full text indexing. (Uses the "Apache POI" tools.)

  Disabled by default.  Uncomment PoiWordFilter and comment WordFilter in dspace.cfg if you wish to use this one.

Microsoft Word, Microsoft Word XML
no

yes

Excel Text Extractororg.dspace.app.mediafilter.ExcelFilterextracts the full text of Microsoft Excel documents for full text indexing. (Uses the "Apache POI" tools.)Microsoft Excel, Microsoft Excel XMLyes

PowerPoint Text Extractor

org.dspace.app.mediafilter.PowerPointFilter

extracts the full text of slides and notes in Microsoft PowerPoint and PowerPoint XML documents for full text indexing. (Uses the Apache POI tools.)

Microsoft Powerpoint, Microsoft Powerpoint XML

yes

PDFBox JPEG Thumbnailorg.dspace.app.mediafilter.PDFBoxThumbnailcreates thumbnail images of the first page of PDF filesAdobe PDFyes

JPEG Thumbnail

org.dspace.app.mediafilter.JPEGFilter

creates thumbnail images of GIF, JPEG and PNG files

BMP, GIF, JPEG, image/png

yes

Branded Preview JPEG

org.dspace.app.mediafilter.BrandedPreviewJPEGFilter

creates a branded preview image for GIF, JPEG and PNG files

BMP, GIF, JPEG, image/png

no

ImageMagick Image Thumbnail Generator

org.dspace.app.mediafilter.ImageMagickImageThumbnailFilter

Uses ImageMagick to generate thumbnails for image bitstreams. Requires installation of ImageMagick on your server. See ImageMagick Media Filters.BMP, GIF, image/png, JPG, TIFF, JPEG, JPEG 2000no
ImageMagick PDF Thumbnail Generatororg.dspace.app.mediafilter.ImageMagickPdfThumbnailFilterUses ImageMagick and Ghostscript to generate thumbnails for PDF bitstreams. Requires installation of ImageMagick and Ghostscript on your server. See  ImageMagick Media Filters.Adobe PDFno

Please note that the filter-media script will automatically update the DSpace search index by default.

...

 

Configuration parameters

Property

filter.org.dspace.app.mediafilter.publicPermission

Example Valuefilter.org.dspace.app.mediafilter.publicPermission = JPEGFilter
Informational NoteBy default mediafilter derivatives / thumbnails inherit the permissions of the parent bitstream, but you can override this, in case you want to make publicly accessible derivative / thumbnail content, typically the thumbnails of objects for the browse list. List the MediaFilter names that would get public accessible permissions. Any media filters not listed will instead inherit the permissions of the parent bitstream.