Merge branch 'ControlSystemStudio:master' into master

ControlSystemStudio · Sep 1, 2023 · d62c7fb · d62c7fb
2 parents 4b7035c + eaa692c
commit d62c7fb
Show file tree

Hide file tree

Showing 24 changed files with 843 additions and 23 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -1,6 +1,10 @@
 name: Phoebus build
 
-on: [push, pull_request]
+on: 
+  push:
+    branches-ignore:
+      - 'master'
+  pull_request:
 
 jobs:
   build:

diff --git a/app/alarm/datasource/doc/index.rst b/app/alarm/datasource/doc/index.rst
@@ -10,7 +10,7 @@ to take a set of actions needed to effectively handle an alarm.
 
 The alarm datasource provides a subsection of the alarm information and functionality.
 This makes it possible for user to access beast alarm information of any other cs-studio application.
-OPI screens can now embed informatino about from the alarm server, like the acknowledgement state of a pv, etc..
+OPI screens can now embed information about from the alarm server, like the acknowledgement state of a pv, etc..
 
 PV syntax
 ---------

diff --git a/app/display/editor/doc/formula_functions.rst b/app/display/editor/doc/formula_functions.rst
diff --git a/app/display/editor/doc/widgets.rst b/app/display/editor/doc/widgets.rst
@@ -3,9 +3,38 @@ Widgets
 =======
 
 The Display Builder application supports a set of widgets which can be used to create control GUIs. The widgets are
-organized based on functionality as shown below
+organized according to the categories *Graphics*, *Monitors*, *Controls*, *Plots*, *Structure*, and *Miscellaneous*:
 
 .. image:: images/widgets.png
+   :align: center
+
+Each category corresponds to an intended use case of the widgets belonging to the category:
+
+.. list-table::
+   :widths: 30 70
+   :header-rows: 1
+   :align: center
+
+   * - Widget Category
+     - Intended Use Case
+
+   * - `Graphics`
+     - Static graphical elements
+
+   * - `Monitors`
+     - Displaying values from PVs
+
+   * - `Controls`
+     - Writing values to PVs
+
+   * - `Plots`
+     - Plotting PV values
+
+   * - `Structure`
+     - Grouping widgets and embedding displays
+
+   * - `Miscellaneous`
+     - 3D Viewer, Web Browser
 
 .. toctree::
    :maxdepth: 1

diff --git a/app/display/model/src/main/resources/examples/01_main.bob b/app/display/model/src/main/resources/examples/01_main.bob
@@ -156,6 +156,34 @@ then press &lt;SPACE&gt; to activate button.</text>
     <height>26</height>
     <tooltip>$(actions)</tooltip>
   </widget>
+  <widget type="action_button" version="3.0.0">
+    <name>Action Button_40</name>
+    <actions>
+      <action type="open_display">
+        <file>11_datasources.bob</file>
+        <target>replace</target>
+        <description>Datasources</description>
+      </action>
+    </actions>
+    <y>360</y>
+    <width>120</width>
+    <height>26</height>
+    <tooltip>$(actions)</tooltip>
+  </widget>
+  <widget type="action_button" version="3.0.0">
+    <name>Action Button_41</name>
+    <actions>
+      <action type="open_display">
+        <file>12_formulas.bob</file>
+        <target>replace</target>
+        <description>Formulas</description>
+      </action>
+    </actions>
+    <y>400</y>
+    <width>120</width>
+    <height>26</height>
+    <tooltip>$(actions)</tooltip>
+  </widget>
   <widget type="action_button" version="3.0.0">
     <name>Action Button_26</name>
     <actions>
@@ -165,7 +193,7 @@ then press &lt;SPACE&gt; to activate button.</text>
         <description>Enablement</description>
       </action>
     </actions>
-    <y>360</y>
+    <y>440</y>
     <width>120</width>
     <height>26</height>
     <tooltip>$(actions)</tooltip>
@@ -819,4 +847,4 @@ then press &lt;SPACE&gt; to activate button.</text>
     <height>26</height>
     <tooltip>$(actions)</tooltip>
   </widget>
-</display>
+</display>
diff --git a/app/display/model/src/main/resources/examples/02_intro.bob b/app/display/model/src/main/resources/examples/02_intro.bob
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <display version="1.0.0">
-  <name>Display</name>
+  <name>Introduction</name>
   <x>-1</x>
   <y>-1</y>
   <widget type="label" version="2.0.0">

diff --git a/app/display/model/src/main/resources/examples/10_scripts.bob b/app/display/model/src/main/resources/examples/10_scripts.bob
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <display version="2.0.0">
-  <name>Display</name>
+  <name>Scripts</name>
   <width>1150</width>
   <height>2000</height>
   <widget type="label" version="2.0.0">

diff --git a/app/display/model/src/main/resources/examples/11_datasources.bob b/app/display/model/src/main/resources/examples/11_datasources.bob
@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<display version="2.0.0">
+  <name>Datasources</name>
+  <widget type="label" version="2.0.0">
+    <name>Label_3</name>
+    <text>Datasources</text>
+    <width>210</width>
+    <font>
+      <font name="Header 1" family="Liberation Sans" style="BOLD" size="22.0">
+      </font>
+    </font>
+  </widget>
+</display>