User Guide

• 1. Introduction
• 2. About this User Guide
• 3. How to user this User Guide
• 4. Quick Start
• 5. Initialisation
• 6. Commands
  • Command Format
  • Category Types
  • Help: help
  • PLAN component of Plan&Score
    • Set Recommended Hours set hours
    • Class Category
      • Add a class: add class
      • Delete a class: delete class
    • Cca Category
      • Add a cca: add cca
      • Delete a cca: delete cca
    • Test Category
      • Add a test: add test
      • Delete a test: delete test
    • Tuition Category
      • Add a tuition: add tuition
      • Delete a tuition: delete tuition
    • List schedule: list event <today/[date]/week/nextweek>
    • Find event: find event
  • SCORE component of Plan&Score:
    • Take a quiz:quiz
    • Add a quiz question: add quiz
    • Delete a quiz question: delete quiz
    • List quiz questions: list quiz
    • Find a quiz by keyword: find quiz
    • Search for former incorrect quiz questions: quiz record
  • Contact component of Plan&Score:
    • Add a contact: add contact
    • Delete a contact: delete contact
    • List a contact: list contact
    • Find a contact: find contact
  • Exit the program: bye
• 7. Saving Data
• 8. FAQ
• 9. Troubleshooting
• 10. Command Summary

Introduction (Chan Wan Ting Elizabeth)

Plan&Score is an application consisting of 2 key components:

• Event scheduler
• Quiz component

and a sub-component:

• Contact list

These components aim to tackle the issue of poor planning and revision most Primary 6 students in Singapore face.

This application uses a command line interface, meaning that you operate the application by typing commands into a Command Box.

Figure 1. The graphical user interface for Plan&Score

About this User Guide (Chan Xu Hui)

This User Guide serves to provide an in-depth explanation of Plan&Score’s usage and functionalities, as well as troubleshooting steps you can take if problems are encountered.

How to use this User Guide (Andre Wong Zhi Hua)

To navigate to the contents of your desired feature, simply click on the hyperlinks provided in the contents page above.

The highlights and symbols used in this document are as follows:

Add class A grey highlight is used to denote text to be entered into the
command line.

Quick Start (Chan Xu Hui)

1. Ensure that you have Java 11 or above installed.
2. Download the latest version of Plan&Score from here.
3. Run the program by entering java -jar \[CS2113T-W12-4\]\[\ Plan\&Score\].jar in your terminal.
4. You can exit the program by running bye.

Initialisation (Alicia Ho Shimin)

When you first open Plan&Score, you will be greeted by a welcome message as well as a prompt asking for your name. This is as shown below.

Type in your name and press ‘Enter’ to proceed.

Afterwards, you will be prompted to enter the number of recommended hours that you wish to accomplish per day. Key in your desired number of hours and press ‘Enter’ to proceed.

This is the end of the initialisation process. You can now enjoy the rest of Plan&Score’s amazing features!

Commands

Command Format

• A command can contain multiple parameters.
  • A test contains a description, start and end, where description, start and end are parameters that make up a test.
• Command parameters cannot be swapped.
  • add test /n [name of test] /s [start date-time of test] /e [end date-time of test] will work but add test /s [start date-time of test] /e [end date-time of test] /n [name of test] will give an error
• Extra spaces in the command will be sanitized.
  • list event will be sanitized to list event
• Command will be converted as lowercase.
  • LIST EVENT will be modified to list event
• Commands with extra parameters provided will give an error
  • delete class 1 2 3 abc will be give an error.

Category Types (Chan Wan Ting Elizabeth)

• Plan&Score has the following categories types:

  1. event
     1. class
     2. cca
     3. test
     4. tuition
  2. contact
  3. quiz

• The category type often follows after the command word (E.g class follows after add to form add class).

Viewing help: help (Chan Wan Ting Elizabeth)

Shows all available commands that you can use

Firstly, type help in the command line as seen below, and press ‘Enter’ to execute it.

The output containing all the different commands is seen in the console.

Plan component of Plan&Score

It allows you to plan and track the following category types:

• Class
• Cca
• Test
• Tuition

Set Recommended Hours: set hours (Alicia Ho Shimin)

Allows you to change the number of recommended hours you would want to have per day.

Firstly, type set hours in the command line as seen below. Press ‘Enter’ to execute it.

