Difference between revisions of "Show in Documentation (Simulation macro property)"

From SAP Enable Now Wiki
Line 7: Line 7:
 
==Purpose==
 
==Purpose==
 
This property determines whether or not the Bubble Text (either '''[[Demo Text]]''' or '''[[Practice Text]]''' depending upon the [[Document Settings]] for the parent macro) is included in the generated document. By default it is selected (which means that the text ''will'' be included).
 
This property determines whether or not the Bubble Text (either '''[[Demo Text]]''' or '''[[Practice Text]]''' depending upon the [[Document Settings]] for the parent macro) is included in the generated document. By default it is selected (which means that the text ''will'' be included).
 +
 +
For the '''[[Branch Begin]]''' macro, if this property is selected, a sub-heading (one level below the Step heading) will be inserted, with a title of "Branch - select one of the following actions:" followed by the Bubble text for each option. If this property is not selected, this heading will not be included, and each Bubble text will be listed as a separate 'action' (just like all other action macros); there is no indication that these are exclusive choices.
  
 
[[Category:Property]]
 
[[Category:Property]]

Revision as of 22:24, 21 August 2019

Scope

  • Simulation content object > action macro > Documentation > Show in Documentation property
  • Simulation content object > Branch Begin macro > Documentation > Show in Documentation property
  • Simulation content object > Explanation macro > Documentation > Show in Documentation property
  • Simulation content object > Screen macro > Documentation > Show in Documentation property

Purpose

This property determines whether or not the Bubble Text (either Demo Text or Practice Text depending upon the Document Settings for the parent macro) is included in the generated document. By default it is selected (which means that the text will be included).

For the Branch Begin macro, if this property is selected, a sub-heading (one level below the Step heading) will be inserted, with a title of "Branch - select one of the following actions:" followed by the Bubble text for each option. If this property is not selected, this heading will not be included, and each Bubble text will be listed as a separate 'action' (just like all other action macros); there is no indication that these are exclusive choices.