Extension:ElectronPdfService

Other languages:
Deutsch • ‎English • ‎Türkçe • ‎français • ‎português do Brasil • ‎русский • ‎中文 • ‎日本語
The information on this page is partially outdated, as the Electron service has been superseded by the Proton service. See phab:T247310.
MediaWiki extensions manual
OOjs UI icon advanced.svg
ElectronPdfService
Release status: stable
ElectronPdfService-mockup.png
Implementation User interface
Description Provides access to the Proton service for browser-based PDF rendering
Author(s) Wikimedia Germany (WMDE) – Roadmap
Latest version continuous updates
Compatibility policy Snapshots releases along with MediaWiki. Master is not backwards compatible.
MediaWiki 1.25+
MediaWiki 1.36 Not formally tested
MediaWiki 1.34 Not formally tested
MediaWiki 1.32 Not formally tested
Database changes No
License GNU General Public License 2.0 or later
Download
Example Wikipedia article
  • $wgElectronPdfServiceRESTbaseURL
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 Proton service for browser-based PDF rendering. (Proton needs to be installed separately.)

Historically, this extension provided access to the now defunct Electron PDF Service instead of Proton, hence its name.

DescriptionEdit

The extension provides a handy way to access the Proton service via a RESTBase API endpoint .

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

InstallationEdit

  • Install Proton
  • Download and place the file(s) in a directory called ElectronPdfService in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
    wfLoadExtension( 'ElectronPdfService' );
    $wgElectronPdfServiceRESTbaseURL = '/api/rest_v1/page/pdf/';
    
  •   Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

UsageEdit

  • Once the extension is installed, the “⧼ElectronPdfService-download-label⧽” link in the MediaWiki sidebar will lead you to a new selection screen.
  • Click the “⧼ElectronPdfService-download-button⧽” button to get the PDF.
  • Note: if there is no alternative rendering method available on the Wiki, “⧼ElectronPdfService-download-label⧽” will immediately serve you the Proton rendered PDF without showing a selection screen.

LinksEdit

See alsoEdit

  • PDF export – summary of all PDF export extensions