| @@ -1,130 +1,5 @@ | ||
| 1 | -Installation | |
| 1 | +Upgrading | |
| 2 | 2 | ============ |
| 3 | - * Download the .zip file and unzip it | |
| 4 | - * Create a folder e.g. /mpdf on your server | |
| 5 | - * Upload all of the files to the server, maintaining the folders as they are | |
| 6 | - * Ensure that you have write permissions set (CHMOD 6xx or 7xx) for the following folders: | |
| 7 | - /ttfontdata/ - used to cache font data; improves performance a lot | |
| 8 | - /tmp/ - used for some images and ProgressBar | |
| 9 | - /graph_cache/ - if you are using JpGraph in conjunction with mPDF | |
| 10 | 3 | |
| 11 | -To test the installation, point your browser to the basic example file : [path_to_mpdf_folder]/mpdf/examples/example01_basic.php | |
| 12 | - | |
| 13 | -If you wish to define a different folder for temporary files rather than /tmp/ see the note on 'Folder for temporary files' in | |
| 14 | - the section on Installation & Setup in the manual (http://mpdf1.com/manual/). | |
| 15 | - | |
| 16 | -If you have problems, please read the section on troubleshooting in the manual. | |
| 17 | - | |
| 18 | - | |
| 19 | -Fonts | |
| 20 | -===== | |
| 21 | -Let us refer to font names in 2 ways: | |
| 22 | -"CSS font-family name" - mPDF is designed primarily to read HTML and CSS. This is the name used in CSS e.g. | |
| 23 | - <p style="font-family: 'Trebuchet MS';"> | |
| 24 | - | |
| 25 | -"mPDF font-family name" - the name used internally to process fonts. This could be anything you like, | |
| 26 | - but by default mPDF will convert CSS font-family names by removing any spaces and changing | |
| 27 | - to lowercase. Reading the name above, mPDF will look for a "mPDF font-family name" of | |
| 28 | - 'trebuchetms'. | |
| 29 | - | |
| 30 | -The configurable values referred to below are set in the config_fonts.php file | |
| 31 | - | |
| 32 | -When parsing HTML/CSS, mPDF will read the CSS font-family name (e.g. 'Trebuchet MS') and convert | |
| 33 | -by removing any spaces and changing to lowercase, to look for a mPDF font-family name (trebuchetms). | |
| 34 | - | |
| 35 | -Next it will look for a translation (if set) in config_font.php e.g.: | |
| 36 | -$this->fonttrans = array( | |
| 37 | - 'trebuchetms' => 'trebuchet' | |
| 38 | -) | |
| 39 | - | |
| 40 | -Now the mPDF font-family name to be used is 'trebuchet' | |
| 41 | - | |
| 42 | -If you wish to make this font available, you need to specify the Truetype .ttf font files for each variant. | |
| 43 | -These should be defined in config_font.php in the array: | |
| 44 | -$this->fontdata = array( | |
| 45 | - "trebuchet" => array( | |
| 46 | - 'R' => "trebuc.ttf", | |
| 47 | - 'B' => "trebucbd.ttf", | |
| 48 | - 'I' => "trebucit.ttf", | |
| 49 | - 'BI' => "trebucbi.ttf", | |
| 50 | - ) | |
| 51 | -) | |
| 52 | - | |
| 53 | -This is the array which determines whether a font is available to mPDF. Each font-family must have a | |
| 54 | -Regular ['R'] file defined - the others (bold, italic, bold-italic) are optional. | |
| 55 | - | |
| 56 | -mPDF will try to load the font-file. If you have defined _MPDF_SYSTEM_TTFONTS at the top of the | |
| 57 | -config_fonts.php file, it will first look for the font-file there. This is useful if you are running | |
| 58 | -mPDF on a computer which already has a folder with TTF fonts in (e.g. on Windows) | |
| 59 | - | |
| 60 | -If the font-file is not there, or _MPDF_SYSTEM_TTFONTS is not defined, mPDF will look in the folder | |
| 61 | -/[your_path_to_mpdf]/ttfonts/ | |
| 62 | - | |
| 63 | -Note that the font-file names are case-sensitive and can contain capitals. | |
| 64 | - | |
| 65 | -If the folder /ttfontdata/ is writeable (CHMOD 644 or 755), mPDF will save files there which it can | |
| 66 | -re-use next time it accesses a particular font. This will significantly improve processing time | |
| 67 | -and is strongly recommended. | |
| 68 | - | |
| 69 | -mPDF should be able to read most TrueType Unicode font files with a .ttf extension | |
| 70 | -Truetype fonts with .otf extension that are OpenType also work OK. | |
| 71 | -TrueType collections (.ttc) will also work if they contain TrueType Unicode fonts. | |
| 72 | - | |
| 73 | - | |
| 74 | -Character substitution | |
| 75 | -Most people will have access to a Pan-Unicode font with most Unicode characters in it such as | |
| 76 | -Arial Unicode MS. Set $this->backupSubsFont = array('arialunicodems'); at the top of the config_fonts.php file | |
| 77 | -to use this font when substituting any characters not found in the specific font being used. | |
| 78 | - | |
| 79 | -Example: | |
| 80 | -You can set $mpdf->useSubstitutions = true; at runtime | |
| 81 | -or $this->useSubstitutions = true; in the config.php file | |
| 82 | - | |
| 83 | -<p style="font-family: 'Comic Sans MS'">This text contains a Thai character ม which does not exist | |
| 84 | -in the Comic Sans MS font file</p> | |
| 85 | - | |
| 86 | -When useSubstitutions is true, mPDF will try to find substitutions for any missing characters: | |
| 87 | -1) firstly looks if the character is available in the inbuilt Symbols or ZapfDingbats fonts; | |
| 88 | -2) [If defined] looks in each of the the font(s) set by $this->backupSubsFont array | |
| 89 | - | |
| 90 | -NB There is an increase in processing time when using substitutions, and even more so if | |
| 91 | -a backupSubsFont is defined. | |
| 92 | - | |
| 93 | -Controlling mPDF mode | |
| 94 | -===================== | |
| 95 | -The first parameter of new mPDF('') works as follows: | |
| 96 | -new mPDF('c') - forces mPDF to only use the built-in [c]ore Adobe fonts (Helvetica, Times etc) | |
| 97 | - | |
| 98 | -new mPDF('') - default - font subsetting behaviour is determined by the configurable variables | |
| 99 | - $this->maxTTFFilesize and $this->percentSubset (see below) | |
| 100 | - Default values are set so that: 1) very large font files are always subset | |
| 101 | - 2) Fonts are embedded as subsets if < 30% of the characters are used | |
| 102 | - | |
| 103 | -new mPDF('..+aCJK') new mPDF('+aCJK') | |
| 104 | -new mPDF('..-aCJK') new mPDF('-aCJK') | |
| 105 | - - used optionally together with a language or language/country code, +aCJK will force mPDF | |
| 106 | - to use the Adobe non-embedded CJK fonts when a passage is marked with e.g. "lang: ja" | |
| 107 | - This can be used at runtime to override the value set for $mpdf->useAdobeCJK in config.php | |
| 108 | - Use in conjunction with settings in config_cp.php | |
| 109 | - | |
| 110 | -For backwards compatibility, new mPDF('-s') and new mPDF('s') will force subsetting by | |
| 111 | - setting $this->percentSubset=100 | |
| 112 | - new mPDF('utf-8-s') and new mPDF('ar-s') are also recognised | |
| 113 | - | |
| 114 | - | |
| 115 | - | |
| 116 | - | |
| 117 | -Configuration variables changed | |
| 118 | -=============================== | |
| 119 | -Configuration variables are documented in the on-line manual (http://mpdf1.com/manual/). | |
| 120 | - | |
| 121 | - | |
| 122 | -Font folders | |
| 123 | -============ | |
| 124 | -If you wish to define your own font file folders (perhaps to share), | |
| 125 | -you can define the 2 constants in your script before including the mpdf.php script e.g.: | |
| 126 | - | |
| 127 | -define('_MPDF_TTFONTPATH','your_path/ttfonts/'); | |
| 128 | -define('_MPDF_TTFONTDATAPATH','your_path/ttfontdata/'); // should be writeable | |
| 4 | +To upgrade from mPDF 5.7 to 5.7.1, simply upload the 3 files to their corresponding folders, overwriting files as required. | |
| 129 | 5 | |
