By: CS2103T W11-3 Team      Since: Feb 2019      Licence: MIT

1. Introduction

During your travels, have you ever wanted to curate all your travel moments, and wished there was an app to do just that? There were approximately 1.4 billion travelers in 2018 alone. That means 1 out of every 5 person on the planet is a traveler, you are certainly not alone in your struggles. Is there a solution to all your 21st century travel woes?

Introducing TravelBuddy. TravelBuddy is a desktop journal app that curates all your travel moments! Here are 4 ways to use TravelBuddy:

Best of all, you can accomplish any of these tasks with just a single command. So, are you ready to redefine traveling?

2. Additional Information

Before continuing, it may be helpful to familiarize yourself these two symbols that you will encounter in this User Guide:

This tells you there is important information that you should take note of.
This alerts you of useful tips and tricks that will improve your TravelBuddy experience.
This WARNING symbol is used to alert you of something critical.

3. Quick Start

Here are the steps to get you started with using TravelBuddy:

  1. Ensure you have Java version 9 or later installed in your computer. The list of Java versions available for download can be found here.

  2. Download the latest version of TravelBuddy. The latest TravelBuddy jar file can be found here. Once the download is successful, you should be able to see a file named travelBuddy.jar.

  3. Double-click travelBuddy.jar to start the app. TravelBuddy’s Graphical User Interface (GUI) should appear in a few seconds, as shown in Figure 3.1.

    Ui
    Figure 3.1: An illustration of how the TravelBuddy GUI looks

  4. Perform a quick test to verify that TravelBuddy works by typing in a command in the command box and press Enter to execute it.

    Example: Type help and press Enter to open the help window.

    Below are other example commands you may try:

    List all places

    list

    Adds NUS Computing to the list of places

    add n/NUS Computing cc/SGP dv/10/10/2018 r/5 d/No Description a/NUS School of Computing, COM1, 13 Computing Drive, 117417

    Deletes the 3rd place shown in the current list

    delete 3

    Exits the application

    exit

  5. For a detailed explanation of each command, refer to Section 4, “Features”.

  6. For a complete summary of each command, refer to Section 6, “Cheatsheet”.

4. Features

4.1. Standardizing Command Formats

The following covers the standard format to be used for all the commands in TravelBuddy and the syntax that follows:

The code in this section is merely for illustrative purposes. It is kept brief to highlight the formatting standards for all the commands and not the actual commands themselves. Do not copy and paste the commands in this section.

  • Some commands may have a shortcut, which you can use to execute the command.
    Example: For add, its shortcut is a. Hence, you can either type add n/Botanic Gardens or a n/Botanic Gardens.

  • Words in UPPER_CASE are the parameters that you have to supply.
    Example: For add n/NAME, NAME is a parameter which can be substituted to be add n/Botanic Gardens.

  • Items in square brackets are optional.
    Example: For add n/NAME [t/TAG], it can either be specified as add n/Botanic Gardens t/faculty or as add n/Botanic Gardens.

  • Parameters can be in any order.
    Example: If the command specifies the parameters n/NAME r/RATING, then changing the order to r/RATING n/NAME is also acceptable.

  • Whenever there are duplicate parameters, the last duplicated parameter is chosen.
    Example: If the command is add n/Singapore Zoo n/Botanic Gardens, where there are duplicates of the n/NAME parameters, the last parameter, n/Botanic Gardens, is chosen to be added to the list of places.

  • Some parameters have a specific input format.
    Example: For dv/DATE_VISITED, the DATE_VISITED needs to follow the DD/MM/YYYY format.

4.2. Seeking Help: help

Description: The help command opens up a help page.

Shortcut: he

Format: help

The help page will be shown in another window, but you can resize and move it around. This can be useful to refer to when using the app.
A quick alternative way to seek help is to hit the F1 key.

4.3. Adding a Place: add

Description: The add command adds a place to TravelBuddy.

Shortcut: a

