Difference between revisions of "Highlight (Page macro)"

From SAP Enable Now Wiki
m (Admin moved page Highlight (macro) to Highlight (Page macro) without leaving a redirect: Disambiguation)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 
==Scope==
 
==Scope==
* '''[[Simulation]]''' content object > '''Highlight''' macro
+
* '''[[Simulation]]''' content object > Page '''Highlight''' macro
  
 
==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 Page '''Highlight''' macro (not to be confused with the Documentation '''[[Highlight (Documentation macro)|Highlight]]''' macro) is used to display an additional '''[[Highlight (Screenshot overlay)]]''' on a screen during playback of a '''[[Simulation]]'''.
 +
 
 +
The position of the '''Highlight''' within the parent [[Step]] is important. The '''Highlight''' will be displayed from the point this macro is reached until the end of the [[Step]] - even during the display or execution of any 'action' or '''[[Explanation]]''' macros that follow it.
 +
 
 +
It is recommended that you use a different color (specified in the '''[[Highlight Color]]''' property) for the '''Highlight''' than is used for 'actions', so the user is not confused about where to perform the action.
  
 
==Use==
 
==Use==
To insert a '''Highlight''' macro:
+
To insert a Page '''Highlight''' macro:
# Click on any macro within the [[Step]] containing the '''[[Screen]]''' to which the Highlight should be applied.
+
# Click on the macro within the [[Step]] (containing the '''[[Screen]]''' to which the Highlight should be applied) after which this Highlight should appear.
# Select menu option '''Insert > Insert Documentation Macro > Highlight'''
+
# Select menu option '''Insert > Insert Page Macro > Highlight'''
# 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.
+
# A Highlight is added to the screenshot in the ''[[Step View]]''. Drag this object and/or its handles to where you want the Highlight to appear.
# Click the '''Confirm Selection''' button (or press '''Enter''') to confirm the highlight position and size, and close the dialog box.
 
 
# Adjust the macro's properties (see below) as required.
 
# Adjust the macro's properties (see below) as required.
  

Revision as of 15:38, 10 September 2019

Scope

Purpose

The Page Highlight macro (not to be confused with the Documentation Highlight macro) is used to display an additional Highlight (Screenshot overlay) on a screen during playback of a Simulation.

The position of the Highlight within the parent Step is important. The Highlight will be displayed from the point this macro is reached until the end of the Step - even during the display or execution of any 'action' or Explanation macros that follow it.

It is recommended that you use a different color (specified in the Highlight Color property) for the Highlight than is used for 'actions', so the user is not confused about where to perform the action.

Use

To insert a Page Highlight macro:

  1. Click on the macro within the Step (containing the Screen to which the Highlight should be applied) after which this Highlight should appear.
  2. Select menu option Insert > Insert Page Macro > Highlight
  3. A Highlight is added to the screenshot in the Step View. Drag this object and/or its handles to where you want the Highlight to appear.
  4. Adjust the macro's properties (see below) as required.

Properties