Extension: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. |
| Database changes | No |
| License | GNU General Public License 2.0 or later |
| Download | |
| Example | Wikipedia article |
|
|
| Quarterly downloads | 23 (Ranked 106th) |
| 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
[edit]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
[edit]
- 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
ElectronPdfServicefolder to yourextensions/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/';
Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.
Usage
[edit]- 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.
Links
[edit]See also
[edit]- PDF export – summary of all PDF export extensions
- Read more on the background of the motivation for the extension and the service.
 | This extension is being used on one or more Wikimedia 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's CommonSettings.php and InitialiseSettings.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's Special:Version page. |
 | This extension is included in the following wiki farms/hosts and/or packages: 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. |