diff --git a/app/databrowser-timescale/doc/index.rst b/app/databrowser-timescale/doc/index.rst new file mode 100644 index 0000000000..2c3acde836 --- /dev/null +++ b/app/databrowser-timescale/doc/index.rst @@ -0,0 +1,8 @@ +Data Browser Timescale +====================== + +.. toctree:: + :glob: + :numbered: + + * diff --git a/app/display/editor/doc/dynamic.rst b/app/display/editor/doc/dynamic.rst index aee2b4b6e0..c4b0406632 100644 --- a/app/display/editor/doc/dynamic.rst +++ b/app/display/editor/doc/dynamic.rst @@ -14,6 +14,5 @@ and behaviour of Phoebus. .. toctree:: :maxdepth: 1 - formula_functions rules - scripts \ No newline at end of file + scripts diff --git a/app/display/editor/doc/index.rst b/app/display/editor/doc/index.rst index d5469b589e..f234a3d8ab 100644 --- a/app/display/editor/doc/index.rst +++ b/app/display/editor/doc/index.rst @@ -12,4 +12,6 @@ Display Builder is an editor and a runtime for build and running controls GUIs datasource_connections macros dynamic - + property_type + access_widget + access_pv_in_script diff --git a/app/display/editor/doc/macros.rst b/app/display/editor/doc/macros.rst index 602ea64ece..bc11b253d0 100644 --- a/app/display/editor/doc/macros.rst +++ b/app/display/editor/doc/macros.rst @@ -17,7 +17,7 @@ Simple Macros can be defined in several places. 1. On the command line when launching a display using the -resource option: -.. code-block:: python +.. code-block:: bash java -jar /path/to/application.jar -resource file:///path/to/display.bob?MyMacroValue=Some%20Value diff --git a/app/logbook/olog/ui/doc/index.rst b/app/logbook/olog/ui/doc/index.rst index ba1d8ef429..e6d2cb8c84 100644 --- a/app/logbook/olog/ui/doc/index.rst +++ b/app/logbook/olog/ui/doc/index.rst @@ -46,6 +46,7 @@ The log entry editor may also be launched from context menus, where applicable. the background of an OPI the launched context menu will include the Create Log item: .. image:: images/ContextMenu.png + The Create Log context menu item is available also in a Databrowser plot area. Editing a log entry @@ -74,6 +75,7 @@ When the log entry editor is launched from a context menu, a screen shot is auto Additional images (or other type of attachments) may be added by expanding the Attachments editor: .. image:: images/Attachments.png + Here user may attach any number of files of arbitrary types: - :guilabel:`Add Files` will launch the native file browser dialog from which user may select any number of files. @@ -103,6 +105,7 @@ Images may be embedded in the body text using markup. The user should consult th for details on how to do this. In general, users should use the Embed Image button to add image markup at the cursor position: .. image:: images/EmbedImage.png + External image resources may be edited manually, e.g.: ``![alt-text](https://foo.com/bar.jpg)``. File URLs are not supported. @@ -117,6 +120,7 @@ Properties are edited by expanding the Properties editor. The below screen shot (LCR shift info) holding five keys has been configured in the service: .. image:: images/PropertiesEditor.png + User may select what properties to include in the log entry, and edit the values for the items in the property. diff --git a/app/save-and-restore/app/doc/index.rst b/app/save-and-restore/app/doc/index.rst index f826a173fc..1fbdb5171f 100644 --- a/app/save-and-restore/app/doc/index.rst +++ b/app/save-and-restore/app/doc/index.rst @@ -316,12 +316,14 @@ write operations is hence undefined. Prior to restore user has the option to: * Exclude PVs using the checkboxes in the left-most column. To simplify selection, user may use the Filter input field to find matching PV names: -.. image:: images/snapshot-restore-filter.png - :width: 80% + + .. image:: images/snapshot-restore-filter.png + :width: 80% * Specify a multiplier factor :math:`{\neq}` 1 applied to scalar data type PVs: -.. image:: images/restore-with-scale.png - :width: 80% + + .. image:: images/restore-with-scale.png + :width: 80% Restoring from a composite snapshot works in the same manner as the restore operation from a single-snapshot. diff --git a/core/formula/doc/index.rst b/core/formula/doc/index.rst index 811412cf51..bf354a1afa 100644 --- a/core/formula/doc/index.rst +++ b/core/formula/doc/index.rst @@ -6,7 +6,8 @@ A prefix of the form "=xx(..)" is typically used to select the formula. Operators ----- +--------- + You can use the following operators : | **Arithmetic and maths operators :** diff --git a/docs/source/converter.rst b/docs/source/converter.rst index dfe7c9329f..200355de3a 100644 --- a/docs/source/converter.rst +++ b/docs/source/converter.rst @@ -13,7 +13,7 @@ Table: + Converter application Description ------------- +----------- AdvancedConverter is a tool to convert massively and recursively CSS OPI to Phoebus BOB files. It will automatically convert the widgets and their properties from the legacy file format. @@ -42,7 +42,7 @@ Exemples : **-main org.csstudio.display.builder.model.AdvancedConverter input/path/to/folder** Converter application ----------------------- +--------------------- Located in *Utility -> OPI converter*, it will generate a pop up window. In this pop up, you can choose a input file or folder with the Browse button in the input section. In a similar way, you can choose or not a output folder. To run the conversion you need to press the run button. diff --git a/docs/source/convertor.rst b/docs/source/convertor.rst index 7c4d360c27..9318f05152 100644 --- a/docs/source/convertor.rst +++ b/docs/source/convertor.rst @@ -13,7 +13,7 @@ Table: + Converter application Description ------------- +----------- AdvancedConverter is a tool to convert massively and recursively CSS OPI to Phoebus BOB files. It will automatically convert the widgets and their properties from the legacy file format. @@ -42,7 +42,7 @@ Exemples : **-main org.csstudio.display.builder.model.AdvancedConverter input/path/to/folder** Converter application ----------------------- +--------------------- Located in *Utility -> OPI converter*, it will generate a pop up window. In this pop up, you can choose a input file or folder with the Browse button in the input section. In a similar way, you can choose or not a output folder. To run the conversion you need to press the run button. diff --git a/docs/source/trouble_shooting.rst b/docs/source/trouble_shooting.rst index 6370930b40..dfeda96851 100644 --- a/docs/source/trouble_shooting.rst +++ b/docs/source/trouble_shooting.rst @@ -27,13 +27,13 @@ Impossible to run Phoebus under linux | If you get the following error message: -.. code-block:: kmsg - - /bin/java : permission denied +.. code-block:: + + /bin/java : permission denied | or -.. code-block:: kmsg +.. code-block:: Error initializing QuantumRenderer: no suitable pipeline found java.lang.RuntimeException: java.lang.RuntimeException: Error initializing QuantumRenderer: no suitable pipeline found diff --git a/services/save-and-restore/doc/index.rst b/services/save-and-restore/doc/index.rst index 41a3f05bc3..80ea893c00 100644 --- a/services/save-and-restore/doc/index.rst +++ b/services/save-and-restore/doc/index.rst @@ -135,7 +135,7 @@ Body: .. code-block:: JSON - ["nodeId-1", "nodeId-2",..., "nodeId-N"] + ["nodeId-1", "nodeId-2", "...", "nodeId-N"] Return: Details of the nodes listed as unique node ids in the request body. @@ -207,7 +207,7 @@ updated. Delete nodes """""""""""" -**.../node +**.../node** Method: DELETE @@ -215,7 +215,7 @@ Caller must specify a body, which is a list of the unique ids of the nodes subje .. code-block:: JSON - ["id_1", "id_2",...., "id_n"] + ["id_1", "id_2", "...", "id_n"] Note that deletion is recursive and non-reversible: @@ -1051,7 +1051,7 @@ Authorization uses a role-based approach like so: * Save-and-restore role "sar-admin": no restrictions Authentication endpoint -""""""""""""""""""""""" +----------------------- A client can may use the /login endpoint to check if user is authenticated: