0

Report Text

  • updated 3 yrs ago

Description


Report-text is a form part used in the Assessment Framework. It allows you to "echo back" the selections or text entries from users on the left side of the screen as reports on the right side of the screen. This part has few options except a text area that can be populated with text, html (e.g. URL links) and interpolated variables (e.g. $(my variable)) for use within longer text constructions.

Node Type: This is a form-part node.
 

Used With: Assessment Framework
 

Editor Fields

Field Name

Description/Use

Type/
Options

Optional/
Mandatory

HTML enabled

Check this box to open an HTML editor for the text box, that allows you to format text in a variety of ways including bold, italics, underline, bullet point and numbered lists, symbols and access to the underlying HTML for review and direct edit. 

On|Off

M

Text

Enter the report text here. Text can include variables referenced using the syntax $(my_variable) and see Tips and Tricks section below for creative ways to use this feature.

Note: All texts that are inserted via interpolation in the text-field are HTML encoded, to prevent XSS.

text

M

Skip interpolation

Check this box to leave any $(...) variable references unresolved. 

On|Off

M

Escape $(..)-text
v7.4 on

Check this box if your report text includes $(..) variables that should NOT be encoded. 
Example:

mytext = "<b>Hello</b>
$(mytext) will appear as Hello (off) or <b>Hello</b> (on)

If the text box contains several interpolations only some of which need to be escaped, use the $(html(mytext)) construction to turn off escaping for specific output. 

$(html(mytext)) appears as Hello 

 

On|Off

On by default (existing nodes)

Off by default (new nodes)

M

 

Tips and Tricks

 Displaying clickable URL link

To display a clickable link on the report panel, use this form part and the following HTML construction:
 

<a href="your-URL" target="_blank">Display Text</a>

Use Interpolation for text construction.


When the report-item part cannot deliver exactly the text you want to appear on screen, use this form part to create a custom display. Stringing multiple variables together for a verbose report can be done easier using this part, than trying to format several report-item nodes together.

For example, if your application output is a sentence including multiple variables of different types, you can use the Format Variable part to first convert your outputs into the right (date, list) format, then include them in this node to present on screen generating an output like this:

As of Monday July 1st, 3pm, the sky is blue today, with a few clouds. Rain is expected on Tuesday, Wednesday and Friday .

This string can be created using this entry in the HTML node, preceeded by two format variable nodes to define time of day and rain forecast variables.
As of $(time_of_day_formatted),  the sky is $(sky_color) today, with $(cloud_cover) clouds. Rain is expected on $(rain_forecast_days_formatted_as_list)

General Notes


The Designer User can use this node for simple text, and for text that requires more finely tuned formatting/styling. Click the HTML enabled checkbox to access the HTML editor for access to customization tools - see graphic below for examples.

Note that the URL and Wikipedia buttons will NOT correctly generate URL links in the report panel - see Displaying Clickable URL  above.

 

Reply Oldest first
  • Oldest first
  • Newest first
  • Active threads
  • Popular
Like Follow
  • 3 yrs agoLast active
  • 69Views
  • 3 Following

Home