Visual indicators

Review this legend for examples of the images you might see in Rational® Publishing Engine.


Template visual indicators

Review this legend for examples of the images you might see in a template after applying various things like filters, conditions, attributes, and more. Each example is taken from a template in the source folder so you can see how each is being used in the broader context of the template.

Attribute

When you apply an attribute to an element, the name of the attribute displays in the template content editor:

Cell element with a query applied

Image taken from the RPE_HOME\source\DOORS\examples\doorsData.dta template.


Condition

When you apply a condition to an element, the element displays with an Condition icon icon in the template content editor:

Conditions icon on a Paragraph element

Image taken from the RPE_HOME\source\REST\examples\Tutorial_REST.dta template.


Filter

When you apply a Rational Publishing Engine or native filter to an element, the element displays with an Filtering icon icon in the template content editor.

A paragraph element with a query and a filter applied

Image taken from the RPE_HOME\source\REST\examples\ReqProSRRequirements.dta template.


Formatting properties

When you add formatting to an element by applying it to an element in the Properties view, the element displays with an asterisk (*) in the template content editor:

Table caption element with an asterisk

Image taken from the RPE_HOME\source\DOORS\examples\doorsData.dta template.


Master page

When you apply a master page to an element, the element displays an Master page icon icon in the template content editor.

Master page icon on a Container element

Image taken from the RPE_HOME\source\DOORS\examples\Tutorial_DOORS.dta template.


Query

When you apply a query to an element, there are three visual indicators that display in blue by default in the template content editor:
  • The data source schema name
  • The context displayed with a dollar sign ($)
  • The query name
Cell element with a query applied

Image taken from the RPE_HOME\source\DOORS\examples\doorsData.dta template.


Style

When you add formatting to an element by applying a style, the element displays with an Outline styles icon icon in the template content editor:

Hyperlink element with a style applied

Image taken from the RPE_HOME\source\REST\examples\Tutorial_REST.dta template.


Sort

When you add a Rational Publishing Engine or native sort to an element, the element displays an Sort icon icon in the template content editor.

Sort icon in a Row element

Image taken from the RPE_HOME\source\DOORS\examples\doorsNativeSort.dta template.


Variable assignment

When you assign a variable to an element, the element displays an Variable assignment icon icon in the template content editor.

Paragraph element with a query and a variable assignment

Image taken from the RPE_HOME\source\DOORS\examples\doors-discussions\doorsObjectDiscussions.dta template.


Variable with an expression

If you added a data or script expression, an example variable in the element might look like this in the template:

Variable with a data expression applied to a Text element.

Image taken from the RPE_HOME\source\DOORS\examples\Tutorial_DOORS.dta template.


Document specification visual indicators

Review this legend for examples of the images you might see in a document specification.

Unconfigured properties

When there are properties to be configured, parts of the tree structure in the Document specification view display in red color with an asterisk (*).

Data sources appear as unconfigured when the URI property is not specified. You are not required to enter a value to generate a document, but if you do not enter a value, your generated document might not include the correct data.

An unconfigured Generic XML data source

Output formats display as unconfigured when the path property is not specified. You are not required to enter a value to generate a document; the output is not affected. If there is no value, the generated output is saved to a temporary location.

An unconfigured HTML output


Document generation wizard visual indicators

Review this legend for examples of the images you might see in the document generation wizard.

Current page

Each data source and variable are configured in individual pages within the section. The Current page icon icon displays in the progress bar to show you which data source or variable you are configuring.

Current page in the progress bar

Current section

The significant areas to be configured are Templates, Data sources, Variables, and Output. As you are configuring these sections, they display with a Current section icon icon in the progress bar.
Current section in the progress bar

Unconfigured properties

When there are properties to be configured, data sources in the tree structure and summary in the Document generation wizard display with an asterisk (*).

Data sources appear as unconfigured when the URL or file path to the data source is not specified. You are not required to enter a value to generate a document, but if you do not enter a value, your generated document might not include the correct data.

Data source section:

An unconfigured Generic XML data source in the Data sources section of the progress bar

Summary page:

An unconfigured Generic XML data source in the Summary page

Viewed section

After you move past a section in the progress bar, the section displays with a Viewed section icon icon.

Configured templates page in the progress bar


Properties view

Review this legend for examples of the images you might see in the Properties view in either the Document Studio or Launcher application.

Browse

To configure a property in the Document Studio or Launcher application Properties view, you can type a value or you can click the Browse icon Browse icon. If you click the Browse icon Browse icon, you can select a value, enter a condition, or enter a script.

Font property in the Document Studio application Properties view


Feedback