Skip to content

Commit 07ca4ed

Browse files
committed
Updates to describe alarm view context menu
1 parent 59a283f commit 07ca4ed

File tree

3 files changed

+16
-2
lines changed

3 files changed

+16
-2
lines changed
5.31 KB
Loading
29.5 KB
Loading

app/alarm/ui/doc/index.rst

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -410,13 +410,27 @@ Where the include component is identified in the inclusion file with a DID decla
410410
</component>
411411
</config>
412412
413+
Context Menu
414+
------------
415+
416+
In the Alarm Tree and the Alarm Table views user may right click on an alarm item to launch a context menu:
417+
418+
.. image:: images/context_menu.png
419+
:width: 20%
420+
421+
The top item ("Guidance" in the screenshot) will launch a dialog showing the guidance text for the alarm item.
422+
423+
With the Disable Alarms menu item (Alarm Tree only) user may disable an alarm item, or all alarms in the sub-tree of a
424+
node. The alarm(s) will stay disabled until explicitly enabled by the user. See also notes below for
425+
more information on how disabled alarms are handled upon import of the alarm configuration XML file.
426+
413427
Configuration Editor
414-
-------------------
428+
--------------------
415429

416430
In the Alarm Tree and the Alarm Table views user may right click on an alarm item to launch the configuration
417431
editor dialog:
418432

419-
.. image:: images/context_menu.png
433+
.. image:: images/context_menu_config.png
420434
:width: 20%
421435

422436
In this view user may update all settings defined in the alarm configuration XML file:

0 commit comments

Comments
 (0)