Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions app/databrowser-timescale/doc/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Data Browser Timescale
======================

.. toctree::
:glob:
:numbered:

*
3 changes: 1 addition & 2 deletions app/display/editor/doc/dynamic.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,5 @@ and behaviour of Phoebus.
.. toctree::
:maxdepth: 1

formula_functions
rules
scripts
scripts
4 changes: 3 additions & 1 deletion app/display/editor/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion app/display/editor/doc/macros.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 4 additions & 0 deletions app/logbook/olog/ui/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand All @@ -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.


Expand Down
10 changes: 6 additions & 4 deletions app/save-and-restore/app/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
3 changes: 2 additions & 1 deletion core/formula/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 :**
Expand Down
4 changes: 2 additions & 2 deletions docs/source/converter.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions docs/source/convertor.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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.
Expand Down
8 changes: 4 additions & 4 deletions docs/source/trouble_shooting.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions services/save-and-restore/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -207,15 +207,15 @@ updated.
Delete nodes
""""""""""""

**.../node
**.../node**

Method: DELETE

Caller must specify a body, which is a list of the unique ids of the nodes subject to deletion:

.. code-block:: JSON

["id_1", "id_2",...., "id_n"]
["id_1", "id_2", "...", "id_n"]

Note that deletion is recursive and non-reversible:

Expand Down Expand Up @@ -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:

Expand Down