Template elements

This section briefly describes the elements you can use when building a template.
Icon Name Description Container Hosts data
Paragraph Is an element that can have other elements inside it like text, table and so on. A paragraph cannot contain data directly. Adds a carriage return into the output then renders its child elements. Yes No
Container Similar to paragraph with 2 exceptions:
  • Cannot be styled.
  • Does not add a carriage return into the output.

When used in a table, the container can host only row elements.

When used in a row, the container can host only cell elements.

When used in a list, the container can host only list-detail elements.

Yes No
Text The basic block for building templates. Renders its content with the specified formatting. The formatting is applied to the whole content. Can contain data but cannot contain other elements. No Yes
Styled text A block of text that can have basic formatting at word level. The text is static. No Yes
Hyperlink Adds a hyperlink in the output. The hyperlink can point to a location inside the document or to an external location. No Yes
Image Inserts an image into the output. The image can be taken from the template or have its path calculated at runtime. No Yes
Table A table can contain rows or Container elements. Creates a table in the output then renders its child elements, rows or containers. Yes No
Row Creates a row in the current table (direct child or inside a container in a table), then renders its child elements (cells). Yes No
Cell Creates a cell in the current row of the current table then render its child elements (any). Yes No
List Creates a list in the output then renders its child elements (list items). Yes No
List detail Creates a list item in the current list in the output then renders its child elements (any). Yes No
Data source configuration See Configuring data sources. No No
Include file Includes the specified file in the output as an “INCLUDETEXT” field.

Supported on Word output only.

You need to update all fields in the Word document in order to see the included file.

No Yes
Footnote Creates a footnote in the current output page. The text of the footnote is the content of the footnote element. Supported on Word output only. No Yes
Region Defines a region that will host elements. If an element has the region property specified, it will be rendered in the specified region instead of the current position in the document. You can define elements inside the region. No No
Bookmark Defines a bookmark in the document. The name of the generated bookmark is the content of the bookmark element. When generating the documents, Rational® Publishing Engine will generate a unique name for each bookmark. The name is based on the name provided at design time and a unique identifier generated at runtime. No Yes
Comment Adds a comment element into the output. The form and shape of the output comment is specific to the output format. The comment's text is taken from the template element content.

Supported on Word and PDF.

No Yes
Page Break Adds a page break to the output. No No
Section Break Adds a section break to the output. No No
Table of Contents Adds a table of contents to the output. No No
Table of Tables Adds a table of tables to the output. You need to add Table Captions in your document template for this table to contain anything.

Supported on Word output only.

You need to update all fields in the Word document in order to see/update the value of the field.

No No
Table of Figures Adds a table of figures to the output. You need to add Figure Captions in your document template for this table to have the captions listed above the table.

Supported on Word output only.

You need to update all fields in the Word document in order to see/update the value of the field.

No No
Field Adds a generic Word field element. You can type any valid Microsoft Word code in the field code property.

Supported on Word output only.

You need to update all fields in the Word document in order to see/update the value of the field.

No No
Page Number Adds a page number in the output. Supported on Word and PDF output only. No No
Total Pages Number Adds the total number of pages in the output. Supported on Word and PDF output only. No No
Table Caption Adds a table caption. While you cannot specify dynamic content into a table caption, any subsequent text element will be concatenated to it.

Supported on Word output only.

You need to update all fields in the Word document in order to see/update the value of the field.

No No
Figure Caption Adds a figure caption. While you cannot specify dynamic content into a figure caption, any subsequent text element will be concatenated to it.

Supported on Word output only.

You need to update all fields in the Word document in order to see/update the value of the field.

No No

Feedback