Go to file

Andreas Gal 9e19966a83 Merge pull request #524 from notmasteryet/tree-25 Changing the calculateMD5 function name (ref #523)		2011-09-24 12:46:15 -07:00
examples/helloworld	Addressing comments by Vivien	2011-09-16 08:28:42 -07:00
extensions/firefox	Initial import of the Firefox extension	2011-09-07 00:00:24 +02:00
test	update to master	2011-09-23 17:49:23 -07:00
utils	Fix a small lint error in fonts_utils.js	2011-09-21 16:26:20 +02:00
web	Fixing hyperlinks (regr. #509 )	2011-09-22 18:29:43 -05:00
worker	Zero gjslint warnings mark	2011-09-18 14:44:57 -05:00
.gitignore	allow custom rules to be defined in local.mk	2011-07-07 12:51:48 -04:00
charsets.js	Fix lint errors and add metrics.js and charsets.js to the default set of pdf files in the Makefile	2011-09-20 04:26:37 +02:00
crypto.js	Changing the calculateMD5 function name (ref #523 )	2011-09-24 09:14:44 -05:00
fonts.js	Fix lint warnings.	2011-09-23 20:56:21 +03:00
glyphlist.js	Fix Mode comment lines.	2011-09-12 20:37:33 +03:00
LICENSE	Added myself to the license (yay!)	2011-09-16 23:55:06 +01:00
Makefile	Fix lint errors and add metrics.js and charsets.js to the default set of pdf files in the Makefile	2011-09-20 04:26:37 +02:00
metrics.js	Fix Mode comment lines.	2011-09-12 20:37:33 +03:00
pdf.js	Fix mediaBox check (regr. of #519 )	2011-09-23 21:29:01 -05:00
README.md	Add links to subscribe to mailing list.	2011-09-19 21:11:14 +03:00

README.md

pdf.js

Overview

pdf.js is an HTML5 technology experiment that explores building a faithful and efficient Portable Document Format (PDF) renderer without native code assistance.

pdf.js is community-driven and supported by Mozilla Labs. Our goal is to create a general-purpose, web standards-based platform for parsing and rendering PDFs, and eventually release a PDF reader extension powered by pdf.js. Integration with Firefox is a possibility if the experiment proves successful.

Getting started

Online demo

For an online demo, visit:

http://andreasgal.github.com/pdf.js/web/viewer.html

This demo provides an interactive interface for displaying and browsing PDFs using the pdf.js API.

Hello world

For a "hello world" example, take a look at:

examples/helloworld/

This example illustrates the bare minimum ingredients for integrating pdf.js in a custom project.

Running the Tests

pdf.js comes with browser-level regression tests that allow one to probe whether it's able to successfully parse PDFs, as well as compare its output against reference images, pixel-by-pixel.

To run the tests, first configure the browser manifest file at:

test/resources/browser_manifests/browser_manifest.json

Sample manifests for different platforms are provided in that directory.

To run all the bundled tests, type:

$ make test

and cross your fingers. Different types of tests are available, see the test manifest file at:

test/test_manifest.json

The test type eq tests whether the output images are identical to reference images. The test type load simply tests whether the file loads without raising any errors.

Contributing

pdf.js is a community-driver project, so contributors are always welcome. Simply fork our repo and contribute away. A great place to start is our open issues.

For better consistency and long-term stability, please do look around the code and try to follow our conventions.

Additional resources

Our demo site is here:

http://andreasgal.github.com/pdf.js/web/viewer.html

You can read more about pdf.js here:

http://andreasgal.com/2011/06/15/pdf-js/

http://blog.mozilla.com/cjones/2011/06/15/overview-of-pdf-js-guts/

http://twitter.com/#!/pdfjs

Join our mailing list:

dev-pdf-js@lists.mozilla.org

Subscribe either using lists.mozilla.org or Google Groups:

https://lists.mozilla.org/listinfo/dev-pdf-js https://groups.google.com/group/mozilla.dev.pdf-js/topics

Talk to us on IRC:

#pdfjs on irc.mozilla.org