Afterwards, Plan&Score will prompt you to enter the number of recommended hours that you wish to accomplish per day.

Key in your new desired number of hours and press ‘Enter’ to proceed. The output is then seen in the console as shown below.

WARNING:

• [number of hours] must be written in numerals.

Category: Class (Chan Wan Ting Elizabeth)

Adding a class: add class

Allows you to add a new class with a name, date and time.

Firstly, type add in the command line as seen below, followed by the category type which is the class. Afterwards, key in the description of the class as well as its start and end date and time. Press ‘Enter’ to execute it.

The output is seen in the console. The date and time is converted to a more readable form, enabling you to read it more pleasantly.

WARNING:

• [name of class] can be in a natural language format and cannot contain ‘/’.

• [start date-time of class] and [end date-time of class] must be in yyyy-mm-dd HHMM format with HHMM in 24-hour format.

• Parameters /n, /s, /e cannot be swapped.

Deleting a class: delete class

Allows you to delete a class based on its index in the list.

Firstly, type ‘delete’ in the command line as seen below, followed by the category type which is the class. Afterwards, key in the corresponding index of the class you would like to delete. Press ‘Enter’ to execute it.

The output is seen in the console. The date and time is converted to a more readable form, enabling you to read it more pleasantly.

WARNING:

• [class number] must be written in numerals.

Category: Cca (Chen Jinran)

Adding a cca: add cca

Allow you to add a new cca with a name, date and time.

Firstly, type add in the command line as seen below, followed by the category type which is the cca. Afterwards, key in the description of the cca as well as its start and end date and time. Press ‘Enter’ to execute it.

The output is seen in the console. The date and time is converted to a more readable form, enabling you to read it more pleasantly.

WARNING:

• [name of cca] can be in a natural language format and cannot contain ‘/’.

• [start date-time of cca] and [end date-time of cca] must be in yyyy-mm-dd HHMM format with HHMM in 24-hour format.

• Parameters /n, /s, /e cannot be swapped.

Deleting a cca: delete cca

Allows you to delete a cca based on its index in the list.

Firstly, type delete in the command line as seen below, followed by the category type which is the cca. Afterwards, key in the corresponding index of the cca you would like to delete. Press ‘Enter’ to execute it.

The output is seen in the console. The date and time is converted to a more readable form, enabling you to read it more pleasantly.

WARNING:

• [cca number] must be written in numerals.

Category: Test (Alicia Ho Shimin)

Adding a test: add test

Allows you to add a new test with a name, date and time.

Firstly, type add in the command line as seen below, followed by the category type which is the test. Afterwards, key in the description of the test as well as its start and end date and time. Press ‘Enter’ to execute it.

The output is seen in the console. The date and time is converted to a more readable form, enabling you to read it more pleasantly.

WARNING:

• [name of test] can be in a natural language format and cannot contain ‘/’.

• [start date-time of test] and [end date-time of test] must be in yyyy-mm-dd HHMM format with HHMM in 24-hour format.

• Parameters /n, /s, /e cannot be swapped.

Deleting a test: delete test

Allows you to delete a test event based on its index in the list.

Firstly, type delete in the command line as seen below, followed by the category type which is the test. Afterwards, key in the corresponding index of the test you would like to delete. Press ‘Enter’ to execute it.

The output is seen in the console. The date and time is converted to a more readable form, enabling you to read it more pleasantly.

WARNING:

• [test number] must be written in numerals.

Category: Tuition (Chan Xu Hui)

Adding a tuition: add tuition

Allows you to add a new test with a name, date, time, location.

Firstly, type add in the command line as seen below, followed by the category type which is the tuition. Afterwards, key in the description of the tuition, its start and end date and time as well as its location. Press ‘Enter’ to execute it.

The output is seen in the console. The date and time is converted to a more readable form, enabling you to read it more pleasantly.

WARNING:

• [name of tuition] and [location of tuition] can be in a natural language format and cannot contain ‘/’.

• [start date-time of tuition] and [end date-time of tuition] must be in yyyy-mm-dd HHMM format with HHMM in 24-hour format.

• Parameters /n, /s, /e, /l cannot be swapped.

Deleting a tuition: delete tuition

Allows you to delete a tuition based on its index in the list.

