A Woodpecker field is just like a field in any template or form.
Inserting fields in your document allows you to identify the content that is likely to change. That content can then be dynamically updated with the field values you enter into the Woodpecker side panel.
There are 9 different field types.
Single line text
"Single line text" fields allows for simple, flexible, one-line text entries.
Use this field type for simple information that doesn't need to be formatted in any special way. This is the field type that you will likely use most often.
Multi line text
"Multi line text" fields are like single line text fields, but with the added flexibility of multiple lines. In order to insert a new line, simply press "Enter", and a new line break will be inserted at your cursor location.
Use this field type for fields that require multiple paragraphs without special formatting.
"Rich text" fields allow for multi-line, rich text formatting. This means that you can specify fonts, colors, bullets, numbers, and much more!
Use this field type whenever you have data that needs to to have a specific format.
"Date" fields allows you to specify a date using a date-picker. Woodpecker formats the date you select according to a specified date format.
If specify a default value for a date field (for example "today"), each time you open your document the date will automatically be set to today.
"Number" fields only allow inputting numbers. Use this field type to restrict the information that can be entered to only numerical characters, usually for things like currency amounts, term lengths, or ages.
"Single select" fields allow you to specify a list of predefined options that can be selected between via a dropdown.
Use this field type whenever you have a finite set of options for a field. For example: a list of statuses, list of addresses, or list of people's names.
"Multi select" fields allow you to specify a list of predefined options, where any option or combination of options can be selected via a dropdown. When the field is inserted into the document, the values are joined by a separator of your choice.
Use this field type whenever you have a finite set of options for a field and you want to select a combination of them.
"Conditional" fields allow you to specify a list of conditions that dictate the value for the field. These conditions take into account the values of other fields within your document and can be really helpful when dealing with varying words, phrases, or clauses.
For example, you may have a "Spouse name" conditional field that depends on a "Marital status" field. If "Marital status" is "Married", then the "Spouse name" field would become active.
“Formula” fields allow you to specify dynamic calculations that depend on the values of other fields within your document. “Formula” fields support almost any Excel operation and can be chained together.
Each Woodpecker field has several attributes that you can specify:
Field Name (required)
The name of your field can be anything that you want it to be. Numbers, text, special characters, anything!
Field type (required)
Each Woodpecker field can be one of the five field types mentioned above.
You can specify a default value for almost any Woodpecker field. If a field has a default value, and a custom value hasn’t been specified for the field, the field will be pre-populated with the default value whenever Woodpecker is launched.
For example, if you specified a default value of "Today" for a date field, whenever you launch Woodpecker your "Date" field would automatically be set to today's date. Woodpecker maintains a hierarchy for what values to pre-populate fields with when the app launches. Below is the order in which Woodpecker will pre-fill a field with a value:
- “Custom value” - any time you manually enter a value into a field, it will stick across subsequent launches of the app. To wipe a custom value, simply click the “Clear all” button at the bottom of the app.
- “Default value” - if there has been no “custom value” entered and the field has a default value specified, the field will be assigned its default value.
- “Blank” - if there is no “custom value” and no default value, the field will be blank.
Guidance notes (optional)
You can specify guidance notes for a field that describes what the field does and what type of information should be entered into it. Guidance notes are useful for other people who will use your template.
Format (Date and Formula fields only)
The "format" attribute only applies to "Date" and “Formula” fields and allows you to select a date or number format. For example, you may want your date to appear as "March 1st, 2018" or to appear as "03/01/18".
Choices (Single select fields only)
The "choices" attribute only applies to "Single select" fields. A single select field allows you to specify a predefined list of options that can be chosen from. The "choices" attribute gives you a set of input fields (as many as you want) to specify what choices should be available.
Conditions (Conditional fields only)
The "conditions" attribute only applies to "Conditional" fields. A conditional field allows you to specify a list of conditions (as many as you want) that dictate the value of the field. These conditions allow you to specify that the value for a "Conditional" field should be determined by the value of other fields within your document.
Formula (Formula fields only)
The “formula” attribute only applies to “Formula” fields and allows you to specify an Excel-like formula based on your other Woodpecker fields. See the “Formula” field documentation for more details.