Extensión:PDF Handler
PdfHandler Estado de lanzamiento: estable |
|
---|---|
Implementación | Multimedia |
Descripción | Allows to handle PDF files like multipage DJVU |
Autor(es) | Martin Seidel (xarax) |
Política de compatibilidad | Lanzamientos de screenshots junto con MediaWiki. Master no es compatible con versiones anteriores. |
Cambios de la base de datos | No |
Licencia | GNU Licencia Pública general 2.0 o posterior |
Descarga | |
Ejemplo | |
|
|
Descargas trimestrales | 198 (Ranked 31st) |
Wikis públicos que lo utilizan | 3,575 (Ranked 185th) |
Traduce la extensión PdfHandler si está disponible en translatewiki.net | |
Función de vagabundo | pdfhandler |
Asuntos | Tareas abiertas · Reportar un 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]
Uso
- A user can display PDF files as an image, showing a single page at a time, like so:
[[File:myPdfFile.pdf|page=1|600px]]
. Thepage
andsize
parameters are optional; the default page is page #1. Instead of asize
-parameter, you can also use thethumb
-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-requisitos
This extension requires the following packages to be installed first:
Package | Description | Link |
---|---|---|
ghostscript
|
Renders the page images.
It provides the command |
www.ghostscript.com |
imagemagick
|
Does dynamic resizing and thumbnailing of images.
It provides the command |
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 |
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
Si falta algo, instala los paquetes relacionados. Ejemplo en Debian y Ubuntu:
sudo apt install ghostscript imagemagick xpdf-utils
Si no puede instalar estos paquetes, póngase en contacto con su administrador de servidor para obtener ayuda en su entorno.
Instalación
- Make sure that the required software is installed before you continue!
- Descarga y extrae los archivos en un directorio denominado «
PdfHandler
» dentro de la carpetaextensions/
.
Developers and code contributors should install the extension from Git instead, using:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/PdfHandler - Añade el siguiente código en la parte final de tu archivo LocalSettings.php :
wfLoadExtension( 'PdfHandler' );
- Configure as required. (see also the examples provided)
- Hecho – Navega a Special:Version en el wiki para verificar que la extensión se haya instalado correctamente.
Configuración
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
- 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.
Ubuntu
Nota: 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';
Solución de problemas
- 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
.
Notas
- ↑ PROBABLY not required any more: with WebStore enabled, the extension automatically generates images from the specified page
- ↑ 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.
Véase también
- 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
- How to use DjVu with MediaWiki
- Extension PDFEmbed
Esta extensión está siendo usada en uno o más proyectos de Wikimedia. Esto significa probablemente que la extensión es estable y funciona lo suficientemente bien como para ser usada en sitios con gran cantidad de visitas. Puedes buscar el nombre de esta extensión en los archivos CommonSettings.php e InitialiseSettings.php de Wikimedia para ver dónde se instala. Encontrarás la lista completa de extensiones instaladas en un wiki en particular en la página Special:Version del wiki. |
Esta extensión está incluida en los siguientes anfitriones/granjas wiki y/o paquetes: No se trata de una lista oficial. Algunas granjas/hosts wiki y/o paquetes pueden tener disponible esta extensión aunque no estén listados aquí. Siempre compruébelo con su anfitrión o granja wiki para confirmarlo. |