Skip to content

Commit

Permalink
Merge pull request AY2425S1-CS2103T-T12-4#303
Browse files Browse the repository at this point in the history 
Adjust UserGuide to fix navbar links
  • Loading branch information
@JJtan2002
JJtan2002 authored Nov 9, 2024
2 parents ff50273 + 5b18d22 commit 4366c81
Show file tree
Hide file tree
Showing 8 changed files with 63 additions and 51 deletions.
12 changes: 6 additions & 6 deletions docs/DeveloperGuide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
pageNav: 3
---

# AB-3 Developer Guide
# GamerBook Pro Max Developer Guide

<!-- * Table of Contents -->
<page-nav-print />
Expand Down Expand Up @@ -398,7 +398,7 @@ Use case ends.
* 1a1. GamerBook notifies user that the command was entered incorrectly.

Use case ends.
* 1b. User tries to add a duplicate contact.
* 1b. User attempts to add a duplicate contact.
* 1b1. GamerBook notifies the user that the contact already exists.

Use case ends.
Expand Down Expand Up @@ -448,7 +448,7 @@ Use case ends.
Use case ends.

**Extensions**
* 1a. User tries to tag a contact that does not exist.
* 1a. User attempts to tag a contact that does not exist.
* 1a1. GamerBook notifies the user that the contact cannot be found.

Use case ends.
Expand All @@ -464,7 +464,7 @@ Use case ends.
Use case ends.

**Extensions**
* 1a. User tries to list contacts when none exist.
* 1a. User attempts to list contacts when none exist.
* 1a1. GamerBook notifies the user that no contacts are available.

Use case ends.
Expand All @@ -476,7 +476,7 @@ Use case ends.
Use case ends.

**Extensions**
* 1a. User tries to edit a game that does not exist.
* 1a. User attempts to edit a game that does not exist.
* 1a1. GamerBook notifies the user that the game could not be found.

Use case ends.
Expand Down Expand Up @@ -512,7 +512,7 @@ Use case ends.
* 1a1. GamerBook notifies user the correct input format.

Use case ends.
* 1b. User enters only the start of the range.
* 1b. User enters only the starting time.
* 1b1. GamerBook returns all contacts that overlaps with the single time point.

Use case ends.
Expand Down
85 changes: 48 additions & 37 deletions docs/UserGuide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,15 @@ If you can type fast, GamerBook can get your contact management tasks done faste

--------------------------------------------------------------------------------------------------------------------

## Install and Get Started!
## Installation and Quick Start

