From 400fb0f3176016ee2be90ca974e9056b3853a76b Mon Sep 17 00:00:00 2001 From: architeuthidae Date: Tue, 13 Aug 2024 13:31:48 +0800 Subject: [PATCH] doc: GUI applet groups --- doc/manual/faq.rst | 5 +++++ doc/manual/using_data_interfaces.rst | 3 +++ 2 files changed, 8 insertions(+) diff --git a/doc/manual/faq.rst b/doc/manual/faq.rst index 249992e79..44d765df9 100644 --- a/doc/manual/faq.rst +++ b/doc/manual/faq.rst @@ -174,6 +174,11 @@ organize datasets in folders? Use the dot (".") in dataset names to separate folders. The GUI will automatically create and delete folders in the dataset tree display. +organize applets in groups? +--------------------------- + +Create groups by left-clicking within the applet list and selecting 'New Group'. Move applets in and out of groups by dragging them with the mouse. To unselect an applet or a group, use CTRL+click. + organize experiment windows in the dashboard? --------------------------------------------- diff --git a/doc/manual/using_data_interfaces.rst b/doc/manual/using_data_interfaces.rst index 60294e5ea..3f1f4309e 100644 --- a/doc/manual/using_data_interfaces.rst +++ b/doc/manual/using_data_interfaces.rst @@ -59,6 +59,9 @@ In our case, we only need to supply our dataset to the applet to be plotted. Nav Run the experiment again, and observe how the points are added as they are generated to the plot in the applet window. +.. tip:: + Datasets and applets can both be arranged in groups for organizational purposes. (In fact, so can arguments; see the reference of :meth:`~artiq.language.environment.HasEnvironment.setattr_argument`). For datasets, use a dot (``.``) in names to separate folders. For applets, left-click in the applet list to see the option 'Create Group'. You can drag and drop to move applets in and out of groups, or select a particular group with a click to create new applets in that group. Deselect applets or groups with CTRL+click. + The ARTIQ browser ^^^^^^^^^^^^^^^^^