Firstly, type delete in the command line as seen below, followed by the category type which is the tuition. Afterwards, key in the corresponding index of the tuition you would like to delete. Press ‘Enter’ to execute it.

The output is seen in the console. The date and time is converted to a more readable form, enabling you to read it more pleasantly.

WARNING:

• [tuition number] must be written in numerals.

Listing out schedule: list event <today/[date]/week/nextweek> (Andre Wong Zhi Hua)

Allows you to list out the entire schedule for classes, ccas and tests. You can also choose to list today’s schedule, the schedule for the week or the schedule for a specific date.

List event: list event

Firstly, to list out all events, type ‘list event’ in the command line, as seen below. Press ‘Enter’ to execute it.

The output is seen in the console. The list is arranged by their respective categories. The date and time is converted to a more readable form, enabling you to read it more pleasantly.

List event today: list event today (Alicia Ho Shimin)

Secondly, to list out all events today, type list event today in the command line, as seen below. Press ‘Enter’ to execute it.

The output is seen in the console. The list is arranged by their respective categories. The date and time is converted to a more readable form, enabling you to read it more pleasantly. The index of the event is corresponding to its index in the entire list.

List event week: list event week (Chan Xu Hui)

Thirdly, to list out all events in the current week, type list event week in the command line, as seen below. Press ‘Enter’ to execute it.

The output is seen in the console. It is displayed in a calendar format for easier readability. The events are listed according to time. The date and time is converted to a more readable form, enabling you to read it more pleasantly.

List event next week: list event nextweek (Chan Xu Hui)

Fourthly, to list out all events in the next week, type list event nextweek in the command line, as seen below. Press ‘Enter’ to execute it.

The output is seen in the console. It is displayed in a calendar format for easier readability. The events are listed according to time. The date and time is converted to a more readable form, enabling you to read it more pleasantly.

List event date: list event [desired date] (Alicia Ho Shimin)

Lastly, to list out all events on a particular date, type list event [desired date] in the command line, as seen below. Press ‘Enter’ to execute it.

The output is seen in the console. The list is arranged by their respective categories. The date and time is converted to a more readable form, enabling you to read it more pleasantly. The index of the event is corresponding to its index in the entire list.

Finding events: find event (Andre Wong Zhi Hua)

Allows you to look for classes, ccas and tests and tuitions that match your given keyphrase.

In the case when you have many events in your schedule and you need to find a specific event to check the date. You can use the find event command to look for the event you want by entering keywords related to it.

Let’s say we need to find out when my vocabulary test is on. We can first type find event vocabulary into the command box, and press ‘Enter’ to execute it.

The output can then be seen in the console.

And we can find the date we are looking for as pointed out by the yellow arrow below.

Score component of Plan&Score

Enables the following category type: quiz

The quiz feature enables you to spend the extra time resulting from your productive scheduling to hone your Mathematics for your upcoming PSLE.

Taking a Quiz: quiz (Chan Wan Ting Elizabeth)

Taking a Mathematics quiz with any number of questions you want, ranging from just 1 question to the total number of questions in the quiz list.

First, enter quiz, followed by the number of questions you would like to take in your quiz. For example, you could enter quiz 1 to attempt a quiz with 1 question.

The following output would then be displayed.

Adding a Quiz Question: add quiz (Andre Wong Zhi Hua)

Allows you to add a Mathematics multiple-choice quiz question to the quiz list.

Note that the /e (explanation) is an optional parameter. You can add a quiz question with or without an explanation.

First, enter add quiz, follow by /q.

Then, enter the question you would like to add.

Next, enter /o1, followed by the answer option you would like to enter. Repeat this for the rest of the three options.

Now, enter /a, followed by the number corresponding to the correct answer option.

Lastly, enter /e, followed by the explanation to the solution of the question. This last part is optional.

An example of such a command would be: add quiz /q What is 26+5? /o1 28 /o2 31 /o3 38 /o4 41 /a 2 /exp Adding 5 to 26 gives us 31..

The corresponding output would then be displayed as shown below.

Deleting a Quiz Question: delete quiz (Chen Jinran)

Allows you to delete a quiz question from the quiz list.

Simply enter delete quiz, followed by the index number corresponding to the quiz question you would like to delete in your quiz list.

For example, you could enter delete quiz 1.

You would expect to see this output.

Listing out All Quiz Questions: list quiz (Andre Wong Zhi Hua)

