From ffc9346cb50f85cdbe1034df88747b0cfd0a6496 Mon Sep 17 00:00:00 2001 From: raydenlim <109991591+raydenlim@users.noreply.github.com> Date: Thu, 9 Nov 2023 00:44:03 +0800 Subject: [PATCH 1/7] Update UG --- docs/UserGuide.md | 170 ++++++++++++++++++++++------------------------ 1 file changed, 83 insertions(+), 87 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 163f61f6445..c2504f932a1 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -483,11 +483,11 @@ Format: `list` You can edit an existing student's fields in F.A.K.E.J.A.R.V.I.S. -Format: `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [th/TELEGRAM_HANDLE] [t/TAG]…​ [gt/GRADED_TESTS]` +Format: `edit STUDENT_INDEX [n/NAME] [p/PHONE] [e/EMAIL] [th/TELEGRAM_HANDLE] [t/TAG]…​ [gt/GRADED_TESTS]` | Parameter | Description | |-----------------|---------------------------------------------------------| -| INDEX | The index of the student to be edited. | +| STUDENT_INDEX | The index of the student to be edited. | | NAME | The new name for the student. | | PHONE | The new phone number for the student. | | EMAIL | The new email address for the student. | @@ -498,9 +498,9 @@ Format: `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [th/TELEGRAM_HANDLE] [t/TAG]…
:information_source: Note: -* Edits the person at the specified `INDEX`. -* The index refers to the index number shown in the displayed student list. -* The index **must be a positive integer** 1, 2, 3, …​ +* Edits the person at the specified `STUDENT_INDEX`. +* The student index refers to the index number shown in the displayed student list. +* The student index **must be a positive integer** 1, 2, 3, …​ * At least one of the optional fields must be provided. (i.e NAME, PHONE, EMAIL, TELEGRAM_HANDLE, TAG, GRADED_TESTS) * Editing tags overwrites existing tags; it's not cumulative. * You can remove all the person’s tags by typing `t/` without specifying any tags after it. @@ -539,12 +539,11 @@ Format: `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [th/TELEGRAM_HANDLE] [t/TAG]… You can find a student whose name contain any of the given keywords. -Format: `find KEYWORD [MORE_KEYWORDS]` +Format: `find KEYWORD…` | Parameter | Description | |---------------|-------------------------------------| | KEYWORD | The main keyword to search for. | -| MORE_KEYWORDS | Additional keywords for the search. | @@ -586,11 +585,11 @@ Format: `find KEYWORD [MORE_KEYWORDS]` You can delete a specific student from F.A.K.E.J.A.R.V.I.S. -Format: `delete INDEX` +Format: `delete STUDENT_INDEX` | Parameter | Description | |-----------|-----------------------------------------| -| INDEX | The index of the student to be deleted. | +| STUDENT_INDEX | The index of the student to be deleted. |
@@ -598,9 +597,9 @@ Format: `delete INDEX` :information_source: Note: -* Deletes 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, …​ +* Deletes the person at the specified `STUDENT_INDEX`. +* The student index refers to the index number shown in the displayed student list. +* The student index **must be a positive integer** 1, 2, 3, …​
@@ -755,8 +754,6 @@ Format: `viewtasks [tn/TASK_NAME] / [td/TASK_DESCRIPTION] / [d/DUE_DATE] / [tp/T - -

@@ -778,8 +775,8 @@ Format: `updateprogress TASK_INDEX tprog/NEW_PROGRESS` :information_source: Note: -* The index refers to the index number shown in the displayed task list. -* The index **must be a positive integer** 1, 2, 3, …​ that is within the range of the task list. +* The task index refers to the index number shown in the displayed task list. +* The task index **must be a positive integer** 1, 2, 3, …​ that is within the range of the task list.
@@ -824,8 +821,8 @@ Format: `deletetask TASK_INDEX` :information_source: Note: -* The index refers to the index number shown in the displayed task list. -* The index **must be a positive integer** 1, 2, 3, …​ that is within the range of the task list. +* The task index refers to the index number shown in the displayed task list. +* The task index **must be a positive integer** 1, 2, 3, …​ that is within the range of the task list. @@ -915,7 +912,7 @@ Format: `takeattendance n/STUDENT_NAME s/SESSION_NUMBER ap/PRESENCE` You can view the attendance list of your students. -Format: `viewattendance n/STUDENT_NAME n/STUDENT_NAME …` +Format: `viewattendance n/STUDENT_NAME…` | Parameter | Description | |--------------|----------------------------------------------------------------| @@ -972,18 +969,17 @@ Format: `viewattendance n/STUDENT_NAME n/STUDENT_NAME …` ### Assignment Management This section describes commands that help you manage your students' assignments. -

#### 👀Viewing a List of Assignments: `viewassignments` You can view a list of assignment grades and comments. -Format: `viewassignments INDEX` +Format: `viewassignments STUDENT_INDEX` | Parameter | Description | |-----------|---------------------------| -| INDEX | The index of the student. | +| STUDENT_INDEX | The index of the student. |
@@ -991,8 +987,8 @@ Format: `viewassignments INDEX` :information_source: Note: -* The index refers to the index number shown in the displayed student list. -* The index **must be a positive integer** 1, 2, 3, …​ that is within the range of the student list. +* The student index refers to the index number shown in the displayed student list. +* The student index **must be a positive integer** 1, 2, 3, …​ that is within the range of the student list.
@@ -1024,11 +1020,11 @@ Format: `viewassignments INDEX` You can edit your student’s assignment grade. -Format: `editgrade INDEX as/ASSIGNMENT g/GRADE` +Format: `editgrade STUDENT_INDEX as/ASSIGNMENT g/GRADE` | Parameter | Description | |------------|-----------------------------| -| INDEX | The index of the student. | +| STUDENT_INDEX | The index of the student. | | ASSIGNMENT | The name of the assignment. | | GRADE | The score of the student. | @@ -1038,8 +1034,8 @@ Format: `editgrade INDEX as/ASSIGNMENT g/GRADE` :information_source: Note: -* The index refers to the index number shown in the displayed student list. -* The index **must be a positive integer** 1, 2, 3, …​ that is within the range of the student list. +* The student index refers to the index number shown in the displayed student list. +* The student index **must be a positive integer** 1, 2, 3, …​ that is within the range of the student list. * The name of the assignment must exist in F.A.K.E.J.A.R.V.I.S. @@ -1072,11 +1068,11 @@ Format: `editgrade INDEX as/ASSIGNMENT g/GRADE` You can delete your student’s assignment grade. -Format: `deletegrade INDEX as/ASSIGNMENT` +Format: `deletegrade STUDENT_INDEX as/ASSIGNMENT` | Parameter | Description | |------------|-----------------------------| -| INDEX | The index of the student. | +| STUDENT_INDEX | The index of the student. | | ASSIGNMENT | The name of the assignment. | @@ -1085,8 +1081,8 @@ Format: `deletegrade INDEX as/ASSIGNMENT` :information_source: Note: -* The index refers to the index number shown in the displayed student list. -* The index **must be a positive integer** 1, 2, 3, …​ that is within the range of the student list. +* The student index refers to the index number shown in the displayed student list. +* The student index **must be a positive integer** 1, 2, 3, …​ that is within the range of the student list. * The name of the assignment must exist in F.A.K.E.J.A.R.V.I.S. @@ -1120,11 +1116,11 @@ Format: `deletegrade INDEX as/ASSIGNMENT` You can edit the comment of your student’s assignment. -Format: `editcomment INDEX as/ASSIGNMENT c/COMMENT` +Format: `editcomment STUDENT_INDEX as/ASSIGNMENT c/COMMENT` | Parameter | Description | |------------|-----------------------------| -| INDEX | The index of the student. | +| STUDENT_INDEX | The index of the student. | | ASSIGNMENT | The name of the assignment. | | COMMENT | The new comment. | @@ -1135,8 +1131,8 @@ Format: `editcomment INDEX as/ASSIGNMENT c/COMMENT` :information_source: Note: -* The index refers to the index number shown in the displayed student list. -* The index **must be a positive integer** 1, 2, 3, …​ that is within the range of the student list. +* The student index refers to the index number shown in the displayed student list. +* The student index **must be a positive integer** 1, 2, 3, …​ that is within the range of the student list. * The name of the assignment must exist in F.A.K.E.J.A.R.V.I.S. @@ -1170,11 +1166,11 @@ Format: `editcomment INDEX as/ASSIGNMENT c/COMMENT` You can delete the comment tagged to your student’s assignment. -Format: `deletecomment INDEX as/ASSIGNMENT` +Format: `deletecomment STUDENT_INDEX as/ASSIGNMENT` | Parameter | Description | |------------|-----------------------------| -| INDEX | The index of the student. | +| STUDENT_INDEX | The index of the student. | | ASSIGNMENT | The name of the assignment. | @@ -1184,8 +1180,8 @@ Format: `deletecomment INDEX as/ASSIGNMENT` :information_source: Note: -* The index refers to the index number shown in the displayed student list. -* The index **must be a positive integer** 1, 2, 3, …​ that is within the range of the student list. +* The student index refers to the index number shown in the displayed student list. +* The student index **must be a positive integer** 1, 2, 3, …​ that is within the range of the student list. * The name of the assignment must exist in F.A.K.E.J.A.R.V.I.S. @@ -1232,7 +1228,7 @@ Format: `editgradedtest INDEX [ra1/READING_ASSESSMENT_1] [ra2/READING_ASSESSMENT | Parameter | Description | |----------------------|--------------------------------------------------| -| INDEX | The index of the student. | +| STUDENT_INDEX | The index of the student. | | READING_ASSESSMENT_1 | The score of the student's Reading Assessment 1. | | READING_ASSESSMENT_2 | The score of the student's Reading Assessment 2. | | MIDTERMS | The score of the student's MidTerms. | @@ -1245,8 +1241,8 @@ Format: `editgradedtest INDEX [ra1/READING_ASSESSMENT_1] [ra2/READING_ASSESSMENT :information_source: Note: -* The index refers to the index number shown in the displayed student list. -* The index **must be a positive integer** 1, 2, 3, …​ that is within the range of the student list. +* The student index refers to the index number shown in the displayed student list. +* The student index **must be a positive integer** 1, 2, 3, …​ that is within the range of the student list. * At least 1 field must be present after the `INDEX`. @@ -1291,7 +1287,7 @@ This section describes commands that help you manage your sessions. You can create a session for any upcoming or past sessions. -Format: `createsession s/SESSION_NUMBER n/STUDENT_NAME n/STUDENT_NAME …` +Format: `createsession s/SESSION_NUMBER n/STUDENT_NAME…` | Parameter | Description | |----------------|------------------------------------| @@ -1435,7 +1431,7 @@ This section describes commands that help you manage your consultations with stu You can create a consultation for any upcoming consultations. -Format: `createconsult d/DATE tt/TIME n/STUDENT_NAME n/STUDENT_NAME …` +Format: `createconsult d/DATE tt/TIME n/STUDENT_NAME…` | Parameter | Description | |--------------|-----------------------------| @@ -1481,11 +1477,11 @@ Format: `createconsult d/DATE tt/TIME n/STUDENT_NAME n/STUDENT_NAME …` #### 📝️Adding students to a consultation: `addtoconsult` You can add your student(s) into a consultation slot. -Format: `addtoconsult INDEX n/STUDENT_NAME …` +Format: `addtoconsult CONSULTATION_INDEX n/STUDENT_NAME…` | Parameter | Description | |--------------|--------------------------------------------------------------| -| INDEX | The index of the consultation in the upcoming consultations. | +| CONSULTATION_INDEX | The index of the consultation in the upcoming consultations. | | STUDENT_NAME | The name of the student to be added to the consultation. | @@ -1495,8 +1491,8 @@ Format: `addtoconsult INDEX n/STUDENT_NAME …` :information_source: Note: -* The index refers to the index number shown in the displayed consultation list. -* The index **must be a positive integer** 1, 2, 3, …​ that is within the range of the consultation list. +* The consultation index refers to the index number shown in the displayed consultation list. +* The consultation index **must be a positive integer** 1, 2, 3, …​ that is within the range of the consultation list. * The name of the student must exist in F.A.K.E.J.A.R.V.I.S. @@ -1529,12 +1525,12 @@ Format: `addtoconsult INDEX n/STUDENT_NAME …` You can remove your student(s) from a consultation. -Format: `removefromconsult INDEX n/STUDENT_NAME …` +Format: `removefromconsult CONSULTATION_INDEX n/STUDENT_NAME…` -| Parameter | Description | -|--------------|--------------------------------------------------------------| -| INDEX | The index of the consultation in the upcoming consultations. | -| STUDENT_NAME | The name of the student to be added to the consultation. | +| Parameter | Description | +|--------------------|--------------------------------------------------------------| +| CONSULTATION_INDEX | The index of the consultation in the upcoming consultations. | +| STUDENT_NAME | The name of the student to be added to the consultation. |
@@ -1542,8 +1538,8 @@ Format: `removefromconsult INDEX n/STUDENT_NAME …` :information_source: Note: -* The index refers to the index number shown in the displayed consultation list. -* The index **must be a positive integer** 1, 2, 3, …​ that is within the range of the consultation list. +* The consultation index refers to the index number shown in the displayed consultation list. +* The consultation index **must be a positive integer** 1, 2, 3, …​ that is within the range of the consultation list. * The name of the student must exist in F.A.K.E.J.A.R.V.I.S. @@ -1566,11 +1562,11 @@ Format: `removefromconsult INDEX n/STUDENT_NAME …` You can delete the consultation slot specified by an index. -Format: `deleteconsult INDEX` +Format: `deleteconsult CONSULTATION_INDEX` | Parameter | Description | |-----------|--------------------------------------------------------------| -| INDEX | The index of the consultation in the upcoming consultations. | +| CONSULTATION_INDEX | The index of the consultation in the upcoming consultations. |
@@ -1578,8 +1574,8 @@ Format: `deleteconsult INDEX` :information_source: Note: -* The index refers to the index number shown in the displayed consultation list. -* The index **must be a positive integer** 1, 2, 3, …​ that is within the range of the consultation list. +* The consultation index refers to the index number shown in the displayed consultation list. +* The consultation index **must be a positive integer** 1, 2, 3, …​ that is within the range of the consultation list.
@@ -1625,33 +1621,33 @@ Format: `deleteconsult INDEX` ## Command summary -|
**Action**
|
**Format**
|
**Examples**
| -|--------------------------------------------|--------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------| -|
**Add**
| `add n/NAME p/PHONE_NUMBER e/EMAIL th/TELEGRAM_HANDLE [t/TAG]…​ [gt/GRADED_TESTS]`
| `add n/James Ho p/12345678 e/jamesho@u.nus.edu th/james03 t/friend t/colleague gt/default` | -|
**Clear**
| `clear` | `clear` | -|
**Delete**
| `delete INDEX` | `delete 3` | -|
**Edit**
| `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [th/TELGRAM_HANDLE] [t/TAG]…[gt/GRADEDTEST]…` | `edit 2 n/James Lee e/jameslee@u.nus.edu gt/default` | -|
**Find**
| `find KEYWORD [MORE_KEYWORDS]`
| `find John`
`find alex david` | -|
**List**
| `list` | `list` | -|
**Add Task**
| `addtask tn/TASK_NAME td/TASK_DESCRIPTION d/DUE_DATE tp/TASK_PRIORITY` | `addtask tn/Prepare Lecture slides d/30/09/2023 tp/high`,
`addtask tn/Read Chapter 5` | -|
**View Tasks**
| `viewtasks [tn/TASK_NAME] / [td/TASK_DESCRIPTION] / [d/DUE_DATE] / [tp/TASK_PRIORITY] /
[tprog/TASK_PROGRESS]` | `viewtasks`,
`viewtasks tp/high`,
`viewtasks d/30/09/2023` | -|
**Update Progress**
| `updateprogress TASK_INDEX tprog/NEW_PROGRESS` | `updateprogress 1 tprog/pending`,
`updateprogress 3 tprog/done` | -|
**Delete Task**
| `deletetask TASK_INDEX` | `deletetask 3`,
`deletetask 2` | -|
**View Grade**
| `viewgrade INDEX as/ASSIGNMENT` | `viewgrade 1 as/Functional Expressionism`,
`viewgrade 2 as/Rune Reading` | -|
**Edit Grade**
| `editgrade INDEX as/ASSIGNMENT g/GRADE` | `editgrade 1 as/Functional Expressionism g/1200`,
`editgrade 2 as/Rune Reading g/1000` | -|
**Delete Grade**
| `deletegrade INDEX as/ASSIGNMENT` | `deletegrade 1 as/Functional Expressionism`,
`deletegrade 2 as/Rune Reading` | -|
**Edit Comment**
| `editcomment n/STUDENT_NAME a/ASSIGNMENT c/COMMENT` | `editcomment n/Rayson a/Functional Expressionism c/Decent`,
`editcomment n/Wesley a/Rune Reading c/Great` | -|
**Delete Comment**
| `deletecomment n/STUDENT_NAME a/ASSIGNMENT` | `deletecomment n/Rayson a/Functional Expressionism`, `deletecomment n/Wesley a/Rune Reading` | -|
**Edit Graded Test**
| `editgradedtest INDEX [ra1/READING_ASSESSMENT_1] [ra2/READING_ASSESSMENT_2] [mt/MIDTERMS] [f/FINALS] [pe/PRACTICALEXAM]` | `editgradedtest 1 ra1/90 ra2/80 mt/85 f/88 pe/95`,
`editgradedtest 2 ra1/88 ra2/92 mt/78 f/80 pe/89` | -|
**Take Attendance**
| `takeattendance n/STUDENT_NAME s/SESSION p/PRESENCE` | `takeattendance n/John Doe s/5 present`,
`takeattendance n/Foo Bar s/2 absent` | -|
**View Attendance**
| `viewattendance n/STUDENT_NAME [MORE_STUDENT_NAMES]` | `viewattendance`,
`viewattendance n/Rayan`,
`viewattendance n/Jayson Resley` | -|
**Create Consultation**
| `createconsult d/DATE tt/TIME n/STUDENT_NAME …` | `createconsult d/30/10/2023 tt/12:30 n/Alex Yeoh`,
`createconsult d/30/09/2023 tt/15:30 n/Alex Yeoh n/Betsy Crower n/David Li` | -|
**Add To Consult**
| `addtoconsult INDEX n/STUDENT_NAME …` | `addtoconsult 2 n/Betsy Crower`,
`addtoconsult 1 n/David Li n/Roy Balakrishnan` | -|
**Remove From Consult**
| `removefromconsult INDEX n/STUDENT_NAME …` | `removefromconsult 2 n/Betsy Crower` | -|
**Delete Consult**
| `deleteconsult INDEX` | `deleteconsult 1` | -|
**Create Session**
| `createsession s/SESSION_NUMBER n/STUDENT_NAME …` | `createsession s/4 n/Betsy Crower n/David Li` | -|
**Update Session Remark**
| `updatesessionremark s/SESSION_NUMBER r/REMARK` | `updatesessionremark s/2 r/Teach Essence of Recursion`,
`updatesessionremark s/4 r/Taught streams and metacircular evalutator` | -|
**Delete Session**
| `deletesession s/SESSION_NUMBER` | `deletesession s/1`,
`deletesession s/4` | +|
**Action**
|
**Format**
|
**Examples**
| +|--------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------| +|
**Add**
| `add n/NAME p/PHONE_NUMBER e/EMAIL th/TELEGRAM_HANDLE [t/TAG]…​ [gt/GRADED_TESTS]`
| `add n/James Ho p/12345678 e/jamesho@u.nus.edu th/james03 t/friend t/colleague gt/default` | +|
**Clear**
| `clear` | `clear` | +|
**Delete**
| `delete STUDENT_INDEX`
| `delete 3` | +|
**Edit**
| `edit STUDENT_INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [th/TELGRAM_HANDLE] [t/TAG]…[gt/GRADEDTEST]` | `edit 2 n/James Lee e/jameslee@u.nus.edu gt/default` | +|
**Find**
| `find KEYWORD [MORE_KEYWORDS]`
| `find John`
`find alex david` | +|
**List**
| `list` | `list` | +|
**Add Task**
| `addtask tn/TASK_NAME td/TASK_DESCRIPTION d/DUE_DATE tp/TASK_PRIORITY` | `addtask tn/Prepare Lecture slides d/30/09/2023 tp/high`,
`addtask tn/Read Chapter 5` | +|
**View Tasks**
| `viewtasks [tn/TASK_NAME] / [td/TASK_DESCRIPTION] / [d/DUE_DATE] / [tp/TASK_PRIORITY] /
[tprog/TASK_PROGRESS]` | `viewtasks`,
`viewtasks tp/high`,
`viewtasks d/30/09/2023` | +|
**Update Progress**
| `updateprogress TASK_INDEX tprog/NEW_PROGRESS` | `updateprogress 1 tprog/pending`,
`updateprogress 3 tprog/done` | +|
**Delete Task**
| `deletetask TASK_INDEX` | `deletetask 3`,
`deletetask 2` | +|
**View Grade**
| `viewgrade STUDENT_INDEX as/ASSIGNMENT` | `viewgrade 1 as/Functional Expressionism`,
`viewgrade 2 as/Rune Reading` | +|
**Edit Grade**
| `editgrade STUDENT_INDEX as/ASSIGNMENT g/GRADE` | `editgrade 1 as/Functional Expressionism g/1200`,
`editgrade 2 as/Rune Reading g/1000` | +|
**Delete Grade**
| `deletegrade STUDENT_INDEX as/ASSIGNMENT` | `deletegrade 1 as/Functional Expressionism`,
`deletegrade 2 as/Rune Reading` | +|
**Edit Comment**
| `editcomment STUDENT_INDEX as/ASSIGNMENT c/COMMENT` | `editcomment 1 as/Functional Expressionism c/Decent`,
`editcomment 2 as/Rune Reading c/Great` | +|
**Delete Comment**
| `deletecomment STUDENT_INDEX as/ASSIGNMENT` | `deletecomment 1 as/Functional Expressionism`,
`deletecomment 2 as/Rune Reading` | +|
**Edit Graded Test**
| `editgradedtest STUDENT_INDEX [ra1/READING_ASSESSMENT_1] [ra2/READING_ASSESSMENT_2] [mt/MIDTERMS] [f/FINALS] [pe/PRACTICALEXAM]` | `editgradedtest 1 ra1/90 ra2/80 mt/85 f/88 pe/95`,
`editgradedtest 2 ra1/88 ra2/92 mt/78 f/80 pe/89` | +|
**Take Attendance**
| `takeattendance n/STUDENT_NAME s/SESSION p/PRESENCE` | `takeattendance n/John Doe s/5 present`,
`takeattendance n/Foo Bar s/2 absent` | +|
**View Attendance**
| `viewattendance n/STUDENT_NAME…` | `viewattendance`,
`viewattendance n/Rayan`,
`viewattendance n/Jayson Resley` | +|
**Create Consultation**
| `createconsult d/DATE tt/TIME n/STUDENT_NAME…` | `createconsult d/30/10/2023 tt/12:30 n/Alex Yeoh`,
`createconsult d/30/09/2023 tt/15:30 n/Alex Yeoh n/Betsy Crower n/David Li` | +|
**Add To Consult**
| `addtoconsult CONSULTATION_INDEX n/STUDENT_NAME…`
| `addtoconsult 2 n/Betsy Crower`,
`addtoconsult 1 n/David Li n/Roy Balakrishnan` | +|
**Remove From Consult**
| `removefromconsult CONSULTATION_INDEX n/STUDENT_NAME…` | `removefromconsult 2 n/Betsy Crower` | +|
**Delete Consult**
| `deleteconsult CONSULTATION_INDEX` | `deleteconsult 1` | +|
**Create Session**
| `createsession s/SESSION_NUMBER n/STUDENT_NAME…` | `createsession s/4 n/Betsy Crower n/David Li` | +|
**Update Session Remark**
| `updatesessionremark s/SESSION_NUMBER r/REMARK` | `updatesessionremark s/2 r/Teach Essence of Recursion`,
`updatesessionremark s/4 r/Taught streams and metacircular evalutator` | +|
**Delete Session**
| `deletesession s/SESSION_NUMBER` | `deletesession s/1`,
`deletesession s/4` | [Back to Table of Contents](#table-of-contents) From ac4eabf7f2b0da827ea8c1826e9baa76741e4c47 Mon Sep 17 00:00:00 2001 From: raydenlim <109991591+raydenlim@users.noreply.github.com> Date: Thu, 9 Nov 2023 01:21:22 +0800 Subject: [PATCH 2/7] Update UG tables and breaklines --- docs/UserGuide.md | 442 ++++++++++++++++++++++++++-------------------- 1 file changed, 251 insertions(+), 191 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index c2504f932a1..c091515c71d 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -96,43 +96,101 @@ The F.A.K.E.J.A.R.V.I.S. User Guide employs a variety of visual cues to enhance
-
- -|
**Convention**
|
**Description**
| -|---------------------------------|----------------------------------------------------------------| -|
`Monospace`
| Used for command inputs, syntax, and file paths. | -|
**Bold text**
| Highlights important keywords. | -|
[Hyperlink](#)
| Indicates hyperlinks to external websites or within the guide. | + + + +
+ + + + + + + + + + + + + + + + + + +
Convention
Description
Monospace
Used for command inputs, syntax, and file paths.
Bold text
Highlights important keywords.
Hyperlink
Indicates hyperlinks to external websites or within the guide.

-
+
-|
**Convention**
|
**Description**
| -|-------------------------------------------------------------------------------------|-----------------------------------------------------------------| -| **
:information_source: Note
** | Provides information of special interest or importance. | -| **
:bangbang: Warning
** | Alerts to potentially irreversible actions with data loss risk. | + + + + + + + + + + + + + +
Convention
Description
:information_source: Note
Provides information of special interest or importance.
:bangbang: Warning
Alerts to potentially irreversible actions with data loss risk.

-
- -|
**Convention**
|
**Description**
| -|---------------------------------|------------------------------------------------| -|
📝
|
Add
Create
| -|
❌
|
Delete
Remove
| -|
🛠️
|
Edit
Modify
Update | -|
🔎
|
Find
| -|
📆
|
Take Attendance
| -|
👀
|
View
Display
List
| +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Convention
Description
📝
Add
Create
❌
Delete
Remove
🛠️
Edit
Modify
Update
🔎
Find
📆
Take Attendance
👀
View
Display
List
+ [Back to Table of Contents](#table-of-contents)
@@ -267,31 +325,31 @@ The following describes what each panel contains: Most commands given in the user guide utilise various parameters which are also known as prefixes. To add a prefix to your command, follow this format: `PREFIX/MESSAGE`. Their prefixes and their respective constraints are given in the table below. -| Field | Prefix | Commands | Description | -|---------------------|----------|-------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| NAME | `n/` | `add` `edit` `addtoconsult` `createconsult` `removefromconsult` `createsession` `takeattendance` `viewattendance` | The Name of a student.
  • Names should only contain alphanumeric characters and spaces.
  • Names should not be blank.
| -| PHONE | `p/` | `add` `edit` | The Phone number of a student.
  • Phone numbers should only contain numbers.
  • Numbers should be at least 3 digits.
| -| EMAIL | `e/` | `add` `edit` | The Email of a student.
  • Emails should be of the format `local-part@domain`
  • The local-part should only contain alphanumeric characters and these special characters `+_.-`
  • The domain name must be `@u.nus.edu`.
| -| TELEGRAM_HANDLE | `th/` | `add` `edit` | The Telegram handle of a student.
  • Telegram Handles can only use a-z, 0-9 and underscores.
| -| TAG | `t/` | `add` `edit` | The Tag belonging to a student.
  • Tags should only contain alphanumeric characters.
| -| GRADED_TEST | `gt/` | `add` `edit` | The scores of respective graded tests.
  • Names should only contain alphanumeric characters and spaces.
  • Names should not be blank.
| -| READING_ASSESSMENT_1 | `ra1/` | `editgradedtest` | The score of Reading Assessment 1.
  • Score should be a positive number.
| -| READING_ASSESSMENT_2 | `ra2/` | `editgradedtest` | The score of Reading Assessment 2.
  • Score should be a positive number.
| -| MIDTERMS | `mt/` | `editgradedtest` | The score of a Midterms exam.
  • Score should be a positive number.
| -| FINALS | `f/` | `editgradedtest` | The score of a Finals exam.
  • Score should be a positive number.
| -| PRACTICAL_EXAM | `pe/` | `editgradedtest` | The score of a Practical exam.
  • Score should be a positive number.
| -| ASSIGNMENT | `as/` | `deletecomment` `editcomment` `editgrade` | The name of an Assignment.
  • Name should exist in the list of possible assignments.
| -| GRADE | `g/` | `editgrade` | The grade of an Assignment.
  • Grade should be a positive number.
  • Grade should be less than or equal to (max grade + 75).
  • Grade should not have leading 0's.
| -| COMMENT | `c/` | `editcomment` | The Comment of an Assignment.
  • Comment should be less than 200 characters.
  • Comment should not be empty.
| -| DATE | `d/` | `addtask` `viewtasks` `createconsult` | The Date.
  • The format must be dd/MM/yyyy.
| -| TIME | `tt/` | `createconsult` | The Time.
  • The format must be HH:mm.
  • Time must also be in 24-hour format.
| -| SESSION | `s/` | `createsession` `deletesession` `takeattendance` `updatesessionremark` | The Session Number of a Tutorial.
  • Session must only contain numbers.
  • Session should not be blank.
| -| SESSION_REMARK | `r/` | `updatesessionremark` | The remarks of a Session.
  • Remark must only contain alphanumeric characters and spaces.
| -| ATTENDANCE_PRESENCE | `ap/` | `takeattendance` | The presence of a student.
  • Only 2 possible values are allowed: `PRESENT`, `ABSENT`.
| -| TASK_NAME | `tn/` | `addtask` `viewtasks` | The name of a Task.
  • Name should only contain alphanumeric characters and spaces.
  • Name should not be blank.
| -| TASK_DESCRIPTION | `td/` | `addtask` `viewtasks` | The description of a Task.
  • Description should be less than 100 characters.
| -| TASK_PRIORITY | `tp/` | `addtask` `viewtasks` | The priority of a Task.
  • Only 3 possible values are allowed: `HIGH`, `MEDIUM`, `LOW`.
| -| TASK_PROGRESS | `tprog/` | `addtask` `viewtasks` `updateprogress` | The progress of a Task.
  • Only 3 possible values are allowed: `NOT_STARTED`, `PENDING`, `DONE`.
| +|
**Field**
|
**Prefix**
|
**Commands**
|
**Description**
| +|---------------------------------------|-----------------------------|-------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +|
NAME
|
`n/`
| `add` `edit` `addtoconsult` `createconsult` `removefromconsult` `createsession` `takeattendance` `viewattendance` | The Name of a student.
  • Names should only contain alphanumeric characters and spaces.
  • Names should not be blank.
| +|
PHONE
|
`p/`
| `add` `edit` | The Phone number of a student.
  • Phone numbers should only contain numbers.
  • Numbers should be at least 3 digits.
| +|
EMAIL
|
`e/`
| `add` `edit` | The Email of a student.
  • Emails should be of the format `local-part@domain`
  • The local-part should only contain alphanumeric characters and these special characters `+_.-`
  • The domain name must be `@u.nus.edu`.
| +|
TELEGRAM_HANDLE
|
`th/`
| `add` `edit` | The Telegram handle of a student.
  • Telegram Handles can only use a-z, 0-9 and underscores.
| +|
TAG
|
`t/`
| `add` `edit` | The Tag belonging to a student.
  • Tags should only contain alphanumeric characters.
| +|
GRADED_TEST
|
`gt/`
| `add` `edit` | The scores of respective graded tests.
  • Names should only contain alphanumeric characters and spaces.
  • Names should not be blank.
| +|
READING_ASSESSMENT_1
|
`ra1/`
| `editgradedtest` | The score of Reading Assessment 1.
  • Score should be a positive number.
| +|
READING_ASSESSMENT_2
|
`ra2/`
| `editgradedtest` | The score of Reading Assessment 2.
  • Score should be a positive number.
| +|
MIDTERMS
|
`mt/`
| `editgradedtest` | The score of a Midterms exam.
  • Score should be a positive number.
| +|
FINALS
|
`f/`
| `editgradedtest` | The score of a Finals exam.
  • Score should be a positive number.
| +|
PRACTICAL_EXAM
|
`pe/`
| `editgradedtest` | The score of a Practical exam.
  • Score should be a positive number.
| +|
ASSIGNMENT
|
`as/`
| `deletecomment` `editcomment` `editgrade` | The name of an Assignment.
  • Name should exist in the list of possible assignments.
| +|
GRADE
|
`g/`
| `editgrade` | The grade of an Assignment.
  • Grade should be a positive number.
  • Grade should be less than or equal to (max grade + 75).
  • Grade should not have leading 0's.
| +|
COMMENT
|
`c/`
| `editcomment` | The Comment of an Assignment.
  • Comment should be less than 200 characters.
  • Comment should not be empty.
| +|
DATE
|
`d/`
| `addtask` `viewtasks` `createconsult` | The Date.
  • The format must be dd/MM/yyyy.
| +|
TIME
|
`tt/`
| `createconsult` | The Time.
  • The format must be HH:mm.
  • Time must also be in 24-hour format.
| +|
SESSION
|
`s/`
| `createsession` `deletesession` `takeattendance` `updatesessionremark` | The Session Number of a Tutorial.
  • Session must only contain numbers.
  • Session should not be blank.
| +|
SESSION_REMARK
|
`r/`
| `updatesessionremark` | The remarks of a Session.
  • Remark must only contain alphanumeric characters and spaces.
| +|
ATTENDANCE_PRESENCE
|
`ap/`
| `takeattendance` | The presence of a student.
  • Only 2 possible values are allowed: `PRESENT`, `ABSENT`.
| +|
TASK_NAME
|
`tn/`
| `addtask` `viewtasks` | The name of a Task.
  • Name should only contain alphanumeric characters and spaces.
  • Name should not be blank.
| +|
TASK_DESCRIPTION
|
`td/`
| `addtask` `viewtasks` | The description of a Task.
  • Description should be less than 100 characters.
| +|
TASK_PRIORITY
|
`tp/`
| `addtask` `viewtasks` | The priority of a Task.
  • Only 3 possible values are allowed: `HIGH`, `MEDIUM`, `LOW`.
| +|
TASK_PROGRESS
|
`tprog/`
| `addtask` `viewtasks` `updateprogress` | The progress of a Task.
  • Only 3 possible values are allowed: `NOT_STARTED`, `PENDING`, `DONE`.
| [Back to Table of Contents](#table-of-contents) @@ -319,18 +377,18 @@ This section describes commands that fit in no special category. You can navigate between different tabs in F.A.K.E.J.A.R.V.I.S. -Format: `tab INDEX` - -| Parameter | Description | -|-----------|------------------------------------| -| INDEX | The Index of the tab to switch to. | +Format: `tab TAB_INDEX` +|
**Parameter**
|
**Description**
| +|--------------------------------|-----------------------------------------------------| +|
TAB_INDEX
|
The Index of the tab to switch to.
| +
:information_source: Note: -For the list of indexes to use: +For the list of tab indexes to use: * **Students List:** 1 * **Tasks List:** 2 * **Assignments List:** 3 @@ -418,14 +476,15 @@ You can add a student to F.A.K.E.J.A.R.V.I.S. Format: `add n/NAME p/PHONE_NUMBER e/EMAIL th/TELEGRAM_HANDLE [t/TAG]…​ [gt/GRADED_TESTS]` -| Parameter | Description | -|-----------------|---------------------------------------------------------| -| NAME | The name of the student to be added. | -| PHONE_NUMBER | The phone number of the student. | -| EMAIL | The email address of the student. | -| TELEGRAM_HANDLE | The Telegram handle of the student. | -| TAG | Tags associated with the student. | -| GRADED_TESTS | Scores of the graded tests associated with the student. | +|
**Parameter**
|
**Description**
| +|----------------------------------|--------------------------------------------------------------------------| +|
NAME
|
The name of the student to be added.
| +|
PHONE_NUMBER
|
The phone number of the student.
| +|
EMAIL
|
The email address of the student.
| +|
TELEGRAM_HANDLE
|
The Telegram handle of the student.
| +|
TAG
|
Tags associated with the student.
| +|
GRADED_TESTS
|
Scores of the graded tests associated with the student.
| +
@@ -485,16 +544,16 @@ You can edit an existing student's fields in F.A.K.E.J.A.R.V.I.S. Format: `edit STUDENT_INDEX [n/NAME] [p/PHONE] [e/EMAIL] [th/TELEGRAM_HANDLE] [t/TAG]…​ [gt/GRADED_TESTS]` -| Parameter | Description | -|-----------------|---------------------------------------------------------| -| STUDENT_INDEX | The index of the student to be edited. | -| NAME | The new name for the student. | -| PHONE | The new phone number for the student. | -| EMAIL | The new email address for the student. | -| TELEGRAM_HANDLE | The new Telegram handle for the student. | -| TAG | New tags associated with the student. | -| GRADED_TESTS | Scores of the graded tests associated with the student. | - +|
**Parameter**
|
**Description**
| +|----------------------------------|--------------------------------------------------------------------------| +|
STUDENT_INDEX
|
The index of the student to be edited.
| +|
NAME
|
The new name for the student.
| +|
PHONE
|
The new phone number for the student.
| +|
EMAIL
|
The new email address for the student.
| +|
TELEGRAM_HANDLE
|
The new Telegram handle for the student.
| +|
TAG
|
New tags associated with the student.
| +|
GRADED_TESTS
|
Scores of the graded tests associated with the student.
| +
:information_source: Note: @@ -541,10 +600,10 @@ You can find a student whose name contain any of the given keywords. Format: `find KEYWORD…` -| Parameter | Description | -|---------------|-------------------------------------| -| KEYWORD | The main keyword to search for. | - +|
**Parameter**
|
**Description**
| +|--------------------------------|--------------------------------------------------| +|
KEYWORD
|
The main keyword to search for.
| +
:information_source: Note: @@ -587,10 +646,10 @@ You can delete a specific student from F.A.K.E.J.A.R.V.I.S. Format: `delete STUDENT_INDEX` -| Parameter | Description | -|-----------|-----------------------------------------| -| STUDENT_INDEX | The index of the student to be deleted. | - +|
**Parameter**
|
**Description**
| +|--------------------------------|----------------------------------------------------------| +|
STUDENT_INDEX
|
The index of the student to be deleted.
| +
@@ -662,13 +721,13 @@ You can add a task to your task list. Format: `addtask tn/TASK_NAME td/TASK_DESCRIPTION d/DUE_DATE tp/TASK_PRIORITY` -| Parameter | Description | -|------------------|---------------------------------------------------------------------| -| TASK_NAME | The name of the task. | -| TASK_DESCRIPTION | The description of the task. | -| DUE_DATE | The due date or deadline of the task. | -| TASK_PRIORITY | The priority level of the task. Given as `high`, `medium` or `low`. | - +|
**Parameter**
|
**Description**
| +|-----------------------------------|--------------------------------------------------------------------------------------| +|
TASK_NAME
|
The name of the task.
| +|
TASK_DESCRIPTION
|
The description of the task.
| +|
DUE_DATE
|
The due date or deadline of the task.
| +|
TASK_PRIORITY
|
The priority level of the task. Given as `high`, `medium` or `low`.
| +
> **Example 1:** > @@ -699,14 +758,14 @@ You can view you list of tasks. Format: `viewtasks [tn/TASK_NAME] / [td/TASK_DESCRIPTION] / [d/DUE_DATE] / [tp/TASK_PRIORITY] / [tprog/TASK_PROGRESS]` -| Parameter | Description | -|------------------|------------------------------------------------------------------------------| -| TASK_NAME | The name of the task. | -| TASK_DESCRIPTION | The description of the task. | -| DUE_DATE | The due date or deadline of the task. | -| TASK_PRIORITY | The priority level of the task. Given as `high`, `medium` or `low`. | -| TASK_PROGRESS | The progress level of the task. Given as `done`, `pending` or `not_started`. | - +|
**Parameter**
|
**Description**
| +|-----------------------------------|-----------------------------------------------------------------------------------------------| +|
TASK_NAME
|
The name of the task.
| +|
TASK_DESCRIPTION
|
The description of the task.
| +|
DUE_DATE
|
The due date or deadline of the task.
| +|
TASK_PRIORITY
|
The priority level of the task. Given as `high`, `medium` or `low`.
| +|
TASK_PROGRESS
|
The progress level of the task. Given as `done`, `pending` or `not_started`.
| +
@@ -763,11 +822,11 @@ You can mark a task as completed. Format: `updateprogress TASK_INDEX tprog/NEW_PROGRESS` -| Parameter | Description | -|--------------|-----------------------------------------------------------------------------------| -| TASK_INDEX | The index of the task to update the progress. | -| NEW_PROGRESS | The new progress level of the task. Given as `done`, `pending`, or `not_started`. | - +|
**Parameter**
|
**Description**
| +|--------------------------------|----------------------------------------------------------------------------------------------------| +|
TASK_INDEX
|
The index of the task to update the progress.
| +|
NEW_PROGRESS
|
The new progress level of the task. Given as `done`, `pending`, or `not_started`.
| +
@@ -811,10 +870,10 @@ Deletes a task from the task list. Format: `deletetask TASK_INDEX` -| Parameter | Description | -|------------|----------------------------------| -| TASK_INDEX | The index of the task to delete. | - +|
**Parameter**
|
**Description**
| +|--------------------------------|-------------------------------------------| +|
TASK_INDEX
|
The index of the task to delete.
| +
@@ -868,12 +927,12 @@ You can take the attendance of your student(s). Format: `takeattendance n/STUDENT_NAME s/SESSION_NUMBER ap/PRESENCE` -| Parameter | Description | -|----------------|-----------------------------------------------------------------------| -| STUDENT_NAME | The name of the student. | -| SESSION_NUMBER | The session number of the session. | -| PRESENCE | The attendance status of the student. Given as `present` or `absent`. | - +|
**Parameter**
|
**Description**
| +|---------------------------------|----------------------------------------------------------------------------------------| +|
STUDENT_NAME
|
The name of the student.
| +|
SESSION_NUMBER
|
The session number of the session.
| +|
PRESENCE
|
The attendance status of the student. Given as `present` or `absent`.
| +
@@ -914,10 +973,10 @@ You can view the attendance list of your students. Format: `viewattendance n/STUDENT_NAME…` -| Parameter | Description | -|--------------|----------------------------------------------------------------| -| STUDENT_NAME | The name of the student(s) you want to view the attendance of. | - +|
**Parameter**
|
**Description**
| +|--------------------------------|---------------------------------------------------------------------------------| +|
STUDENT_NAME
|
The name of the student(s) you want to view the attendance of.
| +
@@ -977,10 +1036,10 @@ You can view a list of assignment grades and comments. Format: `viewassignments STUDENT_INDEX` -| Parameter | Description | -|-----------|---------------------------| -| STUDENT_INDEX | The index of the student. | - +|
**Parameter**
|
**Description**
| +|--------------------------------|--------------------------------------------| +|
STUDENT_INDEX
|
The index of the student.
| +
@@ -1022,12 +1081,12 @@ You can edit your student’s assignment grade. Format: `editgrade STUDENT_INDEX as/ASSIGNMENT g/GRADE` -| Parameter | Description | -|------------|-----------------------------| -| STUDENT_INDEX | The index of the student. | -| ASSIGNMENT | The name of the assignment. | -| GRADE | The score of the student. | - +|
**Parameter**
|
**Description**
| +|--------------------------------|----------------------------------------------| +|
STUDENT_INDEX
|
The index of the student.
| +|
ASSIGNMENT
|
The name of the assignment.
| +|
GRADE
|
The score of the student.
| +
@@ -1070,11 +1129,11 @@ You can delete your student’s assignment grade. Format: `deletegrade STUDENT_INDEX as/ASSIGNMENT` -| Parameter | Description | -|------------|-----------------------------| -| STUDENT_INDEX | The index of the student. | -| ASSIGNMENT | The name of the assignment. | - +|
**Parameter**
|
**Description**
| +|--------------------------------|----------------------------------------------| +|
STUDENT_INDEX
|
The index of the student.
| +|
ASSIGNMENT
|
The name of the assignment.
| +
@@ -1118,12 +1177,12 @@ You can edit the comment of your student’s assignment. Format: `editcomment STUDENT_INDEX as/ASSIGNMENT c/COMMENT` -| Parameter | Description | -|------------|-----------------------------| -| STUDENT_INDEX | The index of the student. | -| ASSIGNMENT | The name of the assignment. | -| COMMENT | The new comment. | - +|
**Parameter**
|
**Description**
| +|--------------------------------|----------------------------------------------| +|
TUDENT_INDEX
|
The index of the student.
| +|
ASSIGNMENT
|
The name of the assignment.
| +|
COMMENT
|
The new comment.
| +
@@ -1168,11 +1227,11 @@ You can delete the comment tagged to your student’s assignment. Format: `deletecomment STUDENT_INDEX as/ASSIGNMENT` -| Parameter | Description | -|------------|-----------------------------| -| STUDENT_INDEX | The index of the student. | -| ASSIGNMENT | The name of the assignment. | - +|
**Parameter**
|
**Description**
| +|--------------------------------|----------------------------------------------| +|
STUDENT_INDEX
|
The index of the student.
| +|
ASSIGNMENT
|
The name of the assignment.
| +
@@ -1226,15 +1285,15 @@ You can edit your student’s graded test scores. Format: `editgradedtest INDEX [ra1/READING_ASSESSMENT_1] [ra2/READING_ASSESSMENT_2] [mt/MIDTERMS] [f/FINALS] [pe/PRACTICALEXAM] ` -| Parameter | Description | -|----------------------|--------------------------------------------------| -| STUDENT_INDEX | The index of the student. | -| READING_ASSESSMENT_1 | The score of the student's Reading Assessment 1. | -| READING_ASSESSMENT_2 | The score of the student's Reading Assessment 2. | -| MIDTERMS | The score of the student's MidTerms. | -| FINALS | The score of the student's Final Assessment. | -| PRACTICALEXAM | The score of the student's Practical Exams. | - +|
**Parameter**
|
**Description**
| +|---------------------------------------|-------------------------------------------------------------------| +|
STUDENT_INDEX
|
The index of the student.
| +|
READING_ASSESSMENT_1
|
The score of the student's Reading Assessment 1.
| +|
READING_ASSESSMENT_2
|
The score of the student's Reading Assessment 2.
| +|
MIDTERMS
|
The score of the student's MidTerms.
| +|
FINALS
|
The score of the student's Final Assessment.
| +|
PRACTICALEXAM
|
The score of the student's Practical Exams.
| +
@@ -1289,11 +1348,11 @@ You can create a session for any upcoming or past sessions. Format: `createsession s/SESSION_NUMBER n/STUDENT_NAME…` -| Parameter | Description | -|----------------|------------------------------------| -| SESSION_NUMBER | The session number of the session. | -| STUDENT_NAME | The name of the student(s). | - +|
**Parameter**
|
**Description**
| +|---------------------------------|-----------------------------------------------------| +|
SESSION_NUMBER
|
The session number of the session.
| +|
STUDENT_NAME
|
The name of the student(s).
| +
@@ -1335,11 +1394,11 @@ You can update an existing session's remark. Format: `updatesessionremark s/SESSION_NUMBER r/REMARK` -| Parameter | Description | -|----------------|-----------------------------------------------| -| SESSION_NUMBER | The session number of the session. | -| REMARK | The new remark to be updated for the session. | - +|
**Parameter**
|
**Description**
| +|---------------------------------|----------------------------------------------------------------| +|
SESSION_NUMBER
|
The session number of the session.
| +|
REMARK
|
The new remark to be updated for the session.
| +
@@ -1381,10 +1440,10 @@ You can delete an existing session specified by its session number. Format: `deletesession s/SESSION_NUMBER` -| Parameter | Description | -|----------------|------------------------------------| -| SESSION_NUMBER | The session number of the session. | - +|
**Parameter**
|
**Description**
| +|---------------------------------|-----------------------------------------------------| +|
SESSION_NUMBER
|
The session number of the session.
| +
@@ -1433,12 +1492,12 @@ You can create a consultation for any upcoming consultations. Format: `createconsult d/DATE tt/TIME n/STUDENT_NAME…` -| Parameter | Description | -|--------------|-----------------------------| -| DATE | The date of consultation. | -| TIME | The time of consultation. | -| STUDENT_NAME | The name of the student(s). | - +|
**Parameter**
|
**Description**
| +|--------------------------------|----------------------------------------------| +|
DATE
|
The date of consultation.
| +|
TIME
|
The time of consultation.
| +|
STUDENT_NAME
|
The name of the student(s).
| +
@@ -1479,11 +1538,11 @@ You can add your student(s) into a consultation slot. Format: `addtoconsult CONSULTATION_INDEX n/STUDENT_NAME…` -| Parameter | Description | -|--------------|--------------------------------------------------------------| -| CONSULTATION_INDEX | The index of the consultation in the upcoming consultations. | -| STUDENT_NAME | The name of the student to be added to the consultation. | - +|
**Parameter**
|
**Description**
| +|-------------------------------------|-------------------------------------------------------------------------------| +|
CONSULTATION_INDEX
|
The index of the consultation in the upcoming
consultations. | +|
STUDENT_NAME
|
The name of the student to be added to the consultation.
| +
@@ -1527,11 +1586,11 @@ You can remove your student(s) from a consultation. Format: `removefromconsult CONSULTATION_INDEX n/STUDENT_NAME…` -| Parameter | Description | -|--------------------|--------------------------------------------------------------| -| CONSULTATION_INDEX | The index of the consultation in the upcoming consultations. | -| STUDENT_NAME | The name of the student to be added to the consultation. | - +|
**Parameter**
|
**Description**
| +|-------------------------------------|-------------------------------------------------------------------------------| +|
CONSULTATION_INDEX
|
The index of the consultation in the upcoming consultations.
| +|
STUDENT_NAME
|
The name of the student to be added to the consultation.
| +
@@ -1564,10 +1623,10 @@ You can delete the consultation slot specified by an index. Format: `deleteconsult CONSULTATION_INDEX` -| Parameter | Description | -|-----------|--------------------------------------------------------------| -| CONSULTATION_INDEX | The index of the consultation in the upcoming consultations. | - +|
**Parameter**
|
**Description**
| +|-------------------------------------|-------------------------------------------------------------------------------| +|
CONSULTATION_INDEX
|
The index of the consultation in the upcoming
consultations. | +
@@ -1649,6 +1708,7 @@ Format: `deleteconsult CONSULTATION_INDEX` |
**Update Session Remark**
| `updatesessionremark s/SESSION_NUMBER r/REMARK` | `updatesessionremark s/2 r/Teach Essence of Recursion`,
`updatesessionremark s/4 r/Taught streams and metacircular evalutator` | |
**Delete Session**
| `deletesession s/SESSION_NUMBER` | `deletesession s/1`,
`deletesession s/4` | +
[Back to Table of Contents](#table-of-contents)
@@ -1660,14 +1720,14 @@ Format: `deleteconsult CONSULTATION_INDEX` ## Encountering Errors This section outlines a list of error messages that you may encounter during your usage of the application. It aims to help you better understand the messages that you may receive and what it means to you. -| Error | What it means | How to resolve | -|---------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **Unknown command** | You have supplied a command that was unrecognisable.
E.g., Command word was given in upper case. | 1. Double-check the spelling and case of the command.
2. Refer to the [features](#features) section above for the correct commands. | -| **Invalid command format!** | You have supplied a command with the incorrect format.
E.g., Command is missing the compulsory parameters. | 1. Double-check the command format and the parameters required.
2. Refer to the [features](#features) section above for the correct command formats. | -| **The Index provided is invalid** | You have provided an index that is out of the range of the items. | 1. Only provide Indexes that are within the range of the list.
E.g., if there are 3 items in the list, the valid indexes that can be used are (1, 2, 3). | -| **At least one field to edit must be provided.** | You have not provided a field to edit. | 1. Double-check that a prefix and a field was provided together with the command. | -| **This `task` / `person` already exists in the `task list` / `students list`.** | You have tried to either add a duplicate entry with the same fields, or edit an entry such that all the fields are duplicates of an existing entry. | 1. Double-check that the fields supplied are correct.
2. Remove the old entry from F.A.K.E.J.A.R.V.I.S. | -| **Date needs to be in the format dd/MM/yyyy, or date has already crossed.** | You have either supplied the date in an unrecognisable format, or provided a date that is in the past. | 1. Double-check that the format of the date provided is dd/MM/yyyy (e.g. 28/10/2023)
2. Choose a date from today or later. | -| **Time needs to be in the format HH:mm.** | You have supplied the time in an unrecognisable format. | 1. Double-check that the format of the time provided is HH:mm (e.g. 22:00) | +|
Error
|
What it means
|
How to resolve
| +|--------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------| +|
**Unknown command**
| You have supplied a command that was unrecognisable.
E.g., Command word was given in upper case. | 1. Double-check the spelling and case of the command.
2. Refer to the [features](#features) section above for the correct commands. | +|
**Invalid command format!**
| You have supplied a command with the incorrect format.
E.g., Command is missing the compulsory parameters. | 1. Double-check the command format and the parameters required.
2. Refer to the [features](#features) section above for the correct command formats. | +|
**The Index provided is invalid**
| You have provided an index that is out of the range of the items. | 1. Only provide Indexes that are within the range of the list.
E.g., if there are 3 items in the list, the valid indexes that can be used are (1, 2, 3). | +|
**At least one field to edit must be provided.**
| You have not provided a field to edit. | 1. Double-check that a prefix and a field was provided together with the command. | +|
**This `task` / `person` already exists in the `task list` / `students list`.**
| You have tried to either add a duplicate entry with the same fields, or edit an entry such that all the fields are duplicates of an existing entry. | 1. Double-check that the fields supplied are correct.
2. Remove the old entry from F.A.K.E.J.A.R.V.I.S. | +|
**Date needs to be in the format dd/MM/yyyy, or date has already crossed.**
| You have either supplied the date in an unrecognisable format, or provided a date that is in the past. | 1. Double-check that the format of the date provided is dd/MM/yyyy (e.g. 28/10/2023)
2. Choose a date from today or later. | +|
**Time needs to be in the format HH:mm.**
| You have supplied the time in an unrecognisable format. | 1. Double-check that the format of the time provided is HH:mm (e.g. 22:00) | [Back to Table of Contents](#table-of-contents) From 7c8b132bfaea028aac0b246c8679ff8fb778445f Mon Sep 17 00:00:00 2001 From: raydenlim <109991591+raydenlim@users.noreply.github.com> Date: Thu, 9 Nov 2023 01:29:45 +0800 Subject: [PATCH 3/7] UG css test --- docs/UserGuide.md | 49 +++++++++++++++++++++++++---------------------- 1 file changed, 26 insertions(+), 23 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index c091515c71d..26613114226 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -3,7 +3,19 @@ layout: default.md title: "User Guide" pageNav: 3 --- - + # F.A.K.E.J.A.R.V.I.S. User Guide ## Introduction @@ -96,18 +108,6 @@ The F.A.K.E.J.A.R.V.I.S. User Guide employs a variety of visual cues to enhance
- - -
@@ -1135,16 +1135,19 @@ Format: `deletegrade STUDENT_INDEX as/ASSIGNMENT` |
ASSIGNMENT
|
The name of the assignment.
|
-
- - -:information_source: Note: - -* The student index refers to the index number shown in the displayed student list. -* The student index **must be a positive integer** 1, 2, 3, …​ that is within the range of the student list. -* The name of the assignment must exist in F.A.K.E.J.A.R.V.I.S. - - +
+
+ + :information_source: Note: + +
+
+ + * The student index refers to the index number shown in the displayed student list. + * The student index must be a positive integer 1, 2, 3, …​ that is within the range of the student list. + * The name of the assignment must exist in F.A.K.E.J.A.R.V.I.S. + +
From eea7fb823576bdd14f62ef4619737db0e3b76126 Mon Sep 17 00:00:00 2001 From: raydenlim <109991591+raydenlim@users.noreply.github.com> Date: Thu, 9 Nov 2023 01:36:02 +0800 Subject: [PATCH 4/7] Enhance index error messages to be clearer --- src/main/java/seedu/address/logic/commands/EditCommand.java | 4 ++-- .../java/seedu/address/logic/commands/EditGradeCommand.java | 4 ++-- .../seedu/address/logic/commands/EditGradedTestCommand.java | 4 ++-- src/main/java/seedu/address/logic/parser/ParserUtil.java | 2 +- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/src/main/java/seedu/address/logic/commands/EditCommand.java b/src/main/java/seedu/address/logic/commands/EditCommand.java index 9e8cb38924f..a6a8281ccad 100644 --- a/src/main/java/seedu/address/logic/commands/EditCommand.java +++ b/src/main/java/seedu/address/logic/commands/EditCommand.java @@ -44,9 +44,9 @@ public class EditCommand extends Command { public static final String COMMAND_WORD = "edit"; public static final String MESSAGE_USAGE = COMMAND_WORD + ": Edits the details of the person identified " - + "by the index number used in the displayed person list. " + + "by the student index number used in the displayed person list. " + "Existing values will be overwritten by the input values.\n" - + "Parameters: INDEX (must be a positive integer) " + + "Parameters: STUDENT_INDEX (must be a positive integer) " + "[" + PREFIX_NAME + "NAME] " + "[" + PREFIX_PHONE + "PHONE] " + "[" + PREFIX_EMAIL + "EMAIL] " diff --git a/src/main/java/seedu/address/logic/commands/EditGradeCommand.java b/src/main/java/seedu/address/logic/commands/EditGradeCommand.java index 905ddecc6ab..ebb2c8a495d 100644 --- a/src/main/java/seedu/address/logic/commands/EditGradeCommand.java +++ b/src/main/java/seedu/address/logic/commands/EditGradeCommand.java @@ -33,8 +33,8 @@ public class EditGradeCommand extends Command { public static final String COMMAND_WORD = "editgrade"; public static final String MESSAGE_USAGE = COMMAND_WORD + ": Edits a grade to a person’s assignment identified " - + "by the index number used in the displayed person list. " - + "Parameters: INDEX (must be a positive integer) " + + "by the student index number used in the displayed person list. " + + "Parameters: STUDENT_INDEX (must be a positive integer) " + PREFIX_ASSIGNMENT + "ASSIGNMENT " + PREFIX_GRADE + "GRADE "; diff --git a/src/main/java/seedu/address/logic/commands/EditGradedTestCommand.java b/src/main/java/seedu/address/logic/commands/EditGradedTestCommand.java index 5e264567187..ce0c111e54f 100644 --- a/src/main/java/seedu/address/logic/commands/EditGradedTestCommand.java +++ b/src/main/java/seedu/address/logic/commands/EditGradedTestCommand.java @@ -41,8 +41,8 @@ public class EditGradedTestCommand extends Command { public static final String COMMAND_WORD = "editgradedtest"; public static final String MESSAGE_USAGE = COMMAND_WORD + ": Edits the graded test of a person, " - + "identified by the index number used in the displayed person list. \n" - + "Parameters: INDEX (must be a positive integer) " + + "identified by the student index number used in the displayed person list. \n" + + "Parameters: STUDENT_INDEX (must be a positive integer) " + "[" + PREFIX_READING_ASSESSMENT1 + "RA1] " + "[" + PREFIX_READING_ASSESSMENT2 + "RA2] " + "[" + PREFIX_MIDTERMS + "MIDTERMS] " diff --git a/src/main/java/seedu/address/logic/parser/ParserUtil.java b/src/main/java/seedu/address/logic/parser/ParserUtil.java index b3d8798ad01..245b4cae7d1 100644 --- a/src/main/java/seedu/address/logic/parser/ParserUtil.java +++ b/src/main/java/seedu/address/logic/parser/ParserUtil.java @@ -41,7 +41,7 @@ */ public class ParserUtil { - public static final String MESSAGE_INVALID_INDEX = "Index is not a non-zero unsigned integer."; + public static final String MESSAGE_INVALID_INDEX = "Task index is not a non-zero unsigned integer."; public static final String MESSAGE_INVALID_DATE = "Date is needs to be in the format dd/MM/yyyy."; public static final String MESSAGE_INVALID_TIME = "Time is needs to be in the format HH:mm."; From e2abdb581fc4dcf9ee17f619698251348bc3a42e Mon Sep 17 00:00:00 2001 From: raydenlim <109991591+raydenlim@users.noreply.github.com> Date: Thu, 9 Nov 2023 06:15:45 +0800 Subject: [PATCH 5/7] Fix viewattendance UG and message --- docs/UserGuide.md | 3 ++- .../seedu/address/logic/commands/ViewAttendanceCommand.java | 2 +- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 26613114226..3be226c20b7 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -971,7 +971,7 @@ Format: `takeattendance n/STUDENT_NAME s/SESSION_NUMBER ap/PRESENCE` You can view the attendance list of your students. -Format: `viewattendance n/STUDENT_NAME…` +Format: `viewattendance [n/STUDENT_NAME]…` |
**Parameter**
|
**Description**
| |--------------------------------|---------------------------------------------------------------------------------| @@ -984,6 +984,7 @@ Format: `viewattendance n/STUDENT_NAME…` :information_source: Note: * The student must exist in F.A.K.E.J.A.R.V.I.S. +* Leaving the `STUDENT_NAME` field blank will display the overall attendance across all students and sessions.
diff --git a/src/main/java/seedu/address/logic/commands/ViewAttendanceCommand.java b/src/main/java/seedu/address/logic/commands/ViewAttendanceCommand.java index ac1ab735b8a..22b0e7a50c9 100644 --- a/src/main/java/seedu/address/logic/commands/ViewAttendanceCommand.java +++ b/src/main/java/seedu/address/logic/commands/ViewAttendanceCommand.java @@ -26,7 +26,7 @@ public class ViewAttendanceCommand extends Command { public static final String COMMAND_WORD = "viewattendance"; public static final String MESSAGE_USAGE = COMMAND_WORD + ": Views the attendance of a student. " + "Parameters: " - + PREFIX_NAME + "KEYWORD [MORE_KEYWORDS]...\n" + + "[" + PREFIX_NAME + "STUDENT_NAME]...\n" + "Example: " + COMMAND_WORD + " " + PREFIX_NAME + "John Doe Alice"; From c354f5ebb0b1ec65b7255e0f528e68f1be2798da Mon Sep 17 00:00:00 2001 From: raydenlim <109991591+raydenlim@users.noreply.github.com> Date: Thu, 9 Nov 2023 06:16:34 +0800 Subject: [PATCH 6/7] Fix viewattendance UG and message --- docs/UserGuide.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 3be226c20b7..f7061fb2b2d 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -1703,11 +1703,11 @@ Format: `deleteconsult CONSULTATION_INDEX` |
**Delete Comment**
| `deletecomment STUDENT_INDEX as/ASSIGNMENT` | `deletecomment 1 as/Functional Expressionism`,
`deletecomment 2 as/Rune Reading` | |
**Edit Graded Test**
| `editgradedtest STUDENT_INDEX [ra1/READING_ASSESSMENT_1] [ra2/READING_ASSESSMENT_2] [mt/MIDTERMS] [f/FINALS] [pe/PRACTICALEXAM]` | `editgradedtest 1 ra1/90 ra2/80 mt/85 f/88 pe/95`,
`editgradedtest 2 ra1/88 ra2/92 mt/78 f/80 pe/89` | |
**Take Attendance**
| `takeattendance n/STUDENT_NAME s/SESSION p/PRESENCE` | `takeattendance n/John Doe s/5 present`,
`takeattendance n/Foo Bar s/2 absent` | -|
**View Attendance**
| `viewattendance n/STUDENT_NAME…` | `viewattendance`,
`viewattendance n/Rayan`,
`viewattendance n/Jayson Resley` | +|
**View Attendance**
| `viewattendance [n/STUDENT_NAME]…` | `viewattendance`,
`viewattendance n/Rayan`,
`viewattendance n/Jayson Resley` | |
**Create Consultation**
| `createconsult d/DATE tt/TIME n/STUDENT_NAME…` | `createconsult d/30/10/2023 tt/12:30 n/Alex Yeoh`,
`createconsult d/30/09/2023 tt/15:30 n/Alex Yeoh n/Betsy Crower n/David Li` | |
**Add To Consult**
| `addtoconsult CONSULTATION_INDEX n/STUDENT_NAME…`
| `addtoconsult 2 n/Betsy Crower`,
`addtoconsult 1 n/David Li n/Roy Balakrishnan` | -|
**Remove From Consult**
| `removefromconsult CONSULTATION_INDEX n/STUDENT_NAME…` | `removefromconsult 2 n/Betsy Crower` | -|
**Delete Consult**
| `deleteconsult CONSULTATION_INDEX` | `deleteconsult 1` | +|
**Remove From Consult**
| `removefromconsult CONSULTATION_INDEX n/STUDENT_NAME…` | `removefromconsult 2 n/Betsy Crower` | +|
**Delete Consult**
| `deleteconsult CONSULTATION_INDEX` | `deleteconsult 1` | |
**Create Session**
| `createsession s/SESSION_NUMBER n/STUDENT_NAME…` | `createsession s/4 n/Betsy Crower n/David Li` | |
**Update Session Remark**
| `updatesessionremark s/SESSION_NUMBER r/REMARK` | `updatesessionremark s/2 r/Teach Essence of Recursion`,
`updatesessionremark s/4 r/Taught streams and metacircular evalutator` | |
**Delete Session**
| `deletesession s/SESSION_NUMBER` | `deletesession s/1`,
`deletesession s/4` | From 57097458cc17ce5426677edf0e4ec6d69a65150d Mon Sep 17 00:00:00 2001 From: raydenlim <109991591+raydenlim@users.noreply.github.com> Date: Thu, 9 Nov 2023 06:37:26 +0800 Subject: [PATCH 7/7] Fix viewattendance UG and message --- docs/UserGuide.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index f7061fb2b2d..6acc7c2fca9 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -984,7 +984,7 @@ Format: `viewattendance [n/STUDENT_NAME]…` :information_source: Note: * The student must exist in F.A.K.E.J.A.R.V.I.S. -* Leaving the `STUDENT_NAME` field blank will display the overall attendance across all students and sessions. +* Omitting `n/STUDENT_NAME` will display the overall attendance across all students and sessions. @@ -1002,7 +1002,7 @@ Format: `viewattendance [n/STUDENT_NAME]…` > **Example 2:** > -> **Input:** `viewattendance n/Alex Yeoh` Displays all the sessions that Alex Yeoh has attended. +> **Input:** `s n/Alex Yeoh` Displays all the sessions that Alex Yeoh has attended. > > **Output:** >`2 sessions listed!`