Release status: stable
|Description||Allows to handle PDF files like multipage DJVU|
|Author(s)||Martin Seidel (xarax)|
|Compatibility policy||Snapshots releases along with MediaWiki. Master is not backwards compatible.|
|MediaWiki 1.36||Not formally tested|
|MediaWiki 1.34||Not formally tested|
|MediaWiki 1.32||Not formally tested|
|License||GNU General Public License 2.0 or later|
|Translate the PdfHandler extension if it is available at translatewiki.net|
|Issues||Open tasks · Report a bug|
The PdfHandler extension shows uploaded PDF files in a multipage preview layout.
- A user can display PDF files as an image, showing a single page at a time, like so:
[[File:myPdfFile.pdf|page=1|600px]]. The page and size parameters are optional; the default page is page #1. Instead of a size-parameter, you can also use the thumb-parameter, with or without captions:
- Because PdfHandler extends ImageHandler, you can use all the arguments that you would for an Image -- for example: thumb, right/left, caption, border, link, etc.
- If you would like to present a 2-page pdf, for example, do the following:
- The main usage of the PdfHandler extension is without user interaction. If you upload a new pdf file, the metadata will be stored in the database, and then this file can be shown in a multipage preview layout like the djvu handler does. Without this extension, pdfs will not display properly when uploaded.
- Additionally, this extension allows Extension:ProofreadPage to handle pdfs in side-by-side view for transcribing/proofreading, as is done on Wikisource
This extension requires the following packages to be installed first:
|"ghostscript" for gs||Renders the page images||www.ghostscript.com|
|"imagemagick" for convert||Does dynamic resizing and thumbnailing of images||www.imagemagick.org|
|"xpdf-utils" for pdfinfo||Extracts metadata from PDF files. If you see "0 × 0 pixel" on the file description of a PDF, you lack this package.||www.xpdfreader.com
On Ubuntu and Debian, the "poppler-utils" package can be used instead of "xpdf-utils".
Type the following in your shell to see if you have the above installed first:
which gs convert pdfinfo pdftotext
- Make sure that the required software is installed before you continue!
- Download and place the file(s) in a directory called
- Add the following code at the bottom of your LocalSettings.php:
wfLoadExtension( 'PdfHandler' );
- Configure as required. (see also the examples provided)
- Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.
To users running MediaWiki 1.24 or earlier:
The instructions above describe the new way of installing this extension using
If you need to install this extension on these earlier versions (MediaWiki 1.24 and earlier), instead of
wfLoadExtension( 'PdfHandler' );, you need to use:
You can (or, depending on the operating system of the server, will have to) set some variables in the "LocalSettings.php" file:
$wgPdfProcessor(default = "gs")
- path to your ghostscript implementation
$wgPdfPostProcessor(default = "convert")
- path to your imagemagick convert
$wgPdfInfo(default = "pdfinfo")
- path to your pdfinfo
$wgPdftoText(default = "pdftotext")
- path to your pdftotext
$wgPdfOutputExtension(default = "jpg")
- preferred output format
$wgPdfHandlerDpi(default = "150" )
- resolution in dpi
- The extension extracts a bitmap image for each page of the PDF, using this resolution (dpi = dots per inch). For example, a PDF page with the European size A4 is 210 mm wide, corresponding to 595 points (at 72 dpi). This yields an image 1240 pixels wide (at 150 dpi). If instead this parameter is set to 300 dpi, the width will be 2480 pixels.
$wgPdfHandlerJpegQuality(default = "95" / since MW 1.24+ )
- Quality level, which the post processor should use.
$wgPdfCreateThumbnailsInJobQueue(default = "false")
- Puts creating pages' thumbnails into a job queue, so they do not have to be created while browsing a file page, but during normal wikibrowsing. Be advised that setting this to "true" may significantly increase CPU load of your webserver on a high-traffic website. Job queue was designed to perform quick tasks on page views, and creating thumbnails can be included into that queue, according to this definition. Nevertheless, as quick as it is, it also requires certain CPU load to convert PDF pages to another format. The solution to that would be either setting $wgJobRunRate to rather small value (ie. 0.05) or disabling job queue on the high-traffic wiki and setting up another server to do just job queue (like Wikimedia did).
- Variables below are not specific to this extension
- Enable PDF uploads, if you haven't already:
$wgFileExtensions = 'pdf';
- Enable ImageMagick, if you haven't already:
$wgUseImageMagick = true;
$wgMaxShellMemory- memory limit for gs, convert and pdfinfo. The default value might be too low.
Note: This is identical to the default settings for this extension.
$wgPdfProcessor = 'gs'; $wgPdfPostProcessor = $wgImageMagickConvertCommand; // if defined via ImageMagick // $wgPdfPostProcessor = 'convert'; // if not defined via ImageMagick $wgPdfInfo = 'pdfinfo'; $wgPdftoText = 'pdftotext';
$wgPdfProcessor = '/usr/bin/gs'; $wgPdfPostProcessor = $wgImageMagickConvertCommand; // if defined via ImageMagick // $wgPdfPostProcessor = '/usr/bin/convert'; // if not defined via ImageMagick $wgPdfInfo = '/usr/bin/pdfinfo'; $wgPdftoText = '/usr/bin/pdftotext';
$wgPdfProcessor = 'C:\Program Files\gs\gs8.60\bin\gswin32.exe'; $wgPdfPostProcessor = $wgImageMagickConvertCommand; // if defined via ImageMagick // $wgPdfPostProcessor = 'C:\Program Files\ImageMagick-6.6.2-Q16\convert.exe'; // if not defined via ImageMagick $wgPdfInfo = 'C:\Program Files\xpdf-3.02pl1-win32\pdfinfo.exe'; $wgPdftoText = 'C:\Program Files\xpdf-3.02pl1-win32\pdftotext.exe';
$wgPdfProcessor = '/usr/local/bin/gs'; $wgPdfPostProcessor = $wgImageMagickConvertCommand; // if defined via ImageMagick // $wgPdfPostProcessor = '/usr/local/bin/convert'; // if not defined via ImageMagick $wgPdfInfo = '/usr/local/bin/pdfinfo'; $wgPdftoText = '/usr/local/bin/pdftotext';
- General issues
- If PDF files do not display after upload, make sure that MediaWiki can execute the pdfinfo command and that configuration parameter
$wgPdfInfois set properly. Also check your error log, and make sure that your host hasn't disabled running external commands.
- If PDF files do not show properly after installation you may need to use the maintenance scripts "refreshImageMetadata.php -f" and "rebuildImages.php"
- If PDF files are rendered randomly check if the "C.UTF-8" locale is available on your server by running
locale -aand make sure that configuration parameter
$wgShellLocaleis set to this locale.
- If the main preview image of PDF files is broken (image not found by browser), but all other images are working, also check your configuration parameter
$wgShellLocale. If it is set to a locale that does not use the point
.as a decimal separator (e.g. "de-de", which use a comma), the
imgtags will be broken. MediaWiki strongly recommends to use the "C.UTF-8" locale.
- Special solutions for Windows Server running MW 1.31.x
If you are having pdfoinfo and/or pdftotext hanging issue that prevents a big PDF upload, please check the modified extension by SeongMoon
- This allows users to transcribe books and other documents as is commonly done with DjVu files (particularly in Wikisource).
- This single page option was introduced quite long ago (r25575)
- This does not preclude rendering to other formats, as the picture is served in a format determined by the extension (suffix) in its
src=path, not by
$wgPdfOutputExtension. The server-side choice can be overridden with a user script – see example.
- http://wiki.4intra.net/PdfHandler - a fork with much faster thumbnail generation by using pdftocairo instead of ghostscript+imagemagick
- Extension:Proofread Page (may be used in conjunction with PdfHandler)
- Manual:How to use DjVu with MediaWiki
|This extension is being used on one or more Wikimedia projects. This probably means that the extension is stable and works well enough to be used by such high-traffic websites. Look for this extension's name in Wikimedia's CommonSettings.php and InitialiseSettings.php configuration files to see where it's installed. A full list of the extensions installed on a particular wiki can be seen on the wiki's Special:Version page.|