By: Team SE-EDU
Since: Aug 2019
Licence: MIT
Team: T17-2
Content
- 1. Introduction
- 2. Quickstart
- 3. Preface
- 4. Main
- 5. Calendar
- 6. Itinerary
- 6.1. Interface
- 6.2. Auto-completion feature
- 6.3. Adding an event:
add
- 6.4. Deleting an event:
delete
- 6.5. Editing an event:
edit
- 6.6. Checking a command as done:
done
- 6.7. Listing all events:
list
- 6.8. Clearing all entries:
clear
- 6.9. Greet TravEzy itinerary:
greet
- 6.10. Showing past commands:
history
- 6.11. Searching for an event:
search
- 6.12. Sorting the events:
sort
- 7. Address Book
- 8. Financial Tracker
- 8.1. Interface
- 8.2. Adding an expense:
add
- 8.3. Deleting an expense:
delete
- 8.4. Editing an expense:
edit
- 8.5. Clears an expense list:
clear
- 8.6. Undo your previous action:
undo
- 8.7. Switching between countries:
switch
- 8.8. Sort out your expense list:
sort
- 8.9. Generate an overview of your spending:
summary
- 9. Diary
- 9.1. Adding diary entries to your diary
add
- 9.2. Deleting diary entries from your diary
delete
- 9.3. List all your diary entries
list
- 9.4. Find diary entries
find
- 9.5. Find specific diary entries
findSpecific
- 9.6. Private personal memories
private
- 9.7. Unprivate personal memories
unprivate
- 9.8. Keep your diary protected
setDetails
- 9.9. Unlock your private diary entries
unlock
- 9.1. Adding diary entries to your diary
- 10. Achievements
- 11. FAQ
- 12. Command Summary
Welcome to TravEzy! 😊
Firstly, thank you for downloading our application. We greatly appreciate your support and we promise to make travel easy with TravEzy.
So, is TravEzy for you?
-
Are you a busy university student with a passion for travelling?
-
Are your summers and winters swamped with internships, projects and CCA activities?
-
Do your numerous commitments get in the way of your travel plans?
IF you answered yes to the questions above, then yes it is. If not, it still is :)
What is TravEzy?
TravEzy is a desktop application with a command line interface (CLI) and is perfect for NUS students who love travelling as much as we do. With a CLI, you will be able to type in your commands much faster than similar applications which require you to keep using your mouse. Furthermore, since this is a desktop application, you do not need a web browser (like Chrome, Firefox, Internet Explorer, etc.) to start using TravEzy.
TravEzy is perfect for:
-
Managing your busy calendar and finding the a good time to take that much needed holiday!
-
Creating the ideal itinerary for your trips :)
-
Tracking your expenses during your trip, so that you have enough money left for the trip home
-
Journaling in your travel diary and effortlessly looking at old entries to recall your favourite moments
-
Keep in contact with your old and new friends with the help of TravEzy’s address book
What are you waiting for? Hop on to this user guide and we will travel to Section 2, “Quick Start” to start TravEzy 😊
-
Grab a cup of coffee.
-
Ensure that you have Java 11 or above installed in your Computer.
-
Download the latest TravEzy.jar
-
Copy the file to the folder you want to use as the home folder for your TravEzy.
-
Double-click the file to start the app. The GUI (Graphical User Interface) should appear in a few seconds.
-
You are now in the Main Page of TravEzy.
-
At the bottom of the screen, type the command in the command box and press <Enter> on your keyboard to execute it. E.g. typing help and pressing <Enter> will open the help window.
Refer to Section 3, “Features” for details of each command.
Excited to start using TravEzy? Read this section to find out how this document is structured, and what each symbol and special font style mean. We promise that this will help you to get started with using TravEzy more quickly! 😊
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:
-
Main
-
Calendar
-
Itinerary
-
Address Book
-
Diary
-
Achievements
In each of the above sections, you will be introduced to the interface of the feature and the commands that will do the menial tasks for you.
Symbols and fanciful (okay, different) fonts are exciting, aren’t they? Let’s find out more about what they mean in this document!
Symbol/font | What does it mean? |
---|---|
italics |
Italicised text indicates that the text has a definition that is specific to the application. Do look out for the definitions of these words along the way. If not, please look at the glossary in section 13). |
|
A grey highlight means that you can type the words into TravEzy and it will start performing tasks to make travel easier for you |
|
Uppercase letters that are highlighted in grey indicate that the word is a parameter.[1] |
|
The slash and letter (or word) before the parameter is a prefix. It is used to separate the current parameter from other parameters. |
|
Square brackets imply that the the stated prefix and parameter are optional. (This means less typing! 😆) |
💡 |
A light bulb indicates that the enclosed text is a tip. |
A warning sign indicates that enclosed text is important. |
Main is the welcome screen for TravEzy. From here, you can easily navigate to the other pages (which contains the interface of the features): calendar, itinerary, address book, financial tracker, diary and achievements. You can also the exit the application from here.
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:
goto itinerary
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.
|
The above commands goto , help and exit can also be executed from the other pages.
|
It’s the end of the semester but there are still orientation camps, internships, and family commitments to attend to. However, after a long and tiring semester, the desire to unwind by travelling is just too strong. Sounds like you?
Well, TravEzy has got you covered. Simply inform TravEzy of your schedule (your commitments, school breaks, public holidays and trips) and TravEzy will suggest periods of time when you can travel! Excited to find out more? Well… Read on!
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.
|
The labels indicate the type of event you have for that particular day. It does not indicate the number of events. |
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:
-
To add a commitment,
add commitment n/volunteer to tutor children d/2 m/Dec y/2019 D/5 M/Dec Y/2019
-
To add a holiday,
add holiday n/labour day d/1 m/May y/2020
-
To add a school break,
add school_break n/winter vacation d/8 m/Dec y/2019 D/12 M/Jan Y/2020
-
To add a trip,
add trip n/Bali 3D2N d/10 m/Dec y/2019 D/13 M/Dec Y/2019
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.
💡
|
You do not have to specify the END YEAR , END MONTH and/or END DAY if they are the same as START YEAR , START MONTH and/or START DAY , respectively. This applies to the following commands as well.
|
|
If you leave out the month and/or year, the current month and/or year will be used. This applies to the following commands as well. |
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:
-
To delete a commitment,
delete commitment n/volunteer to tutor children d/2 m/Dec y/2019 D/5 M/Dec Y/2019
-
To delete a holiday,
delete holiday n/labour day d/1 m/May y/2020
-
To delete a school break,
delete school_break n/winter vacation d/8 m/Dec y/2019 D/12 M/Jan Y/2020
-
To delete a trip,
delete trip n/Bali 3D2N d/10 m/Dec y/2019 D/13 M/Dec Y/2019
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:
show m/Dec
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.
|
Do remember that if you leave out the year (as we have done in this example), the current year will be used. This applies to the following commands as well. |
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:
-
To list all events,
list
-
To list all events that happen between 2 December 2019 to 10 December 2019,
list d/2 m/Dec y/2019 D/10 M/Dec Y/2019
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:
-
To check whether you are available on 9 December 2019,
check d/9 m/Dec y/2019
-
To check whether you are available from 9 to 20 December 2019,
check d/9 m/Dec y/2019 D/20 M/Dec Y/2019
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:
-
To find out when you can travel between 9 and 20 December 2019,
suggest d/9 m/Dec y/2019 D/20 M/Dec Y/2019
-
To find out when you can travel for at least 5 days between 9 and 20 December 2019,
suggest d/9 m/Dec y/2019 D/20 M/Dec Y/2019 p/5
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.
Now that you have booked your flight, it’s time to start planning your trip using TravEzy’s Itinerary.
In TravEzy, we have broken down your events into 6 key parts, namely Title, Date, Time, Location, Description and Tag.
For example, here is an Itinerary entry about our trip to Japan
-
Title → Visit Tokyo DisneySea
-
Date → 12122019
-
Time → 1000
-
Location → DisneySea
-
Description → Remember to take pictures with the Disney Mascots!
-
Tag → Priority: Critical
In the Itinerary, you will be able to add, delete, edit, list and show your entries. There are also a few more special tasks that you can do with your Itinerary. Read on to find out more! 😊
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:
-
Auto-complete dropdown bar. Provides suggestions to complete your command base on your current input typed in the command box.
|
The auto-complete dropdown bar requires some time to sync with the input typed in the command box. Hence, give some time for it to read the input before hitting Enter |
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:
add title/Ride DisneySea Electric Railway date/12122019 time/1500 l/DisneySea
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:
-
Priority: None
-
Priority: Low
-
Priority: Medium
-
Priority: High
-
Priority: Critical
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:
delete 4
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/]
💡
|
If you wish to edit the tag field in the event, indicate it with the prefix tag/ and use the Priority Dropdown Box
to select the new priority.
|
Example:
edit 4 title/Explore DisneySea's Aquatopia d/Take photos of the fishes tag/
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:
done 4
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
Example:
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! 😄
|
The clear function removes ALL the events that you have planned in your event list. This action CANNOT be undone. Hence, only click on the Proceed button if you are sure that you want to clear your event list. |
Format:
clear
Example:
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
Example:
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
Example:
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. 😊
💡
|
If your event list is too cluttered up, try using the clear command instead to reset the whole event list instead.
|
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:
search date/12122019 l/DisneySea
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:
sort by/priority
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.
You are heading to a different country for a trip this holiday and you want to let your friends in other countries know that you are coming over. The troubles of managing contacts from many different countries can be overwhelming with a large number of contacts. Looking for a better contacts management application?
TravEzy is the better contact management you are looking for. TrazvEzy allows you to add your contacts information specifying your contact’s country. How does TravEzy do it? Read on to find our more.
Met a new friend in a new foreign country during your holiday trip? Add him / her to your TravEzy address book.
Format:
add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG] [r/REMARK][c/COUNTRY]
|
Address Book does not allow duplicate contacts. A person should not have the same NAME , PHONE and EMAIL
|
💡
|
Tags are useful ways to categorize your contacts. For example, tag a person with:add n/Alice p/918273645 e/alice@example.com t/friend ,
the t/ prefix is used for tagging.A person can have any number of tags (including 0) |
Examples:
-
To add a person into the address book,
add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01
-
To add a person into the address book specifying a tag and country,
add n/Betsy Crowe t/friend e/betsycrowe@example.com a/Newgate Prison p/1234567 t/criminal r/Best friend c/Singapore
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
Examples:
-
To list your contacts,
list
Step by Step:
Step 1. Type list
in the command box and click Enter.
Step 2. See the 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 into the address book! Edit all your contact information in the address book inside TravEzy.
Format:
edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [t/TAG] [r/REMARK] [c/COUNTRY]
|
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.You can remove the person’s remark by typing r/ without specifying any remark after it.You can remove the person’s country by typing c/ without specifying any country after it.
|
Examples:
-
To edit a 1st person’s phone number and email address to be
91234567
andjohndoe@example.com
respectively.edit 1 p/91234567 e/johndoe@example.com
-
To edit the name of the 2nd person to be
Betsy Crower
and clears all exisiting tags.edit 2 n/Betsy Crower t/
-
To edit the name of the 3rd person to be
Alexander Bell
and clears all existing country information.edit 3 n/Alexander Bell c/
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.
Your address book have many contacts and you would need to have a way to find your contacts information with 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
|
Examples:
-
To find
John
,find John
-
To return any person having names
Besty
,Time
orJohn
,find Betsy Tim John
Step by Step
Step 1. Type find Alice
in the command box and click Enter
Step 2. The found results 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.
While organizing your TravEzy address book, you want to clear your old contacts.
Format:
delete 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:
-
Delete the 2nd person in the address book.
delete 2
-
Deletes the 1st person in the results of the
find
command.find Betsy delete 1
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.
Your address book is in a mess, and you would like to clear all exisiting entries in the address book and restart from scratch
Format:
clear
|
You will not be able to undo this operation. Think twice before entering this command! |
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.
Scare that you’re gonna overspend whenever you’re on a trip? Afraid no more! TravEzy’s Financial Tracker allow you to track your expenses seamlessly!
Each of your expense has 6 key fields:
-
Date
-
Time
-
Amount
-
Description
-
Type of expenditure
-
Country
The Date and Time specify when you spend your expenses, followed by the amount, description, types of expenditure and country where you’re current travelling at. Example of the types of expenditure are food, entertainment, health care, etc. You name it, TravEzy tracks it! In Financial Tracker, you will be able to manage your expenses easily.
Adding the expense of milk you’ve bought at the grocery shop you stopped by?
|
You can only add a total maximum amount of one trillion! |
Format:
add a/AMOUNT d/DESCRIPTION t/TYPE OF EXPENDITURE [date/DATE] [time/TIME]
Example:
add a/2.89 d/Meiji Milk t/grocery
Step by step:
Step 1. Type add a/2.89 d/Meiji Milk t/grocery
in the Command box and press Enter.
Step 2. The Result box will display the message "Expense added".
Step 3. 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.
delete 1
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.
edit 1 a/29.80 d/Nike bottle
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
Example: Clears your current country’s expense list.
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 :)
|
You can only undo your previous add , edit , delete and clear command.
|
Format:
undo
Example: Undo your previous clear
command.
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
💡
|
Do realise that you can always use the drop down menu instead! |
|
You can only type in countries which are only listed from the Countries dropdown box |
Example:
switch Japan
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!
💡
|
All of the sorting is done in reversed order :) |
Format:
sort CRITERIA
Where CRITERIA
can be amount
, date
, time
, type
and default
Example: to sort by amount
sort 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
Example:
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!
The sweetest part of any holiday is looking back at your fond memories. TravEzy’s Diary allows you to do just that! Here is our Diary!
In TravEzy, we have broken down your memories into 4 key parts, namely Title, Date and Time, Place and Memory.
For example, here is a Diary Entry about our trip to Tioman
-
Title → First time Snorkeling
-
Date and Time → 30/12/2019 0900
-
Place → Tioman Island
-
Memory → Saw so may beautiful fish!
In the Diary, you will be able to add, delete, list and show your entries. There are also a few more special tasks that you can do with your diary. Enjoy!
Trying to journal about your fishing trip? The Diary allows you to add entries and keep them alive in your desktop forever.
Format: add t/TITLE d/DATE TIME [p/PLACE] [m/MEMORY]
Example: Lets take the example of our midnight fishing trip!
Step 1: Enter add t/Fishing Trip d/12/12/2019 2300 p/Pulau Tekong m/Caught the biggest fish ever!
Step 2: TravEzy will tell you if your add
command was successful in the Result Display
Step 3: You can see you added entry in the Diary List
For some memories, it’s best to forget them ☹. The Diary can help you to get rid of unpleasant diary entries.
Format: delete INDEX
Example: I lost my wallet at the amusement park in Genting, I don’t want to remember that trip ever again :(
Step 1: Enter delete 2
Step 2: TravEzy will tell you if your delete
command was successful in the Result Display
Step 3: You can see your updated Diary List without the horrible memory
What if you want to see all your memories in ONE, CONTINUOUS list? The Diary allows you to see everything in on, convenient list!
Format: list
Example: I want to relive EVERYTHING
Step 1: Enter list
Step 2: TravEzy will tell you if your list
command was successful in the Result Display
Step 3: You can see all your entries in the Diary List
"Hey, when did I go to Spain?" It can be hard to remember all the details of your trips. That’s why, this Diary allows you to look through all your entries to find the ones you want!
Format: find TARGET
Example: I want to see what I wrote about the Rugby World Cup
Step 1: Enter find rugby
Step 2: TravEzy will tell you if your find
command was successful in the Result Display
Step 3: You can see the matching entries in your Diary List
Let’s narrow down your search! The diary allows you to look through specific sections of each entry to find the exact entry that you want!
Format: findSpecific [t/TITLE] [d/DATE TIME] [p/PLACE] [m/MEMORY]
Example: I know that I had a trip on the 12th of December 2019, but I cant remember what I did…
Step 1: Enter findSpecific d/12/12/2019
Step 2: TravEzy will tell you if your findSpecific
command was successful in the Result Display
Step 3: You can see the specific matching entries in your Diary List
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: I had my first sip of wine today at the restaurant! I don’t want my mum to find out…
Step 1: Enter private 4
Step 2: TravEzy will tell you if your private
command was successful in the Result Display
Step 3: You can see your updated Diary List, after the memory has been hidden
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!, I’m alone and I want to look at my private memories
Step 1: Enter unprivate 4
Step 2: TravEzy will tell you if your unprivate
command was successful in the Result Display
Step 3: You can see your updated Diary List, after the memory is visible again
You never know who may use your laptop when you’re away. The Diary can help you to password protect your memories to stop hackers from looking at your private memories.
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: Better set a password to protect my memories against prying eyes
Step 1: Enter setDetails user/youcanthackme password/youreallycanthackme
Step 2: TravEzy will tell you if your unprivate
command was successful in the Result Display
Step 1: Lets say someone tries to hack you
Step 1: TravEzy will protect you if someone else tries to change your details
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: Time to look at all my private memories
Step 1: Enter unlock 4 user/youcanthackme password/youreallycanthackme
Step 2: TravEzy will tell you if your unlock
command was successful in the Result Display
Step 1: Lets say someone tries to hack you
Step 1: TravEzy will protect you if someone else tries to change your details
Travezy provides a way for you to look through your progress within the app itself. You will be able to see the overall statistics of your current progress as you grow to become a top traveller!
In the Address Book Achievements, you will be able to see:
-
Total Contacts in your Address Book out of 200
-
Number of contacts from different country
Q: How do I backup my data onto cloud storage?
A: Locate the data
folder in the same directory where you saved you jar file. Compact it into zip file before uploading it onto cloud storage.
Q: How do I transfer my data onto another computer?
A: Backup your data first. Then, download TravEzy in the other computer and put your data
folder on the same directory where you saved the jar file. Execute TravEzy and you should see your data has been safely transferred.
Q: Can I change the theme of the application? I prefer to work with a night theme interface.
A: Stay tuned for TravEzy v2.0 for this features! The TravEzy theme also aims to provide user with a UI that they are comfortable with. Hence, we strongly believe giving users the option to personalize their theme is extremely useful and would greatly consider adding it for the upcoming major update on TravEzy! Stay tuned for that!
Q: Who can view my travel posts in my TravEzy?
A: As TravEzy is a single user application, it is not opened to the public, and unable to be viewed by others. You can however, showcase your application in front of your friends to show off your overseas trips.
Q: Is it possible to connect to social media such as Facebook, Snapchat, Instagram?
A: Currently, it is not possible to connect to social media using TravEzy. However, we will consider implementing this feature in the future! Stay tuned for that! 😉
Q: Is there any in-app purchase for this application?
A: NO there isn’t. TravEzy is created from a non-profit organization and we are not here to milk any of your gold coins! It is absolutely free! It cost nothing, zilch, nada, 零, nil, kosong. So what are you waiting for get? Get TravEzy today!
Q: I’m having difficulties uploading the pictures onto the travel diary.
A: At the moment, TravEzy does not have any feature where it allows the user to store their travel photos. However, this will definitely be implemented in v2.0. We intend for the pictures to be stored in the user’s local drive and subsequently in a cloud database which is stored online.
Q: Who can I contact should there be a bug or feedback that I would like to share?
A: Feel free to send an email to the developer team: thetravellerdiary@gmail.com and we will access to your queries within three working days. We also value your feedback and will use it to improve TravEzy. Thank you and we looking forward to serving you better!
Q: Is it advisable to edit the storage files in TravEzy so that the changes will be reflected when I start the application?
A: TravEzy gives you a caveat and strongly advise against tempering with the storage files in TravEzy as this could result in falsification of the data.
Q: What are some of the cool features that are available in TravEzy currently?
A: TravEzy currently boast a plethora of features such as calendar, itinerary, address book, travelling diary, financial tracker and achievements page. All these features work in tandem with each other to give you the best and only the best travelling experience. Not only that, the TravEzy team also decided to spice things up and included some easter eggs scattered throughout the
application for users to discuss and discover. Hope that you have fun finding these cool easter egg features! 🐰🐰🐰
Here are summary lists of commands for the different features.
Command | Function | Syntax |
---|---|---|
|
Adds a new event to your calendar |
|
|
Deletes an event from your calendar |
|
|
Shows the requested month view |
|
|
Lists your events |
|
|
Checks whether you are available to travel during the specified time |
|
|
Suggests suitable time periods to travel |
|
Command | Function | Syntax |
---|---|---|
|
Add an event entry to the itinerary |
|
|
Delete a certain entry from the itinerary |
|
|
Edit a certain entry from the itinerary |
|
|
Mark an event as done from the itinerary |
|
|
List all the events that are currently in the itinerary |
|
|
Clears the whole event list in the itinerary |
|
|
Give user the current time and date. Also shows the events for today |
|
|
Pops up the help window for the itinerary page |
|
|
Gives a list of the past user input to the itinerary page for that session |
|
|
Search the whole event list and filter out events which meets the search condition |
``search [title/TITLE] [date/DATE] [time/TIME] [l/LOCATION] [d/DESCRIPTION] [tag/] |
|
Sort the event list based on the sorting condition |
|
Command | Function | Syntax |
---|---|---|
|
Adds a person to the address book |
|
|
Clears all entries from the address book |
|
|
Edits an existing person in the address book |
|
|
Deletes the specified person from the address book |
|
|
Finds persons whose names contain any of the given keywords |
|
|
Shows a list of all persons in the address book. |
|
|
View help |
|
Command | Function | Syntax |
---|---|---|
|
Adds an expense to the Financial Tracker |
|
|
Edits an existing expense in the Financial Tracker |
|
|
Deletes the specified expense from the Financial Tracker |
|
|
Clears all your expenses in your current country’s expense list |
|
|
Undo your previous action |
|
|
Switch to another country’s expense list |
|
|
Sort your expense list based on amount, type, date, time or default |
|
|
Generate an overview of your expenses statistics |
|
Command | Function | Syntax |
---|---|---|
|
Add a diary entry to the diary |
|
|
Delete a certain entry from the diary |
|
addData
: add a new data to be used for price comparison
showData
: show the prices for a selected data
deleteData
: delete data used for price comparison
compareData
: compare prices between two data
reviewData
: review the previous few comparisons that user did
listData
: list out all the data that user has inputted into TTD
Travel Recommendations:
setDates
: set the dates for your proposed trip
setPrice
: set your price range
setType
: set the type of trip (Fun, educational etc)
generate
: generate recommendations from stored diaries
NUS trips:
loadTrips
: download trips from NUS societies
deleteTrips
: delete certain NUS trips
showTrip
: show your whole trip in a calendar view
getSoc
: get societies from NUS which organise trips
deleteSoc
: delete certain societies
selectSoc
: select a certain society to load trips