Skip to content

Commit

Permalink
Updates to describe alarm view context menu
Browse files Browse the repository at this point in the history
  • Loading branch information
georgweiss committed Nov 26, 2024
1 parent 59a283f commit 07ca4ed
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 2 deletions.
Binary file modified app/alarm/ui/doc/images/context_menu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added app/alarm/ui/doc/images/context_menu_config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
18 changes: 16 additions & 2 deletions app/alarm/ui/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -410,13 +410,27 @@ Where the include component is identified in the inclusion file with a DID decla
</component>
</config>
Context Menu
------------

In the Alarm Tree and the Alarm Table views user may right click on an alarm item to launch a context menu:

.. image:: images/context_menu.png
:width: 20%

The top item ("Guidance" in the screenshot) will launch a dialog showing the guidance text for the alarm item.

With the Disable Alarms menu item (Alarm Tree only) user may disable an alarm item, or all alarms in the sub-tree of a
node. The alarm(s) will stay disabled until explicitly enabled by the user. See also notes below for
more information on how disabled alarms are handled upon import of the alarm configuration XML file.

Configuration Editor
-------------------
--------------------

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

.. image:: images/context_menu.png
.. image:: images/context_menu_config.png
:width: 20%

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

0 comments on commit 07ca4ed

Please sign in to comment.