Jump to content

Extension:PdfHandler

From mediawiki.org
This page is a translated version of the page Extension:PdfHandler and the translation is 100% complete.
Manuel des extensions MediaWiki
PdfHandler
État de la version : stable
Implémentation Média
Description permet de gérer les fichiers PDF comme le multipages DJVU
Auteur(s) Martin Seidel (xarax)
Politique de compatibilité Versions ponctuelles alignées avec MediaWiki. Le master n'est pas compatible arrière.
Modifie la base
de données
Non
Licence Licence publique générale GNU v2.0 ou supérieur
Téléchargement
Exemple
  • $wgPdfHandlerJpegQuality
  • $wgPdfOutputExtension
  • $wgPdfInfo
  • $wgPdfProcessor
  • $wgPdftoText
  • $wgPdfPostProcessor
  • $wgPdfHandlerDpi
Traduire l’extension PdfHandler sur translatewiki.net si elle y est disponible
Rôle Vagrant pdfhandler
Problèmes Tâches ouvertes · Signaler un bogue

L'extension PdfHandler présente les fichiers PDF téléversés, dans un format d'affichage multi-pages.[1]

Avec l'extension Proofread Page, les fichiers PDF peuvent être affichés côte à côte avec le texte. Cela permet aux utilisateurs de transcrire des livres et d'autres documents.[2]

Utilisation

  • Un utilisateur peut afficher les fichiers PDF sous forme d'image, montrant une seule page à la fois, comme ceci : [[File:myPdfFile.pdf|page=1|600px]]. Les paramètres page et size sont facultatifs; la page par défaut est la page numéro 1. Au lieu du paramètre size, vous pouvez également utiliser le paramètre thumb avec ou sans légende : [[File:myPdfFile.pdf|page=1|thumb|My PDF]].[3]
  • Parce que PdfHandler étend ImageHandler, vous pouvez utiliser tous les arguments que vous utiliseriez pour une Image -- par exemple : thumb, right/left, caption, border, link, etc.
Pour présenter un PDF sur deux pages par exemple, faites : [[File:myPdfFile.pdf|page=1]] [[File:myPdfFile.pdf|page=2]]
  • L'utilisation principale de l'extension PdfHandler se fait sans intervention de l'utilisateur. Si vous téléversez un nouveau fichier PDF, les métadonnées seront stockées dans la base de données, et ce fichier pourra être affiché avec une mise en page d'aperçu multi-pages comme le fait le gestionnaire djvu. Sans cette extension, les PDF ne s'afficheront pas correctement lors du téléversement.
  • De plus cette extension permet à Extension:ProofreadPage de gérer les PDF dans une vue côte à côte pour la traduction et la relecture comme c'est fait sur Wikisource

Pré-requis

L'extension nécessite que les paquets suivants soient d'abord installés :

Paquet Description Lien
ghostscript rendu des images de la page.

Fournit la commande gs.

www.ghostscript.com
imagemagick Réalise le redimentionnement dynamique et les vignettes des images.

Fournit la commande convert.

www.imagemagick.org
xpdf-utils poppler-utils Extrait les métadonnées des fichiers PDF. Si voys voyez 0 × 0 pixel dans la description d'un fichier PDF, c'est que le paquet est absent.

Fournit la commande pdfinfo.

www.xpdfreader.com

Sous Ubuntu et Debian, le paquet poppler-utils peut être utilisé à la place de xpdf-utils.

Entrer les lignes qui suivent dans votre shell pour vérifier d'abord si les éléments ci-dessus sont installés (4 lignes doivent apparaître) :

which gs convert pdfinfo pdftotext

S'il manque quelque chose, installez les paquets correspondants. Exemple dans Debian et Ubuntu :

sudo apt install ghostscript imagemagick xpdf-utils

Si vous ne pouvez pas installer ces paquets, veuillez contacter votre administrateur de serveur pour obtenir de l'aide concernant votre environnement.

Installation

Cette extension est fournie avec MediaWiki 1.21 et supérieur. Les instructions de configuration restantes doivent encore être suivies.
  • Assurez-vous que le logiciel nécessaire est installé avant de continuer !
  • Téléchargez et placez le(s) fichier(s) dans un répertoire appelé PdfHandler dans votre dossier extensions/.
    Les développeurs et les contributeurs au code doivent à la place installer l'extension à partir de Git en utilisant:
    cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/PdfHandler
    
  • Ajoutez le code suivant à la fin de votre fichier LocalSettings.php  :
    wfLoadExtension( 'PdfHandler' );
    
  • Configurez si nécessaire. (see also the examples provided)
  • Yes Fait – Accédez à Special:Version sur votre wiki pour vérifier que l'extension a bien été installée.

