Merge branch 'master' into developerguide

README.adoc

@@ -2,10 +2,9 @@
 ifdef::env-github,env-browser[:relfileprefix: docs/]
 
 https://travis-ci.org/AY1920S2-CS2103T-W17-4/main[image:https://travis-ci.org/AY1920S2-CS2103T-W17-4/main.svg?branch=master[Build Status]]
-https://ci.appveyor.com/project/damithc/addressbook-level3[image:https://ci.appveyor.com/api/projects/status/3boko2x2vr5cc3w2?svg=true[Build status]]
+https://ci.appveyor.com/project/PotatoCombat/main[image:https://ci.appveyor.com/api/projects/status/hj9hoqnof01ge3pp/branch/master?svg=true[Build status]]
 https://coveralls.io/github/AY1920S2-CS2103T-W17-4/main?branch=master[image:https://coveralls.io/repos/github/AY1920S2-CS2103T-W17-4/main/badge.svg?branch=master[Coverage Status]]
 
-
 ifdef::env-github[]
 image::docs/images/Ui.png[width="600"]
 endif::[]

docs/ContactUs.adoc

@@ -2,6 +2,20 @@
 :site-section: ContactUs
 :stylesDir: stylesheets
 
-* *Bug reports, Suggestions* : Post in our https://github.com/se-edu/addressbook-level3/issues[issue tracker] if you noticed bugs or have suggestions on how to improve.
-* *Contributing* : We welcome pull requests. Follow the process described https://github.com/oss-generic/process[here]
-* *Email us* : You can also reach us at `damith [at] comp.nus.edu.sg`
+== Bug reports, Suggestions
+
+Post in our https://github.com/AY1920S2-CS2103T-W17-4/main/issues[issue tracker] if you noticed bugs or have suggestions on how to improve.
+
+== Email us
+
+You can also reach us at the following emails: +
+Aakanksha Rai: +
+`rai.aakanksha [at] gmail.com` +
+Chua Yi Jing: +
+`yijing.chua [at] gmail.com` +
+Fatin Nabilah Bte Suhaimi: +
+`fatinnbs [at] gmail.com` +
+Gabriel Benedict Teo Jian Cheng: +
+`gtforce [at] gmail.com` +
+Huang Haoyi: +
+`samuel.huanghaoyi [at] gmail.com`

docs/DeveloperGuide.adoc

