Skip to content

Commit c013c9e

Browse files
committed
website: quickview file loading page revised
1 parent 6a9da4f commit c013c9e

4 files changed

Lines changed: 38 additions & 26 deletions

File tree

docs/.vitepress/theme/style.css

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
.img-right {
2+
float: right;
3+
margin-left: 12px;
4+
margin-bottom: 8px; /* adds space below so text doesn’t hug the bottom edge */
5+
width: var(--img-width, 10%);
6+
}

docs/guides/quickview/file_selection.md

Lines changed: 32 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,26 @@
11
# Selecting Files for Analysis
22

33
QuickView can be used in two modes:
4-
a **new-viz mode** for starting a new visualization or
5-
a **resume mode** for continuing an earlier analysis saved in a state file.
4+
- a **new-viz mode** for starting a new visualization or
5+
- a **resume mode** for continuing an earlier analysis saved in a state file.
66

77
## New-viz mode: starting a new visualization
88

9-
![File loading window](./screenshots/file-upload-outline.svg){ width="8%", align=right }
9+
<!-- ![File loading window](./screenshots/file-upload-outline.svg){ width="8%", align=right } -->
10+
11+
<img src="file-upload-outline.svg"
12+
alt="File loading window"
13+
class="img-right"
14+
style="--img-width: 5%;" />
15+
1016
When QuickView is launched using a shell command or the desktop bundle,
11-
or when the user clicks the "File loading" icon on the toolbar (or `F` key),
17+
or when the user clicks the "File loading" icon on the toolbar,
1218
the a dialogue window like the screenshot below will be brought up.
1319
The user is expected to select a connecitivy file and at least one a simulation data file
1420
from the file system.
1521

16-
![File loading window](./screenshots/file_loading_dialogue.png){ width="50%", align=right }
22+
![File loading window](./screenshots/file_loading_dialogue.png){ width="80%", align=center }
23+
1724
The user can single-click a file name and then click the "simulation" or "connectivity"
1825
button to clarify file type, and repeat these two clicks to have both files specified.
1926

@@ -31,34 +38,33 @@ on the left showing a list of recognized variables in the simulation file
3138
and the viewport on the right showing the landing page.
3239
The user can now start to search for and load variables to inspect.
3340

41+
![File loaded](./screenshots/file_loaded.png){ width="80%", align=center }
42+
3443

3544
## Resume mode: pick up where you left off
3645

3746
::: error TO-DO: check and explain state file download and upload
3847
:::
3948

40-
::: info "Info: What's in a State File?"
41-
42-
A state file is a JSON file that contains the paths and names of
43-
the connectivity and data files being used as well as the settings
44-
the user has chosen for the visualization; the *contents* of the
45-
connectivity and simulation files are *not* included.
46-
47-
If a state file is shared among multiple users or used across different
48-
file systems, or if a user wants to apply the same visualization settings
49-
to a different simulation data file, then the file names and paths
50-
at the beginning of the state file need to be edited before the state
51-
file is loaded in the app.
49+
::: info Info: What's in a State File?
50+
A state file is a JSON file that contains the paths and names of
51+
the connectivity and data files being used as well as the settings
52+
the user has chosen for the visualization; the *contents* of the
53+
connectivity and simulation files are *not* included.
54+
55+
If a state file is shared among multiple users or used across different
56+
file systems, or if a user wants to apply the same visualization settings
57+
to a different simulation data file, then the file names and paths
58+
at the beginning of the state file need to be edited before the state
59+
file is loaded in the app.
5260
:::
5361

54-
::: warning "Tip: State File Loading Error"
55-
56-
If the app seems nonresponsive after a state file has been chosen
57-
and the `Open` button in the dialogue window has been clicked,
58-
there is a high chance that the paths and names of
59-
the connectivity and simulation data files contain errors.
60-
The user should consider using a text editor to inspect the first
61-
few lines of the state file and verify correctness.
62+
::: warning Tip: State File Loading Error
63+
If the app seems nonresponsive after a state file has been chosen
64+
and the `Open` button in the dialogue window has been clicked,
65+
there is a high chance that the paths and names of
66+
the connectivity and simulation data files contain errors.
67+
The user should consider using a text editor to inspect the first
68+
few lines of the state file and verify correctness.
6269
:::
6370

64-
891 KB
Loading
20.5 KB
Loading

0 commit comments

Comments
 (0)