TravEzy

There are alot of things that TravEzy can do. So, we have organised this document such that you can easily look for what you need.

We’ve split up this guide into the different features of our application, namely:

In each of the above sections, you will be introduced to the Interface of the feature and the Commands that will help you make travel easy.

Symbols and exquisite (okay, different) fonts are exciting, aren’t they? Let’s find out more about what they mean in this document!

This is how TravEzy’s main page looks like:

Trying to open up the another page? Use this command!

Format:
goto PAGE TYPE
 
where PAGE TYPE can be any of the following: calendar, itinerary, address_book, financial_tracker, diary or achievements

Example:

Step by step:

Step 1. Type goto itinerary in the command box and press Enter.

Step 2. You will be directed to the itinerary page.

If you are lost, this command will be helpful.

Format:
help

Step by step:

Step 1. Type help in the command box and press Enter.

Step 2. The message in the result box will be updated to indicate that the help window has been opened.

Step 3. The help window will appear as a pop-up and you may click the "copy link". This link will direct you to TravEzy’s user guide (i.e. this document).😊

It’s time to catch your flight, exit TravEzy and start your trip!

Format:
exit

Step by step:

Step 1. Type exit in the command box and press Enter.

Step 2. All TravEzy’s windows will close.

This is how TravEzy’s calendar looks like:

To help you easily differentiate between various types of events, TravEzy has categorised the events into four types: commitment, holiday, school break and trip. Visually, TravEzy also uses different labels for the different types of events, as shown in the image above.

Whew! After reading so much, it is time to find out how you can add your event so that TravEzy can start suggesting when you can travel! 😊

Format:
add EVENT TYPE n/NAME d/START DAY [m/START MONTH] [y/START YEAR] [D/END DAY] [M/END MONTH] [Y/END YEAR]

Examples:

Step by step:

Step 1. Type add commitment n/volunteer to tutor children d/2 m/Dec y/2019 D/5 M/Dec Y/2019 in the command box and press Enter.

Step 2. The month and year panel will change to "December" and the relevant view will be shown.

Step 3. In the month view panel, you will be able to see the newly added commitment labels.

Step 4. The result box will also display a message to indicate that your commitment has been successfully added.

Yes, we have all had that experience. We thought that next Friday is a public holiday even though it isn’t. However, you have added this holiday to TravEzy! 😧 What should you do now? Delete it!

But how? Well, this is the section for you. 😀

Format:
delete EVENT TYPE n/NAME d/START DAY [m/START MONTH] [y/START YEAR] [D/END DAY] [M/END MONTH] [Y/END YEAR]

Examples:

Step by step:

Step 1. Type delete commitment n/volunteer to tutor children d/2 m/Dec y/2019 D/5 M/Dec Y/2019 in the command box and press Enter.

Step 2. The month and year panel will change to "December" and the relevant view will be shown.

Step 3. In the month view panel, you will be able to see that the commitment labels have been removed.

Step 4. The result box will also display a message to indicate that your commitment has been successfully deleted.

After adding and deleting your events, you can have an overview of them!

How easy is it?

Format:
show m/MONTH [y/YEAR]

Example:

Step by step:

Step 1. Type show m/Dec in the command box and press Enter.

Step 2. The month and year panel and month view panel will change to show you your schedule for this December.

Step 3. The result box will also display a message to indicate that TravEzy is currently showing you your schedule for December.

If you would like to view your events as a list instead, this command would be helpful!

Format:
list [d/START DAY] [m/START MONTH] [y/START YEAR] [D/END DAY] [M/END MONTH] [Y/END YEAR]

Examples:

Step by step:

Step 1. Type list in the command box and press Enter.

Step 2. A pop-up will appear to show you all your events.

Step 3. When you click at a region outside of the pop-up, the pop-up will disappear. How neat is that?

Do you need to find out whether you are available to go for a trip? You can get TravEzy to find that out for you (i.e. when you happen to have a school break/holiday and do not have any commitment/trip).

Let’s find out how!

Format:
check d/START DAY [m/START MONTH] [y/START YEAR] [D/END DAY] [M/END MONTH] [Y/END YEAR]

Examples:

Step by step:

Step 1. Type check d/9 m/Dec y/2019 in the command box and press Enter.

Step 2. The month and year panel and month view panel will change to show you your schedule for this December.