@@ -301,18 +301,94 @@ Priorities: High (must have) - `* * \*`, Medium (nice to have) - `* \*`, Low (un
 |Priority |As a ... |I want to ... |So that I can...
 |`* * *` |new user |see usage instructions |refer to instructions when I forget how to use the App
 
-|`* * *` |user |add a new person |
+|`* * *` |TA |see an overview of events in a week |know what I have that week in a glance
 
-|`* * *` |user |delete a person |remove entries that I no longer need
+|`* *` |TA |give students ratings |keep a track of student participation in class
 
-|`* * *` |user |find a person by name |locate details of persons without having to go through the entire list
+|`* *` |TA |delete tasks and events |remove cancelled tasks and events from my session tracker
 
-|`* *` |user |hide <<private-contact-detail,private contact details>> by default |minimize chance of someone else seeing them by accident
+|`*` |TA |get a message when a new task clashes with an old one |prevent clashes in my schedule
+
+|`* * *` |TA |store and retrieve details of my students |I can get details relating to students whenever necessary
+
+|`* *` |TA |be able to get tasks on a particular date |
+
+|`* *` |TA |filter by a module |see events relating to a particular module clearly
+
+|`*` |TA |state that a task is recurring |prevent the need to put a recurring task in my schedule each week
+
+|`* * *` |TA |see all my claimable hours in the TSS format |type my claims easily at the end of the semester
+
+|`* * *` |TA |set my hourly rate |get the value of my estimated pay according to the latest rate of the semester
+
+|`* *` |TA |get information on how many hours I've worked so far |keep track of how much work I've done
+
+|`* * *` |user |change between the different pages |view the information on the different pages
+
+|`* * *` |TA |add students to a particular module |
+
+|`* *` |TA |store my students' email ids |retrieve their email ids when I need to contact them
+
+|`* * *` |TA |add multiple modules |keep track of the different modules I am a TA for
+
+|`* * *` |TA |add a tutorial/lab group |keep track of the different tutorial and lab groups I conduct
+
+|`* *` |TA |delete a tutorial group |remove tasks relating to a tutorial group I am no longer the TA of
+
+|`* *` |TA |delete a module |remove tasks relating to a module I am no longer the TA of
+
+|`* * *` |TA |edit student details |
+
+|`* * *` |TA |remove students from a tutorial or lab group |no longer have details of students that are no longer in my tutorial/lab group
+
+|`* * *` |TA |mark a session as done |automatically get filled in my TSS claim section.
+
+|`* *` |TA |give students ratings |keep a track of student participation in class
+
+|`* *` |TA |delete tasks and events |remove cancelled tasks and events from my session tracker
+
+|`* * *` |TA |schedule consultation sessions with my students |keep track of claimable hours spent in consultations
+
+|`*` |TA |get a message when a new task clashes with an old one |prevent clashes in my schedule
+
+|`* * *` |TA |store and retrieve details of my students |I can get details relating to students whenever necessary
+
+|`* *` |TA |be able to get tasks on a particular date |
+
+|`* *` |TA |filter by a module |see events relating to a particular module clearly
+
+|`*` |TA |state that a task is recurring |prevent the need to put a recurring task in my schedule each week
+
+|`* * *` |TA |see all my claimable hours in the TSS format |type my claims easily at the end of the semester
+
+|`* * *` |TA |set my hourly rate |get the value of my estimated pay according to the latest rate of the semester
+
+|`* *` |TA |get information on how many hours I've worked so far |keep track of how much work I've done
+
+|`* * *` |user |change between the different pages |view the information on the different pages
+
+|`* * *` |TA |add students to a particular module |
+
+|`* *` |TA |store my students' email ids |retrieve their email ids when I need to contact them
+
+|`* * *` |TA |add multiple modules |keep track of the different modules I am a TA for
+
+|`* * *` |TA |add a tutorial/lab group |keep track of the different tutorial and lab groups I conduct
+
+|`* *` |TA |delete a tutorial group |remove tasks relating to a tutorial group I am no longer the TA of
+
+|`* *` |TA |delete a module |remove tasks relating to a module I am no longer the TA of
+
+|`* * *` |TA |edit student details |
+
+|`* * *` |TA |remove students from a tutorial or lab group |no longer have details of students that are no longer in my tutorial/lab group
+
+|`* * *` |TA |mark a session as done |automatically get filled in my TSS claim section.
+
+|`*` |user |change the default view of the application |
 
-|`*` |user with many persons in the address book |sort persons by name |locate a person easily
 |=======================================================================
 
-_{More to be added}_
 
 [appendix]
 == Use Cases

docs/UserGuide.adoc

@@ -36,10 +36,10 @@ e.g. typing *`help`* and pressing kbd:[Enter] will open the help window.
 
 A brief overview of the layout of the TATracker.
 
-====
+[[Features]]
+==Features
 
 === Dashboard
-
 Home page.
 
 === Student View
@@ -58,6 +58,7 @@ This view will contain the upcoming tasks and statistics.
 This will show you all your claimable hours up till now in the same format as that
 used in the TSS claim files.
 
+
 === Automatic Backups
 
 TATracker data is automatically saved in the hard disk as backup files after any
@@ -103,6 +104,101 @@ automatically loaded into the program when it is opened.
 * START, END - a time parameter, in the following format: HH:mm
 * DATE - a date parameter, in the following format: dd-MM-yyyy
 
+=== Student Management
+
+==== Enrolling a student in a class : `enroll`
+
+Enrolls a student in a class in the program. +
+
+Format: `enroll MATRIC_NUMBER CLASS_CODE MOD_CODE'
+
+****
+* Enrolls the person with the given matriculation number in the class given by the class code of the module given by the module code.
+****
+
+Examples:
+
+* `enroll A01234567J G06 CS2101` +
+Enrolls the student with the matriculation number A01234567J in tutorial G06 of module CS2101.
+
+==== Removing a student from a class : `kick`
+
+Removes a student from a class in the program. +
+Format: `kick MATRIC_NUMBER CLASS_CODE MOD_CODE`
+
+****
+* Removes the person with the given matriculation number from the class given by the class code of the module given by the module code.
+
+Examples:
+
+* `kick A01234567J G06 CS2101` +
+Removes the student with the matriculation number A01234567J from tutorial G06 of module CS2101.
+
+=== Session Management
+
+==== Labelling a session as completed : `done`
+
+Labels a session as done. If the session is claimable, it will appear as
+a new claim in the TSS view.+
+Format: `done SESSION_UID'
+
+****
+* Marks the session with the given unique session identifier as done.
+****
+
+Example:
+
+* `done 25` +
+Marks the session with the unique session id of 25 as done.
+
+==== Labeling a session as a makeup : `makeup`
+
+Labels a session as a makeup session. If the session is claimable, it will appear
+ as a new claim in the TSS view.+
+Format: `makeup SESSION_UID`
+
+****
+* Marks the session with the given unique session identifier as a makeup.
+****
+
+Examples:
+
+* `makeup 25` +
+Marks the session with the unique session id of 25 as a makeup.
+
+=== Settings
+
+==== Adjusting the settings : `set`
+
+Adjusts the chosen settings. +
+Format: `set SETTING`
+
+Here are the things that you can set:
+
+* rate: * Adjusts the hourly rate. +
+Sets the hourly rate for the total income and claim computation.
+
+Format: `set rate AMOUNT`
+* AMOUNT is the amount you want to change the hourly rate to.
+* To specify in exact dollars, you can write it as just the number (example: 20).
+* To specify in exact dollars and cents, write it as a decimal up to 2 decimal places (example: 20.05).
+
+Examples:
+
+* `set rate 25` +
+Sets the current hourly rate to 25$.
+
+*default:* Adjusts the default layout +
+Change the default view shown when the GUI is first opened.
+
+Format: `set default PAGE_NAME`
+
+Examples:
+
+* `set default sessions` +
+Sets the default view to be the list of sessions every time you open the GUI.
+
+
 == FAQ
 
 *Q*: How do I transfer my data to another Computer? +