updated documentation and changed names of disable sub context menu

Author: milenaschedle

.gitattributes

@@ -0,0 +1,2 @@
+# SCM syntax highlighting & preventing 3-way merges
+pixi.lock merge=binary linguist-language=YAML linguist-generated=true -diff

.gitignore

@@ -132,3 +132,6 @@ docs/source/_ext/**/*.pyc
 # Ignore pip installation metadata
 docs/phoebus_docs.egg-info/
 *.pyc
+# pixi environments
+.pixi/*
+!.pixi/config.toml

app/alarm/ui/doc/images/configuration_editor_dialogs.png

@@ -459,13 +459,32 @@ 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
+.. image:: images/context_menu_new.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
+.. image:: images/context_menu_disable.png
+    :width: 35%
+
+With the Disable... menu item (Alarm Tree only) user may disable an alarm item, or all alarms in the sub-tree of a
+node.
+When choosing to disable the alarm(s) *indefinitely* in the sub-context menu, the alarm(s) will stay disabled until
+explicitly enabled by the user.
+
+Alarm(s) can also be disabled for a certain time choosing *with enable date*.
+
+.. image:: images/dialog_enable_date.png
+    :width: 40%
+
+Users can specify an either absolute or relative date or time the alarm(s) should be disabled. After that, the alarm(s)
+will be enabled again automatically.
+
+**NOTE**: A structural component, along with all the items in its sub-tree, can **only** be disabled with an enable date
+if either all of the items have the same enable date or none at all.
+If this is not the case, the *with enable date* option in the sub context menu will be disabled.
+
+See also notes below for
 more information on how disabled alarms are handled upon import of the alarm configuration XML file.
 
 Configuration Editor
@@ -479,8 +498,13 @@ editor dialog:
 
 In this view user may update all settings defined in the alarm configuration XML file:
 
-.. image:: images/configuration_editor.png
-    :width: 50%
+**NOTE:** There are different configuration files for a structural component (path), containing several components
+or leaves, and a leaf itself (training:COUNTER), as their functionalities vary
+
+
+.. image:: images/configuration_editor_dialogs.png
+    :width: 85%
+
 
 **NOTE:** Any changes performed in the editor will be overwritten when the associated alarm configuration XML file is
 imported again.

app/alarm/ui/doc/images/context_menu_disable.png

@@ -35,6 +35,7 @@ public class Messages
     public static String headerConfirmDisable;
     public static String headerConfirmDisableWithEnableDate;
     public static String headerConfirmEnable;
+    public static String indefinitely;
     public static String moveItemFailed;
     public static String partlyDisabled;
     public static String promptTitle;
@@ -43,6 +44,7 @@ public class Messages
     public static String renameItemFailed;
     public static String timer;
     public static String unacknowledgeFailed;
+    public static String withEnableDate;
 
     static
     {

app/alarm/ui/doc/images/context_menu_new.png

@@ -34,7 +34,8 @@ public DisableAction(final Node node, final AlarmClient model, final List<AlarmT
         setText(Messages.disableMenu);
         setGraphic(ImageCache.getImageView(AlarmUI.class, "/icons/disabled.png"));
         MenuItem disable = new DisableComponentAction(node, model, items);
-        MenuItem disableUntil = new MenuItem(Messages.disabledUntil);
+        disable.setText(Messages.indefinitely);
+        MenuItem disableUntil = new MenuItem(Messages.withEnableDate);
         disableUntil.setDisable(true);
         Set<AlarmClientLeaf> totalLeafItems = new HashSet<>();
         Set<AlarmClientLeaf> leafItemsWithEnableDate = new HashSet<>();

app/alarm/ui/doc/images/dialog_enable_date.png

@@ -56,6 +56,7 @@ headerAlreadyEnabled=All PVs in the selected section are already enabled
 headerConfirmDisable=Disable all PVs in the selected section of the alarm hierarchy?\nThis would disable {0} PVs.
 headerConfirmDisableWithEnableDate=Disable all PVs in the selected section of the alarm hierarchy until {0}?\nThis would affect {1} PVs.
 headerConfirmEnable=Enable all PVs in the selected section of the alarm hierarchy?\nThis would enable {0} PVs.
+indefinitely=Indefinitely
 info=Info
 invalidDate=You have selected a date that is either invalid or in the past
 latch=Latch
@@ -79,3 +80,4 @@ tooltipMoveEditDetail=Edit the detail field of table item
 tooltipMoveTableItemDown=Move table item down
 tooltipMoveTableItemUp=Move table item up
 unacknowledgeFailed=Failed to unacknowledge alarm(s)
+withEnableDate=With Enable Date