Extension:ElectronPdfService

From MediaWiki.org
Jump to navigation Jump to search

Other languages:
Deutsch • ‎English • ‎dansk • ‎français • ‎português do Brasil • ‎中文 • ‎日本語
MediaWiki extensions manual
Crystal Clear action run.svg
Extension:ElectronPdfService
Release status: beta
ElectronPdfService-mockup.png
Implementation User interface
Description Provides access to the Electron Service for browser based PDF rendering
Author(s) Wikimedia Germany (WMDE) – Roadmap
Latest version continuous updates
Compatibility policy release branches
MediaWiki 1.25+
Database changes No
License GNU General Public License 2.0 or later
Download
Example Wikipedia article
Translate the ElectronPdfService extension if it is available at translatewiki.net
Check usage and version matrix.
Issues Open tasks · Report a bug

The ElectronPdfService extension provides access to the Electron Service for browser-based PDF rendering. (The Electron Service needs to be installed separately.)

Description[edit]

The extension provides a handy way to access the Electron Service via a RESTBase API endpoint. The Electron Service provides a new rendering method for Wiki-pages as alternative to the existing OCG/LaTeX rendering. The huge advantage of using the Electron Service is, that the generated PDF will contain all tables as well as rendered infoboxes and other templates which was not possible with the old method. Read more on the background of the motivation for the extension and the service.

And here's an example: PDF for the article about Berlin.

Installation[edit]

  • Add the following code at the bottom of your LocalSettings.php:
    wfLoadExtension( 'ElectronPdfService' );
    $wgElectronPdfServiceRESTbaseURL = '/api/rest_v1/page/pdf/';
    
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Ubuntu 16.04.3 (Local Install)[edit]

When installing on Ubuntu Server 16.04.3 LTS, the following configuration was needed instead:

$wgElectronPdfServiceRESTbaseURL = "http://HOSTFQDN:3000/pdf?accessKey=secret&url=http://HOSTFQDN/wiki/";

The /wiki/ is the Apache rewrite URL as this installation mimics the generic variation of re-writing. Change to whatever you use! Yes, hardcoding can be bad, but variables refused to work otherwise.

Usage[edit]

  • Once the extension is installed, the "Download as PDF" link in the MediaWiki sidebar will lead you to a new selection screen.
  • On the selection screen you can then choose whether you want to render your PDF using Electron ("Single Column") or using the old OCG/LaTeX renderer ("Two Column").
  • After you've chosen the desired rendering method, click the "Download" button to get the PDF.
  • Note: if there is no alternative rendering method available on the Wiki, "Download as PDF" will immediately serve you the Electron rendered PDF without showing a selection screen.

Links[edit]

See also[edit]