Format: add [n/NAME] [cc/COUNTRY_CODE] [dv/DATE_VISITED] [r/RATING] [d/DESCRIPTION] [a/ADDRESS] [p/FILE_PATH] [t/TAG]…

The Table 4.3.1 below shows the parameters that require a specific input format to be added.

Table 4.3.1: Parameters that require a specific format

Parameter

Parameter Prefix

Specific Input Format

RATING

r/

An integer ranging from 1 to 5

COUNTRY_CODE

cc/

A valid ISO-3166 three-letter country code
e.g. JPN to represent Japan
The full list of country codes can be found here

DATE_VISITED

dv/

A valid date that follows the DD/MM/YYYY format ranging from 01/01/1900 to the current date

Examples: Given below are some examples on how to utilize the add command:

  • add n/Botanic Gardens cc/SGP dv/01/01/2017 r/4 d/UNESCO World Heritage Site a/1 Cluny Rd, Singapore 259569 t/nature
    Adds Botanic Gardens to the list of places you have visited into TravelBuddy.

  • add n/Raffles Hotel cc/SGP dv/05/05/2016 t/hotel d/This place is lovely a/Raffles Road r/5 t/staycation
    Adds Raffles Hotel to the list of places you have visited into TravelBuddy.

Figure 4.3.1 below shows the outcome of a specific add command

addCommand
Figure 4.3.1: Adding a place to TravelBuddy
A place can have any number of tags (including 0 tags).

4.3.1. Including a photo when adding a place with p/

Description: The add command can also attach a single photo when adding a new place to TravelBuddy.

The photo must be an image file that already exists in your computer.

Format:

Parameter

Parameter Prefix

Specific Input Format

PHOTO

p/

The file path must be an absolute file path and include the filename and file extension.
A filepath specifies a unique location for a file. Absolute file paths are paths that start with a drive letter (eg. C:\)

Examples: Given below is an example that uses the add command to include a photo with the p/ parameter:

  • add n/Himeiji Castle cc/JPN dv/15/12/2017 r/5 d/Wow. a/Kyoto t/castle p/C:\Users\Michael\Pictures\castle-photo.jpg

Adds Himeiji Castle as a place in TravelBuddy, and include the image castle-photo.jpg at the location specified by the filepath C:\Users\Michael\Pictures\castle-photo.jpg.

Figure 4.3.1.1 below shows TravelBuddy before the above example command is executed.

addPhotoBefore2
Figure 4.3.1.1: Before the add command is executed.

Figure 4.3.1.2 below shows TravelBuddy after the above example command is executed, and the newly added "Himeiji Castle" is selected.

addPhotoAfter2
Figure 4.3.1.2: After the add command is executed and the newly added "Himeiji Castle" is selected.
If you are using Windows 10, below is a quick way to obtain the file path of the photo you would like to include:

  • Step 1: Open File Explorer.

  • Step 2: Navigate to the folder that contains the photo you would like to add.

  • Step 3: Select the Photo you would like to add.

AddPhotoStep3
Figure 4.3.1.3: Select the Photo you would like to add

  • Step 4: Click on Copy Path at the top left corner of the File Explorer window.

AddPhotoStep4
Figure 4.3.1.4: Click on Copy Path at the top left corner File Explorer window

  • Step 5: Open TravelBuddy and paste the filepath after the parameter prefix p/.

TravelBuddy allows for double quotation marks around the filepath, so there is no need to delete them.

Currently, TravelBuddy supports the following image file formats/extensions:

  • JPEG .jpg

  • PNG .png

  • Bitmap .bmp

4.4. Listing All Places: list

Description: The list command displays a list of all the places in TravelBuddy.

Shortcut: l

Format: list

4.5. Editing a Place: edit

Description: The edit command edits an existing place in TravelBuddy.

Shortcut: e

Format: edit INDEX [n/NAME] [cc/COUNTRY_CODE] [dv/DATE_VISITED] [r/RATING] [d/DESCRIPTION] [a/ADDRESS] [p/FILE_PATH] [t/TAG]…​

