Skip to content

Latest commit

 

History

History
808 lines (536 loc) · 26.4 KB

UserGuide.adoc

File metadata and controls

808 lines (536 loc) · 26.4 KB

NUSProductivity

By: Team W16-4 Since: Mar 2020 Licence: MIT

1. Introduction

1.1. An Introduction to NUSProductivity User guide

  • NUSProductivity is an application designed for all NUS students to better manage their school work. The app is set out to enhance your productivity in school through 5 main features, module planning, CAP (cumulative average point) tracking, note taking, deadline and task listing, and finally, diary logging. This app is designed only for NUS students for now with the possibility to customise it for students from other universities in the future. More importantly, NUSProductivity is optimized for those who prefer to work with a Command Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI). Read on to get you started on using the application!

  • The purpose of this document is for you to familiarise yourself with the functions and capabilities of what NUSProductivity can do.

  • The image below shows the different parts of the user interface of NUSProductivity

StartupDescription
Figure 1. NUSProductivity Introduction

1.2. Commonly Used Symbols

ℹ️
 This symbol indicates something you should take note of.
💡
 This symbol indicates a tip that you could use.
🔥
 This symbol indicates something need be used or followed with caution.
❗
 This symbol indicates something you really need to pay attention to.

2. Quick Start

This section allows you to start up NUSProductivity with ease. Detailed steps are listed below.

  1. Ensure you have Java 11 or above installed on your computer, if not you can refer to the guide below

  2. Windows Mac

  3. Download the latest version of NUSProductivity.jar here.

  4. Copy the file to the folder you want to use as the home folder for NUSProductivity.

  5. Double-click the file to start the app. The GUI should appear in a few seconds (screenshot of GUI shown below).

    Ui
    Figure 2. NUSProductivity Start up

  6. Type the command in the command box and press Enter to execute it.
    e.g. typing help and pressing Enter will open the help window.

  7. Some example commands you can try:

    • searchCS2103T : searches for the module CS2103T

    • calendar : Allows you to switch to the calendar tab

    • deadlineAdd desc/Finish homework by/30-04-2020 cat/School : schedules a deadline on the calendar for you to finish your homework

    • cap : calculates your CAP

    • exit : exits the app

  8. Refer to Section 3, “Features” for details of each command.

3. Features

This section shows the detailed list of usable commands.

Command Format

  • Words in UPPER_CASE are the parameters to be supplied by the user e.g. in add n/NAME, NAME is a parameter which can be used as add n/John Doe.

  • Items in square brackets are optional e.g n/NAME [t/TAG] can be used as n/John Doe t/friend or as n/John Doe.

  • Items with …​ after them can be used multiple times including zero times e.g. [t/TAG]…​ can be used as   (i.e. 0 times), t/friend, t/friend t/family etc.

  • Parameters can be in any order e.g. if the command specifies n/NAME p/PHONE_NUMBER, p/PHONE_NUMBER n/NAME is also acceptable.

3.1. General

3.1.1. Viewing help : help

  • Format: help

3.1.2. Exiting the program : exit

  • Exits the program.

  • Format: exit

3.1.3. Switching Tabs : calendar, diary, modplan, addressbook, notes, profile

  • This command allows you to switch to the tab using the command line instead of clicking on the respective tab.

  • Format: calendar, diary, modplan, addressbook, notes, profile

    switching tabs
    Figure 3. Switching tabs

3.2. Calendar

The calendar feature in the app that allows you to schedule and set deadline for important tasks such as project or assignment deadlines.

The application allows you to add 2 type of tasks, deadline and moduleTask.

moduleTask allows you to tag a module, that you have already inputted in your Profile tab, to the task itself. It allows you to set the priority level of the task.

deadline allows you to input a deadline event into the calendar without any specified modules attached to it.

3.2.1. Priority Levels

We give you the flexibility to choose and indicate what priority each moduleTask should have. This priority is represented from 1 to 5, with 1 being the lowest priority and 5 being the highest.

