diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 936eeebdbc6..45653acf0ae 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -200,7 +200,7 @@ Only Java 11 has been tested to work with TAPro, so [check that your Java versio A GUI similar to the below image should appear in a few seconds. Note how the app contains some sample data. -Main Window UI on first launch +Main Window UI on first launch
@@ -311,7 +311,7 @@ as well as quick reference of each command with simple examples on how to use th A new window is opened, so that it does not clutter up your main window. A GUI similar to the below image should appear. -Help Window UI +Help Window UI @@ -381,6 +381,16 @@ Course codes must start with a prefix of 2 letters. +**#g#Examples:##** + +* `setcrs cs2103t` + +* `setcrs ST2334` + + + + + **Screenshots of using the `setcrs` command:** #g#Before running `setcrs` command:## @@ -448,9 +458,8 @@ A student can have any number of tags, including 0. **Alphanumeric tags** -{{ macros.semiBold('#g#Example:##') }} `bestFriend4Ever`, `colleague`, `Club` are valid tags, but `best friend`, `best-friend` are not valid tags. +`bestFriend4Ever`, `colleague`, `Club` are valid tags, but `best friend`, `best-friend` are not valid tags. - **Adding multiple majors:** @@ -460,7 +469,6 @@ If a student is undertaking a double degree programme, you can use a comma to se #g#Example:## We can use `m/Computer Science, Mathematics` to indicate that a student has these two majors, Computer Science and Mathematics. - @@ -537,16 +545,20 @@ 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. Otherwise, TAPro will parse the input as adding multiple tags, which may lead to an unsuccessful execution of the command. - - **#g#Example:##** Entering `edit 1 t/abc t/` will cause the error message `Tags names should be alphanumeric` to be shown. This error message is shown because TAPro expects the second `t/` to contain an alphanumeric value, which an empty value is not. - + @@ -557,10 +569,6 @@ Otherwise, TAPro will parse the input as adding multiple tags, which may lead to * `edit 2 n/Betsy Crower t/` Edits the name of the second student to be `Betsy Crower` and clears all existing tags. - - -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. - @@ -586,6 +594,7 @@ Finds students whose names contain any of the given keywords. **Format: `find KEYWORD [MORE_KEYWORDS]…​`** + **Parameters of `find` command:** @@ -687,10 +696,13 @@ Marks a student's attendance for a particular week. **Format: `mark nn/NUSNET wk/WEEK`** + + **#g#Example:##** `mark nn/E1234567 wk/3` + @@ -716,8 +728,9 @@ Unmarks a student's attendance for a particular week. **Format: `unmark nn/NUSNET wk/WEEK`** + - + **#g#Example:##** `unmark nn/E1234567 wk/3` @@ -1119,7 +1132,7 @@ target computer. - `chmod +x` changes the permissions of the script to allow it to be executed. + `chmod +x` changes the permissions of the script on unix systems to allow it to be executed. 4. Double-click on the script to launch TAPro.