-
Notifications
You must be signed in to change notification settings - Fork 22
/
readme.txt
107 lines (88 loc) · 3.92 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
95
96
97
98
99
100
101
102
103
104
105
106
107
=== wp-mpdf ===
Contributors: fkrauthan
Donate link: https://fkrauthan.ca
Tags: print, printer, wp-mpdf, pdf, mpdf
Requires at least: 2.9
Tested up to: 6.5.3
Stable tag: 3.9
Print Wordpress posts as PDF. Optional with Geshi highlighting.
== Description ==
Print Wordpress posts as PDF. Optional with Geshi highlighting. It also has support for password protected posts and only logged in users can print post as pdf support.
Note: You can find the development repository at Github: <https://github.com/fkrauthan/wp-mpdf>
== Changelog ==
= 3.9 =
* Added `mpdfbutton` shortcode to print the PDF button
* Fixed a php warning
= 3.8.3 =
* Fixed deployment of 3.8.2
= 3.8.2 =
* Downgraded psr/log to hopefully fix some runtime errors
= 3.8.1 =
* Fixed deployment of 3.8
= 3.8 =
* Updated mpdf version
* Removed a file from geshi that could be abused
= 3.7.1 =
* Added missing files to plugin
= 3.7 =
* Updated mpdf to version 8
* Added mpdf_adjust_settings filter to allow overwriting any mpdf settings
= 3.6.1 =
* Fixed release tag to prevent install issues
= 3.6 =
* Removed manual cron job and used wp-cron instead for cache population (as per wordpress guidelines)
* Removed PHP 4 support (don't think anyone is running that anymore)
= 3.5.2 =
* Added some small security improvements for the admin page
* Fixed a PHP notice when "allow to print all pages" is disabled (thanks to grandeljay)
= 3.5.1 =
* Added some small security fixes to the admin page
= 3.5 =
* Added support to change page format inside template (thanks to conlaccento)
= 3.4 =
* Made codebase PHP 7.3 compatible (thanks to nopticon)
* Fixed issues with newer wordpress versions (thanks to nopticon)
= 3.3 =
* Fixed some small bugs
* Updated mpdf to version 6
* Updated geshi to latest version
* Made plugin compatible with PHP 7
= Earlier versions =
For the changelog of earlier versions, please refer to the separate changelog.txt file.
== Installation ==
1. Upload the whole plugin folder to your /wp-content/plugins/ folder.
2. Set write permission (777) to the plugin dir folder => /wp-content/plugins/wp-mpdf/cache
3. Go to the plugins page and activate the plugin.
4. Add to your template
```php
if( function_exists( 'mpdf_pdfbutton' ) ) {
mpdf_pdfbutton();
}
```
or as a small button
```php
if( function_exists( 'mpdf_pdfbutton' ) ) {
mpdf_pdfbutton( false, 'my link', 'my login text' );
}
```
The second text specifies the text which should displayed if you have checked "needs login" and a user isn't logged in. (if you wish to open the pdf print in a new tab you may pass "true" for the first parameter)
5. You can adjust some options: in your admin interface, click on plugins and then on wp-mpdf. For allowing or disabling pdf export you can use the checkbox when creating/editing a post or a page.
6. Place your templates into /wp-content/wp-mpdf-themes
The mpdf_pdfbutton function signature:
```php
function mpdf_pdfbutton( $opennewtab = false, $buttontext = '', $logintext = 'Login!', $print_button = true, $nofollow = false, $options = array() )
```
The options array supports
```php
'pdf_lock_image' => '/my/image/path/relative/to/wordpress/route'
```
and
```php
'pdf_image' => '/my/image/path/relative/to/wordpress/route'
```
to overwrite which icon should be used.
== License ==
This file is part of wp-mpdf.
wp-mpdf is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
wp-mpdf is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with wp-mpdf. If not, see <http://www.gnu.org/licenses/>.