4d-plugin-HTMLTOX

4D implementation of wkhtmltopdf

Deprecated! Use 4d-component-wkhtmltopdf instead.

Platform

carbon	cocoa	win32	win64

Version

Based on wkhtmltopdf 0.12.2.3.

Syntax

document:=HTML Convert(sources;format;optionNames;optionValues)

Parameter	Type	Description
sources	ARRAY TEXT	URL (`http:`, `https:`, `ftp:`, `file:`), path, HTML
format	LONGINT	`HTMLTOX Format PDF`, `HTMLTOX Format PS`, `HTMLTOX Format PNG`, `HTMLTOX Format JPG`, `HTMLTOX Format BMP`. `HTMLTOX Format SVG`
optionNames	ARRAY TEXT	http://wkhtmltopdf.org/libwkhtmltox/
optionValues	ARRAY TEXT	http://wkhtmltopdf.org/libwkhtmltox/
document	BLOB	PDF or image

Quick Download

Mac-0.12.4 font size is about 25% but the program can process unicode paths

Mac+Windows-MinGW

Mac+Windows-VC

Examples

HTML to PDF

$path:=Get 4D folder(Database folder)+\
"Plugins"+Folder separator+\
"HTMLTOX.bundle"+Folder separator+\
"Contents"+Folder separator+\
"Resources"+Folder separator+\
"Documentation"+Folder separator+\
"index.html"

  //3 ways to provide source
ARRAY TEXT($html;3)
$html{1}:="http://wkhtmltopdf.org/"  //a: URL
$html{2}:=Document to text($path)  //b: HTML source code
$html{3}:=$path  //c: path of HTML

  //for full list of keys, see http://wkhtmltopdf.org/libwkhtmltox/
ARRAY TEXT($optionKeys;0)
ARRAY TEXT($optionValues;0)
  //special consideration: for per-object (page) settings, 
  //prefix the key with an element number corresponding to the array of htmls.
  //e.g. "size.paperSize" this is a global setting
  //"1:toc.useDottedLines" this is a per-object setting for $html{1}

APPEND TO ARRAY($optionKeys;"size.paperSize")
APPEND TO ARRAY($optionValues;"A4")

APPEND TO ARRAY($optionKeys;"orientation")
APPEND TO ARRAY($optionValues;"Landscape")

$resultBlob:=HTML Convert ($html;HTMLTOX Format PDF;$optionKeys;$optionValues)

$path:=Temporary folder+Generate UUID+".pdf"

BLOB TO DOCUMENT($path;$resultBlob)

OPEN WEB URL($path)

HTML to PNG, BMP, JPG, SVG

ARRAY TEXT($html;1)  //only the first element is used for image
$html{1}:="http://wkhtmltopdf.org/"

  //for full list of keys, see http://wkhtmltopdf.org/libwkhtmltox/
ARRAY TEXT($optionKeys;0)
ARRAY TEXT($optionValues;0)

$resultBlob:=HTML Convert ($html;HTMLTOX Format PNG;$optionKeys;$optionValues)
$path:=Temporary folder+Generate UUID+".png"
BLOB TO DOCUMENT($path;$resultBlob)
OPEN URL($path)

$resultBlob:=HTML Convert ($html;HTMLTOX Format SVG;$optionKeys;$optionValues)
$path:=Temporary folder+Generate UUID+".svg"
BLOB TO DOCUMENT($path;$resultBlob)
OPEN URL($path)

$resultBlob:=HTML Convert ($html;HTMLTOX Format BMP;$optionKeys;$optionValues)
$path:=Temporary folder+Generate UUID+".bmp"
BLOB TO DOCUMENT($path;$resultBlob)
OPEN URL($path)

$resultBlob:=HTML Convert ($html;HTMLTOX Format JPG;$optionKeys;$optionValues)
$path:=Temporary folder+Generate UUID+".jpg"
BLOB TO DOCUMENT($path;$resultBlob)
OPEN URL($path)

To set per-page option, prepend the option name by its source number (1-based).

~~The plugin processes the source array from element number 0, so to specify an option for a single source~~.

ARRAY TEXT($optionKeys;0)
ARRAY TEXT($optionValues;0)

ARRAY TEXT($html;1)
$html{1}:=System folder(Desktop)+"source.html"

APPEND TO ARRAY($optionKeys;"1:web.printMediaType")
APPEND TO ARRAY($optionValues;"true")

$resultBlob:=HTML Convert ($html;HTMLTOX Format PDF;$optionKeys;$optionValues)
$dstPath:=Temporary folder+Generate UUID+".pdf"
BLOB TO DOCUMENT($dstPath;$resultBlob)
OPEN URL($dstPath)

History

v3.0

Callback feature is deprecated.

You can pass file path, URL or raw HTML as source.

The helper app is launched per process and stays running for the lifetime of that process.

libwkhtmltox is no longer linked as a dylib; instead, a command line program is invoked internally.

TODO: ~~Check caller process ID so that multiple instances of 4D can use the plugin.~~ done in 3.0

Remarks

~~When used on a Mac client connected to Windows server, the executable bit of the helper app may be lost. You might need to use chmod locally on the helper app's executable file.~~

The plugin now changes the bits internally.

miyako / 4d-plugin-htmltox Goto Github PK