1====== mediathumbnails Plugin ======
3---- plugin ----
4description: Extracts a thumbnail from media files (ODT, DOCX, PPTX, PDF, JPG, etc.) in a media library and shows it on the wiki page.
5author     : Thomas Schäfer
6email      : thomas@hilbershome.de
7type       : syntax
8lastupdate : 2021-05-24
9compatible : 2020-07-29 "Hogfather"
10depends    :
11conflicts  :
12similar    :
13tags       : images, media, mediamanager, thumbnail, odt, pdf
15downloadurl: https://github.com/ternite/dokuwiki-plugin-mediathumbnails/archive/v0.92.zip
16bugtracker : hhttps://github.com/ternite/dokuwiki-plugin-mediathumbnails/issues
17sourcerepo : https://github.com/ternite/dokuwiki-plugin-mediathumbnails
20screenshot_img :
23===== Installation and Dependencies =====
25Install the plugin using the [[plugin:plugin|Plugin Manager]] and the download URL above, which points to latest version of the plugin. Refer to [[:Plugins]] on how to install plugins manually.
27:!: **External requirements:** Office files (ODT, DOCX, PPTX, etc.) are supported natively. If you need image or PDF support, this plugin requires the following additional components that must be installed and integrated into your PHP environment separately:
29  * Support for Office file thumbnails:
30    * [[https://www.php.net/manual/de/book.zip.php|zip]] PHP extension
31    * libzip-dev (needed by zip) - your installation might already have this installed, or not.
32  * Support for PDF and image thumbnails:
33    * [[https://imagemagick.org|ImageMagick]]
34    * [[https://github.com/Imagick/imagick|Imagick]] (PHP extension for ImageMagick integration)
35    * [[https://www.ghostscript.com/index.html|GhostScript]] //(obligatory only for PDF support)//
38  * Installation on Windows was troublesome for me. The best description of how to install ImageMagick and Imagick was: [[https://mlocati.github.io/articles/php-windows-imagick.html|Install the ImageMagick PHP extension in Windows]] by [[https://github.com/mlocati|Michele Locati]].
39    * It does not cover the installation process of ImageMagick, but the correct destribution archive is linked along with the matching PHP extension!
40    * In addition to the description on Michele's page, I added ImageMagick's bin folder to my systems' PATH variable and to a variable named MAGICK_HOME.
41  * Concerning the installation of GhostScript: despite all my efforts, wedding GhostScript to ImageMagick via configuration failed. I finally added GhostScript's `bin` folder to the System Environment PATH variable (which is ok) and then I renamed `gswin32c.exe` to `gs.exe` (then I made my donut suffer for it).
42  * You might run into a case where ImageMagick, Imagick and Ghostscript are properly installed, but no PDF file thumbnail is created. (In that case, you should get a proper error message if you activated //allowdebug// in your dokuwiki config.) This may be due to a security policy defined in ImageMagick's `policy.xml`. Look for the following entry, then change the //rights// attribute to the value `read|write`:
44<code><policy domain="coder" rights="none" pattern="PDF" /></code>
46...should become...
48<code><policy domain="coder" rights="read|write" pattern="PDF" /></code>
50===== What's it for? =====
52This plugin will show thumbnail images for supported media files (ODT, DOCX, PPTX, PDF, JPG, etc.) within your wiki pages.
54In default settings, a click in the thumbnail will have your browser download the media file.
56And an error message will be shown by default in case a referenced media file does not contain a thumbnail (office files) or is an unsupported file type (see dependencies on how you might work around that).
58===== Syntax =====
62Shows a thumbnail of the media file given via the string `media_path_and_filename` (standard file path for the [[:media_manager|Media Manager]]). In case of an office file (ODT, DOCX, PPTX, etc.), this will only work, if a thumbnail image already has been saved within the file (which nowadays should be very common).
64In order to be able to show the thumbnail image, the image itself is stored within the media library alongside the media file (see [[#Implementation Details|Implementation Details]]).
66The plugin watches file changes at the moment a wiki page is rendered. You might need to watch out for page caching!
68In case a media file is replaced by another file (with the same name), this will be noticed by timestamp comparison - the original thumbnail will be overwritten.
70**Example:** <code>{{thumbnail>main:media_namespace:presentation.pptx}}</code>
72This will show a thumbnail of the Powerpoint presentation in your wiki page. The thumbnail image will be stored within the media library as `main:media_namespace:presentation.pptx.thumb100.jpeg` (with default settings, and because JPEG appears to be the format of thumbnail images within a PPTX file).
74===== Implementation Details =====
76In all cases where a file format is supported by the plugin, it will add a thumbnail image into the [[:media_manager|Media Manager]]. In case you decide later on that you don't want these images within your media, your only option is to remove them manually.
78The name of the thumbnail will be: <code>{original_filename}.thumb{thumb_max_dimension}.{image_suffix}</code>
80The following examples assume the default value of 100 for `thumb_max_dimension`.
82**Example 1:** my_dog.jpg => my_dog.jpg.thumb100.jpg
84**Example 2:** presentation.pdf => presentation.pdf.thumb100.jpg
86The file format for PDF thumbnails will always be JPG.
88**Example 3:** presentation.pptx => presentation.pptx.thumb100.png
90Note that the file format of the thumbnail in office files might theoretically be any image file format. It depends on the format found within the office file. If you use office files with differing file formats, you might need to adjust the config setting `thumb_paths`. If you have such an office file, I'd like to hear about that so I can add the format to the default value of that config option.
92==== Office files ====
94When looking for thumbnails of office files (ODT, DOCX, etc.), the plugin essentially assumes these files to be ZIP files containing a thumbnail image at a specific path (see config setting `thumb_paths`). It will not generate any images for office files, but look for an already embedded thumbnail within the document file, then show the thumbnail on your wiki page.
96==== Image files ====
98The plugin will need a properly installed and integrated **ImageMagick** and **Imagick** suite (see [[#Installation and Dependencies]]). Then it will load the image into ImageMagick and transform it into a thumbnail image.
100==== PDF files ====
102In order to create thumbnails for PDF files, in addition to a requirement of **ImageMagick** and **Imagick**, you will also need a properly installed and configured **GhostScript** (see [[#Installation and Dependencies]]). The plugin will then transform the first page of the PDF file to a JPG thumbnail.
104===== Configuration and Settings =====
106//(compare: [[:devel:configuration#configuration_metadata|Configuration metadata]] for configuration classes)//
108^ **thumb_max_dimension** | Default dimension to set for a thumbnail (in pixels, enter without units). The thumbnail will fit into a quadratic box of this size - in case the image is not quadratic, the other dimension will be reduced per aspect ratio. ||
109| ::: | numeric, default: | **"100"** |
110^ **thumb_paths** | Paths within media files (format: ZIP) to look at for thumbnail images (comma-separated list, use slashes as directory delimiters). //Is defaulted for paths within ODT files and MS Office files, but can be extended in case of other formats.// ||
111| ::: | array, default: | **array("Thumbnails/thumbnail.png", "docProps/thumbnail.jpeg")** |
112^ **link_to_media_file** | Should a click on the thumbnail start the media file download? ||
113| ::: | onoff, default: | **true** |
114^ **show_no_thumb_error** | In case no thumbnail was found, do you want an error message be shown? ||
115| ::: | onoff, default: | **true** |
116^ **no_thumb_error_message** | Error message to be shown when no thumbnail was found, and 'show_no_thumb_error' is set. Media path will automatically be appended! ||
117| ::: | string, default: | **"No thumbnail in "** \\ //note: media path will automatically be appended// |
119If your PDF and/or image thumbnails don't show up, consider activating the `allowdebug` option in the DokuWiki base configuratoin. I added some checks that should output information on dependency status.
121===== Development =====
123[[https://github.com/ternite/dokuwiki-plugin-mediathumbnails|Sources]] on github.
125=== Change Log ===
127  * **2021-03-29**
128    * v0.81 (Initial release)
129  * **2021-04-02**
130    * v0.91 (added image and PDF support)
131      * config option `thumb_width` was dropped, so you might want to delete that entry from `conf/local.php` if you upgraded from v0.81 and had altered that value
132  * **2021-05-24**
133    * v0.92 (Added checks for ImageMagick security policy issues)
135=== Known Bugs and Issues ===
137See [[https://github.com/ternite/dokuwiki-plugin-mediathumbnails/issues|issue tracker]] on github.
139===== FAQ =====
141None, yet.
143===== Discussion =====
145//Thomas Schäfer (2021-03-29):// I wasn't able to locate a proper specification indicating the exact file locations for thumbnails within both OpenOffice/LibreOffice files, or MS Office files. In case you point me to such a specification, I might enhance the config settings for properly identifying thumbnails in more instances of such office documents.