Difference between revisions of "Use Title as Heading"
| Line 4: | Line 4: | ||
==Purpose== | ==Purpose== | ||
| − | If the [[Documentation Settings]] > '''Project Content''' > '''[[Headings | + | If the [[Documentation Settings]] > '''Project Content''' > '''[[Headings from]]''' property for the generated document is set to '''Screens''', then the 'step' headings in the document will be taken from the '''[[Screen (Simulation macro)|Screen]]''' Macro's '''[[Title]]''' property, instead of from the '''[[Step]]''' Macro's '''[[Name]]''' property. If a heading should not be included for a specific '''[[Screen (Simulation macro)|Screen]]''', then the '''Use Title as Heading''' property can be deselected, and the Step content will be included under the previous heading. |
Because the heading is generated from the '''[[Screen (Simulation macro)|Screen]]''' macro, it is important that all Step content is included in the Step ''after'' the '''[[Screen (Simulation macro)|Screen]]''' macro - otherwise it will appear in the document under the ''previous'' step. | Because the heading is generated from the '''[[Screen (Simulation macro)|Screen]]''' macro, it is important that all Step content is included in the Step ''after'' the '''[[Screen (Simulation macro)|Screen]]''' macro - otherwise it will appear in the document under the ''previous'' step. | ||
Latest revision as of 05:36, 28 October 2020
Scope
- Simulation content object > Imported Page macro > Use Title as Heading property
- Simulation content object > Screen macro > Use Title as Heading property
Purpose
If the Documentation Settings > Project Content > Headings from property for the generated document is set to Screens, then the 'step' headings in the document will be taken from the Screen Macro's Title property, instead of from the Step Macro's Name property. If a heading should not be included for a specific Screen, then the Use Title as Heading property can be deselected, and the Step content will be included under the previous heading.
Because the heading is generated from the Screen macro, it is important that all Step content is included in the Step after the Screen macro - otherwise it will appear in the document under the previous step.
If the Show in Documentation property is deselected for the Screen macro, then the Title heading will also not be shown in the document, regardless of the Use Title as Heading property's setting.