Preconditions: Given below is a list of preconditions that must be met for the edit command to work:

  • The command edits the place at the specified INDEX. The index refers to the index number shown in the displayed place list. The index must be a positive integer 1, 2, 3, …​

  • It must have at least one of the optional fields.

  • Its existing values will be updated to the input values.

  • The adding of tags is not cumulative. Hence, when the tags are edited, the existing tags of the place will be removed.

  • The tags can all be removed by typing t/ without specifying any tags after it.

  • Some parameters have a specific input format.

  • Preconditions for changing the photo file [FILE_PATH] are in Section 4.5.1, “Replacing the photo of a place with edit p/”

Examples: Given below are some examples on how to utilize the edit command:

  • edit 1 r/3 d/No description
    Edits the rating and description of the 1st entry in the list to be 3 and No description respectively.

  • edit 2 n/Raffles Hotel t/
    Edits the name of the 2nd entry in the list to be Raffles Hotel and clears all existing tags.

Figure 4.5.1 below shows the list of places before the edit command is used.

editCommandBefore
Figure 4.5.1: Before the edit command is used

Figure 4.5.2 below shows the list of places after the edit command is used.

editCommandAfter
Figure 4.5.2: After the edit command is used

4.5.1. Replacing the photo of a place with edit p/

The edit command can also be used to change the photo of a place by replacing the FILE_PATH of the current photo with the FILE_PATH of the new photo.

Figure 4.5.1.1 below shows TravelBuddy before edit command is used to replace the current photo.

editPhotoBefore2
Figure 4.5.1.1: Before the edit command is used to replace a photo.

Figure 4.5.1.2 below shows TravelBuddy after a new photo has been added to the place "Suntory Yamazaki Distillery".

editPhotoAfter2
Figure 4.5.1.2: After the edit command is used to replace a photo.

Examples: Given below is an example of using edit to replace a photo:

  • edit 3 p/C:\Users\Michael\Pictures\Wallpapers\Zion National Park 1.jpg
    Replaces the current photo of 3rd Place entry with the photo named Zion National Park 1.jpg

The image FILE_PATH being replaced with the edit command must still follow the specifications laid out in Section 4.3.1, “Including a photo when adding a place with p/”

4.6. Searching Places by Name: search

Description: The search command searches for places whose names contain any of the given keywords.

Shortcut: se

Format: search KEYWORD [MORE_KEYWORDS]

Preconditions: Given below is a list of preconditions that must be met for the search command to work:

  • The search is case insensitive. e.g national will match National.

  • The order of the keywords does not matter.
    e.g. University National of Singapore will match National University of Singapore.

  • Only the name of the places in TravelBuddy is searched.

  • Only full words will be matched.
    e.g. Nation will not match National

  • Places matching at least one keyword will be returned.
    e.g. National Museum will return National Museum of Singapore and National University Hospital.

Example: search Singapore
Executes a search for places that contain the keyword Singapore in its name.
From Figure 4.6.1, using search Singapore will return all places in your TravelBuddy that contain Singapore in its name.
In this case, the following are returned as they contain Singapore in their names:

  • Universal Studios Singapore

  • National University of Singapore

  • Singapore Zoo

UIsearchresults
Figure 4.6.1: Search results of search Singapore

4.7. Searching places by Ratings: searchr

Description: The searchr command searches for places whose ratings match the specified rating from 1 to 5.

Shortcut: sr

Format: searchr INDEX [MORE_INDICES]

Preconditions: Given below is a list of preconditions that must be met for the searchr command to work:

  • The rating used in the search must be an integer ranging from 1 to 5.
    e.g searchr 5 will return places with 5-star ratings.

  • Only the rating of the places in TravelBuddy is searched.

  • Multiple indices can be included in the query, e.g searchr 4 5 will return places with 4 or 5 star ratings.

Example: searchr 4
Executes a search for places with a rating of 4.
From Figure 4.7.1 below, using searchr 4 will return all places in your TravelBuddy that have a rating of 4.

UIsearchratingresults
Figure 4.7.1: Search results of searchr 4

4.8. Searching Places by Tags: searcht

Description: The searcht command searches for places whose tags correspond to any given keywords.

Shortcut: st

Format: searcht KEYWORD [MORE_KEYWORDS]

Preconditions: Given below is a list of preconditions that must be met for the searcht command to work:

  • The search is case insensitive. e.g Temple will match temple.

  • Only the tags of the places in TravelBuddy are searched.

  • Only full words will be matched e.g. temp will not match temple.

  • Places tagged with at least one matching keyword will be returned. e.g. temple school will return places tagged with temple or school.

  • Multiple keywords can be included in the query, e.g searcht distillery temple will return places tagged with distillery or temple.

Example: searcht distillery
Executes a search for places that are tagged with distillery.
From Figure 4.8.1 below, using searcht distillery will return all places in your TravelBuddy that are tagged with distillery.

UIsearchtagsresults
Figure 4.8.1: Search results of searcht distillery

4.9. Searching places by Country: searchc

Description: The searchc command searches for places whose country matches the specified ISO-3166 3-letter country code.

Shortcut: sc

Format: searchc KEYWORD [MORE_KEYWORDS]

Preconditions: Given below is a list of preconditions that must be met for the searchc command to work:

  • The country code keywords for searchc must be valid 3-letter ISO-3166 country codes.

  • The search country is from a list of ISO-3166 country codes. e.g JPN will return places located in Japan.

  • Only the country of the places in TravelBuddy is searched.

  • Multiple keywords can be included in the query, e.g searchc JPN CHN will return places located in Japan or China.

Example: searchc JPN
Executes a search for places located in JPN (Japan).
From Figure 4.9.1 below, using searchc JPN will return all places in your TravelBuddy that are located in Japan.

UIsearchcountryresults
Figure 4.9.1: Search results of searchc JPN

4.10. Searching Places by Year of Visit: searchyear

Description: The searchyear command searches for places whose year of visit matches the specified year of interest.

Shortcut: sy

Format: searchyear KEYWORD [MORE_KEYWORDS] OR searchyear KEYWORD-KEYWORD

Preconditions: Given below is a list of preconditions that must be met for the searchyear command to work:

  • The search year is bounded from 1900 to the current year. e.g searchyear 2016 will return places visited in the year 2016.

  • Search requests outside the bounds will issue a warning.

  • The year keywords for searchyear can be entered as a range. e.g searchyear 2010-2017 will return all the places visited from 2010 to 2017.

  • Only the year of visit of the places in TravelBuddy is searched.

Example: searchyear 2016
Executes a search for places visited in the year 2016.
From Figure 4.10.1 below, using searchyear 2016 will return all places in your TravelBuddy that you visited in the year 2016.

UIsearchyearresults
Figure 4.10.1: Search results of searchyear 2016

4.11. Deleting a Place: delete

Description: The delete command deletes the specified place from TravelBuddy.

Shortcut: d

Format: delete INDEX

Preconditions: Given below is a list of preconditions that must be met for the delete command to work:

  • Deletes the place at the specified INDEX.

  • The index refers to the index number shown in the currently displayed list, on the left.

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

Figure 4.11.1 below shows TravelBuddy before delete command is used.

deleteCommandBefore
Figure 4.11.1: Before the delete command is used

Figure 4.11.2 below shows the result of using the delete command on the first index of the list.

deleteCommandAfter
Figure 4.11.2: After the delete command is used

Examples: Given below are some examples on how to utilize the delete command:

  • list
    Lists all the places in TravelBuddy.
    delete 2
    Deletes the 2nd place in TravelBuddy.

  • search Raffles
    Searches for any places which has the word "Raffles" in it.
    delete 1
    Deletes the 1st place in the results of the search command.

