From d9de216fd4261a53a854e0b43bbeb6f6d0866669 Mon Sep 17 00:00:00 2001 From: Anant Shanker Date: Fri, 12 Apr 2024 17:19:28 +0800 Subject: [PATCH] Update UG --- docs/UserGuide.md | 46 ++++++++++++++++++++++------------------------ 1 file changed, 22 insertions(+), 24 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index db61a865d0f..8964f846337 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -129,7 +129,7 @@ TODO: Add a screenshot of the GUI with annotations 1. Ensure you have Java 11 or above installed in your computer. - + **Installing Java:** @@ -256,6 +256,15 @@ A new window is opened, so that it does not clutter up your main window. A GUI s + + +**More about help's quick reference:** + +The quick reference is meant for **fast and reliable** lookup of commands and their usages, without needing an internet connection and opening a browser to get an overview of the commands. + +* It is not meant to contain detailed information about each command. To access detailed information about each command, you can refer to our user guide. + + @@ -275,15 +284,6 @@ The help window is resizable, so you can **easily reposition and resize** it to - - -**More about help's quick reference:** - -The quick reference is meant for **fast and reliable** lookup of commands and their usages, without needing an internet connection and opening a browser to get an overview of the commands. - -* It is not meant to contain detailed information about each command. To access detailed information about each command, you can refer to our user guide. - - ---

@@ -312,21 +312,18 @@ Format: `addstu n/NAME nn/NUSNET [p/PHONE] [e/EMAIL] [m/MAJOR] [t/TAG]…​` * Name cannot be empty or spaces only, contain only alphabets and cannot have double spaces. * All the remaining fields are optional. If values are not provided to optional fields, they will be set to a placeholder value under the hood (e.g., `Major not provided` for `MAJOR` field). - - + **Tip:** A person can have any number of tags (including 0) - - -**Tip:** If a student is undertaking a double degree programme, you can use a comma to separate the disciplines in the `MAJOR` field. (e.g., `m/Computer Science, Mathematics`) - - - **Note:** NUSNet ID is case-insensitive, and it will be converted to uppercase automatically upon running the command. (e.g., `e0123456` will be converted to `E0123456`) + +**Tip:** If a student is undertaking a double degree programme, you can use a comma to separate the disciplines in the `MAJOR` field. (e.g., `m/Computer Science, Mathematics`) + + Examples: * `addstu n/John Doe nn/E1234567 p/98765432 e/johnd@example.com m/Computer Science` * `addstu n/Betsy Crowe nn/E0123456 t/friend e/betsycrowe@example.com m/Mathematics, Physics p/1234567 t/club` @@ -657,6 +654,13 @@ the previous command `mark nn/E0123456`! scroll back to the more recent commands you have entered. + + + +**Warning:** +When retrieving commands, be aware that it will erase the current text in the command input box. + + **Caution:** @@ -672,12 +676,6 @@ Only commands that has succeeded previously will be retrieved. If you enter an i when attempting to retrieve it. - - -**Warning:** -When retrieving commands, be aware that it will erase the current text in the command input box. - - ---