website: explain variable filtering and list display modes

Author: huiwanpnnl

docs/.vitepress/config.mjs

@@ -64,6 +64,7 @@ export default defineConfig({
             { text: "Keyboard Shortcuts",link: "/guides/quickview/shortcuts" },
             { text: "File Selection",    link: "/guides/quickview/file_selection" },
             { text: "Variable Selection",link: "/guides/quickview/variable_selection" },
+            { text: "Slice Selection",   link: "/guides/quickview/slice_selection" },
             { text: "Viewport Layout",   link: "/guides/quickview/viewport_layout" },
             { text: "Individual Views",  link: "/guides/quickview/individual_views" },
           ],
@@ -76,9 +77,9 @@ export default defineConfig({
           ],
         },
         {
-          text: "Tools Under Development",
+          text: "Tools In Development",
           items: [
-            { text: "Site View" },
+            { text: "SiteView" },
             { text: "CondiDiagViewer", },
           ],
         },

docs/guides/quickview/index.md

@@ -71,6 +71,4 @@ program.
 
 ##  
 
-![SciDAC](/logos/SciDAC-logo.png){ width="25%", align=left }
-![Kitware](/logos/Kitware_logo_with_text.png){ width="15%", align=left}
-![PNNL](/logos/PNNL_logo_with_text_abbr.png){ width="15%", align=left }
+![SciDAC, Kitware, and PNNL](/logos/SciDAC-Kitware-PNNL.png){ width="75%", align=center }

docs/guides/quickview/slice_selection.md

@@ -0,0 +1 @@
+# Selecting Data Slices to Inspect

docs/guides/quickview/variable_selection.md

@@ -1,8 +1,8 @@
 # Selecting Variables to Inspect
 
-QuickView's capabilities of variable search and selection
-has been enhanced substantially compared to the earlier version.
-The enhancement was partly motivated by the generalization of
+Starting in version 2, QuickView's variable search and selection capabilities
+are substantially enhanced.
+This was partly motivated by the generalization of
 the tool to handle arbitrarily-shaped arrays,
 and partly due to the intention to help users navigate through simulation
 files containing many (e.g., hundreds of) variables.
@@ -13,12 +13,12 @@ to explain the search and selection capabilities.
 
 ## Checkboxes for selecting and unselecting variables
 
-The first screenshot here shows the Variable Selection panel
-right after the files have been loaded.
-- The checkboxes to the left of each variable name can be used
+The first screenshot here shows how the Variable Selection panel
+looks like after a simulation file has been loaded.
+- The checkboxes to the left of the variable names can be used
   to select or unselect the corresponding variables.
 - The first checkbox, to the left of "Name" and below the eye icon,
-  can be used to select or unselect all variables.
+  can be used to select or unselect all variables on the list.
 
 ## Variable groups
 
@@ -32,26 +32,68 @@ we get the second screenshot shown here.
 - The **wide blue button** at the top of the contol panel indicates there is
   a total of 1385 variables displayable in the file.
 - The **colorful tabs** correspond to different variable groups with distinct shapes.
-  Each groups shape (dimension combination), as well as the number
-  of displayable variables in the group, is shown in the corresponding tab.
+  Each group's shape (dimension combination), as well as the number
+  of displayable variables in the group, is shown inside the corresponding tab.
   Each tab also has a "close" button that can be used to unselect the entire group.
 
 Note that at this point, QuickView has *not* loaded all the variables into memory.
 It has finished a scan and *is ready to load* these variables.
 
-## The filter box
+## Variable search 
 
-Talk points to be expanded after we further revise the filter logic:
+Below the variable group tabs and above the list of variables,
+there is a text input box with a magnifying glass icon.
+This box, also referred to as the filter box,
+can be used to search for variables by their names or dimensions.
 
-- filter box; filter by dimension name, dimension combination, or variable name
-- eye icon: cycle through lists of selected, unselected, and all variables in the filtered list.
-- clicking a tab will filter the list of all variables by the shape combination.
-- filter is applied immediately when contents are entered.
-  - implication: when the filter box is not empty, the eye icon and the first checkbox
-    will operate on the filtered list. If the user wants them to apply to the full list
-    of displayable variables instead, then the filter box should be cleared by deleteing the
-    text;  a shortcut would be to use the "close button" that shows up when the cursor
-    hoves over the filter box".
+### Fuzzy search
 
-::: warning Reminder: Use the `Load X variables` button to apply selection or change
+As soon as the user enters text into the filter box, QuickView displays
+a filtered list of variables whose **names or dimension names** contain
+the entered string.
+
+Fuzzy search is case-**in**sensitive.
+
+### Pattern search
+
+Patterns such as `text*` or `*text` can be used to match **variable names**
+that start or end with `text`, respectively.
+
+Pattern search is also case-**in**sensitive.
+
+### Strict search
+
+A string enclosed in double quotation marks (e.g., `"text"`) can be used
+to request exact matches of **variable names**,
+with no preceding or succeeding characters.
+
+Exact search is **case-sensitive**.
+
+
+## Variable display modes
+
+The eye icon to the left of the text input box (filter box)
+is a button for cycling through three display modes.
+The icon changes to reflect the current mode:
+
+- **Eye icon** – shows the **full list** of variables in the file.
+- **Eye with check mark** – shows only the variables currently **selected** via the checkboxes.
+- **Eye with cross** – shows the variables that are **not currently selected**.
+
+When a search or filter is active, these modes apply to the filtered list rather than
+the full set of variables in the simulation file.
+
+Also note that:
+- If the user wants to return to the full list, the filter can be cleared
+  by first hovering the cursor over the filter box and then clicking the cross button
+  at the right end.
+- Double-clicking a colored group tab sets the filter to that group.
+  The three display modes then apply to the selection state within that group.
+
+
+::: warning Reminder: Do not forget the `Load ... variables` button
+After making your selection or adjusting it, the `Load ... variables`
+buttone at the top of the control panel needs to be clicked
+in order for the selected variables to be loaded into memory and
+shown in the viewport.
 :::

docs/guides/reminders.md

@@ -23,10 +23,12 @@ simulation data file. Please double check when you run into a loading error.
 
 ::: warning The `Load ... Variables` Button
 Most buttons, sliders, and selection boxes in the UI apply their effects
-immediately upon user interaction. The only exception is variable
+immediately upon user interaction. An important exception is variable
 selection: After variables are chosen for the first time following file load
 or after the selection is changed, the user **must** click the `Load ... Variables`
-button at the top of the "Select Variables" control panel for the new selection to take effect.
+button at the top of the "Select Variables" control panel for the new selection to take effect
+i.e., for the selected variables to be loaded into memory and displayed as
+global or regional maps.
 :::
 
 ::: info Show/hide control panels