From dd84b514b6616af96136db6ad7bc6a6d3d5622fe Mon Sep 17 00:00:00 2001
From: Titus Chew <39845485+tituschewxj@users.noreply.github.com>
Date: Mon, 15 Apr 2024 20:26:38 +0800
Subject: [PATCH] Update DG and DG
Let's
- Update symbols
- Reorder info box in edit
- Add prefix note
- Enter key
---
docs/UserGuide.md | 65 ++++++++++++++++++++++++++++++-----------------
1 file changed, 42 insertions(+), 23 deletions(-)
diff --git a/docs/UserGuide.md b/docs/UserGuide.md
index bf2e94c754f..0a3e60198ef 100644
--- a/docs/UserGuide.md
+++ b/docs/UserGuide.md
@@ -73,19 +73,21 @@ Diving into TAPro, you'll encounter some handy notations and terms. We've decode
Symbols are indicators that give additional information about a target piece of text.
-| Symbol | Meaning of target text |
-|------------------------------------------------------|-------------------------------|
-| | Tip |
-| | Warning |
-| | Important |
-| | Additional useful information |
-| | Valid example |
-| | Invalid example |
-| | Danger |
-| | Definition |
-| | Question |
-| | Command Format |
-| {{ macros.keyFormat('Key') }} | Represents a keyboard input. |
+| Symbol | Meaning of target text |
+|------------------------------------------------------|---------------------------------|
+| | Tip |
+| | Warning |
+| | Important |
+| | Additional useful information |
+| | Valid example |
+| | Invalid example |
+| | Danger |
+| | Definition |
+| | Question |
+| | Command Format |
+| {{ macros.keyFormat('Key') }} | Keyboard key input |
+| `syntax` | Input and output related syntax |
+| [link](#symbols) | Clickable link |
{{ newPageBetween }}
@@ -105,6 +107,7 @@ Keywords are word(s) that hold greater significance.
| **Graphical User Interface** | The visual interface that enhances user interaction with graphical elements. |
| **Parameter** | A piece of information can be used in commands to be executed. |
| **Placeholder Value** | A parameter value used to indicate that a value is not set for an attribute. |
+| **Recognized Prefix** | A prefix that has an associated parameter and attribute. |
### Abbreviations
@@ -135,6 +138,11 @@ Commands formats have specific notations to represent how a command can be used.
| **`[ELLIPSIS]...`** | Indicates that a parameter can be repeated or omitted entirely. |
| **`[SQUARE_BRACKETS]`** | Denotes optional parameters. |
+
+
+Prefixes must have a space in front of them.
+
+
### Parameters and their Recognized Prefixes
{{ macros.definitionBox('Recognized Prefixes', 'Prefixes that have an associated parameter and attribute in TAPro.') }}
@@ -144,7 +152,7 @@ Commands formats have specific notations to represent how a command can be used.
| **`NAME`** | `n/` | Name of the student. | Proper-case and alphabetical characters only. |
| **`NUSNET`** | `nn/` | NUSNet ID of the student. | Case-insensitive, unique identifier. |
| **`PHONE`** | `p/` | Phone number of the student. | At least 3 digits, and digits only. |
-| **`EMAIL`** | `e/` | Email address of the student. | Case-insensitive, email address. |
+| **`EMAIL`** | `e/` | Email address of the student. | Case-insensitive, valid email address. |
| **`MAJOR`** | `m/` | Major of the student. | Unconstrained. |
| **`TAG`** | `t/` | Tag(s) of the student. | Case-sensitive, alphanumeric without spaces. |
| **`WEEK`** | `wk/` | Week number of student's attendance. | Integer between 1 to 13 (inclusive). |
@@ -308,6 +316,9 @@ as well as quick reference of each command with simple examples on how to use th
**Format: `help`**
+
+* Additional arguments after `help` will be simply ignored.
+
@@ -469,6 +480,10 @@ A student can have any number of tags, including 0.
`bestFriend4Ever`, `colleague`, `Club` are valid tags, but `best friend`, `best-friend` are not valid tags.
+
+
+**Adding new tag(s) will replace the existing tag(s)**
+
**Adding multiple majors:**
@@ -550,6 +565,12 @@ Edits an existing student in the contact book.
* Edits the student at the specified `INDEX`. The index refers to the index number shown in the displayed student list. The index **must be a positive integer**, such as 1, 2, 3, …
+
+
+This command differs from most other commands that uses `NUSNET` to identify a student. This command uses the index number shown in the displayed person list to identify the student to be edited.
+
+
+
* At least one of the optional fields must be provided.
* Existing values will be updated to the input values.
@@ -559,12 +580,6 @@ Edits an existing student in the contact book.
* You can remove all the student’s tags by typing `t/` without
specifying any tags after it.
-
-
-This command differs from most other commands that uses `NUSNET` to identify a student. This command uses the index number shown in the displayed person list to identify the student to be edited.
-
-
-
When `t/` is specified in the command, no other tags can be present, in order to remove all of a student's tag.
@@ -825,6 +840,8 @@ Clears all entries from the contact book.
**Format: `clear`**
+* Additional arguments after `help` will be simply ignored.
+
**Screenshots of using the `clear` command:**
@@ -851,6 +868,8 @@ Exits the program.
**Format: `exit`**
+* Additional arguments after `exit` will be simply ignored.
+
**Screenshots of using the `exit` command:**
@@ -1159,8 +1178,8 @@ target computer.
2. Save the file as `TAPro.bat` (Windows) or `TAPro.sh` (macOS/Linux).
3. Change the admin settings of the script to allow it to run as a program:
- - Windows: Right-click on the script and select Properties. Under General, check the box that says `Allow this file to run as a program`.
- - macOS/Linux: Open the Terminal and navigate to the directory where the script is located. Type `chmod +x ` and press `Enter`.
+ - Windows: Right-click on the script and select Properties. Under General, check the box that says "Allow this file to run as a program".
+ - macOS/Linux: Open the Terminal and navigate to the directory where the script is located. Type `chmod +x ` and press {{ macros.keyFormat('Enter') }}.
@@ -1277,7 +1296,7 @@ designed to help you input commands faster and more efficiently.
1. Hold the {{ macros.keyFormat('Left', '') }} key to
move the cursor to the beginning of the command.
1. Add a `un` in front of `mark` to change the command to `unmark nn/E0123456 wk/6`.
-1. Press `Enter`!
+1. Press {{ macros.keyFormat('Enter') }}!