Skip to content

Commit

Permalink
Merge pull request #179 from yellow-294/change-ug
Browse files Browse the repository at this point in the history
Update UserGuide.md
  • Loading branch information
KJunWei authored Nov 7, 2022
2 parents d3781a3 + b0d5a38 commit c21cde3
Showing 1 changed file with 15 additions and 13 deletions.
28 changes: 15 additions & 13 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,13 +50,13 @@ For teachers who are teaching more than one module, please use one TAB for each

**:information_source: Notes about the command format:**<br>

* All commands are **case sentitive**
* All tokenizers are **case sentitive**
* All commands are **case sensitive**
* All tokenizers are **case sensitive**
* Words in `UPPER_CASE` are the parameters to be supplied by the user.<br>
e.g. in `add n/NAME`, `NAME` is a parameter which can be used as `add n/John Doe`.

* Items in square brackets are optional.<br>
e.g. `n/NAME [t/TAG]` can be used as `n/John Doe t/friend` or as `n/John Doe`.
e.g. `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL]` can be used as `edit 1 n/John Doe a/Jurong` or as `n/John Doe`.

* Parameters can be in any order.<br>
e.g. if the command specifies `n/NAME p/PHONE_NUMBER`, `p/PHONE_NUMBER n/NAME` is also acceptable.
Expand Down Expand Up @@ -90,6 +90,7 @@ Format: `add n/NAME p/PHONE_NUMBER e/EMAIL pos/POSITION a/ADDRESS t/MODULE-GROUP
<div markdown="span" class="alert alert-primary">:bulb: **Tip:**
A teaching assistant or professor can have more than one tag. A student can only have one tag.


Format of parameters:
* `NAME`: Alphanumerical
* `PHONE_NUMBER`: Numerical
Expand Down Expand Up @@ -140,7 +141,7 @@ TA:
Student
* Attendance: represented as a fraction _e.g. 9/10_
* Grade: represented as a fraction. This grade is the overall grade calculated from the list of already graded Assignments.
* Graph containing each Assignment and their scores(only if their grae has been updated)
* Graph containing each Assignment and their scores(only if their grade has been updated)
Format: `show INDEX`

* Shows the detailed information of the person at the specified `INDEX`.
Expand Down Expand Up @@ -172,7 +173,7 @@ Edits the person at the specified `INDEX`. The index refers to the index number

Examples:
* `edit 1 p/91234567 e/[email protected]` edits the phone number and email address of the 1st person to be `91234567` and `[email protected]` respectively.
* `edit 2 n/Betsy Crower t/` edits the name of the 2nd person to be `Betsy Crower` and clears all existing tags.
* `edit 2 n/Betsy Crower` edits the name of the 2nd person to be `Betsy Crower`

### Adding a remark : `remark`

Expand Down Expand Up @@ -209,6 +210,7 @@ Adds assignments to all students in the TAB.
Format: `assignments assignments/ ASSIGNMENT_1 w/ASSIGNMENT_1_WEIGHTAGE, ASSIGNMENT_2 w/ASSIGNMENT_2_WEIGHTAGE…​`

* The assignments are added to all students in the TAB. Students that are added to the TAB afterwards will automatically be instantiated with the assignments.
* There must at least be one student inside TAB when running this command. The command will fail otherwise.
* The weightage of the assignments must be integers that add up to 100%. The command will fail otherwise.
* At most 10 assignments can be added.

Expand Down Expand Up @@ -311,8 +313,8 @@ Format: `clear`

### Creating new TAB : `new`

Creates a new TAB and automatically swaps to the newly created data file.

Creates a new TAB and automatically swaps to the newly created data file.<br>
There can be a maximum of 5 books.
Format: `new`

<div markdown="span" class="alert alert-primary">:bulb: **Tip:**
Expand All @@ -335,19 +337,19 @@ Renames the current data file.

Format: `rename {NEW_NAME}`

Renames the current data file as the `NEW_NAME`
Renames the current data file as the `NEW_NAME` in lowercase
* `NEW_NAME` only accepts alphanumeric, '-' and '_' characters.

Example:
* `rename CS2103T` renames the current data file as `CS2103T.json`
* `rename cs2103t` renames the current data file as `cs2103t.json`

### Saving the data

TAB data are saved in the hard disk automatically after any command that changes the data. There is no need to save manually.
TAB data is saved in the hard disk automatically after any command that changes the data. There is no need to save manually.

### Editing the data file

TAB data are saved as a JSON file `[JAR file location]/data/addressbook.json`. Advanced users are welcome to update data directly by editing that data file.
TAB data is saved as a JSON file `[JAR file location]/data/addressbook.json`. Advanced users are welcome to update data directly by editing that data file.

<div markdown="span" class="alert alert-warning">:exclamation: **Caution:**
If your changes to the data file makes its format invalid, TAB will discard all data and start with an empty data file at the next run.
Expand Down Expand Up @@ -446,10 +448,10 @@ Action | Format, Examples
**Add** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS pos/ POSITION [t/TAG]…​` <br> e.g., `add n/Alex Yeoh p/87438807 e/[email protected] pos/Student a/Blk 30 Geylang Street 29, #06-40 t/CS2103T-T17`
**List** | `list`
**Show** | `show INDEX`<br> e.g., `show 2`
**Edit** | `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]…​`<br> e.g.,`edit 2 n/James Lee e/[email protected]`
**Edit** | `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS]…​`<br> e.g.,`edit 2 n/James Lee e/[email protected]`
**Remark** | `remark INDEX r/REMARK`<br> e.g., `remark 1 r/Interested to be a TA`
**Attendance** | `attendance INDEX attendance/ATTENDANCE` <br> e.g., `attendance 1 attendance/10/13`
**Assignments** | `assignments assignments/ ASSIGNMENT_1 w/ASSIGNMENT_1_WEIGHTAGE, ASSIGNMENT_2 w/ASSIGNMENT_2_WEIGHTAGE…​`<br> e.g., `assignments assignments/ Assignment 1 w/15, Assignment 2 w/15, Midterms w/30, Finals w/40`
**Assignments** | `assignments assignments/ASSIGNMENT_1 w/ASSIGNMENT_1_WEIGHTAGE, ASSIGNMENT_2 w/ASSIGNMENT_2_WEIGHTAGE…​`<br> e.g., `assignments assignments/Assignment 1 w/15, Assignment 2 w/15, Midterms w/30, Finals w/40`
**Grade** | `grade INDEX assignment/INDEX grade/GRADE` <br> e.g., `grade 2 assignment/1 grade/68/80`
**Availability** | `avail INDEX avail/AVAILABILITY` <br> e.g., `avail 1 avail/Available`
**Roles** | `roles INDEX roles/ROLE` <br> e.g., `roles 1 roles/Coordinator`
Expand Down

0 comments on commit c21cde3

Please sign in to comment.