Merge pull request #261 from eyelessrhyme7/master

Update UG pages

build.gradle

@@ -66,7 +66,7 @@ dependencies {
 }
 
 shadowJar {
-    archiveFileName = 'profplan.jar'
+    archiveFileName = 'profplanv14.jar'
 }
 
 run {

docs/DeveloperGuide.md

@@ -13,14 +13,12 @@ title: Developer Guide
 * This project is built on top of the codebase of [AddressBook Level-3 (AB3)](https://github.com/se-edu/addressbook-level3).
 
 --------------------------------------------------------------------------------------------------------------------
-<div style="page-break-after: always;"></div>
 
 ## **Setting up, getting started**
 
 Refer to the guide [_Setting up and getting started_](SettingUp.md).
 
 --------------------------------------------------------------------------------------------------------------------
-<div style="page-break-after: always;"></div>
 
 ## **Design**
 
@@ -65,6 +63,8 @@ Each of the four main components (also shown in the diagram above),
 * defines its *API* in an `interface` with the same name as the Component.
 * implements its functionality using a concrete `{Component Name}Manager` class (which follows the corresponding API `interface` mentioned in the previous point).
 
+<div style="page-break-after: always;"></div>
+
 For example, the `Logic` component defines its API in the `Logic.java` interface and implements its functionality using the `LogicManager.java` class which follows the `Logic` interface. Other components interact with a given component through its interface rather than the concrete class (reason: to prevent outside component's being coupled to the implementation of a component), as illustrated in the (partial) class diagram below.
 
 <img src="images/ComponentManagers.png" width="300" />

docs/UserGuide.md

@@ -479,6 +479,8 @@ Tasks with unassigned recurrence will not recur.<br>
 **Valid format:** `recur/[recurrenceType]` <br>
 **Acceptable Parameter Values**: `recurrenceType`: Any of the following words, case-insensitive: `daily`, `weekly`, `monthly`, `semesterly`. Alternatively, any of the short-forms `d`, `w`, `m`, `s`, also case-insensitive.
 
+<div style="page-break-after: always;"></div>
+
 ### Management Commands
 
 ### Mark task as done / undone : `mark / unmark`
@@ -644,6 +646,8 @@ Grade assignments, Priority: 10, DueDate: 02-11-2023
 
 ![do_nextCommand](images/donextADV.png)
 
+<div style="page-break-after: always;"></div>
+
 ### Visualise important and urgent tasks :
 
 Sometimes, we might have 20, 30, 40 or more tasks in our lists!
@@ -658,6 +662,7 @@ The higher the urgency and the priority, the task will appear further towards th
 The task(s) in the top right of the matrix should be done first.
 ![img.png](matrix.png)
 
+<div style="page-break-after: always;"></div>
 
 ### Create A Recurring Task
 
@@ -667,7 +672,6 @@ Tasks with unassigned recurrence will not recur.<br>
 **Valid format:** `recur/[recurrenceType]` <br>
 **Acceptable Parameter Values**: `recurrenceType`: Any of the following words, case-insensitive: `daily`, `weekly`, `monthly`, `semesterly`. Alternatively, any of the short-forms `d`, `w`, `m`, `s`, also case-insensitive.
 
-
 ### Sort Tasks based on Priority :
 
 
@@ -681,6 +685,8 @@ Struggling to decide which task to tackle first in your busy schedule? Our 'Sort
 
 **Note:** ProfPlan will sort the tasks that is displayed in the UI at the time when the command is run.
 
+<div style="page-break-after: always;"></div>
+
 ### Sort Tasks based on DueDate:
 
 Overwhelmed by deadlines? The 'Sort by Due Date' function brings clarity to your schedule. It arranges your tasks starting with those that have the nearest deadlines. This ensures you never miss an important date and can methodically work through your tasks in a timely manner.
@@ -721,6 +727,7 @@ contains the data in the previous ProfPlan home folder.
 
 1. **When using multiple screens**, if you move the application to a secondary screen, and later switch to using only the primary screen, the GUI will open off-screen. The remedy is to delete the `preferences.json` file created by the application before running the application again.
 1. **When scrolling through Urgency-Priority Matrix**, if you scroll too quickly, the cells take some time to render and display the tasks.
+1. **After using filter command**, use `list` to list all tasks so that all operations are done on the correct index number. The filtered list doesn't revert back when doing next command, so user has to manually enter `list` to avoid any discrepancies.
 
 ---
 <div style="page-break-after: always;"></div>
@@ -737,6 +744,7 @@ contains the data in the previous ProfPlan home folder.
 | Recur (not editable)                    |       recur/        | The recurring type of the task |
 | Description (not editable through `edit`) |        des/         |    The description of the task |
 
+<div style="page-break-after: always;"></div>
 
 ## Command summary
 
@@ -757,6 +765,8 @@ contains the data in the previous ProfPlan home folder.
 | **Filter**        | `filter d/[duedate] s/[status]...`, e.g. `filter s/done p/4`                                                                                   |
 | **Help**          | `help`                                                                                                                                         |
 
+<div style="page-break-after: always;"></div>
+
 ## Supported Setting Parameters
 
 | **Parameter**    | **Description**                   | **Valid values**         | **Default value** |

src/main/java/profplan/model/util/SampleDataUtil.java

@@ -25,21 +25,21 @@ public static Task[] getSampleTasks() {
                     new Link("https://nus.edu.sg/nuslibraries/spaces/tel-imaginarium/services/3d-printing"),
                     new Description("Test blueprints and apply for 3D Printing machine access.")),
             new Task(new Name("Review Student Project Proposal"), new Priority("5"), false, null,
-                    getTagSet("student", "research"), new DueDate("04-11-2023"),
+                    getTagSet("student", "research"), new DueDate("30-11-2023"),
                     new Link("urop.com"), new Description("Review Raman's UROP Proposal.")),
             new Task(new Name("CS2100 Lecture"), new Priority("7"), true, Task.RecurringType.WEEKLY,
-                    getTagSet("course", "lecture"), new DueDate("07-11-2023"),
+                    getTagSet("course", "lecture"), new DueDate("21-11-2023"),
                     new Link("https://nus-sg.zoom.us/j/84615636187?pwd=RWRHc1hiTDlUaU54dUIrRVFiT2l2Zz09"),
                     new Description("9AM Lecture in COM1-Seminar Room")),
             new Task(new Name("Read Neural Network Paper"), new Priority("6"), false, null,
-                    getTagSet("reading", "research"), new DueDate("10-11-2023"),
+                    getTagSet("reading", "research"), new DueDate("25-11-2023"),
                     new Link("arivx.com/12366"), new Description("Read and review newly released paper on CNNs")),
             new Task(new Name("CS2106 Course Admin"), new Priority("5"), true, Task.RecurringType.WEEKLY,
-                    getTagSet("course", "admin"), new DueDate("10-11-2023"),
+                    getTagSet("course", "admin"), new DueDate("10-12-2023"),
                     new Link("https://blog.nus.edu.sg/cs2106/about/"),
                     new Description("Release Quiz 9 and Midterm Grades")),
             new Task(new Name("Grant Application"), new Priority("8"), false, null,
-                    getTagSet("grant", "research"), new DueDate("20-12-2023"),
+                    getTagSet("grant", "research"), new DueDate("20-07-2024"),
                     new Link("-"), new Description("NUS SOC Grant Application for DLD Project"))
         };
     }