Configuration

Vous pouvez (ou devez selon le système d'exploitation du serveur) définir certaines variables dans le fichier LocalSettings.php :

Nom Par défaut Description
$wgPdfProcessor "gs" chemin de votre implémentation ghostscript
$wgPdfPostProcessor "convert" chemin de votre convertisseur imagemagick
$wgPdfInfo "pdfinfo" chemin de votre pdfinfo
$wgPdftoText "pdftotext" chemin de votre pdftotext
$wgPdfOutputExtension "jpg" format de sortie favorit[4]
$wgPdfHandlerDpi "150" résolution en dpi

L'extension extrait une image bitmap pour chaque page du PDF, en utilisant cette résolution (dpi = dots per inch = points par pouce). Par exemple une page PDF avec la taille européenne A4 a une longueur de 210 mm, ce qui correspond à 595 points (pour 72 dpi). Cela fournit une image de 1240 pixels de large (pour une résolution de 150 dpi). Si ce paramètre vaut 300 dpi, la largeur sera de 2480 pixels.

$wgPdfHandlerJpegQuality "95" (introduit dans 1.24) Niveau de qualité que le post processeur doit utiliser.
Les variables ci-dessous ne sont pas spécifiques à cette extension
  • Autoriser le téléversement des PDF si ce n'est pas déjà fait : $wgFileExtensions [] = 'pdf';
  • Activer ImageMagick, si ce n'est pas déjà fait : $wgUseImageMagick = true;
  • $wgMaxShellMemory - limite de la mémoire pour gs, convert et pdinfo. Il est possible que la valeur par défaut soit trop basse.

Ubuntu

Ceci est identique aux paramètres par défaut pour cette extension.
$wgPdfProcessor = 'gs';
$wgPdfPostProcessor = $wgImageMagickConvertCommand; // si défini via ImageMagick
// $wgPdfPostProcessor = 'convert'; // si non défini via ImageMagick
$wgPdfInfo = 'pdfinfo';
$wgPdftoText = 'pdftotext';

Debian

$wgPdfProcessor = '/usr/bin/gs';
$wgPdfPostProcessor = $wgImageMagickConvertCommand; // si défini via ImageMagick
// $wgPdfPostProcessor = '/usr/bin/convert';  // si non défini via ImageMagick
$wgPdfInfo = '/usr/bin/pdfinfo';
$wgPdftoText = '/usr/bin/pdftotext';

Windows

$wgPdfProcessor = 'C:\Program Files\gs\gs8.60\bin\gswin32.exe';
$wgPdfPostProcessor = $wgImageMagickConvertCommand; // si défini via ImageMagick
// $wgPdfPostProcessor = 'C:\Program Files\ImageMagick-6.6.2-Q16\convert.exe'; // si non défini 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; // si défini via ImageMagick
// $wgPdfPostProcessor = '/usr/local/bin/convert'; // si non défini via ImageMagick
$wgPdfInfo = '/usr/local/bin/pdfinfo';
$wgPdftoText = '/usr/local/bin/pdftotext';

Dépannage

  • Si les fichiers PDF ne s'affichent pas après le téléversement, vérifiez que MediaWiki peut exécuter la commande pdfinfo et que le paramètre de configuration $wgPdfInfo est correctement initialisé. Vérifiez également le journal des erreurs et assurez-vous que votre hôte n'a pas désactivé l'exécution des commandes externes.
  • Si les fichiers PDF ne s'affichent pas correctement après l'installation (par exemple, en montrant 0 × 0 pixels) vous devrez peut-être utiliser Scripts de maintenance refreshImageMetadata.php et (ou) rebuildImages.php. Par exemple :
    $ php ./maintenance/run.php refreshImageMetadata --mime application/pdf --force
    
    Essayez aussi de purger la page du fichier. Voir Manuel:Purger .
  • Si les fichiers PDF s'affichent au hasard, vérifiez si la locale C.UTF-8 est disponible sur votre serveur en exécutant locale -a.

Notes

  1. Eventuellement n'est plus nécessaire car si WebStore est activé, l'extension génère automatiquement les images à partir de la page spécifiée.
  2. Cela permet aux utilisateurs de transcrire des livres et d'autres documents comme c'est généralement le cas avec les fichiers DjVu (en particulier dans Wikisource).
  3. Cette option de page unique a été introduite il y a longtemps (r25575)
  4. Cela n'exclut pas de générer d'autres formats car l'image est fournie dans un format déterminé par l'extension (le suffixe) dans le chemin src=, et non pas par $wgPdfOutputExtension. Le choix côté serveur peut être redéfini par un script utilisateur – voir cet exemple.

Voir aussi