From b067aeabfd1acb5972657d74e80df47c4a64970f Mon Sep 17 00:00:00 2001 From: Derek Date: Thu, 3 Jul 2014 15:59:27 -0500 Subject: [PATCH] Update README.md Added WebSettings documentation --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index a66f4a8..06f5955 100644 --- a/README.md +++ b/README.md @@ -115,6 +115,26 @@ converter.Finished += OnFinished; byte[] result = converter.Convert(document); ``` +## Options + +### How to read this section + +This section spells out each settings class, a description for each possible setting, and the default values TuesPechkin and wkhtmltopdf uses. There are differences in the defaults which may affect rendering. The defaults may be normalized to match that of wkhtmltopdf in a future version. + +#### WebSettings + +Setting | Description | TuesPechkin default | wkhtmltopdf default +--------|-------------|---------------------|-------------------- +DefaultEncoding|(string) Default encoding used to render the HTML|`"utf-8"`|`""` +EnableIntelligentShrinking|(bool) Whether or not to enable intelligent compression of content to fit in the page|`true`|`true` +EnableJavascript|Whether or not to enable JavaScript|`true`|`true` +EnablePlugins|Whether to enable plugins (maybe like Flash? unsure)|`false`|`false` +LoadImages|Whether or not to load images|`true`|`true` +MinimumFontSize|The minimum font size to use|`-1`|`-1` +PrintBackground|Whether or not to print the background on elements|`true`|`true` +PrintMediaType|Whether to print the content using the print media type instead of the screen media type|`true`|`false` +UserStyleSheet|Path to a user specified style sheet|`""`|`""` + License -------