|
|
|
@ -18,46 +18,42 @@ successful.
@@ -18,46 +18,42 @@ successful.
|
|
|
|
|
|
|
|
|
|
## Getting started |
|
|
|
|
|
|
|
|
|
**Online demo** |
|
|
|
|
### Online demo |
|
|
|
|
|
|
|
|
|
For an online demo, visit: |
|
|
|
|
|
|
|
|
|
http://andreasgal.github.com/pdf.js/web/viewer.html |
|
|
|
|
+ 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. |
|
|
|
|
|
|
|
|
|
**Getting the code** |
|
|
|
|
### Getting the code |
|
|
|
|
|
|
|
|
|
To get a local copy of the current code, clone it using git: |
|
|
|
|
|
|
|
|
|
```bash |
|
|
|
|
git clone git://github.com/andreasgal/pdf.js.git pdfjs |
|
|
|
|
cd pdfjs |
|
|
|
|
``` |
|
|
|
|
$ git clone git://github.com/andreasgal/pdf.js.git pdfjs |
|
|
|
|
$ cd pdfjs |
|
|
|
|
|
|
|
|
|
Next, you need to start a local web server as some browsers don't allow opening |
|
|
|
|
PDF files for a file:// url: |
|
|
|
|
|
|
|
|
|
```bash |
|
|
|
|
make server |
|
|
|
|
``` |
|
|
|
|
$ make server |
|
|
|
|
|
|
|
|
|
If everything worked out, you can now serve |
|
|
|
|
|
|
|
|
|
http://localhost:8888/web/viewer.html |
|
|
|
|
+ http://localhost:8888/web/viewer.html |
|
|
|
|
|
|
|
|
|
You can also view all the test pdf files on the right side serving |
|
|
|
|
|
|
|
|
|
http://localhost:8888/test/pdfs/?frame |
|
|
|
|
+ http://localhost:8888/test/pdfs/?frame |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
**Hello world** |
|
|
|
|
### Hello world |
|
|
|
|
|
|
|
|
|
For a "hello world" example, take a look at: |
|
|
|
|
|
|
|
|
|
examples/helloworld/ |
|
|
|
|
+ [examples/helloworld/hello.js](blob/master/examples/helloworld/hello.js) |
|
|
|
|
|
|
|
|
|
This example illustrates the bare minimum ingredients for integrating pdf.js |
|
|
|
|
in a custom project. |
|
|
|
@ -66,16 +62,22 @@ in a custom project.
@@ -66,16 +62,22 @@ in a custom project.
|
|
|
|
|
|
|
|
|
|
## Contributing |
|
|
|
|
|
|
|
|
|
pdf.js is a community-driver project, so contributors are always welcome. |
|
|
|
|
pdf.js is a community-driven 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. |
|
|
|
|
[open issues](issues/). For better consistency and long-term stability, please do |
|
|
|
|
look around the code and try to follow our conventions. |
|
|
|
|
|
|
|
|
|
If you __don't want to hack__ on the project or have short spare times, you still |
|
|
|
|
can help! Just open PDFs in the |
|
|
|
|
If you don't want to hack on the project or have short spare times, __you still |
|
|
|
|
can help!__ Just open PDFs in the |
|
|
|
|
[online demo](http://andreasgal.github.com/pdf.js/web/viewer.html) and report |
|
|
|
|
any breakage in rendering. |
|
|
|
|
|
|
|
|
|
Our Github contributors so far: |
|
|
|
|
|
|
|
|
|
+ https://github.com/andreasgal/pdf.js/contributors |
|
|
|
|
|
|
|
|
|
You can add your name to it! :) |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Running the Tests |
|
|
|
@ -108,47 +110,46 @@ raising any errors.
@@ -108,47 +110,46 @@ raising any errors.
|
|
|
|
|
|
|
|
|
|
Our demo site is here: |
|
|
|
|
|
|
|
|
|
http://andreasgal.github.com/pdf.js/web/viewer.html |
|
|
|
|
+ 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://andreasgal.com/2011/06/15/pdf-js/ |
|
|
|
|
+ http://blog.mozilla.com/cjones/2011/06/15/overview-of-pdf-js-guts/ |
|
|
|
|
|
|
|
|
|
http://blog.mozilla.com/cjones/2011/06/15/overview-of-pdf-js-guts/ |
|
|
|
|
|
|
|
|
|
Follow us on twitter: @pdfjs |
|
|
|
|
Talk to us on IRC: |
|
|
|
|
|
|
|
|
|
http://twitter.com/#!/pdfjs |
|
|
|
|
+ #pdfjs on irc.mozilla.org |
|
|
|
|
|
|
|
|
|
Join our mailing list: |
|
|
|
|
|
|
|
|
|
dev-pdf-js@lists.mozilla.org |
|
|
|
|
+ dev-pdf-js@lists.mozilla.org |
|
|
|
|
|
|
|
|
|
Subscribe either using lists.mozilla.org or Google Groups: |
|
|
|
|
|
|
|
|
|
https://lists.mozilla.org/listinfo/dev-pdf-js |
|
|
|
|
+ https://lists.mozilla.org/listinfo/dev-pdf-js |
|
|
|
|
+ https://groups.google.com/group/mozilla.dev.pdf-js/topics |
|
|
|
|
|
|
|
|
|
https://groups.google.com/group/mozilla.dev.pdf-js/topics |
|
|
|
|
Follow us on twitter: @pdfjs |
|
|
|
|
|
|
|
|
|
+ http://twitter.com/#!/pdfjs |
|
|
|
|
|
|
|
|
|
Talk to us on IRC: |
|
|
|
|
|
|
|
|
|
#pdfjs on irc.mozilla.org |
|
|
|
|
|
|
|
|
|
## Additional resources to understand the structure of PDF |
|
|
|
|
|
|
|
|
|
A really basic overview of PDF is described here: |
|
|
|
|
|
|
|
|
|
http://partners.adobe.com/public/developer/en/livecycle/lc_pdf_overview_format.pdf |
|
|
|
|
+ http://partners.adobe.com/public/developer/en/livecycle/lc_pdf_overview_format.pdf |
|
|
|
|
|
|
|
|
|
A more detailed file example: |
|
|
|
|
|
|
|
|
|
http://gnupdf.org/Introduction_to_PDF |
|
|
|
|
+ http://gnupdf.org/Introduction_to_PDF |
|
|
|
|
|
|
|
|
|
The PDF specification itself is an ISO and not free available. However, there is |
|
|
|
|
The PDF specification itself is an ISO and not freely available. However, there is |
|
|
|
|
a "PDF Reference" from Adobe: |
|
|
|
|
|
|
|
|
|
http://wwwimages.adobe.com/www.adobe.com/content/dam/Adobe/en/devnet/pdf/pdfs/pdf_reference_1-7.pdf |
|
|
|
|
+ http://wwwimages.adobe.com/www.adobe.com/content/dam/Adobe/en/devnet/pdf/pdfs/pdf_reference_1-7.pdf |
|
|
|
|
|
|
|
|
|
Recommanded chapters to read: "2. Overview", "3.4 File Structure", |
|
|
|
|
Recommended chapters to read: "2. Overview", "3.4 File Structure", |
|
|
|
|
"4.1 Graphics Objects" that lists the PDF commands. |
|
|
|
|
|
|
|
|
|