Difference between revisions of "Show in Documentation (Simulation macro property)"
(→Scope) |
|||
| (5 intermediate revisions by the same user not shown) | |||
| Line 3: | Line 3: | ||
* '''[[Simulation]]''' content object > '''[[Branch Begin]]''' 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 > '''[[Explanation]]''' macro > '''Documentation''' > '''Show in Documentation''' property | ||
| + | * '''[[Simulation]]''' content object > '''[[Imported Page]]''' macro > '''Documentation''' > '''Show in Documentation''' property | ||
* '''[[Simulation]]''' content object > '''[[Screen (Simulation macro)|Screen]]''' macro > '''Documentation''' > '''Show in Documentation''' property | * '''[[Simulation]]''' content object > '''[[Screen (Simulation macro)|Screen]]''' macro > '''Documentation''' > '''Show in Documentation''' property | ||
==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 '''[[Input Text]]''' macros, even if this property is deselected, the macro will still be included in the ''Input Values'' table, where this appears in the document (either via a '''[[Fragment n|Fragment]]''' in the documentation definition or via a '''[[Input Values]]''' macro in the simulation project). | ||
| + | |||
| + | For '''[[Screen]]''' macros, this determines whether the screen image should be included in the document. | ||
| + | |||
| + | 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]] | ||
Latest revision as of 06:27, 4 April 2022
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 > Imported Page 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 Input Text macros, even if this property is deselected, the macro will still be included in the Input Values table, where this appears in the document (either via a Fragment in the documentation definition or via a Input Values macro in the simulation project).
For Screen macros, this determines whether the screen image should be included in the document.
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.
