WS Form PDF Addon v1.2.6 - WordPress Plugin

The PDF add-on allows you to attach a PDF file to emails, as well as export PDFs from the submissions page. Note: The PDF add-on uses Published forms. Please ensure your form has been published before using the PDF add-on. Installation The WS Form PDF plugin is installed in the same way as installing the WS Form PRO plugin. Once installed you will need to activate the license for the plugin.

When you purchase the PDF plugin, you will be given a license key. If you have lost your license key(s), click here. To activate your license key: Click WS Form in the WordPress administration menu. Click Settings. Click the PDF tab at the top of the page. Enter your license key. Click the Activate button. If your license key fails to activate, please ensure you are using the correct license key and not your WS Form PRO license key.

PDF Settings Page size, page orientation, and font settings can be changed in the PDF settings tab. To access the settings: Click WS Form in the WordPress administration menu. Click Settings. Click the PDF tab at the top of the page. Adjust the settings to suit your preferences. Click Save. Attaching a PDF to a Send Email Action To attach a PDF to a Send Email action: When editing your form, click the Actions icon at the top of the page.

The Actions sidebar will open on the right-hand side of the page. Click the Add icon to add a new action (or select an existing ‘Send Email’ action). Scroll down the settings until you see the Attach PDF checkbox. Check the Attach PDF checkbox. If you want to specify the filename of the PDF, enter it in the Custom PDF Filename setting. You can use WS Form variables in this setting.

(Optional) If you want to specify a custom template to use for the PDF, enter the template filename in this setting. For example: my-custom-template.html (See Creating Custom PDF Templates below) Click the Save button at the bottom. Now when the email is sent, a PDF attachment of your submitted data will be included with the email. Export Submission PDFs To create a PDF of a submission: View the submissions of a form.

In the left-most column, click on Export PDF. Adding Page Breaks When you install the PDF add-on, a new field type will appear in the form editor field types called ‘Page Break’. Simply drag that onto your form, and a page break will appear in your PDF at that point. This is useful for formatting PDFs that are created from your form submissions. This field type does not have any settings.

Variables The PDF add-on adds additional variables that you can use in actions such as messages, emails and in custom mapping. VariableNameDescriptionUsage#pdf_linkPDF Link (Download)Returns a 'Download PDF' link to the PDF. Actions#pdf_link_viewPDF Link (View)Returns a 'View PDF' link to the PDF. Actions#pdf_urlPDF URL (Download)Returns the URL to the PDF.

URL downloads the PDF. Actions#pdf_url_viewPDF URL (View)Returns the URL to the PDF. URL shows the PDF in the browser. Actions Creating Custom PDF Templates Note: We are not able to provide HTML support for the development of custom templates using the PDF add-on. The PDF add-on uses parsed HTML templates containing WS Form variables. These templates are then converted to PDF.

By default, WS form will create the PDF using a template found at the following location: /templates/standard.html You can also create custom templates for each form or for each ‘Send Email’ action. We recommend copying the standard.html template to get started. For tips on how to add fields to your HTML template, see Writing Custom HTML for Email Content and PDF Templates. Custom Templates By Form To create a template that will be used by a specific form, the template should be saved to: wp-content/uploads/ws-form/pdf/templates/.html So for example, for form ID 123 you would save your custom template to: wp-content/uploads/ws-form/pdf/templates/123.html You can find the form ID by clicking the ‘Form Settings‘ icon and looking at the top of the sidebar. Custom Templates By Send Email Action If you want to specify a custom template for a specific Send Email action, that can be done by configuring the ‘Custom PDF Template’ setting in the Send Email action itself. In the example above the template would be located at: wp-content/uploads/ws-form/pdf/templates/my-template.html Note that the ‘Export PDF’ link on the submissions page will always use the standard template or the form specific template. How a PDF is Created The add-on uses the popular dompdf converter to transform the parsed HTML template in a PDF document. Please refer to their online help for guidance on formatting a PDF document. Standard Template The standard template code is as follows: #email_submission Setting Page Size and Orientation in the Template You can set the page size and orientation in the template itself by using CSS: