User Guide

NUScheduler is a desktop app for NUS students who have a large network of contacts to manage, optimised for use via a Command Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, NUScheduler can get your contact management tasks done faster than traditional GUI apps.

With NUScheduler, you can store the contact details of the NUS community around you and manage your classes and events effectively.

Table of Contents

• Using this guide
• Quick start
• User interface
• Command format
  • Command word
  • Option flag
  • Parameters
• Features
  • Profiles
    • Adding a profile: profile -a
    • Viewing all profiles: profile -v
    • Editing a profile: profile -e
    • Finding profiles by name: profile -f
    • Deleting a profile: profile -d
  • Events
    • Adding an event: event -a
    • Adding a profile to an event: event -ap
    • Deleting an attendee from an event: event -dp
    • Viewing upcoming events: event -u
    • Viewing all events: event -v
    • Editing an event: event -e
    • Finding events by date or title: event -f
    • Deleting an event: event -d
  • General
    • Viewing help: help
    • Clearing all profiles and events: clear
    • Exiting the program: exit
    • Saving the data
  • Advanced features
    • Session-based command history
    • Tag shortcuts
    • Quick links
    • Editing the data
• Useful Information
  • Accepted date time formats
    • Date-only formats
    • Date time formats
  • Accepted email formats
  • Transfer data to another computer
• Command summary

Using this guide

This user guide provides you with the information necessary to start using NUScheduler.

In this user guide, you may encounter the following icons:

Icon	Description
	Provides general information that you might find helpful
	Provides good to know information on how to more effectively utilise NUScheduler
	Provides important information to prevent undesired behaviour

You may also encounter the following text formatting:

If you are a new user, check out the Quick start to get started with NUScheduler.

If you are a returning user, the Command summary provides you with a quick overview of some of the commands NUScheduler offers.

Quick start

1. Ensure you have Java 11 or above installed in your Computer.

2. Download the latest NUScheduler.jar from here.

3. Copy the file to the folder you want to use as the home folder for your NUScheduler.

4. Double-click the file to start the app. The GUI similar to the one shown below should appear. Note how the app contains some sample data.

5. 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.
   Some example commands you can try:

   • profile -a n/John Doe p/98765432 e/johnd@u.nus.edu t/friend: Adds a profile with the name John Doe.

   • profile -d 2: Deletes the 2nd profile shown in the current list.

   • profile -v: Lists all profiles in NUScheduler.

6. Refer to the Features below for details of each command.

User interface

The following is the main user interface of NUScheduler.

• Menu Bar
• Command Box: Enter your commands here.
• Result Display: Shows the details of the results of your commands.
• Profile List: Displays the list of profiles stored and the relevant details.
• Event List: Displays the list of events stored and the relevant details.

Command format

All profile and events commands used in NUScheduler follow this command format:

<command word> <option flag> <parameters>

Command word

Command words are used to specify what to perform the operation on.

• Command words are case-sensitive, e.g. exit will work, but not EXIT.

Option flag

Option flags are used to specify the operation to perform.

• Option flags are prefixed by -, and are case-sensitive, e.g. -v will work, but not -V.
• Option flags must be specified right after the command word.
• Optional flags are only applicable for the profile and event command words.

Parameters

Parameters are extra inputs the command may require.

• Words in UPPER_CASE are the parameters you will specify.
  e.g. in profile -a n/NAME, NAME is a parameter which can be used as profile -a n/John Doe.
• Parameters may require a prefix, and the prefix is case-sensitive.
• Parameters 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.
• Parameters with …​ after them can be used multiple times, including zero times for optional items.
  e.g. [t/TAG]…​ can be used as   (i.e. 0 times), t/friend, t/friend t/family etc.
  e.g. pr/PROFILE_INDEX…​ must be used at least once, such as pr/1, pr/3 pr/5 etc.
• If a parameter is expected only once in the command, but you specified it multiple times, only the last occurrence of the parameter will be taken.
  e.g. if you specify p/12341234 p/56785678, only p/56785678 will be taken.

Tip: 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.

Features

Profiles

Each profile is a set of contact information about a person in your NUS community.

Adding a profile: profile -a

Adds a profile to NUScheduler.

Format: profile -a n/NAME p/PHONE_NUMBER e/EMAIL [tg/TELEGRAM_USERNAME] [t/TAG]…

Tip: A profile can have 0 or more tags.

Examples:

• profile -a n/John Doe p/98765432 e/johnd@u.nus.edu t/friend
• profile -a n/Jane Smith e/jane_s@u.nus.edu p/91234580 tg/jane_s
• profile -a n/Betsy Crowe e/betsycrowe@u.nus.edu p/1234567 t/professor t/lecturer

Viewing all profiles: profile -v

Shows a list of all profiles in the NUScheduler.

Format: profile -v

