-
Notifications
You must be signed in to change notification settings - Fork 0
/
readme.txt
94 lines (62 loc) · 3.85 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
=== Embed PDF with Smallpdf ===
Plugin Name: Embed PDF with Smallpdf
Version: 1.0.1
Auhtor: Smallpdf
Author URI: https://smallpdf.com
Contributors: Smallpdf
Tags: PDF, embed PDF, PDF viewer, document, Smallpdf
Tested up to: 6.7
Requires at least: 6.5
Requires PHP: 7.4
Stable tag: 1.0.1
License: GPL-2.0-or-later
License URI: https://www.gnu.org/licenses/gpl-2.0.html
Embed PDF by Smallpdf is a free and secure plugin that allows you to embed PDF documents directly into your posts and pages. No API keys are required.
== Description ==
Embed PDF with Smallpdf makes it easy to add PDF documents to your WordPress posts and pages. This plugin offers two convenient methods for embedding PDFs:
1. **Gutenberg Block**:
- Add the block by clicking on the + button in the Gutenberg editor.
- Search for "Embed PDF with Smallpdf".
- You can either upload a PDF from your media library or paste a PDF URL in the block details in the sidebar.
- Adjust the height of the widget by specifying the size in pixels (px) from the sidebar.
2. **Shortcode**:
- Use the shortcode `[pdf url='_ADD_PDF_URL_HERE_']` to embed a PDF.
- Control the height of the widget by adding the `height` parameter to the shortcode, e.g., `[pdf url='' height='480']`. The height value, in px, must be integer.
This flexibility allows you to seamlessly integrate PDF files into your content, ensuring they are easily accessible to your audience.
== Use of Third-Party Services ==
This plugin integrates the Embed PDF widget viewer from [Smallpdf](https://smallpdf.com/embed-pdf). To display your PDF successfully, the file may be processed through Smallpdf's servers.
By using this plugin, you agree to Smallpdf's [Terms & Conditions](https://smallpdf.com/terms) and [Privacy Policy](https://smallpdf.com/privacy)
== Installation ==
= From your Wordpress Admin Dashboard (Recommended) =
1. Go to _Plugins_ → _Add New Plugin_
2. Search for _Embed PDF with Smallpdf_
3. Click _Install_, then _Activate_
= Manual installation =
1. Download the plugin as `.zip` file
2. Unzip the downloaded archive
3. Upload `embed-pdf-by-smallpdf` folder into your `/wp-content/plugins/` directory
4. Go to _Plugins_ → _Installed Plugins_
5. _Activate_ Embed PDF with Smallpdf
== Frequently Asked Questions ==
= Can I embed multiple PDFs on the same page? =
Yes, you can embed multiple PDFs on the same page using either the Gutenberg block or the shortcode. Each block or shortcode will handle an individual PDF file.
= Can I adjust the dimensions of the embedded PDF viewer? =
Yes, you can adjust the height of the embedded PDF viewer. In the Gutenberg block, you can specify the height in the block's sidebar settings. When using the shortcode, add the height parameter with the desired value in pixels, e.g., `height='500'`.
= What types of PDF files can I embed? =
You can embed any standard PDF file. Simply ensure that the URL you provide or the file you upload is a valid PDF document.
= Can I use this plugin without an API key? =
Yes, the Embed PDF with Smallpdf plugin does not require an API key to function. You can embed PDFs without any additional setup
= Why does it say "Document unavaiable"? =
The message `Document unavailable` typically means that the PDF is not reachable or readable. To resolve this issue, please ensure that:
- The URL points to a valid PDF file.
- There are no typos in the URL.
- Your internet connection is stable.
If the problem persists, verify that the PDF file is publicly accessible and not restricted by permissions or behind a firewall.
== Changelog ==
= 1.0.1 =
* Fix widget rendering when using the `pdf` shortcode
= 1.0.0 =
* Initial release of Embed PDF with Smallpdf
== Development ==
The source code for this plugin is available on GitHub:
[GitHub Repository](https://github.com/smallpdf/wordpress-plugin)