prioritylevels
Figure 4. NUSProductivity calendar priority levels

3.2.2. Deadline

Adding Deadline: deadlineAdd

  • Schedules a task tagged with a deadline to the calendar. A dot will be shown to indicate there is a deadline to be met on that day

  • Format: deadlineAdd desc/DESCRIPTION by/DD-MM-YYYY cat/CATEGORY

deadlineAdd
Figure 5. Adding Deadlines

After invoking the command, the deadline will be added to the calendar as shown in figure 5. The task will be tagged as light grey to signify it is uncompleted yet.

Deadline tasks are defaulty tagged with the lowest priority.

3.2.3. Module Tasks

Adding Module Tasks: moduleTask

  • Schedules a module task, this module task includes priority level, module that is associated with the task.

  • Format: moduleTask desc/DESCRIPTION m/MODULE_CODE date/DD-MM-YYYY pri/PRIORITY-LEVEL

moduleTaskAdd
Figure 6. Adding Module Tasks
ℹ️
 This requires you to add a module under moduleAdd before you can use it
moduleTaskAddError
Figure 7. Error when adding a module task without adding a module first.

3.2.4. Shared Functions

The commands stated in this section can be used for both moduleTask and deadline tasks.

Marking a task as Done: done

  • Marks a task as completed, completed task will be shown with a black background while uncompleted task will be shown as a grey background.

  • Format: done index/INDEX

taskDone
Figure 8. Completing a task

After a task is completed, it will be pushed to the bottom, the dot on the calendar removed and the background of the task is changed to black to signify the task is compelted.

Removing Deadline: taskDelete

  • Deletes a task from the deadline list, marking the task as done

  • Format: taskDelete index/INDEX

taskDelete
Figure 9. Deleting a task
💡
 Tip: delete a task only after the date have passed to make sure everything is completed up to your current date
Sorting the Calendar: sortTask

  • Allows you to sort the tasks list on the left by either date or priority. This gives you the flexibility to plan ahead, whether you want to complete a more urgent task or to complete a task with the deadline that is earlier

  • Format: sortTask by/SORT

taskSort
Figure 10. Sorting tasks by priority
ℹ️
 SORT can only be either date or priority
Finding specific tasks in the Calendar: findTask

  • Allows you to see task at a glance based on what you specified.

  • Format: findTask m/MODULECODE or findTask cat/CATEGORY or findTask date/DD-MM-YYYY

findTask
Figure 11. Finding task by module Code
ℹ️
 The dots on the calendar will not disappear and will show that there is still task to be completed on that date despite filtering
Listing back all tasks in the Calendar: listTask

  • Allows you to list back all task after you have filtered the list with findTask

  • Format: listTask

listTask
Figure 12. Listing all tasks

3.3. Notes

  • Allows you to create notes from the application, making it easier for you to find your files since often time students have a lot of research papers or references opened when writing a report.

  • Allows for users to create documents for notes, organise their notes in folders. Default location is set to /User/<ACCOUNT NAME> for mac C:\Users\<ACCOUNT NAME> for windows

3.3.1. Pathing

  • The notes feature allows you to specify the pathing used to access the file/folder you specify

  • The diagram below shows a comparision between absolute vs relative pathing

pathing
Figure 13. Pathing Absolute vs Rel
💡
 if you want to access the Documents folder as shown in figure 13, you can use the absolute pathing and specify loc/Desktop instead of typing loc/../../../Documents

3.3.2. Listing Directory: notesList

  • List the directory that you supplied. The display will show all folders that is in that directory.

  • Format: notesList loc/PATH pt/PATH TYPE

notesListingUG
Figure 14. Listing files in directory

3.3.3. Creating a note: notesCreate

  • Creates a file/directory based on what you specified.

  • Format: notesCreate loc/PATH name/FILE_NAME type/TYPE pt/PATH_TYPE

ℹ️
 The type can only be file or folder
