Extension:ElectronPdfService

MediaWiki-Erweiterungen

ElectronPdfService Erscheinungsstatus: stabil
Einbindung	User interface
Beschreibung	Provides access to the Electron Service for browser-based PDF rendering
Autor(en)	Wikimedia Germany (WMDE) – Roadmap
Letzte Version	continuous updates
Kompatibilitätspolitik	Release-Zweige
MediaWiki	1.25+
Datenbankänderungen	Nein
Lizenz	GNU General Public License 2.0 or later
Herunterladen	Download extension Git [?]: Git master herunterladen Repository durchsuchen (GitHub) commit history Code-Review
Beispiel	Wikipedia article
Verwendete Hooks SidebarBeforeOutput BeforePageDisplay
Übersetze die ElectronPdfService Erweiterung wenn sie auf translatewiki.net verfügbar ist
Prüfe die Benutzungs- und Versionsmatrix.
Probleme	Offene Aufgaben · Einen Fehler melden

Die ElectronPdfService Erweiterung erlaubt es Artikel mittels des Electron Service als PDF anzuzeigen.

Beschreibung

Die Erweiterung erlaubt eine einfache Nutzung des Electron Service mittels einer REST-basierten Schnittstelle. Der Electron Service bietet eine alternative PDF-Rendering-Methode für Artikel als Alternative zur existierenden OCG/LaTeX Methode. Der Vorteil der Electron-Methode ist, dass auch Tabellen sowie Infoboxen und andere Templates gerendert und im PDF inkludiert werden können, was mit der bisherigen Methode nicht möglich war. Mehr Informationen darüber, welche Motivation hinter der Entwicklung der Erweiterung und des Service steckt, gibt es hier.

Hier ein Beispiel: PDF des Artikels über Claude Monet

Installation

• Install and configure an Electron Service exposed over a RESTBase API endpoint
  • Follow the service install instructions & verify correct functioning with http://your-host:port/pdf?accessKey=your-key&url=article-url
  • Install RESTBase, and set up a config similar to config.example.wikimedia.yaml. Adjust the PDF server URL to reflect your host & port.
• Lade die Erweiterung herunter und lege die Datei(en) in ein Verzeichnis namens ElectronPdfService in deinem Ordner extensions/ ab.

• Füge folgenden Code am Ende deiner LocalSettings.php hinzu:

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

•  Erledigt – Navigiere zu Special:Version in deinem Wiki (bei Einstellung auf deutsch nach Spezial:Version), um zu prüfen, dass die Erweiterung erfolgreich installiert ist.

Ubuntu 16.04.3 (Local Install)

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.

Verwendung

• Wenn die Erweiterung aktiv ist, führt der "Als PDF herunterladen" Link in der Seitenleiste zu einer Auswahlseite.

• Auf dieser Auswahlseite kann ausgewählt werden, ob das PDF mittels Electron oder mittels der bisherigen OCG/LaTeX Methode generiert werden soll.

• Nach der Auswahl kann per "Herunterladen" Knopf das PDF heruntergeladen werden.

• Anmerkung: sollte auf dem entsprechenden Wiki keine alternative Rendering-Methode für PDFs vorhanden sein, wird das mittels Electron Service generierte PDF bei einem Klick auf "Als PDF herunterladen" sofort geladen ohne dass ein Auswahlbildschirm angezeigt wird.

Weblinks

• Dokumentation des Electron Service (Englisch)
• Dokumentation zur REST-basierten Schnittstelle (Englisch)
• Dokumentation zu OCG/Latex (Englisch)
• Beispiel-PDF

• RESTBase API documentation
• OCG documentation
• Example PDF

See also

• PDF export – summary of all PDF export extensions