Difference between revisions of "Comment"
From SAP Enable Now Wiki
(Initial creation) |
|||
| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
==Scope== | ==Scope== | ||
| − | * '''[[Simulation]]''' | + | * '''[[Simulation]]''' content object > '''[[Step]]''' macro > '''Comment''' property |
| − | * '''[[Simulation]]''' | + | * '''[[Simulation]]''' content object > '''[[Screen (Simulation macro)|Screen]]''' macro > '''Comment''' property |
| − | * '''[[Simulation]]''' | + | * '''[[Simulation]]''' content object > ''action'' macros > '''Comment''' property |
==Purpose== | ==Purpose== | ||
| Line 9: | Line 9: | ||
* If the text is preceded by '''*''' then the text is placed in brackets and included ''before'' the macro description | * If the text is preceded by '''*''' then the text is placed in brackets and included ''before'' the macro description | ||
* If the text is preceded by '''/''' then the text is not included in the macro description at all | * If the text is preceded by '''/''' then the text is not included in the macro description at all | ||
| + | |||
| + | ==Use== | ||
| + | The '''Comment''' is ''generally'' just for reference by the Authors during editing, but it does appear in the '''[[Work Document]]''' (which is presumably for use by Authors/Editors while they are working on the simulation project, and is not intended for distribution to Learners). | ||
[[Category:Property]] | [[Category:Property]] | ||
Latest revision as of 07:58, 2 June 2021
Scope
- Simulation content object > Step macro > Comment property
- Simulation content object > Screen macro > Comment property
- Simulation content object > action macros > Comment property
Purpose
This text field property can be used to enter a brief text relating to the parent macro. Text entered into the Comment property will replace the default macro description in the Thumbnails pane, unless one of the following prefixes is used:
- If the text is preceded by + then the text is placed in brackets and included after the macro description
- If the text is preceded by * then the text is placed in brackets and included before the macro description
- If the text is preceded by / then the text is not included in the macro description at all
Use
The Comment is generally just for reference by the Authors during editing, but it does appear in the Work Document (which is presumably for use by Authors/Editors while they are working on the simulation project, and is not intended for distribution to Learners).