notesCreateUG
Figure 15. Creating a file in a specified directory

3.3.4. Opening a note: notesOpen

  • Opens a file/directory based on what you specified.

  • Format: notesOpen loc/PATH name/FILE_NAME pt/PATH_TYPE

notesOpenUG
Figure 16. Opening a file in a specified directory

3.3.5. Deleting a note: notesDelete

  • Delete a file based on what you specified.

  • Format: notesDelete loc/PATH name/FILE_NAME pt/PATH_TYPE

notesDeleteUG
Figure 17. Deleting a file in a specified directory
ℹ️
 This can only be use to delete a file and not a folder

3.4. Address Book

The address book allows you to add other individuals, such as professors and fellow classmates to your addressbook. Information such as phone number and email of the person will be saved into the address book for easier communication for projects or to schedule consultation relating to the module.

3.4.1. Adding a person: add

  • Adds a person to the address book.

  • Format: add n/NAME p/PHONE_NUMBER e/EMAIL [t/TAG]…​

💡
 A person can have any number of tags (including 0)

3.4.2. Listing all persons : list

  • Shows a list of all persons in the address book.

  • Format: list

3.4.3. Editing a person : edit

  • Edits an existing person in the address book.

  • Format: contactEdit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [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.

  • Examples:

    • edit 1 p/91234567 e/[email protected]
      Edits the phone number and email address of the 1st person to be 91234567 and [email protected] respectively.

    • edit 2 n/Betsy Crower t/
      Edits the name of the 2nd person to be Betsy Crower and clears all existing tags.

3.4.4. Locating persons by name: find

  • Finds persons whose names contain any of the given keywords.

  • Format: find KEYWORD [MORE_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

  • After a find operation, use list to get back the original list for address book.

  • Examples:

    • find John
      Returns john and John Doe

    • find Betsy Tim John
      Returns any person having names Betsy, Tim, or John

3.4.5. Deleting a person : delete

  • Deletes the specified person from the address book.

  • Format: delete INDEX

  • 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, …

  • Examples:

    • list
      delete 2
      Deletes the 2nd person in the address book.

    • find Betsy
      delete 1
      Deletes the 1st person in the results of the find command.

3.4.6. Clearing all entries : clear

  • Clears all entries from the address book.

  • Format: clear

3.5. Profile / Module Book (Part 1: Manage your modules)

  • This feature allows individuals to see their own profile, their current cap and the all modules that the individual have taken and all the grades gotten.

ProfileMainScreen
Figure 18. Main Screen for profile tab

3.5.1. Adding a module : moduleAdd

  • Adds a module you have taken before or is taking now and store your grade for each module if you want.

  • Format: moduleAdd m/MODULE_CODE [g/GRADE]

💡
 The grade field is optional. You can state your grade when you add in modules and also can update or add in your grade later.

  • You can only add in modules which are valid modules that can be taken in NUS.

  • All other module codes inputted will be considered as invalid and the program will not allow you to add in.

  • This requirement is not case sensitive, which means for example, both "CS2103" and "cs2103" are considered valid module code.

💡
 The program checks whether a module code provided is valid or not by using the search function in module planning feature, which fetch information about modules online. If the search function fails to fetch any information, the module code will be treated as invalid.

  • Example:

    • moduleAdd m/CS2103

    • moduleAdd m/cs1101s g/A

AddModule
Figure 19. Adding a module

3.5.2. Deleting a module : moduleDel

  • Deletes a module you have added to the program before from the profile tab.

  • Format: moduleDel MODULE_CODE

  • Deletes the module specified from the module book (profile)

  • You can only delete the module which you have added into the program before.

  • Module code inputted is not case sensitive ('moduleDel cs2103' is the same as 'moduleDel CS2103')

  • Example:

    • moduleDel CS2103
      Delete CS2103 from module book if you have added it before.

DeleteModule
Figure 20. Deleting a module

3.5.3. Editing the grade of a module : grade

  • Updates or adds the grade of certain modules you have added to the program.

  • Format: grade m/MODULE_CODE g/GRADE

  • Updates the grade of the specified module as the grade you provided now.

  • You can only update the grade of module which you have added into the program before.

  • Grade inputted should be a valid grade in NUS’s grading system.

  • Both module code and grade inputted is not case sensitive.

💡
 List of all valid grade: A+, A, A-, B+, B, B-, C+, C, D+, D, F, S and U.

  • Example:

    • grade m/CS1101S g/S

    • grade m/CS2103 g/A

Grade
Figure 21. Updating the grade of a module

3.5.4. View current CAP : cap

  • Shows your current cap based on the grades of modules you have stated.

  • Format: cap

  • Calculates your current CAP.

  • CAP = Sum (module grade point x modular credits for the module) / Sum (modular credits)

  • The calculation strictly follow the grading system of NUS.

  • Shows current CAP in in result display panel, CAP on UI will only get updated after you restart.

💡
 You don’t need to indicate the modular credits for each module when you add it in because the program will fetch that infomation online.
Cap
Figure 22. View current CAP

3.6. Profile / Module Book (Part 2: Manage your tasks separately for each module)

Most of the functionality here has been integrate into the Calendar feature but these commands left here still can be used. You can give it a try if you want.

ℹ️
 These tasks related to certain module are called 'module task' from now on.
💡
 All commands that make changes to the module tasks will be synchronous for both module book and the task list in calendar feature.
❗
 For this part, the UI hasn’t been implemented yet but you are able to see the updated list of module tasks in command line.
❗
 Most functionality covered in this part can also be achieved by some commands in Calendar feature above. Just provides users with an alternative way. (The orders of tasks shown are different. Thus, the index inputted may be different to achieve the same modification.)

3.6.1. Creating a module task : moduleTask

ℹ️
 This command has been covered in Calendar feature already.

  • Adds a module task related to certain module you have added before in module book.

  • You need to indicate which module the task is related to, its priority level (how important it is) and also its deadline or scheduled timing.

  • Format: moduleTask desc/DESCRIPTION m/MODULE_CODE date/DEADLINE_OR_SCHEDULED_TIMING pri/PRIORITY

🔥
 The date inputted should be in the format: DD-MM-YYYY.

  • This command allows you to create tasks to certain module you added to the program before.

  • Stores the task added in the module book and automatically adds and shows on the Calender.

  • You will get an updated list of tasks related to that specific module after adding. (shown in command line)

  • Example:

    • moduleTask desc/essay m/CS2101 date/02-04-2020 pri/3
      Add a module task as specified in module book and also shows on calendar.

ModuleTaskProfile
Figure 23. Adding a module task for certain module
ModuleTaskCalendar
Figure 24. module task added will also be shown on calendar

3.6.2. Listing all module tasks of certain module

💡
 You can also view module tasks in calendar using findModule m/MODULE_CODE

  • Lists all module tasks related to the specific module.

  • Format: listModuleTasks MODULE_CODE

  • Lists all module tasks related to that module in in result display panel.

  • Module code inputted must be valid module code you have added in before.

  • Example:

    • listModuleTasks CS2103
      Lists all module tasks of CS2103.

ListModuleTask
Figure 25. Showing all module tasks related to specified module

3.6.3. Deleting a module task : taskDelete

  • Deletes the specified module tasks for certain module from the module book and calendar.

  • Format: taskDelete m/MODULE_CODE index/INDEX

ℹ️
 This command is similar to the taskDelete command in Calendar feature but you need to specify the module code.

  • Deletes the module task at the specified INDEX.

  • The index refers to the index number shown in result display panel (you can get that by entering 'listModuleTasks MODULE_CODE')

  • The index must be a positive integer 1, 2, 3, …

🔥
 Only refer to the index of tasks shown in command line when performing this command. (not the one in calendar)

  • Example:

    • taskDelete m/CS2103 index/1
      Deletes the first module task for CS2103 in module book and Calendar.
      (First task in module book and may not be the first in Calendar even after performing findTask m/cs2103)

TaskDeleteWirhModuleCode
Figure 26. Deleting a module task

3.6.4. Marking a module task as done : done

  • Marks the specified module tasks for certain module as done in the module book and calendar.

  • Format: done m/MODULE_CODE index/Index

ℹ️
 This command is similar to the done command in Calendar feature but you need to specify the module code.

  • Deletes the module task at the specified INDEX.

  • The index refers to the index number shown in the in result display panel (you can get that by entering 'listModuleTasks MODULE_CODE')

  • The index must be a positive integer 1, 2, 3, …

🔥
 Only refer to the index of tasks shown in result display panel when performing this command. (not the one in calendar)

  • Example:

    • done m/cs2103 index/1
      Marks the first module task for module cs2103 as done.

DoneWithModuleCode
Figure 27. Marking a module task as done
❗
 Clarification for taskDelete and done commands.
If you did not provide specific module code in the command, the index required refers to the index of list of tasks shown in calendar tab. Otherwise, it refers to the index of list of module tasks shown in the result display panel.
For example:
taskDelete m/cs2103 index/1 will delete the first task as shown in Figure 26
taskDelete index/1 will delete the first task shown in the task list in calendar tab.

3.6.5. View task breakdown per module : taskBreakdown

  • Shows the how many tasks are there in total and how many tasks haven’t been completed yet for each module.

  • Format: taskBreakdown

TaskBreakDown
Figure 28. Show task breakdown

3.6.6. States major taken : major (coming in v2.0)

3.7. Module planning

3.7.1. View module requirement: modreq (coming in v2.0)

  • Shows the modules requirement for the major specified. This function will show the core modules that the individual have to take before graduation but have not taken yet.

  • Format: modreq MAJOR

  • Example:

    • modreq computer science

3.7.2. Module information: search

  • Shows basic information about the module, such as time of lecture, tutorial, exam venues and professor’s contact associated with the module.

  • Format: search MODULE_CODE

  • Example:

    • search CS2103T

3.8. Diary

The diary feature allows you to jot down any thoughts, be it for your personal life or for school work, or just a concept that you may not understand that you will have to revisit in the future.

3.8.1. Adding an diary entry: diaryAdd

  • Adds a diary entry to the diary book.

  • Format: diaryAdd ec/ENTRY_CONTENT

3.8.2. Viewing diary logs: diaryLog

  • Shows all diary entry IDs.

  • Format: `diaryLog `

3.8.3. Viewing diary entries with specified entry ID: diaryShow

  • Shows the diary entry for the specified entry ID.

  • Format: diaryShow id/ENTRY_ID

3.8.4. Viewing diary entries with specified date: diaryShow

  • Shows the diary entry at the specified date if there is any, date needs to be in DD-MM-YYYY.

  • Format: diaryShow date/DATE

3.8.5. Deleting an diary entry: diaryDelete

  • Deletes the specified diary ID’s entry.

  • Format: diaryDelete id/ENTRY_ID

3.8.6. Tagging weather: diaryWeather

  • Tags the diary with the specific ID with a specific weather (e.g. sunny, cloudy)

  • Format: diaryWeather id/ENTRY_ID w/WEATHER

3.8.7. Tagging mood: diaryMood

  • Tags the diary with the specific ID with a specific mood (e.g. happy, stressed)

  • Format: diaryMood id/ENTRY_ID m/MOOD

4. Command Summary

This section summarizes the list of commands.

  • General:

    • calendar: calendar

    • notes: notes

    • modplan: modplan

    • diary: diary

    • profile: profile

    • help: help

    • exit: exit

  • Calendar:

    • deadline : deadlineAdd desc/DESCRIPTION by/DD-MM-YYYY cat/CATEGORY e.g. deadlineAdd desc/Do Chores by/30-04-2020 cat/Misc

    • moduleTask: moduleTask desc/DESCRIPTION m/MODULE CODE date/DD-MM-YYYY pri/PRIORITY e.g. moduleTask desc/Project Deadline date/30-04-2020 m/CS2103T pri/5

    • done: done index/INDEX e.g. done index/1

    • taskDelete: taskDelete index/INDEX e.g. taskDelete index/1

    • sortTask: sortTask by/SORTING_PARAM e.g. sortTask by/priority

    • findTask: findTask m/MODULECODE or findTask cat/CATEGORY or findTask date/DD-MM-YYYY e.g. findTask m/CS2103T

    • listTask: listTask e.g. listTask

  • Notes

    • notesList loc/PATH pt/PATH TYPE e.g. notesList loc/Desktop pt/abs

    • notesOpen loc/PATH name/FILE_NAME pt/PATH_TYPE e.g. notesOpen loc/Desktop name/test.doc pt/abs

    • notesCreate loc/PATH name/FILE_NAME type/TYPE pt/PATH_TYPE e.g. notesCreate loc/Desktop/ name/Test.doc type/file pt/abs

    • notesDelete loc/PATH name/FILE_NAME pt/PATH_TYPE e.g. notesDelete loc/Desktop/ name/Test.doc pt/abs

  • Address Book:

    • add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]…
      e.g. add n/James Ho p/22224444 e/[email protected] t/friend t/colleague

    • clear : clear

    • delete : delete INDEX
      e.g. delete 3

    • edit : edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [t/TAG]…
      e.g. edit 2 n/James Lee e/[email protected]

    • find : find KEYWORD [MORE_KEYWORDS]
      e.g. find James Jake

    • list: list

  • Profile (Module Book)

    • moduleAdd m/MODULE_CODE [g/GRADE]
      e.g. moduleAdd m/cs2103 g/A

    • moduleDel*MODULE_CODE
      e.g. moduleDel CS2103

    • grade m/MODULE_CODE g/GRADE
      e.g. grade m/cs2103 g/A

    • cap

    • moduleTask desc/DESCRIPTION m/MODULE CODE date/DD-MM-YYYY pri/PRIORITY
      e.g. moduleTask desc/Project m/CS2103T date/30-04-2020 pri/5

    • taskDelete m/MODULE_CODE index/INDEX e.g. taskDelete m/cs2103 index/1

    • done m/MODULE_CODE index/INDEX e.g. done m/cs2103 index/1

    • listModuleTasks m/MODULE_CODE e.g. listModuleTasks m/CS2103

    • taskBreakdown

  • Diary :

    • diary log LIMIT e.g. diary log 10

    • diary show ENTRY ID e.g. diary show 3

    • diary show DD-MM-YYYY e.g. diary show 30-03-2020

    • diary add ENTRY e.g. diary add "Today is a good day"

    • diary delete ENTRY ID e.g. diary delete 1

    • diary weather ID WEATHER e.g. diary weather 1 SUNNY

    • diary emotion ID EMOTION e.g. diary emotion 1 HAPPY

  • Mod Plan:

    • search MODULE_CODE
      e.g. search CS2103T

    • mymodplan: mymodplan (coming in v2.0)

    • mymodplan add MODULE CODE e.g. mymodplan add CS2103T (coming in v2.0)

    • mymodplan done MODULE CODE e.g. mymodplan done CS2103T (coming in v2.0)

    • modreq : modreq {\MAJOR} + (coming in v2.0) e.g. modreq computer science

5. Glossary

  • NUS : National University of Singapore

  • CAP : The Cumulative Average Point is the weighted average grade point of the letter grades of all the modules taken by the students, according to NUS’s grading system.

  • CLI : Command Line Interface

6. FAQ

Q: How do I transfer my data to another Computer?
A: Install the app in the other computer and overwrite the empty data file it creates with the file that contains the data of your previous fitness log book folder.

Q: How do I save my data in my own PC?
A: NusProductivity saves your data of all your modules, grades and tasks after you make changes.