src/plugins/litehtml_viewer/litehtml/README.md

   1 #What is litehtml?\r
   2 \r
   3 **litehtml** is the lightweight HTML rendering engine with CSS2/CSS3 support. Note, **litehtml** itself does not draw any text, pictures or other graphics and **litehtml** does not depend of any image/draw/font library. You are free to use any library to draw images, fonts and any other graphics. **litehtml** just parses HTML/CSS and places the HTML elements into right position (renders HTML). To draw the html elemens you have to implement the simple callback interface [document_container](https://github.com/litehtml/litehtml/wiki/document_container). This interface is really simple, check it! Note, the [document_container](https://github.com/litehtml/litehtml/wiki/document_container) implementation is required to render HTML correctly. \r
   4 \r
   5 #Where litehtml can be used\r
   6 \r
   7 **litehtml** can be used when you need to show the html-formated texts or even to create a mini-browser, but the using full-featured html engine is not possible. Usually you don't need something like WebKit to show some html tooltips or html-formated text, **litehtml** is much better for these.\r
   8 \r
   9 ##HTML Parser\r
  10 \r
  11 **litehtml** uses the [gumbo-parser](https://github.com/google/gumbo-parser) to parse HTML. Gumbo is an implementation of the HTML5 parsing algorithm implemented as a pure C99 library with no outside dependencies. It's designed to serve as a building block for other tools and libraries such as linters, validators, templating languages, and refactoring and analysis tools.\r
  12 \r
  13 ##Compatibility\r
  14 \r
  15 **litehtml** is compatible with any platform suported C++ and STL. For Windows the MS Visual Studio 2013 is recommended. **litehtml** supports both utf-8 and unicode strings on Windows and utf-8 strings on Linux.\r
  16 \r
  17 ##Support for HTML and CSS standards\r
  18 \r
  19 Unfortunately **litehtml** is not fully compatible with HTML/CSS standards. There are lots of work to do to make **litehtml** as well as modern browsers. But **litehtml** supports most HTML tags and CSS properties. You can find the list of supported CSS properties in  [this table](https://docs.google.com/spreadsheet/ccc?key=0AvHXl5n24PuhdHdELUdhaUl4OGlncXhDcDJuM1JpMnc&usp=sharing). In the most cases the html/css features supported by **litehtml** are enough. Right now **litehtml** supports the pages with very complex html/css designs. As example the pages created with [bootstrap framework](http://getbootstrap.com/) are usually well formated by **litehtml**.\r
  20 \r
  21 ##Testing litehtml\r
  22 \r
  23 You can [download the simple browser](http://www.litehtml.com/download.html) (**litebrowser**) to test the **litehtml** rendering engine. \r
  24 \r
  25 The litebrowser source codes are available on GitHub:\r
  26   * [For Windows](https://github.com/tordex/litebrowser)\r
  27   * [For Linux](https://github.com/tordex/litebrowser-linux)\r
  28 \r
  29 ##License\r
  30 \r
  31 **litehtml** is distributed under [New BSD License](http://opensource.org/licenses/BSD-3-Clause).\r
  32 The **gumbo-parser** is disributed under [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)\r
  33 \r
  34 ##Support litehtml project\r
  35 \r
  36 If you think litehtml is amazing please consider a small donation:\r
  37 \r
  38 [ ![PayPal](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif) ](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=UHBQG6EAFCRBA)\r
  39 \r
  40 Bitcoin: **1CS1174GVSLbP33TBp8RFwqPS6KmQK6kLY**\r
  41 \r
  42 ![BitCoin](https://www.tordex.com/assets/images/litehtml-bitcoin.png)\r