Extension | Format of generated document |
---|---|
.doc | Microsoft Word 2003. |
.docx | Microsoft Word 2007, without the ability to run macros. |
.docm | Microsoft Word 2007, with the ability to run macros. |
Element | Description | Can contain other elements | Can contain data |
---|---|---|---|
![]() |
Use to group a section of elements. Adds a carriage return around its child elements in the output. | Yes | No |
![]() |
Use to group a section of elements.
Cannot be styled and does not affect the formatting of the output. When
used inside other elements, the child elements available to use within
the container might be limited. For example:
|
Yes | No |
![]() |
The content renders with the same, specified formatting. | No | Yes |
![]() |
A block of text that can have unique formatting on individual words. Use bold, italic, underline, strikeout, or color formatting on a selection of words within the element. The text is static. | No | Yes |
![]() |
Creates a hyperlink in the output. The hyperlink can point to a location inside the document or to an external location. | No | Yes |
![]() |
Displays a .gif, .png, .jpg, emf, or wmf image in the output. The report designer can specify the image path in the template or the report generator can specify the path at run time. | No | Yes |
![]() |
Creates a table in the output. A table can contain rows or container elements. | Yes | No |
![]() |
Creates a row in the current table. | Yes | No |
![]() |
Creates a cell in the current row of the current table. | Yes | No |
![]() |
Creates a bulleted or numeric list in the output. | Yes | No |
![]() |
Creates a list item in the current list in the output. | Yes | No |
See Adding a data source configuration element. | No | No | |
![]() |
Includes the specified file in the
output as an INCLUDETEXT field.
|
No | Yes |
![]() |
Creates a footnote in the current output page. The text of the footnote is the content of the footnote element. Supported for Microsoft Word output only. | No | Yes |
![]() |
Regions are static elements that allow you to alter the output flow by redirecting the content of other elements or groups of elements. If an element has the target region property specified with the name of a region element, its content renders in the specified region instead of in its position in the document. | No | No |
![]() |
Defines a bookmark in the document. The name of the generated bookmark is the content for the bookmark. When generating the documents, Rational Publishing Engine generates a unique name for each bookmark. The name is based on the name provided at design time and a unique identifier generated at run time. | No | Yes |
![]() |
Adds a comment to the output. The form
and shape of the output comment is specific to the output format. Supported for Microsoft Word and PDF. |
No | Yes |
![]() |
Adds a page break to the output. | No | No |
![]() |
Adds a section break to the output. | No | No |
![]() |
Adds a table of contents to the output. | No | No |
![]() |
Adds a table of tables to the output.
You must add Table Captions in your document template to generate
a table of tables in the output. Supported for Microsoft Word output only. You must update all fields in the Microsoft Word document to see and be able to update the value of the field. |
No | No |
![]() |
Adds a table of tables to the output.
You must add Table Captions in your document template to generate
a table of tables in the output. Supported for Microsoft Word output only. You must update all fields in the Microsoft Word document to see and be able to update the value of the field. |
No | No |
![]() |
Adds a generic Microsoft Word field element. You can type
any valid Microsoft Word
code in the field code property. Supported for Microsoft Word output only. You must update all fields in the Microsoft Word document to see and be able to update the value of the field. |
No | No |
![]() |
Adds a page number in the output. Supported in Microsoft Word and PDF output only. | No | No |
![]() |
Adds the total number of pages in the output. Supported for Microsoft Word and PDF output only. | No | No |
![]() |
Adds a table caption. While you cannot
specify dynamic content into a table caption, any subsequent text
element is concatenated to it. Supported for Microsoft Word and PDF outputs. You must update all fields in the Microsoft Word document to see and be able to update the value of the field. |
No | No |
![]() |
Adds a figure caption. While you cannot
specify dynamic content in a figure caption, any subsequent text element
is concatenated to it. Supported for Microsoft Word and PDF outputs. You must update all fields in the Microsoft Word document to see and be able to update the value of the field. |
No | No |
Cell properties | Notes® |
---|---|
Border width | You must specify a border width value between 1 and 30 pixels to create a border in the output. |
Cell alignment | This property specifies the position of the text within the cell. The justify value is not supported for this output format. |
Cell width | Enter a value in points or pixels. If you enter a value in pixels, the value is converted to points and assumes that the display is 96 dpi. If you enter a value as a percentage, the value is ignored. When you are combining tables, you must set the cell width property to ensure that the column sizes are the same. |
Comment properties | Notes |
---|---|
Content | If you include hyperlinks in the Content property of Comment elements, the hyperlinks are not clickable in the Microsoft Word output. |
Figure caption properties | Notes |
---|---|
Border width | Do not use for this output format. |
Field code | Arabic or Roman numerals display sequentially on each caption. |
Footnote properties | Notes |
---|---|
Style name | If you apply a style to inline elements such as footnotes, text, styled text, or tables, the style is applied to all of the inline elements until the next block element, such as a paragraph. For example, if you add a style to a footnote element and there is a styled text element before it, the style is also applied to the styled text element. |
Image properties | Notes |
---|---|
Border width | Do not use for this output format. |
Content | Supported image formats: .bmp, .emf, .gif, .jpg, .png, .wmf .svg images are supported by Rational Publishing Engine, but are not supported by Microsoft Word. To generate the document correctly into Microsoft Word output, .svg images are converted to .png images. The conversion process can distort the display of the image in the output. |
List-detail properties | Notes |
---|---|
Border width | Do not use for this output format. |
Page number properties | Notes |
---|---|
Border width | Do not use for this output format. |
Paragraph properties | Notes |
---|---|
Border width | You must specify a border width value between 1 and 30 pixels to create a border in the output. |
Paragraph alignment | Space the text across the page with a
certain alignment. Left, right, and center alignment, creates uneven paragraph edges, fitting as many words in a paragraph as possible. Justify creates even paragraph edges by inserting additional space between words on all lines except the last line. Distributed is similar to justify, except that space is also inserted between words in the last line of the paragraph. |
Widow/orphan control | When set to true, the line spacing is
adjusted to prevent the following formatting results:
When set to false, spacing is not adjusted. |
Row properties | Notes |
---|---|
Row break across pages | When set to true, the content of a row
that comes at the end of a page is split, if necessary. The content
that does not fit on the page carries over onto the next page as a
new row. When set to false, the content of a row that comes at the end of the page is not split. The whole row carries over onto the next page. |
Styled text properties | Notes |
---|---|
Style name | If you apply a style to inline elements such as footnotes, text, styled text, or tables, the style is applied to all of the inline elements until the next block element, such as a paragraph. For example, if you add a style to a footnote element and there is a styled text element before it, the style is also applied to the styled text element. |
Table properties | Notes |
---|---|
Autofit to contents | Resizes the table to fit the content each cell contains. When you use this property, also set the Resize to fit contents property to true. |
Border width | You must specify a border width value between 1 and 30 pixels to create a border in the output. |
Border style | Use the value single instead of thick, hairline, inset, or outset. The same formatting is applied for all of these values and most closely resembles what you would expect to see for single. |
Fixed cell width in column | Specify a value in pixels to ensure that all of the cells in a column are the same width. |
Resize to fit contents | When set to true, lines
do not break unless a space is present. When you do not have space,
lines do not break and the column width is increased to the width
of the text. If autofit to contents is set,
you must set resize to fit contents to true. When set to false, the column width is fixed and the lines break regardless of the spaces used or the length of the text. Also, the table auto fit property is ignored. |
Style name | If you apply a style to inline elements such as footnotes, text, styled text, or tables, the style is applied to all of the inline elements until the next block element, such as a paragraph. For example, if you add a style to a footnote element and there is a styled text element before it, the style is also applied to the styled text element. |
Table auto fit | When set to true, the table is resized to fit
the width of the page. When resize to fit contents is
also set to true, cell widths are ignored and the table is resized
to match the content. You cannot enter fixed column width as a value. Use the fixed cell width property instead. |
Width | You must specify a value. |
Table caption properties | Notes |
---|---|
Border width | Do not use for this output format. |
Field code | Arabic or Roman numerals display sequentially on each caption. |
Text properties | Notes |
---|---|
Border width | You must specify a border width value between 1 and 30 pixels to create a border in the output. |
Style name | If you apply a style to inline elements such as footnotes, text, styled text, or tables, the style is applied to all of the inline elements until the next block element, such as a paragraph. For example, if you add a style to a footnote element and there is a styled text element before it, the style is also applied to the styled text element. |
Total pages number properties | Notes |
---|---|
Border width | Do not use for this output format. |
Long tables might need to carry over onto more than one page. When this requirement arises, select a Row element in the table and in the Properties view, set the row break across page property to true. With that property set, your tables can continue across multiple pages.
Action | Result |
---|---|
Select the entire document content and use the Update fields function in Microsoft Word. | The OLE objects are displayed in the document. The document is not self-contained. |
Use the updateFields macro provided by Rational Publishing Engine. | The OLE objects are displayed in the document. The document is not self-contained. |
Use the insertOLEs macro provided by Rational Publishing Engine. | The OLE objects are displayed in the document. The document is self-contained. |
Use the rpe or insertOLEs macros provided by Rational Publishing Engine. | The OLE objects are displayed in the document. The document is self-contained. |