Editing a profile: profile -e

Edits an existing profile in NUScheduler.

Format: profile -e INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [tg/TELEGRAM_USERNAME] [t/TAG]…

• Edits the profile at the specified INDEX. The index refers to the index number shown in the displayed profile list. The index must be a positive integer less than or equal to 1000 e.g. 1, 2, 3, …​, 1000
• At least one of the optional fields must be provided.
• Existing values will be updated to the input values.
• You can remove the profile’s telegram username by typing tg/ without specifying any username after it.
• When editing tags, the existing tags of the profile will be removed i.e adding of tags is not cumulative.
• You can remove all the profile’s tags by typing t/ without specifying any tags after it.

Examples:

• profile -e 1 p/91234567 e/johndoe@u.nus.edu edits the phone number and email address of the 1st profile to be 91234567 and johndoe@u.nus.edu respectively.
• profile -e 2 n/Betsy Crower t/ edits the name of the 2nd profile to be Betsy Crower and clears all existing tags.
• profile -e 3 tg/ t/ clears the telegram username and tags of the 3rd profile.

Finding profiles by name: profile -f

Finds profiles whose names contain any of the given keywords.

Format: profile -f 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.
• Partial match will also be returned. e.g. han will match hans
• Profiles matching at least one keyword will be returned (i.e. OR search). e.g. Hans Bo will return Hans Gruber, Bo Yang

Examples:

• profile -f Jane returns jane and Jane Doe
• profile -f alex dav returns Alex Yeohand David Li
  

Deleting a profile: profile -d

Deletes a specified profile from NUScheduler.

Format: profile -d INDEX

• Deletes the profile at the specified INDEX.
• The index refers to the index number shown in the displayed profile list.
• The index must be a positive integer less than or equal to 1000 e.g. 1, 2, 3, …​, 1000

Example:

• profile -d 1 deletes the first profile listed.

Events

Adding an event: event -a

Adds an event with a title, a start date and end date.

Format: event -a n/TITLE s/START e/END [t/TAG]…

• The start and end dates can be specified in various formats. See Accepted Date Time Formats for the full list of formats.
• The start and end dates must both contain either date only or date and time i.e. time is optional.
• The start date must occur before or on the same day and time as the end date.

Tip: An event can have 0 or more tags.

Example:

• event -a n/Presentation s/22/10/2022 e/23/10/2022 t/CS2103

Adding a profile to an event: event -ap

Adds one or more existing profiles as attendees to an existing event in NUScheduler.

Format: event -ap EVENT_INDEX pr/PROFILE_INDEX…

• Adds profiles at the specified PROFILE_INDEX. This index refers to the index number shown in the displayed profile list. The index must be a positive integer less than or equal to 1000 e.g. 1, 2, 3, …​, 1000
• Profiles are added to the event at the specified EVENT_INDEX. This index refers to the index number shown in the displayed event list. It follows the same constraints as PROFILE_INDEX.
• At least one PROFILE_INDEX must be provided.
• Existing attendees will not be overwritten i.e. adding of profiles is cumulative.
• If one or more or all of the specified profiles have already been added to the event, the command still executes successfully.

Tip: If a profile has been added to an event as an attendee, deleting the profile from NUScheduler will delete the profile from the event as well.

Example:

• event -ap 1 pr/1 pr/2 adds the first and second profiles listed to the first event listed.

Deleting an attendee from an event: event -dp

Removes one or more attendees from an existing event in NUScheduler.

Format: event -dp EVENT_INDEX pr/ATTENDEE_INDEX…

• Removes attendees at the specified ATTENDEE_INDEX. This index refers to the index number shown in the displayed attendee list of the event. The index must be a positive integer less than or equal to 1000 e.g. 1, 2, 3, …​, 1000
• Attendees are removed from the event at the specified EVENT_INDEX. This index refers to the index number shown in the displayed event list. It follows the same constraints as ATTENDEE_INDEX.
• At least one ATTENDEE_INDEX must be provided.

Example:

• event -dp 1 pr/1 pr/3 Note how the first and third attendees under the first listed event Discuss presentation have been deleted.

Viewing upcoming events: event -u

Displays a list of upcoming events, ordered by the date, which starts in the next specified number of days.

Format: event -u DAYS

• The days refer to the number of days after the current date. All events that start within this time frame will be displayed. Events starting and occurring on the day the command is entered will not be displayed.
• The days must be a positive integer less than 10000 e.g. 1, 2, 3, …​, 9999.

Example:

• event -u 5 when used on 22/10/2022 displays all events starting in the next 5 days from 23/10/2022 to 27/10/2022 with both dates included.

Viewing all events: event -v

Shows a list of all events in the NUScheduler.

Format: event -v

Editing an event: event -e

Edits an existing event in NUScheduler.