Allows you to list out all the questions in the quiz list.

All you have to enter is list quiz for this command.

This output should then be seen.

Finding a quiz: find quiz (Chen Jinran)

Look for quizzes that match the given keyword(s) that you want.

Note that searches are case-insensitive and user can provide multiple words to compare with

The format for this command is find quiz, followed by the keyword(s) you would like to search for in your list of quiz questions.

For example, you could enter find quiz 26.

Then, you would expect to see this in your output.

Searching for former incorrect quiz questions: quiz record (Chen Jinran)

Allows you to list out the incorrect quizzes in your last quiz attempt.

Simply enter quiz record.

You should see the full list of questions you have answered wrongly in your previous quiz attempt, as shown below.

Contact component of Plan&Score

Adding a contact add contact (Chen Jinran)

Allows you to add a teacher’s contact details to the contact list.

Firstly, type add in the command line as seen below, followed by the category type which is the contact. Afterwards, key in the description of the contact. Press ‘Enter’ to execute it.

The output is seen in the console.

WARNING:

• [subject of contact], [name of contact], [phone number of contact] and [email of contact] can be in a natural language format and cannot contain ‘/’.
• Parameters /s, /n, /p, /e cannot be swapped.

Deleting a contact delete contact (Chen Jinran)

Allows you to delete a contact from the contact list.

Firstly, type delete in the command line as seen below, followed by the category type which is the contact. Afterwards, key in the corresponding index of the contact you would like to delete. Press ‘Enter’ to execute it.

The output is seen in the console.

WARNING:

• [contact number] must be written in numerals.

Listing out contacts list contact (Chen Jinran)

Allows you to list out all the contacts in the contact list

To list out all contacts, type list contact in the command line, as seen below. Press Enter to execute it.

The output is seen in the console.

Finding a contact find contact (Andre Wong Zhi Hua)

Look for contacts that match the given keywords you want.

In the case when you have many contacts in your list and you need to find a specific contact, you can use the find contact command to look for the contact you want by entering keywords related to it.

Let’s say we need to find out the contact of our math teacher. We can type find contact math into the command box, and press ‘Enter’ to execute it.

The output can then be seen in the console.

Exits Program: bye (Alicia Ho Shimin)

Exits the program once you have finished using it.

Type the command and press ‘Enter’ to execute it.

The output is shown in the console. It contains a simple goodbye message.

Saving Data (Chan Xu Hui)

Plan&Score saves all your data automatically after every command. There is no need to save manually. However, if your storage file is detected to be unreadable, Plan&Score will offer to reset itself to its default settings, wiping all data stored in the text file.

FAQ

Q: How do I transfer my data to another computer?

A: We recommend you to transfer the entire folder containing [CS2113T-W12-4][ Plan&Score].jar and the data directory. Then, follow instructions given in our Quick Start section to set up Plan&Score.

Troubleshooting (Chan Xu Hui)

Q: Plan&Score is unable to start, and I do not want to lose my data through factory resetting. How can I fix this?

A: Your data files might have been corrupted. To fix this, you can attempt the following steps:

We recommend adult supervision for this process.

1. Locate the data directory. It should be in the same directory as where Plan&Score is located.
2. Open the events.txt file.
3. Check if any of the data are violating our decoding formats:
   • For class/cca/test, the format should be: [IDENTIFIER]|[true/false]|[DESCRIPTION]|[DATE IN YYYY-MM-DD HHMM]|[DATE IN YYYY-MM-DD HHMM]
   • For tuition, the format should be: [IDENTIFIER]|[true/false]|[DESCRIPTION]|[DATE IN YYYY-MM-DD HHMM]|[DATE IN YYYY-MM-DD HHMM]|location
4. Edit the file to the correct formats shown above
5. Launch Plan&Score
6. Confirm that Plan&Score runs without any error

In the unfortunate event where the error persists, please reset Plan&Score to factory settings. We recommend keeping a duplicate of the contents in events.txt to assist with the re-adding of events.

1. Ensure you have duplicated events.txt
2. Delete events.txt
3. Launch Plan&Score
4. Confirm that Plan&Score runs without any error
5. events.txt should appear in the data directory
6. Copy any unaffected events from the duplicated file in Step 1
7. Re-add affected events through the command line interface

Command Summary (Team)