Document Builder

Getting Started

The Document builder gives you all the necessary tools to help you build your document in a PDF format. You can include Document Headers, Text, Images, Tables, Page Breaks, etc.

Overview of Document Builder

Types of Merge Fields

Docupilot supports a variety of merge fields for you to use in your document builder.

  • Tokens (Merge Field)

  • Condition (IF / ELSE)

  • Loops

  • Tables

Docupilot supports easy ways to insert Merge fields into your document template. {{ }} button on the toolbar helps you insert the merge fields.

Tokens (Merge Field)

These are simple words embraced in {{}}. When you provide your custom data, Docupilot will replace these fields with the data. For example {{email}}, {{client_name}}, {{company_name}}.

If you want to group your fields you can use dot(.) while defining the tokens. For example if you want to capture your client's first name & last name, you can write the tokens as {{client.first_name}} and {{client.last_name}}

Condition (IF / ELSE)

You can use condition to show or hide contents based on your data. For example, if you are creating an invoice you want display PAID if the payment status field is paid, else you want to show UNPAID.

{{#if payment_status "==" "paid"}}
PAID
{{else if payment_status "==" "partial"}}
PARTIAL PAID
{{else}}
UNPAID, Insert Payment Instruction
{{/if}}

You can use condition in three ways

  • IF Statement.

  • IF - Else Statement.

  • IF - Else IF - Else Statement

Below are few examples :

Example

Description

{{#if payment_status}} {{/if}}

if payment_status is not empty or blank.

{{#if payment_status "==" "paid"}} {{/if}}

if payment_status equal to paid (case-sensitive).

{{#if payment_status "!=" "paid"}} {{/if}}

if payment_status not equal to paid (case-sensitive).

{{#if price ">" 1000}} {{/if}}

If price greater than 1000

{{#if price ">=" 1000}} {{/if}}

If price greater than and equal to 1000

{{#if price "<" 1000}} {{/if}}

If price lesser than 1000

{{#if price "<=" 1000}} {{/if}}

If price lesser than 1000

Hiding Empty Sections & Lines

You can use IF to hide sections/lines that do not have a value.

Hide section example
Name: {{name}}
{{#if address}}Address: {{address}}{{/if}}

In the above example when the Address is empty, the Address section will be removed.

Hide empty lines example
{{name}}{{#if address}}
{{address}}{{/if}}
{{city}}{{country}}

In the above example when the Address is empty, the Address empty line will be removed to achieve better document formatting.

Lists (Loops)

Lists are used when you want to print a list of items in your document. Docupilot supports three types of loops in document builder.

  • Simple List

  • Advanced List

  • Bulleted List

  • Numbered List

Simple Loop

{{#each items}}
{{this}}
{{/each}}
Output
Apple
Orange
Strawberry

Advanced Loop

You can use advanced loop, if you want to print list of items like line items. Think of this as a sub-form with multiple rows in your main form.

{{#each line_items}}
{{name}} ${{price}}
{{/each}}
Output
Iphone6 $799
Iphone7 $899
Iphone8 $999

Bulleted List

• {{#list services}}{{this}}{{/list}}

Numbered List

1. {{#list services}}{{this}}{{/list}}

Please use bullet insertion buttons from editor's tools pane for Bulleted and Numbered lists to work

Tables

A table is similar to an advanced list, but the data will be rendered in a table. For example, if you want to generate a invoice, you may want display a table with all the line items.

name

quantity

price

{{#each line_items }}

{{ name }}

{{ quantity }}

{{ price }}

{{/each}}

Hiding Empty Tables

You can use IF condition to hide empty tables, you should wrap the entire table inside a IF condition.

{{#if line_items}}
{{!...INSERT THE ABOVE TABLE IN THIS LINE...}}
{{/if}}

Filtering rows in a Table based on empty column value

name

quantity

price

{{#each line_items }}{{#if quantity}}

{{ name }}

{{ quantity }}

{{ price }}

{{/if}}{{/each}}

If the value for quantity is empty in any row, it will be skipped in the output table.

Filtering rows in a Table based on a column value

name

quantity

price

{{#each line_items }}{{#if name "==" "Iphone"}}

{{ name }}

{{ quantity }}

{{ price }}

{{/if}}{{/each}}

If the value for name is Iphone in any row, it will be skipped in the output table.

Inserting a dynamic image

This will be helpful if you want to insert dynamic image in the document.

Format - {{insert_image image1 width height}}

Example - {{insert_image image1 300 300}}

If you want to automatically adjust the height to keep proportions, you can use:

Example - {{insert_image image1 300}}

The image URL need to be publicly accessible so we can download and insert it in the document.

Inserting a dynamic QR Code

This will be helpful if you want to insert dynamic QR code from your data in the document.

Format - {{insert_qr url width margin}}

Example - {{insert_qr url 100 1}}

100 X 100 with margin 1 & value https://docupilot.app

Example - {{insert_qr url 100}}

100 X 100 with default margin 4 & value https://docupilot.app/

Inserting Google Maps

This will be helpful if you want to insert Google Maps from your data in the document.

Format - {{insert_map Location width height maptype}}

The supported map types are as follows. The default map type is roadmap.

  1. roadmap

  2. satellite

  3. hybrid

  4. terrain

Example - {{insert_map Location 500 500 "roadmap"}}

Location Value is Manchester

Page Break

If you want to format your document into multiple pages properly, you can use the page break option. The content after the page break will begin in a new page.

Google Fonts

Docupilot supports all Google fonts to help you maintain your branding. Once you finish building your document, you will need to add a small code snippet by clicking on the source button in the document editor. You will need to change the font family accordingly to the choice of your fonts. You can find the font family here https://fonts.google.com/.

<style type="text/css">body{
font-family: 'Tangerine', serif;
}
</style>
Google Fonts

Sometimes the document builder will not show the specified font but the document will be generated in the specified font.

Page Margins

Docupilot allows you to adjust the size of the top, bottom, left, right page margins in inches. You can set the margins in preferences -> More Options.

The default margin is 0.4 inches on all sides. You can also set it to zero.

Page Margins

Comments

You can add comments in the document template to help your future editors. The comments will be removed in the output document.

Comments Syntax : {{!Your comments here}}