Word Import Annotations
Published:
Updated:
Every code the Word importer understands, with its options: the element types, the layout codes, the properties that set IDs, tags, rules and validations, and the control codes used with import templates.
Overview
An annotation is a code in curly brackets typed into the Word document where the element should be, for example {DATE} or {NUMBER|#part_number}. Text immediately before a code becomes the element's label. Options follow a pipe inside the brackets. How to import a document and where annotations pay off is covered in Import a Form from a Word Document; this page is the list to look codes up in.
Details
Element types
| Code | Options | Creates |
|---|---|---|
| {DATE} | {DATE|format=YYYY.MM.DD} | Date input, with an optional date format |
| {DATETIME} | {DATETIME|format=YYYY.MM.DD HH:mm} | Date and time input |
| {TIME} | {TIME|format=HH:mm} | Time input |
| {DECIMAL} | Decimal number input | |
| {NUMBER} | Whole number input | |
| {TEXT} | Text input on one line, growing in height to show all text | |
| {TEXTAREA} | Text input that allows line breaks | |
| {BOOLEAN} | Toggle, True/False or Yes/No | |
| {MULTI} | {MULTI|options:Banana,Orange,Mango} | Multiple Select, shown as checkboxes |
| {SINGLE} | Single Select, shown as a dropdown or radio buttons | |
| {OPTION} | One option of a {BOOLEAN}, {MULTI}, {OPTION} or {SINGLE} | |
| {SLIDER} | Slider with a start and end value | |
| {AUDIO} | Audio recording or upload | |
| {FILE} | File upload | |
| {IMAGE} | Image capture or upload | |
| {VIDEO} | Video capture or upload | |
| {GPS} | Location capture | |
| {LINK} | Link to a file, a website or a repeat | |
| {SIGNATURE} or {SIGN} | Signature capture | |
| {MULTIMEDIA:URL} | Display of an image, video or audio file, not a capture. Pictures in the document become this automatically | |
| {LINE} | Horizontal line between elements | |
| {SPACER} | Vertical space between elements | |
| {LABEL} | Text without an input, such as a heading. Every paragraph without a code becomes a label | |
| {PAGE_BREAK} | A page break | |
| {REPEAT_SUB|reference=elementid} | {REPEAT_SUB|reference=elementid;description=Description template} | Filtered view of a repeat. The reference is another repeat's Element ID, without the hash |
| {ACTION|action=print} | action=print, state, finish, save, close, view or settings | A button, the same as those on the summary page |
Layout
| Code | Options | Effect |
|---|---|---|
| {GROUP_START} and {GROUP_END} | Elements between the two codes form a group. The first text without a code becomes the group title | |
| {ACCORDION_START} and {ACCORDION_END} | As a group, but collapsible | |
| {REPEAT_START} and {REPEAT_END} | {REPEAT_START|#elementid}, required when used with {REPEAT_SUB} | Elements between the two codes form a repeat, a sub form. The first text without a code becomes the repeat title |
Properties on an element code
Replace TYPE with the element type, for example {TEXT|#customer_name}. Several properties can be combined: {TEXT|#elementid;?ruleid}.
| Code | Effect |
|---|---|
| {TYPE|#elementid} or {TYPE|elementid=elementid} | Sets the Element ID, needed for rules, prefill and standard IDs |
| {TYPE|@tag} or {TYPE|tag=tag} | Adds a tag to the element |
| {TYPE|#elementid;?ruleid} or {TYPE|ruleid=ruleid} | Adds the element to every action of a rule, for branching and skip logic. The element needs an Element ID of its own, and the rule must exist in the document or in the import template. The rule ID is the automatic Element ID made from the rule's title |
| {TYPE|%validationid} or {TYPE|validationid=validationid} | Copies the input validation of the referenced element. The validation must exist in the document or in the import template |
| {TYPE|$calculationid} or {TYPE|calculationid=calculationid} | Copies the calculation of the referenced element |
Control and configuration
These codes steer the import itself and are mostly used together with an import template, a form in a collection named Import Templates whose elements are added to every imported form.
| Code | Effect |
|---|---|
| {START|#elementid} | Adds the imported elements after the referenced element in the import template. Without it, or when the element is not found, the elements go on a new page |
| {MOVE|#elementid} | Moves an element defined earlier, in the document or in the import template, to this position |
| {COPY|#elementid} | Inserts a copy of an element defined earlier |
| {REPLACE|#elementid} | Replaces the preceding text with a copy of an element defined earlier |
| {DELETE|#elementid} | Removes the element with this ID, useful for clearing template elements that are not needed |
| {SET_DEFAULT_CHECKBOX|#elementid} | Chooses which Multiple Select in the import template plain checkboxes become. Can be switched part way through the document |
| {SETTINGS|header=false;footer=false} | Ignores the document's header and footer |
| {SETTINGS|disable=#abc,@123} | Sets the starting state of elements by ID or tag. Keywords: disable, hide, readonly, mandatory, and their reverses enable, show, active, optional. Several can be combined: {SETTINGS|disable=#abc,@123;mandatory=@456,#xyz} |
| {ROW|&ruleid#elementid} | Applies a rule, tag or ID to a table row. Placed in a cell of that row |
| {APPLY_TABLE|&ruleid#elementid} | Applies a rule, tag or ID to a whole table. Placed in a cell of the table |
