From 22818a033dd99789a8c6281a733b633a811aa499 Mon Sep 17 00:00:00 2001 From: ldinghan Date: Sun, 12 Nov 2023 03:33:26 +0800 Subject: [PATCH 1/8] Update UG --- docs/UserGuide.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 897d5de4301..2757606e7ae 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -56,7 +56,7 @@ If you are new to CLI, or unfamiliar with the commands F.A.K.E.J.A.R.V.I.S. offe             5.2.1 [📝 Adding a Student: `add`](#adding-a-student-add)             5.2.2 [👀 Listing All Students : `list`](#listing-all-students-list)             5.2.3 [🛠️ Editing a Student Field : `edit`](#editing-a-student-field-edit) -            5.2.4 [🔎 Locating Student by Name: `find`](#locating-student-by-name-find) +            5.2.4 [🔎 Finding Student by Name: `find`](#finding-student-by-name-find)             5.2.5 [❌ Deleting a Student : `delete`](#deleting-a-student-delete)             5.2.6 [🗑️ Clearing all Entries : `clear`](#clearing-all-entries-clear) @@ -589,7 +589,7 @@ Format: `edit STUDENT_INDEX [n/NAME] [p/PHONE] [e/EMAIL] [th/TELEGRAM_HANDLE] [t

-#### 🔎Locating Student by Name: `find` +#### 🔎Finding Student by Name: `find` You can find a student in F.A.K.E.J.A.R.V.I.S. if you're looking for certain students by their names. @@ -1740,6 +1740,7 @@ Format: `deleteconsult CONSULTATION_INDEX` | **Action** | **Format** |
**Examples**
| |:-------------------------:|:--------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------------------------------------------------------------------------------------------| +| **Help** | `help` | `help` | | **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` | @@ -1756,12 +1757,12 @@ Format: `deleteconsult CONSULTATION_INDEX` | **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` | +| **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 n/Resley` | | **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 31fb278e0824cd53728f1059d135c94442d1cd90 Mon Sep 17 00:00:00 2001 From: ldinghan Date: Sun, 12 Nov 2023 04:46:15 +0800 Subject: [PATCH 2/8] Fix typos --- docs/UserGuide.md | 224 +++++++++++++++++++++++----------------------- 1 file changed, 114 insertions(+), 110 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 2757606e7ae..c127c26fcc4 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -44,9 +44,9 @@ If you are new to CLI, or unfamiliar with the commands F.A.K.E.J.A.R.V.I.S. offe       4.1 [Command Parameters](#command-parameters)  5 [Features](#features) -      5.1 [General Commands](#general-commands) -            5.1.1 [🔀 Switching between different tabs : `tab`](#switching-between-different-tabs-tab) -            5.1.2 [👀 Viewing help : `help`](#viewing-help-help) +      5.1 [General Commands](#general-commands) +            5.1.1 [👀 Viewing help : `help`](#viewing-help-help) +            5.1.2 [🔀 Switching between different tabs : `tab`](#switching-between-different-tabs-tab)             5.1.3 [🏃🚪 Exiting F.A.K.E.J.A.R.V.I.S. : `exit`](#exiting-f-a-k-e-j-a-r-v-i-s-exit)             5.1.4 [💾 Saving the Data](#saving-the-data)             5.1.5 [🛠️ Editing the Data File](#editing-the-data-file) @@ -125,7 +125,7 @@ The F.A.K.E.J.A.R.V.I.S. User Guide employs a variety of visual cues to enhance |:---------------------------------------------------------------------------------------:|:---------------------------------------------------------------:| | **
:information_source: **Note**
** | Provides information of special interest or importance. | | **
:warning: **Warning**
** | Alerts to potentially irreversible actions with data loss risk. | -| **
:bulb: **Tip**
** | Useful Tips | +| **
:bulb: **Tip**
** | Useful Tips. |
@@ -292,31 +292,31 @@ The following describes what each tab displays on the **Current Panel**: 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. | -| PHONE | `p/` | `add` `edit` | The Phone number of a student. | -| EMAIL | `e/` | `add` `edit` | The Email of a student. | -| TELEGRAM_HANDLE | `th/` | `add` `edit` | The Telegram handle of a student. | -| TAG | `t/` | `add` `edit` | The Tag belonging to a student. | -| GRADED_TEST | `gt/` | `add` `edit` | The scores of respective graded tests. | -| READING_ASSESSMENT_1 | `ra1/` | `editgradedtest` | The score of Reading Assessment 1. | -| READING_ASSESSMENT_2 | `ra2/` | `editgradedtest` | The score of Reading Assessment 2. | -| MIDTERMS | `mt/` | `editgradedtest` | The score of a Midterms exam. | -| FINALS | `f/` | `editgradedtest` | The score of a Finals exam. | -| PRACTICAL_EXAM | `pe/` | `editgradedtest` | The score of a Practical exam. | -| ASSIGNMENT | `as/` | `deletecomment` `editcomment` `editgrade` | The name of an Assignment. | -| GRADE | `g/` | `editgrade` | The grade of an Assignment. | -| COMMENT | `c/` | `editcomment` | The Comment of an Assignment. | -| DATE | `d/` | `addtask` `viewtasks` `createconsult` | The Date. | -| TIME | `tt/` | `createconsult` | The Time. | -| SESSION | `s/` | `createsession` `deletesession` `takeattendance` `updatesessionremark` | The Session Number of a Tutorial. | -| SESSION_REMARK | `r/` | `updatesessionremark` | The remarks of a Session. | -| ATTENDANCE_PRESENCE | `ap/` | `takeattendance` | The presence of a student. | -| TASK_NAME | `tn/` | `addtask` `viewtasks` | The name of a Task. | -| TASK_DESCRIPTION | `td/` | `addtask` `viewtasks` | The description of a Task. | -| TASK_PRIORITY | `tp/` | `addtask` `viewtasks` | The priority of a Task. | -| TASK_PROGRESS | `tprog/` | `addtask` `viewtasks` `updateprogress` | The progress of a Task. | +| **Field** | **Prefix** | **Commands** |
**Description**
| +|:--------------------:|:----------:|:-----------------------------------------------------------------------------------------------------------------:|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NAME | `n/` | `add` `edit` `addtoconsult` `createconsult` `removefromconsult` `createsession` `takeattendance` `viewattendance` | The Name of a Student. | +| PHONE | `p/` | `add` `edit` | The Phone Number of a Student. | +| EMAIL | `e/` | `add` `edit` | The Email of a Student. | +| TELEGRAM_HANDLE | `th/` | `add` `edit` | The Telegram Handle of a Student. | +| TAG | `t/` | `add` `edit` | The Tag belonging to a Student. | +| GRADED_TEST | `gt/` | `add` `edit` | The Scores of respective Graded Tests. | +| READING_ASSESSMENT_1 | `ra1/` | `editgradedtest` | The Score of Reading Assessment 1. | +| READING_ASSESSMENT_2 | `ra2/` | `editgradedtest` | The Score of Reading Assessment 2. | +| MIDTERMS | `mt/` | `editgradedtest` | The Score of a MidTerms exam. | +| FINALS | `f/` | `editgradedtest` | The Score of a Finals exam. | +| PRACTICAL_EXAM | `pe/` | `editgradedtest` | The Score of a Practical exam. | +| ASSIGNMENT | `as/` | `deletecomment` `editcomment` `editgrade` | The Name of an Assignment. | +| GRADE | `g/` | `editgrade` | The Grade of an Assignment. | +| COMMENT | `c/` | `editcomment` | The Comment of an Assignment. | +| DATE | `d/` | `addtask` `viewtasks` `createconsult` | The Date. | +| TIME | `tt/` | `createconsult` | The Time. | +| SESSION_NUMBER | `s/` | `createsession` `deletesession` `takeattendance` `updatesessionremark` | The Session Number of a Session. | +| SESSION_REMARK | `r/` | `updatesessionremark` | The Remarks of a Session. | +| ATTENDANCE_PRESENCE | `ap/` | `takeattendance` | The Presence of a student. | +| TASK_NAME | `tn/` | `addtask` `viewtasks` | The Name of a Task. | +| TASK_DESCRIPTION | `td/` | `addtask` `viewtasks` | The Description of a Task. | +| TASK_PRIORITY | `tp/` | `addtask` `viewtasks` | The Priority of a Task. | +| TASK_PROGRESS | `tprog/` | `addtask` `viewtasks` `updateprogress` | The Progress of a Task. | [Back to Table of Contents](#table-of-contents) @@ -340,6 +340,17 @@ This section describes commands that fit in no special category.

+#### 👀Viewing help : `help` + +You can view a message explaining how to access the help page if you require assistance in understanding the commands and their formats. + +![help message](images/helpMessage.png) + +Format: `help` + + +
+ #### 🔀Switching between different tabs: `tab` You can navigate between different tabs in F.A.K.E.J.A.R.V.I.S. to view different lists on the current panel. @@ -386,22 +397,11 @@ For the list of tab indexes to use: > > [IMAGE COMING SOON] -
- -#### 👀Viewing help : `help` - -You can view a message explaining how to access the help page, if you require assistance in understanding the commands and their formats. - -![help message](images/helpMessage.png) - -Format: `help` - -
#### 🏃🚪Exiting F.A.K.E.J.A.R.V.I.S. : `exit` -You can exit the F.A.K.E.J.A.R.V.I.S. application, if you're done using the application. +You can exit the F.A.K.E.J.A.R.V.I.S. application if you're done using the application. Format: `exit` @@ -449,14 +449,14 @@ You can add a student to F.A.K.E.J.A.R.V.I.S. if you need to keep track of new 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. | +| PHONE_NUMBER | The phone number of the student. | +| EMAIL | The email address of the student. | +| TELEGRAM_HANDLE | The Telegram handle of the student. | +| TAG | The tags associated with the student. | +| GRADED_TESTS | The scores of the graded tests associated with the student. |
@@ -495,7 +495,7 @@ Format: `add n/NAME p/PHONE_NUMBER e/EMAIL th/TELEGRAM_HANDLE [t/TAG]…​ [gt/ > **Input:** `add n/Betsy Crowe t/friend e/betsycrowe@u.nus.edu th/itsybetsyspider p/1234567 t/bestie gt/default` Adds a person called Betty Crowe into F.A.K.E.J.A.R.V.I.S. She has 1234567 as her phone number, betsycrowe@u.nus.edu as her email, itsybetsyspider as her telegram handle and bestie as tags. All her grades are also set to `-`. > > **Output:** ->`New person added: Name: Betsy Crowe; Phone: 1234567; Email: betsycrowe@u.nus.edu; Telegram Handle: itsybetsyspider; Tags: ; Graded Test: [bestie]; Graded Test: RA1: -; RA2: -; MidTerms: -; Final: -; PE: -` +>`New person added: Name: Betsy Crowe; Phone: 1234567; Email: betsycrowe@u.nus.edu; Telegram Handle: itsybetsyspider; Tags: [bestie]; Graded Test: RA1: -; RA2: -; MidTerms: -; Final: -; PE: -` > > [IMAGE COMING SOON] @@ -530,15 +530,15 @@ You can edit an existing student's fields in F.A.K.E.J.A.R.V.I.S. if you need to 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. | +| NAME | The new name of the student. | +| PHONE | The new phone number of the student. | +| EMAIL | The new email address of the student. | +| TELEGRAM_HANDLE | The new Telegram handle of the student. | +| TAG | The new tags associated with the student. | +| GRADED_TESTS | The new scores of the graded tests associated with the student. |
@@ -958,6 +958,7 @@ Format: `takeattendance n/STUDENT_NAME s/SESSION_NUMBER ap/PRESENCE` :information_source: **Note**: * The student must exist in F.A.K.E.J.A.R.V.I.S. +* The session with the session number must exist in F.A.K.E.J.A.R.V.I.S. @@ -1329,7 +1330,7 @@ Format: `editgradedtest INDEX [ra1/READING_ASSESSMENT_1] [ra2/READING_ASSESSMENT | 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. | +| PRACTICALEXAM | The score of the student's Practical Exam. |
@@ -1352,7 +1353,7 @@ Format: `editgradedtest INDEX [ra1/READING_ASSESSMENT_1] [ra2/READING_ASSESSMENT > **Input:** `editgradedtest 1 ra1/1 ra2/2 mt/3 f/4 pe/5` Edits the corresponding graded test scores for the 1st person Alex Yeoh. > > **Output:** ->`Edited Person: Name: Alex Yeoh; Phone: 91234567; Email: johndoe@u.nus.edu; Telegram Handle: alexYeohh; Tags:[friends]; Graded Test: RA1: 1; RA2: 2; MidTerms: 3; Final: 4; PE: 5` +>`Edited Person: Name: Alex Yeoh; Phone: 91234567; Email: johndoe@u.nus.edu; Telegram Handle: alexYeohh; Tags: [friends]; Graded Test: RA1: 1; RA2: 2; MidTerms: 3; Final: 4; PE: 5` > > [IMAGE COMING SOON] @@ -1400,6 +1401,7 @@ Format: `createsession s/SESSION_NUMBER n/STUDENT_NAME…` :information_source: **Note**: * The name of the student must exist in F.A.K.E.J.A.R.V.I.S. +* The session with the session number must not already exist in F.A.K.E.J.A.R.V.I.S. @@ -1448,7 +1450,7 @@ Format: `updatesessionremark s/SESSION_NUMBER r/REMARK` :information_source: **Note**: -* The session number must exist in F.A.K.E.J.A.R.V.I.S. +* The session with the session number must exist in F.A.K.E.J.A.R.V.I.S. @@ -1587,10 +1589,10 @@ You can add your student(s) into a consultation slot if you need to assign speci 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 list of upcoming consultations. | +| STUDENT_NAME | The name of the student to be added to the consultation. |
@@ -1638,10 +1640,10 @@ You can remove your student(s) from a consultation if you need to cancel your st 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 list of upcoming consultations. | +| STUDENT_NAME | The name of the student to be removed from the consultation. |
@@ -1678,9 +1680,9 @@ You can delete the consultation slot specified by an index if you need to remove 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 list of upcoming consultations. |
@@ -1738,34 +1740,36 @@ Format: `deleteconsult CONSULTATION_INDEX` ## Command summary -| **Action** | **Format** |
**Examples**
| -|:-------------------------:|:--------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------------------------------------------------------------------------------------------| -| **Help** | `help` | `help` | -| **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` | -| **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` | -| **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 n/Resley` | -| **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**
| +|:----------------------------:|:--------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------------------------------------------------------------------------------------------| +| **Help** | `help` | `help` | +| **Switch Tabs** | `tab TAB_INDEX` | `tab 4` | +| **Exit** | `exit` | `exit` | +| **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` | +| **List** | `list` | `list` | +| **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` | +| **Delete** | `delete STUDENT_INDEX` | `delete 3` | +| **Clear** | `clear` | `clear` | +| **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` | +| **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 n/Resley` | +| **View Assignments** | `viewassignments STUDENT_INDEX` | `viewassignments 1`,
`viewassignments 2` | +| **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` | +| **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` | +| **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 Consultation** | `addtoconsult CONSULTATION_INDEX n/STUDENT_NAME…` | `addtoconsult 2 n/Betsy Crower`,
`addtoconsult 1 n/David Li n/Roy Balakrishnan` | +| **Remove From Consultation** | `removefromconsult CONSULTATION_INDEX n/STUDENT_NAME…` | `removefromconsult 2 n/Betsy Crower` | +| **Delete Consultation** | `deleteconsult CONSULTATION_INDEX` | `deleteconsult 1` |
@@ -1780,14 +1784,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 e5893ed2a3941ad7b97917d8fbb1e530cd1802cf Mon Sep 17 00:00:00 2001 From: ldinghan Date: Sun, 12 Nov 2023 10:08:18 +0800 Subject: [PATCH 3/8] Fix color of code tag --- docs/UserGuide.md | 50 +++++++++++++++++++-------------------- docs/stylesheets/main.css | 2 +- 2 files changed, 26 insertions(+), 26 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index c127c26fcc4..a2f1207666d 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -292,31 +292,31 @@ The following describes what each tab displays on the **Current Panel**: 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.
  • Graded Test should only contain alphanumeric characters and spaces.
  • Graded Test field should follow this format: `gt/RA1:0 | RA2:0 | MidTerms:0 | Finals:0 | PE:0`
| -| 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_NUMBER | `s/` | `createsession` `deletesession` `takeattendance` `updatesessionremark` | The Session Number of a Session.
  • Session Number must only contain numbers.
  • Session Number 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.
  • Graded Test should only contain alphanumeric characters and spaces.
  • Graded Test field should follow this format: gt/RA1:0 | RA2:0 | MidTerms:0 | Finals:0 | PE:0
| +| 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_NUMBER | `s/` | `createsession` `deletesession` `takeattendance` `updatesessionremark` | The Session Number of a Session.
  • Session Number must only contain numbers.
  • Session Number 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) diff --git a/docs/stylesheets/main.css b/docs/stylesheets/main.css index d80db8813bb..f4e73156ec5 100644 --- a/docs/stylesheets/main.css +++ b/docs/stylesheets/main.css @@ -165,7 +165,7 @@ h6 { color: #003366; } -.hljs.inline.no-lang { +.hljs.inline.no-lang, code { color: #A46AFF; /* GUI purple */ } From f5030230e8d7767800321cd94a7793ee3347e5f0 Mon Sep 17 00:00:00 2001 From: ldinghan Date: Sun, 12 Nov 2023 10:10:32 +0800 Subject: [PATCH 4/8] Fix styles --- docs/stylesheets/main.css | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/stylesheets/main.css b/docs/stylesheets/main.css index f4e73156ec5..35009cf4936 100644 --- a/docs/stylesheets/main.css +++ b/docs/stylesheets/main.css @@ -165,10 +165,14 @@ h6 { color: #003366; } -.hljs.inline.no-lang, code { +.hljs.inline.no-lang { color: #A46AFF; /* GUI purple */ } +code { + color: #A46AFF; /* GUI purple */ +} + blockquote { border-left: 0.25em solid #46F2F1; /* left border color */ color: #6a737d; /* text color*/ From bdc40e7dfcf05b845a1c9994da0e9a5df7832bc1 Mon Sep 17 00:00:00 2001 From: ldinghan Date: Sun, 12 Nov 2023 10:10:49 +0800 Subject: [PATCH 5/8] Fix typo --- docs/stylesheets/main.css | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/stylesheets/main.css b/docs/stylesheets/main.css index 35009cf4936..71e830cb473 100644 --- a/docs/stylesheets/main.css +++ b/docs/stylesheets/main.css @@ -170,7 +170,7 @@ h6 { } code { - color: #A46AFF; /* GUI purple */ + color: #A46AFF; /* GUI purple */ } blockquote { From 12082832c85bf198cf208f7918d826c83683e66f Mon Sep 17 00:00:00 2001 From: ldinghan Date: Sun, 12 Nov 2023 10:13:44 +0800 Subject: [PATCH 6/8] Resolve merge conflicts --- docs/stylesheets/main.css | 4 ---- 1 file changed, 4 deletions(-) diff --git a/docs/stylesheets/main.css b/docs/stylesheets/main.css index b2658602bd8..8e35687121f 100644 --- a/docs/stylesheets/main.css +++ b/docs/stylesheets/main.css @@ -170,10 +170,6 @@ h6 { color: #A46AFF; /* GUI purple */ } -code { - color: #A46AFF; /* GUI purple */ -} - blockquote { border-left: 0.25em solid #46F2F1; /* left border color */ color: #000000; /* text color*/ From 91da3599c7a7148502a96e43715d8b9ed19f0243 Mon Sep 17 00:00:00 2001 From: ldinghan Date: Sun, 12 Nov 2023 10:43:43 +0800 Subject: [PATCH 7/8] Categorise command summary commands --- docs/UserGuide.md | 64 +++++++++++++++++++++++++++++++++------ docs/stylesheets/main.css | 2 +- 2 files changed, 56 insertions(+), 10 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index a2f1207666d..1e69f8fae0a 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -1740,37 +1740,83 @@ Format: `deleteconsult CONSULTATION_INDEX` ## Command summary +### General commands +| **Action** | **Format** |
**Examples**
| +|:------------------:|:--------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------------------------------------------------------------------------------------------| +| **Help** | `help` | `help` | +| **Switch Tabs** | `tab TAB_INDEX` | `tab 4` | +| **Exit** | `exit` | `exit` | +| **Clear** | `clear` | `clear` | + + +
+ +### Student commands +| **Action** | **Format** |
**Examples**
| +|:------------------:|:--------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------------------------------------------------------------------------------------------| +| **Add Student** | `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` | +| **List Students** | `list` | `list` | +| **Edit Student** | `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 Student** | `find KEYWORD [MORE_KEYWORDS]` | `find John`
`find alex david` | +| **Delete Student** | `delete STUDENT_INDEX` | `delete 3` | + +
+ +### Task commands | **Action** | **Format** |
**Examples**
| |:----------------------------:|:--------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------------------------------------------------------------------------------------------| -| **Help** | `help` | `help` | -| **Switch Tabs** | `tab TAB_INDEX` | `tab 4` | -| **Exit** | `exit` | `exit` | -| **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` | -| **List** | `list` | `list` | -| **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` | -| **Delete** | `delete STUDENT_INDEX` | `delete 3` | -| **Clear** | `clear` | `clear` | | **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` | + +
+ +### Attendance commands +| **Action** | **Format** |
**Examples**
| +|:----------------------------:|:--------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------------------------------------------------------------------------------------------| | **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 n/Resley` | + +
+ +### Assignment commands +| **Action** | **Format** |
**Examples**
| +|:----------------------------:|:--------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------------------------------------------------------------------------------------------| | **View Assignments** | `viewassignments STUDENT_INDEX` | `viewassignments 1`,
`viewassignments 2` | | **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` | + +
+ +### Graded Test commands +| **Action** | **Format** |
**Examples**
| +|:----------------------------:|:--------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------------------------------------------------------------------------------------------| | **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` | + +
+ +### Session commands +| **Action** | **Format** |
**Examples**
| +|:----------------------------:|:--------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------------------------------------------------------------------------------------------| | **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` | + + +
+ +### Consultation commands +| **Action** | **Format** |
**Examples**
| +|:----------------------------:|:--------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------------------------------------------------------------------------------------------| | **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 Consultation** | `addtoconsult CONSULTATION_INDEX n/STUDENT_NAME…` | `addtoconsult 2 n/Betsy Crower`,
`addtoconsult 1 n/David Li n/Roy Balakrishnan` | | **Remove From Consultation** | `removefromconsult CONSULTATION_INDEX n/STUDENT_NAME…` | `removefromconsult 2 n/Betsy Crower` | | **Delete Consultation** | `deleteconsult CONSULTATION_INDEX` | `deleteconsult 1` | +
[Back to Table of Contents](#table-of-contents) diff --git a/docs/stylesheets/main.css b/docs/stylesheets/main.css index 8e35687121f..204040053da 100644 --- a/docs/stylesheets/main.css +++ b/docs/stylesheets/main.css @@ -166,7 +166,7 @@ h6 { } .hljs.inline.no-lang, -.li .code { +li code { color: #A46AFF; /* GUI purple */ } From 7fcff590851e07dd2d480e6a648bd201e05cd43f Mon Sep 17 00:00:00 2001 From: ldinghan Date: Sun, 12 Nov 2023 10:46:49 +0800 Subject: [PATCH 8/8] Fix grammar --- docs/UserGuide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 1e69f8fae0a..5bc78415c56 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -1401,7 +1401,7 @@ Format: `createsession s/SESSION_NUMBER n/STUDENT_NAME…` :information_source: **Note**: * The name of the student must exist in F.A.K.E.J.A.R.V.I.S. -* The session with the session number must not already exist in F.A.K.E.J.A.R.V.I.S. +* The session with the session number must not exist in F.A.K.E.J.A.R.V.I.S.