PDF Forms

PDFMonkey can generate interactive PDF forms (AcroForms) by detecting special markers in your template and converting them into fillable form fields.

Overview

When you enable the PDF forms feature in your template settings, PDFMonkey automatically detects markers in your HTML content and replaces them with interactive form fields in the generated PDF. This allows you to create forms that can be filled out directly in PDF readers like Adobe Acrobat or Preview.

Enabling PDF Forms

To enable PDF forms in your template:

1. Go to your Template settings

2. Enable the "PDF Forms" option (similar to enabling JavaScript or Emojis)

3. Add form field markers to your template content

When enabled via the API, set use_forms: true in your template's settings or settings_draft object.

Marker Syntax

Markers follow a specific syntax that tells PDFMonkey what type of field to create and how to configure it:

[% data_form_field_TYPE_NAME_OPTIONS %]

Required Elements

• [% and %] - Start and end delimiters

• data_form_field - Required prefix for detection

• TYPE - Field type (text, checkbox, dropdown, etc.)

Optional Elements

• NAME - Custom field name (e.g., firstname, email)

• OPTIONS - Dimensions, validation, alignment, etc.

Basic Examples

[% data_form_field_text_w200_h30 %]
[% data_form_field_checkbox_w20_h20 %]
[% data_form_field_dropdown_w250_h30_options[Option1,Option2,Option3] %]

Field Types

Text Fields

Single-line Text

[% data_form_field_text_w300_h30 %]
[% data_form_field_text_firstname_w250_h30_required %]

Use for: Names, addresses, phone numbers, short text

Multi-line Text (Textarea)

[% data_form_field_textarea_w400_h100 %]
[% data_form_field_textarea_comments_w500_h150_max500 %]

Use for: Comments, descriptions, long messages

Password Field

[% data_form_field_text_password_w250_h30_password %]

Use for: Passwords, PINs, sensitive information

Email Field (with validation)

[% data_form_field_text_email_w350_h30_email %]
[% data_form_field_text_contact_w400_h30_required_email %]

Use for: Email addresses

Phone Field

[% data_form_field_text_phone_w200_h30_phone %]

Use for: Phone numbers

Selection Fields

Checkbox

[% data_form_field_checkbox_w20_h20 %]
[% data_form_field_checkbox_accept_terms_w20_h20_required %]

Use for: Terms acceptance, yes/no options, multiple selections

Example in template:

<p>☐ I accept the terms [% data_form_field_checkbox_accept_w20_h20 %]</p>
<p>☐ Subscribe to newsletter [% data_form_field_checkbox_newsletter_w20_h20 %]</p>

Dropdown (Select)

[% data_form_field_dropdown_w250_h30_options[Option1,Option2,Option3] %]
[% data_form_field_dropdown_country_w300_h30_options[France,Belgium,Switzerland,Canada] %]

Use for: Country lists, department selection, multiple choice (single selection)

Important: You must specify all options in the marker using options[A,B,C]

Radio Buttons

[% data_form_field_radio_w20_h20_options[Male,Female,Other] %]
[% data_form_field_radio_payment_w20_h20_options[Card,Transfer,Cash] %]

Use for: Exclusive choices (gender selection), single option among several

Note: Radio buttons with the same name form a group

Specialized Fields

Number Field

[% data_form_field_number_w100_h30 %]
[% data_form_field_number_age_w80_h30_min18_max120 %]
[% data_form_field_number_quantity_w60_h30_min1_max99 %]

Use for: Age, quantities, amounts, scores

Date Field

[% data_form_field_date_w150_h30_format_dd_mm_yyyy %]
[% data_form_field_date_birthdate_w150_h30_format_dd_mm_yyyy_required %]

Available formats:

• format_dd_mm_yyyy - DD/MM/YYYY (European)

• format_mm_dd_yyyy - MM/DD/YYYY (USA)

• format_yyyy_mm_dd - YYYY-MM-DD (ISO)

Comb Field (for codes)

[% data_form_field_text_zipcode_w150_h30_max5_comb %]
[% data_form_field_text_serial_w200_h30_max10_comb %]

Use for: Postal codes, serial numbers, verification codes

Appearance: Each character has its own visual box

Borderless Fields (noborder / invisible)

[% data_form_field_text_w300_h30_noborder %]
[% data_form_field_text_user_id_w200_h30_invisible_readonly %]

Use for:

• Elegant forms: Fields without black rectangles, with manually drawn dotted guide lines

• Invisible metadata: Tracking, references, user IDs

• Pre-filled values: Invisible but editable default values

• Clean design: Alternative to classic borders

Features:

• ✅ Border: 0 (invisible)

• ✅ Background: Transparent (shows content underneath)

• ✅ Functional: Captures text normally

• ✅ Compatible: All field types (text, checkbox, dropdown, etc.)

Advanced technique - Dotted guide lines:

To create elegant writing lines, combine:

1. Marker in WHITE on white background (invisible to the eye)

2. Manually drawn dotted lines at the base of the field

3. noborder option to make the field transparent

