Difference between revisions of "Header Information"
(Created page with "__NOTOC__ ==Scope== '''Simulation''' > '''Header Information''' macro ==Purpose== The '''Header Information''' macro can be used to provide a brief text segment, and a he...") |
(→Scope) |
||
Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
==Scope== | ==Scope== | ||
− | '''[[Simulation]]''' > '''Header Information''' macro | + | '''[[Simulation]]''' content object > '''Header Information''' macro |
==Purpose== | ==Purpose== |
Latest revision as of 19:49, 12 August 2019
Scope
Simulation content object > Header Information macro
Purpose
The Header Information macro can be used to provide a brief text segment, and a heading for this text. Unfortunately, this heading does not use a specific heading style, and is not numbered, so depending upon where you insert it in the simulation, it may not be logically sized according to its position relative to other headings in the simulation (although you can customize the Title style in the template, to influence this).
If it is important to use a specific heading, it would be better to use a Heading macro (where you can specify the heading level) to insert the heading, and then use a Description macro to provide the text. Also note that the Description property for this macro can only contain a single line of plain text, whereas the Description macro allows you to use the full Text Editor with all of its functionality.
Use
From within the Project Editor, select the existing macro after which the information provided by this macro should be inserted, and then select menu option Insert > Insert Documentation Macro > Header Information.