1. Ensure you have [Java `17`](https://www.oracle.com/sg/java/technologies/downloads/) or above installed in your Computer. You can check your Java version by opening a command terminal (e.g. Command Prompt) and typing `java -version`.

2. Download the latest `.jar` file from [here](https://github.com/AY2425S1-CS2103T-T12-4/tp/releases).

3. Copy the file to the folder you want to use as the _home folder_ for your AddressBook.

4. Open a command terminal, use `cd` to nvaigate into the folder you put the jar file in, and use the `java -jar GamerBook.jar` command to run the application.<br>
4. Open a command terminal, use `cd` to navigate into the folder you put the jar file in, and use the `java -jar GamerBook.jar` command to run the application.<br>
A GUI similar to the below should appear in a few seconds. Note how the app contains some sample data.<br>
![Ui](images/Ui.png)

Expand All @@ -47,30 +47,34 @@ Refer to the [Features](#features) below for more details.

-------------------------------------------------

## Play Around With GUI
## Exploring the GUI

Our GUI consists of several parts, refer to the image below.
Our graphical user interface (GUI) consists of several parts, refer to the image below.

1. **Menu Option**: By clicking the buttons here, you can exit the app or open the help window.
2. **Command Input Box**: You may input your command here.
3. **Result Display Panel**: Error messages and result of command execution are displayed here.
1. **Menu Option**: By clicking the buttons here around the top right, you can exit the app or open the help window.
2. **Command Input Box**: You may input commands here.
3. **Result Display Panel**: Results of command execution and error messages are displayed here.
4. **Person Cards Panel**: Person cards are listed here.
![UiTut](images/UiTut.png)

### Command Popup!

![CommandPopUp](images/commandpopup.png)

We have implemented a Command Suggestion PopUp for your convenience!
Our Command Suggestion Pop-Up helps you find the command you need with ease.

As long as the command box is currently the UI element **in focus** and **at least one** character is detected inside the command box, it will suggest the possible commands that you can autocomplete it to.
When you start typing in the command box and have **at least one** character entered, the pop-up will appear, suggesting possible commands to complete your input.

Underneath each suggested command is the syntax for that command and what parameters are needed to complete it
* To access the autocomplete functionality press `shift + up` or `shift + down` while the popup is open and it will highlight the **current selection** in **blue**.
Each suggestion includes the correct command format and any required details to use it effectively.

To scroll through the suggestions:
* Press `shift + up` or `shift + down` and the **current selection** will be highlighted in **blue**.
_In the image the **current selection** would be `editgame`._

Quickly complete your commands!
* If your **current selection** is correct press `tab` to autocomplete it within the command box.

Need a quick reference?
* The suggestion will stay open as you finish your command so u can reference it in case you forget any syntax.

--------------------------------------------------------------------------------------------------------------------
Expand Down Expand Up @@ -98,33 +102,42 @@ Underneath each suggested command is the syntax for that command and what parame

* If you are using a PDF version of this document, be careful when copying and pasting commands that span multiple lines as space characters surrounding line-breaks may be omitted when copied over to the application.

</box>

<box type="info" seamless>

**Notes about command parameters:**<br>

* `NAME` only accepts alphanumeric characters and spaces. We acknowledge that names can contain special characters like `-` or `/`
e.g. Flora-Ann. We ask that users workaround this issue by using spaces or other alternatives to name contacts.

</box>
--------------------------------------------------------------------------------------------------------------------

<div style="page-break-after: always;"></div>

## Command summary

| Action | Format, Examples |
|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **Help** | `help` |
| **List** | `list` |
| **Add** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [g/GAME]… [t/TAG]… [pt/TIME-TIME]…​` <br> e.g., `add n/James Ho p/22224444 e/[email protected] a/123, Clementi Rd, 1234665 g/Overwatch t/friend t/colleague pt/2130-2359` |
| **Edit** | `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [g/Game]… [t/TAG]… [pt/TIME-TIME]…​`<br> e.g.,`edit 2 n/James Lee e/[email protected]` |
| **AddGame** | `addgame INDEX g/GAME [u/USERNAME] [s/SKILLLEVEL] [r/ROLE]​`<br> e.g.,`addgame 1 g/Overwatch u/Potato` |
| **EditGame** | `editgame INDEX g/GAME [u/USERNAME] [s/SKILLLEVEL] [r/ROLE]​`<br> e.g.,`editgame 1 g/Overwatch u/Potato` |
| **DeleteGame** | `deletegame INDEX g/GAME`<br> e.g.,`deletegame 1 g/Overwatch` |
| **FavGame** | `favgame INDEX g/GAME`<br> e.g.,`favgame 2 g/Overwatch` |
| **UnFavGame** | `unfavgame INDEX g/GAME`<br> e.g.,`unfavgame 2 g/Overwatch` |
| **Find** | `find KEYWORD [MORE_KEYWORDS]…`<br> e.g., `find James Jake` |
| **Findgame** | `findgame KEYWORD [MORE_KEYWORDS]…`<br> e.g., `find James Jake` |
| **FindTime** | `findtime TIME-TIME [TIME-TIME]…`<br> e.g., `findtime 1800-1900 2000-2200 ` |
| **Delete** | `delete INDEX`<br> e.g., `delete 3` |
| **Clear** | `clear` |
| **Undo** | `undo` |
| **Save** | `save` |
| **Load** | `load` |
| **Exit** | `exit` |
| Action | Format, Examples |
|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **Help** | `help` |
| **List** | `list` |
| **Add** | `add n/NAME [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [g/GAME]… [t/TAG]… [pt/TIME-TIME]…​` <br> e.g., `add n/James Ho p/22224444 e/[email protected] a/123, Clementi Rd, 1234665 g/Overwatch t/friend t/colleague pt/2130-2359` |
| **Edit** | `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [g/Game]… [t/TAG]… [pt/TIME-TIME]…​`<br> e.g.,`edit 2 n/James Lee e/[email protected]` |
| **AddGame** | `addgame INDEX g/GAME [u/USERNAME] [s/SKILLLEVEL] [r/ROLE]​`<br> e.g.,`addgame 1 g/Overwatch u/Potato` |
| **EditGame** | `editgame INDEX g/GAME [u/USERNAME] [s/SKILLLEVEL] [r/ROLE]​`<br> e.g.,`editgame 1 g/Overwatch u/Potato` |
| **DeleteGame** | `deletegame INDEX g/GAME`<br> e.g.,`deletegame 1 g/Overwatch` |
| **FavGame** | `favgame INDEX g/GAME`<br> e.g.,`favgame 2 g/Overwatch` |
| **UnFavGame** | `unfavgame INDEX g/GAME`<br> e.g.,`unfavgame 2 g/Overwatch` |
| **Find** | `find KEYWORD [MORE_KEYWORDS]…`<br> e.g., `find James Jake` |
| **Findgame** | `findgame KEYWORD [MORE_KEYWORDS]…`<br> e.g., `find James Jake` |
| **FindTime** | `findtime TIME-TIME [TIME-TIME]…`<br> e.g., `findtime 1800-1900 2000-2200 ` |
| **Delete** | `delete INDEX`<br> e.g., `delete 3` |
| **Clear** | `clear` |
| **Undo** | `undo` |
| **Save** | `save` |
| **Load** | `load` |
| **Exit** | `exit` |

--------------------------------------------------------------------------------------------------------------------

Expand Down Expand Up @@ -176,7 +189,7 @@ Examples:

Edits an existing person in the address book.

Format: `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [g/GAME]… [t/TAG]… [pt/PREFERRED TIME]…​`
Format: `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [g/GAME]… [t/TAG]… [pt/PREFERRED TIME]…​`

* Edits the person at the specified `INDEX`. The index refers to the index number shown in the displayed person list. The index **must be a positive integer** 1, 2, 3, …​
* At least one of the optional fields must be provided.
Expand Down Expand Up @@ -355,6 +368,8 @@ Clears all entries from the address book.

Format: `clear`

* Worried about losing your data? You can just `undo` this command!

<br>

### Undoing previous command : `undo`
Expand Down Expand Up @@ -410,11 +425,7 @@ If your changes to the data file makes its format invalid, GamerBook will discar
Furthermore, certain edits can cause the GamerBook to behave in unexpected ways (e.g., if a value entered is outside the acceptable range). Therefore, edit the data file only if you are confident that you can update it correctly.
</box>

<br>

### Archiving data files `[coming in v2.0]`

_Details coming soon ..._
<br></br>

--------------------------------------------------------------------------------------------------------------------

Expand Down
5 changes: 3 additions & 2 deletions docs/_markbind/layouts/default.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

<header sticky>
<navbar type="dark">
<a slot="brand" href="{{baseUrl}}/index.html" title="Home" class="navbar-brand">Gamerbook PRO MAX</a>
<a slot="brand" href="{{baseUrl}}/index.html" title="Home" class="navbar-brand">GamerBook Pro Max</a>
<li><a href="{{baseUrl}}/index.html" class="nav-link">Home</a></li>
<li><a href="{{baseUrl}}/UserGuide.html" class="nav-link">User Guide</a></li>
<li><a href="{{baseUrl}}/DeveloperGuide.html" class="nav-link">Developer Guide</a></li>
Expand All @@ -28,7 +28,8 @@
<site-nav>
* [Home]({{ baseUrl }}/index.html)
* [User Guide]({{ baseUrl }}/UserGuide.html) :expanded:
* [Quick Start]({{ baseUrl }}/UserGuide.html#quick-start)
* [Installation and Quick Start]({{ baseUrl }}/UserGuide.html#installation-and-quick-start)
* [Exploring the GUI]({{ baseUrl }}/UserGuide.html#exploring-the-gui)
* [Features]({{ baseUrl }}/UserGuide.html#features)
* [Command Summary]({{ baseUrl }}/UserGuide.html#command-summary)
* [Commands]({{ baseUrl }}/UserGuide.html#commands)
Expand Down
Binary file modified docs/images/Ui.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/UiTut.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions docs/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@
![Ui](images/Ui.png)


**Gamerbook PRO MAX is a desktop application for managing your gamer friends' contact details.** While it has a GUI, most of the user interactions happen using a CLI (Command Line Interface).
**GamerBook Pro Max is a desktop application for managing your gamer friends' contact details.** While it has a GUI, most of the user interactions happen using a CLI (Command Line Interface).

* If you are interested in using Gamerbook PRO MAX, head over to the [_Quick Start_ section of the **User Guide**](UserGuide.html#quick-start).
* If you are interested about developing Gamerbook PRO MAX, the [**Developer Guide**](DeveloperGuide.html) is a good place to start.
* If you are interested in using GamerBook Pro Max, head over to the [_Quick Start_ section of the **User Guide**](UserGuide.html#quick-start).
* If you are interested about developing GamerBook Pro Max, the [**Developer Guide**](DeveloperGuide.html) is a good place to start.


**Acknowledgements**
Expand Down
4 changes: 2 additions & 2 deletions docs/site.json
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"baseUrl": "",
"titlePrefix": "Gamerbook PRO MAX",
"titleSuffix": "Gamerbook PRO MAX",
"titlePrefix": "GamerBook Pro Max",
"titleSuffix": "GamerBook Pro Max",
"faviconPath": "images/Logo.png",
"style": {
"codeTheme": "light"
Expand Down
2 changes: 1 addition & 1 deletion src/main/resources/view/MainWindow.fxml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<?import javafx.scene.image.ImageView?>
<?import javafx.scene.layout.HBox?>
<fx:root type="javafx.stage.Stage" xmlns="http://javafx.com/javafx/17" xmlns:fx="http://javafx.com/fxml/1"
title="GamerBook PRO MAX" minWidth="900" minHeight="600" onCloseRequest="#handleExit">
title="GamerBook Pro Max" minWidth="900" minHeight="600" onCloseRequest="#handleExit">
<icons>
<Image url="@/images/address_book_32.png" />
</icons>
Expand Down

0 comments on commit 4366c81

Please sign in to comment.