-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
35 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
6 changes: 1 addition & 5 deletions
6
docs/learned-knowledge.md → docs/learned-knowledge/app-options.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
# PDFViewerApplication | ||
|
||
The global `PDFViewerApplication` object is the entry of the default viewer of PDF.js, it glues all the modules | ||
together, and provides the API for the user. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
# Acknowledge | ||
|
||
> There are critical comments about the PDF.js project, they say it should be easier to integrate the default | ||
> viewer. I understand them somehow as a developer who want to show a PDF quickly, but knowing the primary goal | ||
> of an OSS project can help us to understand the trade-off decisions made by the maintainers. | ||
> | ||
> All these are what I learned from the PDF.js project. It may not be accurate, but I hope it can help you to understand the PDF.js better. | ||
## Table of Contents | ||
|
||
### Background Introduction | ||
|
||
[PDF.js](https://github.com/mozilla/pdf.js) is an OSS project supported by Mozilla and developed using HTML5, | ||
It's goal is to create a general-purpose, web standards-based platform for rendering PDFs in the **Firefox browser**. Many people find out that it's hard to integrate it into project, it's [somehow intentionally](#issues-talked-about-why-it-s-hard-to-integrate). | ||
|
||
It's not developed as a component or library you can easily integrate like most npm packages, because it's | ||
primary goal is to be used easily in **Firefox browser**, the goal doesn't match most developers expectations. | ||
It's the trade-off decision made by the maintainers, we should respect it. | ||
|
||
### Issues talked about why it's not easy to integrate | ||
|
||
- [Issue 5609](https://github.com/mozilla/pdf.js/issues/5609#issuecomment-68530552) | ||
- [Issue 9210](https://github.com/mozilla/pdf.js/issues/9210#issuecomment-347834276) | ||
- [Issue 7203](https://github.com/mozilla/pdf.js/issues/7203#issuecomment-210510569) | ||
|
||
## The Terms | ||
|
||
- [AppOptions](./app-options) | ||
- [PDFViewerApplication](./application) |