Format: event -e INDEX [n/TITLE] [s/START] [e/END] [t/TAG]…

• Edits the event at the specified INDEX. The index refers to the index number shown in the displayed event list. The index must be a positive integer less than or equal to 1000 e.g. 1, 2, 3, …​, 1000
• 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 event will be removed i.e adding of tags is not cumulative.
• You can remove all the event’s tags by typing t/ without specifying any tags after it.

Tip: The start and end dates can be specified in various formats. See Accepted Date Time Formats for the full list of formats.

Example:

• event -e 1 n/Formal Dinner t/RC4 edits the title of the first event in the displayed list to Formal Dinner and clears existing tags before adding the tag RC4.

Finding events by date or title: event -f

Finds events whose title contain any of the given keywords or start times contain any of the given start times.

Format: event -f KEYWORD_OR_DATE [MORE_KEYWORDS_OR_DATES]…

• Date search will occur when all inputs are valid dates, otherwise, keyword search will occur.
• The date search occurs only by date, ignoring the time, e.g. 11/10/2022 08:00 will match any events that start on 11/10/2022.
• The keyword search is case-insensitive. e.g birthday will match Birthday.
• The order of the keywords does not matter. e.g. one two will match two one.
• Partial match will also be returned. e.g. inter will match interview
• Events matching at least one keyword will be returned (i.e. OR search) e.g. interview meeting will return Meeting Tom, Job Interview.

Example:

• event -f Presentation displays all events with Presentation within the event title.
• event -f 20/11/2022 05/10/2022 displays all events that start on either 20/11/2022 or 05/10/2022.

Deleting an event: event -d

Deletes a specified event from NUScheduler.

Format: event -d INDEX

• Deletes the events at the specified INDEX.
• The index refers to the index number shown in the displayed event list.
• The index must be a positive integer less than or equal to 1000 e.g. 1, 2, 3, …​, 1000

Example:

• event -v followed by event -d 2 deletes the 2nd event displayed.

General

Viewing help: help

Opens a help window displaying all the recognised commands, and a link to access the user guide.

Format: help

Tip: Open the help window using F1 on your keyboard

Clearing all profiles and events: clear

Clears all profiles and events from the NUScheduler.

Format: clear

Exiting the program: exit

Exits the program.

Format: exit

Saving the data

All data in NUScheduler is saved in the hard disk automatically after executing any command that changes the data. There is no need to save manually.

Advanced features

Session-based command history

Access the previous commands you’ve made within each session.

• Use the up arrow key, ↑ to navigate to the previous command.
• Use the down arrow key, ↓ to navigate to the next command.

Tag shortcuts

Use shortcuts to quickly enter tags.

Example:

• profile -a n/Damith e/damith@comp.nus.edu.sg p/65164359 t/prof creates a profile with the name Damith and the tag professor.
• event -e 1 t/tut edits the tag of the first event shown to tutorial.

Quick links

Get easy access to some of your favourite NUS websites, right from the menu bar.

1. Click on Links in the menu bar. A dropdown should appear.
2. Click on the link you want to visit, if you want to visit Canvas, click on Canvas.
3. The website should open in your browser.

Editing the data

NUScheduler data are saved as a JSON file [JAR file location]/data/nuscheduler.json. You can update data directly by editing that data file.

Caution: If your changes to the data file makes its format invalid, NUScheduler will discard all data and start with an empty data file at the next run.

Useful Information

Accepted date time formats

NUScheduler accepts date-time formats both with and without a time specified. For example, date-only formats can be used to specify all day events.

Date-only formats

• DAY/MONTH/YEAR
• DAY-MONTH-YEAR
• YEAR/MONTH/DAY
• YEAR-MONTH-DAY
• DAY/MONTH (uses current year by default)
• DAY-MONTH (uses current year by default)

Date time formats

The following time formats can be appended after a whitespace to the end of the above date formats.

• HOUR:MINUTE
• HOURMINUTE

Example:

• 25/05/2015 10:00
• 4-July-2022 2100

Accepted email formats

NUScheduler checks the following:

• Local part (the characters in your email before @) of the emails must follow these rules:
  • Only alphanumeric characters and these special characters, +, _, ., - are allowed
  • The local part cannot start or end with a special character
  • The local part must begin and end with an alphabet or number
  • 2 consecutive special characters are not allowed (e.g. +_, .. and -+ are all not allowed)
• Domain (the characters in your email after @) of the emails must be one of the following valid NUS email domains, domains are case-sensitive:
  • u.nus.edu
  • u.duke.nus.edu
  • nus.edu.sg
  • comp.nus.edu.sg
  • u.yale-nus.edu.sg

Transfer data to another computer

You can simply install the app in the other computer and overwrite the data file it creates with the file that contains the data of your previous NUScheduler home folder.

Command summary