MediaWiki extensions manual

ElectronPdfService Release status: stable
Implementation	User interface
Description	Provides access to theProton 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 backward compatible.
Database changes	No
License	GNU General Public License 2.0 or later
Download	Download extension Git[?]: Browse repository (GitHub) Gerrit code review Git commit log Download source tarball
Example	Wikipedia article
Parameters $wgElectronPdfServiceRESTbaseURL
Hooks used SidebarBeforeOutput
Translate the ElectronPdfService extension if it is available at translatewiki.net
Issues	Open tasks ·Report a bug

TheElectronPdfService extension provides access to theProton 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.

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

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

• InstallProton
• InstallRESTBase, and set up a config similar toconfig.example.wikimedia.yaml. Adjust the PDF server URL to reflect your host & port.
• Download and move the extractedElectronPdfService folder to yourextensions/ directory.
  Developers and code contributors should install the extensionfrom Git instead, using:

  cdextensions/gitclonehttps://gerrit.wikimedia.org/r/mediawiki/extensions/ElectronPdfService

• Add the following code at the bottom of yourLocalSettings.php file:

  wfLoadExtension('ElectronPdfService');$wgElectronPdfServiceRESTbaseURL='/api/rest_v1/page/pdf/';

• Done – Navigate toSpecial:Version on your wiki to verify that the extension is successfully installed.

• 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.

• RESTBase API documentation
• Example PDF

• PDF export – summary of all PDF export extensions
• Read more on thebackground of the motivation for the extension and the service.

This extension is being used on one or moreWikimedia projects. This probably means that the extension is stable and works well enough to be used by such high-traffic websites. Look for this extension's name in Wikimedia'sCommonSettings.php andInitialiseSettings.php configuration files to see where it's installed. A full list of the extensions installed on a particular wiki can be seen on the wiki'sSpecial:Version page.

This extension is included in the following wiki farms/hosts and/or packages: WikiForge This is not an authoritative list. Some wiki farms/hosts and/or packages may contain this extension even if they are not listed here. Always check with your wiki farms/hosts or bundle to confirm.

• Stable extensions
• User interface extensions
• GPL licensed extensions
• Extensions in Wikimedia version control
• SidebarBeforeOutput extensions
• All extensions
• PDF extensions
• Extensions used on Wikimedia
• Extensions included in WikiForge

• Extensions with release branches compatibility policy