Document Markup

Markup is recognised at various places within a document:
  • the body of the document
  • the page headers and footers associated with a section
  • inserted footnotes and endnotes
Only markup within the body and markup within the headers and footers contributes towards the relevancy of variables. Markup within footnotes and markup within endnotes does
not
contribute towards relevancy.
Also, relevancy derived from markup within headers and footers does not take into account any conditional spans in the document body which may determine that section's inclusion. That is, markup within each header and each footer is treated as if it were markup within the document body itself.

Tips and Restrictions on using markup

In the document body:
  1. Each include or attach field must be on its own paragraph
  2. Spans that span multiple paragraphs must begin at the beginning of a paragraph and end at the end of a paragraph
  3. If you want to make a row in a table conditional, put the brackets inside the table - at the beginning and end of the row text (see Cell prefix: spans and tables for more on working with tables)
  4. Use a table break to span multiple rows in a table (see Cell prefix: spans and tables for more on working with tables)
  5. Spanning auto-numbered paragraphs means the open bracket goes before the start of the text of that paragraph not the auto-number itself- eg it is the text that is conditional; the numbering comes from the paragraph style applied
In headers, footers, footnotes and endnotes:
  1. Include fields are not allowed: this applies to include picture, include text file and include template
  2. Hyperlink fields are also not allowed
When controlling section breaks:
If all the text in a section is surrounded by span brackets the section will become conditional. It is best to view the template in outline view with paragraph marks turned on to ensure you do not have a trailing paragraph mark in the section as this will make the section unconditional.
Consider the below image of a template viewed in outline view in Word:
Section 2 shows an unconditional section break. Not only does it have text outside the span, but it also has a trailing paragraph mark that will make the section always appear in the generated document.
Section 3 shows a conditional section. All the text is surrounded in span brackets and there is no trailing paragraph mark i.e, the closing span bracket is right up against the section break mark. Therefore if the span evaluates to false, the entire section 3 will be removed including its section information such as landscape page layout

Related content