4.12. Deleting Multiple Places: deletem

Description: The deletem command deletes multiple places from TravelBuddy’s currently displayed list on the left.

Shortcut: dm

Format: deletem START_INDEX END_INDEX

Preconditions: Given below is a list of precondiitions that must be met for the deletem command to work:

  • Deletes multiple places within a specified range from START_INDEX to END_INDEX.

  • START_INDEX must be smaller than or equal to the last index in the list and END_INDEX.

  • Deletem will delete up till the last entry in TravelBuddy if specified END_INDEX exceeds the last entry.

  • Inclusive of both places specified by START_INDEX and END_INDEX.

  • The index refers to the index number to the left of each place name, ie. "4. Jalan Kayu".

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

deletemExample1
Figure 4.12.1: An example of the deletem command

Examples: Given below are some examples on how to utilize the deletem command:

  • list
    Lists all the places in TravelBuddy.
    deletem 1 4
    Deletes the 1st, 2nd, 3rd and 4th place in the currently displayed list on the left.

  • search Singapore
    Searches for any places which has the word "Singapore" in it.
    deletem 1 3
    Deletes the 1st, 2nd and 3rd place in the results of the search Singapore command.

4.13. Selecting a Place: select

Description: The select command selects the place identified by the index number used in the currently displayed list on the left, which loads expanded details of the selected place on the right of the displayed list.

Shortcut: s

Format: select INDEX

Preconditions: Given below is a list of preconditions that must be met for the select command to work:

  • The index refers to the index number to the left of each place name, ie. "4. Jalan Kayu"

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

Figure 4.13.1 shows the result of using select 3 command. The place with an index of 2 is highlighted in a red box and additional information is shown on the right side of the GUI.

selectCommand
Figure 4.13.1: An example of the select command

Examples: Given below are some examples on how to utilize the select command:

  • list
    Lists all the places in TravelBuddy.
    select 2
    Selects the 2nd place in TravelBuddy.

  • search Raffles
    Searches for any places which has the word "Raffles" in it.
    select 1
    Selects the 1st place in the results of the search command.

4.14. Listing Previously Entered Commands: history

Description: The history command lists all the commands that you have entered in reverse chronological order.

Shortcut: hi

Format: history

Figure 4.14.1 shows the result of running the history command.

historyCommand
Figure 4.14.1: An example of the history command

Pressing the up and down arrows will display the previous and next input respectively in the command box.

4.15. Undoing Previous Command: undo

Description: The undo command restores TravelBuddy to the state before the previous undoable command was executed.

Shortcut: u

Format: undo

Undoable commands: Commands that modify TravelBuddy’s data (add, delete, deletem, edit , generate and clear).

Examples: Given below are some examples on how to utilize the undo command:

  • delete 1
    Deletes the 1st place on the list currently displayed.
    undo
    Reverses the delete 1 command.

  • select 1
    Selects the 1st place on the list currently displayed.
    undo
    The undo command fails as there are no undoable commands executed previously.

  • delete 1
    Deletes the 1st place on the list currently displayed.
    clear
    Clears all contents in the list.
    undo
    Reverses the clear command.
    undo
    Reverses the delete 1 command.

4.16. Redoing the Previously Undone Command: redo

Description: The redo command reverses the most recent undo command.

Shortcut: r

Format: redo

Examples: Given below are some examples on how to utilize the redo command:

  • delete 1
    Deletes the 1st place on the list currently displayed.
    undo
    Reverses the delete 1 command.
    redo
    Reapplies the delete 1 command.

  • delete 1
    Deletes the 1st place on the list currently displayed.
    redo
    The redo command fails as there are no undo commands executed previously.

  • delete 1
    Deletes the 1st place on the list currently displayed.
    clear
    Clears all contents in the list.
    undo
    Reverses the clear command.
    undo
    Reverses the delete 1 command.
    redo
    Reapplies the delete 1 command.
    redo
    Reapplies the clear command.

4.17. Generating Charts: generate

Chart Combined
Figure 4.17.1: The number of places visited by country, rating category and year

Description: The generate command generates charts based on the list of places in TravelBuddy. TravelBuddy serves up three charts (Figure 4.17.1) that are the most relevant to you as a traveler:

  • The number of places visited for each country

  • The number of places visited for each rating category

  • The number of places visited for each year

Shortcut: g

Format: generate

Preconditions: Given below is a list of preconditions that must be met for the generate command to work:

  • By default, the charts are automatically generated each time TravelBuddy loads.

  • The generate command always triggers the display of all three charts, as seen in Figure 4.17.1.

  • The charts always update themselves in real-time.
    Example: When a place is added via the add command, the charts are automatically updated so that no generate command is necessary.

  • If the list is empty, the generate command will not display any charts (Figure 4.17.4).

  • You can type in any parameters after the generate command, TravelBuddy will simply ignore them (Figure 4.17.2).

Generate BeforeParamAfterParam
Figure 4.17.2: Before and after a parameter is used in the generate command

Examples: Given below are some examples on how to utilize the generate command:

  • select 1
    Selects the 1st place in the current list displayed.
    generate
    Generates the charts.
    Outcome: The charts were successfully generated, as seen in Figure 4.17.3

  • clear
    Clears all places in the list.
    generate
    Generates the charts.
    Outcome: Unable to generate the charts as the list is empty, as seen in Figure 4.17.4

Generate Successful
Figure 4.17.3: The charts were successfully generated
Generate ListIsEmpty
Figure 4.17.4: Unable to generate the charts as the list is empty

4.18. Clearing All Entries: clear

Description: The clear command clears all place entries from TravelBuddy.

Shortcut: c

Format: clear

Figure 4.18.1 below shows the results of running a clear command, which will remove all places in TravelBuddy.

clearCommand
Figure 4.18.1: The outcome of the clear command

4.19. Exiting the Program: exit

Description: The exit command exits the program.

Shortcut: ex

Format: exit

An alternative way to exit TravelBuddy is to click FILE > EXIT, as seen in Figure 4.19.1
exit
Figure 4.19.1: An alternative way to exit TravelBuddy

4.20. Saving of Data

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

5. Frequently Asked Questions (FAQ)

5.1. Setting Up

Q: Can TravelBuddy be used without an internet connection?
A: Yes, TravelBuddy works without an internet connection.

Q: Why is my TravelBuddy empty?
A: If you are just starting out, TravelBuddy will be empty for you to add places that you have been to. If you have already added places to TravelBuddy, there is likely an issue with your TravelBuddy.json data file. Please refer to the section below.

5.2. Data and Storage Issues

Q: How do I transfer my data to another computer?
A: First, install the TravelBuddy on the other computer.
Next, copy the TravelBuddy.json data file from your current TravelBuddy. It is located in the same folder as the TravelBuddy.jar program.
Finally, paste the TravelBuddy.json data file in the folder of your new TravelBuddy.jar program. When a warning box appears with the messages "There is already a file with the same name in this location.", select "Copy and Replace".

Q: How do I send my TravelBuddy to someone else?
A: You can send the person (via E-mail or messenger applications) your TravelBuddy.json data file. It is located in the same folder as the TravelBuddy.jar program.

Q: Can I reset my TravelBuddy to the state it was when I first launched the application?
A: You can simply repeatedly run the undo command until there are no further commands to undo.

Q: Why is my TravelBuddy empty?
A: If you are just starting out, please refer to Setting Up section. Otherwise, an empty TravelBuddy may mean that your data has been cleared by commands, or the TravelBuddy.json data file is missing or corrupted.

Please check that the file is located in the same folder as the TravelBuddy.jar program executable, and the file can be opened by a text editor such as NotePad.

5.3. Command Issues

Q: How do I view the full TravelBuddy after searching or selecting an entry?
A: You can use the command list to retrieve the full TravelBuddy.

Q: What details do I need for the add command?
A: The following details are required for a valid add command:

  • Name of the place (Prefix: n/)

  • Country code of the place (Prefix: cc/)

  • Date the place was visited (Prefix: dv/)

  • Rating of the place (Prefix: r/)

  • Description of the place (Prefix: d/)

  • Address of the place (Prefix: a/)

Q: What details are optional for the add command?
A: The following details are optional for a valid add command:

  • Tags of the place (Prefix: t/)

  • Filepath of the photo file for the place (Prefix: p/)

Q: Why does the undo command not work?
A: The undo command only reverses the commands add, delete, deletem, generate, edit and clear.

Q: Why does the undo command reverse a command from multiple commands before?
A: The undo command reverses the last used add, delete, deletem, edit, generate and clear command.

6. Cheatsheet

6.1. Command Glossary and Shortcuts

Below is a summarized list of all the command glossary and shortcuts that TravelBuddy supports:

Command

Shortcut

Explanation

Add

a

Adds a place to TravelBuddy.

Clear

c

Clears all place entries from TravelBuddy.

Delete

d

Deletes the specified place from TravelBuddy.

Delete Multiple

dm

Deletes multiple places from TravelBuddy’s currently displayed list on the left.

Edit

e

Edits an existing place in TravelBuddy.

Exit

ex

Exits the program.

Generate

g

Generates charts based on the list of places in TravelBuddy.

Help

he

Opens up a help page.

History

hi

Lists all the commands that you have entered in reverse chronological order.

List

l

Lists all the places in TravelBuddy.

Redo

r

Reverses the most recent undo command.

Search

se

Searches for places whose names contain any of the given keywords.

Search Country

sc

Searches for places whose country matches the specified ISO-3166 3-letter country code.

Search Rating

sr

Searches for places whose ratings match the specified rating from 1 to 5.

Search Tags

st

Searches for places whose tags correspond to any given keywords.

Search Year

sy

Searches for places whose year of visit matches the specified year of interest.

Select

s

Selects the place identified by the index number used in the currently displayed list on the left, which loads expanded details of the selected place on the right of the displayed list.

Undo

u

Restores TravelBuddy to the state before the previous undoable command was executed.

6.2. Command Formats

Below is a summarized list of all the command formats that TravelBuddy supports:

Command

Format

Add

add n/NAME cc/COUNTRY_CODE dv/DATE_VISITED r/RATING d/DESCRIPTION a/ADDRESS p/FILE_PATH [t/TAG]…​

Example:
add n/NUS Computing cc/SGP dv/10/10/2017 r/5 d/No description a/NUS School of Computing, COM1, 13 Computing Drive, 117417 p/C:\Users\Michael\Pictures\nus-photo.jpg t/school

Clear

clear

Delete

delete INDEX

Example:
delete 3

Delete Multiple

deletem START_INDEX END_INDEX

Example:
deletem 2 5

Edit

edit INDEX [n/NAME] [cc/COUNTRYCODE] [dv/DATE_VISITED] [r/RATING] [d/DESCRIPTION] [a/ADDRESS] [p/FILE_PATH] [t/TAG]…​

Example:
edit 2 n/Starbucks d/I like the coffee here
edit 4 p/C:\Users\Michael\Pictures\castle-photo.png

Exit

exit

Generate

generate

Help

help

History

history

List

list

Redo

redo

Search

search KEYWORD [MORE_KEYWORDS]

Example:
search Coffee Bean Tea Leaf

Search Country

searchc KEYWORD [MORE_KEYWORDS]

Example:
searchc JPN CHN

Search Rating

searchr RATING [MORE_RATINGS]

Example:
searchr 4 5

Search Tags

searcht KEYWORD [MORE_KEYWORDS]

Example:
searcht school airport

Search Year

searchyear KEYWORD [MORE_KEYWORDS]

Examples:
searchyear 2011
searchyear 2008-2017

Select

select INDEX

Example:
select 2

Undo

undo