Difference between revisions of "Highlight (Documentation macro)"

From SAP Enable Now Wiki
(Created page with "__NOTOC__ ==Scope== * '''Simulation''' content object > (Documentation) '''Highlight''' macro ==Purpose== The '''Highlight''' macro is used to display an additional '''...")
 
 
(One intermediate revision by the same user not shown)
Line 4: Line 4:
  
 
==Purpose==
 
==Purpose==
The '''Highlight''' macro is used to display an additional '''[[Highlight (Screenshot overlay)]]''' on a screenshot in the printed document (over and above any Highlights shown for action macros and '''[[Explanation]]''' macros). If you specify the '''[[Text (Highlight macro property)|Text]]''' property then a '''[[Marker]]''' will also be shown, and the specified text will appear in the instructions for the screen (just as for any action macro).
+
The '''Highlight''' macro is used to display an additional '''[[Highlight (Screenshot overlay)]]''' on a screenshot in the printed document (over and above any Highlights shown for action macros and '''[[Explanation]]''' macros). If you specify the '''[[Text (Documentation Highlight macro property)|Text]]''' property then a '''[[Marker]]''' will also be shown, and the specified text will appear in the instructions for the screen (just as for any action macro).
  
 
==Use==
 
==Use==
Line 18: Line 18:
 
* [[UID]]
 
* [[UID]]
 
* [[Highlight Position / Size]]
 
* [[Highlight Position / Size]]
* [[Text (Highlight macro property)|Text]]
+
* [[Text (Documentation Highlight macro property)|Text]]
  
 
[[Category:Macro]]
 
[[Category:Macro]]

Latest revision as of 16:22, 10 September 2019

Scope

  • Simulation content object > (Documentation) Highlight macro

Purpose

The Highlight macro is used to display an additional Highlight (Screenshot overlay) on a screenshot in the printed document (over and above any Highlights shown for action macros and Explanation macros). If you specify the Text property then a Marker will also be shown, and the specified text will appear in the instructions for the screen (just as for any action macro).

Use

To insert a Highlight macro:

  1. Click on any macro within the Step containing the Screen to which the Highlight should be applied.
  2. Select menu option Insert > Insert Documentation Macro > Highlight
  3. The Free Marker dialog box is displayed. This contains the current documentation screenshot image (not the entire Page image - you can only highlight an area of the screenshot that is selected for inclusion in the generated document), and a red selection marquee. Drag this marquee and/or its handles to where you want the highlight to appear.
  4. Click the Confirm Selection button (or press Enter) to confirm the highlight position and size, and close the dialog box.
  5. Adjust the macro's properties (see below) as required.

Properties