diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 0b01bab4c7e..4310f6a099d 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -15,11 +15,14 @@ _Say goodbye to chaos and hello to an organized and efficient classroom experien

-F.A.K.E.J.A.R.V.I.S. is the **ultimate solution for CS1101S Avengers who manage a multitude of tutoring tasks.** This platform empowers you to efficiently track assignment gradings, monitor student participation, and seamlessly plan tutorials, consultations, and mastery checks. This is your one-stop solution to managing your time and students as a CS1101S Avenger! +F.A.K.E.J.A.R.V.I.S. is your **friendly companion for efficient task and administrative management**, allowing you to excel as a CS1101S Avenger. With this tool, you can effortlessly track assignment gradings, monitor student participation, and seamlessly plan tutorials, consultations, and mastery checks. -The application is designed for efficient usage through a Command-Line Interface, all while preserving the advantages of having a Graphical User Interface. +As Avengers ourselves, we understand the importance of managing both our time and our students effectively. F.A.K.E.J.A.R.V.I.S. is the one-stop solution to streamlining your workload, making your life easier. It is designed to empower you with the benefits of a Command-Line Interface(CLI), all while preserving the advantages of having a Graphical User Interface(GUI). -If you're new to the Command-Line Interface and need assistance, this User Guide is here to help you become familiar with it and use the application with ease. +If you are new to CLI, or unfamiliar with the commands F.A.K.E.J.A.R.V.I.S. offers and need assistance, don't worry! This UserGuide is your trusted assistant, and will guide you through every step and ensure that you can unlock the full potential of F.A.K.E.J.A.R.V.I.S. Let's get started! + + + @@ -183,93 +186,97 @@ Shows a message explaining how to access the help page. Format: `help` -### Adding a person: `add` +### Adding a Student: `add` -Adds a person to the address book. +You can add a student to your address book. Format: `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]…​` - - -**Tip:** A person can have any number of tags (including 0) - - Examples: * `add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01` * `add n/Betsy Crowe t/friend e/betsycrowe@example.com a/Newgate Prison p/1234567 t/criminal` -### Listing all persons : `list` + +**Tip:** You can add any number of tags to a person! (including 0) + + +### Listing All Students : `list` -Shows a list of all persons in the address book. +You can list out all students in your address book. Format: `list` -### Editing a person : `edit` +### Editing a Student Field : `edit` -Edits an existing person in the address book. +You can edit an existing student's fields in your address book. Format: `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [t/TAG]…​` -* Edits 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, …​ -* At least one of the optional fields must be provided. -* Existing values will be updated to the input values. -* When editing tags, the existing tags of the person will be removed i.e adding of tags is not cumulative. -* You can remove all the person’s tags by typing `t/` without - specifying any tags after it. +[//]: # (* Edits 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, …​ THIS CAN BE IN THE GLOSSARY) Examples: * `edit 1 p/91234567 e/johndoe@example.com` Edits the phone number and email address of the 1st person to be `91234567` and `johndoe@example.com` respectively. * `edit 2 n/Betsy Crower t/` Edits the name of the 2nd person to be `Betsy Crower` and clears all existing tags. -### Locating persons by name: `find` +> **Note:** +> * At least one of the optional fields must be provided. (i.e NAME, PHONE, EMAIL, ADDRESS) +> * Editing tags overwrites existing tags; it's not cumulative. To remove all tags, use `t/` without specifying any +> tags after it. +> * You can remove all the person’s tags by typing `t/` without + specifying any tags after it. -Finds persons whose names contain any of the given keywords. +### Locating Student by Name: `find` -Format: `find KEYWORD [MORE_KEYWORDS]` +You can find a student whose name contain any of the given keywords. -* The search is case-insensitive. e.g `hans` will match `Hans` -* The order of the keywords does not matter. e.g. `Hans Bo` will match `Bo Hans` -* Only the name is searched. -* Only full words will be matched e.g. `Han` will not match `Hans` -* Persons matching at least one keyword will be returned (i.e. `OR` search). - e.g. `Hans Bo` will return `Hans Gruber`, `Bo Yang` +Format: `find KEYWORD [MORE_KEYWORDS]` Examples: * `find John` returns `john` and `John Doe` * `find alex david` returns `Alex Yeoh`, `David Li`
![result for 'find alex david'](images/findAlexDavidResult.png) -### Deleting a person : `delete` +> **Note:** +> * The search is case-insensitive. e.g `hans` will match `Hans` +> * The order of the keywords does not matter. e.g. `Hans Bo` will match `Bo Hans` +> * You can remove all the person’s tags by typing `t/` without + specifying any tags after it. +> * Only full words will be matched e.g. `Han` will not match `Hans` +> * Persons matching at least one keyword will be returned (i.e. `OR` search). e.g. `Hans Bo` will return `Hans Gruber`, `Bo Yang` -Deletes the specified person from the address book. +### Deleting a Student : `delete` -Format: `delete INDEX` +You can delete any specific student from your address book. -* 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, …​ +Format: `delete INDEX` Examples: * `list` followed by `delete 2` deletes the 2nd person in the address book. * `find Betsy` followed by `delete 1` deletes the 1st person in the results of the `find` command. -### Clearing all entries : `clear` +> **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, …​ -Clears all entries from the address book. +### Clearing all Entries : `clear` + +You can clear all entries from your address book. Format: `clear` -### Exiting the program : `exit` +### Exiting F.A.K.E.J.A.R.V.I.S. : `exit` -Exits the program. +You can exit the F.A.K.E.J.A.R.V.I.S. Format: `exit` -### Saving the data +### Saving the Data -F.A.K.E.J.A.R.V.I.S. data are saved in the hard disk automatically after any command that changes the data. There is no need to save manually. +F.A.K.E.J.A.R.V.I.S. data are saved in the hard disk automatically after any command that changes the data. Ther is no need to save data manually. -### Editing the data file +### Editing the Data File F.A.K.E.J.A.R.V.I.S. data are saved automatically as a JSON file `[JAR file location]/data/fakejarvis.json`. Advanced users are welcome to update data directly by editing that data file. @@ -277,286 +284,347 @@ F.A.K.E.J.A.R.V.I.S. data are saved automatically as a JSON file `[JAR file loca If your changes to the data file makes its format invalid, F.A.K.E.J.A.R.V.I.S. will discard all data and start with an empty data file at the next run. Hence, it is recommended to take a backup of the file before editing it. -### Archiving data files `[coming in v2.0]` +### Archiving Data Files `[coming in v2.0]` + +_Stay tuned for more features and enhancements in `v2.0`, including archiving data files and more!_ -_Details coming soon ..._ +## Task Management +F.A.K.E.J.A.R.V.I.S. also simplifies task management. Here's how to make the most of it: ### 📝Adding a Task: `addtask` -Adds a task to your task list. + +You can add a task to your task list. Format: `addtask tn/TASK_NAME td/TASK_DESCRIPTION d/DUE_DATE tp/TASK_PRIORITY` -Parameters: -* 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`. +> **Parameters:** +> * 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`. Examples: * `addtask tn/Prepare Lecture slides d/30/09/2023 tp/high` creates a task to prepare lecture slides with a high priority due on September 30, 2023. * `addtask tn/Read Chapter 5` creates a task to read Chapter 5 without specifying a due date or priority. - ### 👀Viewing Tasks: `viewtasks` -Views the list of tasks. -Format: `viewtasks [tn/TASK_NAME] / [td/TASK_DESCRIPTION] / [d/DUE_DATE] / [tp/TASK_PRIORITY] / [tprog/TASK_PROGRESS]` +You can view you list of tasks. -* Only the task name, task description, due date, task priority and task progress are searched. -* Only one field can be searched at a time. -* The search is case-insensitive, e.g. `cs2101` will match `CS2101`. -* The order of the keywords does not matter, e.g. `quant book` will match `book quant`. -* If no task matching the search criteria is found, the resulting task list will be blank. +Format: `viewtasks [tn/TASK_NAME] / [td/TASK_DESCRIPTION] / [d/DUE_DATE] / [tp/TASK_PRIORITY] / [tprog/TASK_PROGRESS]` -Parameters: -* 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`. +> **Parameters:** +> * 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`. Examples: * `viewtasks` displays all tasks in the user's task list. * `viewtasks tp/high` displays only high-priority tasks. * `viewtasks d/30/09/2023` displays tasks due on September 30, 2023. +> **Tip:** +> * Only the task name, task description, due date, task priority and task progress are searched. +> * Only one field can be searched at a time. +> * The search is case-insensitive, e.g. `cs2101` will match `CS2101`. +> * The order of the keywords does not matter, e.g. `quant book` will match `book quant`. +> * If no task matching the search criteria is found, the resulting task list will be blank. + ### ✅Updating a Task's Progress: `updateprogress` -Marks a task as completed. -Format: `updateprogress TASK_INDEX tprog/NEW_PROGRESS` +You can mark a task as completed. -* 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. +Format: `updateprogress TASK_INDEX tprog/NEW_PROGRESS` -Parameters: -* 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`. +> **Parameters:** +> * 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`. Examples: * `completetask 1 tprog/pending` marks the task with index 1 as pending. * `completetask 3 tprog/done` marks the task with index 3 as done. +> **Tip:** +> * 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. ### ❌Deleting a Task: `deletetask` + Deletes a task from the task list. Format: `deletetask TASK_INDEX` -* 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. - -Parameters: -* TASK_INDEX The index of the task to delete. +> **Parameters:** +> * TASK_INDEX The index of the task to delete. Examples: * `deletetask 3` deletes the task with index 3 from the task list. * `deletetask 2` deletes the task with index 2 from the task list. -### 📆Taking attendance: `takeattendance` -Takes the attendance of a student +> **Tip:** +> * 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. -Format: `takeattendance n/STUDENT_NAME s/SESSION p/PRESENCE` +## Attendance Management -Parameters: -* STUDENT_NAME - The name of the student. -* SESSION - The session number. -* PRESENCE - The attendance status of the student (e.g., present, absent). +### 📆Taking Attendance: `takeattendance` + +You can take the attendance of your student(s). + +Format: `takeattendance n/STUDENT_NAME s/SESSION p/PRESENCE` Examples: * `takeattendance n/John Doe s/5 present` Marks John Doe as present on the 5th session. * `takeattendance n/Foo Bar s/2 absent` Marks Foo Bar as absent on the 2nd session. -### 👀Viewing attendance: `viewattendance` -Views the attendance list +> **Parameters:** +> * STUDENT_NAME - The name of the student. +> * SESSION - The session number. +> * PRESENCE - The attendance status of the student (e.g., present, absent). + +### 👀Viewing Attendance: `viewattendance` + +You can view the attendance list of your students. Format: `viewattendance n/STUDENT_NAME [MORE_STUDENT_NAMES]` -Parameters: -* STUDENT_NAME - The name of the student you want to view the attendance of. +> **Parameters:** +> * STUDENT_NAME - The name of the student you want to view the attendance of. Examples: * `viewattendance` Displays the overall attendance across all students and sessions. * `viewattendance n/Rayan` Displays all the sessions that Rayan has attended. * `viewattendance n/Jayson Resley` Displays all the sessions that Jayson and Resley have attended. -### 🔎Finding a Student: `find` -Finds a student’s profile +[//]: # (### 🔎Finding a Student: `find`) -Format: `find n/STUDENT_NAME [MORE_STUDENT_NAMES]` +[//]: # () +[//]: # (Finds a student’s profile) -Parameters: -* STUDENT_NAME - The name of the student you want to find. +[//]: # () +[//]: # (Format: `find n/STUDENT_NAME [MORE_STUDENT_NAMES]`) -Examples: -* `find n/John Doe` Finds and displays the profile of students with the name “John Doe”. -* `find n/Jane Doe` Finds and displays the profile of students with the name “Jane Doe”. +[//]: # () +[//]: # (Parameters:) -### 🥅Filtering results: `filter` -Filters the results displayed on the dashboard +[//]: # (* STUDENT_NAME - The name of the student you want to find.) -Format: -* `filter_add n/FILTER_ATTRIBUTE n/FILTER_DESCRIPTION` -* `filter_delete n/FILTER_ATTRIBUTE n/FILTER_DESCRIPTION` +[//]: # () +[//]: # (Examples:) -Parameters: -* `FILTER_ATTRIBUTE` - The filter type filter_studentScores - * `filter_studentScores` - * `filter_studentGrades` -* `FILTER_DESCRIPTION` - The conditions for the filter +[//]: # (* `find n/John Doe` Finds and displays the profile of students with the name “John Doe”.) -Examples: -* `filter_add n/filter_studentGrades n/A` Sets the dashboard to display students who have an “A” grade. -* `Filter_add n/filter_studentScores n/>80` Sets the dashboard to show students with test scores above 80. +[//]: # (* `find n/Jane Doe` Finds and displays the profile of students with the name “Jane Doe”.) + +[//]: # (### 🥅Filtering results: `filter`) -### 📝Adding a grade to an assignment: `addgrade` -Adds a grade to a student’s assignment. +[//]: # (Filters the results displayed on the dashboard) + +[//]: # () +[//]: # (Format:) + +[//]: # (* `filter_add n/FILTER_ATTRIBUTE n/FILTER_DESCRIPTION`) + +[//]: # (* `filter_delete n/FILTER_ATTRIBUTE n/FILTER_DESCRIPTION`) + +[//]: # () +[//]: # (Parameters:) + +[//]: # (* `FILTER_ATTRIBUTE` - The filter type filter_studentScores) + +[//]: # ( * `filter_studentScores`) + +[//]: # ( * `filter_studentGrades`) + +[//]: # (* `FILTER_DESCRIPTION` - The conditions for the filter) + +[//]: # () +[//]: # (Examples:) + +[//]: # (* `filter_add n/filter_studentGrades n/A` Sets the dashboard to display students who have an “A” grade.) + +[//]: # (* `Filter_add n/filter_studentScores n/>80` Sets the dashboard to show students with test scores above 80.) + +## Assignment Management + +### 📝Adding a Grade to an Assignment: `addgrade` + +You can add a grade to your student’s assignment. Format: `addgrade INDEX as/ASSIGNMENT g/GRADE` -Parameters: -* INDEX The index of the student. -* ASSIGNMENT The name of the assignment. -* GRADE The grade of the student. +> **Parameters:** +> * INDEX The index of the student. +> * ASSIGNMENT The name of the assignment. +> * GRADE The grade of the student. Examples: * `addgrade 1 as/Functional Expressionism g/1300` adds a grade of 1300 to student 1's Functional Expressionism assignment. * `addgrade 2 as/Rune Reading g/600` adds a grade of 600 to student 2's Rune Reading assignment. -### 👀Viewing an assignment grade: `viewgrade` -Shows a student’s assignment grade. +### 👀Viewing an Assignment Grade: `viewgrade` + +You can view your student’s assignment grade. Format: `viewgrade INDEX as/ASSIGNMENT` -Parameters: -* INDEX The index of the student. -* ASSIGNMENT The name of the assignment. +> **Parameters:** +> * INDEX The index of the student. +> * ASSIGNMENT The name of the assignment. Examples: * `viewgrade 1 as/Functional Expressionism` shows student 1's Functional Expressionism grade. * `viewgrade 2 as/Rune Reading` shows student 2's Rune Reading grade. -### 🛠️Editing an assignment grade: `editgrade` -Edits a student’s assignment grade. +### 🛠️Editing an Assignment Grade: `editgrade` + +You can edit your student’s assignment grade. Format: `editgrade INDEX as/ASSIGNMENT g/GRADE` -Parameters: -* INDEX The index of the student. -* ASSIGNMENT The name of the assignment. -* GRADE The score of the student. +> **Parameters:** +> * INDEX The index of the student. +> * ASSIGNMENT The name of the assignment. +> * GRADE The score of the student. Examples: * `editgrade 1 as/Functional Expressionism g/1200` edits the grade of student 1's Functional Expressionism assignment to 1200. * `editgrade 2 as/Rune Reading g/1000` edits the grade of student 2's Rune Reading assignment to 1000. -### ❌Deleting an assignment grade: `deletegrade` -Deletes a student’s assignment grade. +### ❌Deleting an Assignment Grade: `deletegrade` + +You can delete your student’s assignment grade. Format: `deletegrade INDEX as/ASSIGNMENT` -Parameters: -* INDEX The index of the student. -* ASSIGNMENT The name of the assignment. +> **Parameters:** +> * INDEX The index of the student. +> * ASSIGNMENT The name of the assignment. Examples: * `deletegrade 1 as/Functional Expressionism` deletes student 1's Functional Expressionism grade. * `deletegrade 2 as/Rune Reading` deletes student 2's Rune Reading grade. -### 📝Adding a comment to an assignment: `addcomment` -Adds a comment to a student’s assignment. +### 📝Adding a Comment to an Assignment: `addcomment` + +You can add a comment to your student’s assignment. Format: `addcomment n/STUDENT_NAME a/ASSIGNMENT c/COMMENT` -Parameters: -* STUDENT_NAME The name of the student. -* ASSIGNMENT The name of the assignment. -* COMMENT The comment. +> **Parameters:** +> * STUDENT_NAME The name of the student. +> * ASSIGNMENT The name of the assignment. +> * COMMENT The comment. Examples: * `addcomment n/Rayson a/Functional Expressionism c/Excellent` adds the comment “Excellent” on Rayson’s Functional Expressionism assignment. * `addcomment n/Wesley a/Rune Reading c/Not bad` adds the comment “Not bad” on Wesley’s Rune Reading assignment. -### 👀Viewing a comment: `viewcomment` -Shows the comment tagged to a student’s assignment. +### 👀Viewing an Assignment Comment: `viewcomment` + +You can view the comment(s) tagged to your student’s assignment. Format: `viewcomment n/STUDENT_NAME a/ASSIGNMENT` -Parameters: -* STUDENT_NAME The name of the student. -* ASSIGNMENT The name of the assignment. +> **Parameters:** +> * STUDENT_NAME The name of the student. +> * ASSIGNMENT The name of the assignment. Examples: * `viewcomment n/Rayson a/Functional Expressionism` shows the comment on Rayson’s Functional Expressionism assignment. * `viewcomment n/Wesley a/Rune Reading` shows the comment on Wesley’s Rune Reading assignment. -### 🛠️Editing a comment: `editcomment` -Edits the comment on a student’s assignment. +### 🛠️Editing an Assignment Comment: `editcomment` + +You can edit the comment of your student’s assignment. Format: `editcomment n/STUDENT_NAME a/ASSIGNMENT c/COMMENT` -Parameters: -* STUDENT_NAME The name of the student. -* ASSIGNMENT The name of the assignment. -* COMMENT The new comment. +> **Parameters:** +> * STUDENT_NAME The name of the student. +> * ASSIGNMENT The name of the assignment. +> * COMMENT The new comment. Examples: * `editcomment n/Rayson a/Functional Expressionism c/Decent` changes the comment on Rayson’s Functional Expressionism assignment to “Decent”. * `editcomment n/Wesley a/Rune Reading c/Great` changes the comment on Wesley’s Rune Reading assignment to “Great”. -### ❌Deleting a comment: `deletecomment` -Deletes the comment tagged to a student’s assignment. +### ❌Deleting an Assignment Comment: `deletecomment` + +You can delete the comment tagged to your student’s assignment. Format: `deletecomment n/STUDENT_NAME a/ASSIGNMENT` -Parameters: -* STUDENT_NAME The name of the student. -* ASSIGNMENT The name of the assignment. +> **Parameters:** +> * STUDENT_NAME The name of the student. +> * ASSIGNMENT The name of the assignment. Examples: * `deletecomment n/Rayson a/Functional Expressionism` deletes the comment on Rayson’s Functional Expressionism assignment. * `deletecomment n/Wesley a/Rune Reading` deletes the comment on Wesley’s Rune Reading assignment. +## Graded Test Management +### 🛠️Editing a Graded Test Score: `editgradedtest` + +You can edit your student’s graded test scores. + +Format: `editgrade INDEX ra1/READING_ASSESSMENT_1 ra2/READING_ASSESSMENT_2 mt/MIDTERMS f/FINALS pe/PRACTICALEXAM ` + +> **Parameters:** +> * 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. -### 📆Creating a Consult: `createconsult` -Creates a consultation into upcoming consultations. + +## Consultation Management + +### 📆Creating a Consultation: `createconsult` + +You can create a consultation for any upcoming consultations. Format: `createconsult d/DATE tt/TIME n/STUDENT_NAME n/STUDENT_NAME …` -Parameters: -* DATE The date of consultation -* TIME The time of consultation -* STUDENT_NAME The name of the student(s) +> **Parameters:** +> * DATE The date of consultation +> * TIME The time of consultation +> * STUDENT_NAME The name of the student(s) Examples: * `createconsult d/2023-10-30 tt/12:30 n/John Doe` creates a consultation for John Doe on 2023-10-30 12:30. -* `createconsult d/2023-09-30 tt/15:30 n/John Doe n/Foo Bar n/Rayson n/Wesley` creates a consultation for John Doe, -Foo Bar, Rayson and Wesley on 2023-09-30 15:30. +* `createconsult d/2023-09-30 tt/15:30 n/John Doe n/Foo Bar n/Rayson n/Wesley` creates a consultation for John Doe, Foo Bar, Rayson and Wesley on 2023-09-30 15:30. + +### 👀Showing a List of Consultations: `showconsults` -### 👀Showing list of consultations: `showconsults` -Shows the list of upcoming consultations. +You can view the list of all upcoming consultation(s). Format: `showconsults` Example: -* `showconsults` displays a list of upcoming consultations +* `showconsults` displays a list of upcoming consultation(s) -### 👀Viewing details of a consultation: `viewconsult` -Shows the details of a consultation. +### 👀Viewing the Details of a Consultation: `viewconsult` + +You can view the details of your consultation(s). Format: `viewconsult INDEX` -Parameters: -* INDEX The index of the consultation in the upcoming consultations. +> **Parameters:** +> * INDEX The index of the consultation in the upcoming consultation(s). Examples: * `viewconsult 1` shows the details of the consultation (if there is a consult scheduled). @@ -568,14 +636,15 @@ Examples: * `viewconsult -1`shows an error message “Consultation not found” (if there is no consult scheduled). -### 🛠️Adding students to a consultation: `addtoconsult` -Adds student(s) into a consultation. +### 🛠️Adding Students to a Consultation: `addtoconsult` + +You can add your student(s) into a consultation slot. Format: `addtoconsult INDEX n/STUDENT_NAME …` -Parameters: -* INDEX The index of the consultation in the upcoming consultations. -* STUDENT_NAME The name of student to be added into the consultation. +> **Parameters:** +> * INDEX The index of the consultation in the upcoming consultations. +> * STUDENT_NAME The name of student to be added into the consultation. Examples: * `addtoconsult 2 n/Foo Bar`. @@ -583,30 +652,32 @@ Examples: * `addtoconsult -1 n/Foo Bar`shows an error message. -### ❌Removing students from a consultation: `removefromconsult` -Removes student(s) from a consultation. +### ❌Removing Students from a Consultation: `removefromconsult` + +You can remove your student(s) from a consultation. Format: `removefromconsult INDEX n/STUDENT_NAME …` -Parameters: -* INDEX The index of the consultation in the upcoming consultations. -* STUDENT_NAME The name of student to be added into the consultation. +> **Parameters:** +> * INDEX The index of the consultation in the upcoming consultations. +> * STUDENT_NAME The name of student to be added into the consultation. Examples: * `removefromconsult 2 n/Foo Bar`. * `removefromconsult 1 n/NOTINCONSULT` shows an error message “Student not found”. -### ❌Deleting a consultation: `deleteconsult` -Deletes the consultation specified by the index. +### ❌Deleting a Consultation: `deleteconsult` + +You can delete the consultation slot specified by an index. Format: `deleteconsult INDEX` -Parameters: -* INDEX The index of the consultation in the upcoming consultations. +> **Parameters:**git +> * INDEX The index of the consultation in the upcoming consultations. Examples: -* `deleteconsult 1` deletes the first consultation. +* `deleteconsult 1` deletes the first consultation in the consultation list. * `deleteconsult -1` shows an error message “Consultation not found”. diff --git a/docs/_config.yml b/docs/_config.yml deleted file mode 100644 index 10e6731ad27..00000000000 --- a/docs/_config.yml +++ /dev/null @@ -1 +0,0 @@ -markdown: kramdown diff --git a/docs/_markbind/layouts/default.md b/docs/_markbind/layouts/default.md index 711f988dc1d..9c2da466242 100644 --- a/docs/_markbind/layouts/default.md +++ b/docs/_markbind/layouts/default.md @@ -50,6 +50,9 @@
{{ content }}
+