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.

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}}

Previewing and Editing an HTML Template

Choose your preferred template. Upon selection, you'll be able to Preview it. To modify the template, click the "Edit" button.

Condition (if-else)

You can use conditional statements to show or hide contents based on your data.

Conditional statements have the following syntax:

• {{#if (a == b)}} a and b are same {{else if (c != d)}} c and d are not same {{/if}}

• {{#if (count > 3)}} count is greater than 3{{/if}}

• {{#if (item in "apple, ball")}} is apple or ball{{/if}}

The syntax can be extended to support more complex use-cases:

• {{#if (a == b or a == c)}} a is same as b or c {{/if}}

• {{#if (color == "red" or color == "blue")}}this is either red or blue{{/if}}

• {{#if (color == "red" and item == "ball")}}this is a red ball{{/if}}

• {{#if ((color == "red" and item == "ball") or (color == "blue" and item == "hat"))}}this is either a red ball or a blue hat{{/if}}

• {{#if (color in "red, blue")}}this is either red or blue{{/if}

• {{#if ("red, blue" contains color)}}this is either red or blue{{/if}}

For example, If you are creating an invoice, you want to display CASH if the payment_mode is cash, else if the payment_mode is the card you want to show CARD.

{{#if (payment_mode == "cash")}}
CASH
{{else if (payment_mode == "card")}}
CARD
{{else}}
Please Insert preferred Mode of Payment{{/if}}

To use conditional statement for checking inverse or negation of a condition, use the not in the condition. For example, to add an instruction requesting to add secure link if payment mode is not available on record:

{{#if (not payment_mode)}}
Please Add your payment details in this secure link: <your secure payment link>
{{/if}}

You can use the conditional statements in three ways

• if

• if-else

• if-else if

• if-else if-else

• if-else if-else if

• if-else if-else if-else

• and so on

Below are a few examples:

Hiding Empty Sections & Lines

In the following example, when the address field has a value, it gives desired outcome. If the address is empty, it leaves an empty line in the output.

{{customer_name}},
{{#if address}}{{address}},{{/if}}
{{city}}, {{country}}

customer_name = John Doe
street = WinWood St.
city = NY
country = US

John Doe,
WinWood St.,
NY, US

customer_name = John Doe
city = NY
country = US

John Doe,

NY, US

To hide empty lines, we should open the if condition in previous line or close it in next line. Here are examples on how the output will look like when street address is passed and when it is not:

{{customer_name}},{{#if street}}
{{street}},{{/if}}
{{city}}, {{country}}

customer_name = John Doe
city = NY
country = US

John Doe,
NY, US

{{customer_name}},{{#if street}}
{{street}},{{/if}}
{{city}}, {{country}}

customer_name = John Doe
street = WinWood St.
city = NY
country = US

John Doe,
WinWood St.,
NY, US

{{customer_name}},
{{#if street}}{{street}},
{{/if}}{{city}}, {{country}}

customer_name = John Doe
city = NY
country = US

John Doe,
NY, US

{{customer_name}},
{{#if street}}{{street}},
{{/if}}{{city}}, {{country}}

customer_name = John Doe
street = WinWood St.
city = NY
country = US

John Doe,
WinWood St.,
NY, US

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}}

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}}

Iphone6 $799
Iphone7 $899
Iphone8 $999

Bulleted List

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

Numbered List

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

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.

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

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

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

Lookbacks

Lookbacks allow you to access parent context within a nested context. For example, you can access a variable that is outside the loop from inside it.

Format: {{../token_name}}

For example, if your input data for generating an invoice contains of CustomerName, DiscountPercentage and LineItems and you want to render DiscountPercentage against each line item, to access it you need to use {{../DiscountPercentage}} inside the loop {{#each LineItems}} ... {{/each}}

                                Sales Invoice

Customer: {{CustomerName}}
Membership Discount: {{DiscountPercentage}} %

{{#each LineItems}}
{{ProductName}} | {{Quantity}} | {{UnitPrice}} | {{../DiscountPercentage}}%
{{/each}}

Thank you for your business

Inserting a dynamic image

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

Format : {{insert_image image1 width="width" height="height"}}

Inserting a QR Code

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

Format: {{insert_qr url size="qr_size" margin="qr_margin" color="qr_color(in hex values)"}}

Example: {{insert_qr url size="100" margin="1"}}

Example: {{insert_qr url size="100"}}

Example: {{insert_qr url margin="7"}}

Example: {{insert_qr url color="0000FF"}}

Inserting a Barcode

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

Format: {{insert_barcode name format="barcode_format" bar_width="width" height="height" margin="barcode_margin" color="color" background_color="bg_color" display_value=true/false}}

Example: {{insert_barcode item_name}}

Example: {{insert_barcode name format="CODE39"}}

Example: {{insert_barcode name bar_width="3"}}

Example: {{insert_barcode name format="CODE128" bar_width="2" height="25"}}

Example: {{insert_barcode name format="CODE128" bar_width="2" display_value= false}}

Example: {{insert_barcode name height="50" margin="10"}}

Example: {{insert_barcode name height="50" color="FF0000"}}

Inserting a Barcode with a Transparent Background

This is useful if you need to insert a barcode with a transparent background into your document.

Format: {{insert_barcode name bg_color='#ffffff00'}}

Inserting Google Maps

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

Format: {{insert_map Address width="width" height="height" map_type="maptype"}}

Example: {{insert_map Location width="500" height="500" map_type="roadmap"}}

Example: {{insert_map Location map_type="roadmap" zoom= "20"}}

Example: {{insert_map Location height="300" zoom= "5"}}

Grid Helper

The Grid Helper will render the list input in a grid format, with specified column size.

Syntax: {{#grid items col_size=3}} {{@item1.title}}{{@item2.title}}{{@item3.title}} {{/grid}}

Example :

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>

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 -> Advance settings.

Comments

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