MediaWiki

Extension:PdfHandler

Translate this page
Languages:
This extension comes with MediaWiki 1.21 and above. Thus you do not have to download it again. However, you still need to follow the other instructions provided.
MediaWiki extensions manual
PdfHandler
Release status: stable
Implementation Media
Description Allows to handle PDF files like multipage DJVU
Author(s) Martin Seidel (xarax)
Compatibility policy Snapshots releases along with MediaWiki. Master is not backward compatible.
MediaWiki >= 1.43
Database changes No
License GNU General Public License 2.0 or later
Download
Download extension
Git [?]:
Example
Parameters
  • $wgPdfHandlerJpegQuality
  • $wgPdfOutputExtension
  • $wgPdfInfo
  • $wgPdfProcessor
  • $wgPdftoText
  • $wgPdfPostProcessor
  • $wgPdfHandlerDpi
Quarterly downloads 217 (Ranked 29th)
Public wikis using 3,575 (Ranked 185th)
Translate the PdfHandler extension if it is available at translatewiki.net
Vagrant role pdfhandler
Issues Open tasks · Report a bug

The PdfHandler extension shows uploaded PDF files in a multipage preview layout.[1]

Together with the Proofread Page extension, PDF files can be displayed side-by-side with text. This allows users to transcribe books and other documents.[2]

Usage

  • 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: [[File:myPdfFile.pdf|page=1|thumb|My PDF]].[3]
  • 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: [[File:myPdfFile.pdf|page=1]] [[File:myPdfFile.pdf|page=2]]
  • 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


Pre-requisites

This extension requires the following packages to be installed first:

Package Description Link
ghostscript Renders the page images.

It provides the command gs.

www.ghostscript.com
imagemagick Does dynamic resizing and thumbnailing of images.

It provides the command convert.

www.imagemagick.org
xpdf-utils
or
poppler-utils 		Extracts metadata from PDF files. If you see "0 × 0 pixel" on the file description of a PDF, you lack this package.

It provides the command pdfinfo.

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 (it should list 4 rows): 

which gs convert pdfinfo pdftotext

If something is missing, install the related packages. Example in Debian and Ubuntu: 

sudo apt install ghostscript imagemagick xpdf-utils

If you are unable to install these packages, kindly contact your server administrator for assistance in your environment.

Installation

  • Make sure that the required software is installed before you continue!
  • Download and move the extracted PdfHandler folder to your extensions/ directory.
    Developers and code contributors should install the extension from Git instead, using:cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/PdfHandler
  • Add the following code at the bottom of your LocalSettings.php file: 
    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.

Configuration

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[4]
$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.
Variables below are not specific to this extension

Ubuntu

  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';

Debian

$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';

Windows

$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';

macOS

$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';

Troubleshooting

General issues
  • If PDF files do not display after upload, make sure that MediaWiki can execute the pdfinfo command and that configuration parameter $wgPdfInfo is 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 (for example saying 0 height and width) you may need to use the maintenance scripts "refreshImageMetadata.php -f" and "rebuildImages.php"
    Example:
    php refreshImageMetadata.php --mime application/pdf --force
    Also try to purge the page of the file. See Manual:Purge.
  • If PDF files are rendered randomly check if the "C.UTF-8" locale is available on your server by running locale -a and make sure that configuration parameter $wgShellLocale is 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 srcset for the img tags 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 running this extension on a windows machine with PHP 7, please see Tommeyheyser's workaround description.

If you are having pdfoinfo and/or pdftotext hanging issue that prevents a big PDF upload, please check the modified extension by SeongMoon

Notes

  1. ↑ PROBABLY not required any more: with WebStore enabled, the extension automatically generates images from the specified page
  2. ↑ This allows users to transcribe books and other documents as is commonly done with DjVu files (particularly in Wikisource).
  3. ↑ This single page option was introduced quite long ago (r25575)
  4. ↑ 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.

See also

Retrieved from "https://www.mediawiki.org/w/index.php?title=Extension:PdfHandler/en&oldid=6849838"