VersaType ConverterはHTML/CSSからPDFを一括生成するソフトウェアです。
【重要】製品名変更に伴う注意点
バージョン2018.5より、製品名を従来のVivliostyle FormatterからVersaType Converterに変更いたしました。それに伴い、実行ファイルの名前も以下のように変更されています。外部のスクリプトから呼び出している場合などは、呼び出し側の修正が必要になりますのでご注意ください。
旧実行ファイル名 | 新実行ファイル名 |
---|---|
vivliostyle-formatter(.bat) |
versatype-converter(.bat) |
vivliostyle_formatter_core(.exe) |
versatype_converter_core(.exe) |
また、2018.5以降のバージョンへのアップデートの際には、ライセンスファイルの指定が再度必要です。ライセンスファイルの指定に記載の手順を実行してください。ライセンスファイルは、アップデート前にご提供しているものをそのままご使用ください。
バージョン2.0での追加・変更点
前バージョンからの変更点は以下の通りです。 また、VersaType Core 2.0を組み込んであるので、その追加・変更・修正点も反映されています。
修正
以下の問題を修正しています。
- (Linux版のみ) 複数Converterの同時実行時にエラーが発生する場合がある
- 一部の文字コードがPDF上で化ける場合がある
新機能追加・変更
以下の新機能追加・変更を行なっています。
- OpenType(CFF)フォント埋め込みに対応しました
- Chromium Embedded Frameworkをアップデートしました(Chromium 69相当)
- 縦書きの場合に、PDFファイルに適切な綴じ方向を設定するようになりました(Issue #49)
- PDFのページサイズ(MediaBox)の精度を向上しました(Issue #50, Issue #51)
- PDFにTrimBox、BleedBoxの情報を設定するようになりました
実験的機能
以下の機能は実験的なため、デフォルトでは有効になりません。有効にする方法についてはオプションをご覧ください。
- OpenType(CFF)フォントの、使われていないグリフを削除する実験的な機能を追加
動作環境
- OS X/macOS 10.10〜10.13
- Windows 7, Windows 8, Windows 10
- Linux 64bit (x86_64/amd64)
- Ubuntu 16.04.3 LTS 以上
- CentOS 7
- RedHat Enterprise Linux 7
- Amazon Linux 2
インストール方法
Windows版
versatype-converter-2.0-win-64/versatype/versatype-converter.bat
がプログラム本体です。
他のスクリプトやアプリケーションから呼び出すときは、versatype-converter-2.0-win-64/versatype/versatype_converter_core.exe
を呼び出してください。
macOS 版
versatype-converter-2.0-mac/install.sh
を実行することでインストールできます。
インストールせずに、versatype-converter-2.0-mac/versatype/versatype-converter
を直接呼び出すこともできます。
Linux版
deb
パッケージ・rpm
パッケージ・tar.gz
で提供しています。
Ubuntuではdeb
パッケージを、CentOS・RHEL・Amazon Linuxではrpm
パッケージからのインストールをお勧めします。依存する関連ライブラリが自動的にインストールされます。
X serverについて
- versatype-converterをLinuxで実行するには X11 display serverが必要です。
- Xvfbがインストールされていれば自動的に利用します。
- ヘッドレスサーバではXvfbが必要です。
Xvfbインストール: Ubuntu
sudo apt-get install xvfb
Xvfbインストール: RHELまたはCentOS
RHELでは、optional rpm channelを追加する必要があります。
sudo subscription-manager repos --enable rhel-7-server-optional-rpms
AWS EC2上のRHELでは、次のようにoptional rpm channelを追加します。
sudo yum-config-manager --enable rhui-REGION-rhel-server-optional
sudo yum install xorg-x11-server-Xvfb
Xvfbインストール: Amazon Linux 2
sudo yum install Xvfb
Linux版: deb
sudo dpkg -i versatype-converter-2.0-linux-deb/versatype-converter-2.0-amd64.deb
依存関係の問題が起きた場合は、続けて以下も実行します。
sudo apt-get -f install
Linux版: rpm
sudo yum install versatype-converter-2.0-linux-rpm/versatype-converter-2.0.x86_64.rpm
Linux版 : tar gz
versatype-converter-2.0-linux/versatype/versatype-converter
がプログラム本体です。
配布物は実行形式と直接利用するライブラリのみです。依存するshared libraryがシステムにあらかじめインストールされていることを前提にしています。もしあなたのシステムがdeb
やrpm
をサポートしているなら、tar.gz
よりもそちらの利用をお勧めします。
ライセンスファイルの指定
ライセンスファイルを指定し、コマンドラインから以下を実行してください。
versatype-converter --license=<ライセンスファイルへのファイルパス>
指定されたライセンスファイルの情報は、versatype-converter
のインストールディレクトリ内に格納されます。
使い方
コマンドラインから利用します。
versatype-converter ソース(ファイルまたはURL) [options]
ソースファイルにはHTMLまたはEPUBが指定できます(EPUBのURLは指定できません)。
- ログはカレントディレクトリの
versatype_converter.log
に出力されます。--log-dir
が指定されている場合はそのディレクトリに出力されます。 - JavaScriptのconsole logはカレントディレクトリの
console.log
に出力されます。--log-dir
が指定されている場合はそのディレクトリに出力されます。
利用例
指定したURLのHTMLを、B5サイズ横でPDFに変換します。
versatype-converter https://trimmarks.github.io/samples/public/gutenberg/Alice.html --page-size=JIS-B5 --landscape
環境変数
- VC_WIN_NO_CONSOLE
- trueをセットすると、コンソール出力を抑制します。 (Windowsのみ; 出力をファイルなどにリダイレクトするときに利用します)
オプション
size
, width
と height
は@page
ルールのsize
プロパティの値として使われます。もし入力した文書のスタイルシートでsize
がすでに指定されている場合、これらのオプションは無視されます。
- --output=output-path
- 出力先ファイルパス。デフォルトはversatype-output.pdf
- --log-dir=log-dir
- ログの出力先。デフォルトはカレントディレクトリ
- --page-size=size
- 出力用紙サイズ。次のいずれかの値: A3, A4, A5, B4, B5, JIS-B4, JIS-B5, letter, legal, ledger. デフォルトはA4。widthとheightが指定されている場合は無視される。
- --width=width
- 出力用紙サイズの幅。例: 210mm。
- --height=height
- 出力用紙サイズの高さ。例: 297mm。
- --landscape
- page-sizeとともに指定したとき、用紙の向きをランドスケープにする。
- --style=stylesheet
- ユーザスタイルシートのURLまたはファイルを指定する。
- --author-style=stylesheet
- オーサースタイルシートのURLまたはファイルを指定する。
- --verbose
- 詳細ログを出力する。
- --license[=license file]
- ライセンスファイルをImportする。またはImportされているライセンスを表示する。
- --with-bookmarks
- cssのbookmarksにしたがって、PDFしおりを書き込む。
- --bookmarks-zoom=type
- PDFしおりの倍率を指定する。次のいずれかの値:inherit, fit-width, fit-visible, page. デフォルトはinherit。
- --disable-page-box
- MediaBoxの精度向上およびTrimBox、BleedBoxの設定を無効にします。通常は指定する必要はありません。
- --disable-replace-kangxi-radicals
- 康熙部首の文字コード置き換え機能を無効にします。このオプションを使用すると、一部の文字コードがPDF内で化ける場合があります。通常は指定する必要はありません。
- --enable-cff-shrink
- OpenType(CFF)フォントの使われていないグリフを削除し、PDFサイズを縮小する実験的機能を有効にします。
- --disable-page-progression-direction
- PDFの綴じ方向設定を無効にします。通常は指定する必要はありません。
- --compat-layout
- 旧バージョンと互換性のあるレイアウトを利用する。(ほとんどの場合、このオプションの指定は必要ありません)
- --initial-page-number=value
- 最初の文書の最初のページのpage-based counterが、指定した値にセットされる。
- --input-file=file
- ファイルから入力リスト(ファイル名、URL)を読み込む。
--input-file
で、複数のファイルやURIを指定できます。
ページ番号に関するパラメータを、各ファイルやURIに次のように指定できます。
<URI or path> startPage:<integer>
<URI or path> skipPagesBefore:<integer>
startPage:
設定された場合、対象のドキュメントの最初のページで、page-based counterが指定された値になります。--initial-page-number
オプションが指定された場合、最初の文書に対するこの指定は無視されます。
skipPagesBefore:
設定された場合、page-based counterは指定された値だけ増加します。
サードパーティーライセンス
VersaType Converterは以下のコンポーネントを含んでいます。
- Chromium Embedded Framework
- BSD License
- MathJax
- Apache License 2.0
- lopdf
- MIT License