Step 3. The result box will display a message to indicate whether you are available to travel during the specified time. If you happen to be free (like in this case), you may start booking your trip! 😀

The end of the semester is near. It is time to look for some cheap flights🛫! However, before deciding which flight to book, you need to find out when you can travel. Need some help with that? No worries! TravEzy has got you covered. 😊

How so? Just ask TravEzy to suggest a suitable time!

Format:
suggest d/START DAY [m/START MONTH] [y/START YEAR] [D/END DAY] [M/END MONTH] [Y/END YEAR] [p/PERIOD]

Examples:

Step by step:

Step 1. Type suggest d/9 m/Dec y/2019 D/20 M/Dec Y/2019 in the command box and press Enter.

Step 2. The month and year panel and month view panel will change to show you your schedule for this December.

Step 3. The result box will display a message to indicate when you are able to travel during the specified time.

This is how TravEzy’s Itinerary looks like:

Planning to visit DisneySea tomorrow? Add some rides that you plan to take then! 🎢

Format:
add title/TITLE date/DATE time/TIME [l/LOCATION] [d/DESCRIPTION]

Example:

Step by step:

Step 1. Type add title/Ride DisneySea Electric Railway date/12122019 time/1500 l/DisneySea in the command box.

Step 2. Remember to prioritize your events using the Priority dropdown box, to one of the 5 different priorities:

After selecting the priority for the event, press Enter.

Step 3. The result box will display the message "Processing…​ Done! Your event has been successfully added! HAND, TravEzy! :D"

Step 4. Now you can find your added event in the the event list.

Had a change in plan during your trip but have already keyed in the event into TravEzy’s Itinerary? Don’t worry you can always remove it from the event list.

Read on to find out more!

Format:
delete INDEX

Example:

Step by step:

Step 1. Type delete 4 in the command box and press Enter.

Step 2. The result box will display the message "Processing…​ Done! Your event has been deleted successfully. Yay! :^)"

Step 3. The new event list will be shown with the specified event being removed.

Rather than deleting an event when you have a change of plans, why not edit the details of the event instead?

Format:
edit INDEX [title/TITLE] [date/DATE] [time/TIME] [l/LOCATION] [d/DESCRIPTION] [tag/]

Example:

Step by step:

Step 1. Type edit 4 title/Explore DisneySea’s Aquatopia d/Take photos of the fishes tag/ in the command box.

Step 2. If you indicate a change of the priority in the edit command using tag/, do remember to select the new priority using the Priority Dropdown Box.

Step 3. The result box will display the message "Updated successfully! :D HAND, TrazEzy~"

Step 4. TravEzy’s Itinerary will showcase the new event list with the edited event.

Impressive! After you have completed an event that you have planned for the day, TravEzy itinerary lets you check that event as done. ✅

Format:
done INDEX

Example:

Step by step:

Step 1. Type done 4 in the command box and press Enter.

Step 2. The result box will display the message "Processing…​ Done! Your event has been marked done successfully. Yay! :^)"

Step 3. In the event list, that event will be marked as done. Great Job! 👍

What if you want to see all your events in ONE, CONTINUOUS list? The Itinerary allows you to see everything in one, convenient list!

Format:
list

Step by step:

Step 1. Type list in the command box and press Enter.

Step 2. The result box will display the message "Processing…​ Done! Your event has been marked done successfully. Yay! :^)"

Step 3. A continuous event list will be shown with all the events in the Itinerary.

After using TravEzy Itinerary for a long time, you might find that your Itinerary is cluttered with many past events. However, it might be a hassle to delete each events one by one.

Don’t worry, TravEzy’s Itinerary got you covered and allows you to clear the entire event list instead.

How convenient is that! 😄

Format:
clear

Step by step:

Step 1. Type clear in the command box and press Enter.

Step 2. A popup window will appear prompting whether you would like to Proceed in clearing all your events from the event list.

Step 3. The result box will display the message "Currently viewing clear window warning.".

Step 4. Upon selecting Proceed, a notification will be shown on the screen with the message, "Done! We have wiped off all your events from the face of this Earth! ( ﾟヮﾟ)".

Start you day right by saying hello to TravEzy Itinerary and it will greet you back with the current time and date. TravEzy will also filter the event list to showcase events that are due today.

Format:
greet

Step by step:

Step 1. Type greet in the command box and press Enter.

Step 2. The result box will display the message "Hello! Welcome to the itinerary page!" this will be followed by the current date and time.

Step 3. The event list in the Itinerary will only showcase events that are due for the day.

Curious on what are the past commands that you have inputted during the current session? TravEzy will show you a list of your past commands for the Itinerary.

Let’s find out how!

Format:
history

Step by step:

Step 1. Type history in the command box and press Enter.

Step 2. The result box will display the message "Commands called for this session (Most recent → Earliest):" followed by the list of past commands that are being called in the Itinerary for that session.

Does your event list too many events to browse through? Let TravEzy Itinerary help you by searching for events that matches specific keywords. 😊

Format:
search SEARCH CONDITION

where SEARCH CONDITION can be any of the following: title/TITLE, date/DATE, time/TIME, l/LOCATION, d/DESCRIPTION or tag/

Example:

Step by step:

Step 1. Type search in the command box and press Enter.

Step 2. The result box will display the message "Processing…​ Done! Here are the events that matches the details. ( ͡° ͜ʖ ͡°)"

Step 3. The filtered event list will be shown containing events that matches the keywords given.

Organizing your events in the event list has never been easier the Itinerary’s awesome sorting capabilities. 💯

Format:
sort by/SORT CONDITION

where SORT CONDITION can be any of the following: title, location, chronological, completion or priority

Example:

Step by step:

Step 1. Type sort by/priority in the command box and press Enter.

Step 2. The result box will display the message "Processing…​ Done! TravEzy has helped sorted out your life!"

Step 3. The Itinerary will present the sorted event list based on the sort condition given.

Don’t you wish there’s a way to quickly type all your commands. Well TravEzy’s Itinerary got you covered! TravEzy’s Itinerary command box has auto-completion function which offers suggestions based on your input.

This is how TravEzy’s Itinerary auto-complete looks like:

Navigating around the address book page:

Met a new friend in a new foreign country during your holiday trip? Add him / her to your TravEzy address book. TravEzy address book is different from other address book by allowing you to add a country field beside your contact information.

Format:
add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG] [r/REMARK][c/COUNTRY]

Examples:

Step by Step:

Step 1. Type add n/Alice p/918273645 e/alice@example.com a/566,Yishun Ring Road, #14-113 in the command box and click Enter.

Step 2. In the persons list panel, you can now see that Alice has been added into the address book.

Step 3. The result box will also display a message that your contact has been added.

After adding your contacts, you may want to see an overview of your contact information in the address book. See everyone in your address book with one command!

Format:
list

Step by Step:

Step 1. Type list in the command box and click Enter.

Step 2. See an overview of your contact information in the persons list panel

Step 3. The result box will also display a message that all your contact information has been listed.

Oh no, you have added a wrong contact information into the address book! Edit all your contact information in the address book inside TravEzy is easy by specifying a field of the contact information you want to edit.

Format:
edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [t/TAG] [r/REMARK] [c/COUNTRY]

Examples:

Step by Step:

Step 1. Type edit7 p/9082373645 to edit Alice’s phone number to reflect the correct phone number 908237645

Step 2. The persons list panel will now display the updated information for Alice after the edit.

Step 3. The result box will display a message that the person has been edited if successful.

Too many contacts in your address book? TravEzy address book provides a simple way to find your contact information with keywords. How about let TravEzy address book do the finding for you!

Format: find KEYWORD [MORE_KEYWORDS]

Examples:

Step by Step:

Step 1. Type find Alice in the command box and click Enter

Step 2. The results found will be displayed at the persons list panel.

Step 3. The result box will also display a message to indicate the number of matching results found.

Make your address book neat and organized! Clear off any old and unused contact information. Travezy address book application allows you to delete your old contact information. Time to make your address book look pretty and neat!

Format:
delete INDEX

Examples:

Step By Step:

Step 1. Type delete 7 in the command box and click Enter

Step 2. The persons list panel will display the updated address book after deleting the specified contact

Step 3. The result box will also display a message to notify that the person has been deleted from the contact book.

Restarting your address book from scratch? Rather than deleting your contacts one by one, start with a fresh new address book by clearing all existing contact entries.

Format:
clear

Step by step:

Step 1. Type clear into the command box and click Enter

Step 2. The persons list panel is now cleared. You will see an empty persons list panel.

Step 3. The result box will display a message that tells you that the address book has been cleared.

Address book data are saved in the hard disk automatically after any command that changes the data.

There is no need to save manually.