Example in your design software:

Email: [marker in WHITE] ← Set text color to white
       .......................  ← Draw dotted lines

Result:

• White marker is invisible in the PDF

• Dotted lines guide the user

• Generated field is transparent and functional

Complete examples:

<!-- Invisible metadata -->
[% data_form_field_text_form_id_w150_h25_noborder_readonly_default_FORM-2025-001 %]
[% data_form_field_text_session_w200_h25_invisible %]

<!-- Elegant fields with dotted lines -->
[% data_form_field_text_email_w350_h30_noborder_email %]
[% data_form_field_text_address_w400_h30_noborder_required %]

<!-- Invisible textarea -->
[% data_form_field_textarea_message_w450_h80_noborder_max500 %]

Field Options

Dimensions

Required for proper rendering:

w{width}   → Width in pixels
h{height}  → Height in pixels

Examples:

w200_h30    → Short field (name)
w400_h30    → Medium field (email)
w500_h100   → Text area (comments)
w20_h20     → Checkbox

Size Guide:

Type	Recommended Width	Recommended Height
Short name	150-250px	30px
Email	300-400px	30px
Address	400-500px	30px
Textarea	400-600px	80-150px
Checkbox	20px	20px
Dropdown	200-300px	30px
Date	120-150px	30px
Number	60-100px	30px

Field State

required     → Required field (*)
mandatory    → Alias for required
readonly     → Read-only (not editable)

Examples:

[% data_form_field_text_email_w300_h30_required %]
[% data_form_field_text_total_w150_h30_readonly %]

Constraints

max{number}  → Maximum length (text) or maximum value (number)
min{number}  → Minimum value (number only)

Examples:

[% data_form_field_text_w200_h30_max50 %]                    → Max 50 characters
[% data_form_field_number_age_w80_h30_min18_max120 %]        → Between 18 and 120

Alignment and Style

left         → Left-aligned text (default)
center       → Centered text
right        → Right-aligned text
font{size}   → Font size (10, 12, 14, etc.)

Examples:

[% data_form_field_text_amount_w150_h30_right %]              → Right-aligned amount
[% data_form_field_text_title_w400_h40_center_font16 %]      → Centered title, large font

Default Values

default_{value}  → Pre-filled value (replace spaces with underscores)

Examples:

[% data_form_field_text_country_w200_h30_default_France %]
[% data_form_field_text_w300_h30_default_Enter_your_name %]

Custom Field Names

The first unrecognized element becomes the field name:

[% data_form_field_text_firstname_w200_h30 %]
                         ^^^^^^^^^
                         Field name

Benefits:

• Clearly identifies the field

• Facilitates data processing

• Improves readability

Naming conventions:

• Use snake_case: first_name, email_address

• Be descriptive: user_email rather than email1

• Avoid special characters

Complete Examples

Simple Contact Form

<h1>Contact Form</h1>

<p>Last name: [% data_form_field_text_lastname_w300_h30_required %]</p>

<p>First name: [% data_form_field_text_firstname_w300_h30_required %]</p>

<p>Email: [% data_form_field_text_email_w350_h30_required_email %]</p>

<p>Phone: [% data_form_field_text_phone_w200_h30_phone %]</p>

<p>Message:</p>
<p>[% data_form_field_textarea_message_w500_h120_required_max1000 %]</p>

<p>☐ I agree to be contacted [% data_form_field_checkbox_accept_w20_h20 %]</p>

Registration Form

<h1>Registration Form</h1>

<h2>Personal Information</h2>

<p>Title: [% data_form_field_dropdown_civility_w100_h30_options[Mr,Mrs,Ms] %]</p>

<p>Last name: [% data_form_field_text_lastname_w250_h30_required %]</p>

<p>First name: [% data_form_field_text_firstname_w250_h30_required %]</p>

<p>Birth date: [% data_form_field_date_birthdate_w150_h30_format_dd_mm_yyyy %]</p>

<p>Age: [% data_form_field_number_age_w80_h30_min18_max120 %]</p>

<h2>Contact</h2>

<p>Email: [% data_form_field_text_email_w350_h30_required_email %]</p>

<p>Phone: [% data_form_field_text_phone_w200_h30_phone %]</p>

<h2>Address</h2>

<p>Street: [% data_form_field_text_address_w450_h30_required %]</p>

<p>Postal code: [% data_form_field_text_zipcode_w120_h30_max5_comb %]</p>

<p>City: [% data_form_field_text_city_w250_h30_required %]</p>

<p>Country: [% data_form_field_dropdown_country_w250_h30_options[France,Belgium,Switzerland,Canada] %]</p>

<h2>Terms</h2>

<p>☐ I accept the terms [% data_form_field_checkbox_accept_terms_w20_h20_required %]</p>
<p>☐ Subscribe to newsletter [% data_form_field_checkbox_newsletter_w20_h20 %]</p>

Elegant Form with Borderless Fields

<h1>Request Form</h1>

<p>Instructions: Please fill in the information below</p>

<hr>

<p>1. Full name (field with classic border):</p>
<p>[% data_form_field_text_fullname_w400_h30_required %]</p>

<p>2. Email address (invisible field with dotted line):</p>
<p style="color: white;">[% data_form_field_text_email_w400_h30_noborder_email_required %]</p>
<p style="border-bottom: 1px dotted #999; width: 400px;"></p>

<p>3. Phone number:</p>
<p style="color: white;">[% data_form_field_text_phone_w250_h30_noborder_phone %]</p>
<p style="border-bottom: 1px dotted #999; width: 250px;"></p>

<p>4. Complete address:</p>
<p style="color: white;">[% data_form_field_text_address_w450_h30_noborder_required %]</p>
<p style="border-bottom: 1px dotted #999; width: 450px;"></p>

<p>5. Postal code: &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; City:</p>
<p>
  <span style="color: white;">[% data_form_field_text_zipcode_w80_h30_noborder_max5_comb %]</span>
  <span style="border-bottom: 1px dotted #999; width: 80px; display: inline-block;"></span>
  &nbsp;&nbsp;
  <span style="color: white;">[% data_form_field_text_city_w250_h30_noborder_required %]</span>
  <span style="border-bottom: 1px dotted #999; width: 250px; display: inline-block;"></span>
</p>

<p>6. Message or comments:</p>
<p style="color: white;">[% data_form_field_textarea_message_w480_h80_noborder_max500 %]</p>
<p style="border: 1px dotted #999; width: 480px; height: 80px;"></p>

<hr>

<p>Internal reference (invisible): <span style="color: white;">[% data_form_field_text_ref_w150_h20_noborder_readonly_default_REF-2025-001 %]</span></p>

<p><em>TIP: Dotted lines indicate where to write. Fields are invisible but functional. Markers are in WHITE.</em></p>

Technique to create this template:

1. In Word/InDesign/Canva:

   • Write the markers at field locations

   • Set marker text color to WHITE (invisible)

   • Manually draw dotted lines under the fields

   • Dotted lines remain visible, markers disappear

2. Result after processing:

   • Transparent AcroForms fields (noborder option)

   • Visible dotted lines to guide the user

   • Clean design without black rectangles

   • Functional in all PDF readers

Common Errors and Solutions

Marker Not Detected

Problem: The marker remains visible in the final PDF

Solutions:

1. Check the prefix data_form_field

   ✅ [% data_form_field_text_w200_h30 %]
   ❌ [% form_field_text_w200_h30 %]
   ❌ [% data_field_text_w200_h30 %]

2. Check the delimiters [% and %]

   ✅ [% data_form_field_text_w200_h30 %]
   ❌ {% data_form_field_text_w200_h30 %}
   ❌ [$ data_form_field_text_w200_h30 $]

3. No line breaks within the marker

   ❌ [% data_form_field_text_
       w200_h30 %]
   
   ✅ [% data_form_field_text_w200_h30 %]

Field Mispositioned

Problem: The field overflows or is offset

Solutions:

1. Adjust the w and h dimensions

2. Ensure there's enough space in the template

3. Align the marker properly in your design

Dropdown/Radio Without Options

Problem: The field is not created

Solution: Add options[...]

❌ [% data_form_field_dropdown_country_w250_h30 %]
✅ [% data_form_field_dropdown_country_w250_h30_options[France,Belgium,Switzerland] %]

Best Practices

1. Start simple: Test with 2-3 fields before creating a complete template

2. Name your fields: Use descriptive names for easier data processing

   ✅ [% data_form_field_text_user_email_w300_h30 %]
   ❌ [% data_form_field_text_w300_h30 %]

3. Test in preview: Always preview your template before generating documents

4. Use default values: Pre-fill common fields to facilitate input

   [% data_form_field_text_country_w200_h30_default_France %]

5. Align for readability: Align your fields for a professional appearance

6. Provide adequate spacing: Ensure markers have enough space around them

7. Document your fields: Keep a list of used fields and their purpose

8. Hide markers visually: To prevent markers from being visible under the form fields in the generated PDF, set the marker text color to match your background color (e.g., white text on white background). The form field will render on top, but any visible marker text won't show through.

   <span style="color: white;">[% data_form_field_text_name_w300_h30 %]</span>

9. Create elegant forms with borderless fields: Combine noborder option + white marker text + manually drawn dotted lines for a professional, clean design without visible form rectangles.

   <!-- Marker in white + dotted line underneath -->
   <p style="color: white;">[% data_form_field_text_email_w350_h30_noborder_email %]</p>
   <p style="border-bottom: 1px dotted #999; width: 350px;"></p>

10. Mix border styles strategically: Use classic borders for important required fields and borderless fields for secondary or optional information to create visual hierarchy.

Limitations

• Signature fields are not currently supported as interactive form fields

• Complex field validation beyond basic types (email, phone) is limited

• Fields work best with PDF Engine v5

See Also

• API Reference - Templates - Complete API documentation for template settings

• Styling your documents - Learn how to style your forms