archive-gh-me/pdfkit
1
0
Fork 0
mirror of https://github.com/foliojs/pdfkit.git synced 2025-12-08 20:15:54 +00:00
Code Issues Projects Releases Wiki Activity

Update readme and docs

Browse Source
This commit is contained in:
Yang Liu 2018-12-16 23:45:14 +09:00
parent 678148a286
commit 6398cca899
2 changed files with 78 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@ -6,9 +6,9 @@ A JavaScript PDF generation library for Node and the browser.
## Description
PDFKit is a PDF document generation library for Node and the browser that makes creating complex, multi-page, printable documents easy.
It's written in CoffeeScript, but you can choose to use the API in plain 'ol JavaScript if you like. The API embraces
chainability, and includes both low level functions as well as abstractions for higher level functionality. The PDFKit API
PDFKit is a PDF document generation library for Node and the browser that makes creating complex, multi-page, printable documents easy.
It's written in CoffeeScript, but you can choose to use the API in plain 'ol JavaScript if you like. The API embraces
chainability, and includes both low level functions as well as abstractions for higher level functionality. The PDFKit API
is designed to be simple, so generating complex documents is often as simple as a few function calls.
Check out some of the [documentation and examples](http://pdfkit.org/docs/getting_started.html) to see for yourself!
@ -49,15 +49,17 @@ Installation uses the [npm](http://npmjs.org/) package manager. Just type the f
* Underlines
* etc.
* Outlines
* PDF security
* Encryption
* Access privileges (printing, copying, modifying, annotating, form filling, content accessibility, document assembly)
## Coming soon!
* Patterns fills
* PDF Security
* Higher level APIs for creating tables and laying out content
* More performance optimizations
* Even more awesomeness, perhaps written by you! Please fork this repository and send me pull requests.
## Example
```coffeescript
@ -111,9 +113,9 @@ doc.addPage()
# Finalize PDF file
doc.end()
```
[The PDF output from this example](http://pdfkit.org/demo/out.pdf) (with a few additions) shows the power of PDFKit — producing
complex documents with a very small amount of code. For more, see the `demo` folder and the
[The PDF output from this example](http://pdfkit.org/demo/out.pdf) (with a few additions) shows the power of PDFKit — producing
complex documents with a very small amount of code. For more, see the `demo` folder and the
[PDFKit programming guide](http://pdfkit.org/docs/getting_started.html).
## Browser Usage
@ -122,13 +124,13 @@ There are two ways to use PDFKit in the browser. The first is to use [Browserif
which is a Node module packager for the browser with the familiar `require` syntax. The second is to use
a prebuilt version of PDFKit, which you can [download from Github](https://github.com/devongovett/pdfkit/releases).
In addition to PDFKit, you'll need somewhere to stream the output to. HTML5 has a
In addition to PDFKit, you'll need somewhere to stream the output to. HTML5 has a
[Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob) object which can be used to store binary data, and
get URLs to this data in order to display PDF output inside an iframe, or upload to a server, etc. In order to
get URLs to this data in order to display PDF output inside an iframe, or upload to a server, etc. In order to
get a Blob from the output of PDFKit, you can use the [blob-stream](https://github.com/devongovett/blob-stream)
module.
The following example uses Browserify to load `PDFKit` and `blob-stream`, but if you're not using Browserify,
The following example uses Browserify to load `PDFKit` and `blob-stream`, but if you're not using Browserify,
you can load them in whatever way you'd like (e.g. script tags).
```coffeescript
@ -157,9 +159,9 @@ stream.on 'finish', ->
You can see an interactive in-browser demo of PDFKit [here](http://pdfkit.org/demo/browser.html).
Note that in order to Browserify a project using PDFKit, you need to install the `brfs` module with npm,
which is used to load built-in font data into the package. It is listed as a `devDependency` in
PDFKit's `package.json`, so it isn't installed by default for Node users.
Note that in order to Browserify a project using PDFKit, you need to install the `brfs` module with npm,
which is used to load built-in font data into the package. It is listed as a `devDependency` in
PDFKit's `package.json`, so it isn't installed by default for Node users.
If you forget to install it, Browserify will print an error message.
## Documentation

61
docs/getting_started.coffee.md
View File

@ -183,6 +183,67 @@ capitalized.
* `CreationDate` - the date the document was created (added automatically by PDFKit)
* `ModDate` - the date the document was last modified
## Encryption and Access Privileges
PDF specification allow you to encrypt the PDF file and require a password when opening the file,
and/or set permissions of what users can do with the PDF file. PDFKit implements standard security
handler in PDF version 1.3 (40-bit RC4), version 1.4 (128-bit RC4), PDF version 1.7 (128-bit AES),
and PDF version 1.7 ExtensionLevel 3 (256-bit AES).
To enable encryption, provide a user password when creating the `PDFDocument` in `options` object.
The PDF file will be encrypted when a user password is provided, and users will be prompted to enter
the password to decrypt the file when opening it.
* `userPassword` - the user password (string value)
To set access privileges for the PDF file, you need to provide an owner password and permission
settings in the `option` object when creating `PDFDocument`. By default, all operations are disallowed.
You need to explicitly allow certain operations.
* `ownerPassword` - the owner password (string value)
* `allowPrinting` - whether printing is allowed. Specify `"lowResolution"` to allow degraded printing, or `"highResolution"` to allow printing with high resolution
* `allowModifying` - whether modifying the file is allowed. Specify `true` to allow modifying document content
* `allowCopying` - whether copying text or graphics is allowed. Specify `true` to allow copying
* `allowAnnotating` - whether annotating, form filling is allowed. Specify `true` to allow annotating and form filling
* `allowFillingForms` - whether form filling and signing is allowed. Specify `true` to allow filling in form fields and signing
* `allowContentAccessibility` - whether copying text for accessibility is allowed. Specify `true` to allow copying for accessibility
* `allowDocumentAssembly` - whether assembling document is allowed. Specify `true` to allow document assembly
You can specify either user password, owner password or both passwords.
Behavior differs according to passwords you provides:
* When only user password is provided,
users with user password are able to decrypt the file and have full access to the document.
* When only owner password is provided,
users are able to decrypt and open the document without providing any password,
but the access is limited to those operations explicitly permitted.
Users with owner password have full access to the document.
* When both passwords are provided,
users with user password are able to decrypt the file
but only have limited access to the file according to permission settings.
Users with owner password have full access to the document.
Note that PDF file itself cannot enforce access privileges.
When file is decrypted, PDF viewer applications have full access to the file content,
and it is up to them to respect permission settings.
To choose encryption method, you need to specify PDF version.
PDFKit will choose best encryption method available in the PDF version you specified.
* `pdfVersion` - a string value specifying PDF file version
Available options includes:
* `1.3` - PDF version 1.3 (default), 40-bit RC4 is used
* `1.4` - PDF version 1.4, 128-bit RC4 is used
* `1.5` - PDF version 1.5, 128-bit RC4 is used
* `1.6` - PDF version 1.6, 128-bit AES is used
* `1.7` - PDF version 1.7, 128-bit AES is used
* `1.7ext3` - PDF version 1.7 ExtensionLevel 3, 256-bit AES is used
When using PDF version 1.7 ExtensionLevel 3, password is truncated to 127 bytes of its UTF-8 representation.
In older versions, password is truncated to 32 bytes, and only Latin-1 characters are allowed.
### Adding content
Once you've created a `PDFDocument` instance, you can add content to the