This is what you will see when navigated to the Financial Tracker:

Adding the expense of milk you’ve bought at the grocery shop you stopped by?

Format:
add a/AMOUNT d/DESCRIPTION t/TYPE OF EXPENDITURE [date/DATE] [time/TIME]

Example:

Step by step:

Step 1. Select which country you’re currently at from the Countries dropdown box.

Step 2. Type add a/2.89 d/Meiji Milk t/grocery in the Command box and press Enter.

Step 3. The Result box will display the message "Expense added".

Step 4. Now you can find your added expense in the Expense list panel.

Added a wrong expense? Of course you can delete it if you want to :)

Format:
delete INDEX

Example: Delete the first expense you saw on your expense list.

Step by step:

Step 1. Type delete 1 in the Command box and press Enter.

Step 2. The Result box will display the message "Your expense has been deleted".

Add a wrong expense? Why not edit it instead!

Format:
edit INDEX [a/AMOUNT] [d/DESCRIPTION] [t/TYPE OF EXPENDITURE] [date/DATE] [time/TIME]

Example: Edit the 1st expense you saw on your expense list.

Step by step:

Step 1. Notice the first expense’s fields in the Expense list panel.

Step 2. Now, type edit 1 a/29.80 d/Nike bottle in the Command box and press Enter.

Step 3. The Result box will display the message "The expense updated successfully!".

Step 4. Now the first expense’s amount and description fields have been changed to 29.80 and Nike bottle respectively.

Messed up your expense list? Don’t worry, just clear it!

Format:
clear

Step by step:

Step 1. Type clear in the Command box and press Enter.

Step 2. The Result box will display the message "Expense list cleared!".

Step 3. Now in your Expense list panel, your expense list has been cleared!

Did something wrong? We heard you! Simply undo your previous action :)

Format:
undo

Step by step: (A continue from above clear command)

Step 1. Type undo in the Command box and press Enter.

Step 2. The Result box will display the message "Done!".

Step 3. Notice that your expense list has been recovered. Nice save!

Currently in somewhere else? Switch to that expense list instead!

Format:
switch COUNTRY

Example:

Step by step:

Step 1. Type switch Japan in the Command box and press Enter.

Step 2. The Result box will display the message "Expense list switched".

Step 3. Now your expense list inside the Expense list panel has been switched to that which is in Japan!

The default sorting way of the expense list is not your thing? Just sort your expense list according your needs!

Format:
sort CRITERIA

Where CRITERIA can be amount, date, time, type and default

Example: to sort by amount

Step by step:

Step 1. Notice the amount field in each expenses are currently not in order.

Step 2. Now, type sort amount in the Command box and press Enter.

Step 3. The Result box will display the message "Expense List sorted!".

Step 4. Now all your expenses are sorted in descending order of your amount!

Do you ever have difficulty summarising your spending? Afraid not! You can view you expenses statistics easily!

Format:
summary

Step by step:

Step 1. Type summary in the Command box and press Enter.

Step 2. The result box will display the message "Currently viewing the Summary Window".

Step 3. As you should have noticed, the Summary Window has been popped out showing you statistics of your expenses in a nice-looking pie chart and bar chart form!

Trying to journal about your fishing trip? The Diary allows you to add Diary Entries and keep them alive in your desktop forever.

Format:
add t/TITLE d/DATE TIME [p/PLACE] [m/MEMORY]

Example:

Step by step:

Lets take the example of a midnight fishing trip!

Step 1: Type add t/Fishing Trip d/12/12/2019 2300 p/Pulau Tekong m/Caught the biggest fish ever! into the User Input Box and press Enter on your keyboard. You can refer to the picture below, where the number 1 is.

Step 2: TravEzy will tell you if your add command was successful in the Result Display, as can be seen where the number 2 is, in the picture below.

Step 3: You can see your added entry in the Diary List Panel, similar to number 3 in the picture below.

It’s best to forget some memories ☹. The Diary can help you to get rid of unpleasant Diary Entries.

Format:
delete INDEX

Example:

Step by step:

