Skip to content

Commit

Permalink
Merge pull request #246 from Pluiexo/branch-UpdateCommandScrollUg
Browse files Browse the repository at this point in the history
Update UG on Navagibillity
  • Loading branch information
Pluiexo authored Apr 12, 2024
2 parents 2e2c27a + eabb0fc commit 083181e
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 7 deletions.
31 changes: 24 additions & 7 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,24 +42,41 @@ StaffConnect (SC) is a **desktop app for managing contacts of Professors and Tut

## Navigability

### Overall UI layout
<br>![Overall Layout](images/OverallLayout.png)


### Mouse and Keyboard controls

Before we get started StaffConnect offers a unique suite of UI controls for users to customise their own unique experience!

1. Clicking any items on the left panel will allow you to select the person contact to display.
<br>Alternatively, clicking anywhere in the list panel then using your arrow keys to navigate and hitting enter to select would give the same result.
1. Clicking any items on the left contacts panel will allow you to select the person contact to display.
<br>Alternatively, clicking anywhere in the contacts panel then using your arrow keys to navigate and hitting enter to select would give the same result.
<br>**Intended Behaviour:**
<br> Hovering the selection with mouse or arrow keys would not cause the details panel to switch to the selected person. This is to allow users to browse the contacts panel without switching.
<br>![Region to select the person](images/personPanelRegion.png)


2. There is a divider that is draggable up and down to hide and show details on the right side and to customise the look of your application.
<br>![Region to select the divider](images/detailsDividerRegion.png)

3. Each of the 3 display panes of information they are able to pan in all four directions to view the content:
3. Each of the 2 detail panels on the right are able to pan in all four directions to view the content:
- For mouse pad users, dragging around with two fingers the around would pan around the pane.
- For mouse users, __[mouse wheel]__ will scroll up and down while __[shift + mouse wheel]__ will scroll left and right.
- __[Left click + drag]__ would pan around in the details pane as well.
- For mouse users, __[Mouse Wheel]__ will scroll up and down while __[Shift + Mouse wheel]__ will scroll left and right.
- __[Left click + Drag Mouse]__ would pan around in the details pane as well.
- Keyboard arrow keys are able to pan around as well, but the scroll speed may differ on different systems.
- There are scroll bars at the vertical and horizontal dividers of the window pane, dragging them in the respective direction will pan around as well.


4. The Result display:<br>
The scroll bars can only be scrolled by two ways:
1. For mouse pad users, dragging around with two fingers the around would pan around the pane.
2. For mouse users, __[Mouse Wheel]__ will scroll up and down while __[Shift + Mouse Wheel]__ will scroll left and right.
3. Simply dragging the scroll bar with a left mouse click.
<br>**Scrolling by arrow keys is not fully supported in the result display**

5. The Command box:<br>
The input can only be scrolled by __[Holding Left Click + Drag Mouse]__ to the edge in the direction to scroll. This is to allow making adjustments on very long commands.


<Br><Br>
### Alternative UI arrangements
Expand All @@ -69,7 +86,7 @@ Before we get started StaffConnect offers a unique suite of UI controls for user

**Intended Limitations**
1. The divider position is not controllable by keyboard input, hence the only way to customise the look is mostly by mouse input.
2. Pane switching by keyboard input, like a terminal is not supported.
2. Panel switching by keyboard input, like a terminal is not supported.
3. Font sizes does not automatically resize in this application, scroll bars will appear in smaller window variants of this application to help with the viewing of details.
4. The UI will do a soft reset on its divider position every time the application is relaunched, as this is to allow users who wish to fall back to the default layout settings.

Expand Down
Binary file added docs/images/OverallLayout.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 083181e

Please sign in to comment.