Jump to content

Extension:ElectronPdfService

From mediawiki.org
MediaWiki extensions manual
ElectronPdfService
Release status: stable
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 backward compatible.
MediaWiki >= 1.43
Database changes No
License GNU General Public License 2.0 or later
Download
Example Wikipedia article
  • $wgElectronPdfServiceRESTbaseURL
Quarterly downloads 30 (Ranked 103rd)
Public wikis using 857 (Ranked 301st)
Translate the ElectronPdfService extension if it is available at translatewiki.net
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.

Description

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.

Installation

  • Install Proton
  • Install RESTBase, and set up a config similar to config.example.wikimedia.yaml. Adjust the PDF server URL to reflect your host & port.
  • Download and move the extracted ElectronPdfService folder to your extensions/ directory.
    Developers and code contributors should install the extension from Git instead, using:cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/ElectronPdfService
  • Add the following code at the bottom of your LocalSettings.php file:
    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.

Usage

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

See also