mPDF Manual – What Else Can I Do

PDF/X-1a compliance

(mPDF >= 5.1)

PDF/X-1a is a file format to facilitate printing of electronic documents.

Two key elements to this function are the requirement for PDF/X documents to be 100% self-contained, and all images need to be CMYK or spot colors.

A PDF/X document can be identified as such through PDF/X-specific metadata located in the document. However, claiming to be PDF/X compliant and being so are not necessarily the same.

Important: mPDF is **not guaranteed **to produce fully PDF/X-1a compliant files in all circumstances. It is the users responsibility to check compliance if this is essential.

mPDF and PDF/X-1a compliance

You can make mPDF produce mPDF/X-1a:2003 compliant files by setting:

<?php

$this->PDFX = true; // Edit in config.php or set at runtime

Colorspaces and ICC Profiles

PDF files handle colours internally in a number of different colorspaces. PDFX files can only use CMYK and spot colurs, and a colorspace profile must be embedded in the document.

It is likely that most content in a PDF file will be RGB unless you have specifically defined otherwise e.g. a CMYK JPG image file, or colours defined as CMYK() etc.

Colorspaces can be altered using restrictColorSpace.

An ICC Color profile must be embedded in the file.

A default CMYK ICC profile is included with mPDF: SWOP2006_Coated5v2.icc

Sources of free ICC profiles are:

You can change the color profile used by mPDF by adding a  *.icc file to the [mpdf]/iccprofiles/ folder. It must be a 4-colour CMYK profile. Then edit config.php e.g.

<?php

$this->ICCProfile = 'SWOP2006_Coated5v2';

Fonts

All fonts must be embedded in a PDF/X file. mPDF normally uses the core Adobe fonts (Helvetica, Times, Courier, Symbol and Zapfdingbats) in a number of situations, and these font files are not available to embed. This affects:

  • $useCoreFontsOnly is not permitted
  • lists `<ul>` cannot use Zapfdingbats font for bullets
  • form element `<select>` cannot use Zapfdingbats character as the drop-down symbol
  • ISBN/ISSN barcode cannot use Helvetica for the ISBN number (above the bar)

Also, the fonts GB, BIG5, UHC and SJIS which reference the free CJK font pack from Adobe cannot be used

Transparency and Annotations

Because PDF/X-1a has the objective of ensuring reliable reproduction of the document, no objects may be transparent or semi-transparent. This affects:

  • watermarks text or images
  • images with the CSS property $opacity set
  • annotation markers

Making it happen!

When $this->PDFX is set to true, the following changes will automatically and silently happen:

  • list bullets will use the characters from the current font (if available) e.g. • ⚬ ▪
  • the default font (which in some circumstances is set to a core Adobe font) is set to an alternative embedded font
  • annotations (including hyperlinks) have their 'flag' changed to /F 28 which should force printing (this seems to make no difference but is required for PDFX compliance)
  • a /Charset entry is included for each font when using embedded subsets
  • a Metadata object is added to the file
  • an ICC Color Profile is added as /OuputIntent

Only the first change may make a discernible change to the displayed document. All other changes are to the file structure.

Warnings

Some problems can be fixed by mPDF, but will cause a change to the appearance of your document. By default they will generate warning messages. Once you have assessed the warnings, you can direct mPDF to make these changes automatically by setting in your script:

<?php

$mpdf->PDFXauto = true; // Overrides warnings making changes when possible to force PDFX-1a compliance

The following issues will cause a warning message when you try to generate a PDFX file:

Problem detected Action taken by mPDF
List bullets cannot be substituted from current font Bullets substituted by a hypen "-"
Character substitution ($useSubstitutions or $useSubstitutionsMB) is enabled. This would attempt to substitute missing characters using core Adobe fonts which are disallowed. Character substitution is disabled
Annotation markers are present; these cannot be semi-transparent and may hide underlying text. Annotation markers are placed in the right margin
Images which have CSS property opacity set less than 1 - PDFX does not allow transparency. NB GIF or PNG images with a simple transparency set (not alpha-channel mask) are valid. Opacity is changed to 1 (no transparency)
Core fonts (Times, Helvetica, Courier) are specified directly e.g. in CSS stylesheet Font will be substituted with an available sans, serif, or mono font.
Barcode of ISBN, ISSN or EAN-13 type which specifies the code to appear above the barcode (normally uses Helvetica font). Substitutes available sans-serif font
Form element `<select>` which normally uses a Zapfdingbats character for the drop-down symbol. An equal sign "=" will be substituted if ▼ is not available in the default sans-serif font.

Fatal Errors

Some issues cannot be fixed automatically by mPDF and will generate fatal errors:

  • $useCoreFontsOnly is set as TRUE (cannot embed core fonts)
  • BIG5, SJIS, UHC or GB fonts cannot be used (cannot be embedded)
  • Watermarks - text or image - are not permitted (transparency is disallowed so will make text unreadable)
  • PNG images with alpha channel transparency ('masks' not allowed)
  • encryption is enabled

See Also

  • PDF/A1-b compliance
  • PDFA - Create PDF/A1-b compliant document
  • PDFX - Create PDF/X-1a compliant document
  • PDFAauto - Specify whether to automatically fix issues to create PDF/A1-b compliant document
  • PDFXauto - Specify whether to automatically fix issues to create PDF/X-1a compliant document
  • ICCProfile - Specify the ICC profile for the chosen colorspace used in the document
  • restrictColorSpace - Specify whether to automatically limit the colorspaces used