Extension:ElectronPdfService

The information on this page is partially outdated. See phab:T247310.

MediaWiki 拡張機能マニュアル

ElectronPdfService リリースの状態: 安定
実装	ユーザー インターフェイス
説明	ブラウザベースの PDF レンダリング機能エレクトロン・サービスにアクセスを提供
作者	Wikimedia Germany (WMDE) – Roadmap
最新バージョン	continuous updates
互換性ポリシー	リリースブランチ
MediaWiki	1.25+
データベースの変更	いいえ
ライセンス	GNU 一般公衆利用許諾書 2.0 以降
ダウンロード	拡張機能をダウンロード Git [?]: Git master をダウンロード リポジトリを参照 (GitHub) コミット履歴 repository contributors (GitHub) コード レビュー
例	Wikipedia article
パラメーター $wgElectronPdfServiceRESTbaseURL
使用するフック BeforePageDisplay SidebarBeforeOutput
translatewiki.net で翻訳を利用できる場合は、ElectronPdfService 拡張機能の翻訳にご協力ください
使用状況とバージョン マトリクスを確認してください。
問題点	未解決のタスク · バグを報告

ElectronPdfService 拡張機能はブラウザベースの PDF レンダリング機能エレクトロン サービスにアクセスを提供します。 (The Electron Service needs to be installed separately.)

説明

この拡張機能はRESTBase APIの接続ポイント を通じてエレクトロン サービスにアクセスするための便利な方法を提供します。 エレクトロン サービスはウィキページの内容をPDFファイルに変換する新たな手法で、既存のOCG/LaTeX を使った変換に代わるものです。 生成された PDF ファイルには基礎情報ボックスやその他のテンプレートだけでなくすべてのテーブルまでを含むことができるのが、エレクトロン サービスを使う大きな利点です。 より詳しくはこの拡張機能とサービスを開発する動機付けとなった背景をご覧ください。

事例を紹介します。「Berlin」の記事から生成した PDF。

インストール

• RESTBase APIの接続ポイントで公開されているエレクトロン・サービスをインストールし、設定する。
  • 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.
• ダウンロードして、ファイルを extensions/ フォルダー内の ElectronPdfService という名前のディレクトリ内に配置します。
• 以下のコードを LocalSettings.php の末尾に追加します:

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

•  完了 – ウィキの「Special:Version」に移動して、拡張機能が正しくインストールされたことを確認します。

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.

使用法

• 拡張機能のインストールが完了すると MediaWiki のサイドバーにできた「⧼ElectronPdfService-download-label⧽」のリンクから、新しい窓が開きます。
• PDF の出力にエレクトロンを利用するか (「1段組」) もしくは旧来のレンダリング機能OCG/LaTeX (「2段組」) を使うか選択します。
• 使いたい方式を選んだら「⧼ElectronPdfService-download-button⧽」ボタンを押して PDF を出力します。
• 注：ウィキにレンダリング方式の選択肢がない場合は「⧼ElectronPdfService-download-label⧽」ボタンを押すと出力書式の選択画面を表示せず、エレクトロンで PDF を生成します。

リンク

• エレクトロン・サービスの説明文書
• RESTBase API 説明文書
• OCG 説明文書
• PDF の例

関連項目

• PDF export – summary of all PDF export extensions