pdf2htmlEX/README.md

120 lines
3.3 KiB
Markdown
Raw Normal View History

2012-08-28 09:54:27 +00:00
# pdf2html**EX**
2012-08-04 18:03:53 +00:00
2012-09-07 17:50:18 +00:00
A beautiful demo is worth a thousand words:
2012-08-04 18:25:47 +00:00
[**Typography**](http://coolwanglu.github.com/pdf2htmlEX/demo/geneve.html) [Original](https://github.com/raphink/geneve_1564/raw/master/geneve_1564.pdf)
2012-09-07 17:50:18 +00:00
[**Formulas**](http://coolwanglu.github.com/pdf2htmlEX/demo/cheat.html) [Original](http://www.tug.org/texshowcase/cheat.pdf)
2012-09-07 17:50:18 +00:00
[**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)
2012-09-07 17:50:18 +00:00
[**Chinese**](http://coolwanglu.github.com/pdf2htmlEX/demo/chn.html) [Original](http://files.cnblogs.com/phphuaibei/git%E6%90%AD%E5%BB%BA.pdf)
2012-08-18 08:05:36 +00:00
2012-08-04 18:22:50 +00:00
2012-08-18 07:46:07 +00:00
**WINDOWS XP USERS: Please make sure ClearType is turned on**
2012-08-17 13:45:16 +00:00
(Control Panel -> Display -> Appearance -> Effects -> "Use the following method to smooth edges of screen fonts" -> ClearType)
2012-08-28 09:56:37 +00:00
## Introduction
2012-08-28 09:54:27 +00:00
2012-08-07 12:16:05 +00:00
pdf2htmlEX renders PDF files in HTML, utilizing modern Web technologies, aims to provide an accuracy rendering, while keeping optimized for Web display.
2012-08-04 18:03:53 +00:00
2012-08-28 09:54:27 +00:00
It is optimized for modern web browsers such as Mozilla Firefox & Google Chrome.
2012-08-07 12:16:05 +00:00
2012-08-28 09:54:27 +00:00
This program is designed for scientific papers with complicate formulas and figures, so a precise rendering is also the #1 concern. But of course general PDF files are also supported.
2012-08-28 09:56:37 +00:00
## Features
2012-08-04 18:03:53 +00:00
2012-08-14 18:54:39 +00:00
* Single HTML file output
2012-08-07 12:16:05 +00:00
* Precise rendering
2012-08-05 15:54:15 +00:00
* Text Selection
2012-08-28 09:54:27 +00:00
* Font embedding & reencoding for Web
2012-08-06 17:22:25 +00:00
* Proper styling (Color, Transformation...)
2012-09-16 12:48:51 +00:00
* Links
2012-08-04 18:03:53 +00:00
* Optimization for Web
2012-08-28 09:56:37 +00:00
### Not supported yet
2012-08-28 09:54:27 +00:00
* Type 3 fonts
2012-08-06 06:32:12 +00:00
* Non-text object (Don't worry, they will be rendered as images)
2012-08-04 18:03:53 +00:00
2012-08-28 09:56:37 +00:00
## Get started
2012-08-28 09:54:27 +00:00
### Ubuntu
2012-08-28 09:54:27 +00:00
2012-09-21 13:30:00 +00:00
A not so up-to-date [Ubuntu PPA](https://launchpad.net/~coolwanglu/+archive/pdf2htmlex).
2012-08-28 09:54:27 +00:00
### ArchLinux
2012-09-21 13:30:00 +00:00
[AUR Package](https://aur.archlinux.org/packages.php?ID=62426), special thanks to Arthur Titeica
2012-09-21 06:21:56 +00:00
### Mac
MacPorts and Homebrew are coming soon
### Windows
I have tested with CYGWIN without any problem, and I believe it also works on MinGW without many modifications.
2012-09-21 06:21:56 +00:00
2012-08-29 23:42:53 +00:00
### Build from source
2012-08-28 09:54:27 +00:00
2012-08-28 09:56:37 +00:00
#### Dependency
2012-08-28 10:27:45 +00:00
2012-09-10 18:44:45 +00:00
* CMake, pkg-config
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
2012-09-17 17:32:27 +00:00
* I heard about successful build with Clang
2012-09-09 18:57:38 +00:00
* libpoppler with xpdf header >= 0.20.0 (compile with --enable-xpdf-headers)
2012-09-07 17:24:56 +00:00
* Install libpng (and headers) BEFORE you compile libpoppler if you want background images generated
2012-09-11 05:59:24 +00:00
* Install poppler-data if your want CJK support
2012-09-06 09:32:16 +00:00
* fontforge (with header files)
2012-08-04 18:03:53 +00:00
2012-08-28 09:56:37 +00:00
#### Compiling
2012-08-28 10:27:45 +00:00
2012-08-14 18:28:19 +00:00
cmake . && make && sudo make install
2012-08-04 18:03:53 +00:00
2012-08-28 09:54:27 +00:00
## Usage
2012-08-28 10:27:45 +00:00
2012-08-28 09:54:27 +00:00
pdf2htmlEX /path/to/foobar.pdf
pdf2htmlEX --help
## FAQ
[here](https://github.com/coolwanglu/pdf2htmlEX/wiki/FAQ)
2012-08-28 09:56:37 +00:00
## LICENSE
2012-08-04 18:03:53 +00:00
2012-08-31 13:19:46 +00:00
GPLv2 & GPLv3 Dual licensed
2012-08-04 18:03:53 +00:00
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**
2012-09-07 10:23:38 +00:00
2012-09-11 07:02:11 +00:00
**Font extraction, conversion or redistribution may be illegal, please check your local laws**
2012-09-07 10:23:38 +00:00
2012-08-28 09:56:37 +00:00
## Credits
2012-08-28 09:54:27 +00:00
2012-09-18 16:45:20 +00:00
pdf2htmlEX is inspired by the following projects:
2012-08-04 18:03:53 +00:00
* pdftops & pdftohtml from poppler
2012-08-11 11:55:06 +00:00
* MuPDF
2012-08-04 18:03:53 +00:00
* PDF.js
* Crocodoc
* Google Doc
2012-08-28 09:56:37 +00:00
## Contact
2012-08-28 09:54:27 +00:00
2012-09-20 07:44:23 +00:00
Suggestions and questions are welcome.
2012-09-06 17:33:00 +00:00
2012-09-20 07:44:23 +00:00
Please read [FAQ](https://github.com/coolwanglu/pdf2htmlEX/wiki/FAQ) before sending an email to me. Or your message might be ignored.
2012-09-06 17:33:00 +00:00
2012-09-21 06:33:56 +00:00
I'm much more user-friendly than pdf2htmlEX.
2012-08-04 18:27:18 +00:00
* Lu Wang <coolwanglu@gmail.com>
2012-08-28 09:54:27 +00:00
2012-08-28 09:56:37 +00:00
### Special Thanks
2012-08-28 09:54:27 +00:00
2012-08-04 18:27:18 +00:00
* Hongliang Tian <tatetian@gmail.com>
2012-08-04 18:03:53 +00:00