pdf2htmlEX/README.md

# pdf2htmlEX 

[![Build Status](https://travis-ci.org/coolwanglu/pdf2htmlEX.png?branch=master)](https://travis-ci.org/coolwanglu/pdf2htmlEX)

A beautiful demo is worth a thousand words:

- [**Typography**](http://coolwanglu.github.com/pdf2htmlEX/demo/geneve.html) [Original](https://github.com/raphink/geneve_1564/raw/master/geneve_1564.pdf)
- [**Full Circle Magazine(large)**](http://coolwanglu.github.com/pdf2htmlEX/demo/issue65_en.html) [Sample](http://coolwanglu.github.com/pdf2htmlEX/demo/issue65_en_sample.html) [Original](http://dl.fullcirclemagazine.org/issue65_en.pdf)
- [**Formulas**](http://coolwanglu.github.com/pdf2htmlEX/demo/cheat.html) [Original](http://www.tug.org/texshowcase/cheat.pdf)
- [**Scientific Paper**](http://coolwanglu.github.com/pdf2htmlEX/demo/demo.html) [Original](http://citeseerx.ist.psu.edu/viewdoc/download?doi=10.1.1.148.349&rep=rep1&type=pdf)
- [**Chinese**](http://coolwanglu.github.com/pdf2htmlEX/demo/chn.html) [Original](http://files.cnblogs.com/phphuaibei/git%E6%90%AD%E5%BB%BA.pdf)
- Try your own files: [MediaFire](http://www.mediafire.com), a free online storage service, now uses pdf2htmlEX for its PDF preview feature.

## Introduction

pdf2htmlEX renders PDF files in HTML, utilizing modern Web technologies.
It aims to provide an accuracy rendering, while keeping optimized for Web display.

pdf2htmlEX is best for text-based PDF files, for example scientific papers with complicated formulas and figures.
Text, fonts and formats are natively perserved in HTML such that you can still search and copy.
The generated HTML file is static, Javascript is not required.

[More info](https://github.com/coolwanglu/pdf2htmlEX/wiki/Introduction)

## Features

* Optional single HTML file output
* Precise rendering 
* Native text in HTML - you can select & copy & search
* Proper styling 
  - Font - extracted and reencoded
  - Color
  - Transformation
* Links
* Outline
* [EXPERIMENTAL] Path drawing with CSS
  - Orthogonal lines
  - Rectangles
  - Linear gradients 
* Not fully supported (Rendered as images)
  - Type 3 fonts
  - Non-text object

## Get started

### Install
 
Thanks to all packagers!

  * [Ubuntu PPA](https://launchpad.net/~coolwanglu/+archive/pdf2htmlex) by Lu Wang <coolwanglu@gmail.com>, not always up-to-date.
  * [ArchLinux AUR](https://aur.archlinux.org/packages.php?ID=62426) by Arthur Titeica <arthur.titeica@gmail.com>
  * [Gentoo Overlay](http://gpo.zugaina.org/app-text/pdf2htmlex), gentoo-zh, mrueg or sunrise, by respective packagers.  
  * [Homebrew Formula](https://github.com/jamiely/homebrew/blob/pdf2htmlex/Library/Formula/pdf2htmlex.rb) by Jamie Ly <me@jamie.ly>
  * [Macports (local repo)](https://github.com/iapain/pdf2htmlEX-macport) by Deepak Thukral <iapain@iapa.in>
  * Windows [N/A](https://github.com/coolwanglu/pdf2htmlEX/wiki/FAQ#wiki-install-windows)

### Build from source

#### Dependency

* CMake, pkg-config
* GNU Getopt
* compilers support C++11, for example
 * GCC >= 4.4.6
 * I heard about successful build with Clang 
* **poppler** with xpdf header >= 0.20.0 (compile with **--enable-xpdf-headers**)
 * Install **libpng** (and headers) BEFORE you compile poppler if you want background images generated
 * Install **poppler-data** if your want CJK support
* **fontforge** (with header files)
 * git version is recommended to avoid annoying compilation issues
* [Optional] **ttfautohint**
 * run pdf2htmlEX with **--external-hint-tool=ttfautohint** to enable it
* [For Windows]
 * Cygwin 
 * or MinGW, with some modifications to pdf2htmlEX. See [pdf2htmlEX on TeX Wiki](http://oku.edu.mie-u.ac.jp/~okumura/texwiki/?pdf2htmlEX) (in Japanese), special thanks to Haruhiko Okumura


#### Compiling

    git clone --depth 1 git://github.com/coolwanglu/pdf2htmlEX.git
    cd pdf2htmlEX
    cmake . && make && sudo make install

## Usage

    pdf2htmlEX /path/to/foobar.pdf
    pdf2htmlEX --help
    man pdf2htmlEX

## FAQ

* [Troubleshooting compilation errors](https://github.com/coolwanglu/pdf2htmlEX/wiki/FAQ#wiki-compile)
* [How can I help](https://github.com/coolwanglu/pdf2htmlEX/wiki/FAQ#wiki-help)
* [I want more features](https://github.com/coolwanglu/pdf2htmlEX/wiki/FAQ#wiki-feature_commission)
* [More about pdf2htmlEX](https://github.com/coolwanglu/pdf2htmlEX/wiki/)

## LICENSE

GPLv2 & GPLv3 Dual licensed

**pdf2htmlEX is totally free, please credit pdf2htmlEX if you use it**

**Please consider sponsoring it if you use it for commercial purpose**

**Font extraction, conversion or redistribution may be illegal, please check your local laws**

### [**Donate Now**](http://coolwanglu.github.com/pdf2htmlEX/donate.html)

## Contact

* Mailing list <pdf2htmlex@googlegroups.com>
  * You might want to try these useful resources first: `man pdf2htmlEX`, [wiki](https://github.com/coolwanglu/pdf2htmlEX/wiki) and [FAQ](https://github.com/coolwanglu/pdf2htmlEX/wiki/FAQ)

* Lu Wang <coolwanglu@gmail.com>
  * For personal enquiries only
  * Accepting messages in **Chinese**, **English** or **Japanese**.

## Acknowledge

pdf2htmlEX is made possible thanks to the following projects:

* [poppler](http://poppler.freedesktop.org/)
* [Fontforge](http://fontforge.org/)
* [jQuery](http://jquery.com/)

pdf2htmlEX is inspired by the following projects:

* pdftops & pdftohtml from poppler 
* MuPDF
* PDF.js
* Crocodoc
* Google Doc

### Special Thanks

* Hongliang Tian <tatetian@gmail.com>
* Wanmin Liu <wanminliu@gmail.com>
Travis CI status image in README 2013-01-25 13:11:27 +00:00			`# pdf2htmlEX`

Update README.md 2013-01-25 18:10:07 +00:00			`[![Build Status](https://travis-ci.org/coolwanglu/pdf2htmlEX.png?branch=master)](https://travis-ci.org/coolwanglu/pdf2htmlEX)`
READMe 2012-09-26 14:44:50 +00:00
update README 2012-09-07 17:50:18 +00:00			`A beautiful demo is worth a thousand words:`
update README 2012-08-04 18:25:47 +00:00
Update README.md 2012-10-10 19:41:58 +00:00			`- [Typography](http://coolwanglu.github.com/pdf2htmlEX/demo/geneve.html) [Original](https://github.com/raphink/geneve_1564/raw/master/geneve_1564.pdf)`
			`- [Full Circle Magazine(large)](http://coolwanglu.github.com/pdf2htmlEX/demo/issue65_en.html) [Sample](http://coolwanglu.github.com/pdf2htmlEX/demo/issue65_en_sample.html) [Original](http://dl.fullcirclemagazine.org/issue65_en.pdf)`
			`- [Formulas](http://coolwanglu.github.com/pdf2htmlEX/demo/cheat.html) [Original](http://www.tug.org/texshowcase/cheat.pdf)`
			`- [Scientific Paper](http://coolwanglu.github.com/pdf2htmlEX/demo/demo.html) [Original](http://citeseerx.ist.psu.edu/viewdoc/download?doi=10.1.1.148.349&rep=rep1&type=pdf)`
			`- [Chinese](http://coolwanglu.github.com/pdf2htmlEX/demo/chn.html) [Original](http://files.cnblogs.com/phphuaibei/git%E6%90%AD%E5%BB%BA.pdf)`
Update README.md 2013-01-31 18:03:27 +00:00			`- Try your own files: [MediaFire](http://www.mediafire.com), a free online storage service, now uses pdf2htmlEX for its PDF preview feature.`
update REAMD 2012-08-18 08:05:36 +00:00
update README 2012-08-28 09:56:37 +00:00			`## Introduction`
update README 2012-08-28 09:54:27 +00:00
Update README.md 2013-01-31 11:25:53 +00:00			`pdf2htmlEX renders PDF files in HTML, utilizing modern Web technologies.`
			`It aims to provide an accuracy rendering, while keeping optimized for Web display.`
initial import 2012-08-04 18:03:53 +00:00
Update README.md 2013-01-31 11:25:53 +00:00			`pdf2htmlEX is best for text-based PDF files, for example scientific papers with complicated formulas and figures.`
			`Text, fonts and formats are natively perserved in HTML such that you can still search and copy.`
			`The generated HTML file is static, Javascript is not required.`
update README 2012-08-28 09:54:27 +00:00
Update README.md 2013-01-31 13:06:34 +00:00			`[More info](https://github.com/coolwanglu/pdf2htmlEX/wiki/Introduction)`
Update README.md 2012-12-12 08:54:48 +00:00
update README 2012-08-28 09:56:37 +00:00			`## Features`
initial import 2012-08-04 18:03:53 +00:00
Update README.md 2012-12-12 08:54:48 +00:00			`* Optional single HTML file output`
update README 2012-08-07 12:16:05 +00:00			`* Precise rendering`
Update README.md 2013-01-31 16:38:48 +00:00			`* Native text in HTML - you can select & copy & search`
Update README.md 2012-12-12 08:54:48 +00:00			`* Proper styling`
			`- Font - extracted and reencoded`
			`- Color`
			`- Transformation`
READMe 2012-09-16 12:48:51 +00:00			`* Links`
readme 2013-01-28 13:59:06 +00:00			`* Outline`
README 2012-10-03 04:51:04 +00:00			`* [EXPERIMENTAL] Path drawing with CSS`
Update README.md 2012-12-12 08:54:48 +00:00			`- Orthogonal lines`
			`- Rectangles`
			`- Linear gradients`
readme 2013-01-28 13:59:06 +00:00			`* Not fully supported (Rendered as images)`
Update README.md 2012-12-12 08:54:48 +00:00			`- Type 3 fonts`
			`- Non-text object`
initial import 2012-08-04 18:03:53 +00:00
update README 2012-08-28 09:56:37 +00:00			`## Get started`
update README 2012-08-28 09:54:27 +00:00
update readme 2013-01-30 04:15:22 +00:00			`### Install`

			`Thanks to all packagers!`
Update README.md 2012-10-03 18:43:45 +00:00
update readme 2013-01-30 04:15:22 +00:00			`* [Ubuntu PPA](https://launchpad.net/~coolwanglu/+archive/pdf2htmlex) by Lu Wang <coolwanglu@gmail.com>, not always up-to-date.`
			`* [ArchLinux AUR](https://aur.archlinux.org/packages.php?ID=62426) by Arthur Titeica <arthur.titeica@gmail.com>`
			`* [Gentoo Overlay](http://gpo.zugaina.org/app-text/pdf2htmlex), gentoo-zh, mrueg or sunrise, by respective packagers.`
			`* [Homebrew Formula](https://github.com/jamiely/homebrew/blob/pdf2htmlex/Library/Formula/pdf2htmlex.rb) by Jamie Ly <me@jamie.ly>`
			`* [Macports (local repo)](https://github.com/iapain/pdf2htmlEX-macport) by Deepak Thukral <iapain@iapa.in>`
Update README.md 2013-01-31 16:06:26 +00:00			`* Windows [N/A](https://github.com/coolwanglu/pdf2htmlEX/wiki/FAQ#wiki-install-windows)`
README 2012-09-21 06:21:56 +00:00
update README 2012-08-29 23:42:53 +00:00			`### Build from source`
update README 2012-08-28 09:54:27 +00:00
update README 2012-08-28 09:56:37 +00:00			`#### Dependency`
.. 2012-08-28 10:27:45 +00:00
update README 2012-09-10 18:44:45 +00:00			`* CMake, pkg-config`
.. 2012-09-21 13:35:27 +00:00			`* GNU Getopt`
message about libintl.h on Mac 2012-09-17 17:32:27 +00:00			`* compilers support C++11, for example`
.. 2012-09-09 08:13:04 +00:00			`* GCC >= 4.4.6`
message about libintl.h on Mac 2012-09-17 17:32:27 +00:00			`* I heard about successful build with Clang`
Update README.md 2012-10-13 08:01:27 +00:00			`* poppler with xpdf header >= 0.20.0 (compile with --enable-xpdf-headers)`
			`* Install libpng (and headers) BEFORE you compile poppler if you want background images generated`
			`* Install poppler-data if your want CJK support`
			`* fontforge (with header files)`
.. 2012-09-21 13:35:27 +00:00			`* git version is recommended to avoid annoying compilation issues`
Update README.md 2012-10-13 08:01:27 +00:00			`* [Optional] ttfautohint`
			`* run pdf2htmlEX with --external-hint-tool=ttfautohint to enable it`
update readme 2013-01-30 04:15:22 +00:00			`* [For Windows]`
			`* Cygwin`
readme 2013-01-30 04:18:43 +00:00			`* or MinGW, with some modifications to pdf2htmlEX. See [pdf2htmlEX on TeX Wiki](http://oku.edu.mie-u.ac.jp/~okumura/texwiki/?pdf2htmlEX) (in Japanese), special thanks to Haruhiko Okumura`
update readme 2013-01-30 04:15:22 +00:00
initial import 2012-08-04 18:03:53 +00:00
update README 2012-08-28 09:56:37 +00:00			`#### Compiling`
.. 2012-08-28 10:27:45 +00:00
Update README.md 2012-12-25 09:10:38 +00:00			`git clone --depth 1 git://github.com/coolwanglu/pdf2htmlEX.git`
update README 2012-10-08 09:02:34 +00:00			`cd pdf2htmlEX`
background image embedding works now 2012-08-14 18:28:19 +00:00			`cmake . && make && sudo make install`
initial import 2012-08-04 18:03:53 +00:00
update README 2012-08-28 09:54:27 +00:00			`## Usage`
.. 2012-08-28 10:27:45 +00:00
update README 2012-08-28 09:54:27 +00:00			`pdf2htmlEX /path/to/foobar.pdf`
			`pdf2htmlEX --help`
Update README.md 2012-10-03 12:32:21 +00:00			`man pdf2htmlEX`
update README 2012-08-28 09:54:27 +00:00
tweaking font-size-multiplier and auto-hint 2012-09-21 10:12:14 +00:00			`## FAQ`

Update README.md 2012-10-03 12:32:21 +00:00			`* [Troubleshooting compilation errors](https://github.com/coolwanglu/pdf2htmlEX/wiki/FAQ#wiki-compile)`
Update README.md 2012-10-03 12:12:51 +00:00			`* [How can I help](https://github.com/coolwanglu/pdf2htmlEX/wiki/FAQ#wiki-help)`
			`* [I want more features](https://github.com/coolwanglu/pdf2htmlEX/wiki/FAQ#wiki-feature_commission)`
Update README.md 2013-01-31 13:02:08 +00:00			`* [More about pdf2htmlEX](https://github.com/coolwanglu/pdf2htmlEX/wiki/)`
tweaking font-size-multiplier and auto-hint 2012-09-21 10:12:14 +00:00
update README 2012-08-28 09:56:37 +00:00			`## LICENSE`
initial import 2012-08-04 18:03:53 +00:00
update License 2012-08-31 13:19:46 +00:00			`GPLv2 & GPLv3 Dual licensed`
initial import 2012-08-04 18:03:53 +00:00
license 2012-09-11 06:51:31 +00:00			`pdf2htmlEX is totally free, please credit pdf2htmlEX if you use it`

			`Please consider sponsoring it if you use it for commercial purpose`
README.md 2012-09-07 10:23:38 +00:00
README 2012-09-11 07:02:11 +00:00			`Font extraction, conversion or redistribution may be illegal, please check your local laws`
README.md 2012-09-07 10:23:38 +00:00
README 2012-10-08 08:50:42 +00:00			`### [Donate Now](http://coolwanglu.github.com/pdf2htmlEX/donate.html)`

readme 2013-01-30 04:21:57 +00:00			`## Contact`

Update README.md 2013-01-31 13:13:48 +00:00			`* Mailing list <pdf2htmlex@googlegroups.com>`
			* You might want to try these useful resources first: `man pdf2htmlEX`, [wiki](https://github.com/coolwanglu/pdf2htmlEX/wiki) and [FAQ](https://github.com/coolwanglu/pdf2htmlEX/wiki/FAQ)

			`* Lu Wang <coolwanglu@gmail.com>`
			`* For personal enquiries only`
readme 2013-01-30 04:21:57 +00:00			`* Accepting messages in Chinese, English or Japanese.`

Update README.md 2012-10-03 18:41:07 +00:00			`## Acknowledge`
update README 2012-08-28 09:54:27 +00:00
.. 2012-09-21 13:38:23 +00:00			`pdf2htmlEX is made possible thanks to the following projects:`
.. 2012-09-21 13:35:27 +00:00
.. 2012-09-21 13:38:23 +00:00			`* [poppler](http://poppler.freedesktop.org/)`
			`* [Fontforge](http://fontforge.org/)`
add jquery 2012-09-22 06:41:29 +00:00			`* [jQuery](http://jquery.com/)`
.. 2012-09-21 13:35:27 +00:00
README 2012-09-18 16:45:20 +00:00			`pdf2htmlEX is inspired by the following projects:`
initial import 2012-08-04 18:03:53 +00:00
			`* pdftops & pdftohtml from poppler`
support cid fonts 2012-08-11 11:55:06 +00:00			`* MuPDF`
initial import 2012-08-04 18:03:53 +00:00			`* PDF.js`
			`* Crocodoc`
			`* Google Doc`

update README 2012-08-28 09:56:37 +00:00			`### Special Thanks`
update README 2012-08-28 09:54:27 +00:00
update README 2012-08-04 18:27:18 +00:00			`* Hongliang Tian <tatetian@gmail.com>`
special thanks 2012-12-01 16:59:59 +00:00			`* Wanmin Liu <wanminliu@gmail.com>`
initial import 2012-08-04 18:03:53 +00:00