Let’s say you lose your wallet while on holiday in Genting, That’s definitely a trip that no one would want to remember :(.

Step 1: Type delete 2 into the User Input Box and press Enter on the keyboard.You can refer to the picture below, where the number 1 is.

Step 2: TravEzy will tell you if your delete command was successful in the Result Display, as can be seen where the number 2 is, in the picture below.

Step 3: You can see your updated Diary List Panel without the horrible memory, similar to number 3 in the picture below.

What if you want to see all your memories in ONE, CONTINUOUS list? The Diary can do that as well! It allows you to see everything in one, convenient list!

Format:
list

Example:

Step by step:

Lets relive EVERYTHING!

Step 1: Type list into the User Input Box and press Enter on the keyboard. You can refer to the picture below, where the number 1 is.

Step 2: TravEzy will tell you if your list command was successful in the Result Display, as can be seen where the number 2 is, in the picture below.

Step 3: You can see all your Diary Entries in the Diary List Panel, similar to number 3 in the picture below.

"Hey, when did I go to Spain?" It can be hard to remember all the details of your trips. That’s why, this Diary lets you look through all your entries quickly, to give you the entry that you want!

Format:
find TARGET

Example:

Step by step:

That was the craziest Rugby World Cup ever! Who lost?

Step 1: Type find rugby into the User Input Box and press Enter on the keyboard. You can refer to the picture below, where the number 1 is.

Step 2: TravEzy will tell you if your find command was successful in the Result Display, as can be seen where the number 2 is, in the picture below.

Step 3: You can see the matching Diary Entries in your Diary List Panel, similar to number 3 in the picture below.

Let’s narrow down your search! The Diary allows you to look through specific sections of each Diary Entry to find the exact entry that you want!

Format:
findSpecific [t/TITLE] [d/DATE TIME] [p/PLACE] [m/MEMORY]

Example:

Step by step:

You know that you had a trip on the 12th of December 2019, but you can’t remember what you did…​

Step 1: Type findSpecific d/12/12/2019 into the User Input Box and press Enter on the keyboard. You can refer to the picture below, where the number 1 is.

Step 2: TravEzy will tell you if your findSpecific command was successful in the Result Display, as can be seen where the number 2 is, in the picture below.

Step 3: You can see the specific matching Diary Entries in your Diary List Panel, similar to number 3 in the picture below.

There are some personal memories which are for our eyes only. The Diary can help you to private memories from prying eyes.

Format:
private INDEX

Example:

Step by step:

You had your first sip of wine today! Better not let mum find out…​

Step 1: Type private 4 into the User Input Box and press Enter on the keyboard. You can refer to the picture below, where the number 1 is.

Step 2: TravEzy will tell you if your private command was successful in the Result Display, as can be seen where the number 2 is, in the picture below.

Step 3: You can see your updated Diary List, after the memory has been hidden, similar to number 3 in the picture below.

Once you know you are alone and away from prying eyes, you can look at your private memories safely. The Diary can help you to unprivate those memories.

Format:
unprivate INDEX

Example:

Ok you’re alone now! How was that wine? :)

Step by step:

Step 1: Type unprivate 4 into the User Input Box and press Enter on the keyboard. You can refer to the picture below, where the number 1 is. = image::DiaryUnPrivateBefore.png[width=600]

Step 2: TravEzy will tell you if your unprivate command was successful in the Result Display, as can be seen where the number 2 is, in the picture below.

Step 3: You can see your updated Diary List, after the memory is visible again, similar to number 3 in the picture below.

You never know who may use your laptop when you’re away. The Diary can help you to protect your memories to stop hackers from looking at your private memories with a username and password. If you setDetails, you will not be able to use the unprivate command and will have to use the unlock command (See below).

Format:
setDetails user/USERNAME password/PASSWORD

Example:

Step by step:

Better set a password to protect your memories against prying eyes

Step 1: Type setDetails user/youcanthackme password/youreallycanthackme into the User Input Box and press Enter on the keyboard. You can refer to the picture below, where the number 1 is.

Step 2: TravEzy will tell you if your unprivate command was successful in the Result Display, as can be seen where the number 2 is, in the picture below.

With password protection, we want to ensure no one else can access our memories . The Diary can do this by ensuring only you can see the private memories.

Format:
unlock INDEX user/USERNAME password/PASSWORD

Example:

Step by step:

Unlock your hidden memories!

Step 1: Type unlock 4 user/youcanthackme password/youreallycanthackme into the User Input Box and press Enter on the keyboard. You can refer to the picture below, where the number 1 is.

Step 2: TravEzy will tell you if your unlock command was successful in the Result Display, as can be seen where the number 2 is, in the picture below.

Navigating around the achievements interface:

The scroll pane contains the statistics for: