Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Added WebSettings documentation
  • Loading branch information
tuespetre committed Jul 3, 2014
1 parent 18ef29c commit b067aea
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
-------

Expand Down

0 comments on commit b067aea

Please sign in to comment.